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

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