diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SRP_create_verifier.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SRP_create_verifier.3 | 136 |
1 files changed, 30 insertions, 106 deletions
diff --git a/secure/lib/libcrypto/man/man3/SRP_create_verifier.3 b/secure/lib/libcrypto/man/man3/SRP_create_verifier.3 index 1cd0888d1bfb..86eddab2c3ea 100644 --- a/secure/lib/libcrypto/man/man3/SRP_create_verifier.3 +++ b/secure/lib/libcrypto/man/man3/SRP_create_verifier.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" 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 3ossl" -.TH SRP_CREATE_VERIFIER 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH SRP_CREATE_VERIFIER 3ossl 2025-07-01 3.5.1 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" +.SH NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, @@ -144,14 +68,14 @@ SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN \&\- SRP authentication primitives -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/srp.h> .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, +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 11 @@ -170,60 +94,60 @@ see \fBopenssl_user_macros\fR\|(7): \& char *SRP_check_known_gN_param(const BIGNUM *g, const BIGNUM *N); \& SRP_gN *SRP_get_default_gN(const char *id); .Ve -.SH "DESCRIPTION" +.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 +The \fBSRP_create_verifier_BN_ex()\fR function creates an SRP password verifier from +the supplied parameters as defined in section 2.4 of RFC 5054 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). +"ALGORITHM FETCHING" 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 +On successful exit \fI*verifier\fR will point to a newly allocated BIGNUM 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 +newly allocated BIGNUM containing a random salt. If \fI*salt\fR is not NULL 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)). +BIGNUMS (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 +It is possible to pass NULL as \fIN\fR and an SRP 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. +If both \fIN\fR and \fIg\fR are NULL the 8192\-bit SRP 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. +SRP group parameters from RFC 5054 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". +The \fBSRP_get_default_gN()\fR function returns the gN parameters for the RFC 5054 \fIid\fR +SRP group size. +The known ids are "1024", "1536", "2048", "3072", "4096", "6144" and "8192". .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 +\&\fBSRP_create_verifier_ex()\fR and \fBSRP_create_verifier()\fR return NULL 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 +"*" if \fIN\fR is not NULL, 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. +(i.e. the prime bit size) or NULL if the arguments are not valid SRP 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" +\&\fBSRP_get_default_gN()\fR returns NULL if \fIid\fR is not a valid group size, +or the 8192\-bit group parameters if \fIid\fR is NULL. +.SH EXAMPLES .IX Header "EXAMPLES" Generate and store a 8192 bit password verifier (error handling omitted for clarity): @@ -255,17 +179,17 @@ omitted for clarity): \&\fBopenssl\-srp\fR\|(1), \&\fBSRP_VBASE_new\fR\|(3), \&\fBSRP_user_pwd_new\fR\|(3) -.SH "HISTORY" +.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" +.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 +Licensed under the Apache License 2.0 (the "License"). 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 +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |