diff options
author | Pauli <pauli@openssl.org> | 2021-04-16 09:13:43 +1000 |
---|---|---|
committer | Pauli <pauli@openssl.org> | 2021-04-17 18:22:13 +1000 |
commit | e494fac705057c91017b41fa761f9406c87f4cc5 (patch) | |
tree | 133c928c393002291a2f0ef61de870ddc2cbe8ef /doc | |
parent | 7b9f02798f68d9108623f5879f3fc73c06f9a2c7 (diff) | |
download | openssl-e494fac705057c91017b41fa761f9406c87f4cc5.tar.gz |
Fix naming for EVP_RAND_CTX_gettable functions.
Change:
EVP_RAND_gettable_ctx_params -> EVP_RAND_CTX_gettable_params
EVP_RAND_settable_ctx_params -> EVP_RAND_CTX_settable_params
Which brings them in line with the other similar functions for other algorithm
types.
Fixes #14880
Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14893)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_RAND.pod | 14 | ||||
-rw-r--r-- | doc/man7/life_cycle-rand.pod | 8 |
2 files changed, 11 insertions, 11 deletions
diff --git a/doc/man3/EVP_RAND.pod b/doc/man3/EVP_RAND.pod index 23906da5ba..b2d1e18417 100644 --- a/doc/man3/EVP_RAND.pod +++ b/doc/man3/EVP_RAND.pod @@ -9,8 +9,8 @@ EVP_RAND_enable_locking, EVP_RAND_verify_zeroization, EVP_RAND_strength, EVP_RAND_state, EVP_RAND_provider, EVP_RAND_CTX_rand, EVP_RAND_is_a, EVP_RAND_number, EVP_RAND_name, EVP_RAND_names_do_all, EVP_RAND_description, -EVP_RAND_get_ctx_params, -EVP_RAND_set_ctx_params, EVP_RAND_do_all_provided, EVP_RAND_get_params, +EVP_RAND_CTX_get_params, +EVP_RAND_CTX_set_params, EVP_RAND_do_all_provided, EVP_RAND_get_params, EVP_RAND_gettable_ctx_params, EVP_RAND_settable_ctx_params, EVP_RAND_CTX_gettable_params, EVP_RAND_CTX_settable_params, EVP_RAND_gettable_params, EVP_RAND_STATE_UNINITIALISED, EVP_RAND_STATE_READY, @@ -31,8 +31,8 @@ EVP_RAND_STATE_ERROR - EVP RAND routines void EVP_RAND_CTX_free(EVP_RAND_CTX *ctx); EVP_RAND *EVP_RAND_CTX_rand(EVP_RAND_CTX *ctx); int EVP_RAND_get_params(EVP_RAND *rand, OSSL_PARAM params[]); - int EVP_RAND_get_ctx_params(EVP_RAND_CTX *ctx, OSSL_PARAM params[]); - int EVP_RAND_set_ctx_params(EVP_RAND_CTX *ctx, const OSSL_PARAM params[]); + int EVP_RAND_CTX_get_params(EVP_RAND_CTX *ctx, OSSL_PARAM params[]); + int EVP_RAND_CTX_set_params(EVP_RAND_CTX *ctx, const OSSL_PARAM params[]); const OSSL_PARAM *EVP_RAND_gettable_params(const EVP_RAND *rand); const OSSL_PARAM *EVP_RAND_gettable_ctx_params(const EVP_RAND *rand); const OSSL_PARAM *EVP_RAND_settable_ctx_params(const EVP_RAND *rand); @@ -83,7 +83,7 @@ RAND and RAND_DRBG functions. After creating a B<EVP_RAND_CTX> for the required algorithm using EVP_RAND_CTX_new(), inputs to the algorithm are supplied either by passing them as part of the EVP_RAND_instantiate() call or using calls to -EVP_RAND_set_ctx_params() before calling EVP_RAND_instantiate(). Finally, +EVP_RAND_CTX_set_params() before calling EVP_RAND_instantiate(). Finally, call EVP_RAND_generate() to produce cryptographically secure random bytes. =head2 Types @@ -170,14 +170,14 @@ parameters should be retrieved. Note that a parameter that is unknown in the underlying context is simply ignored. -EVP_RAND_get_ctx_params() retrieves chosen parameters, given the +EVP_RAND_CTX_get_params() retrieves chosen parameters, given the context I<ctx> and its underlying context. The set of parameters given with I<params> determine exactly what parameters should be retrieved. Note that a parameter that is unknown in the underlying context is simply ignored. -EVP_RAND_set_ctx_params() passes chosen parameters to the underlying +EVP_RAND_CTX_set_params() passes chosen parameters to the underlying context, given a context I<ctx>. The set of parameters given with I<params> determine exactly what parameters are passed down. diff --git a/doc/man7/life_cycle-rand.pod b/doc/man7/life_cycle-rand.pod index b78b8484d2..5b3e81caa9 100644 --- a/doc/man7/life_cycle-rand.pod +++ b/doc/man7/life_cycle-rand.pod @@ -92,8 +92,8 @@ This is the canonical list. EVP_RAND_generate instantiated EVP_RAND_uninstantiate uninstantiated EVP_RAND_CTX_free freed freed freed freed - EVP_RAND_get_ctx_params newed instantiated uninstantiated freed - EVP_RAND_set_ctx_params newed instantiated uninstantiated freed + EVP_RAND_CTX_get_params newed instantiated uninstantiated freed + EVP_RAND_CTX_set_params newed instantiated uninstantiated freed EVP_RAND_CTX_gettable_params newed instantiated uninstantiated freed EVP_RAND_CTX_settable_params newed instantiated uninstantiated freed @@ -140,13 +140,13 @@ This is the canonical list. <td style="border:1px solid" align="center">freed</td> <td style="border:1px solid" align="center">freed</td> <td style="border:1px solid" align="center"></td></tr> -<tr><th style="border:1px solid" align="left">EVP_RAND_get_ctx_params</th> +<tr><th style="border:1px solid" align="left">EVP_RAND_CTX_get_params</th> <td style="border:1px solid" align="center"></td> <td style="border:1px solid" align="center">newed</td> <td style="border:1px solid" align="center">instantiated</td> <td style="border:1px solid" align="center">uninstantiated</td> <td style="border:1px solid" align="center"></td></tr> -<tr><th style="border:1px solid" align="left">EVP_RAND_set_ctx_params</th> +<tr><th style="border:1px solid" align="left">EVP_RAND_CTX_set_params</th> <td style="border:1px solid" align="center"></td> <td style="border:1px solid" align="center">newed</td> <td style="border:1px solid" align="center">instantiated</td> |