xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_MAC-GMAC.7 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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_MAC-GMAC 7ossl"
EVP_MAC-GMAC 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_MAC-GMAC - The GMAC EVP_MAC implementation
"DESCRIPTION"
Header "DESCRIPTION" Support for computing \s-1GMAC\s0 MACs through the \s-1EVP_MAC\s0 \s-1API.\s0

This implementation uses \s-1EVP_CIPHER\s0 functions to get access to the underlying cipher.

"Identity"
Subsection "Identity" This implementation is identified with this name and properties, to be used with EVP_MAC_fetch(): Item "GMAC, provider=default or provider=fips"
"Supported parameters"
Subsection "Supported parameters" The general description of these parameters can be found in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_MAC\s0\|(3).

The following parameter can be set with EVP_MAC_CTX_set_params(): Item "key (OSSL_MAC_PARAM_KEY) <octet string>" Sets the \s-1MAC\s0 key. Setting this parameter is identical to passing a key to EVP_MAC_init\|(3). Item "iv (OSSL_MAC_PARAM_IV) <octet string>" Sets the \s-1IV\s0 of the underlying cipher, when applicable. Item "cipher (OSSL_MAC_PARAM_CIPHER) <UTF8 string>" Sets the name of the underlying cipher to be used. Item "properties (OSSL_MAC_PARAM_PROPERTIES) <UTF8 string>" Sets the properties to be queried when trying to fetch the underlying cipher. This must be given together with the cipher naming parameter to be considered valid.

The following parameters can be retrieved with \fBEVP_MAC_CTX_get_params(): Item "size (OSSL_MAC_PARAM_SIZE) <unsigned integer>" Gets the \s-1MAC\s0 size.

The \*(L"size\*(R" parameter can also be retrieved with EVP_MAC_CTX_get_mac_size(). The length of the \*(L"size\*(R" parameter is equal to that of an unsigned int.

"SEE ALSO"
Header "SEE ALSO" \fBEVP_MAC_CTX_get_params\|(3), EVP_MAC_CTX_set_params\|(3), \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_MAC\s0\|(3), \s-1OSSL_PARAM\s0\|(3)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2018-2021 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>.