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

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 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
 112 .    \" corrections for vroff
 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'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 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
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "DGST 1"
 132 .TH DGST 1 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-dgst,
 139 dgst, sha, sha1, mdc2, ripemd160, sha224, sha256, sha384, sha512, md2, md4, md5, dss1 \- message digests
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl\fR \fBdgst\fR
 143 [\fB\-sha|\-sha1|\-mdc2|\-ripemd160|\-sha224|\-sha256|\-sha384|\-sha512|\-md2|\-md4|\-md5|\-dss1\fR]
 144 [\fB\-c\fR]
 145 [\fB\-d\fR]
 146 [\fB\-hex\fR]
 147 [\fB\-binary\fR]
 148 [\fB\-r\fR]
 149 [\fB\-non\-fips\-allow\fR]
 150 [\fB\-out filename\fR]
 151 [\fB\-sign filename\fR]
 152 [\fB\-keyform arg\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 [\fB\-non\-fips\-allow\fR]
 159 [\fB\-fips\-fingerprint\fR]
 160 [\fBfile...\fR]
 161 .PP
 162 \&\fBopenssl\fR
 163 [\fIdigest\fR]
 164 [\fB...\fR]
 165 .SH "DESCRIPTION"
 166 .IX Header "DESCRIPTION"
 167 The digest functions output the message digest of a supplied file or files
 168 in hexadecimal.  The digest functions also generate and verify digital
 169 signatures using message digests.
 170 .SH "OPTIONS"
 171 .IX Header "OPTIONS"
 172 .IP "\fB\-c\fR" 4
 173 .IX Item "-c"
 174 print out the digest in two digit groups separated by colons, only relevant if
 175 \&\fBhex\fR format output is used.
 176 .IP "\fB\-d\fR" 4
 177 .IX Item "-d"
 178 print out \s-1BIO\s0 debugging information.
 179 .IP "\fB\-hex\fR" 4
 180 .IX Item "-hex"
 181 digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
 182 digest as opposed to a digital signature.  See \s-1NOTES\s0 below for digital
 183 signatures using \fB\-hex\fR.
 184 .IP "\fB\-binary\fR" 4
 185 .IX Item "-binary"
 186 output the digest or signature in binary form.
 187 .IP "\fB\-r\fR" 4
 188 .IX Item "-r"
 189 output the digest in the \*(L"coreutils\*(R" format used by programs like \fBsha1sum\fR.
 190 .IP "\fB\-non\-fips\-allow\fR" 4
 191 .IX Item "-non-fips-allow"
 192 Allow use of non \s-1FIPS\s0 digest when in \s-1FIPS\s0 mode.  This has no effect when not in
 193 \&\s-1FIPS\s0 mode.
 194 .IP "\fB\-out filename\fR" 4
 195 .IX Item "-out filename"
 196 filename to output to, or standard output by default.
 197 .IP "\fB\-sign filename\fR" 4
 198 .IX Item "-sign filename"
 199 digitally sign the digest using the private key in \*(L"filename\*(R".
 200 .IP "\fB\-keyform arg\fR" 4
 201 .IX Item "-keyform arg"
 202 Specifies the key format to sign digest with. The \s-1DER, PEM, P12,\s0
 203 and \s-1ENGINE\s0 formats are supported.
 204 .IP "\fB\-engine id\fR" 4
 205 .IX Item "-engine id"
 206 Use engine \fBid\fR for operations (including private key storage).
 207 This engine is not used as source for digest algorithms, unless it is
 208 also specified in the configuration file.
 209 .IP "\fB\-sigopt nm:v\fR" 4
 210 .IX Item "-sigopt nm:v"
 211 Pass options to the signature algorithm during sign or verify operations.
 212 Names and values of these options are algorithm-specific.
 213 .IP "\fB\-passin arg\fR" 4
 214 .IX Item "-passin arg"
 215 the private key password source. For more information about the format of \fBarg\fR
 216 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 217 .IP "\fB\-verify filename\fR" 4
 218 .IX Item "-verify filename"
 219 verify the signature using the public key in \*(L"filename\*(R".
 220 The output is either \*(L"Verification \s-1OK\*(R"\s0 or \*(L"Verification Failure\*(R".
 221 .IP "\fB\-prverify filename\fR" 4
 222 .IX Item "-prverify filename"
 223 verify the signature using the private key in \*(L"filename\*(R".
 224 .IP "\fB\-signature filename\fR" 4
 225 .IX Item "-signature filename"
 226 the actual signature to verify.
 227 .IP "\fB\-hmac key\fR" 4
 228 .IX Item "-hmac key"
 229 create a hashed \s-1MAC\s0 using \*(L"key\*(R".
 230 .IP "\fB\-mac alg\fR" 4
 231 .IX Item "-mac alg"
 232 create \s-1MAC \s0(keyed Message Authentication Code). The most popular \s-1MAC\s0
 233 algorithm is \s-1HMAC \s0(hash-based \s-1MAC\s0), but there are other \s-1MAC\s0 algorithms
 234 which are not based on hash, for instance \fBgost-mac\fR algorithm,
 235 supported by \fBccgost\fR engine. \s-1MAC\s0 keys and other options should be set
 236 via \fB\-macopt\fR parameter.
 237 .IP "\fB\-macopt nm:v\fR" 4
 238 .IX Item "-macopt nm:v"
 239 Passes options to \s-1MAC\s0 algorithm, specified by \fB\-mac\fR key.
 240 Following options are supported by both by \fB\s-1HMAC\s0\fR and \fBgost-mac\fR:
 241 .RS 4
 242 .IP "\fBkey:string\fR" 8
 243 .IX Item "key:string"
 244 Specifies \s-1MAC\s0 key as alphnumeric string (use if key contain printable
 245 characters only). String length must conform to any restrictions of
 246 the \s-1MAC\s0 algorithm for example exactly 32 chars for gost-mac.
 247 .IP "\fBhexkey:string\fR" 8
 248 .IX Item "hexkey:string"
 249 Specifies \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
 250 Key length must conform to any restrictions of the \s-1MAC\s0 algorithm
 251 for example exactly 32 chars for gost-mac.
 252 .RE
 253 .RS 4
 254 .RE
 255 .IP "\fB\-rand file(s)\fR" 4
 256 .IX Item "-rand file(s)"
 257 a file or files containing random data used to seed the random number
 258 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 259 Multiple files can be specified separated by a OS-dependent character.
 260 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 261 all others.
 262 .IP "\fB\-non\-fips\-allow\fR" 4
 263 .IX Item "-non-fips-allow"
 264 enable use of non-FIPS algorithms such as \s-1MD5\s0 even in \s-1FIPS\s0 mode.
 265 .IP "\fB\-fips\-fingerprint\fR" 4
 266 .IX Item "-fips-fingerprint"
 267 compute \s-1HMAC\s0 using a specific key
 268 for certain OpenSSL-FIPS operations.
 269 .IP "\fBfile...\fR" 4
 270 .IX Item "file..."
 271 file or files to digest. If no files are specified then standard input is
 272 used.
 273 .SH "EXAMPLES"
 274 .IX Header "EXAMPLES"
 275 To create a hex-encoded message digest of a file:
 276  openssl dgst \-md5 \-hex file.txt
 277 .PP
 278 To sign a file using \s-1SHA\-256\s0 with binary file output:
 279  openssl dgst \-sha256 \-sign privatekey.pem \-out signature.sign file.txt
 280 .PP
 281 To verify a signature:
 282  openssl dgst \-sha256 \-verify publickey.pem \e
 283  \-signature signature.sign \e
 284  file.txt
 285 .SH "NOTES"
 286 .IX Header "NOTES"
 287 The digest of choice for all new applications is \s-1SHA1.\s0 Other digests are
 288 however still widely used.
 289 .PP
 290 When signing a file, \fBdgst\fR will automatically determine the algorithm
 291 (\s-1RSA, ECC,\s0 etc) to use for signing based on the private key's \s-1ASN.1\s0 info.
 292 When verifying signatures, it only handles the \s-1RSA, DSA,\s0 or \s-1ECDSA\s0 signature
 293 itself, not the related data to identify the signer and algorithm used in
 294 formats such as x.509, \s-1CMS,\s0 and S/MIME.
 295 .PP
 296 A source of random numbers is required for certain signing algorithms, in
 297 particular \s-1ECDSA\s0 and \s-1DSA.\s0
 298 .PP
 299 The signing and verify options should only be used if a single file is
 300 being signed or verified.
 301 .PP
 302 Hex signatures cannot be verified using \fBopenssl\fR.  Instead, use \*(L"xxd \-r\*(R"
 303 or similar program to transform the hex signature into a binary signature
 304 prior to verification.