Use a function to generate do-not-edit comment
[openssl.git] / doc / man1 / openssl-pkeyutl.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-pkeyutl - public key algorithm utility
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<pkeyutl>
11 [B<-help>]
12 [B<-in> I<file>]
13 [B<-rawin>]
14 [B<-digest> I<algorithm>]
15 [B<-out> I<file>]
16 [B<-sigfile> I<file>]
17 [B<-inkey> I<file>]
18 [B<-keyform> B<DER>|B<PEM>|B<ENGINE>]
19 [B<-passin> I<arg>]
20 [B<-peerkey> I<file>]
21 [B<-peerform> B<DER>|B<PEM>|B<ENGINE>]
22 [B<-pubin>]
23 [B<-certin>]
24 [B<-rev>]
25 [B<-sign>]
26 [B<-verify>]
27 [B<-verifyrecover>]
28 [B<-encrypt>]
29 [B<-decrypt>]
30 [B<-derive>]
31 [B<-kdf> I<algorithm>]
32 [B<-kdflen> I<length>]
33 [B<-pkeyopt> I<opt>:I<value>]
34 [B<-pkeyopt_passin> I<opt>[:I<passarg>]]
35 [B<-hexdump>]
36 [B<-asn1parse>]
37 [B<-engine> I<id>]
38 [B<-engine_impl>]
39 {- $OpenSSL::safe::opt_r_synopsis -}
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<-engine> I<id>
183
184 Specifying an engine (by its unique I<id> string) will cause this command
185 to attempt to obtain a functional reference to the specified engine,
186 thus initialising it if needed. The engine will then be set as the default
187 for all available algorithms.
188
189 =item B<-engine_impl>
190
191 When used with the B<-engine> option, it specifies to also use
192 engine I<id> for crypto operations.
193
194 {- $OpenSSL::safe::opt_r_item -}
195
196 =back
197
198 =head1 NOTES
199
200 The operations and options supported vary according to the key algorithm
201 and its implementation. The OpenSSL operations and options are indicated below.
202
203 Unless otherwise mentioned all algorithms support the B<digest:>I<alg> option
204 which specifies the digest in use for sign, verify and verifyrecover operations.
205 The value I<alg> should represent a digest name as used in the
206 EVP_get_digestbyname() function for example B<sha1>. This value is not used to
207 hash the input data. It is used (by some algorithms) for sanity-checking the
208 lengths of data passed in and for creating the structures that make up the
209 signature (e.g. B<DigestInfo> in RSASSA PKCS#1 v1.5 signatures).
210
211 This command does not hash the input data (except where -rawin is used) but
212 rather it will use the data directly as input to the signature algorithm.
213 Depending on the key type, signature type, and mode of padding, the maximum
214 acceptable lengths of input data differ. The signed data can't be longer than
215 the key modulus with RSA. In case of ECDSA and DSA the data shouldn't be longer
216 than the field size, otherwise it will be silently truncated to the field size.
217 In any event the input size must not be larger than the largest supported digest
218 size.
219
220 In other words, if the value of digest is B<sha1> the input should be the 20
221 bytes long binary encoding of the SHA-1 hash function output.
222
223 =head1 RSA ALGORITHM
224
225 The RSA algorithm generally supports the encrypt, decrypt, sign,
226 verify and verifyrecover operations. However, some padding modes
227 support only a subset of these operations. The following additional
228 B<pkeyopt> values are supported:
229
230 =over 4
231
232 =item B<rsa_padding_mode:>I<mode>
233
234 This sets the RSA padding mode. Acceptable values for I<mode> are B<pkcs1> for
235 PKCS#1 padding, B<sslv23> for SSLv23 padding, B<none> for no padding, B<oaep>
236 for B<OAEP> mode, B<x931> for X9.31 mode and B<pss> for PSS.
237
238 In PKCS#1 padding if the message digest is not set then the supplied data is
239 signed or verified directly instead of using a B<DigestInfo> structure. If a
240 digest is set then the a B<DigestInfo> structure is used and its the length
241 must correspond to the digest type.
242
243 For B<oaep> mode only encryption and decryption is supported.
244
245 For B<x931> if the digest type is set it is used to format the block data
246 otherwise the first byte is used to specify the X9.31 digest ID. Sign,
247 verify and verifyrecover are can be performed in this mode.
248
249 For B<pss> mode only sign and verify are supported and the digest type must be
250 specified.
251
252 =item B<rsa_pss_saltlen:>I<len>
253
254 For B<pss> mode only this option specifies the salt length. Three special
255 values are supported: B<digest> sets the salt length to the digest length,
256 B<max> sets the salt length to the maximum permissible value. When verifying
257 B<auto> causes the salt length to be automatically determined based on the
258 B<PSS> block structure.
259
260 =item B<rsa_mgf1_md:>I<digest>
261
262 For PSS and OAEP padding sets the MGF1 digest. If the MGF1 digest is not
263 explicitly set in PSS mode then the signing digest is used.
264
265 =back
266
267 =head1 RSA-PSS ALGORITHM
268
269 The RSA-PSS algorithm is a restricted version of the RSA algorithm which only
270 supports the sign and verify operations with PSS padding. The following
271 additional B<-pkeyopt> values are supported:
272
273 =over 4
274
275 =item B<rsa_padding_mode:>I<mode>, B<rsa_pss_saltlen:>I<len>,
276 B<rsa_mgf1_md:>I<digest>
277
278 These have the same meaning as the B<RSA> algorithm with some additional
279 restrictions. The padding mode can only be set to B<pss> which is the
280 default value.
281
282 If the key has parameter restrictions than the digest, MGF1
283 digest and salt length are set to the values specified in the parameters.
284 The digest and MG cannot be changed and the salt length cannot be set to a
285 value less than the minimum restriction.
286
287 =back
288
289 =head1 DSA ALGORITHM
290
291 The DSA algorithm supports signing and verification operations only. Currently
292 there are no additional B<-pkeyopt> options other than B<digest>. The SHA1
293 digest is assumed by default.
294
295 =head1 DH ALGORITHM
296
297 The DH algorithm only supports the derivation operation and no additional
298 B<-pkeyopt> options.
299
300 =head1 EC ALGORITHM
301
302 The EC algorithm supports sign, verify and derive operations. The sign and
303 verify operations use ECDSA and derive uses ECDH. SHA1 is assumed by default for
304 the B<-pkeyopt> B<digest> option.
305
306 =head1 X25519 AND X448 ALGORITHMS
307
308 The X25519 and X448 algorithms support key derivation only. Currently there are
309 no additional options.
310
311 =head1 ED25519 AND ED448 ALGORITHMS
312
313 These algorithms only support signing and verifying. OpenSSL only implements the
314 "pure" variants of these algorithms so raw data can be passed directly to them
315 without hashing them first. The option B<-rawin> must be used with these
316 algorithms with no B<-digest> specified. Additionally OpenSSL only supports
317 "oneshot" operation with these algorithms. This means that the entire file to
318 be signed/verified must be read into memory before processing it. Signing or
319 Verifying very large files should be avoided. Additionally the size of the file
320 must be known for this to work. If the size of the file cannot be determined
321 (for example if the input is stdin) then the sign or verify operation will fail.
322
323 =head1 SM2
324
325 The SM2 algorithm supports sign, verify, encrypt and decrypt operations. For
326 the sign and verify operations, SM2 requires an ID string to be passed in. The
327 following B<-pkeyopt> value is supported:
328
329 =over 4
330
331 =item B<sm2_id:>I<string>
332
333 This sets the ID string used in SM2 sign or verify operations. While verifying
334 an SM2 signature, the ID string must be the same one used when signing the data.
335 Otherwise the verification will fail.
336
337 =item B<sm2_hex_id:>I<hex_string>
338
339 This sets the ID string used in SM2 sign or verify operations. While verifying
340 an SM2 signature, the ID string must be the same one used when signing the data.
341 Otherwise the verification will fail. The ID string provided with this option
342 should be a valid hexadecimal value.
343
344 =back
345
346 =head1 EXAMPLES
347
348 Sign some data using a private key:
349
350  openssl pkeyutl -sign -in file -inkey key.pem -out sig
351
352 Recover the signed data (e.g. if an RSA key is used):
353
354  openssl pkeyutl -verifyrecover -in sig -inkey key.pem
355
356 Verify the signature (e.g. a DSA key):
357
358  openssl pkeyutl -verify -in file -sigfile sig -inkey key.pem
359
360 Sign data using a message digest value (this is currently only valid for RSA):
361
362  openssl pkeyutl -sign -in file -inkey key.pem -out sig -pkeyopt digest:sha256
363
364 Derive a shared secret value:
365
366  openssl pkeyutl -derive -inkey key.pem -peerkey pubkey.pem -out secret
367
368 Hexdump 48 bytes of TLS1 PRF using digest B<SHA256> and shared secret and
369 seed consisting of the single byte 0xFF:
370
371  openssl pkeyutl -kdf TLS1-PRF -kdflen 48 -pkeyopt md:SHA256 \
372     -pkeyopt hexsecret:ff -pkeyopt hexseed:ff -hexdump
373
374 Derive a key using B<scrypt> where the password is read from command line:
375
376  openssl pkeyutl -kdf scrypt -kdflen 16 -pkeyopt_passin pass \
377     -pkeyopt hexsalt:aabbcc -pkeyopt N:16384 -pkeyopt r:8 -pkeyopt p:1
378
379 Derive using the same algorithm, but read key from environment variable MYPASS:
380
381  openssl pkeyutl -kdf scrypt -kdflen 16 -pkeyopt_passin pass:env:MYPASS \
382     -pkeyopt hexsalt:aabbcc -pkeyopt N:16384 -pkeyopt r:8 -pkeyopt p:1
383
384 Sign some data using an L<SM2(7)> private key and a specific ID:
385
386  openssl pkeyutl -sign -in file -inkey sm2.key -out sig -rawin -digest sm3 \
387     -pkeyopt sm2_id:someid
388
389 Verify some data using an L<SM2(7)> certificate and a specific ID:
390
391  openssl pkeyutl -verify -certin -in file -inkey sm2.cert -sigfile sig \
392     -rawin -digest sm3 -pkeyopt sm2_id:someid
393
394 =head1 SEE ALSO
395
396 L<openssl(1)>,
397 L<openssl-genpkey(1)>,
398 L<openssl-pkey(1)>,
399 L<openssl-rsautl(1)>
400 L<openssl-dgst(1)>,
401 L<openssl-rsa(1)>,
402 L<openssl-genrsa(1)>,
403 L<openssl-kdf(1)>
404 L<EVP_PKEY_CTX_set_hkdf_md(3)>,
405 L<EVP_PKEY_CTX_set_tls1_prf_md(3)>,
406
407
408 =head1 COPYRIGHT
409
410 Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
411
412 Licensed under the Apache License 2.0 (the "License").  You may not use
413 this file except in compliance with the License.  You can obtain a copy
414 in the file LICENSE in the source distribution or at
415 L<https://www.openssl.org/source/license.html>.
416
417 =cut