secure/usr.bin/openssl/man/dgst.1

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