$NetBSD: SRP_user_pwd_new.3,v 1.5 2024/09/08 13:08:30 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, 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.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SRP_user_pwd_new 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids, SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv \- Functions to create a record of SRP user verifier information Header "SYNOPSIS" .Vb 1 #include <openssl/srp.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 2 SRP_user_pwd *SRP_user_pwd_new(void); void SRP_user_pwd_free(SRP_user_pwd *user_pwd); \& int SRP_user_pwd_set1_ids(SRP_user_pwd *user_pwd, const char *id, const char *info); void SRP_user_pwd_set_gN(SRP_user_pwd *user_pwd, const BIGNUM *g, const BIGNUM *N); int SRP_user_pwd_set0_sv(SRP_user_pwd *user_pwd, BIGNUM *s, BIGNUM *v); .Ve

Header "DESCRIPTION" All of the functions described on this page are deprecated. There are no available replacement functions at this time.

The SRP_user_pwd_new() function allocates a structure to store a user verifier record.

The SRP_user_pwd_free() function frees up the user_pwd structure. If user_pwd is NULL, nothing is done.

The SRP_user_pwd_set1_ids() function sets the username to id and the optional user info to info for user_pwd. The library allocates new copies of id and info, the caller still owns the original memory.

The SRP_user_pwd_set0_sv() function sets the user salt to s and the verifier to v for user_pwd. The library takes ownership of the values, they should not be freed by the caller.

The SRP_user_pwd_set_gN() function sets the SRP group parameters for user_pwd. The memory is not freed by SRP_user_pwd_free(), the caller must make sure it is freed once it is no longer used.

Header "RETURN VALUES" \fBSRP_user_pwd_set1_ids() returns 1 on success and 0 on failure or if id was NULL.

\fBSRP_user_pwd_set0_sv() returns 1 if both s and v are not NULL, 0 otherwise.

Header "SEE ALSO" \fBopenssl-srp\|(1), \fBSRP_create_verifier\|(3), \fBSRP_VBASE_new\|(3), \fBSSL_CTX_set_srp_password\|(3) Header "HISTORY" These functions were made public in OpenSSL 3.0 and are deprecated. Header "COPYRIGHT" Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.