diff options
author | Pauli <ppzgs1@gmail.com> | 2021-02-23 10:45:39 +1000 |
---|---|---|
committer | Pauli <ppzgs1@gmail.com> | 2021-02-26 18:08:41 +1000 |
commit | 530cacb56fbe02da8aca436c4c1ae8000200e69c (patch) | |
tree | 04a646884c230982e93cad067f3d1ff60c208ecf | |
parent | caa60428cd8f0aa60cd2fb7e6da4f5aa9664ae16 (diff) | |
download | openssl-530cacb56fbe02da8aca436c4c1ae8000200e69c.tar.gz |
doc: changes to match the updated context gettable/settable calls
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14240)
-rw-r--r-- | doc/man3/EVP_KDF.pod | 33 | ||||
-rw-r--r-- | doc/man7/provider-kdf.pod | 19 |
2 files changed, 37 insertions, 15 deletions
diff --git a/doc/man3/EVP_KDF.pod b/doc/man3/EVP_KDF.pod index 3afc0bd9b1..90e8f5adcf 100644 --- a/doc/man3/EVP_KDF.pod +++ b/doc/man3/EVP_KDF.pod @@ -8,8 +8,9 @@ EVP_KDF_CTX_reset, EVP_KDF_derive, EVP_KDF_CTX_get_kdf_size, EVP_KDF_provider, EVP_KDF_CTX_kdf, EVP_KDF_is_a, EVP_KDF_number, EVP_KDF_name, EVP_KDF_names_do_all, EVP_KDF_CTX_get_params, EVP_KDF_CTX_set_params, EVP_KDF_do_all_provided, -EVP_KDF_get_params, EVP_KDF_gettable_ctx_params, EVP_KDF_settable_ctx_params, -EVP_KDF_gettable_params - EVP KDF routines +EVP_KDF_get_params, EVP_KDF_gettable_params, +EVP_KDF_gettable_ctx_params, EVP_KDF_settable_ctx_params, +EVP_KDF_CTX_gettable_params, EVP_KDF_CTX_settable_params - EVP KDF routines =head1 SYNOPSIS @@ -45,6 +46,8 @@ EVP_KDF_gettable_params - EVP KDF routines const OSSL_PARAM *EVP_KDF_gettable_params(const EVP_KDF *kdf); const OSSL_PARAM *EVP_KDF_gettable_ctx_params(const EVP_KDF *kdf); const OSSL_PARAM *EVP_KDF_settable_ctx_params(const EVP_KDF *kdf); + const OSSL_PARAM *EVP_KDF_CTX_gettable_params(const EVP_KDF *kdf); + const OSSL_PARAM *EVP_KDF_CTX_settable_params(const EVP_KDF *kdf); const OSSL_PROVIDER *EVP_KDF_provider(const EVP_KDF *kdf); =head1 DESCRIPTION @@ -124,12 +127,26 @@ simply ignored. Also, what happens when a needed parameter isn't passed down is defined by the implementation. -EVP_KDF_gettable_params(), EVP_KDF_gettable_ctx_params() and -EVP_KDF_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_KDF_get_params(), EVP_KDF_CTX_get_params() -and EVP_KDF_CTX_set_params(), respectively. -See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor. +EVP_KDF_gettable_params() returns an B<OSSL_PARAM> array that describes +the retrievable and settable parameters. EVP_KDF_gettable_params() +returns parameters that can be used with EVP_KDF_get_params(). +See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as a parameter descriptor. + +EVP_KDF_gettable_ctx_params() and EVP_KDF_CTX_gettable_params() +return constant B<OSSL_PARAM> arrays that describe the retrievable +parameters that can be used with EVP_KDF_CTX_get_params(). +EVP_KDF_gettable_ctx_params() returns the parameters that can be retrieved +from the algorithm, whereas EVP_KDF_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_KDF_settable_ctx_params() and EVP_KDF_CTX_settable_params() return +constant B<OSSL_PARAM> arrays that describe the settable parameters that +can be used with EVP_KDF_CTX_set_params(). EVP_KDF_settable_ctx_params() +returns the parameters that can be retrieved from the algorithm, +whereas EVP_KDF_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-kdf.pod b/doc/man7/provider-kdf.pod index 8e2069e34a..4d3d91a4e7 100644 --- a/doc/man7/provider-kdf.pod +++ b/doc/man7/provider-kdf.pod @@ -28,8 +28,8 @@ provider-kdf - The KDF library E<lt>-E<gt> provider functions /* KDF parameter descriptors */ const OSSL_PARAM *OSSL_FUNC_kdf_gettable_params(void *provctx); - const OSSL_PARAM *OSSL_FUNC_kdf_gettable_ctx_params(void *provctx); - const OSSL_PARAM *OSSL_FUNC_kdf_settable_ctx_params(void *provctx); + const OSSL_PARAM *OSSL_FUNC_kdf_gettable_ctx_params(void *kcxt, void *provctx); + const OSSL_PARAM *OSSL_FUNC_kdf_settable_ctx_params(void *kcxt, void *provctx); /* KDF parameters */ int OSSL_FUNC_kdf_get_params(OSSL_PARAM params[]); @@ -129,11 +129,16 @@ Any parameter settings are additional to any that were previously set. OSSL_FUNC_kdf_get_ctx_params() retrieves gettable parameter values associated with the given provider side KDF context I<kctx> and stores them in I<params>. -OSSL_FUNC_kdf_gettable_params(), OSSL_FUNC_kdf_gettable_ctx_params(), and -OSSL_FUNC_kdf_settable_ctx_params() all return constant B<OSSL_PARAM> arrays -as descriptors of the parameters that OSSL_FUNC_kdf_get_params(), -OSSL_FUNC_kdf_get_ctx_params(), and OSSL_FUNC_kdf_set_ctx_params() can handle, -respectively. +OSSL_FUNC_kdf_gettable_params(), OSSL_FUNC_kdf_gettable_ctx_params(), +and OSSL_FUNC_kdf_settable_ctx_params() all return constant B<OSSL_PARAM> +arrays as descriptors of the parameters that OSSL_FUNC_kdf_get_params(), +OSSL_FUNC_kdf_get_ctx_params(), and OSSL_FUNC_kdf_set_ctx_params() +can handle, respectively. OSSL_FUNC_kdf_gettable_ctx_params() and +OSSL_FUNC_kdf_settable_ctx_params() will return the parameters associated +with the provider side context I<kctx> 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 KDFs are as follows. Not all parameters are relevant to, or are understood by all KDFs: |