diff options
author | Pauli <paul.dale@oracle.com> | 2020-07-04 10:48:19 +1000 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2020-07-14 19:20:11 +1000 |
commit | ce3080e931d77fda3bb4f2d923fcc6cec967d1a3 (patch) | |
tree | 42f8130d22bf3d349f855d7b7a32fe14bc7b0f77 /doc/man3 | |
parent | d35bab46c9e5edfeadc756bac9dc38213f172c07 (diff) |
DRBG: rename the DRBG taxonomy.
The existing wording didn't capture the reality of the default setup, this new
nomenclature attempts to improve the situation.
Reviewed-by: Mark J. Cox <mark@awe.com>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/12366)
Diffstat (limited to 'doc/man3')
-rw-r--r-- | doc/man3/RAND_DRBG_get0_public.pod (renamed from doc/man3/RAND_DRBG_get0_master.pod) | 10 | ||||
-rw-r--r-- | doc/man3/RAND_DRBG_new.pod | 2 | ||||
-rw-r--r-- | doc/man3/RAND_DRBG_reseed.pod | 24 |
3 files changed, 18 insertions, 18 deletions
diff --git a/doc/man3/RAND_DRBG_get0_master.pod b/doc/man3/RAND_DRBG_get0_public.pod index 77d0ab70a5..33062a9e7e 100644 --- a/doc/man3/RAND_DRBG_get0_master.pod +++ b/doc/man3/RAND_DRBG_get0_public.pod @@ -2,7 +2,7 @@ =head1 NAME -OPENSSL_CTX_get0_master_drbg, +OPENSSL_CTX_get0_primary_drbg, OPENSSL_CTX_get0_public_drbg, OPENSSL_CTX_get0_private_drbg, RAND_DRBG_get0_master, @@ -14,7 +14,7 @@ RAND_DRBG_get0_private #include <openssl/rand_drbg.h> - RAND_DRBG *OPENSSL_CTX_get0_master_drbg(OPENSSL_CTX *ctx); + RAND_DRBG *OPENSSL_CTX_get0_primary_drbg(OPENSSL_CTX *ctx); RAND_DRBG *OPENSSL_CTX_get0_public_drbg(OPENSSL_CTX *ctx); RAND_DRBG *OPENSSL_CTX_get0_private_drbg(OPENSSL_CTX *ctx); RAND_DRBG *RAND_DRBG_get0_master(void); @@ -36,7 +36,7 @@ These functions here provide access to the shared DRBG instances. =head1 RETURN VALUES -OPENSSL_CTX_get0_master_drbg() returns a pointer to the I<master> DRBG instance +OPENSSL_CTX_get0_primary_drbg() returns a pointer to the I<master> DRBG instance for the given OPENSSL_CTX B<ctx>. OPENSSL_CTX_get0_public_drbg() returns a pointer to the I<public> DRBG instance @@ -48,7 +48,7 @@ for the given OPENSSL_CTX B<ctx>. In all the above cases the B<ctx> parameter can be NULL in which case the default OPENSSL_CTX is used. RAND_DRBG_get0_master(), RAND_DRBG_get0_public() and RAND_DRBG_get0_private() are the same as -OPENSSL_CTX_get0_master_drbg(), OPENSSL_CTX_get0_public_drbg() and +OPENSSL_CTX_get0_primary_drbg(), OPENSSL_CTX_get0_public_drbg() and OPENSSL_CTX_get0_private_drbg() respectively except that the default OPENSSL_CTX is always used. @@ -80,7 +80,7 @@ L<RAND_DRBG(7)> =head1 HISTORY -The OPENSSL_CTX_get0_master_drbg(), OPENSSL_CTX_get0_public_drbg() and +The OPENSSL_CTX_get0_primary_drbg(), OPENSSL_CTX_get0_public_drbg() and OPENSSL_CTX_get0_private_drbg() functions were added in OpenSSL 3.0. All other RAND_DRBG functions were added in OpenSSL 1.1.1. diff --git a/doc/man3/RAND_DRBG_new.pod b/doc/man3/RAND_DRBG_new.pod index d8b9633c7a..340fccdce6 100644 --- a/doc/man3/RAND_DRBG_new.pod +++ b/doc/man3/RAND_DRBG_new.pod @@ -84,7 +84,7 @@ see [NIST SP 800-90A Rev. 1]. Enables use of HMAC instead of the HASH DRBG. -=item RAND_DRBG_FLAG_MASTER +=item RAND_DRBG_FLAG_PRIMARY =item RAND_DRBG_FLAG_PUBLIC diff --git a/doc/man3/RAND_DRBG_reseed.pod b/doc/man3/RAND_DRBG_reseed.pod index b73f35fb66..a0878151e4 100644 --- a/doc/man3/RAND_DRBG_reseed.pod +++ b/doc/man3/RAND_DRBG_reseed.pod @@ -23,10 +23,10 @@ RAND_DRBG_set_reseed_defaults time_t interval); int RAND_DRBG_set_reseed_defaults( - unsigned int master_reseed_interval, - unsigned int slave_reseed_interval, - time_t master_reseed_time_interval, - time_t slave_reseed_time_interval + unsigned int primary_reseed_interval, + unsigned int secondary_reseed_interval, + time_t primary_reseed_time_interval, + time_t secondary_reseed_time_interval ); @@ -60,12 +60,13 @@ elapsed time since its last reseeding exceeds the given reseed time interval. If B<interval> == 0, then this feature is disabled. RAND_DRBG_set_reseed_defaults() sets the default values for the reseed interval -(B<master_reseed_interval> and B<slave_reseed_interval>) +(B<primary_reseed_interval> and B<secondary_reseed_interval>) and the reseed time interval -(B<master_reseed_time_interval> and B<slave_reseed_tme_interval>) +(B<primary_reseed_time_interval> and B<secondary_reseed_tme_interval>) of DRBG instances. -The default values are set independently for master DRBG instances (which don't -have a parent) and slave DRBG instances (which are chained to a parent DRBG). +The default values are set independently for primary DRBG instances (which don't +have a parent) and secondary DRBG instances (which are chained to a parent +DRBG). =head1 RETURN VALUES @@ -74,7 +75,6 @@ RAND_DRBG_set_reseed_interval(), and RAND_DRBG_set_reseed_time_interval(), return 1 on success, 0 on failure. - =head1 NOTES The default OpenSSL random generator is already set up for automatic reseeding, @@ -89,9 +89,9 @@ by providing application defined callbacks using RAND_DRBG_set_callbacks(). The reseeding default values are applied only during creation of a DRBG instance. To ensure that they are applied to the global and thread-local DRBG instances -(<master>, resp. <public> and <private>), it is necessary to call -RAND_DRBG_set_reseed_defaults() before creating any thread and before calling any - cryptographic routines that obtain random data directly or indirectly. +(<primary>, resp. <public> and <private>), it is necessary to call +RAND_DRBG_set_reseed_defaults() before creating any thread and before calling +any cryptographic routines that obtain random data directly or indirectly. =head1 SEE ALSO |