Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / usr.bin / openssl / man / dgst.1
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
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 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "DGST 1"
135 .TH DGST 1 "2009-01-11" "0.9.8j" "OpenSSL"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 dgst, md5, md4, md2, sha1, sha, mdc2, ripemd160 \- message digests
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 \&\fBopenssl\fR \fBdgst\fR 
145 [\fB\-md5|\-md4|\-md2|\-sha1|\-sha|\-mdc2|\-ripemd160|\-dss1\fR]
146 [\fB\-c\fR]
147 [\fB\-d\fR]
148 [\fB\-hex\fR]
149 [\fB\-binary\fR]
150 [\fB\-out filename\fR]
151 [\fB\-sign filename\fR]
152 [\fB\-passin arg\fR]
153 [\fB\-verify filename\fR]
154 [\fB\-prverify filename\fR]
155 [\fB\-signature filename\fR]
156 [\fB\-hmac key\fR]
157 [\fBfile...\fR]
158 .PP
159 [\fBmd5|md4|md2|sha1|sha|mdc2|ripemd160\fR]
160 [\fB\-c\fR]
161 [\fB\-d\fR]
162 [\fBfile...\fR]
163 .SH "DESCRIPTION"
164 .IX Header "DESCRIPTION"
165 The digest functions output the message digest of a supplied file or files
166 in hexadecimal form. They can also be used for digital signing and verification.
167 .SH "OPTIONS"
168 .IX Header "OPTIONS"
169 .IP "\fB\-c\fR" 4
170 .IX Item "-c"
171 print out the digest in two digit groups separated by colons, only relevant if
172 \&\fBhex\fR format output is used.
173 .IP "\fB\-d\fR" 4
174 .IX Item "-d"
175 print out \s-1BIO\s0 debugging information.
176 .IP "\fB\-hex\fR" 4
177 .IX Item "-hex"
178 digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
179 digest as opposed to a digital signature.
180 .IP "\fB\-binary\fR" 4
181 .IX Item "-binary"
182 output the digest or signature in binary form.
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\-passin arg\fR" 4
190 .IX Item "-passin arg"
191 the private key password source. For more information about the format of \fBarg\fR
192 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
193 .IP "\fB\-verify filename\fR" 4
194 .IX Item "-verify filename"
195 verify the signature using the the public key in \*(L"filename\*(R".
196 The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
197 .IP "\fB\-prverify filename\fR" 4
198 .IX Item "-prverify filename"
199 verify the signature using the  the private key in \*(L"filename\*(R".
200 .IP "\fB\-signature filename\fR" 4
201 .IX Item "-signature filename"
202 the actual signature to verify.
203 .IP "\fB\-hmac key\fR" 4
204 .IX Item "-hmac key"
205 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
206 .IP "\fB\-rand file(s)\fR" 4
207 .IX Item "-rand file(s)"
208 a file or files containing random data used to seed the random number
209 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
210 Multiple files can be specified separated by a OS-dependent character.
211 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
212 all others.
213 .IP "\fBfile...\fR" 4
214 .IX Item "file..."
215 file or files to digest. If no files are specified then standard input is
216 used.
217 .SH "NOTES"
218 .IX Header "NOTES"
219 The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
220 however still widely used.
221 .PP
222 If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
223 digest must be used.
224 .PP
225 A source of random numbers is required for certain signing algorithms, in
226 particular \s-1DSA\s0.
227 .PP
228 The signing and verify options should only be used if a single file is
229 being signed or verified.