1SRP_USER_PWD_NEW(3ossl)             OpenSSL            SRP_USER_PWD_NEW(3ossl)
2
3
4

NAME

6       SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids,
7       SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv - Functions to create a
8       record of SRP user verifier information
9

SYNOPSIS

11        #include <openssl/srp.h>
12
13       The following functions have been deprecated since OpenSSL 3.0, and can
14       be hidden entirely by defining OPENSSL_API_COMPAT with a suitable
15       version value, see openssl_user_macros(7):
16
17        SRP_user_pwd *SRP_user_pwd_new(void);
18        void SRP_user_pwd_free(SRP_user_pwd *user_pwd);
19
20        int SRP_user_pwd_set1_ids(SRP_user_pwd *user_pwd, const char *id, const char *info);
21        void SRP_user_pwd_set_gN(SRP_user_pwd *user_pwd, const BIGNUM *g, const BIGNUM *N);
22        int SRP_user_pwd_set0_sv(SRP_user_pwd *user_pwd, BIGNUM *s, BIGNUM *v);
23

DESCRIPTION

25       All of the functions described on this page are deprecated. There are
26       no available replacement functions at this time.
27
28       The SRP_user_pwd_new() function allocates a structure to store a user
29       verifier record.
30
31       The SRP_user_pwd_free() function frees up the user_pwd structure.  If
32       user_pwd is NULL, nothing is done.
33
34       The SRP_user_pwd_set1_ids() function sets the username to id and the
35       optional user info to info for user_pwd.  The library allocates new
36       copies of id and info, the caller still owns the original memory.
37
38       The SRP_user_pwd_set0_sv() function sets the user salt to s and the
39       verifier to v for user_pwd.  The library takes ownership of the values,
40       they should not be freed by the caller.
41
42       The SRP_user_pwd_set_gN() function sets the SRP group parameters for
43       user_pwd.  The memory is not freed by SRP_user_pwd_free(), the caller
44       must make sure it is freed once it is no longer used.
45

RETURN VALUES

47       SRP_user_pwd_set1_ids() returns 1 on success and 0 on failure or if id
48       was NULL.
49
50       SRP_user_pwd_set0_sv() returns 1 if both s and v are not NULL, 0
51       otherwise.
52

SEE ALSO

54       openssl-srp(1), SRP_create_verifier(3), SRP_VBASE_new(3),
55       SSL_CTX_set_srp_password(3)
56

HISTORY

58       These functions were made public in OpenSSL 3.0 and are deprecated.
59

61       Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
62
63       Licensed under the Apache License 2.0 (the "License").  You may not use
64       this file except in compliance with the License.  You can obtain a copy
65       in the file LICENSE in the source distribution or at
66       <https://www.openssl.org/source/license.html>.
67
68
69
703.1.1                             2023-08-31           SRP_USER_PWD_NEW(3ossl)
Impressum