Debian Codegraph @

upstream/debian-unstable/man3/SRP_Calc_B.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SRP_CALC_B 3SSL"
58 .TH SRP_CALC_B 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SRP_Calc_server_key,
65 SRP_Calc_A,
66 SRP_Calc_B_ex,
67 SRP_Calc_B,
68 SRP_Calc_u_ex,
69 SRP_Calc_u,
70 SRP_Calc_x_ex,
71 SRP_Calc_x,
72 SRP_Calc_client_key_ex,
73 SRP_Calc_client_key
74 \&\- SRP authentication primitives
75 .SH SYNOPSIS
76 .IX Header "SYNOPSIS"
77 .Vb 1
78 \& #include <openssl/srp.h>
79 .Ve
80 .PP
81 The following functions have been deprecated since OpenSSL 3.0, and can be
82 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
83 see \fBopenssl_user_macros\fR\|(7):
84 .PP
85 .Vb 7
86 \& /* server side .... */
87 \& BIGNUM *SRP_Calc_server_key(const BIGNUM *A, const BIGNUM *v, const BIGNUM *u,
88 \& const BIGNUM *b, const BIGNUM *N);
89 \& BIGNUM *SRP_Calc_B_ex(const BIGNUM *b, const BIGNUM *N, const BIGNUM *g,
90 \& const BIGNUM *v, OSSL_LIB_CTX *libctx, const char *propq);
91 \& BIGNUM *SRP_Calc_B(const BIGNUM *b, const BIGNUM *N, const BIGNUM *g,
92 \& const BIGNUM *v);
93 \&
94 \& BIGNUM *SRP_Calc_u_ex(const BIGNUM *A, const BIGNUM *B, const BIGNUM *N,
95 \& OSSL_LIB_CTX *libctx, const char *propq);
96 \& BIGNUM *SRP_Calc_u(const BIGNUM *A, const BIGNUM *B, const BIGNUM *N);
97 \&
98 \& /* client side .... */
99 \& BIGNUM *SRP_Calc_client_key_ex(const BIGNUM *N, const BIGNUM *B, const BIGNUM *g,
100 \& const BIGNUM *x, const BIGNUM *a, const BIGNUM *u,
101 \& OSSL_LIB_CTX *libctx, const char *propq);
102 \& BIGNUM *SRP_Calc_client_key(const BIGNUM *N, const BIGNUM *B, const BIGNUM *g,
103 \& const BIGNUM *x, const BIGNUM *a, const BIGNUM *u);
104 \& BIGNUM *SRP_Calc_x_ex(const BIGNUM *s, const char *user, const char *pass,
105 \& OSSL_LIB_CTX *libctx, const char *propq);
106 \& BIGNUM *SRP_Calc_x(const BIGNUM *s, const char *user, const char *pass);
107 \& BIGNUM *SRP_Calc_A(const BIGNUM *a, const BIGNUM *N, const BIGNUM *g);
108 .Ve
109 .SH DESCRIPTION
110 .IX Header "DESCRIPTION"
111 All of the functions described on this page are deprecated. There are no
112 available replacement functions at this time.
113 .PP
114 The SRP functions described on this page are used to calculate various
115 parameters and keys used by SRP as defined in RFC2945. The server key and \fIB\fR
116 and \fIu\fR parameters are used on the server side and are calculated via
117 \&\fBSRP_Calc_server_key()\fR, \fBSRP_Calc_B_ex()\fR, \fBSRP_Calc_B()\fR, \fBSRP_Calc_u_ex()\fR and
118 \&\fBSRP_Calc_u()\fR. The client key and \fBx\fR and \fBA\fR parameters are used on the
119 client side and are calculated via the functions \fBSRP_Calc_client_key_ex()\fR,
120 \&\fBSRP_Calc_client_key()\fR, \fBSRP_Calc_x_ex()\fR, \fBSRP_Calc_x()\fR and \fBSRP_Calc_A()\fR. See
121 RFC2945 for a detailed description of their usage and the meaning of the various
122 BIGNUM parameters to these functions.
123 .PP
124 Most of these functions come in two forms. Those that take a \fIlibctx\fR and
125 \&\fIpropq\fR parameter, and those that don't. Any cryptogrpahic functions that
126 are fetched and used during the calculation use the provided \fIlibctx\fR and
127 \&\fIpropq\fR. See "ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for more details. The variants
128 that do not take a \fIlibctx\fR and \fIpropq\fR parameter use the default library
129 context and property query string. The \fBSRP_Calc_server_key()\fR and \fBSRP_Calc_A()\fR
130 functions do not have a form that takes \fIlibctx\fR or \fIpropq\fR parameters because
131 they do not need to fetch any cryptographic algorithms.
132 .SH "RETURN VALUES"
133 .IX Header "RETURN VALUES"
134 All these functions return the calculated key or parameter, or NULL on error.
135 .SH "SEE ALSO"
136 .IX Header "SEE ALSO"
137 \&\fBopenssl\-srp\fR\|(1),
138 \&\fBSRP_VBASE_new\fR\|(3),
139 \&\fBSRP_user_pwd_new\fR\|(3)
140 .SH HISTORY
141 .IX Header "HISTORY"
142 SRP_Calc_B_ex, SRP_Calc_u_ex, SRP_Calc_client_key_ex and SRP_Calc_x_ex were
143 introduced in OpenSSL 3.0.
144 .PP
145 All of the other functions were added in OpenSSL 1.0.1.
146 .PP
147 All of these functions were deprecated in OpenSSL 3.0.
148 .SH COPYRIGHT
149 .IX Header "COPYRIGHT"
150 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
151 .PP
152 Licensed under the Apache License 2.0 (the "License"). You may not use
153 this file except in compliance with the License. You can obtain a copy
154 in the file LICENSE in the source distribution or at
155 <https://www.openssl.org/source/license.html>.