Debian Codegraph @

upstream/debian-unstable/man3/SRP_user_pwd_new.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_USER_PWD_NEW 3SSL"
58 .TH SRP_USER_PWD_NEW 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_user_pwd_new,
65 SRP_user_pwd_free,
66 SRP_user_pwd_set1_ids,
67 SRP_user_pwd_set_gN,
68 SRP_user_pwd_set0_sv
69 \&\- Functions to create a record of SRP user verifier information
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 1
73 \& #include <openssl/srp.h>
74 .Ve
75 .PP
76 The following functions have been deprecated since OpenSSL 3.0, and can be
77 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
78 see \fBopenssl_user_macros\fR\|(7):
79 .PP
80 .Vb 2
81 \& SRP_user_pwd *SRP_user_pwd_new(void);
82 \& void SRP_user_pwd_free(SRP_user_pwd *user_pwd);
83 \&
84 \& int SRP_user_pwd_set1_ids(SRP_user_pwd *user_pwd, const char *id, const char *info);
85 \& void SRP_user_pwd_set_gN(SRP_user_pwd *user_pwd, const BIGNUM *g, const BIGNUM *N);
86 \& int SRP_user_pwd_set0_sv(SRP_user_pwd *user_pwd, BIGNUM *s, BIGNUM *v);
87 .Ve
88 .SH DESCRIPTION
89 .IX Header "DESCRIPTION"
90 All of the functions described on this page are deprecated. There are no
91 available replacement functions at this time.
92 .PP
93 The \fBSRP_user_pwd_new()\fR function allocates a structure to store a user verifier
94 record.
95 .PP
96 The \fBSRP_user_pwd_free()\fR function frees up the \fBuser_pwd\fR structure.
97 If \fBuser_pwd\fR is NULL, nothing is done.
98 .PP
99 The \fBSRP_user_pwd_set1_ids()\fR function sets the username to \fBid\fR and the optional
100 user info to \fBinfo\fR for \fBuser_pwd\fR.
101 The library allocates new copies of \fBid\fR and \fBinfo\fR, the caller still
102 owns the original memory.
103 .PP
104 The \fBSRP_user_pwd_set0_sv()\fR function sets the user salt to \fBs\fR and the verifier
105 to \fBv\fR for \fBuser_pwd\fR.
106 The library takes ownership of the values, they should not be freed by the caller.
107 .PP
108 The \fBSRP_user_pwd_set_gN()\fR function sets the SRP group parameters for \fBuser_pwd\fR.
109 The memory is not freed by \fBSRP_user_pwd_free()\fR, the caller must make sure it is
110 freed once it is no longer used.
111 .SH "RETURN VALUES"
112 .IX Header "RETURN VALUES"
113 \&\fBSRP_user_pwd_set1_ids()\fR returns 1 on success and 0 on failure or if \fBid\fR was NULL.
114 .PP
115 \&\fBSRP_user_pwd_set0_sv()\fR returns 1 if both \fBs\fR and \fBv\fR are not NULL, 0 otherwise.
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 \&\fBopenssl\-srp\fR\|(1),
119 \&\fBSRP_create_verifier\fR\|(3),
120 \&\fBSRP_VBASE_new\fR\|(3),
121 \&\fBSSL_CTX_set_srp_password\fR\|(3)
122 .SH HISTORY
123 .IX Header "HISTORY"
124 These functions were made public in OpenSSL 3.0 and are deprecated.
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2018\-2021 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.