diff options
| author | Shane Lontis <shane.lontis@oracle.com> | 2020-12-14 14:36:48 +1000 |
|---|---|---|
| committer | Pauli <ppzgs1@gmail.com> | 2021-02-10 12:31:31 +1000 |
| commit | 36978c19a9a5bfd514b1c6f9db66fda4b39ed2c3 (patch) | |
| tree | 1b255108eeaa6078bb565b7d7c71f04eca189fe8 /doc | |
| parent | 8a686bdb3ac7d61b6d5f02b9132c4878ae80a7e5 (diff) | |
Replace MAC flags OSSL_MAC_PARAM_FLAGS with separate param fields.
Fixes #12992
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/13830)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/EVP_MAC.pod | 15 | ||||
| -rw-r--r-- | doc/man7/EVP_MAC-HMAC.pod | 6 | ||||
| -rw-r--r-- | doc/man7/provider-mac.pod | 11 |
3 files changed, 25 insertions, 7 deletions
diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index 455d154cee..926c1fbd06 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -225,10 +225,19 @@ It's a simple flag, the value 0 or 1 are expected. This option is used by KMAC. -=item "flags" (B<OSSL_MAC_PARAM_FLAGS>) <integer> +=item "digest-noinit" (B<OSSL_MAC_PARAM_DIGEST_NOINIT>) <integer> -These will set the MAC flags to the given numbers. -Some MACs do not support this option. +A simple flag to set the MAC digest to not initialise the +implementation specific data. The value 0 or 1 is expected. + +This option is used by HMAC. + +=item "digest-oneshot" (B<OSSL_MAC_PARAM_DIGEST_ONESHOT>) <integer> + +A simple flag to set the MAC digest to be a oneshot operation. +The value 0 or 1 is expected. + +This option is used by HMAC. =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string> diff --git a/doc/man7/EVP_MAC-HMAC.pod b/doc/man7/EVP_MAC-HMAC.pod index 94bac8dbcf..8136bed000 100644 --- a/doc/man7/EVP_MAC-HMAC.pod +++ b/doc/man7/EVP_MAC-HMAC.pod @@ -30,10 +30,12 @@ The following parameter can be set with EVP_MAC_CTX_set_params(): =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string> -=item "flags" (B<OSSL_MAC_PARAM_FLAGS>) <octet string> - =item "digest" (B<OSSL_MAC_PARAM_DIGEST>) <UTF8 string> +=item "digest-noinit" (B<OSSL_MAC_PARAM_DIGEST_NOINIT>) <integer> + +=item "digest-oneshot" (B<OSSL_MAC_PARAM_DIGEST_ONESHOT>) <integer> + =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string> =item "tls-data-size" (B<OSSL_MAC_PARAM_TLS_DATA_SIZE>) <unsigned integer> diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod index f89b1fe0e2..f18a8c7fde 100644 --- a/doc/man7/provider-mac.pod +++ b/doc/man7/provider-mac.pod @@ -172,9 +172,16 @@ Sets the salt of the underlying cipher, when applicable. Sets XOF mode in the associated MAC ctx. 0 means no XOF mode, 1 means XOF mode. -=item "flags" (B<OSSL_MAC_PARAM_FLAGS>) <integer> +=item "digest-noinit" (B<OSSL_MAC_PARAM_DIGEST_NOINIT>) <integer> + +A simple flag to set the MAC digest to not initialise the +implementation specific data. The value 0 or 1 is expected. + +=item "digest-oneshot" (B<OSSL_MAC_PARAM_DIGEST_ONESHOT>) <integer> + +A simple flag to set the MAC digest to be a oneshot operation. +The value 0 or 1 is expected. -Gets flags associated with the MAC. =for comment We need to investigate if this is the right approach |