Update build for OpenSSL-1.0.0b import.
[dragonfly.git] / secure / usr.bin / openssl / man / dgst.1
1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
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 "2010-11-16" "1.0.0b" "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, md5, md4, md2, sha1, sha, mdc2, ripemd160 \- message digests
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl\fR \fBdgst\fR 
137 [\fB\-md5|\-md4|\-md2|\-sha1|\-sha|\-mdc2|\-ripemd160|\-dss1\fR]
138 [\fB\-c\fR]
139 [\fB\-d\fR]
140 [\fB\-hex\fR]
141 [\fB\-binary\fR]
142 [\fB\-out filename\fR]
143 [\fB\-sign filename\fR]
144 [\fB\-keyform arg\fR]
145 [\fB\-passin arg\fR]
146 [\fB\-verify filename\fR]
147 [\fB\-prverify filename\fR]
148 [\fB\-signature filename\fR]
149 [\fB\-hmac key\fR]
150 [\fBfile...\fR]
151 .PP
152 [\fBmd5|md4|md2|sha1|sha|mdc2|ripemd160\fR]
153 [\fB\-c\fR]
154 [\fB\-d\fR]
155 [\fBfile...\fR]
156 .SH "DESCRIPTION"
157 .IX Header "DESCRIPTION"
158 The digest functions output the message digest of a supplied file or files
159 in hexadecimal form. They can also be used for digital signing and verification.
160 .SH "OPTIONS"
161 .IX Header "OPTIONS"
162 .IP "\fB\-c\fR" 4
163 .IX Item "-c"
164 print out the digest in two digit groups separated by colons, only relevant if
165 \&\fBhex\fR format output is used.
166 .IP "\fB\-d\fR" 4
167 .IX Item "-d"
168 print out \s-1BIO\s0 debugging information.
169 .IP "\fB\-hex\fR" 4
170 .IX Item "-hex"
171 digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
172 digest as opposed to a digital signature.
173 .IP "\fB\-binary\fR" 4
174 .IX Item "-binary"
175 output the digest or signature in binary form.
176 .IP "\fB\-out filename\fR" 4
177 .IX Item "-out filename"
178 filename to output to, or standard output by default.
179 .IP "\fB\-sign filename\fR" 4
180 .IX Item "-sign filename"
181 digitally sign the digest using the private key in \*(L"filename\*(R".
182 .IP "\fB\-keyform arg\fR" 4
183 .IX Item "-keyform arg"
184 Specifies the key format to sign digest with. Only \s-1PEM\s0 and \s-1ENGINE\s0
185 formats are supported by the \fBdgst\fR command.
186 .IP "\fB\-engine id\fR" 4
187 .IX Item "-engine id"
188 Use engine \fBid\fR for operations (including private key storage).
189 This engine is not used as source for digest algorithms, unless it is
190 also specified in the configuration file.
191 .IP "\fB\-sigopt nm:v\fR" 4
192 .IX Item "-sigopt nm:v"
193 Pass options to the signature algorithm during sign or verify operations.
194 Names and values of these options are algorithm-specific.
195 .IP "\fB\-passin arg\fR" 4
196 .IX Item "-passin arg"
197 the private key password source. For more information about the format of \fBarg\fR
198 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
199 .IP "\fB\-verify filename\fR" 4
200 .IX Item "-verify filename"
201 verify the signature using the the public key in \*(L"filename\*(R".
202 The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
203 .IP "\fB\-prverify filename\fR" 4
204 .IX Item "-prverify filename"
205 verify the signature using the  the private key in \*(L"filename\*(R".
206 .IP "\fB\-signature filename\fR" 4
207 .IX Item "-signature filename"
208 the actual signature to verify.
209 .IP "\fB\-hmac key\fR" 4
210 .IX Item "-hmac key"
211 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
212 .IP "\fB\-mac alg\fR" 4
213 .IX Item "-mac alg"
214 create \s-1MAC\s0 (keyed Message Authentication Code). The most popular \s-1MAC\s0
215 algorithm is \s-1HMAC\s0 (hash-based \s-1MAC\s0), but there are other \s-1MAC\s0 algorithms
216 which are not based on hash, for instance \fBgost-mac\fR algorithm,
217 supported by \fBccgost\fR engine. \s-1MAC\s0 keys and other options should be set
218 via \fB\-macopt\fR parameter.
219 .IP "\fB\-macopt nm:v\fR" 4
220 .IX Item "-macopt nm:v"
221 Passes options to \s-1MAC\s0 algorithm, specified by \fB\-mac\fR key.
222 Following options are supported by both by \fB\s-1HMAC\s0\fR and \fBgost-mac\fR:
223 .RS 4
224 .IP "\fBkey:string\fR" 8
225 .IX Item "key:string"
226 Specifies \s-1MAC\s0 key as alphnumeric string (use if key contain printable
227 characters only). String length must conform to any restrictions of
228 the \s-1MAC\s0 algorithm for example exactly 32 chars for gost-mac.
229 .IP "\fBhexkey:string\fR" 8
230 .IX Item "hexkey:string"
231 Specifies \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
232 Key length must conform to any restrictions of the \s-1MAC\s0 algorithm
233 for example exactly 32 chars for gost-mac.
234 .RE
235 .RS 4
236 .RE
237 .IP "\fB\-rand file(s)\fR" 4
238 .IX Item "-rand file(s)"
239 a file or files containing random data used to seed the random number
240 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
241 Multiple files can be specified separated by a OS-dependent character.
242 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
243 all others.
244 .IP "\fBfile...\fR" 4
245 .IX Item "file..."
246 file or files to digest. If no files are specified then standard input is
247 used.
248 .SH "NOTES"
249 .IX Header "NOTES"
250 The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
251 however still widely used.
252 .PP
253 If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
254 digest must be used.
255 .PP
256 A source of random numbers is required for certain signing algorithms, in
257 particular \s-1DSA\s0.
258 .PP
259 The signing and verify options should only be used if a single file is
260 being signed or verified.