| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | SRP_user_pwd_new,
|
|---|
| 6 | SRP_user_pwd_free,
|
|---|
| 7 | SRP_user_pwd_set1_ids,
|
|---|
| 8 | SRP_user_pwd_set_gN,
|
|---|
| 9 | SRP_user_pwd_set0_sv
|
|---|
| 10 | - Functions to create a record of SRP user verifier information
|
|---|
| 11 |
|
|---|
| 12 | =head1 SYNOPSIS
|
|---|
| 13 |
|
|---|
| 14 | #include <openssl/srp.h>
|
|---|
| 15 |
|
|---|
| 16 | The following functions have been deprecated since OpenSSL 3.0, and can be
|
|---|
| 17 | hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
|
|---|
| 18 | see L<openssl_user_macros(7)>:
|
|---|
| 19 |
|
|---|
| 20 | SRP_user_pwd *SRP_user_pwd_new(void);
|
|---|
| 21 | void SRP_user_pwd_free(SRP_user_pwd *user_pwd);
|
|---|
| 22 |
|
|---|
| 23 | int SRP_user_pwd_set1_ids(SRP_user_pwd *user_pwd, const char *id, const char *info);
|
|---|
| 24 | void SRP_user_pwd_set_gN(SRP_user_pwd *user_pwd, const BIGNUM *g, const BIGNUM *N);
|
|---|
| 25 | int SRP_user_pwd_set0_sv(SRP_user_pwd *user_pwd, BIGNUM *s, BIGNUM *v);
|
|---|
| 26 |
|
|---|
| 27 | =head1 DESCRIPTION
|
|---|
| 28 |
|
|---|
| 29 | All of the functions described on this page are deprecated. There are no
|
|---|
| 30 | available replacement functions at this time.
|
|---|
| 31 |
|
|---|
| 32 | The SRP_user_pwd_new() function allocates a structure to store a user verifier
|
|---|
| 33 | record.
|
|---|
| 34 |
|
|---|
| 35 | The SRP_user_pwd_free() function frees up the B<user_pwd> structure.
|
|---|
| 36 | If B<user_pwd> is NULL, nothing is done.
|
|---|
| 37 |
|
|---|
| 38 | The SRP_user_pwd_set1_ids() function sets the username to B<id> and the optional
|
|---|
| 39 | user info to B<info> for B<user_pwd>.
|
|---|
| 40 | The library allocates new copies of B<id> and B<info>, the caller still
|
|---|
| 41 | owns the original memory.
|
|---|
| 42 |
|
|---|
| 43 | The SRP_user_pwd_set0_sv() function sets the user salt to B<s> and the verifier
|
|---|
| 44 | to B<v> for B<user_pwd>.
|
|---|
| 45 | The library takes ownership of the values, they should not be freed by the caller.
|
|---|
| 46 |
|
|---|
| 47 | The SRP_user_pwd_set_gN() function sets the SRP group parameters for B<user_pwd>.
|
|---|
| 48 | The memory is not freed by SRP_user_pwd_free(), the caller must make sure it is
|
|---|
| 49 | freed once it is no longer used.
|
|---|
| 50 |
|
|---|
| 51 | =head1 RETURN VALUES
|
|---|
| 52 |
|
|---|
| 53 | SRP_user_pwd_set1_ids() returns 1 on success and 0 on failure or if B<id> was NULL.
|
|---|
| 54 |
|
|---|
| 55 | SRP_user_pwd_set0_sv() returns 1 if both B<s> and B<v> are not NULL, 0 otherwise.
|
|---|
| 56 |
|
|---|
| 57 | =head1 SEE ALSO
|
|---|
| 58 |
|
|---|
| 59 | L<openssl-srp(1)>,
|
|---|
| 60 | L<SRP_create_verifier(3)>,
|
|---|
| 61 | L<SRP_VBASE_new(3)>,
|
|---|
| 62 | L<SSL_CTX_set_srp_password(3)>
|
|---|
| 63 |
|
|---|
| 64 | =head1 HISTORY
|
|---|
| 65 |
|
|---|
| 66 | These functions were made public in OpenSSL 3.0 and are deprecated.
|
|---|
| 67 |
|
|---|
| 68 | =head1 COPYRIGHT
|
|---|
| 69 |
|
|---|
| 70 | Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 71 |
|
|---|
| 72 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 73 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 74 | in the file LICENSE in the source distribution or at
|
|---|
| 75 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 76 |
|
|---|
| 77 | =cut
|
|---|
