diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2021-03-29 19:42:33 +0200 |
---|---|---|
committer | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2021-05-08 14:35:03 +0200 |
commit | 0a8a6afdfb71e42962921980b51942cea8632697 (patch) | |
tree | 745f3e64cca2a9993fc2548f0a80a20dca231bcb /doc/man3 | |
parent | bea31afef013aaf5638e96e9bed1b633c510d50d (diff) |
Add quick one-shot EVP_Q_mac() and deprecation compensation decls for MAC functions
This helps compensating for deprecated functions such as HMAC()
and reduces clutter in the crypto lib, apps, and tests.
Also fixes memory leaks in generate_cookie_callback() of apps/lib/s_cb.c.
and replaces 'B<...>' by 'I<...>' where appropriate in HMAC.pod
Partially fixes #14628.
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14664)
Diffstat (limited to 'doc/man3')
-rw-r--r-- | doc/man3/EVP_MAC.pod | 30 | ||||
-rw-r--r-- | doc/man3/HMAC.pod | 59 |
2 files changed, 56 insertions, 33 deletions
diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index 27930eb89a..f4386f9daf 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -7,8 +7,9 @@ EVP_MAC_number, EVP_MAC_name, EVP_MAC_names_do_all, EVP_MAC_description, EVP_MAC_provider, EVP_MAC_get_params, EVP_MAC_gettable_params, EVP_MAC_CTX, EVP_MAC_CTX_new, EVP_MAC_CTX_free, EVP_MAC_CTX_dup, EVP_MAC_CTX_mac, EVP_MAC_CTX_get_params, EVP_MAC_CTX_set_params, -EVP_MAC_CTX_get_mac_size, EVP_MAC_init, EVP_MAC_update, EVP_MAC_final, -EVP_MAC_finalXOF, EVP_MAC_gettable_ctx_params, EVP_MAC_settable_ctx_params, +EVP_MAC_CTX_get_mac_size, EVP_Q_mac, +EVP_MAC_init, EVP_MAC_update, EVP_MAC_final, EVP_MAC_finalXOF, +EVP_MAC_gettable_ctx_params, EVP_MAC_settable_ctx_params, EVP_MAC_CTX_gettable_params, EVP_MAC_CTX_settable_params, EVP_MAC_do_all_provided - EVP MAC routines @@ -41,6 +42,11 @@ EVP_MAC_do_all_provided - EVP MAC routines int EVP_MAC_CTX_set_params(EVP_MAC_CTX *ctx, const OSSL_PARAM params[]); size_t EVP_MAC_CTX_get_mac_size(EVP_MAC_CTX *ctx); + unsigned char *EVP_Q_mac(OSSL_LIB_CTX *libctx, const char *name, const char *propq, + const char *subalg, const OSSL_PARAM *params, + const void *key, size_t keylen, + const unsigned char *data, size_t datalen, + unsigned char *out, size_t outsize, unsigned int *outlen); int EVP_MAC_init(EVP_MAC_CTX *ctx, const unsigned char *key, size_t keylen, const OSSL_PARAM params[]); int EVP_MAC_update(EVP_MAC_CTX *ctx, const unsigned char *data, size_t datalen); @@ -119,6 +125,19 @@ I<ctx>. =head2 Computing functions +EVP_Q_mac() computes the message authentication code +of I<data> with length I<datalen> +using the MAC algorithm I<name> and the key I<key> with length I<keylen>. +The MAC algorithm is fetched using any given I<libctx> and property query +string I<propq>. It takes parameters I<subalg> and further I<params>, +both of which may be NULL if not needed. +If I<out> is not NULL, it places the result in the memory pointed at by I<out>, +but only if I<outsize> is sufficient (otherwise no computation is made). +If I<out> is NULL, it allocates and uses a buffer of suitable length, +which will be returned on success and must be freed by the caller. +In either case, also on error, +it assigns the number of bytes written to I<*outlen> unless I<outlen> is NULL. + EVP_MAC_init() sets up the underlying context I<ctx> with information given via the I<key> and I<params> arguments. The MAC I<key> has a length of I<keylen> and the parameters in I<params> are processed before setting @@ -162,6 +181,7 @@ EVP_MAC_CTX_set_params() passes chosen parameters to the underlying context, given a context I<ctx>. The set of parameters given with I<params> determine exactly what parameters are passed down. +If I<params> are NULL, the unterlying context should do nothing and return 1. Note that a parameter that is unknown in the underlying context is simply ignored. Also, what happens when a needed parameter isn't passed down is @@ -325,7 +345,7 @@ not be considered a breaking change to the API. =head1 RETURN VALUES -EVP_MAC_fetch() returns a pointer to a newly fetched EVP_MAC, or +EVP_MAC_fetch() returns a pointer to a newly fetched B<EVP_MAC>, or NULL if allocation failed. EVP_MAC_up_ref() returns 1 on success, 0 on error. @@ -351,7 +371,9 @@ EVP_MAC_CTX_free() returns nothing at all. EVP_MAC_CTX_get_params() and EVP_MAC_CTX_set_params() return 1 on success, 0 on error. -EVP_MAC_init(), EVP_MAC_update(), EVP_MAC_final() and EVP_MAC_finalXOF() +EVP_Q_mac() returns a pointer to the computed MAC value, or NULL on error. + +EVP_MAC_init(), EVP_MAC_update(), EVP_MAC_final(), and EVP_MAC_finalXOF() return 1 on success, 0 on error. EVP_MAC_CTX_get_mac_size() returns the expected output size, or 0 if it isn't set. diff --git a/doc/man3/HMAC.pod b/doc/man3/HMAC.pod index 816d6e325d..5057360253 100644 --- a/doc/man3/HMAC.pod +++ b/doc/man3/HMAC.pod @@ -20,14 +20,14 @@ HMAC_size #include <openssl/hmac.h> + unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len, + const unsigned char *data, size_t data_len, + unsigned char *md, unsigned int *md_len); + Deprecated since OpenSSL 3.0, can be hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, see L<openssl_user_macros(7)>: - unsigned char *HMAC(const EVP_MD *evp_md, const void *key, - int key_len, const unsigned char *d, size_t n, - unsigned char *md, unsigned int *md_len); - HMAC_CTX *HMAC_CTX_new(void); int HMAC_CTX_reset(HMAC_CTX *ctx); @@ -53,28 +53,29 @@ L<openssl_user_macros(7)>: =head1 DESCRIPTION -All of the functions described on this page 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)>. - HMAC is a MAC (message authentication code), i.e. a keyed hash function used for message authentication, which is based on a hash function. -HMAC() computes the message authentication code of the B<n> bytes at -B<d> using the hash function B<evp_md> and the key B<key> which is -B<key_len> bytes long. +HMAC() computes the message authentication code of the I<data_len> bytes at +I<data> using the hash function I<evp_md> and the key I<key> which is +I<key_len> bytes long. The I<key> may also be NULL with I<key_len> being 0. -It places the result in B<md> (which must have space for the output of +It places the result in I<md> (which must have space for the output of the hash function, which is no more than B<EVP_MAX_MD_SIZE> bytes). -If B<md> is NULL, the digest is placed in a static array. The size of -the output is placed in B<md_len>, unless it is B<NULL>. Note: passing a NULL -value for B<md> to use the static array is not thread safe. +If I<md> is NULL, the digest is placed in a static array. The size of +the output is placed in I<md_len>, unless it is NULL. Note: passing a NULL +value for I<md> to use the static array is not thread safe. -B<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 +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(). +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)> +or the 'quick' single-shot MAC function L<EVP_Q_mac(3)>. + HMAC_CTX_new() creates a new HMAC_CTX in heap memory. HMAC_CTX_reset() clears an existing B<HMAC_CTX> and associated @@ -89,27 +90,27 @@ The following functions may be used if the message is not completely stored in memory: HMAC_Init_ex() initializes or reuses a B<HMAC_CTX> structure to use the hash -function B<evp_md> and key B<key>. If both are NULL, or if B<key> is NULL -and B<evp_md> is the same as the previous call, then the +function I<evp_md> and key I<key>. If both are NULL, or if I<key> is NULL +and I<evp_md> is the same as the previous call, then the existing key is -reused. B<ctx> must have been created with HMAC_CTX_new() before the first use +reused. I<ctx> must have been created with HMAC_CTX_new() before the first use of an B<HMAC_CTX> in this function. -If HMAC_Init_ex() is called with B<key> NULL and B<evp_md> is not the -same as the previous digest used by B<ctx> then an error is returned +If HMAC_Init_ex() is called with I<key> NULL and I<evp_md> is not the +same as the previous digest used by I<ctx> then an error is returned because reuse of an existing key with a different digest is not supported. HMAC_Init() initializes a B<HMAC_CTX> structure to use the hash -function B<evp_md> and the key B<key> which is B<key_len> bytes +function I<evp_md> and the key I<key> which is I<key_len> bytes long. HMAC_Update() can be called repeatedly with chunks of the message to -be authenticated (B<len> bytes at B<data>). +be authenticated (I<len> bytes at I<data>). -HMAC_Final() places the message authentication code in B<md>, which +HMAC_Final() places the message authentication code in I<md>, which must have space for the hash function output. -HMAC_CTX_copy() copies all of the internal state from B<sctx> into B<dctx>. +HMAC_CTX_copy() copies all of the internal state from I<sctx> into I<dctx>. HMAC_CTX_set_flags() applies the specified flags to the internal EVP_MD_CTXs. These flags have the same meaning as for L<EVP_MD_CTX_set_flags(3)>. @@ -125,7 +126,7 @@ HMAC() returns a pointer to the message authentication code or NULL if an error occurred. HMAC_CTX_new() returns a pointer to a new B<HMAC_CTX> on success or -B<NULL> if an error occurred. +NULL if an error occurred. HMAC_CTX_reset(), HMAC_Init_ex(), HMAC_Update(), HMAC_Final() and HMAC_CTX_copy() return 1 for success or 0 if an error occurred. @@ -142,11 +143,11 @@ RFC 2104 =head1 SEE ALSO -L<SHA1(3)>, L<evp(7)> +L<SHA1(3)>, EVP_Q_mac(3), L<evp(7)> =head1 HISTORY -All of these functions were deprecated in OpenSSL 3.0. +All functions except for HMAC() were deprecated in OpenSSL 3.0. HMAC_CTX_init() was replaced with HMAC_CTX_reset() in OpenSSL 1.1.0. |