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