crypto/external/bsd/openssl/lib/libcrypto/man/openssl_dgst.1

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "DGST 1"
 137 .TH DGST 1 "2009-04-15" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 dgst, md5, md4, md2, sha1, sha, mdc2, ripemd160 \- message digests
 144 .SH "LIBRARY"
 145 libcrypto, -lcrypto
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 \&\fBopenssl\fR \fBdgst\fR
 149 [\fB\-md5|\-md4|\-md2|\-sha1|\-sha|\-mdc2|\-ripemd160|\-dss1\fR]
 150 [\fB\-c\fR]
 151 [\fB\-d\fR]
 152 [\fB\-hex\fR]
 153 [\fB\-binary\fR]
 154 [\fB\-out filename\fR]
 155 [\fB\-sign filename\fR]
 156 [\fB\-keyform arg\fR]
 157 [\fB\-passin arg\fR]
 158 [\fB\-verify filename\fR]
 159 [\fB\-prverify filename\fR]
 160 [\fB\-signature filename\fR]
 161 [\fB\-hmac key\fR]
 162 [\fBfile...\fR]
 163 .PP
 164 [\fBmd5|md4|md2|sha1|sha|mdc2|ripemd160\fR]
 165 [\fB\-c\fR]
 166 [\fB\-d\fR]
 167 [\fBfile...\fR]
 168 .SH "DESCRIPTION"
 169 .IX Header "DESCRIPTION"
 170 The digest functions output the message digest of a supplied file or files
 171 in hexadecimal form. They can also be used for digital signing and verification.
 172 .SH "OPTIONS"
 173 .IX Header "OPTIONS"
 174 .IP "\fB\-c\fR" 4
 175 .IX Item "-c"
 176 print out the digest in two digit groups separated by colons, only relevant if
 177 \&\fBhex\fR format output is used.
 178 .IP "\fB\-d\fR" 4
 179 .IX Item "-d"
 180 print out \s-1BIO\s0 debugging information.
 181 .IP "\fB\-hex\fR" 4
 182 .IX Item "-hex"
 183 digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
 184 digest as opposed to a digital signature.
 185 .IP "\fB\-binary\fR" 4
 186 .IX Item "-binary"
 187 output the digest or signature in binary form.
 188 .IP "\fB\-out filename\fR" 4
 189 .IX Item "-out filename"
 190 filename to output to, or standard output by default.
 191 .IP "\fB\-sign filename\fR" 4
 192 .IX Item "-sign filename"
 193 digitally sign the digest using the private key in \*(L"filename\*(R".
 194 .IP "\fB\-keyform arg\fR" 4
 195 .IX Item "-keyform arg"
 196 Specifies the key format to sign digest with. Only \s-1PEM\s0 and \s-1ENGINE\s0
 197 formats are supported by the \fBdgst\fR command.
 198 .IP "\fB\-engine id\fR" 4
 199 .IX Item "-engine id"
 200 Use engine \fBid\fR for operations (including private key storage).
 201 This engine is not used as source for digest algorithms, unless it is
 202 also specified in the configuration file.
 203 .IP "\fB\-sigopt nm:v\fR" 4
 204 .IX Item "-sigopt nm:v"
 205 Pass options to the signature algorithm during sign or verify operations.
 206 Names and values of these options are algorithm-specific.
 207 .IP "\fB\-passin arg\fR" 4
 208 .IX Item "-passin arg"
 209 the private key password source. For more information about the format of \fBarg\fR
 210 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 211 .IP "\fB\-verify filename\fR" 4
 212 .IX Item "-verify filename"
 213 verify the signature using the the public key in \*(L"filename\*(R".
 214 The output is either \*(L"Verification \s-1OK\s0\*(R" or \*(L"Verification Failure\*(R".
 215 .IP "\fB\-prverify filename\fR" 4
 216 .IX Item "-prverify filename"
 217 verify the signature using the  the private key in \*(L"filename\*(R".
 218 .IP "\fB\-signature filename\fR" 4
 219 .IX Item "-signature filename"
 220 the actual signature to verify.
 221 .IP "\fB\-hmac key\fR" 4
 222 .IX Item "-hmac key"
 223 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
 224 .IP "\fB\-mac alg\fR" 4
 225 .IX Item "-mac alg"
 226 create \s-1MAC\s0 (keyed Message Authentication Code). The most popular \s-1MAC\s0
 227 algorithm is \s-1HMAC\s0 (hash-based \s-1MAC\s0), but there are other \s-1MAC\s0 algorithms
 228 which are not based on hash, for instance \fBgost-mac\fR algorithm,
 229 supported by \fBccgost\fR engine. \s-1MAC\s0 keys and other options should be set
 230 via \fB\-macopt\fR parameter.
 231 .IP "\fB\-macopt nm:v\fR" 4
 232 .IX Item "-macopt nm:v"
 233 Passes options to \s-1MAC\s0 algorithm, specified by \fB\-mac\fR key.
 234 Following options are supported by both by \fB\s-1HMAC\s0\fR and \fBgost-mac\fR:
 235 .RS 4
 236 .IP "\fBkey:string\fR" 8
 237 .IX Item "key:string"
 238 Specifies \s-1MAC\s0 key as alphnumeric string (use if key contain printable
 239 characters only). String length must conform to any restrictions of
 240 the \s-1MAC\s0 algorithm for example exactly 32 chars for gost-mac.
 241 .IP "\fBhexkey:string\fR" 8
 242 .IX Item "hexkey:string"
 243 Specifies \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
 244 Key length must conform to any restrictions of the \s-1MAC\s0 algorithm
 245 for example exactly 32 chars for gost-mac.
 246 .RE
 247 .RS 4
 248 .RE
 249 .IP "\fB\-rand file(s)\fR" 4
 250 .IX Item "-rand file(s)"
 251 a file or files containing random data used to seed the random number
 252 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 253 Multiple files can be specified separated by a OS-dependent character.
 254 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 255 all others.
 256 .IP "\fBfile...\fR" 4
 257 .IX Item "file..."
 258 file or files to digest. If no files are specified then standard input is
 259 used.
 260 .SH "NOTES"
 261 .IX Header "NOTES"
 262 The digest of choice for all new applications is \s-1SHA1\s0. Other digests are
 263 however still widely used.
 264 .PP
 265 If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
 266 digest must be used.
 267 .PP
 268 A source of random numbers is required for certain signing algorithms, in
 269 particular \s-1DSA\s0.
 270 .PP
 271 The signing and verify options should only be used if a single file is
 272 being signed or verified.