bdd67faa044cf5da14c0968b75a229da8aec918b
[dragonfly.git] / secure / usr.bin / openssl / man / dgst.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "DGST 1"
127 .TH DGST 1 "2014-06-05" "1.0.1h" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 dgst, sha, sha1, mdc2, ripemd160, sha224, sha256, sha384, sha512, md2, md4, md5, dss1 \- message digests
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBdgst\fR 
137 [\fB\-sha|\-sha1|\-mdc2|\-ripemd160|\-sha224|\-sha256|\-sha384|\-sha512|\-md2|\-md4|\-md5|\-dss1\fR]
138 [\fB\-c\fR]
139 [\fB\-d\fR]
140 [\fB\-hex\fR]
141 [\fB\-binary\fR]
142 [\fB\-r\fR]
143 [\fB\-out filename\fR]
144 [\fB\-sign filename\fR]
145 [\fB\-keyform arg\fR]
146 [\fB\-passin arg\fR]
147 [\fB\-verify filename\fR]
148 [\fB\-prverify filename\fR]
149 [\fB\-signature filename\fR]
150 [\fB\-hmac key\fR]
151 [\fB\-non\-fips\-allow\fR]
152 [\fB\-fips\-fingerprint\fR]
153 [\fBfile...\fR]
154 .PP
155 \&\fBopenssl\fR
156 [\fIdigest\fR]
157 [\fB...\fR]
158 .SH "DESCRIPTION"
159 .IX Header "DESCRIPTION"
160 The digest functions output the message digest of a supplied file or files
161 in hexadecimal.  The digest functions also generate and verify digital
162 signatures using message digests.
163 .SH "OPTIONS"
164 .IX Header "OPTIONS"
165 .IP "\fB\-c\fR" 4
166 .IX Item "-c"
167 print out the digest in two digit groups separated by colons, only relevant if
168 \&\fBhex\fR format output is used.
169 .IP "\fB\-d\fR" 4
170 .IX Item "-d"
171 print out \s-1BIO\s0 debugging information.
172 .IP "\fB\-hex\fR" 4
173 .IX Item "-hex"
174 digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
175 digest as opposed to a digital signature.  See \s-1NOTES\s0 below for digital
176 signatures using \fB\-hex\fR.
177 .IP "\fB\-binary\fR" 4
178 .IX Item "-binary"
179 output the digest or signature in binary form.
180 .IP "\fB\-r\fR" 4
181 .IX Item "-r"
182 output the digest in the \*(L"coreutils\*(R" format used by programs like \fBsha1sum\fR.
183 .IP "\fB\-out filename\fR" 4
184 .IX Item "-out filename"
185 filename to output to, or standard output by default.
186 .IP "\fB\-sign filename\fR" 4
187 .IX Item "-sign filename"
188 digitally sign the digest using the private key in \*(L"filename\*(R".
189 .IP "\fB\-keyform arg\fR" 4
190 .IX Item "-keyform arg"
191 Specifies the key format to sign digest with. The \s-1DER\s0, \s-1PEM\s0, P12,
192 and \s-1ENGINE\s0 formats are supported.
193 .IP "\fB\-engine id\fR" 4
194 .IX Item "-engine id"
195 Use engine \fBid\fR for operations (including private key storage).
196 This engine is not used as source for digest algorithms, unless it is
197 also specified in the configuration file.
198 .IP "\fB\-sigopt nm:v\fR" 4
199 .IX Item "-sigopt nm:v"
200 Pass options to the signature algorithm during sign or verify operations.
201 Names and values of these options are algorithm-specific.
202 .IP "\fB\-passin arg\fR" 4
203 .IX Item "-passin arg"
204 the private key password source. For more information about the format of \fBarg\fR
205 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
206 .IP "\fB\-verify filename\fR" 4
207 .IX Item "-verify filename"
208 verify the signature using the the public key in \*(L"filename\*(R".
209 The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
210 .IP "\fB\-prverify filename\fR" 4
211 .IX Item "-prverify filename"
212 verify the signature using the  the private key in \*(L"filename\*(R".
213 .IP "\fB\-signature filename\fR" 4
214 .IX Item "-signature filename"
215 the actual signature to verify.
216 .IP "\fB\-hmac key\fR" 4
217 .IX Item "-hmac key"
218 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
219 .IP "\fB\-mac alg\fR" 4
220 .IX Item "-mac alg"
221 create \s-1MAC\s0 (keyed Message Authentication Code). The most popular \s-1MAC\s0
222 algorithm is \s-1HMAC\s0 (hash-based \s-1MAC\s0), but there are other \s-1MAC\s0 algorithms
223 which are not based on hash, for instance \fBgost-mac\fR algorithm,
224 supported by \fBccgost\fR engine. \s-1MAC\s0 keys and other options should be set
225 via \fB\-macopt\fR parameter.
226 .IP "\fB\-macopt nm:v\fR" 4
227 .IX Item "-macopt nm:v"
228 Passes options to \s-1MAC\s0 algorithm, specified by \fB\-mac\fR key.
229 Following options are supported by both by \fB\s-1HMAC\s0\fR and \fBgost-mac\fR:
230 .RS 4
231 .IP "\fBkey:string\fR" 8
232 .IX Item "key:string"
233 Specifies \s-1MAC\s0 key as alphnumeric string (use if key contain printable
234 characters only). String length must conform to any restrictions of
235 the \s-1MAC\s0 algorithm for example exactly 32 chars for gost-mac.
236 .IP "\fBhexkey:string\fR" 8
237 .IX Item "hexkey:string"
238 Specifies \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
239 Key length must conform to any restrictions of the \s-1MAC\s0 algorithm
240 for example exactly 32 chars for gost-mac.
241 .RE
242 .RS 4
243 .RE
244 .IP "\fB\-rand file(s)\fR" 4
245 .IX Item "-rand file(s)"
246 a file or files containing random data used to seed the random number
247 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
248 Multiple files can be specified separated by a OS-dependent character.
249 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
250 all others.
251 .IP "\fB\-non\-fips\-allow\fR" 4
252 .IX Item "-non-fips-allow"
253 enable use of non-FIPS algorithms such as \s-1MD5\s0 even in \s-1FIPS\s0 mode.
254 .IP "\fB\-fips\-fingerprint\fR" 4
255 .IX Item "-fips-fingerprint"
256 compute \s-1HMAC\s0 using a specific key
257 for certain OpenSSL-FIPS operations.
258 .IP "\fBfile...\fR" 4
259 .IX Item "file..."
260 file or files to digest. If no files are specified then standard input is
261 used.
262 .SH "EXAMPLES"
263 .IX Header "EXAMPLES"
264 To create a hex-encoded message digest of a file:
265  openssl dgst \-md5 \-hex file.txt
266 .PP
267 To sign a file using \s-1SHA\-256\s0 with binary file output:
268  openssl dgst \-sha256 \-sign privatekey.pem \-out signature.sign file.txt
269 .PP
270 To verify a signature:
271  openssl dgst \-sha256 \-verify publickey.pem \e
272  \-signature signature.sign \e
273  file.txt
274 .SH "NOTES"
275 .IX Header "NOTES"
276 The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
277 however still widely used.
278 .PP
279 When signing a file, \fBdgst\fR will automatically determine the algorithm
280 (\s-1RSA\s0, \s-1ECC\s0, etc) to use for signing based on the private key's \s-1ASN\s0.1 info.
281 When verifying signatures, it only handles the \s-1RSA\s0, \s-1DSA\s0, or \s-1ECDSA\s0 signature
282 itself, not the related data to identify the signer and algorithm used in
283 formats such as x.509, \s-1CMS\s0, and S/MIME.
284 .PP
285 A source of random numbers is required for certain signing algorithms, in
286 particular \s-1ECDSA\s0 and \s-1DSA\s0.
287 .PP
288 The signing and verify options should only be used if a single file is
289 being signed or verified.
290 .PP
291 Hex signatures cannot be verified using \fBopenssl\fR.  Instead, use \*(L"xxd \-r\*(R"
292 or similar program to transform the hex signature into a binary signature
293 prior to verification.