doc/apps/pkeyutl.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 pkeyutl - public key algorithm utility
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<pkeyutl>
  10 [B<-help>]
  11 [B<-in file>]
  12 [B<-out file>]
  13 [B<-sigfile file>]
  14 [B<-inkey file>]
  15 [B<-keyform PEM|DER|ENGINE>]
  16 [B<-passin arg>]
  17 [B<-peerkey file>]
  18 [B<-peerform PEM|DER|ENGINE>]
  19 [B<-pubin>]
  20 [B<-certin>]
  21 [B<-rev>]
  22 [B<-sign>]
  23 [B<-verify>]
  24 [B<-verifyrecover>]
  25 [B<-encrypt>]
  26 [B<-decrypt>]
  27 [B<-derive>]
  28 [B<-kdf algorithm>]
  29 [B<-kdflen length>]
  30 [B<-pkeyopt opt:value>]
  31 [B<-hexdump>]
  32 [B<-asn1parse>]
  33 [B<-engine id>]
  34 [B<-engine_impl>]
  35
  36 =head1 DESCRIPTION
  37
  38 The B<pkeyutl> command can be used to perform public key operations using
  39 any supported algorithm.
  40
  41 =head1 COMMAND OPTIONS
  42
  43 =over 4
  44
  45 =item B<-help>
  46
  47 Print out a usage message.
  48
  49 =item B<-in filename>
  50
  51 This specifies the input filename to read data from or standard input
  52 if this option is not specified.
  53
  54 =item B<-out filename>
  55
  56 specifies the output filename to write to or standard output by
  57 default.
  58
  59 =item B<-sigfile file>
  60
  61 Signature file, required for B<verify> operations only
  62
  63 =item B<-inkey file>
  64
  65 the input key file, by default it should be a private key.
  66
  67 =item B<-keyform PEM|DER|ENGINE>
  68
  69 the key format PEM, DER or ENGINE. Default is PEM.
  70
  71 =item B<-passin arg>
  72
  73 the input key password source. For more information about the format of B<arg>
  74 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  75
  76
  77 =item B<-peerkey file>
  78
  79 the peer key file, used by key derivation (agreement) operations.
  80
  81 =item B<-peerform PEM|DER|ENGINE>
  82
  83 the peer key format PEM, DER or ENGINE. Default is PEM.
  84
  85 =item B<-pubin>
  86
  87 the input file is a public key.
  88
  89 =item B<-certin>
  90
  91 the input is a certificate containing a public key.
  92
  93 =item B<-rev>
  94
  95 reverse the order of the input buffer. This is useful for some libraries
  96 (such as CryptoAPI) which represent the buffer in little endian format.
  97
  98 =item B<-sign>
  99
 100 sign the input data and output the signed result. This requires
 101 a private key.
 102
 103 =item B<-verify>
 104
 105 verify the input data against the signature file and indicate if the
 106 verification succeeded or failed.
 107
 108 =item B<-verifyrecover>
 109
 110 verify the input data and output the recovered data.
 111
 112 =item B<-encrypt>
 113
 114 encrypt the input data using a public key.
 115
 116 =item B<-decrypt>
 117
 118 decrypt the input data using a private key.
 119
 120 =item B<-derive>
 121
 122 derive a shared secret using the peer key.
 123
 124 =item B<-kdf algorithm>
 125
 126 Use key derivation function B<algorithm>.  The supported algorithms are
 127 at present B<TLS1-PRF> and B<HKDF>.
 128 Note: additional paramers and the KDF output length will normally have to be
 129 set for this to work.  See L<EVP_PKEY_HKDF(3)> and L<EVP_PKEY_TLS1_PRF(3)>
 130 for the supported string parameters of each algorithm.
 131
 132 =item B<-kdflen length>
 133
 134 Set the output length for KDF.
 135
 136 =item B<-pkeyopt opt:value>
 137
 138 Public key options specified as opt:value. See NOTES below for more details.
 139
 140 =item B<-hexdump>
 141
 142 hex dump the output data.
 143
 144 =item B<-asn1parse>
 145
 146 asn1parse the output data, this is useful when combined with the
 147 B<-verifyrecover> option when an ASN1 structure is signed.
 148
 149 =item B<-engine id>
 150
 151 specifying an engine (by its unique B<id> string) will cause B<pkeyutl>
 152 to attempt to obtain a functional reference to the specified engine,
 153 thus initialising it if needed. The engine will then be set as the default
 154 for all available algorithms.
 155
 156 =item B<-engine_impl>
 157
 158 When used with the B<-engine> option, it specifies to also use
 159 engine B<id> for crypto operations.
 160
 161 =back
 162
 163 =head1 NOTES
 164
 165 The operations and options supported vary according to the key algorithm
 166 and its implementation. The OpenSSL operations and options are indicated below.
 167
 168 Unless otherwise mentioned all algorithms support the B<digest:alg> option
 169 which specifies the digest in use for sign, verify and verifyrecover operations.
 170 The value B<alg> should represent a digest name as used in the
 171 EVP_get_digestbyname() function for example B<sha1>.
 172 This value is used only for sanity-checking the lengths of data passed in to
 173 the B<pkeyutl> and for creating the structures that make up the signature
 174 (e.g. B<DigestInfo> in RSASSA PKCS#1 v1.5 signatures).
 175 In case of RSA, ECDSA and DSA signatures, this utility
 176 will not perform hashing on input data but rather use the data directly as
 177 input of signature algorithm. Depending on key type, signature type and mode
 178 of padding, the maximum acceptable lengths of input data differ. In general,
 179 with RSA the signed data can't be longer than the key modulus, in case of ECDSA
 180 and DSA the data shouldn't be longer than field size, otherwise it will be
 181 silently truncated to field size.
 182
 183 In other words, if the value of digest is B<sha1> the input should be 20 bytes
 184 long binary encoding of SHA-1 hash function output.
 185
 186 =head1 RSA ALGORITHM
 187
 188 The RSA algorithm generally supports the encrypt, decrypt, sign,
 189 verify and verifyrecover operations. However, some padding modes
 190 support only a subset of these operations. The following additional
 191 B<pkeyopt> values are supported:
 192
 193 =over 4
 194
 195 =item B<rsa_padding_mode:mode>
 196
 197 This sets the RSA padding mode. Acceptable values for B<mode> are B<pkcs1> for
 198 PKCS#1 padding, B<sslv23> for SSLv23 padding, B<none> for no padding, B<oaep>
 199 for B<OAEP> mode, B<x931> for X9.31 mode and B<pss> for PSS.
 200
 201 In PKCS#1 padding if the message digest is not set then the supplied data is
 202 signed or verified directly instead of using a B<DigestInfo> structure. If a
 203 digest is set then the a B<DigestInfo> structure is used and its the length
 204 must correspond to the digest type.
 205
 206 For B<oaep> mode only encryption and decryption is supported.
 207
 208 For B<x931> if the digest type is set it is used to format the block data
 209 otherwise the first byte is used to specify the X9.31 digest ID. Sign,
 210 verify and verifyrecover are can be performed in this mode.
 211
 212 For B<pss> mode only sign and verify are supported and the digest type must be
 213 specified.
 214
 215 =item B<rsa_pss_saltlen:len>
 216
 217 For B<pss> mode only this option specifies the salt length. Two special values
 218 are supported: -1 sets the salt length to the digest length. When signing -2
 219 sets the salt length to the maximum permissible value. When verifying -2 causes
 220 the salt length to be automatically determined based on the B<PSS> block
 221 structure.
 222
 223 =back
 224
 225 =head1 DSA ALGORITHM
 226
 227 The DSA algorithm supports signing and verification operations only. Currently
 228 there are no additional options other than B<digest>. Only the SHA1
 229 digest can be used and this digest is assumed by default.
 230
 231 =head1 DH ALGORITHM
 232
 233 The DH algorithm only supports the derivation operation and no additional
 234 options.
 235
 236 =head1 EC ALGORITHM
 237
 238 The EC algorithm supports sign, verify and derive operations. The sign and
 239 verify operations use ECDSA and derive uses ECDH. Currently there are no
 240 additional options other than B<digest>. Only the SHA1 digest can be used and
 241 this digest is assumed by default.
 242
 243 =head1 EXAMPLES
 244
 245 Sign some data using a private key:
 246
 247  openssl pkeyutl -sign -in file -inkey key.pem -out sig
 248
 249 Recover the signed data (e.g. if an RSA key is used):
 250
 251  openssl pkeyutl -verifyrecover -in sig -inkey key.pem
 252
 253 Verify the signature (e.g. a DSA key):
 254
 255  openssl pkeyutl -verify -in file -sigfile sig -inkey key.pem
 256
 257 Sign data using a message digest value (this is currently only valid for RSA):
 258
 259  openssl pkeyutl -sign -in file -inkey key.pem -out sig -pkeyopt digest:sha256
 260
 261 Derive a shared secret value:
 262
 263  openssl pkeyutl -derive -inkey key.pem -peerkey pubkey.pem -out secret
 264
 265 Hexdump 48 bytes of TLS1 PRF using digest B<SHA256> and shared secret and
 266 seed consisting of the single byte 0xFF:
 267
 268  openssl pkeyutl -kdf TLS1-PRF -kdflen 48 -pkeyopt md:SHA256 \
 269     -pkeyopt hexsecret:ff -pkeyopt hexseed:ff -hexdump
 270
 271 =head1 SEE ALSO
 272
 273 L<genpkey(1)>, L<pkey(1)>, L<rsautl(1)>
 274 L<dgst(1)>, L<rsa(1)>, L<genrsa(1)>,
 275 L<EVP_PKEY_HKDF(3)>, L<EVP_PKEY_TLS1_PRF(3)>
 276
 277 =cut
 278
 279 =head1 COPYRIGHT
 280
 281 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
 282
 283 Licensed under the OpenSSL license (the "License").  You may not use
 284 this file except in compliance with the License.  You can obtain a copy
 285 in the file LICENSE in the source distribution or at
 286 L<https://www.openssl.org/source/license.html>.
 287
 288 =cut