diff options
author | Pauli <ppzgs1@gmail.com> | 2021-02-23 09:50:17 +1000 |
---|---|---|
committer | Pauli <ppzgs1@gmail.com> | 2021-02-26 18:08:41 +1000 |
commit | 90fec26dc681bec9af25fb5bd232109f1f261965 (patch) | |
tree | afc5914190c385dcca75c60c49c9595acfc3cc44 /doc | |
parent | d618ac6fd7e24a99122b04cd23b84130b2537d87 (diff) |
doc: note changes to rand gettable/settable provider call
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14240)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_RAND.pod | 29 | ||||
-rw-r--r-- | doc/man7/provider-rand.pod | 19 |
2 files changed, 35 insertions, 13 deletions
diff --git a/doc/man3/EVP_RAND.pod b/doc/man3/EVP_RAND.pod index df92629780..88ee739d94 100644 --- a/doc/man3/EVP_RAND.pod +++ b/doc/man3/EVP_RAND.pod @@ -11,6 +11,7 @@ EVP_RAND_provider, EVP_RAND_CTX_rand, EVP_RAND_is_a, EVP_RAND_number, EVP_RAND_name, EVP_RAND_names_do_all, EVP_RAND_get_ctx_params, EVP_RAND_set_ctx_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, EVP_RAND_STATE_ERROR - EVP RAND routines @@ -34,6 +35,8 @@ EVP_RAND_STATE_ERROR - EVP RAND routines 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); + const OSSL_PARAM *EVP_RAND_CTX_gettable_params(EVP_RAND_CTX *ctx); + const OSSL_PARAM *EVP_RAND_CTX_settable_params(EVP_RAND_CTX *ctx); int EVP_RAND_number(const EVP_RAND *rand); const char *EVP_RAND_name(const EVP_RAND *rand); int EVP_RAND_is_a(const EVP_RAND *rand, const char *name); @@ -179,12 +182,26 @@ simply ignored. Also, what happens when a needed parameter isn't passed down is defined by the implementation. -EVP_RAND_gettable_params(), EVP_RAND_gettable_ctx_params() and -EVP_RAND_settable_ctx_params() get a constant B<OSSL_PARAM> array that -describes the retrievable and settable parameters, i.e. parameters that -can be used with EVP_RAND_get_params(), EVP_RAND_get_ctx_params() -and EVP_RAND_set_ctx_params(), respectively. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor. +EVP_RAND_gettable_params() returns an B<OSSL_PARAM> array that describes +the retrievable and settable parameters. EVP_RAND_gettable_params() returns +parameters that can be used with EVP_RAND_get_params(). See L<OSSL_PARAM(3)> +for the use of B<OSSL_PARAM> as a parameter descriptor. + +EVP_RAND_gettable_ctx_params() and EVP_RAND_CTX_gettable_params() return +constant B<OSSL_PARAM> arrays that describe the retrievable parameters that +can be used with EVP_RAND_CTX_get_params(). EVP_RAND_gettable_ctx_params() +returns the parameters that can be retrieved from the algorithm, whereas +EVP_RAND_CTX_gettable_params() returns the parameters that can be retrieved +in the context's current state. See L<OSSL_PARAM(3)> for the use of +B<OSSL_PARAM> as a parameter descriptor. + +EVP_RAND_settable_ctx_params() and EVP_RAND_CTX_settable_params() return +constant B<OSSL_PARAM> arrays that describe the settable parameters that +can be used with EVP_RAND_CTX_set_params(). EVP_RAND_settable_ctx_params() +returns the parameters that can be retrieved from the algorithm, whereas +EVP_RAND_CTX_settable_params() returns the parameters that can be retrieved +in the context's current state. See L<OSSL_PARAM(3)> for the use of +B<OSSL_PARAM> as a parameter descriptor. =head2 Information functions diff --git a/doc/man7/provider-rand.pod b/doc/man7/provider-rand.pod index 3250e3c11a..5de3a15f38 100644 --- a/doc/man7/provider-rand.pod +++ b/doc/man7/provider-rand.pod @@ -53,8 +53,8 @@ functions /* RAND parameter descriptors */ const OSSL_PARAM *OSSL_FUNC_rand_gettable_params(void *provctx); - const OSSL_PARAM *OSSL_FUNC_rand_gettable_ctx_params(void *provctx); - const OSSL_PARAM *OSSL_FUNC_rand_settable_ctx_params(void *provctx); + const OSSL_PARAM *OSSL_FUNC_rand_gettable_ctx_params(void *ctx, void *provctx); + const OSSL_PARAM *OSSL_FUNC_rand_settable_ctx_params(void *ctx, void *provctx); /* RAND parameters */ int OSSL_FUNC_rand_get_params(OSSL_PARAM params[]); @@ -163,11 +163,16 @@ OSSL_FUNC_rand_get_ctx_params() gets details of currently set parameter values associated with the given provider side rand context I<ctx> and stores them in I<params>. -OSSL_FUNC_rand_gettable_params(), OSSL_FUNC_rand_gettable_ctx_params(), and -OSSL_FUNC_rand_settable_ctx_params() all return constant B<OSSL_PARAM> arrays -as descriptors of the parameters that OSSL_FUNC_rand_get_params(), -OSSL_FUNC_rand_get_ctx_params(), and OSSL_FUNC_rand_set_ctx_params() can handle, -respectively. +OSSL_FUNC_rand_gettable_params(), OSSL_FUNC_rand_gettable_ctx_params(), +and OSSL_FUNC_rand_settable_ctx_params() all return constant B<OSSL_PARAM> +arrays as descriptors of the parameters that OSSL_FUNC_rand_get_params(), +OSSL_FUNC_rand_get_ctx_params(), and OSSL_FUNC_rand_set_ctx_params() +can handle, respectively. OSSL_FUNC_rand_gettable_ctx_params() +and OSSL_FUNC_rand_settable_ctx_params() will return the parameters +associated with the provider side context I<ctx> in its current state +if it is not NULL. Otherwise, they return the parameters associated +with the provider side algorithm I<provctx>. + Parameters currently recognised by built-in rands are as follows. Not all parameters are relevant to, or are understood by all rands: |