| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "EVP_PKEY-HMAC 7SSL" |
| 58 |
.TH EVP_PKEY-HMAC 7SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
EVP_PKEY\-HMAC, EVP_KEYMGMT\-HMAC, EVP_PKEY\-Siphash, EVP_KEYMGMT\-Siphash, |
| 65 |
EVP_PKEY\-Poly1305, EVP_KEYMGMT\-Poly1305, EVP_PKEY\-CMAC, EVP_KEYMGMT\-CMAC |
| 66 |
\&\- EVP_PKEY legacy MAC keytypes and algorithm support |
| 67 |
.SH DESCRIPTION |
| 68 |
.IX Header "DESCRIPTION" |
| 69 |
The \fBHMAC\fR and \fBCMAC\fR key types are implemented in OpenSSL's default and FIPS |
| 70 |
providers. Additionally the \fBSiphash\fR and \fBPoly1305\fR key types are implemented |
| 71 |
in the default provider. Performing MAC operations via an EVP_PKEY |
| 72 |
is considered legacy and are only available for backwards compatibility purposes |
| 73 |
and for a restricted set of algorithms. The preferred way of performing MAC |
| 74 |
operations is via the EVP_MAC APIs. See \fBEVP_MAC_init\fR\|(3). |
| 75 |
.PP |
| 76 |
For further details on using EVP_PKEY based MAC keys see |
| 77 |
\&\fBEVP_SIGNATURE\-HMAC\fR\|(7), \fBEVP_SIGNATURE\-Siphash\fR\|(7), |
| 78 |
\&\fBEVP_SIGNATURE\-Poly1305\fR\|(7) or \fBEVP_SIGNATURE\-CMAC\fR\|(7). |
| 79 |
.SS "Common MAC parameters" |
| 80 |
.IX Subsection "Common MAC parameters" |
| 81 |
All the \fBMAC\fR keytypes support the following parameters. |
| 82 |
.IP """priv"" (\fBOSSL_PKEY_PARAM_PRIV_KEY\fR) <octet string>" 4 |
| 83 |
.IX Item """priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" |
| 84 |
The MAC key value. |
| 85 |
.IP """properties"" (\fBOSSL_PKEY_PARAM_PROPERTIES\fR) <UTF8 string>" 4 |
| 86 |
.IX Item """properties"" (OSSL_PKEY_PARAM_PROPERTIES) <UTF8 string>" |
| 87 |
A property query string to be used when any algorithms are fetched. |
| 88 |
.SS "CMAC parameters" |
| 89 |
.IX Subsection "CMAC parameters" |
| 90 |
As well as the parameters described above, the \fBCMAC\fR keytype additionally |
| 91 |
supports the following parameters. |
| 92 |
.IP """cipher"" (\fBOSSL_PKEY_PARAM_CIPHER\fR) <UTF8 string>" 4 |
| 93 |
.IX Item """cipher"" (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" |
| 94 |
The name of a cipher to be used when generating the MAC. |
| 95 |
.IP """engine"" (\fBOSSL_PKEY_PARAM_ENGINE\fR) <UTF8 string>" 4 |
| 96 |
.IX Item """engine"" (OSSL_PKEY_PARAM_ENGINE) <UTF8 string>" |
| 97 |
The name of an engine to be used for the specified cipher (if any). |
| 98 |
.SS "Common MAC key generation parameters" |
| 99 |
.IX Subsection "Common MAC key generation parameters" |
| 100 |
MAC key generation is unusual in that no new key is actually generated. Instead |
| 101 |
a new provider side key object is created with the supplied raw key value. This |
| 102 |
is done for backwards compatibility with previous versions of OpenSSL. |
| 103 |
.IP """priv"" (\fBOSSL_PKEY_PARAM_PRIV_KEY\fR) <octet string>" 4 |
| 104 |
.IX Item """priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" |
| 105 |
The MAC key value. |
| 106 |
.SS "CMAC key generation parameters" |
| 107 |
.IX Subsection "CMAC key generation parameters" |
| 108 |
In addition to the common MAC key generation parameters, the CMAC key generation |
| 109 |
additionally recognises the following. |
| 110 |
.IP """cipher"" (\fBOSSL_PKEY_PARAM_CIPHER\fR) <UTF8 string>" 4 |
| 111 |
.IX Item """cipher"" (OSSL_PKEY_PARAM_CIPHER) <UTF8 string>" |
| 112 |
The name of a cipher to be used when generating the MAC. |
| 113 |
.SH "SEE ALSO" |
| 114 |
.IX Header "SEE ALSO" |
| 115 |
\&\fBEVP_KEYMGMT\fR\|(3), \fBEVP_PKEY\fR\|(3), \fBprovider\-keymgmt\fR\|(7) |
| 116 |
.SH COPYRIGHT |
| 117 |
.IX Header "COPYRIGHT" |
| 118 |
Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. |
| 119 |
.PP |
| 120 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 121 |
this file except in compliance with the License. You can obtain a copy |
| 122 |
in the file LICENSE in the source distribution or at |
| 123 |
<https://www.openssl.org/source/license.html>. |