diff options
| author | Pauli <ppzgs1@gmail.com> | 2021-02-22 12:07:15 +1000 |
|---|---|---|
| committer | Pauli <ppzgs1@gmail.com> | 2021-02-26 18:08:41 +1000 |
| commit | d618ac6fd7e24a99122b04cd23b84130b2537d87 (patch) | |
| tree | bc69ccb6a03d6e1b33515708ac6f92a288823d40 /doc/man7 | |
| parent | 6de3a06dd45c68edd67b5ce1dbc94f3952a84a77 (diff) | |
doc: note changes to digest gettable/settable provider calls
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14240)
Diffstat (limited to 'doc/man7')
| -rw-r--r-- | doc/man7/provider-digest.pod | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod index 1c09ee3c40..4f90cf8b62 100644 --- a/doc/man7/provider-digest.pod +++ b/doc/man7/provider-digest.pod @@ -33,8 +33,10 @@ provider-digest - The digest library E<lt>-E<gt> provider functions const OSSL_PARAM *OSSL_FUNC_digest_gettable_params(void *provctx); /* Digest operation parameter descriptors */ - const OSSL_PARAM *OSSL_FUNC_digest_gettable_ctx_params(void *provctx); - const OSSL_PARAM *OSSL_FUNC_digest_settable_ctx_params(void *provctx); + const OSSL_PARAM *OSSL_FUNC_digest_gettable_ctx_params(void *dctx, + void *provctx); + const OSSL_PARAM *OSSL_FUNC_digest_settable_ctx_params(void *dctx, + void *provctx); /* Digest parameters */ int OSSL_FUNC_digest_get_params(OSSL_PARAM params[]); @@ -152,11 +154,17 @@ Any parameter settings are additional to any that were previously set. OSSL_FUNC_digest_get_ctx_params() gets digest operation details details from the given provider side digest context I<dctx> and stores them in I<params>. -OSSL_FUNC_digest_gettable_params(), OSSL_FUNC_digest_gettable_ctx_params(), and -OSSL_FUNC_digest_settable_ctx_params() all return constant B<OSSL_PARAM> arrays -as descriptors of the parameters that OSSL_FUNC_digest_get_params(), -OSSL_FUNC_digest_get_ctx_params(), and OSSL_FUNC_digest_set_ctx_params() can handle, -respectively. +OSSL_FUNC_digest_gettable_params() returns a constant B<OSSL_PARAM> array +containing descriptors of the parameters that OSSL_FUNC_digest_get_params() +can handle. + +OSSL_FUNC_digest_gettable_ctx_params() and +OSSL_FUNC_digest_settable_ctx_params() both return constant +B<OSSL_PARAM> arrays as descriptors of the parameters that +OSSL_FUNC_digest_get_ctx_params() and OSSL_FUNC_digest_set_ctx_params() +can handle, respectively. The array is based on the current state of +the provider side context if I<dctx> is not NULL and on the provider +side algorithm I<provctx> otherwise. Parameters currently recognised by built-in digests with this function are as follows. Not all parameters are relevant to, or are understood |