diff options
Diffstat (limited to 'static/freebsd/man7/EVP_MAC-HMAC.7')
| -rw-r--r-- | static/freebsd/man7/EVP_MAC-HMAC.7 | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/static/freebsd/man7/EVP_MAC-HMAC.7 b/static/freebsd/man7/EVP_MAC-HMAC.7 new file mode 100644 index 00000000..e9a930fb --- /dev/null +++ b/static/freebsd/man7/EVP_MAC-HMAC.7 @@ -0,0 +1,142 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" 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'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l +.\" ======================================================================== +.\" +.IX Title "EVP_MAC-HMAC 7ossl" +.TH EVP_MAC-HMAC 7ossl 2026-04-07 3.5.6 OpenSSL +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +EVP_MAC\-HMAC \- The HMAC EVP_MAC implementation +.SH DESCRIPTION +.IX Header "DESCRIPTION" +Support for computing HMAC MACs through the \fBEVP_MAC\fR API. +.PP +This implementation uses EVP_MD functions to get access to the underlying +digest. +.SS Identity +.IX Subsection "Identity" +This implementation is identified with this name and properties, to be +used with \fBEVP_MAC_fetch()\fR: +.IP """HMAC"", ""provider=default"" or ""provider=fips""" 4 +.IX Item """HMAC"", ""provider=default"" or ""provider=fips""" +.SS "Supported parameters" +.IX Subsection "Supported parameters" +The general description of these parameters can be found in +"PARAMETERS" in \fBEVP_MAC\fR\|(3). +.PP +The following parameters can be set with \fBEVP_MAC_CTX_set_params()\fR: +.IP """key"" (\fBOSSL_MAC_PARAM_KEY\fR) <octet string>" 4 +.IX Item """key"" (OSSL_MAC_PARAM_KEY) <octet string>" +Sets the MAC key. +Setting this parameter is identical to passing a \fIkey\fR to \fBEVP_MAC_init\fR\|(3). +.IP """digest"" (\fBOSSL_MAC_PARAM_DIGEST\fR) <UTF8 string>" 4 +.IX Item """digest"" (OSSL_MAC_PARAM_DIGEST) <UTF8 string>" +Sets the name of the underlying digest to be used. +.IP """properties"" (\fBOSSL_MAC_PARAM_PROPERTIES\fR) <UTF8 string>" 4 +.IX 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\fR) to be considered valid. +.IP """digest\-noinit"" (\fBOSSL_MAC_PARAM_DIGEST_NOINIT\fR) <integer>" 4 +.IX 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. +This option is deprecated and will be removed in a future release. +It may be set but is currently ignored +.IP """digest\-oneshot"" (\fBOSSL_MAC_PARAM_DIGEST_ONESHOT\fR) <integer>" 4 +.IX 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. +This option is deprecated and will be removed in a future release. +It may be set but is currently ignored. +.IP """tls\-data\-size"" (\fBOSSL_MAC_PARAM_TLS_DATA_SIZE\fR) <unsigned integer>" 4 +.IX Item """tls-data-size"" (OSSL_MAC_PARAM_TLS_DATA_SIZE) <unsigned integer>" +.PD 0 +.IP """key\-check"" (\fBOSSL_MAC_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4 +.IX Item """key-check"" (OSSL_MAC_PARAM_FIPS_KEY_CHECK) <integer>" +.PD +See "Mac Parameters" in \fBprovider\-mac\fR\|(7). +.PP +The following parameters can be retrieved with \fBEVP_MAC_CTX_get_params()\fR: +.IP """size"" (\fBOSSL_MAC_PARAM_SIZE\fR) <unsigned integer>" 4 +.IX Item """size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>" +The "size" parameter can also be retrieved with \fBEVP_MAC_CTX_get_mac_size()\fR. +The length of the "size" parameter is equal to that of an \fBunsigned int\fR. +.IP """block\-size"" (\fBOSSL_MAC_PARAM_BLOCK_SIZE\fR) <unsigned integer>" 4 +.IX 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()\fR. +.IP """fips\-indicator"" (\fBOSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4 +.IX Item """fips-indicator"" (OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR) <integer>" +See "Mac Parameters" in \fBprovider\-mac\fR\|(7). +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBEVP_MAC_CTX_get_params\fR\|(3), \fBEVP_MAC_CTX_set_params\fR\|(3), +"PARAMETERS" in \fBEVP_MAC\fR\|(3), \fBOSSL_PARAM\fR\|(3), \fBHMAC\fR\|(3) +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2018\-2024 The OpenSSL Project Authors. All Rights Reserved. +.PP +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>. |