xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_PKEY-HMAC.7 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: EVP_PKEY-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_PKEY-HMAC 7"
EVP_PKEY-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_PKEY-HMAC, EVP_KEYMGMT-HMAC, EVP_PKEY-Siphash, EVP_KEYMGMT-Siphash, EVP_PKEY-Poly1305, EVP_KEYMGMT-Poly1305, EVP_PKEY-CMAC, EVP_KEYMGMT-CMAC \- EVP_PKEY legacy MAC keytypes and algorithm support
DESCRIPTION
Header "DESCRIPTION" The HMAC and CMAC key types are implemented in OpenSSL's default and FIPS providers. Additionally the Siphash and Poly1305 key types are implemented in the default provider. Performing MAC operations via an EVP_PKEY is considered legacy and are only available for backwards compatibility purposes and for a restricted set of algorithms. The preferred way of performing MAC operations is via the EVP_MAC APIs. See EVP_MAC_init\|(3).

For further details on using EVP_PKEY based MAC keys see \fBEVP_SIGNATURE-HMAC\|(7), EVP_SIGNATURE-Siphash\|(7), \fBEVP_SIGNATURE-Poly1305\|(7) or EVP_SIGNATURE-CMAC\|(7).

"Common MAC parameters"
Subsection "Common MAC parameters" All the MAC keytypes support the following parameters.
"""priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" 4
Item """priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" The MAC key value.
"""properties"" (OSSL_PKEY_PARAM_PROPERTIES) <UTF8 string>" 4
Item """properties"" (OSSL_PKEY_PARAM_PROPERTIES) <UTF8 string>" A property query string to be used when any algorithms are fetched.
"CMAC parameters"
Subsection "CMAC parameters" As well as the parameters described above, the CMAC keytype additionally supports the following parameters.
"""cipher"" (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" 4
Item """cipher"" (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" The name of a cipher to be used when generating the MAC.
"""engine"" (OSSL_PKEY_PARAM_ENGINE) <UTF8 string>" 4
Item """engine"" (OSSL_PKEY_PARAM_ENGINE) <UTF8 string>" The name of an engine to be used for the specified cipher (if any).
"Common MAC key generation parameters"
Subsection "Common MAC key generation parameters" MAC key generation is unusual in that no new key is actually generated. Instead a new provider side key object is created with the supplied raw key value. This is done for backwards compatibility with previous versions of OpenSSL.
"""priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" 4
Item """priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" The MAC key value.
"CMAC key generation parameters"
Subsection "CMAC key generation parameters" In addition to the common MAC key generation parameters, the CMAC key generation additionally recognises the following.
"""cipher"" (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" 4
Item """cipher"" (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" The name of a cipher to be used when generating the MAC.
"SEE ALSO"
Header "SEE ALSO" \fBEVP_KEYMGMT\|(3), EVP_PKEY\|(3), provider-keymgmt\|(7)
COPYRIGHT
Header "COPYRIGHT" Copyright 2020 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>.