Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / usr.bin / openssl / man / dgst.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "DGST 1"
132 .TH DGST 1 "2008-09-06" "0.9.8h" "OpenSSL"
133 .SH "NAME"
134 dgst, md5, md4, md2, sha1, sha, mdc2, ripemd160 \- message digests
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBopenssl\fR \fBdgst\fR 
138 [\fB\-md5|\-md4|\-md2|\-sha1|\-sha|\-mdc2|\-ripemd160|\-dss1\fR]
139 [\fB\-c\fR]
140 [\fB\-d\fR]
141 [\fB\-hex\fR]
142 [\fB\-binary\fR]
143 [\fB\-out filename\fR]
144 [\fB\-sign filename\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\-passin arg\fR" 4
183 .IX Item "-passin arg"
184 the private key password source. For more information about the format of \fBarg\fR
185 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
186 .IP "\fB\-verify filename\fR" 4
187 .IX Item "-verify filename"
188 verify the signature using the the public key in \*(L"filename\*(R".
189 The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
190 .IP "\fB\-prverify filename\fR" 4
191 .IX Item "-prverify filename"
192 verify the signature using the  the private key in \*(L"filename\*(R".
193 .IP "\fB\-signature filename\fR" 4
194 .IX Item "-signature filename"
195 the actual signature to verify.
196 .IP "\fB\-hmac key\fR" 4
197 .IX Item "-hmac key"
198 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
199 .IP "\fB\-rand file(s)\fR" 4
200 .IX Item "-rand file(s)"
201 a file or files containing random data used to seed the random number
202 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
203 Multiple files can be specified separated by a OS-dependent character.
204 The separator is \fB;\fR for MS\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
205 all others. 
206 .IP "\fBfile...\fR" 4
207 .IX Item "file..."
208 file or files to digest. If no files are specified then standard input is
209 used.
210 .SH "NOTES"
211 .IX Header "NOTES"
212 The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
213 however still widely used.
214 .PP
215 If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
216 digest must be used.
217 .PP
218 A source of random numbers is required for certain signing algorithms, in
219 particular \s-1DSA\s0.
220 .PP
221 The signing and verify options should only be used if a single file is
222 being signed or verified.