234 lines
7.9 KiB
Groff
Executable File
234 lines
7.9 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" 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" ''
|
|
'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 turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" 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 "2020-03-02" "3.0.0-dev" "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,
|
|
SRP_create_verifier_BN,
|
|
SRP_check_known_gN_param,
|
|
SRP_get_default_gN
|
|
\&\- SRP authentication primitives
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/srp.h>
|
|
\&
|
|
\& 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(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"
|
|
The \fISRP_create_verifier_BN()\fR function creates an \s-1SRP\s0 password verifier from
|
|
the supplied parameters as defined in section 2.4 of \s-1RFC\s0 5054.
|
|
On successful exit \fB*verifier\fR will point to a newly allocated \s-1BIGNUM\s0 containing
|
|
the verifier and (if a salt was not provided) \fB*salt\fR will be populated with a
|
|
newly allocated \s-1BIGNUM\s0 containing a random salt. If \fB*salt\fR is not \s-1NULL\s0 then
|
|
the provided salt is used instead.
|
|
The caller is responsible for freeing the allocated \fB*salt\fR and \fB*verifier\fR
|
|
\&\s-1BIGNUMS\s0 (use \fIBN_free\fR\|(3)).
|
|
.PP
|
|
The \fISRP_create_verifier()\fR function is similar to \fISRP_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 \fBN\fR and an \s-1SRP\s0 group id as \fBg\fR instead to
|
|
load the appropriate gN values (see \fISRP_get_default_gN()\fR).
|
|
If both \fBN\fR and \fBg\fR are \s-1NULL\s0 the 8192\-bit \s-1SRP\s0 group parameters are used.
|
|
The caller is responsible for freeing the allocated \fB*salt\fR and \fB*verifier\fR
|
|
(use \fIOPENSSL_free\fR\|(3)).
|
|
.PP
|
|
The \fISRP_check_known_gN_param()\fR function checks that \fBg\fR and \fBN\fR are valid
|
|
\&\s-1SRP\s0 group parameters from \s-1RFC\s0 5054 appendix A.
|
|
.PP
|
|
The \fISRP_get_default_gN()\fR function returns the gN parameters for the \s-1RFC\s0 5054 \fBid\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"
|
|
\&\fISRP_create_verifier_BN()\fR returns 1 on success and 0 on failure.
|
|
.PP
|
|
\&\fISRP_create_verifier()\fR returns \s-1NULL\s0 on failure and a non-NULL value on success:
|
|
\&\*(L"*\*(R" if \fBN\fR is not \s-1NULL\s0, the selected group id otherwise. This value should
|
|
not be freed.
|
|
.PP
|
|
\&\fISRP_check_known_gN_param()\fR returns the text representation of the group id
|
|
(ie. 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
|
|
\&\fISRP_get_default_gN()\fR returns \s-1NULL\s0 if \fBid\fR is not a valid group size,
|
|
or the 8192\-bit group parameters if \fBid\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 <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(username, password, &salt, &verifier, gN\->N, gN\->g);
|
|
\&
|
|
\& 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"
|
|
\&\fIopenssl\-srp\fR\|(1),
|
|
\&\fISRP_VBASE_new\fR\|(3),
|
|
\&\fISRP_user_pwd_new\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
These functions were added in OpenSSL 1.0.1.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2018 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
|
|
<https://www.openssl.org/source/license.html>.
|