Refactor -engine documentation
[openssl.git] / doc / man1 / openssl-pkcs8.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-pkcs8 - PKCS#8 format private key conversion tool
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<pkcs8>
11 [B<-help>]
12 [B<-topk8>]
13 [B<-inform> B<DER>|B<PEM>]
14 [B<-outform> B<DER>|B<PEM>]
15 [B<-in> I<filename>]
16 [B<-passin> I<arg>]
17 [B<-out> I<filename>]
18 [B<-passout> I<arg>]
19 [B<-iter> I<count>]
20 [B<-noiter>]
21 [B<-nocrypt>]
22 [B<-traditional>]
23 [B<-v2> I<alg>]
24 [B<-v2prf> I<alg>]
25 [B<-v1> I<alg>]
26 [B<-scrypt>]
27 [B<-scrypt_N> I<N>]
28 [B<-scrypt_r> I<r>]
29 [B<-scrypt_p> I<p>]
30 {- $OpenSSL::safe::opt_r_synopsis -}
31 {- $OpenSSL::safe::opt_engine_synopsis -}
32
33 =for openssl ifdef engine scrypt scrypt_N scrypt_r scrypt_p
34
35 =head1 DESCRIPTION
36
37 This command processes private keys in PKCS#8 format. It can handle
38 both unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo
39 format with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
40
41 =head1 OPTIONS
42
43 =over 4
44
45 =item B<-help>
46
47 Print out a usage message.
48
49 =item B<-topk8>
50
51 Normally a PKCS#8 private key is expected on input and a private key will be
52 written to the output file. With the B<-topk8> option the situation is
53 reversed: it reads a private key and writes a PKCS#8 format key.
54
55 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
56
57 The input and formats; the default is B<PEM>.
58 See L<openssl(1)/Format Options> for details.
59
60 If a key is being converted from PKCS#8 form (i.e. the B<-topk8> option is
61 not used) then the input file must be in PKCS#8 format. An encrypted
62 key is expected unless B<-nocrypt> is included.
63
64 If B<-topk8> is not used and B<PEM> mode is set the output file will be an
65 unencrypted private key in PKCS#8 format. If the B<-traditional> option is
66 used then a traditional format private key is written instead.
67
68 If B<-topk8> is not used and B<DER> mode is set the output file will be an
69 unencrypted private key in traditional DER format.
70
71 If B<-topk8> is used then any supported private key can be used for the input
72 file in a format specified by B<-inform>. The output file will be encrypted
73 PKCS#8 format using the specified encryption parameters unless B<-nocrypt>
74 is included.
75
76 =item B<-traditional>
77
78 When this option is present and B<-topk8> is not a traditional format private
79 key is written.
80
81 =item B<-in> I<filename>
82
83 This specifies the input filename to read a key from or standard input if this
84 option is not specified. If the key is encrypted a pass phrase will be
85 prompted for.
86
87 =item B<-passin> I<arg>, B<-passout> I<arg>
88
89 The password source for the input and output file.
90 For more information about the format of B<arg>
91 see L<openssl(1)/Pass Phrase Options>.
92
93 =item B<-out> I<filename>
94
95 This specifies the output filename to write a key to or standard output by
96 default. If any encryption options are set then a pass phrase will be
97 prompted for. The output filename should B<not> be the same as the input
98 filename.
99
100 =item B<-iter> I<count>
101
102 When creating new PKCS#8 containers, use a given number of iterations on
103 the password in deriving the encryption key for the PKCS#8 output.
104 High values increase the time required to brute-force a PKCS#8 container.
105
106 =item B<-nocrypt>
107
108 PKCS#8 keys generated or input are normally PKCS#8 EncryptedPrivateKeyInfo
109 structures using an appropriate password based encryption algorithm. With
110 this option an unencrypted PrivateKeyInfo structure is expected or output.
111 This option does not encrypt private keys at all and should only be used
112 when absolutely necessary. Certain software such as some versions of Java
113 code signing software used unencrypted private keys.
114
115 =item B<-v2> I<alg>
116
117 This option sets the PKCS#5 v2.0 algorithm.
118
119 The I<alg> argument is the encryption algorithm to use, valid values include
120 B<aes128>, B<aes256> and B<des3>. If this option isn't specified then B<aes256>
121 is used.
122
123 =item B<-v2prf> I<alg>
124
125 This option sets the PRF algorithm to use with PKCS#5 v2.0. A typical value
126 value would be B<hmacWithSHA256>. If this option isn't set then the default
127 for the cipher is used or B<hmacWithSHA256> if there is no default.
128
129 Some implementations may not support custom PRF algorithms and may require
130 the B<hmacWithSHA1> option to work.
131
132 =item B<-v1> I<alg>
133
134 This option indicates a PKCS#5 v1.5 or PKCS#12 algorithm should be used.  Some
135 older implementations may not support PKCS#5 v2.0 and may require this option.
136 If not specified PKCS#5 v2.0 form is used.
137
138 =item B<-scrypt>
139
140 Uses the B<scrypt> algorithm for private key encryption using default
141 parameters: currently N=16384, r=8 and p=1 and AES in CBC mode with a 256 bit
142 key. These parameters can be modified using the B<-scrypt_N>, B<-scrypt_r>,
143 B<-scrypt_p> and B<-v2> options.
144
145 =item B<-scrypt_N> I<N>, B<-scrypt_r> I<r>, B<-scrypt_p> I<p>
146
147 Sets the scrypt I<N>, I<r> or I<p> parameters.
148
149 {- $OpenSSL::safe::opt_r_item -}
150
151 {- $OpenSSL::safe::opt_engine_item -}
152
153 =back
154
155 =head1 NOTES
156
157 By default, when converting a key to PKCS#8 format, PKCS#5 v2.0 using 256 bit
158 AES with HMAC and SHA256 is used.
159
160 Some older implementations do not support PKCS#5 v2.0 format and require
161 the older PKCS#5 v1.5 form instead, possibly also requiring insecure weak
162 encryption algorithms such as 56 bit DES.
163
164 Private keys encrypted using PKCS#5 v2.0 algorithms and high iteration
165 counts are more secure that those encrypted using the traditional
166 SSLeay compatible formats. So if additional security is considered
167 important the keys should be converted.
168
169 It is possible to write out DER encoded encrypted private keys in
170 PKCS#8 format because the encryption details are included at an ASN1
171 level whereas the traditional format includes them at a PEM level.
172
173 =head1 PKCS#5 V1.5 AND PKCS#12 ALGORITHMS
174
175 Various algorithms can be used with the B<-v1> command line option,
176 including PKCS#5 v1.5 and PKCS#12. These are described in more detail
177 below.
178
179 =over 4
180
181 =item B<PBE-MD2-DES PBE-MD5-DES>
182
183 These algorithms were included in the original PKCS#5 v1.5 specification.
184 They only offer 56 bits of protection since they both use DES.
185
186 =item B<PBE-SHA1-RC2-64>, B<PBE-MD2-RC2-64>, B<PBE-MD5-RC2-64>, B<PBE-SHA1-DES>
187
188 These algorithms are not mentioned in the original PKCS#5 v1.5 specification
189 but they use the same key derivation algorithm and are supported by some
190 software. They are mentioned in PKCS#5 v2.0. They use either 64 bit RC2 or
191 56 bit DES.
192
193 =item B<PBE-SHA1-RC4-128>, B<PBE-SHA1-RC4-40>, B<PBE-SHA1-3DES>, B<PBE-SHA1-2DES>, B<PBE-SHA1-RC2-128>, B<PBE-SHA1-RC2-40>
194
195 These algorithms use the PKCS#12 password based encryption algorithm and
196 allow strong encryption algorithms like triple DES or 128 bit RC2 to be used.
197
198 =back
199
200 =head1 EXAMPLES
201
202 Convert a private key to PKCS#8 format using default parameters (AES with
203 256 bit key and B<hmacWithSHA256>):
204
205  openssl pkcs8 -in key.pem -topk8 -out enckey.pem
206
207 Convert a private key to PKCS#8 unencrypted format:
208
209  openssl pkcs8 -in key.pem -topk8 -nocrypt -out enckey.pem
210
211 Convert a private key to PKCS#5 v2.0 format using triple DES:
212
213  openssl pkcs8 -in key.pem -topk8 -v2 des3 -out enckey.pem
214
215 Convert a private key to PKCS#5 v2.0 format using AES with 256 bits in CBC
216 mode and B<hmacWithSHA512> PRF:
217
218  openssl pkcs8 -in key.pem -topk8 -v2 aes-256-cbc -v2prf hmacWithSHA512 -out enckey.pem
219
220 Convert a private key to PKCS#8 using a PKCS#5 1.5 compatible algorithm
221 (DES):
222
223  openssl pkcs8 -in key.pem -topk8 -v1 PBE-MD5-DES -out enckey.pem
224
225 Convert a private key to PKCS#8 using a PKCS#12 compatible algorithm
226 (3DES):
227
228  openssl pkcs8 -in key.pem -topk8 -out enckey.pem -v1 PBE-SHA1-3DES
229
230 Read a DER unencrypted PKCS#8 format private key:
231
232  openssl pkcs8 -inform DER -nocrypt -in key.der -out key.pem
233
234 Convert a private key from any PKCS#8 encrypted format to traditional format:
235
236  openssl pkcs8 -in pk8.pem -traditional -out key.pem
237
238 Convert a private key to PKCS#8 format, encrypting with AES-256 and with
239 one million iterations of the password:
240
241  openssl pkcs8 -in key.pem -topk8 -v2 aes-256-cbc -iter 1000000 -out pk8.pem
242
243 =head1 STANDARDS
244
245 Test vectors from this PKCS#5 v2.0 implementation were posted to the
246 pkcs-tng mailing list using triple DES, DES and RC2 with high iteration
247 counts, several people confirmed that they could decrypt the private
248 keys produced and Therefore it can be assumed that the PKCS#5 v2.0
249 implementation is reasonably accurate at least as far as these
250 algorithms are concerned.
251
252 The format of PKCS#8 DSA (and other) private keys is not well documented:
253 it is hidden away in PKCS#11 v2.01, section 11.9. OpenSSL's default DSA
254 PKCS#8 private key format complies with this standard.
255
256 =head1 BUGS
257
258 There should be an option that prints out the encryption algorithm
259 in use and other details such as the iteration count.
260
261 =head1 SEE ALSO
262
263 L<openssl(1)>,
264 L<openssl-dsa(1)>,
265 L<openssl-rsa(1)>,
266 L<openssl-genrsa(1)>,
267 L<openssl-gendsa(1)>
268
269 =head1 HISTORY
270
271 The B<-iter> option was added in OpenSSL 1.1.0.
272
273 =head1 COPYRIGHT
274
275 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
276
277 Licensed under the Apache License 2.0 (the "License").  You may not use
278 this file except in compliance with the License.  You can obtain a copy
279 in the file LICENSE in the source distribution or at
280 L<https://www.openssl.org/source/license.html>.
281
282 =cut