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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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 .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 "2019-09-10" "1.1.1d" "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 openssl\-dgst, dgst \- perform digest operations
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl dgst\fR
 146 [\fB\-\f(BIdigest\fB\fR]
 147 [\fB\-help\fR]
 148 [\fB\-c\fR]
 149 [\fB\-d\fR]
 150 [\fB\-hex\fR]
 151 [\fB\-binary\fR]
 152 [\fB\-r\fR]
 153 [\fB\-out filename\fR]
 154 [\fB\-sign filename\fR]
 155 [\fB\-keyform arg\fR]
 156 [\fB\-passin arg\fR]
 157 [\fB\-verify filename\fR]
 158 [\fB\-prverify filename\fR]
 159 [\fB\-signature filename\fR]
 160 [\fB\-hmac key\fR]
 161 [\fB\-fips\-fingerprint\fR]
 162 [\fB\-rand file...\fR]
 163 [\fB\-engine id\fR]
 164 [\fB\-engine_impl\fR]
 165 [\fBfile...\fR]
 166 .PP
 167 \&\fBopenssl\fR \fIdigest\fR [\fB...\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.  The digest functions also generate and verify digital
 172 signatures using message digests.
 173 .PP
 174 The generic name, \fBdgst\fR, may be used with an option specifying the
 175 algorithm to be used.
 176 The default digest is \fIsha256\fR.
 177 A supported \fIdigest\fR name may also be used as the command name.
 178 To see the list of supported algorithms, use the \fIlist \-\-digest\-commands\fR
 179 command.
 180 .SH "OPTIONS"
 181 .IX Header "OPTIONS"
 182 .IP "\fB\-help\fR" 4
 183 .IX Item "-help"
 184 Print out a usage message.
 185 .IP "\fB\-\f(BIdigest\fB\fR" 4
 186 .IX Item "-digest"
 187 Specifies name of a supported digest to be used. To see the list of
 188 supported digests, use the command \fIlist \-\-digest\-commands\fR.
 189 .IP "\fB\-c\fR" 4
 190 .IX Item "-c"
 191 Print out the digest in two digit groups separated by colons, only relevant if
 192 \&\fBhex\fR format output is used.
 193 .IP "\fB\-d\fR" 4
 194 .IX Item "-d"
 195 Print out \s-1BIO\s0 debugging information.
 196 .IP "\fB\-hex\fR" 4
 197 .IX Item "-hex"
 198 Digest is to be output as a hex dump. This is the default case for a \*(L"normal\*(R"
 199 digest as opposed to a digital signature.  See \s-1NOTES\s0 below for digital
 200 signatures using \fB\-hex\fR.
 201 .IP "\fB\-binary\fR" 4
 202 .IX Item "-binary"
 203 Output the digest or signature in binary form.
 204 .IP "\fB\-r\fR" 4
 205 .IX Item "-r"
 206 Output the digest in the \*(L"coreutils\*(R" format used by programs like \fBsha1sum\fR.
 207 .IP "\fB\-out filename\fR" 4
 208 .IX Item "-out filename"
 209 Filename to output to, or standard output by default.
 210 .IP "\fB\-sign filename\fR" 4
 211 .IX Item "-sign filename"
 212 Digitally sign the digest using the private key in \*(L"filename\*(R". Note this option
 213 does not support Ed25519 or Ed448 private keys. Use the \fBpkeyutl\fR command
 214 instead for this.
 215 .IP "\fB\-keyform arg\fR" 4
 216 .IX Item "-keyform arg"
 217 Specifies the key format to sign digest with. The \s-1DER, PEM, P12,\s0
 218 and \s-1ENGINE\s0 formats are supported.
 219 .IP "\fB\-sigopt nm:v\fR" 4
 220 .IX Item "-sigopt nm:v"
 221 Pass options to the signature algorithm during sign or verify operations.
 222 Names and values of these options are algorithm-specific.
 223 .IP "\fB\-passin arg\fR" 4
 224 .IX Item "-passin arg"
 225 The private key password source. For more information about the format of \fBarg\fR
 226 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
 227 .IP "\fB\-verify filename\fR" 4
 228 .IX Item "-verify filename"
 229 Verify the signature using the public key in \*(L"filename\*(R".
 230 The output is either \*(L"Verification \s-1OK\*(R"\s0 or \*(L"Verification Failure\*(R".
 231 .IP "\fB\-prverify filename\fR" 4
 232 .IX Item "-prverify filename"
 233 Verify the signature using the private key in \*(L"filename\*(R".
 234 .IP "\fB\-signature filename\fR" 4
 235 .IX Item "-signature filename"
 236 The actual signature to verify.
 237 .IP "\fB\-hmac key\fR" 4
 238 .IX Item "-hmac key"
 239 Create a hashed \s-1MAC\s0 using \*(L"key\*(R".
 240 .IP "\fB\-mac alg\fR" 4
 241 .IX Item "-mac alg"
 242 Create \s-1MAC\s0 (keyed Message Authentication Code). The most popular \s-1MAC\s0
 243 algorithm is \s-1HMAC\s0 (hash-based \s-1MAC\s0), but there are other \s-1MAC\s0 algorithms
 244 which are not based on hash, for instance \fBgost-mac\fR algorithm,
 245 supported by \fBccgost\fR engine. \s-1MAC\s0 keys and other options should be set
 246 via \fB\-macopt\fR parameter.
 247 .IP "\fB\-macopt nm:v\fR" 4
 248 .IX Item "-macopt nm:v"
 249 Passes options to \s-1MAC\s0 algorithm, specified by \fB\-mac\fR key.
 250 Following options are supported by both by \fB\s-1HMAC\s0\fR and \fBgost-mac\fR:
 251 .RS 4
 252 .IP "\fBkey:string\fR" 4
 253 .IX Item "key:string"
 254 Specifies \s-1MAC\s0 key as alphanumeric string (use if key contain printable
 255 characters only). String length must conform to any restrictions of
 256 the \s-1MAC\s0 algorithm for example exactly 32 chars for gost-mac.
 257 .IP "\fBhexkey:string\fR" 4
 258 .IX Item "hexkey:string"
 259 Specifies \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
 260 Key length must conform to any restrictions of the \s-1MAC\s0 algorithm
 261 for example exactly 32 chars for gost-mac.
 262 .RE
 263 .RS 4
 264 .RE
 265 .IP "\fB\-rand file...\fR" 4
 266 .IX Item "-rand file..."
 267 A file or files containing random data used to seed the random number
 268 generator.
 269 Multiple files can be specified separated by an OS-dependent character.
 270 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 271 all others.
 272 .IP "[\fB\-writerand file\fR]" 4
 273 .IX Item "[-writerand file]"
 274 Writes random data to the specified \fIfile\fR upon exit.
 275 This can be used with a subsequent \fB\-rand\fR flag.
 276 .IP "\fB\-fips\-fingerprint\fR" 4
 277 .IX Item "-fips-fingerprint"
 278 Compute \s-1HMAC\s0 using a specific key for certain OpenSSL-FIPS operations.
 279 .IP "\fB\-engine id\fR" 4
 280 .IX Item "-engine id"
 281 Use engine \fBid\fR for operations (including private key storage).
 282 This engine is not used as source for digest algorithms, unless it is
 283 also specified in the configuration file or \fB\-engine_impl\fR is also
 284 specified.
 285 .IP "\fB\-engine_impl\fR" 4
 286 .IX Item "-engine_impl"
 287 When used with the \fB\-engine\fR option, it specifies to also use
 288 engine \fBid\fR for digest operations.
 289 .IP "\fBfile...\fR" 4
 290 .IX Item "file..."
 291 File or files to digest. If no files are specified then standard input is
 292 used.
 293 .SH "EXAMPLES"
 294 .IX Header "EXAMPLES"
 295 To create a hex-encoded message digest of a file:
 296  openssl dgst \-md5 \-hex file.txt
 297 .PP
 298 To sign a file using \s-1SHA\-256\s0 with binary file output:
 299  openssl dgst \-sha256 \-sign privatekey.pem \-out signature.sign file.txt
 300 .PP
 301 To verify a signature:
 302  openssl dgst \-sha256 \-verify publickey.pem \e
 303  \-signature signature.sign \e
 304  file.txt
 305 .SH "NOTES"
 306 .IX Header "NOTES"
 307 The digest mechanisms that are available will depend on the options
 308 used when building OpenSSL.
 309 The \fBlist digest-commands\fR command can be used to list them.
 310 .PP
 311 New or agile applications should use probably use \s-1SHA\-256.\s0 Other digests,
 312 particularly \s-1SHA\-1\s0 and \s-1MD5,\s0 are still widely used for interoperating
 313 with existing formats and protocols.
 314 .PP
 315 When signing a file, \fBdgst\fR will automatically determine the algorithm
 316 (\s-1RSA, ECC,\s0 etc) to use for signing based on the private key's \s-1ASN.1\s0 info.
 317 When verifying signatures, it only handles the \s-1RSA, DSA,\s0 or \s-1ECDSA\s0 signature
 318 itself, not the related data to identify the signer and algorithm used in
 319 formats such as x.509, \s-1CMS,\s0 and S/MIME.
 320 .PP
 321 A source of random numbers is required for certain signing algorithms, in
 322 particular \s-1ECDSA\s0 and \s-1DSA.\s0
 323 .PP
 324 The signing and verify options should only be used if a single file is
 325 being signed or verified.
 326 .PP
 327 Hex signatures cannot be verified using \fBopenssl\fR.  Instead, use \*(L"xxd \-r\*(R"
 328 or similar program to transform the hex signature into a binary signature
 329 prior to verification.
 330 .SH "HISTORY"
 331 .IX Header "HISTORY"
 332 The default digest was changed from \s-1MD5\s0 to \s-1SHA256\s0 in OpenSSL 1.1.0.
 333 The FIPS-related options were removed in OpenSSL 1.1.0.
 334 .SH "COPYRIGHT"
 335 .IX Header "COPYRIGHT"
 336 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
 337 .PP
 338 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 339 this file except in compliance with the License.  You can obtain a copy
 340 in the file \s-1LICENSE\s0 in the source distribution or at
 341 <https://www.openssl.org/source/license.html>.