[thirdparty/openssl.git] / doc / man3 / SRP_VBASE_new.pod

=pod

=head1 NAME

SRP_VBASE_new,
SRP_VBASE_free,
SRP_VBASE_init,
SRP_VBASE_add0_user,
SRP_VBASE_get1_by_user,
SRP_VBASE_get_by_user
- Functions to create and manage a stack of SRP user verifier information

=head1 SYNOPSIS

 #include <openssl/srp.h>

Deprecated since OpenSSL 3.0, can be hidden entirely by defining
B<OPENSSL_API_COMPAT> with a suitable version value, see
L<openssl_user_macros(7)>:

 SRP_VBASE *SRP_VBASE_new(char *seed_key);
 void SRP_VBASE_free(SRP_VBASE *vb);

 int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file);

 int SRP_VBASE_add0_user(SRP_VBASE *vb, SRP_user_pwd *user_pwd);
 SRP_user_pwd *SRP_VBASE_get1_by_user(SRP_VBASE *vb, char *username);
 SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username);

=head1 DESCRIPTION

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

The SRP_VBASE_new() function allocates a structure to store server side SRP
verifier information.
If B<seed_key> is not NULL a copy is stored and used to generate dummy parameters
for users that are not found by SRP_VBASE_get1_by_user(). This allows the server
to hide the fact that it doesn't have a verifier for a particular username,
as described in section 2.5.1.3 'Unknown SRP' of RFC 5054.
The seed string should contain random NUL terminated binary data (therefore
the random data should not contain NUL bytes!).

The SRP_VBASE_free() function frees up the B<vb> structure.
If B<vb> is NULL, nothing is done.

The SRP_VBASE_init() function parses the information in a verifier file and
populates the B<vb> structure.
The verifier file is a text file containing multiple entries, whose format is:
flag base64(verifier) base64(salt) username gNid userinfo(optional)
where the flag can be 'V' (valid) or 'R' (revoked).
Note that the base64 encoding used here is non-standard so it is recommended
to use L<openssl-srp(1)> to generate this file.

The SRP_VBASE_add0_user() function adds the B<user_pwd> verifier information
to the B<vb> structure. See L<SRP_user_pwd_new(3)> to create and populate this
record.
The library takes ownership of B<user_pwd>, it should not be freed by the caller.

The SRP_VBASE_get1_by_user() function returns the password info for the user
whose username matches B<username>. It replaces the deprecated
SRP_VBASE_get_by_user().
If no matching user is found but a seed_key and default gN parameters have been
set, dummy authentication information is generated from the seed_key, allowing
the server to hide the fact that it doesn't have a verifier for a particular
username. When using SRP as a TLS authentication mechanism, this will cause
the handshake to proceed normally but the first client will be rejected with
a "bad_record_mac" alert, as if the password was incorrect.
If no matching user is found and the seed_key is not set, NULL is returned.
Ownership of the returned pointer is released to the caller, it must be freed
with SRP_user_pwd_free().

=head1 RETURN VALUES

SRP_VBASE_init() returns B<SRP_NO_ERROR> (0) on success and a positive value
on failure.
The error codes are B<SRP_ERR_OPEN_FILE> if the file could not be opened,
B<SRP_ERR_VBASE_INCOMPLETE_FILE> if the file could not be parsed,
B<SRP_ERR_MEMORY> on memory allocation failure and B<SRP_ERR_VBASE_BN_LIB>
for invalid decoded parameter values.

SRP_VBASE_add0_user() returns 1 on success and 0 on failure.

=head1 SEE ALSO

L<openssl-srp(1)>,
L<SRP_create_verifier(3)>,
L<SRP_user_pwd_new(3)>,
L<SSL_CTX_set_srp_password(3)>

=head1 HISTORY

The SRP_VBASE_add0_user() function was added in OpenSSL 3.0.

All other functions were added in OpenSSL 1.0.1.

All of these functions were deprecated in OpenSSL 3.0.

=head1 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
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
495a1e5c AS	1	=pod
	2
	3	=head1 NAME
	4
	5	SRP_VBASE_new,
	6	SRP_VBASE_free,
495a1e5c	7	SRP_VBASE_init,
51f03f12	8	SRP_VBASE_add0_user,
495a1e5c AS	9	SRP_VBASE_get1_by_user,
	10	SRP_VBASE_get_by_user
	11	- Functions to create and manage a stack of SRP user verifier information
	12
	13	=head1 SYNOPSIS
	14
	15	#include <openssl/srp.h>
	16
13888e79 MC	17	Deprecated since OpenSSL 3.0, can be hidden entirely by defining
	18	B<OPENSSL_API_COMPAT> with a suitable version value, see
	19	L<openssl_user_macros(7)>:
	20
495a1e5c AS	21	SRP_VBASE SRP_VBASE_new(char seed_key);
495a1e5c AS	22	void SRP_VBASE_free(SRP_VBASE *vb);
495a1e5c AS	23
	24	int SRP_VBASE_init(SRP_VBASE vb, char verifier_file);
	25
51f03f12	26	int SRP_VBASE_add0_user(SRP_VBASE vb, SRP_user_pwd user_pwd);
495a1e5c AS	27	SRP_user_pwd SRP_VBASE_get1_by_user(SRP_VBASE vb, char *username);
	28	SRP_user_pwd SRP_VBASE_get_by_user(SRP_VBASE vb, char *username);
	29
	30	=head1 DESCRIPTION
	31
13888e79 MC	32	All of the functions described on this page are deprecated. There are no
	33	available replacement functions at this time.
	34
495a1e5c	35	The SRP_VBASE_new() function allocates a structure to store server side SRP
ebfd055b AS	36	verifier information.
	37	If B<seed_key> is not NULL a copy is stored and used to generate dummy parameters
	38	for users that are not found by SRP_VBASE_get1_by_user(). This allows the server
	39	to hide the fact that it doesn't have a verifier for a particular username,
	40	as described in section 2.5.1.3 'Unknown SRP' of RFC 5054.
495a1e5c AS	41	The seed string should contain random NUL terminated binary data (therefore
	42	the random data should not contain NUL bytes!).
	43
	44	The SRP_VBASE_free() function frees up the B<vb> structure.
	45	If B<vb> is NULL, nothing is done.
	46
495a1e5c AS	47	The SRP_VBASE_init() function parses the information in a verifier file and
	48	populates the B<vb> structure.
	49	The verifier file is a text file containing multiple entries, whose format is:
	50	flag base64(verifier) base64(salt) username gNid userinfo(optional)
	51	where the flag can be 'V' (valid) or 'R' (revoked).
	52	Note that the base64 encoding used here is non-standard so it is recommended
1903a9b7	53	to use L<openssl-srp(1)> to generate this file.
495a1e5c	54
51f03f12	55	The SRP_VBASE_add0_user() function adds the B<user_pwd> verifier information
ebfd055b AS	56	to the B<vb> structure. See L<SRP_user_pwd_new(3)> to create and populate this
ebfd055b AS	57	record.
51f03f12 AS	58	The library takes ownership of B<user_pwd>, it should not be freed by the caller.
51f03f12 AS	59
495a1e5c AS	60	The SRP_VBASE_get1_by_user() function returns the password info for the user
	61	whose username matches B<username>. It replaces the deprecated
	62	SRP_VBASE_get_by_user().
	63	If no matching user is found but a seed_key and default gN parameters have been
	64	set, dummy authentication information is generated from the seed_key, allowing
	65	the server to hide the fact that it doesn't have a verifier for a particular
	66	username. When using SRP as a TLS authentication mechanism, this will cause
	67	the handshake to proceed normally but the first client will be rejected with
	68	a "bad_record_mac" alert, as if the password was incorrect.
	69	If no matching user is found and the seed_key is not set, NULL is returned.
	70	Ownership of the returned pointer is released to the caller, it must be freed
	71	with SRP_user_pwd_free().
	72
	73	=head1 RETURN VALUES
	74
	75	SRP_VBASE_init() returns B<SRP_NO_ERROR> (0) on success and a positive value
	76	on failure.
	77	The error codes are B<SRP_ERR_OPEN_FILE> if the file could not be opened,
	78	B<SRP_ERR_VBASE_INCOMPLETE_FILE> if the file could not be parsed,
	79	B<SRP_ERR_MEMORY> on memory allocation failure and B<SRP_ERR_VBASE_BN_LIB>
	80	for invalid decoded parameter values.
	81
51f03f12 AS	82	SRP_VBASE_add0_user() returns 1 on success and 0 on failure.
51f03f12 AS	83
495a1e5c AS	84	=head1 SEE ALSO
495a1e5c AS	85
1903a9b7	86	L<openssl-srp(1)>,
495a1e5c	87	L<SRP_create_verifier(3)>,
ebfd055b	88	L<SRP_user_pwd_new(3)>,
495a1e5c AS	89	L<SSL_CTX_set_srp_password(3)>
	90
	91	=head1 HISTORY
	92
4674aaf4	93	The SRP_VBASE_add0_user() function was added in OpenSSL 3.0.
51f03f12	94
fc5ecadd	95	All other functions were added in OpenSSL 1.0.1.
495a1e5c	96
13888e79 MC	97	All of these functions were deprecated in OpenSSL 3.0.
13888e79 MC	98
495a1e5c AS	99	=head1 COPYRIGHT
495a1e5c AS	100
a28d06f3	101	Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
495a1e5c	102
4746f25a	103	Licensed under the Apache License 2.0 (the "License"). You may not use
495a1e5c AS	104	this file except in compliance with the License. You can obtain a copy
	105	in the file LICENSE in the source distribution or at
	106	L<https://www.openssl.org/source/license.html>.
	107
	108	=cut