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-Siphash.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-Siphash.pod')
| -rw-r--r-- | doc/man7/EVP_MAC-Siphash.pod | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/man7/EVP_MAC-Siphash.pod b/doc/man7/EVP_MAC-Siphash.pod index 2b6f2ae4e4..01849f7c4a 100644 --- a/doc/man7/EVP_MAC-Siphash.pod +++ b/doc/man7/EVP_MAC-Siphash.pod @@ -34,8 +34,13 @@ The length of the "size" parameter should not exceed that of a B<size_t>. =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 "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer> +Sets the MAC size. + =item "c-rounds" (B<OSSL_MAC_PARAM_C_ROUNDS>) <unsigned integer> Specifies the number of rounds per message block. By default this is I<2>. |