diff options
| author | Richard Levitte <levitte@openssl.org> | 2021-03-01 18:46:20 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2021-03-03 14:08:00 +0100 |
| commit | 8593ff00cc66e330228164ae5422f80ef93ed35d (patch) | |
| tree | 933aa54bfa42767070606d99a845ebf0d2cc5524 /doc/man7/EVP_MAC-CMAC.pod | |
| parent | cb54d1b9d7f0d386aa22550d8b12ecd43e248a3f (diff) | |
DOCS: Fix provider-mac.pod and the docs of our implementations
The idea being that doc/man7/provider-mac.pod is for provider authors,
while provider users find the documentation for each implementation in
doc/man7/EVP_MAC-*.pod, the documentation of parameters wasn't quite
aligned. This change re-arranges the parameter documentation to be
more aligned with this idea.
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14380)
Diffstat (limited to 'doc/man7/EVP_MAC-CMAC.pod')
| -rw-r--r-- | doc/man7/EVP_MAC-CMAC.pod | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/man7/EVP_MAC-CMAC.pod b/doc/man7/EVP_MAC-CMAC.pod index 4d05919b8f..3c6af827b9 100644 --- a/doc/man7/EVP_MAC-CMAC.pod +++ b/doc/man7/EVP_MAC-CMAC.pod @@ -8,6 +8,9 @@ EVP_MAC-CMAC - The CMAC EVP_MAC implementation Support for computing CMAC MACs through the B<EVP_MAC> API. +This implementation uses EVP_CIPHER functions to get access to the underlying +cipher. + =head2 Identity This implementation is identified with this name and properties, to be @@ -30,10 +33,19 @@ The following parameter can be set with EVP_MAC_CTX_set_params(): =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string> +Sets the MAC key. +Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>. + =item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string> +Sets the name of the underlying cipher to be used. + =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string> +Sets the properties to be queried when trying to fetch the underlying cipher. +This must be given together with the cipher naming parameter to be considered +valid. + =back The following parameters can be retrieved with |