zzy/openssl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: fix description of mac "block-size" parameter

Browse Source 
The macro for "block-size" is OSSL_MAC_PARAM_BLOCK_SIZE, and this
parameter is not settable.  Refer to the "customization string" rather
than the "custom value" (in the Blake2 spec, this is called the
personalization string).

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22763)
This commit is contained in:
James Muir 2023-11-17 17:58:24 -05:00 committed by Richard Levitte
parent f1bea887ef
commit 1750689767
4 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/man7/EVP_MAC-BLAKE2.pod
View File

@ -27,7 +27,8 @@ properties, to be used with EVP_MAC_fetch():
The general description of these parameters can be found in
L<EVP_MAC(3)/PARAMETERS>.
All these parameters can be set with EVP_MAC_CTX_set_params().
All these parameters (except for "block-size") can be set with
EVP_MAC_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
EVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_mac_size().
The length of the "size" parameter should not exceed that of a B<size_t>.
@ -45,7 +46,7 @@ Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
Sets the custom value.
Sets the customization/personalization string.
It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
BLAKE2SMAC, and is empty by default.
@ -62,10 +63,10 @@ It can be any number between 1 and 32 for EVP_MAC_BLAKE2S or between 1
and 64 for EVP_MAC_BLAKE2B.
It is 32 and 64 respectively by default.
=item "block-size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
=item "block-size" (B<OSSL_MAC_PARAM_BLOCK_SIZE>) <unsigned integer>
Gets the MAC block size.
By default, it is 64 for EVP_MAC_BLAKE2S and 128 for EVP_MAC_BLAKE2B.
It is 64 for EVP_MAC_BLAKE2S and 128 for EVP_MAC_BLAKE2B.
=back

2
doc/man7/EVP_MAC-CMAC.pod
View File

@ -63,7 +63,7 @@ The length of the "size" parameter is equal to that of an B<unsigned int>.
=over 4
=item "block-size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
=item "block-size" (B<OSSL_MAC_PARAM_BLOCK_SIZE>) <unsigned integer>
Gets the MAC block size. The "block-size" parameter can also be retrieved with
EVP_MAC_CTX_get_block_size().

2
doc/man7/EVP_MAC-HMAC.pod
View File

@ -76,7 +76,7 @@ The length of the "size" parameter is equal to that of an B<unsigned int>.
=over 4
=item "block-size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
=item "block-size" (B<OSSL_MAC_PARAM_BLOCK_SIZE>) <unsigned integer>
Gets the MAC block size. The "block-size" parameter can also be retrieved with
EVP_MAC_CTX_get_block_size().

12
doc/man7/EVP_MAC-KMAC.pod
View File

@ -27,7 +27,8 @@ properties, to be used with EVP_MAC_fetch():
The general description of these parameters can be found in
L<EVP_MAC(3)/PARAMETERS>.
All these parameters can be set with EVP_MAC_CTX_set_params().
All these parameters (except for "block-size") can be set with
EVP_MAC_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
EVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_mac_size().
The length of the "size" parameter should not exceed that of a B<size_t>.
@ -45,18 +46,19 @@ The length of the key (in bytes) must be in the range 4...512.
=item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
Sets the custom value.
It is an optional value with a length of at most 512 bytes, and is empty by default.
Sets the customization string.
It is an optional value with a length of at most 512 bytes, and is
empty by default.
=item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
Sets the MAC size.
By default, it is 32 for C<KMAC-128> and 64 for C<KMAC-256>.
=item "block-size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
=item "block-size" (B<OSSL_MAC_PARAM_BLOCK_SIZE>) <unsigned integer>
Gets the MAC block size.
By default, it is 168 for C<KMAC-128> and 136 for C<KMAC-256>.
It is 168 for C<KMAC-128> and 136 for C<KMAC-256>.
=item "xof" (B<OSSL_MAC_PARAM_XOF>) <integer>