Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
Standard preamble:
========================================================================
..
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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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 "OPENSSL-MAC 1"
way too many mistakes in technical documents.
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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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 "OPENSSL-MAC 1"
OPENSSL-MAC 1 "2023-06-02" "3.0.9" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
"NAME"
openssl-mac - perform Message Authentication Code operations
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl mac
[-help]
[-cipher]
[-digest]
[-macopt]
[-in filename]
[-out filename]
[-binary]
[-provider name]
[-provider-path path]
[-propquery propq]
\fImac_name
"DESCRIPTION"
Header "DESCRIPTION" The message authentication code functions output the \s-1MAC\s0 of a supplied input
file.
"OPTIONS"
Header "OPTIONS" "-help" 4
Item "-help" Print a usage message.
"-in filename" 4
Item "-in filename" Input filename to calculate a \s-1MAC\s0 for, or standard input by default.
Standard input is used if the filename is '-'.
Files and standard input are expected to be in binary format.
"-out filename" 4
Item "-out filename" Filename to output to, or standard output by default.
"-binary" 4
Item "-binary" Output the \s-1MAC\s0 in binary form. Uses hexadecimal text format if not specified.
"-cipher name" 4
Item "-cipher name" Used by \s-1CMAC\s0 and \s-1GMAC\s0 to specify the cipher algorithm.
For \s-1CMAC\s0 it must be one of \s-1AES-128-CBC, AES-192-CBC, AES-256-CBC\s0 or
\s-1DES-EDE3-CBC.\s0
For \s-1GMAC\s0 it should be a \s-1GCM\s0 mode cipher e.g. \s-1AES-128-GCM.\s0
"-digest name" 4
Item "-digest name" Used by \s-1HMAC\s0 as an alphanumeric string (use if the key contains printable
characters only).
The string length must conform to any restrictions of the \s-1MAC\s0 algorithm.
To see the list of supported digests, use \*(C`openssl list -digest-commands\*(C'.
"-macopt nm:v" 4
Item "-macopt nm:v" Passes options to the \s-1MAC\s0 algorithm.
A comprehensive list of controls can be found in the \s-1EVP_MAC\s0 implementation
documentation.
Common parameter names used by EVP_MAC_CTX_get_params() are:
"key:string" 4
Item "key:string" Specifies the \s-1MAC\s0 key as an alphanumeric string (use if the key contains
printable characters only).
The string length must conform to any restrictions of the \s-1MAC\s0 algorithm.
A key must be specified for every \s-1MAC\s0 algorithm.
"hexkey:string" 4
Item "hexkey:string" Specifies the \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
The key length must conform to any restrictions of the \s-1MAC\s0 algorithm.
A key must be specified for every \s-1MAC\s0 algorithm.
"iv:string" 4
Item "iv:string" Used by \s-1GMAC\s0 to specify an \s-1IV\s0 as an alphanumeric string (use if the \s-1IV\s0 contains
printable characters only).
"hexiv:string" 4
Item "hexiv:string" Used by \s-1GMAC\s0 to specify an \s-1IV\s0 in hexadecimal form (two hex digits per byte).
"size:int" 4
Item "size:int" Used by \s-1KMAC128\s0 or \s-1KMAC256\s0 to specify an output length.
The default sizes are 32 or 64 bytes respectively.
"custom:string" 4
Item "custom:string" Used by \s-1KMAC128\s0 or \s-1KMAC256\s0 to specify a customization string.
The default is the empty string "".
"digest:string" 4
Item "digest:string" This option is identical to the -digest option.
"cipher:string" 4
Item "cipher:string" This option is identical to the -cipher option.
"-provider name" 4
Item "-provider name" 0
"-provider-path path" 4
Item "-provider-path path" "-propquery propq" 4
Item "-propquery propq" See \*(L"Provider Options\*(R" in openssl\|(1), provider\|(7), and property\|(7).
"mac_name" 4
Item "mac_name" Specifies the name of a supported \s-1MAC\s0 algorithm which will be used.
To see the list of supported \s-1MAC\s0's use the command \*(C`openssl list
\-mac-algorithms\*(C'.
"EXAMPLES"
Header "EXAMPLES" To create a hex-encoded \s-1HMAC-SHA1 MAC\s0 of a file and write to stdout: \e
openssl mac -digest \s-1SHA1\s0 \e
-macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \e
-in msg.bin \s-1HMAC\s0
To create a SipHash \s-1MAC\s0 from a file with a binary file output: \e openssl mac -macopt hexkey:000102030405060708090A0B0C0D0E0F \e -in msg.bin -out out.bin -binary SipHash
To create a hex-encoded \s-1CMAC-AES-128-CBC MAC\s0 from a file:\e openssl mac -cipher \s-1AES-128-CBC\s0 \e -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B \e -in msg.bin \s-1CMAC\s0
To create a hex-encoded \s-1KMAC128 MAC\s0 from a file with a Customisation String 'Tag' and output length of 16: \e openssl mac -macopt custom:Tag -macopt hexkey:40414243444546 \e -macopt size:16 -in msg.bin \s-1KMAC128\s0
To create a hex-encoded \s-1GMAC-AES-128-GCM\s0 with a \s-1IV\s0 from a file: \e openssl mac -cipher \s-1AES-128-GCM\s0 -macopt hexiv:E0E00F19FED7BA0136A797F3 \e -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B -in msg.bin \s-1GMAC\s0
"NOTES"
Header "NOTES" The \s-1MAC\s0 mechanisms that are available will depend on the options
used when building OpenSSL.
Use \*(C`openssl list -mac-algorithms\*(C' to list them.
"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1),
\s-1EVP_MAC\s0\|(3),
\s-1EVP_MAC-CMAC\s0\|(7),
\s-1EVP_MAC-GMAC\s0\|(7),
\s-1EVP_MAC-HMAC\s0\|(7),
\s-1EVP_MAC-KMAC\s0\|(7),
\fBEVP_MAC-Siphash\|(7),
\fBEVP_MAC-Poly1305\|(7)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2018-2022 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>.