Deprecate unprefixed manual entries for openssl commands
[openssl.git] / doc / man1 / openssl-mac.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-mac - perform Message Authentication Code operations
6
7 =head1 SYNOPSIS
8
9 B<openssl mac>
10 [B<-help>]
11 [B<-macopt>]
12 [B<-in filename>]
13 [B<-out filename>]
14 [B<-binary>]
15 B<mac_name>
16
17 B<openssl> I<mac> [B<...>] B<mac_name>
18
19 =head1 DESCRIPTION
20
21 The message authentication code functions output the MAC of a supplied input
22 file.
23
24 =head1 OPTIONS
25
26 =over 4
27
28 =item B<-help>
29
30 Print a usage message.
31
32 =item B<-in filename>
33
34 Input filename to calculate a MAC for, or standard input by default.
35 Standard input is used if the filename is '-'.
36 Files are expected to be in binary format, standard input uses hexadecimal text
37 format.
38
39 =item B<-out filename>
40
41 Filename to output to, or standard output by default.
42
43 =item B<-binary>
44
45 Output the MAC in binary form. Uses hexadecimal text format if not specified.
46
47 =item B<-macopt nm:v>
48
49 Passes options to the MAC algorithm.
50 A comprehensive list of controls can be found in the EVP_MAC implementation
51 documentation.
52 Common control strings used by EVP_MAC_ctrl_str() are:
53
54 =over 4
55
56 =item B<key:string>
57
58 Specifies the MAC key as an alphanumeric string (use if the key contains
59 printable characters only).
60 The string length must conform to any restrictions of the MAC algorithm.
61 A key must be specified for every MAC algorithm.
62
63 =item B<hexkey:string>
64
65 Specifies the MAC key in hexadecimal form (two hex digits per byte).
66 The key length must conform to any restrictions of the MAC algorithm.
67 A key must be specified for every MAC algorithm.
68
69 =item B<digest:string>
70
71 Used by HMAC as an alphanumeric string (use if the key contains printable
72 characters only).
73 The string length must conform to any restrictions of the MAC algorithm.
74 To see the list of supported digests, use the command I<list -digest-commands>.
75
76 =item B<cipher:string>
77
78 Used by CMAC and GMAC to specify the cipher algorithm.
79 For CMAC it must be one of AES-128-CBC, AES-192-CBC, AES-256-CBC or
80 DES-EDE3-CBC.
81 For GMAC it should be a GCM mode cipher e.g. AES-128-GCM.
82
83 =item B<iv:string>
84
85 Used by GMAC to specify an IV as an alphanumeric string (use if the IV contains
86 printable characters only).
87
88 =item B<hexiv:string>
89
90 Used by GMAC to specify an IV in hexadecimal form (two hex digits per byte).
91
92 =item B<outlen:int>
93
94 Used by KMAC128 or KMAC256 to specify an output length.
95 The default sizes are 32 or 64 bytes respectively.
96
97 =item B<custom:string>
98
99 Used by KMAC128 or KMAC256 to specify a customization string.
100 The default is the empty string "".
101
102 =back
103
104 =item B<mac_name>
105
106 Specifies the name of a supported MAC algorithm which will be used.
107 To see the list of supported MAC's use the command I<list -mac-algorithms>.
108
109 =back
110
111
112 =head1 EXAMPLES
113
114 To create a hex-encoded HMAC-SHA1 MAC of a file and write to stdout: \
115  openssl mac -macopt digest:SHA1 \
116          -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \
117          -in msg.bin HMAC
118
119 To create a SipHash MAC from a file with a binary file output: \
120  openssl mac -macopt hexkey:000102030405060708090A0B0C0D0E0F \
121          -in msg.bin -out out.bin -binary SipHash
122
123 To create a hex-encoded CMAC-AES-128-CBC MAC from a file:\
124  openssl mac -macopt cipher:AES-128-CBC \
125          -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B \
126          -in msg.bin CMAC
127
128 To create a hex-encoded KMAC128 MAC from a file with a Customisation String
129 'Tag' and output length of 16: \
130  openssl mac -macopt custom:Tag -macopt hexkey:40414243444546 \
131          -macopt outlen:16 -in msg.bin KMAC128
132
133 To create a hex-encoded GMAC-AES-128-GCM with a IV from a file: \
134  openssl mac -macopt cipher:AES-128-GCM -macopt hexiv:E0E00F19FED7BA0136A797F3 \
135          -macopt hexkey:77A77FAF290C1FA30C683DF16BA7A77B -in msg.bin GMAC
136
137 =head1 NOTES
138
139 The MAC mechanisms that are available will depend on the options
140 used when building OpenSSL.
141 The B<list -mac-algorithms> command can be used to list them.
142
143 =head1 SEE ALSO
144
145 L<openssl(1)>,
146 L<EVP_MAC(3)>,
147 L<EVP_MAC_CMAC(7)>,
148 L<EVP_MAC_GMAC(7)>,
149 L<EVP_MAC_HMAC(7)>,
150 L<EVP_MAC_KMAC(7)>,
151 L<EVP_MAC_SIPHASH(7)>,
152 L<EVP_MAC_POLY1305(7)>
153
154 =head1 COPYRIGHT
155
156 Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
157
158 Licensed under the OpenSSL license (the "License").  You may not use
159 this file except in compliance with the License.  You can obtain a copy
160 in the file LICENSE in the source distribution or at
161 L<https://www.openssl.org/source/license.html>.
162
163 =cut