Added SRP_VBASE_add0_user()
[openssl.git] / doc / man3 / SRP_VBASE_new.pod
index b235e58..76044ac 100644 (file)
@@ -6,6 +6,7 @@ SRP_VBASE_new,
 SRP_VBASE_free,
 SRP_user_pwd_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
@@ -20,6 +21,7 @@ SRP_VBASE_get_by_user
 
  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);
 
@@ -47,6 +49,10 @@ 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<srp(1)> to generate this file.
 
+The SRP_VBASE_add0_user() function adds the B<user_pwd> verifier information
+to the B<vb> structure.
+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().
@@ -69,6 +75,8 @@ 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<srp(1)>,
@@ -77,7 +85,9 @@ L<SSL_CTX_set_srp_password(3)>
 
 =head1 HISTORY
 
-These functions were first added to OpenSSL 1.0.1.
+SRP_VBASE_add0_user() was first added to OpenSSL 1.2.0.
+
+All other functions were first added to OpenSSL 1.0.1.
 
 =head1 COPYRIGHT