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