f83c2ac516c0992d9e6ee5e2944bf486d4eff2c8
[openssl.git] / doc / man1 / openssl-dgst.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-dgst - perform digest operations
6
7 =head1 SYNOPSIS
8
9 B<openssl dgst>
10 [B<-I<digest>>]
11 [B<-help>]
12 [B<-c>]
13 [B<-d>]
14 [B<-hex>]
15 [B<-binary>]
16 [B<-r>]
17 [B<-out> I<filename>]
18 [B<-sign> I<filename>]
19 [B<-keyform> I<arg>]
20 [B<-passin> I<arg>]
21 [B<-verify> I<filename>]
22 [B<-prverify> I<filename>]
23 [B<-signature> I<filename>]
24 [B<-sigopt> I<nm>:I<v>]
25 [B<-hmac> I<key>]
26 [B<-fips-fingerprint>]
27 [B<-rand> I<files>]
28 [B<-engine> I<id>]
29 [B<-engine_impl>]
30 [I<file> ...]
31
32 B<openssl> I<digest> [B<...>]
33
34 =head1 DESCRIPTION
35
36 This command output the message digest of a supplied file or files
37 in hexadecimal, and also generates and verifies digital
38 signatures using message digests.
39
40 The generic name, B<openssl dgst>, may be used with an option specifying the
41 algorithm to be used.
42 The default digest is B<sha256>.
43 A supported I<digest> name may also be used as the sub-command name.
44 To see the list of supported algorithms, use C<openssl list -digest-commands>
45
46 =head1 OPTIONS
47
48 =over 4
49
50 =item B<-help>
51
52 Print out a usage message.
53
54 =item B<-I<digest>>
55
56 Specifies name of a supported digest to be used. To see the list of
57 supported digests, use the command C<list --digest-commands>.
58
59 =item B<-c>
60
61 Print out the digest in two digit groups separated by colons, only relevant if
62 the B<-hex> option is given as well.
63
64 =item B<-d>
65
66 Print out BIO debugging information.
67
68 =item B<-hex>
69
70 Digest is to be output as a hex dump. This is the default case for a "normal"
71 digest as opposed to a digital signature.  See NOTES below for digital
72 signatures using B<-hex>.
73
74 =item B<-binary>
75
76 Output the digest or signature in binary form.
77
78 =item B<-r>
79
80 Output the digest in the "coreutils" format, including newlines.
81 Used by programs like L<sha1sum(1)>.
82
83 =item B<-out> I<filename>
84
85 Filename to output to, or standard output by default.
86
87 =item B<-sign> I<filename>
88
89 Digitally sign the digest using the private key in "filename". Note this option
90 does not support Ed25519 or Ed448 private keys. Use the L<openssl-pkeyutl(1)>
91 command instead for this.
92
93 =item B<-keyform> I<arg>
94
95 Specifies the key format to sign digest with. The DER, PEM, P12,
96 and ENGINE formats are supported.
97
98 =item B<-sigopt> I<nm>:I<v>
99
100 Pass options to the signature algorithm during sign or verify operations.
101 Names and values of these options are algorithm-specific.
102
103 =item B<-passin> I<arg>
104
105 The private key password source. For more information about the format of I<arg>
106 see L<openssl(1)/Pass phrase options>.
107
108 =item B<-verify> I<filename>
109
110 Verify the signature using the public key in "filename".
111 The output is either "Verification OK" or "Verification Failure".
112
113 =item B<-prverify> I<filename>
114
115 Verify the signature using the private key in "filename".
116
117 =item B<-signature> I<filename>
118
119 The actual signature to verify.
120
121 =item B<-hmac> I<key>
122
123 Create a hashed MAC using "key".
124
125 The L<openssl-mac(1)> command should be preferred to using this command line
126 option.
127
128 =item B<-mac> I<alg>
129
130 Create MAC (keyed Message Authentication Code). The most popular MAC
131 algorithm is HMAC (hash-based MAC), but there are other MAC algorithms
132 which are not based on hash, for instance B<gost-mac> algorithm,
133 supported by the B<gost> engine. MAC keys and other options should be set
134 via B<-macopt> parameter.
135
136 The L<openssl-mac(1)> command should be preferred to using this command line
137 option.
138
139 =item B<-macopt> I<nm>:I<v>
140
141 Passes options to MAC algorithm, specified by B<-mac> key.
142 Following options are supported by both by B<HMAC> and B<gost-mac>:
143
144 =over 4
145
146 =item B<key>:I<string>
147
148 Specifies MAC key as alphanumeric string (use if key contain printable
149 characters only). String length must conform to any restrictions of
150 the MAC algorithm for example exactly 32 chars for gost-mac.
151
152 =item B<hexkey>:I<string>
153
154 Specifies MAC key in hexadecimal form (two hex digits per byte).
155 Key length must conform to any restrictions of the MAC algorithm
156 for example exactly 32 chars for gost-mac.
157
158 =back
159
160 The L<openssl-mac(1)> command should be preferred to using this command line
161 option.
162
163 =item B<-rand> I<files>
164
165 The files containing random data used to seed the random number generator.
166 Multiple files can be specified separated by an OS-dependent character.
167 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
168 all others.
169
170 =item B<-writerand> I<file>
171
172 Writes random data to the specified I<file> upon exit.
173 This can be used with a subsequent B<-rand> flag.
174
175 =item B<-fips-fingerprint>
176
177 Compute HMAC using a specific key for certain OpenSSL-FIPS operations.
178
179 =item B<-engine> I<id>
180
181 Use engine I<id> for operations (including private key storage).
182 This engine is not used as source for digest algorithms, unless it is
183 also specified in the configuration file or B<-engine_impl> is also
184 specified.
185
186 =item B<-engine_impl>
187
188 When used with the B<-engine> option, it specifies to also use
189 engine I<id> for digest operations.
190
191 =item I<file> ...
192
193 File or files to digest. If no files are specified then standard input is
194 used.
195
196 =back
197
198
199 =head1 EXAMPLES
200
201 To create a hex-encoded message digest of a file:
202  openssl dgst -md5 -hex file.txt
203
204 To sign a file using SHA-256 with binary file output:
205  openssl dgst -sha256 -sign privatekey.pem -out signature.sign file.txt
206
207 To verify a signature:
208  openssl dgst -sha256 -verify publickey.pem \
209  -signature signature.sign \
210  file.txt
211
212
213 =head1 NOTES
214
215 The digest mechanisms that are available will depend on the options
216 used when building OpenSSL.
217 The C<openssl list -digest-commands> command can be used to list them.
218
219 New or agile applications should use probably use SHA-256. Other digests,
220 particularly SHA-1 and MD5, are still widely used for interoperating
221 with existing formats and protocols.
222
223 When signing a file, this command will automatically determine the algorithm
224 (RSA, ECC, etc) to use for signing based on the private key's ASN.1 info.
225 When verifying signatures, it only handles the RSA, DSA, or ECDSA signature
226 itself, not the related data to identify the signer and algorithm used in
227 formats such as x.509, CMS, and S/MIME.
228
229 A source of random numbers is required for certain signing algorithms, in
230 particular ECDSA and DSA.
231
232 The signing and verify options should only be used if a single file is
233 being signed or verified.
234
235 Hex signatures cannot be verified using B<openssl>.  Instead, use "xxd -r"
236 or similar program to transform the hex signature into a binary signature
237 prior to verification.
238
239 The L<openssl-mac(1)> command is preferred over the B<-hmac>, B<-mac> and
240 B<-macopt> command line options.
241
242 =head1 SEE ALSO
243
244 L<openssl-mac(1)>
245
246 =head1 HISTORY
247
248 The default digest was changed from MD5 to SHA256 in OpenSSL 1.1.0.
249 The FIPS-related options were removed in OpenSSL 1.1.0.
250
251 =head1 COPYRIGHT
252
253 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
254
255 Licensed under the Apache License 2.0 (the "License").  You may not use
256 this file except in compliance with the License.  You can obtain a copy
257 in the file LICENSE in the source distribution or at
258 L<https://www.openssl.org/source/license.html>.
259
260 =cut