Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / usr.bin / openssl / man / dgst.1
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
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
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
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.\"
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "DGST 1"
aac4ff6f 132.TH DGST 1 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc
MD
133.SH "NAME"
134dgst, md5, md4, md2, sha1, sha, mdc2, ripemd160 \- message digests
135.SH "SYNOPSIS"
8b0cefbb
JR
136.IX Header "SYNOPSIS"
137\&\fBopenssl\fR \fBdgst\fR
984263bc
MD
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]
a561f9ff 145[\fB\-passin arg\fR]
984263bc
MD
146[\fB\-verify filename\fR]
147[\fB\-prverify filename\fR]
148[\fB\-signature filename\fR]
aac4ff6f 149[\fB\-hmac key\fR]
984263bc
MD
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"
8b0cefbb 157.IX Header "DESCRIPTION"
984263bc
MD
158The digest functions output the message digest of a supplied file or files
159in hexadecimal form. They can also be used for digital signing and verification.
160.SH "OPTIONS"
8b0cefbb
JR
161.IX Header "OPTIONS"
162.IP "\fB\-c\fR" 4
163.IX Item "-c"
984263bc 164print out the digest in two digit groups separated by colons, only relevant if
8b0cefbb
JR
165\&\fBhex\fR format output is used.
166.IP "\fB\-d\fR" 4
167.IX Item "-d"
984263bc 168print out \s-1BIO\s0 debugging information.
8b0cefbb
JR
169.IP "\fB\-hex\fR" 4
170.IX Item "-hex"
984263bc
MD
171digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
172digest as opposed to a digital signature.
8b0cefbb
JR
173.IP "\fB\-binary\fR" 4
174.IX Item "-binary"
984263bc 175output the digest or signature in binary form.
8b0cefbb
JR
176.IP "\fB\-out filename\fR" 4
177.IX Item "-out filename"
984263bc 178filename to output to, or standard output by default.
8b0cefbb
JR
179.IP "\fB\-sign filename\fR" 4
180.IX Item "-sign filename"
984263bc 181digitally sign the digest using the private key in \*(L"filename\*(R".
a561f9ff
SS
182.IP "\fB\-passin arg\fR" 4
183.IX Item "-passin arg"
184the private key password source. For more information about the format of \fBarg\fR
185see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
8b0cefbb
JR
186.IP "\fB\-verify filename\fR" 4
187.IX Item "-verify filename"
984263bc
MD
188verify the signature using the the public key in \*(L"filename\*(R".
189The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
8b0cefbb
JR
190.IP "\fB\-prverify filename\fR" 4
191.IX Item "-prverify filename"
984263bc 192verify the signature using the the private key in \*(L"filename\*(R".
8b0cefbb
JR
193.IP "\fB\-signature filename\fR" 4
194.IX Item "-signature filename"
984263bc 195the actual signature to verify.
aac4ff6f
PA
196.IP "\fB\-hmac key\fR" 4
197.IX Item "-hmac key"
198create a hashed \s-1MAC\s0 using \*(L"key\*(R".
8b0cefbb
JR
199.IP "\fB\-rand file(s)\fR" 4
200.IX Item "-rand file(s)"
984263bc 201a file or files containing random data used to seed the random number
8b0cefbb
JR
202generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
203Multiple files can be specified separated by a OS-dependent character.
aac4ff6f
PA
204The separator is \fB;\fR for MS\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
205all others.
8b0cefbb
JR
206.IP "\fBfile...\fR" 4
207.IX Item "file..."
984263bc
MD
208file or files to digest. If no files are specified then standard input is
209used.
210.SH "NOTES"
8b0cefbb
JR
211.IX Header "NOTES"
212The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
984263bc
MD
213however still widely used.
214.PP
8b0cefbb 215If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
984263bc
MD
216digest must be used.
217.PP
218A source of random numbers is required for certain signing algorithms, in
8b0cefbb 219particular \s-1DSA\s0.
984263bc
MD
220.PP
221The signing and verify options should only be used if a single file is
222being signed or verified.