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