13519399fadaea732e3cf9e4d45ec43d32522500
[openssl.git] / doc / man1 / openssl-pkeyutl.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-pkeyutl - public key algorithm utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<pkeyutl>
10 [B<-help>]
11 [B<-in> I<file>]
12 [B<-rawin>]
13 [B<-digest> I<algorithm>]
14 [B<-out> I<file>]
15 [B<-sigfile> I<file>]
16 [B<-inkey> I<file>]
17 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]
18 [B<-passin> I<arg>]
19 [B<-peerkey> I<file>]
20 [B<-peerform> B<DER>|B<PEM>|B<ENGINE>]
21 [B<-pubin>]
22 [B<-certin>]
23 [B<-rev>]
24 [B<-sign>]
25 [B<-verify>]
26 [B<-verifyrecover>]
27 [B<-encrypt>]
28 [B<-decrypt>]
29 [B<-derive>]
30 [B<-kdf> I<algorithm>]
31 [B<-kdflen> I<length>]
32 [B<-pkeyopt> I<opt>:I<value>]
33 [B<-pkeyopt_passin> I<opt>[:I<passarg>]]
34 [B<-hexdump>]
35 [B<-asn1parse>]
36 [B<-rand> I<files>]
37 [B<-writerand> I<file>]
38 [B<-engine> I<id>]
39 [B<-engine_impl>]
40
41 =for openssl ifdef engine engine_impl
42
43 =head1 DESCRIPTION
44
45 This command can be used to perform low level public key
46 operations using any supported algorithm.
47
48 =head1 OPTIONS
49
50 =over 4
51
52 =item B<-help>
53
54 Print out a usage message.
55
56 =item B<-in> I<filename>
57
58 This specifies the input filename to read data from or standard input
59 if this option is not specified.
60
61 =item B<-rawin>
62
63 This indicates that the input data is raw data, which is not hashed by any
64 message digest algorithm. The user can specify a digest algorithm by using
65 the B<-digest> option. This option can only be used with B<-sign> and
66 B<-verify> and must be used with the Ed25519 and Ed448 algorithms.
67
68 =item B<-digest> I<algorithm>
69
70 This specifies the digest algorithm which is used to hash the input data before
71 signing or verifying it with the input key. This option could be omitted if the
72 signature algorithm does not require one (for instance, EdDSA). If this option
73 is omitted but the signature algorithm requires one, a default value will be
74 used. For signature algorithms like RSA, DSA and ECDSA, SHA-256 will be the
75 default digest algorithm. For SM2, it will be SM3. If this option is present,
76 then the B<-rawin> option must be also specified.
77
78 =item B<-out> I<filename>
79
80 Specifies the output filename to write to or standard output by
81 default.
82
83 =item B<-sigfile> I<file>
84
85 Signature file, required for B<-verify> operations only
86
87 =item B<-inkey> I<file>
88
89 The input key file, by default it should be a private key.
90
91 =item B<-keyform> B<DER>|B<PEM>|B<ENGINE>
92
93 The key format; the default is B<PEM>.
94 See L<openssl(1)/Format Options> for details.
95
96 =item B<-passin> I<arg>
97
98 The input key password source. For more information about the format of I<arg>
99 see L<openssl(1)/Pass Phrase Options>.
100
101 =item B<-peerkey> I<file>
102
103 The peer key file, used by key derivation (agreement) operations.
104
105 =item B<-peerform> B<DER>|B<PEM>|B<ENGINE>
106
107 The peer key format; the default is B<PEM>.
108 See L<openssl(1)/Format Options> for details.
109
110 =item B<-pubin>
111
112 The input file is a public key.
113
114 =item B<-certin>
115
116 The input is a certificate containing a public key.
117
118 =item B<-rev>
119
120 Reverse the order of the input buffer. This is useful for some libraries
121 (such as CryptoAPI) which represent the buffer in little endian format.
122
123 =item B<-sign>
124
125 Sign the input data (which must be a hash) and output the signed result. This
126 requires a private key.
127
128 =item B<-verify>
129
130 Verify the input data (which must be a hash) against the signature file and
131 indicate if the verification succeeded or failed.
132
133 =item B<-verifyrecover>
134
135 Verify the input data (which must be a hash) and output the recovered data.
136
137 =item B<-encrypt>
138
139 Encrypt the input data using a public key.
140
141 =item B<-decrypt>
142
143 Decrypt the input data using a private key.
144
145 =item B<-derive>
146
147 Derive a shared secret using the peer key.
148
149 =item B<-kdf> I<algorithm>
150
151 Use key derivation function I<algorithm>.  The supported algorithms are
152 at present B<TLS1-PRF> and B<HKDF>.
153 Note: additional parameters and the KDF output length will normally have to be
154 set for this to work.
155 See L<EVP_PKEY_CTX_set_hkdf_md(3)> and L<EVP_PKEY_CTX_set_tls1_prf_md(3)>
156 for the supported string parameters of each algorithm.
157
158 =item B<-kdflen> I<length>
159
160 Set the output length for KDF.
161
162 =item B<-pkeyopt> I<opt>:I<value>
163
164 Public key options specified as opt:value. See NOTES below for more details.
165
166 =item B<-pkeyopt_passin> I<opt>[:I<passarg>]
167
168 Allows reading a public key option I<opt> from stdin or a password source.
169 If only I<opt> is specified, the user will be prompted to enter a password on
170 stdin.  Alternatively, I<passarg> can be specified which can be any value
171 supported by L<openssl(1)/Pass phrase options>.
172
173 =item B<-hexdump>
174
175 hex dump the output data.
176
177 =item B<-asn1parse>
178
179 Parse the ASN.1 output data, this is useful when combined with the
180 B<-verifyrecover> option when an ASN1 structure is signed.
181
182 =item B<-rand> I<files>, B<-writerand> I<file>
183
184 See L<openssl(1)/Random State Options> for more information.
185
186 =item B<-engine> I<id>
187
188 Specifying an engine (by its unique I<id> string) will cause this command
189 to attempt to obtain a functional reference to the specified engine,
190 thus initialising it if needed. The engine will then be set as the default
191 for all available algorithms.
192
193 =item B<-engine_impl>
194
195 When used with the B<-engine> option, it specifies to also use
196 engine I<id> for crypto operations.
197
198 =back
199
200 =head1 NOTES
201
202 The operations and options supported vary according to the key algorithm
203 and its implementation. The OpenSSL operations and options are indicated below.
204
205 Unless otherwise mentioned all algorithms support the B<digest:>I<alg> option
206 which specifies the digest in use for sign, verify and verifyrecover operations.
207 The value I<alg> should represent a digest name as used in the
208 EVP_get_digestbyname() function for example B<sha1>. This value is not used to
209 hash the input data. It is used (by some algorithms) for sanity-checking the
210 lengths of data passed in and for creating the structures that make up the
211 signature (e.g. B<DigestInfo> in RSASSA PKCS#1 v1.5 signatures).
212
213 This command does not hash the input data (except where -rawin is used) but
214 rather it will use the data directly as input to the signature algorithm.
215 Depending on the key type, signature type, and mode of padding, the maximum
216 acceptable lengths of input data differ. The signed data can't be longer than
217 the key modulus with RSA. In case of ECDSA and DSA the data shouldn't be longer
218 than the field size, otherwise it will be silently truncated to the field size.
219 In any event the input size must not be larger than the largest supported digest
220 size.
221
222 In other words, if the value of digest is B<sha1> the input should be the 20
223 bytes long binary encoding of the SHA-1 hash function output.
224
225 =head1 RSA ALGORITHM
226
227 The RSA algorithm generally supports the encrypt, decrypt, sign,
228 verify and verifyrecover operations. However, some padding modes
229 support only a subset of these operations. The following additional
230 B<pkeyopt> values are supported:
231
232 =over 4
233
234 =item B<rsa_padding_mode:>I<mode>
235
236 This sets the RSA padding mode. Acceptable values for I<mode> are B<pkcs1> for
237 PKCS#1 padding, B<sslv23> for SSLv23 padding, B<none> for no padding, B<oaep>
238 for B<OAEP> mode, B<x931> for X9.31 mode and B<pss> for PSS.
239
240 In PKCS#1 padding if the message digest is not set then the supplied data is
241 signed or verified directly instead of using a B<DigestInfo> structure. If a
242 digest is set then the a B<DigestInfo> structure is used and its the length
243 must correspond to the digest type.
244
245 For B<oaep> mode only encryption and decryption is supported.
246
247 For B<x931> if the digest type is set it is used to format the block data
248 otherwise the first byte is used to specify the X9.31 digest ID. Sign,
249 verify and verifyrecover are can be performed in this mode.
250
251 For B<pss> mode only sign and verify are supported and the digest type must be
252 specified.
253
254 =item B<rsa_pss_saltlen:>I<len>
255
256 For B<pss> mode only this option specifies the salt length. Three special
257 values are supported: B<digest> sets the salt length to the digest length,
258 B<max> sets the salt length to the maximum permissible value. When verifying
259 B<auto> causes the salt length to be automatically determined based on the
260 B<PSS> block structure.
261
262 =item B<rsa_mgf1_md:>I<digest>
263
264 For PSS and OAEP padding sets the MGF1 digest. If the MGF1 digest is not
265 explicitly set in PSS mode then the signing digest is used.
266
267 =back
268
269 =head1 RSA-PSS ALGORITHM
270
271 The RSA-PSS algorithm is a restricted version of the RSA algorithm which only
272 supports the sign and verify operations with PSS padding. The following
273 additional B<-pkeyopt> values are supported:
274
275 =over 4
276
277 =item B<rsa_padding_mode:>I<mode>, B<rsa_pss_saltlen:>I<len>,
278 B<rsa_mgf1_md:>I<digest>
279
280 These have the same meaning as the B<RSA> algorithm with some additional
281 restrictions. The padding mode can only be set to B<pss> which is the
282 default value.
283
284 If the key has parameter restrictions than the digest, MGF1
285 digest and salt length are set to the values specified in the parameters.
286 The digest and MG cannot be changed and the salt length cannot be set to a
287 value less than the minimum restriction.
288
289 =back
290
291 =head1 DSA ALGORITHM
292
293 The DSA algorithm supports signing and verification operations only. Currently
294 there are no additional B<-pkeyopt> options other than B<digest>. The SHA1
295 digest is assumed by default.
296
297 =head1 DH ALGORITHM
298
299 The DH algorithm only supports the derivation operation and no additional
300 B<-pkeyopt> options.
301
302 =head1 EC ALGORITHM
303
304 The EC algorithm supports sign, verify and derive operations. The sign and
305 verify operations use ECDSA and derive uses ECDH. SHA1 is assumed by default for
306 the B<-pkeyopt> B<digest> option.
307
308 =head1 X25519 AND X448 ALGORITHMS
309
310 The X25519 and X448 algorithms support key derivation only. Currently there are
311 no additional options.
312
313 =head1 ED25519 AND ED448 ALGORITHMS
314
315 These algorithms only support signing and verifying. OpenSSL only implements the
316 "pure" variants of these algorithms so raw data can be passed directly to them
317 without hashing them first. The option B<-rawin> must be used with these
318 algorithms with no B<-digest> specified. Additionally OpenSSL only supports
319 "oneshot" operation with these algorithms. This means that the entire file to
320 be signed/verified must be read into memory before processing it. Signing or
321 Verifying very large files should be avoided. Additionally the size of the file
322 must be known for this to work. If the size of the file cannot be determined
323 (for example if the input is stdin) then the sign or verify operation will fail.
324
325 =head1 SM2
326
327 The SM2 algorithm supports sign, verify, encrypt and decrypt operations. For
328 the sign and verify operations, SM2 requires an ID string to be passed in. The
329 following B<-pkeyopt> value is supported:
330
331 =over 4
332
333 =item B<sm2_id:>I<string>
334
335 This sets the ID string used in SM2 sign or verify operations. While verifying
336 an SM2 signature, the ID string must be the same one used when signing the data.
337 Otherwise the verification will fail.
338
339 =item B<sm2_hex_id:>I<hex_string>
340
341 This sets the ID string used in SM2 sign or verify operations. While verifying
342 an SM2 signature, the ID string must be the same one used when signing the data.
343 Otherwise the verification will fail. The ID string provided with this option
344 should be a valid hexadecimal value.
345
346 =back
347
348 =head1 EXAMPLES
349
350 Sign some data using a private key:
351
352  openssl pkeyutl -sign -in file -inkey key.pem -out sig
353
354 Recover the signed data (e.g. if an RSA key is used):
355
356  openssl pkeyutl -verifyrecover -in sig -inkey key.pem
357
358 Verify the signature (e.g. a DSA key):
359
360  openssl pkeyutl -verify -in file -sigfile sig -inkey key.pem
361
362 Sign data using a message digest value (this is currently only valid for RSA):
363
364  openssl pkeyutl -sign -in file -inkey key.pem -out sig -pkeyopt digest:sha256
365
366 Derive a shared secret value:
367
368  openssl pkeyutl -derive -inkey key.pem -peerkey pubkey.pem -out secret
369
370 Hexdump 48 bytes of TLS1 PRF using digest B<SHA256> and shared secret and
371 seed consisting of the single byte 0xFF:
372
373  openssl pkeyutl -kdf TLS1-PRF -kdflen 48 -pkeyopt md:SHA256 \
374     -pkeyopt hexsecret:ff -pkeyopt hexseed:ff -hexdump
375
376 Derive a key using B<scrypt> where the password is read from command line:
377
378  openssl pkeyutl -kdf scrypt -kdflen 16 -pkeyopt_passin pass \
379     -pkeyopt hexsalt:aabbcc -pkeyopt N:16384 -pkeyopt r:8 -pkeyopt p:1
380
381 Derive using the same algorithm, but read key from environment variable MYPASS:
382
383  openssl pkeyutl -kdf scrypt -kdflen 16 -pkeyopt_passin pass:env:MYPASS \
384     -pkeyopt hexsalt:aabbcc -pkeyopt N:16384 -pkeyopt r:8 -pkeyopt p:1
385
386 Sign some data using an L<SM2(7)> private key and a specific ID:
387
388  openssl pkeyutl -sign -in file -inkey sm2.key -out sig -rawin -digest sm3 \
389     -pkeyopt sm2_id:someid
390
391 Verify some data using an L<SM2(7)> certificate and a specific ID:
392
393  openssl pkeyutl -verify -certin -in file -inkey sm2.cert -sigfile sig \
394     -rawin -digest sm3 -pkeyopt sm2_id:someid
395
396 =head1 SEE ALSO
397
398 L<openssl(1)>,
399 L<openssl-genpkey(1)>,
400 L<openssl-pkey(1)>,
401 L<openssl-rsautl(1)>
402 L<openssl-dgst(1)>,
403 L<openssl-rsa(1)>,
404 L<openssl-genrsa(1)>,
405 L<openssl-kdf(1)>
406 L<EVP_PKEY_CTX_set_hkdf_md(3)>,
407 L<EVP_PKEY_CTX_set_tls1_prf_md(3)>,
408
409
410 =head1 COPYRIGHT
411
412 Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
413
414 Licensed under the Apache License 2.0 (the "License").  You may not use
415 this file except in compliance with the License.  You can obtain a copy
416 in the file LICENSE in the source distribution or at
417 L<https://www.openssl.org/source/license.html>.
418
419 =cut