xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_MAC-HMAC.7 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: EVP_MAC-HMAC.7,v 1.5 2024/09/08 13:08:22 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "EVP_MAC-HMAC 7"
EVP_MAC-HMAC 7 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_MAC-HMAC - The HMAC EVP_MAC implementation
DESCRIPTION
Header "DESCRIPTION" Support for computing HMAC MACs through the EVP_MAC API.

This implementation uses EVP_MD functions to get access to the underlying digest.

Identity
Subsection "Identity" This implementation is identified with this name and properties, to be used with EVP_MAC_fetch():
"""HMAC"", ""provider=default"" or ""provider=fips""" 4
Item """HMAC"", ""provider=default"" or ""provider=fips"""
"Supported parameters"
Subsection "Supported parameters" The general description of these parameters can be found in "PARAMETERS" in EVP_MAC\|(3).

The following parameter can be set with EVP_MAC_CTX_set_params():

"""key"" (OSSL_MAC_PARAM_KEY) <octet string>" 4
Item """key"" (OSSL_MAC_PARAM_KEY) <octet string>" Sets the MAC key. Setting this parameter is identical to passing a key to EVP_MAC_init\|(3).
"""digest"" (OSSL_MAC_PARAM_DIGEST) <UTF8 string>" 4
Item """digest"" (OSSL_MAC_PARAM_DIGEST) <UTF8 string>" Sets the name of the underlying digest to be used.
"""properties"" (OSSL_MAC_PARAM_PROPERTIES) <UTF8 string>" 4
Item """properties"" (OSSL_MAC_PARAM_PROPERTIES) <UTF8 string>" Sets the properties to be queried when trying to fetch the underlying digest. This must be given together with the digest naming parameter ("digest", or \fBOSSL_MAC_PARAM_DIGEST) to be considered valid.
"""digest-noinit"" (OSSL_MAC_PARAM_DIGEST_NOINIT) <integer>" 4
Item """digest-noinit"" (OSSL_MAC_PARAM_DIGEST_NOINIT) <integer>" A flag to set the MAC digest to not initialise the implementation specific data. The value 0 or 1 is expected.
"""digest-oneshot"" (OSSL_MAC_PARAM_DIGEST_ONESHOT) <integer>" 4
Item """digest-oneshot"" (OSSL_MAC_PARAM_DIGEST_ONESHOT) <integer>" A flag to set the MAC digest to be a one-shot operation. The value 0 or 1 is expected.
"""tls-data-size"" (OSSL_MAC_PARAM_TLS_DATA_SIZE) <unsigned integer>" 4
Item """tls-data-size"" (OSSL_MAC_PARAM_TLS_DATA_SIZE) <unsigned integer>"

The following parameter can be retrieved with EVP_MAC_CTX_get_params():

"""size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>" 4
Item """size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>" The "size" parameter can also be retrieved with EVP_MAC_CTX_get_mac_size(). The length of the "size" parameter is equal to that of an unsigned int.
"""block-size"" (OSSL_MAC_PARAM_BLOCK_SIZE) <unsigned integer>" 4
Item """block-size"" (OSSL_MAC_PARAM_BLOCK_SIZE) <unsigned integer>" Gets the MAC block size. The "block-size" parameter can also be retrieved with \fBEVP_MAC_CTX_get_block_size().
"SEE ALSO"
Header "SEE ALSO" \fBEVP_MAC_CTX_get_params\|(3), EVP_MAC_CTX_set_params\|(3), "PARAMETERS" in EVP_MAC\|(3), OSSL_PARAM\|(3), HMAC\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.