From 4e98cb5733a4256e75ad5d9a17612b03163139e3 Mon Sep 17 00:00:00 2001 From: slontis Date: Thu, 8 Dec 2022 08:16:03 +1000 Subject: [PATCH] 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 Reviewed-by: Matt Caswell Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/19855) (cherry picked from commit d1ebd99397e18de367918c201c25c389f1f07005) --- doc/man3/HMAC.pod | 3 +++ doc/man7/migration_guide.pod | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/man3/HMAC.pod b/doc/man3/HMAC.pod index 43aca065f0d28..87a567242f60f 100644 --- a/doc/man3/HMAC.pod +++ b/doc/man3/HMAC.pod @@ -71,6 +71,9 @@ I 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. +Use L instead if a library context is required. + All of the functions described below are deprecated. Applications should instead use L, L, L, L and L diff --git a/doc/man7/migration_guide.pod b/doc/man7/migration_guide.pod index d8c9b98107ba4..75c8ed700c898 100644 --- a/doc/man7/migration_guide.pod +++ b/doc/man7/migration_guide.pod @@ -1074,7 +1074,8 @@ See L, L, L, L, L, L, L and L 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