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