xref: /freebsd/secure/lib/libcrypto/man/man3/SRP_VBASE_new.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

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_VBASE_NEW 3ossl"
SRP_VBASE_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user \- Functions to create and manage a stack of SRP user verifier information
"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 2 SRP_VBASE *SRP_VBASE_new(char *seed_key); void SRP_VBASE_free(SRP_VBASE *vb); \& int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file); \& int SRP_VBASE_add0_user(SRP_VBASE *vb, SRP_user_pwd *user_pwd); SRP_user_pwd *SRP_VBASE_get1_by_user(SRP_VBASE *vb, char *username); SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username); .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_VBASE_new() function allocates a structure to store server side \s-1SRP\s0 verifier information. If seed_key is not \s-1NULL\s0 a copy is stored and used to generate dummy parameters for users that are not found by SRP_VBASE_get1_by_user(). This allows the server to hide the fact that it doesn't have a verifier for a particular username, as described in section 2.5.1.3 'Unknown \s-1SRP\s0' of \s-1RFC 5054.\s0 The seed string should contain random \s-1NUL\s0 terminated binary data (therefore the random data should not contain \s-1NUL\s0 bytes!).

The SRP_VBASE_free() function frees up the vb structure. If vb is \s-1NULL,\s0 nothing is done.

The SRP_VBASE_init() function parses the information in a verifier file and populates the vb structure. The verifier file is a text file containing multiple entries, whose format is: flag base64(verifier) base64(salt) username gNid userinfo(optional) where the flag can be 'V' (valid) or 'R' (revoked). Note that the base64 encoding used here is non-standard so it is recommended to use openssl-srp\|(1) to generate this file.

The SRP_VBASE_add0_user() function adds the user_pwd verifier information to the vb structure. See SRP_user_pwd_new\|(3) to create and populate this record. The library takes ownership of user_pwd, it should not be freed by the caller.

The SRP_VBASE_get1_by_user() function returns the password info for the user whose username matches username. It replaces the deprecated \fBSRP_VBASE_get_by_user(). If no matching user is found but a seed_key and default gN parameters have been set, dummy authentication information is generated from the seed_key, allowing the server to hide the fact that it doesn't have a verifier for a particular username. When using \s-1SRP\s0 as a \s-1TLS\s0 authentication mechanism, this will cause the handshake to proceed normally but the first client will be rejected with a \*(L"bad_record_mac\*(R" alert, as if the password was incorrect. If no matching user is found and the seed_key is not set, \s-1NULL\s0 is returned. Ownership of the returned pointer is released to the caller, it must be freed with SRP_user_pwd_free().

"RETURN VALUES"
Header "RETURN VALUES" \fBSRP_VBASE_init() returns \s-1SRP_NO_ERROR\s0 (0) on success and a positive value on failure. The error codes are \s-1SRP_ERR_OPEN_FILE\s0 if the file could not be opened, \fB\s-1SRP_ERR_VBASE_INCOMPLETE_FILE\s0 if the file could not be parsed, \fB\s-1SRP_ERR_MEMORY\s0 on memory allocation failure and \s-1SRP_ERR_VBASE_BN_LIB\s0 for invalid decoded parameter values.

\fBSRP_VBASE_add0_user() returns 1 on success and 0 on failure.

"SEE ALSO"
Header "SEE ALSO" \fBopenssl-srp\|(1), \fBSRP_create_verifier\|(3), \fBSRP_user_pwd_new\|(3), \fBSSL_CTX_set_srp_password\|(3)
"HISTORY"
Header "HISTORY" The SRP_VBASE_add0_user() function was added 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>.