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