Merge from vendor branch NETGRAPH:
[dragonfly.git] / secure / usr.bin / openssl / man / dgst.1
1 .\" Automatically generated by Pod::Man 2.12 (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 .\" 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 .\" 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 "2007-10-24" "0.9.8g" "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\-passin arg\fR]
145 [\fB\-verify filename\fR]
146 [\fB\-prverify filename\fR]
147 [\fB\-signature filename\fR]
148 [\fBfile...\fR]
149 .PP
150 [\fBmd5|md4|md2|sha1|sha|mdc2|ripemd160\fR]
151 [\fB\-c\fR]
152 [\fB\-d\fR]
153 [\fBfile...\fR]
154 .SH "DESCRIPTION"
155 .IX Header "DESCRIPTION"
156 The digest functions output the message digest of a supplied file or files
157 in hexadecimal form. They can also be used for digital signing and verification.
158 .SH "OPTIONS"
159 .IX Header "OPTIONS"
160 .IP "\fB\-c\fR" 4
161 .IX Item "-c"
162 print out the digest in two digit groups separated by colons, only relevant if
163 \&\fBhex\fR format output is used.
164 .IP "\fB\-d\fR" 4
165 .IX Item "-d"
166 print out \s-1BIO\s0 debugging information.
167 .IP "\fB\-hex\fR" 4
168 .IX Item "-hex"
169 digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
170 digest as opposed to a digital signature.
171 .IP "\fB\-binary\fR" 4
172 .IX Item "-binary"
173 output the digest or signature in binary form.
174 .IP "\fB\-out filename\fR" 4
175 .IX Item "-out filename"
176 filename to output to, or standard output by default.
177 .IP "\fB\-sign filename\fR" 4
178 .IX Item "-sign filename"
179 digitally sign the digest using the private key in \*(L"filename\*(R".
180 .IP "\fB\-passin arg\fR" 4
181 .IX Item "-passin arg"
182 the private key password source. For more information about the format of \fBarg\fR
183 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
184 .IP "\fB\-verify filename\fR" 4
185 .IX Item "-verify filename"
186 verify the signature using the the public key in \*(L"filename\*(R".
187 The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
188 .IP "\fB\-prverify filename\fR" 4
189 .IX Item "-prverify filename"
190 verify the signature using the  the private key in \*(L"filename\*(R".
191 .IP "\fB\-signature filename\fR" 4
192 .IX Item "-signature filename"
193 the actual signature to verify.
194 .IP "\fB\-rand file(s)\fR" 4
195 .IX Item "-rand file(s)"
196 a file or files containing random data used to seed the random number
197 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
198 Multiple files can be specified separated by a OS-dependent character.
199 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
200 all others.
201 .IP "\fBfile...\fR" 4
202 .IX Item "file..."
203 file or files to digest. If no files are specified then standard input is
204 used.
205 .SH "NOTES"
206 .IX Header "NOTES"
207 The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
208 however still widely used.
209 .PP
210 If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
211 digest must be used.
212 .PP
213 A source of random numbers is required for certain signing algorithms, in
214 particular \s-1DSA\s0.
215 .PP
216 The signing and verify options should only be used if a single file is
217 being signed or verified.