| 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_MAC-HMAC 7SSL" |
| 58 |
.TH EVP_MAC-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_MAC\-HMAC \- The HMAC EVP_MAC implementation |
| 65 |
.SH DESCRIPTION |
| 66 |
.IX Header "DESCRIPTION" |
| 67 |
Support for computing HMAC MACs through the \fBEVP_MAC\fR API. |
| 68 |
.PP |
| 69 |
This implementation uses EVP_MD functions to get access to the underlying |
| 70 |
digest. |
| 71 |
.SS Identity |
| 72 |
.IX Subsection "Identity" |
| 73 |
This implementation is identified with this name and properties, to be |
| 74 |
used with \fBEVP_MAC_fetch()\fR: |
| 75 |
.IP """HMAC"", ""provider=default"" or ""provider=fips""" 4 |
| 76 |
.IX Item """HMAC"", ""provider=default"" or ""provider=fips""" |
| 77 |
.SS "Supported parameters" |
| 78 |
.IX Subsection "Supported parameters" |
| 79 |
The general description of these parameters can be found in |
| 80 |
"PARAMETERS" in \fBEVP_MAC\fR\|(3). |
| 81 |
.PP |
| 82 |
The following parameters can be set with \fBEVP_MAC_CTX_set_params()\fR: |
| 83 |
.IP """key"" (\fBOSSL_MAC_PARAM_KEY\fR) <octet string>" 4 |
| 84 |
.IX Item """key"" (OSSL_MAC_PARAM_KEY) <octet string>" |
| 85 |
Sets the MAC key. |
| 86 |
Setting this parameter is identical to passing a \fIkey\fR to \fBEVP_MAC_init\fR\|(3). |
| 87 |
.IP """digest"" (\fBOSSL_MAC_PARAM_DIGEST\fR) <UTF8 string>" 4 |
| 88 |
.IX Item """digest"" (OSSL_MAC_PARAM_DIGEST) <UTF8 string>" |
| 89 |
Sets the name of the underlying digest to be used. |
| 90 |
.IP """properties"" (\fBOSSL_MAC_PARAM_PROPERTIES\fR) <UTF8 string>" 4 |
| 91 |
.IX Item """properties"" (OSSL_MAC_PARAM_PROPERTIES) <UTF8 string>" |
| 92 |
Sets the properties to be queried when trying to fetch the underlying digest. |
| 93 |
This must be given together with the digest naming parameter ("digest", or |
| 94 |
\&\fBOSSL_MAC_PARAM_DIGEST\fR) to be considered valid. |
| 95 |
.IP """digest-noinit"" (\fBOSSL_MAC_PARAM_DIGEST_NOINIT\fR) <integer>" 4 |
| 96 |
.IX Item """digest-noinit"" (OSSL_MAC_PARAM_DIGEST_NOINIT) <integer>" |
| 97 |
A flag to set the MAC digest to not initialise the implementation |
| 98 |
specific data. |
| 99 |
The value 0 or 1 is expected. |
| 100 |
This option is deprecated and will be removed in a future release. |
| 101 |
It may be set but is currently ignored |
| 102 |
.IP """digest-oneshot"" (\fBOSSL_MAC_PARAM_DIGEST_ONESHOT\fR) <integer>" 4 |
| 103 |
.IX Item """digest-oneshot"" (OSSL_MAC_PARAM_DIGEST_ONESHOT) <integer>" |
| 104 |
A flag to set the MAC digest to be a one-shot operation. |
| 105 |
The value 0 or 1 is expected. |
| 106 |
This option is deprecated and will be removed in a future release. |
| 107 |
It may be set but is currently ignored. |
| 108 |
.IP """tls-data-size"" (\fBOSSL_MAC_PARAM_TLS_DATA_SIZE\fR) <unsigned integer>" 4 |
| 109 |
.IX Item """tls-data-size"" (OSSL_MAC_PARAM_TLS_DATA_SIZE) <unsigned integer>" |
| 110 |
.PD 0 |
| 111 |
.IP """key-check"" (\fBOSSL_MAC_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4 |
| 112 |
.IX Item """key-check"" (OSSL_MAC_PARAM_FIPS_KEY_CHECK) <integer>" |
| 113 |
.PD |
| 114 |
See "Mac Parameters" in \fBprovider\-mac\fR\|(7). |
| 115 |
.PP |
| 116 |
The following parameters can be retrieved with \fBEVP_MAC_CTX_get_params()\fR: |
| 117 |
.IP """size"" (\fBOSSL_MAC_PARAM_SIZE\fR) <unsigned integer>" 4 |
| 118 |
.IX Item """size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>" |
| 119 |
The "size" parameter can also be retrieved with \fBEVP_MAC_CTX_get_mac_size()\fR. |
| 120 |
The length of the "size" parameter is equal to that of an \fBunsigned int\fR. |
| 121 |
.IP """block-size"" (\fBOSSL_MAC_PARAM_BLOCK_SIZE\fR) <unsigned integer>" 4 |
| 122 |
.IX Item """block-size"" (OSSL_MAC_PARAM_BLOCK_SIZE) <unsigned integer>" |
| 123 |
Gets the MAC block size. The "block-size" parameter can also be retrieved with |
| 124 |
\&\fBEVP_MAC_CTX_get_block_size()\fR. |
| 125 |
.IP """fips-indicator"" (\fBOSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4 |
| 126 |
.IX Item """fips-indicator"" (OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR) <integer>" |
| 127 |
See "Mac Parameters" in \fBprovider\-mac\fR\|(7). |
| 128 |
.SH "SEE ALSO" |
| 129 |
.IX Header "SEE ALSO" |
| 130 |
\&\fBEVP_MAC_CTX_get_params\fR\|(3), \fBEVP_MAC_CTX_set_params\fR\|(3), |
| 131 |
"PARAMETERS" in \fBEVP_MAC\fR\|(3), \fBOSSL_PARAM\fR\|(3), \fBHMAC\fR\|(3) |
| 132 |
.SH COPYRIGHT |
| 133 |
.IX Header "COPYRIGHT" |
| 134 |
Copyright 2018\-2024 The OpenSSL Project Authors. All Rights Reserved. |
| 135 |
.PP |
| 136 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 137 |
this file except in compliance with the License. You can obtain a copy |
| 138 |
in the file LICENSE in the source distribution or at |
| 139 |
<https://www.openssl.org/source/license.html>. |