xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_PKEY-HMAC.7 (revision 4d65a7c6951cea0333f1a0c1b32c38489cdfa6c5)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "EVP_PKEY-HMAC 7ossl"
EVP_PKEY-HMAC 7ossl "2023-09-19" "3.0.11" "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 \s-1HMAC\s0 and \s-1CMAC\s0 key types are implemented in OpenSSL's default and \s-1FIPS\s0 providers. Additionally the Siphash and Poly1305 key types are implemented in the default provider. Performing \s-1MAC\s0 operations via an \s-1EVP_PKEY\s0 is considered legacy and are only available for backwards compatibility purposes and for a restricted set of algorithms. The preferred way of performing \s-1MAC\s0 operations is via the \s-1EVP_MAC\s0 APIs. See EVP_MAC_init\|(3).

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

"Common \s-1MAC\s0 parameters"
Subsection "Common MAC parameters" All the \s-1MAC\s0 keytypes support the following parameters. Item "priv (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" The \s-1MAC\s0 key value. Item "properties (OSSL_PKEY_PARAM_PROPERTIES) <UTF8 string>" A property query string to be used when any algorithms are fetched.
"\s-1CMAC\s0 parameters"
Subsection "CMAC parameters" As well as the parameters described above, the \s-1CMAC\s0 keytype additionally supports the following parameters. Item "cipher (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" The name of a cipher to be used when generating the \s-1MAC.\s0 Item "engine (OSSL_PKEY_PARAM_ENGINE) <UTF8 string>" The name of an engine to be used for the specified cipher (if any).
"Common \s-1MAC\s0 key generation parameters"
Subsection "Common MAC key generation parameters" \s-1MAC\s0 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. Item "priv (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" The \s-1MAC\s0 key value.
"\s-1CMAC\s0 key generation parameters"
Subsection "CMAC key generation parameters" In addition to the common \s-1MAC\s0 key generation parameters, the \s-1CMAC\s0 key generation additionally recognises the following. Item "cipher (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" The name of a cipher to be used when generating the \s-1MAC.\s0
"SEE ALSO"
Header "SEE ALSO" \s-1EVP_KEYMGMT\s0\|(3), \s-1EVP_PKEY\s0\|(3), provider-keymgmt\|(7)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.

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