e2cc86e0e3d9adf9132216b18b09bebc037fba14
[openssl.git] / doc / man / pkcs8.pod
1 =pod
2
3 =head1 NAME
4
5 pkcs8 - PKCS#8 format private key conversion tool
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<pkcs8>
10 [B<-topk8>]
11 [B<-inform PEM|DER>]
12 [B<-outform PEM|DER>]
13 [B<-in filename>]
14 [B<-out filename>]
15 [B<-noiter>]
16 [B<-nocrypt>]
17 [B<-nooct>]
18 [B<-v2 alg>]
19 [B<-v1 alg>]
20
21 =head1 DESCRIPTION
22
23 The B<pkcs8> command processes private keys in PKCS#8 format. It can handle
24 both unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo
25 format with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
26
27 =head1 COMMAND OPTIONS
28
29 =over 4
30
31 =item B<-topk8>
32
33 Normally a PKCS#8 private key is expected on input and a traditional format
34 private key will be written. With the B<-topk8> option the situation is
35 reversed: it reads a traditional format private key and writes a PKCS#8
36 format key.
37
38 =item B<-inform DER|PEM>
39
40 This specifies the input format. If a PKCS#8 format key is expected on input
41 then either a B<DER> or B<PEM> encoded version of a PKCS#8 key will be
42 expected. Otherwise the B<DER> or B<PEM> format of the traditional format
43 private key is used.
44
45 =item B<-outform DER|PEM>
46
47 This specifies the output format, the options have the same meaning as the 
48 B<-inform> option.
49
50 =item B<-in filename>
51
52 This specifies the input filename to read a key from or standard input if this
53 option is not specified. If the key is encrypted a pass phrase will be
54 prompted for.
55
56 =item B<-out filename>
57
58 This specifies the output filename to write a key to or standard output by
59 default. If any encryption options are set then a pass phrase will be
60 prompted for. The output filename should B<not> be the same as the input
61 filename.
62
63 =item B<-nocrypt>
64
65 PKCS#8 keys generated or input are normally PKCS#8 EncryptedPrivateKeyInfo
66 structures using an appropriate password based encryption algorithm. With
67 this option an unencrypted PrivateKeyInfo structure is expected or output.
68 This option does not encrypt private keys at all and should only be used
69 when absolutely necessary. Certain software such as some versions of Java
70 code signing software used unencrypted private keys.
71
72 =item B<-nooct>
73
74 This option generates private keys in a broken format that some software
75 uses. Specifically the private key should be enclosed in a OCTET STRING
76 but some software just includes the structure itself without the
77 surrounding OCTET STRING.
78
79 =item B<-v2 alg>
80
81 This option enables the use of PKCS#5 v2.0 algorithms. Normally PKCS#8
82 private keys are encrypted with the password based encryption algorithm
83 called B<pbeWithMD5AndDES-CBC> this uses 56 bit DES encryption but it
84 was the strongest encryption algorithm supported in PKCS#5 v1.5. Using 
85 the B<-v2> option PKCS#5 v2.0 algorithms are used which can use any
86 encryption algorithm such as 168 bit triple DES or 128 bit RC2 however
87 not many implementations support PKCS#5 v2.0 yet. If you are just using
88 private keys with OpenSSL then this doesn't matter.
89
90 The B<alg> argument is the encryption algorithm to use, valid values include
91 B<des>, B<des3> and B<rc2>. It is recommended that B<des3> is used.
92
93 =item B<-v1 alg>
94
95 This option specifies a PKCS#5 v1.5 or PKCS#12 algorithm to use. A complete
96 list of possible algorithms is included below.
97
98 =back
99
100 =head1 NOTES
101
102 The encrypted form of a PEM encode PKCS#8 files uses the following
103 headers and footers:
104
105  -----BEGIN ENCRYPTED PRIVATE KEY-----
106  -----END ENCRYPTED PRIVATE KEY-----
107
108 The unencrypted form uses:
109
110  -----BEGIN PRIVATE KEY-----
111  -----END PRIVATE KEY-----
112
113 Private keys encrypted using PKCS#5 v2.0 algorithms and high iteration
114 counts are more secure that those encrypted using the traditional
115 SSLeay compatible formats. So if additional security is considered
116 important the keys should be converted.
117
118 The default encryption is only 56 bits because this is the encryption
119 that most current implementations of PKCS#8 will support.
120
121 Some software may use PKCS#12 password based encryption algorithms
122 with PKCS#8 format private keys: these are handled automatically
123 but there is no option to produce them.
124
125 It is possible to write out DER encoded encrypted private keys in
126 PKCS#8 format because the encryption details are included at an ASN1
127 level whereas the traditional format includes them at a PEM level.
128
129 =head1 PKCS#5 v1.5 and PKCS#12 algorithms.
130
131 Various algorithms can be used with the B<-v1> command line option,
132 including PKCS#5 v1.5 and PKCS#12. These are described in more detail
133 below.
134
135 =over 4
136
137 =item B<PBE-MD2-DES PBE-MD5-DES>
138
139 These algorithms were included in the original PKCS#5 v1.5 specification.
140 They only offer 56 bits of protection since they both use DES.
141
142 =item B<PBE-SHA1-RC2-64 PBE-MD2-RC2-64 PBE-MD5-RC2-64 PBE-SHA1-DES>
143
144 These algorithms are not mentioned in the original PKCS#5 v1.5 specification
145 but they use the same key derivation algorithm and are supported by some
146 software. They are mentioned in PKCS#5 v1.5. They use either 64 bit RC2 or
147 56 bit DES.
148
149 =item B<PBE-SHA1-RC4-128 PBE-SHA1-RC4-40 PBE-SHA1-3DES PBE-SHA1-2DES PBE-SHA1-RC2-128 PBE-SHA1-RC2-40>
150
151 These algorithms use the PKCS#12 password based encryption algorithm and
152 allow strong encryption algorithms like triple DES or 128 bit RC2 to be used.
153
154 =back
155
156 =head1 EXAMPLES
157
158 Convert a private from traditional to PKCS#5 v2.0 format using triple
159 DES:
160
161  openssl pkcs8 -in key.pem -topk8 -v2 des3 -out enckey.pem
162
163 Convert a private key to PKCS#8 using a PKCS#5 1.5 compatible algorithm
164 (DES):
165
166  openssl pkcs8 -in key.pem -topk8 -out enckey.pem
167
168 Convert a private key to PKCS#8 using a PKCS#12 compatible algorithm
169 (3DES):
170
171  openssl pkcs8 -in key.pem -topk8 -out enckey.pem -v1 PBE-SHA1-3DES
172
173 Read a DER unencrypted PKCS#8 format private key:
174
175  openssl pkcs8 -inform DER -nocrypt -in key.der -out key.pem
176
177 Convert a private key from any PKCS#8 format to traditional format:
178
179  openssl pkcs8 -in pk8.pem -out key.pem
180
181 =head1 STANDARDS
182
183 Test vectors from this implementation were posted to the pkcs-tng mailing
184 list using triple DES, DES and RC2 with high iteration counts, several
185 people confirmed that they could decrypt the private keys produced and
186 Therefore it can be assumed that the PKCS#5 v2.0 implementation is
187 reasonably accurate at least as far as these algorithms are concerned.
188
189 =head1 BUGS
190
191 There should be an option that prints out the encryption algorithm
192 in use and other details such as the iteration count.
193
194 PKCS#8 using triple DES and PKCS#5 v2.0 should be the default private
195 key format for OpenSSL: for compatability several of the utilities use
196 the old format at present.
197
198 =head1 SEE ALSO
199
200 dsa(1), rsa(1), genrsa(1), gendsa(1)
201
202 =cut