xref: /freebsd/secure/lib/libcrypto/man/man3/SRP_create_verifier.3 (revision 734e82fe33aa764367791a7d603b383996c6b40b)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..
..
.. 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 -- \(*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\} . 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.

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'.
.. .nr rF 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 . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . 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 . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . 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 .\} ========================================================================

Title "SRP_CREATE_VERIFIER 3"
SRP_CREATE_VERIFIER 3 "2023-08-01" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"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
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/srp.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):

.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

"DESCRIPTION"
Header "DESCRIPTION" All of the functions described on this page are deprecated. There are no available replacement functions at this time.

The SRP_create_verifier_BN_ex() 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 libctx and property query string propq. Any cryptographic algorithms that need to be fetched will use the libctx and propq. See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in crypto\|(7).

\fBSRP_create_verifier_BN() is the same as SRP_create_verifier_BN_ex() except the default library context and property query string is used.

On successful exit *verifier will point to a newly allocated \s-1BIGNUM\s0 containing the verifier and (if a salt was not provided) *salt will be populated with a newly allocated \s-1BIGNUM\s0 containing a random salt. If *salt is not \s-1NULL\s0 then the provided salt is used instead. The caller is responsible for freeing the allocated *salt and *verifier \s-1BIGNUMS\s0 (use BN_free\|(3)).

The SRP_create_verifier() function is similar to SRP_create_verifier_BN() 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 N and an \s-1SRP\s0 group id as g instead to load the appropriate gN values (see SRP_get_default_gN()). If both N and g are \s-1NULL\s0 the 8192-bit \s-1SRP\s0 group parameters are used. The caller is responsible for freeing the allocated *salt and *verifier (use OPENSSL_free\|(3)).

The SRP_check_known_gN_param() function checks that g and N are valid \s-1SRP\s0 group parameters from \s-1RFC 5054\s0 appendix A.

The SRP_get_default_gN() function returns the gN parameters for the \s-1RFC 5054\s0 id \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".

"RETURN VALUES"
Header "RETURN VALUES" \fBSRP_create_verifier_BN_ex() and SRP_create_verifier_BN() return 1 on success and 0 on failure.

\fBSRP_create_verifier_ex() and SRP_create_verifier() return \s-1NULL\s0 on failure and a non-NULL value on success: \*(L"*\*(R" if N is not \s-1NULL,\s0 the selected group id otherwise. This value should not be freed.

\fBSRP_check_known_gN_param() 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.

\fBSRP_get_default_gN() returns \s-1NULL\s0 if id is not a valid group size, or the 8192-bit group parameters if id is \s-1NULL.\s0

"EXAMPLES"
Header "EXAMPLES" Generate and store a 8192 bit password verifier (error handling omitted for clarity):

.Vb 2 #include <openssl/bn.h> #include <openssl/srp.h> \& 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

"SEE ALSO"
Header "SEE ALSO" \fBopenssl-srp\|(1), \fBSRP_VBASE_new\|(3), \fBSRP_user_pwd_new\|(3)
"HISTORY"
Header "HISTORY" \fBSRP_create_verifier_BN_ex() and SRP_create_verifier_ex() were introduced in OpenSSL 3.0. All other functions were added in OpenSSL 1.0.1.

All of these functions were deprecated in OpenSSL 3.0.

"COPYRIGHT"
Header "COPYRIGHT" Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

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 <https://www.openssl.org/source/license.html>.