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

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "DGST 1"
 136 .TH DGST 1 "2015-12-03" "0.9.8zh" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 dgst, md5, md4, md2, sha1, sha, mdc2, ripemd160 \- message digests
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBdgst\fR
 146 [\fB\-md5|\-md4|\-md2|\-sha1|\-sha|\-mdc2|\-ripemd160|\-dss1\fR]
 147 [\fB\-c\fR]
 148 [\fB\-d\fR]
 149 [\fB\-hex\fR]
 150 [\fB\-binary\fR]
 151 [\fB\-out filename\fR]
 152 [\fB\-sign filename\fR]
 153 [\fB\-passin arg\fR]
 154 [\fB\-verify filename\fR]
 155 [\fB\-prverify filename\fR]
 156 [\fB\-signature filename\fR]
 157 [\fB\-hmac key\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\-passin arg\fR" 4
 191 .IX Item "-passin arg"
 192 the private key password source. For more information about the format of \fBarg\fR
 193 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 194 .IP "\fB\-verify filename\fR" 4
 195 .IX Item "-verify filename"
 196 verify the signature using the public key in \*(L"filename\*(R".
 197 The output is either \*(L"Verification \s-1OK\*(R"\s0 or \*(L"Verification Failure\*(R".
 198 .IP "\fB\-prverify filename\fR" 4
 199 .IX Item "-prverify filename"
 200 verify the signature using the  the private key in \*(L"filename\*(R".
 201 .IP "\fB\-signature filename\fR" 4
 202 .IX Item "-signature filename"
 203 the actual signature to verify.
 204 .IP "\fB\-hmac key\fR" 4
 205 .IX Item "-hmac key"
 206 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
 207 .IP "\fB\-rand file(s)\fR" 4
 208 .IX Item "-rand file(s)"
 209 a file or files containing random data used to seed the random number
 210 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 211 Multiple files can be specified separated by a OS-dependent character.
 212 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 213 all others.
 214 .IP "\fBfile...\fR" 4
 215 .IX Item "file..."
 216 file or files to digest. If no files are specified then standard input is
 217 used.
 218 .SH "NOTES"
 219 .IX Header "NOTES"
 220 The digest of choice for all new applications is \s-1SHA1.\s0 Other digests are
 221 however still widely used.
 222 .PP
 223 If you wish to sign or verify data using the \s-1DSA\s0 algorithm then the dss1
 224 digest must be used.
 225 .PP
 226 A source of random numbers is required for certain signing algorithms, in
 227 particular \s-1DSA.\s0
 228 .PP
 229 The signing and verify options should only be used if a single file is
 230 being signed or verified.