.\" $NetBSD: SRP_create_verifier.3,v 1.2.2.3 2023/11/02 19:32:27 sborrill Exp $ .\" .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "SRP_create_verifier 3" .TH SRP_create_verifier 3 "2023-05-07" "3.0.12" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN \&\- SRP authentication primitives .SH "LIBRARY" libcrypto, -lcrypto .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include .Ve .PP The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 11 \& int SRP_create_verifier_BN_ex(const char *user, const char *pass, BIGNUM **salt, \& BIGNUM **verifier, const BIGNUM *N, \& const BIGNUM *g, OSSL_LIB_CTX *libctx, \& const char *propq); \& char *SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt, \& BIGNUM **verifier, const BIGNUM *N, const BIGNUM *g); \& char *SRP_create_verifier_ex(const char *user, const char *pass, char **salt, \& char **verifier, const char *N, const char *g, \& OSSL_LIB_CTX *libctx, const char *propq); \& char *SRP_create_verifier(const char *user, const char *pass, char **salt, \& char **verifier, const char *N, const char *g); \& \& char *SRP_check_known_gN_param(const BIGNUM *g, const BIGNUM *N); \& SRP_gN *SRP_get_default_gN(const char *id); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" All of the functions described on this page are deprecated. There are no available replacement functions at this time. .PP The \fBSRP_create_verifier_BN_ex()\fR function creates an \s-1SRP\s0 password verifier from the supplied parameters as defined in section 2.4 of \s-1RFC 5054\s0 using the library context \fIlibctx\fR and property query string \fIpropq\fR. Any cryptographic algorithms that need to be fetched will use the \fIlibctx\fR and \fIpropq\fR. See \&\*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7). .PP \&\fBSRP_create_verifier_BN()\fR is the same as \fBSRP_create_verifier_BN_ex()\fR except the default library context and property query string is used. .PP On successful exit \fI*verifier\fR will point to a newly allocated \s-1BIGNUM\s0 containing the verifier and (if a salt was not provided) \fI*salt\fR will be populated with a newly allocated \s-1BIGNUM\s0 containing a random salt. If \fI*salt\fR is not \s-1NULL\s0 then the provided salt is used instead. The caller is responsible for freeing the allocated \fI*salt\fR and \fI*verifier\fR \&\s-1BIGNUMS\s0 (use \fBBN_free\fR\|(3)). .PP The \fBSRP_create_verifier()\fR function is similar to \fBSRP_create_verifier_BN()\fR but all numeric parameters are in a non-standard base64 encoding originally designed for compatibility with libsrp. This is mainly present for historical compatibility and its use is discouraged. It is possible to pass \s-1NULL\s0 as \fIN\fR and an \s-1SRP\s0 group id as \fIg\fR instead to load the appropriate gN values (see \fBSRP_get_default_gN()\fR). If both \fIN\fR and \fIg\fR are \s-1NULL\s0 the 8192\-bit \s-1SRP\s0 group parameters are used. The caller is responsible for freeing the allocated \fI*salt\fR and \fI*verifier\fR (use \fBOPENSSL_free\fR\|(3)). .PP The \fBSRP_check_known_gN_param()\fR function checks that \fIg\fR and \fIN\fR are valid \&\s-1SRP\s0 group parameters from \s-1RFC 5054\s0 appendix A. .PP The \fBSRP_get_default_gN()\fR function returns the gN parameters for the \s-1RFC 5054\s0 \fIid\fR \&\s-1SRP\s0 group size. The known ids are \*(L"1024\*(R", \*(L"1536\*(R", \*(L"2048\*(R", \*(L"3072\*(R", \*(L"4096\*(R", \*(L"6144\*(R" and \*(L"8192\*(R". .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBSRP_create_verifier_BN_ex()\fR and \fBSRP_create_verifier_BN()\fR return 1 on success and 0 on failure. .PP \&\fBSRP_create_verifier_ex()\fR and \fBSRP_create_verifier()\fR return \s-1NULL\s0 on failure and a non-NULL value on success: \&\*(L"*\*(R" if \fIN\fR is not \s-1NULL,\s0 the selected group id otherwise. This value should not be freed. .PP \&\fBSRP_check_known_gN_param()\fR returns the text representation of the group id (i.e. the prime bit size) or \s-1NULL\s0 if the arguments are not valid \s-1SRP\s0 group parameters. This value should not be freed. .PP \&\fBSRP_get_default_gN()\fR returns \s-1NULL\s0 if \fIid\fR is not a valid group size, or the 8192\-bit group parameters if \fIid\fR is \s-1NULL.\s0 .SH "EXAMPLES" .IX Header "EXAMPLES" Generate and store a 8192 bit password verifier (error handling omitted for clarity): .PP .Vb 2 \& #include \& #include \& \& const char *username = "username"; \& const char *password = "password"; \& \& SRP_VBASE *srpData = SRP_VBASE_new(NULL); \& \& SRP_gN *gN = SRP_get_default_gN("8192"); \& \& BIGNUM *salt = NULL, *verifier = NULL; \& SRP_create_verifier_BN_ex(username, password, &salt, &verifier, gN\->N, gN\->g, \& NULL, NULL); \& \& SRP_user_pwd *pwd = SRP_user_pwd_new(); \& SRP_user_pwd_set1_ids(pwd, username, NULL); \& SRP_user_pwd_set0_sv(pwd, salt, verifier); \& SRP_user_pwd_set_gN(pwd, gN\->g, gN\->N); \& \& SRP_VBASE_add0_user(srpData, pwd); .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBopenssl\-srp\fR\|(1), \&\fBSRP_VBASE_new\fR\|(3), \&\fBSRP_user_pwd_new\fR\|(3) .SH "HISTORY" .IX Header "HISTORY" \&\fBSRP_create_verifier_BN_ex()\fR and \fBSRP_create_verifier_ex()\fR were introduced in OpenSSL 3.0. All other functions were added in OpenSSL 1.0.1. .PP All of these functions were deprecated in OpenSSL 3.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2018\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at .