diff options
| author | slontis <shane.lontis@oracle.com> | 2022-12-08 08:16:03 +1000 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2022-12-16 18:39:32 +0100 |
| commit | 4e98cb5733a4256e75ad5d9a17612b03163139e3 (patch) | |
| tree | 47d90ba3c0325237f3798e9ec29bee8ee6afb433 | |
| parent | b46d2209691593791498af1b9de344b127330c4c (diff) | |
Update HMAC() documentation.
Fixes #19782
Clarify that EVP_Q_MAC() can be used as an alternative that allows
setting of the libctx.
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19855)
(cherry picked from commit d1ebd99397e18de367918c201c25c389f1f07005)
| -rw-r--r-- | doc/man3/HMAC.pod | 3 | ||||
| -rw-r--r-- | doc/man7/migration_guide.pod | 3 |
2 files changed, 5 insertions, 1 deletions
diff --git a/doc/man3/HMAC.pod b/doc/man3/HMAC.pod index 43aca065f0..87a567242f 100644 --- a/doc/man3/HMAC.pod +++ b/doc/man3/HMAC.pod @@ -71,6 +71,9 @@ I<evp_md> is a message digest such as EVP_sha1(), EVP_ripemd160() etc. HMAC does not support variable output length digests such as EVP_shake128() and EVP_shake256(). +HMAC() uses the default B<OSSL_LIB_CTX>. +Use L<EVP_Q_mac(3)> instead if a library context is required. + All of the functions described below are deprecated. Applications should instead use L<EVP_MAC_CTX_new(3)>, L<EVP_MAC_CTX_free(3)>, L<EVP_MAC_init(3)>, L<EVP_MAC_update(3)> and L<EVP_MAC_final(3)> diff --git a/doc/man7/migration_guide.pod b/doc/man7/migration_guide.pod index d8c9b98107..75c8ed700c 100644 --- a/doc/man7/migration_guide.pod +++ b/doc/man7/migration_guide.pod @@ -1074,7 +1074,8 @@ See L<EVP_MAC(3)>, L<EVP_MAC-HMAC(7)>, L<EVP_MAC-CMAC(7)>, L<EVP_MAC-GMAC(7)>, L<EVP_MAC-KMAC(7)>, L<EVP_MAC-BLAKE2(7)>, L<EVP_MAC-Poly1305(7)> and L<EVP_MAC-Siphash(7)> for additional information. -Note that the one-shot method HMAC() is still available for compatibility purposes. +Note that the one-shot method HMAC() is still available for compatibility purposes, +but this can also be replaced by using EVP_Q_MAC if a library context is required. =head4 Deprecated low-level validation functions |