summaryrefslogtreecommitdiffstats
path: root/doc/man7/provider-mac.pod
diff options
context:
space:
mode:
authorPauli <ppzgs1@gmail.com>2021-02-23 02:03:31 +0100
committerPauli <ppzgs1@gmail.com>2021-02-26 09:08:41 +0100
commit8dd233bb07607239bea31f33224df2ac37eddb57 (patch)
tree69e97d170cb8d71780e8fa949adac88de511a512 /doc/man7/provider-mac.pod
parentcore: core: support modified gettable/settable ctx calls for MACs (diff)
downloadopenssl-8dd233bb07607239bea31f33224df2ac37eddb57.tar.xz
openssl-8dd233bb07607239bea31f33224df2ac37eddb57.zip
doc: changes to match the updated context gettable/settable calls for MACs
Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14240)
Diffstat (limited to 'doc/man7/provider-mac.pod')
-rw-r--r--doc/man7/provider-mac.pod21
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod
index 7ce2ad2a13..fdeda79ab5 100644
--- a/doc/man7/provider-mac.pod
+++ b/doc/man7/provider-mac.pod
@@ -28,9 +28,9 @@ provider-mac - The mac library E<lt>-E<gt> provider functions
int OSSL_FUNC_mac_final(void *mctx, unsigned char *out, size_t *outl, size_t outsize);
/* MAC parameter descriptors */
- const OSSL_PARAM *OSSL_FUNC_mac_get_params(void *provctx);
- const OSSL_PARAM *OSSL_FUNC_mac_get_ctx_params(void *provctx);
- const OSSL_PARAM *OSSL_FUNC_mac_set_ctx_params(void *provctx);
+ const OSSL_PARAM *OSSL_FUNC_mac_gettable_params(void *provctx);
+ const OSSL_PARAM *OSSL_FUNC_mac_gettable_ctx_params(void *mctx, void *provctx);
+ const OSSL_PARAM *OSSL_FUNC_mac_settable_ctx_params(void *mctx, void *provctx);
/* MAC parameters */
int OSSL_FUNC_mac_get_params(OSSL_PARAM params[]);
@@ -140,11 +140,16 @@ OSSL_FUNC_mac_get_ctx_params() gets details of currently set parameter values
associated with the given provider side mac context I<mctx> and stores them
in I<params>.
-OSSL_FUNC_mac_gettable_params(), OSSL_FUNC_mac_gettable_ctx_params(), and
-OSSL_FUNC_mac_settable_ctx_params() all return constant B<OSSL_PARAM> arrays
-as descriptors of the parameters that OSSL_FUNC_mac_get_params(),
-OSSL_FUNC_mac_get_ctx_params(), and OSSL_FUNC_mac_set_ctx_params() can handle,
-respectively.
+OSSL_FUNC_mac_gettable_params(), OSSL_FUNC_mac_gettable_ctx_params(),
+and OSSL_FUNC_mac_settable_ctx_params() all return constant B<OSSL_PARAM>
+arrays as descriptors of the parameters that OSSL_FUNC_mac_get_params(),
+OSSL_FUNC_mac_get_ctx_params(), and OSSL_FUNC_mac_set_ctx_params()
+can handle, respectively. OSSL_FUNC_mac_gettable_ctx_params() and
+OSSL_FUNC_mac_settable_ctx_params() will return the parameters associated
+with the provider side context I<mctx> 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 macs are as follows. Not all
parameters are relevant to, or are understood by all macs: