doc/man1/dgst.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-dgst,
   6 dgst - perform digest operations
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl dgst>
  11 [B<-I<digest>>]
  12 [B<-help>]
  13 [B<-c>]
  14 [B<-d>]
  15 [B<-hex>]
  16 [B<-binary>]
  17 [B<-r>]
  18 [B<-out filename>]
  19 [B<-sign filename>]
  20 [B<-keyform arg>]
  21 [B<-passin arg>]
  22 [B<-verify filename>]
  23 [B<-prverify filename>]
  24 [B<-signature filename>]
  25 [B<-hmac key>]
  26 [B<-fips-fingerprint>]
  27 [B<-rand file...>]
  28 [B<-engine id>]
  29 [B<-engine_impl>]
  30 [B<file...>]
  31
  32 B<openssl> I<digest> [B<...>]
  33
  34 =head1 DESCRIPTION
  35
  36 The digest functions output the message digest of a supplied file or files
  37 in hexadecimal.  The digest functions also generate and verify digital
  38 signatures using message digests.
  39
  40 The generic name, B<dgst>, may be used with an option specifying the
  41 algorithm to be used.
  42 The default digest is I<sha256>.
  43 A supported I<digest> name may also be used as the command name.
  44 To see the list of supported algorithms, use the I<list --digest-commands>
  45 command.
  46
  47 =head1 OPTIONS
  48
  49 =over 4
  50
  51 =item B<-help>
  52
  53 Print out a usage message.
  54
  55 =item B<-I<digest>>
  56
  57 Specifies name of a supported digest to be used. To see the list of
  58 supported digests, use the command I<list --digest-commands>.
  59
  60 =item B<-c>
  61
  62 Print out the digest in two digit groups separated by colons, only relevant if
  63 B<hex> format output is used.
  64
  65 =item B<-d>
  66
  67 Print out BIO debugging information.
  68
  69 =item B<-hex>
  70
  71 Digest is to be output as a hex dump. This is the default case for a "normal"
  72 digest as opposed to a digital signature.  See NOTES below for digital
  73 signatures using B<-hex>.
  74
  75 =item B<-binary>
  76
  77 Output the digest or signature in binary form.
  78
  79 =item B<-r>
  80
  81 Output the digest in the "coreutils" format used by programs like B<sha1sum>.
  82
  83 =item B<-out filename>
  84
  85 Filename to output to, or standard output by default.
  86
  87 =item B<-sign filename>
  88
  89 Digitally sign the digest using the private key in "filename".
  90
  91 =item B<-keyform arg>
  92
  93 Specifies the key format to sign digest with. The DER, PEM, P12,
  94 and ENGINE formats are supported.
  95
  96 =item B<-sigopt nm:v>
  97
  98 Pass options to the signature algorithm during sign or verify operations.
  99 Names and values of these options are algorithm-specific.
 100
 101 =item B<-passin arg>
 102
 103 The private key password source. For more information about the format of B<arg>
 104 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
 105
 106 =item B<-verify filename>
 107
 108 Verify the signature using the public key in "filename".
 109 The output is either "Verification OK" or "Verification Failure".
 110
 111 =item B<-prverify filename>
 112
 113 Verify the signature using the private key in "filename".
 114
 115 =item B<-signature filename>
 116
 117 The actual signature to verify.
 118
 119 =item B<-hmac key>
 120
 121 Create a hashed MAC using "key".
 122
 123 =item B<-mac alg>
 124
 125 Create MAC (keyed Message Authentication Code). The most popular MAC
 126 algorithm is HMAC (hash-based MAC), but there are other MAC algorithms
 127 which are not based on hash, for instance B<gost-mac> algorithm,
 128 supported by B<ccgost> engine. MAC keys and other options should be set
 129 via B<-macopt> parameter.
 130
 131 =item B<-macopt nm:v>
 132
 133 Passes options to MAC algorithm, specified by B<-mac> key.
 134 Following options are supported by both by B<HMAC> and B<gost-mac>:
 135
 136 =over 4
 137
 138 =item B<key:string>
 139
 140 Specifies MAC key as alphanumeric string (use if key contain printable
 141 characters only). String length must conform to any restrictions of
 142 the MAC algorithm for example exactly 32 chars for gost-mac.
 143
 144 =item B<hexkey:string>
 145
 146 Specifies MAC key in hexadecimal form (two hex digits per byte).
 147 Key length must conform to any restrictions of the MAC algorithm
 148 for example exactly 32 chars for gost-mac.
 149
 150 =back
 151
 152 =item B<-rand file...>
 153
 154 A file or files containing random data used to seed the random number
 155 generator.
 156 Multiple files can be specified separated by an OS-dependent character.
 157 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 158 all others.
 159
 160 =item [B<-writerand file>]
 161
 162 Writes random data to the specified I<file> upon exit.
 163 This can be used with a subsequent B<-rand> flag.
 164
 165 =item B<-fips-fingerprint>
 166
 167 Compute HMAC using a specific key for certain OpenSSL-FIPS operations.
 168
 169 =item B<-engine id>
 170
 171 Use engine B<id> for operations (including private key storage).
 172 This engine is not used as source for digest algorithms, unless it is
 173 also specified in the configuration file or B<-engine_impl> is also
 174 specified.
 175
 176 =item B<-engine_impl>
 177
 178 When used with the B<-engine> option, it specifies to also use
 179 engine B<id> for digest operations.
 180
 181 =item B<file...>
 182
 183 File or files to digest. If no files are specified then standard input is
 184 used.
 185
 186 =back
 187
 188
 189 =head1 EXAMPLES
 190
 191 To create a hex-encoded message digest of a file:
 192  openssl dgst -md5 -hex file.txt
 193
 194 To sign a file using SHA-256 with binary file output:
 195  openssl dgst -sha256 -sign privatekey.pem -out signature.sign file.txt
 196
 197 To verify a signature:
 198  openssl dgst -sha256 -verify publickey.pem \
 199  -signature signature.sign \
 200  file.txt
 201
 202
 203 =head1 NOTES
 204
 205 The digest mechanisms that are available will depend on the options
 206 used when building OpenSSL.
 207 The B<list digest-commands> command can be used to list them.
 208
 209 New or agile applications should use probably use SHA-256. Other digests,
 210 particularly SHA-1 and MD5, are still widely used for interoperating
 211 with existing formats and protocols.
 212
 213 When signing a file, B<dgst> will automatically determine the algorithm
 214 (RSA, ECC, etc) to use for signing based on the private key's ASN.1 info.
 215 When verifying signatures, it only handles the RSA, DSA, or ECDSA signature
 216 itself, not the related data to identify the signer and algorithm used in
 217 formats such as x.509, CMS, and S/MIME.
 218
 219 A source of random numbers is required for certain signing algorithms, in
 220 particular ECDSA and DSA.
 221
 222 The signing and verify options should only be used if a single file is
 223 being signed or verified.
 224
 225 Hex signatures cannot be verified using B<openssl>.  Instead, use "xxd -r"
 226 or similar program to transform the hex signature into a binary signature
 227 prior to verification.
 228
 229 =head1 HISTORY
 230
 231 The default digest was changed from MD5 to SHA256 in OpenSSL 1.1.0
 232 The FIPS-related options were removed in OpenSSL 1.1.0
 233
 234 =head1 COPYRIGHT
 235
 236 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 237
 238 Licensed under the OpenSSL license (the "License").  You may not use
 239 this file except in compliance with the License.  You can obtain a copy
 240 in the file LICENSE in the source distribution or at
 241 L<https://www.openssl.org/source/license.html>.
 242
 243 =cut