Correct minor spelling error.
[openssl.git] / doc / apps / pkcs12.pod
1
2 =pod
3
4 =head1 NAME
5
6 pkcs12 - PKCS#12 file utility
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<pkcs12>
11 [B<-export>]
12 [B<-chain>]
13 [B<-inkey filename>]
14 [B<-certfile filename>]
15 [B<-name name>]
16 [B<-caname name>]
17 [B<-in filename>]
18 [B<-out filename>]
19 [B<-noout>]
20 [B<-nomacver>]
21 [B<-nocerts>]
22 [B<-clcerts>]
23 [B<-cacerts>]
24 [B<-nokeys>]
25 [B<-info>]
26 [B<-des>]
27 [B<-des3>]
28 [B<-idea>]
29 [B<-nodes>]
30 [B<-noiter>]
31 [B<-maciter>]
32 [B<-twopass>]
33 [B<-descert>]
34 [B<-certpbe>]
35 [B<-keypbe>]
36 [B<-keyex>]
37 [B<-keysig>]
38 [B<-password arg>]
39 [B<-passin arg>]
40 [B<-passout arg>]
41 [B<-rand file(s)>]
42
43 =head1 DESCRIPTION
44
45 The B<pkcs12> command allows PKCS#12 files (sometimes referred to as
46 PFX files) to be created and parsed. PKCS#12 files are used by several
47 programs including Netscape, MSIE and MS Outlook.
48
49 =head1 COMMAND OPTIONS
50
51 There are a lot of options the meaning of some depends of whether a PKCS#12 file
52 is being created or parsed. By default a PKCS#12 file is parsed a PKCS#12
53 file can be created by using the B<-export> option (see below).
54
55 =head1 PARSING OPTIONS
56
57 =over 4
58
59 =item B<-in filename>
60
61 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
62 by default.
63
64 =item B<-out filename>
65
66 The filename to write certificates and private keys to, standard output by default.
67 They are all written in PEM format.
68
69 =item B<-pass arg>, B<-passin arg>
70
71 the PKCS#12 file (i.e. input file) password source. For more information about the
72 format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
73 L<openssl(1)|openssl(1)>.
74
75 =item B<-passout arg>
76
77 pass phrase source to encrypt any outputed private keys with. For more information
78 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
79 L<openssl(1)|openssl(1)>.
80
81 =item B<-noout>
82
83 this option inhibits output of the keys and certificates to the output file version
84 of the PKCS#12 file.
85
86 =item B<-clcerts>
87
88 only output client certificates (not CA certificates).
89
90 =item B<-cacerts>
91
92 only output CA certificates (not client certificates).
93
94 =item B<-nocerts>
95
96 no certificates at all will be output.
97
98 =item B<-nokeys>
99
100 no private keys will be output.
101
102 =item B<-info>
103
104 output additional information about the PKCS#12 file structure, algorithms used and
105 iteration counts.
106
107 =item B<-des>
108
109 use DES to encrypt private keys before outputting.
110
111 =item B<-des3>
112
113 use triple DES to encrypt private keys before outputting, this is the default.
114
115 =item B<-idea>
116
117 use IDEA to encrypt private keys before outputting.
118
119 =item B<-nodes>
120
121 don't encrypt the private keys at all.
122
123 =item B<-nomacver>
124
125 don't attempt to verify the integrity MAC before reading the file.
126
127 =item B<-twopass>
128
129 prompt for separate integrity and encryption passwords: most software
130 always assumes these are the same so this option will render such
131 PKCS#12 files unreadable.
132
133 =back
134
135 =head1 FILE CREATION OPTIONS
136
137 =over 4
138
139 =item B<-export>
140
141 This option specifies that a PKCS#12 file will be created rather than
142 parsed.
143
144 =item B<-out filename>
145
146 This specifies filename to write the PKCS#12 file to. Standard output is used
147 by default.
148
149 =item B<-in filename>
150
151 The filename to read certificates and private keys from, standard input by default.
152 They must all be in PEM format. The order doesn't matter but one private key and
153 its corresponding certificate should be present. If additional certificates are
154 present they will also be included in the PKCS#12 file.
155
156 =item B<-inkey filename>
157
158 file to read private key from. If not present then a private key must be present
159 in the input file.
160
161 =item B<-name friendlyname>
162
163 This specifies the "friendly name" for the certificate and private key. This name
164 is typically displayed in list boxes by software importing the file.
165
166 =item B<-certfile filename>
167
168 A filename to read additional certificates from.
169
170 =item B<-caname friendlyname>
171
172 This specifies the "friendly name" for other certificates. This option may be
173 used multiple times to specify names for all certificates in the order they
174 appear. Netscape ignores friendly names on other certificates whereas MSIE
175 displays them.
176
177 =item B<-pass arg>, B<-passout arg>
178
179 the PKCS#12 file (i.e. output file) password source. For more information about
180 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
181 L<openssl(1)|openssl(1)>.
182
183 =item B<-passin password>
184
185 pass phrase source to decrypt any input private keys with. For more information
186 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
187 L<openssl(1)|openssl(1)>.
188
189 =item B<-chain>
190
191 if this option is present then an attempt is made to include the entire
192 certificate chain of the user certificate. The standard CA store is used
193 for this search. If the search fails it is considered a fatal error.
194
195 =item B<-descert>
196
197 encrypt the certificate using triple DES, this may render the PKCS#12
198 file unreadable by some "export grade" software. By default the private
199 key is encrypted using triple DES and the certificate using 40 bit RC2.
200
201 =item B<-keypbe alg>, B<-certpbe alg>
202
203 these options allow the algorithm used to encrypt the private key and
204 certificates to be selected. Although any PKCS#5 v1.5 or PKCS#12 algorithms
205 can be selected it is advisable only to use PKCS#12 algorithms. See the list
206 in the B<NOTES> section for more information.
207
208 =item B<-keyex|-keysig>
209
210 specifies that the private key is to be used for key exchange or just signing.
211 This option is only interpreted by MSIE and similar MS software. Normally
212 "export grade" software will only allow 512 bit RSA keys to be used for
213 encryption purposes but arbitrary length keys for signing. The B<-keysig>
214 option marks the key for signing only. Signing only keys can be used for
215 S/MIME signing, authenticode (ActiveX control signing)  and SSL client
216 authentication, however due to a bug only MSIE 5.0 and later support
217 the use of signing only keys for SSL client authentication.
218
219 =item B<-nomaciter>, B<-noiter>
220
221 these options affect the iteration counts on the MAC and key algorithms.
222 Unless you wish to produce files compatible with MSIE 4.0 you should leave
223 these options alone.
224
225 To discourage attacks by using large dictionaries of common passwords the
226 algorithm that derives keys from passwords can have an iteration count applied
227 to it: this causes a certain part of the algorithm to be repeated and slows it
228 down. The MAC is used to check the file integrity but since it will normally
229 have the same password as the keys and certificates it could also be attacked.
230 By default both MAC and encryption iteration counts are set to 2048, using
231 these options the MAC and encryption iteration counts can be set to 1, since
232 this reduces the file security you should not use these options unless you
233 really have to. Most software supports both MAC and key iteration counts.
234 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
235 option.
236
237 =item B<-maciter>
238
239 This option is included for compatibility with previous versions, it used
240 to be needed to use MAC iterations counts but they are now used by default.
241
242 =item B<-rand file(s)>
243
244 a file or files containing random data used to seed the random number
245 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
246 Multiple files can be specified separated by a OS-dependent character.
247 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
248 all others.
249
250 =back
251
252 =head1 NOTES
253
254 Although there are a large number of options most of them are very rarely
255 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
256 for PKCS#12 file creation B<-export> and B<-name> are also used.
257
258 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
259 then all certificates will be output in the order they appear in the input
260 PKCS#12 files. There is no guarantee that the first certificate present is
261 the one corresponding to the private key. Certain software which requires
262 a private key and certificate and assumes the first certificate in the
263 file is the one corresponding to the private key: this may not always
264 be the case. Using the B<-clcerts> option will solve this problem by only
265 outputting the certificate corresponding to the private key. If the CA
266 certificates are required then they can be output to a separate file using
267 the B<-nokeys -cacerts> options to just output CA certificates.
268
269 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
270 algorithms for private keys and certificates to be specified. Normally
271 the defaults are fine but occasionally software can't handle triple DES
272 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
273 be used to reduce the private key encryption to 40 bit RC2. A complete
274 description of all algorithms is contained in the B<pkcs8> manual page.
275
276 =head1 EXAMPLES
277
278 Parse a PKCS#12 file and output it to a file:
279
280  openssl pkcs12 -in file.p12 -out file.pem
281
282 Output only client certificates to a file:
283
284  openssl pkcs12 -in file.p12 -clcerts -out file.pem
285
286 Don't encrypt the private key:
287  
288  openssl pkcs12 -in file.p12 -out file.pem -nodes
289
290 Print some info about a PKCS#12 file:
291
292  openssl pkcs12 -in file.p12 -info -noout
293
294 Create a PKCS#12 file:
295
296  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
297
298 Include some extra certificates:
299
300  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
301   -certfile othercerts.pem
302
303 =head1 BUGS
304
305 Some would argue that the PKCS#12 standard is one big bug :-)
306
307 Versions of OpenSSL before 0.9.6a had a bug in the PKCS#12 key generation
308 routines. Under rare circumstances this could produce a PKCS#12 file encrypted
309 with an invalid key. As a result some PKCS#12 files which triggered this bug
310 from other implementations (MSIE or Netscape) could not be decrypted
311 by OpenSSL and similarly OpenSSL could produce PKCS#12 files which could
312 not be decrypted by other implementations. The chances of producing such
313 a file are relatively small: less than 1 in 256.
314
315 A side effect of fixing this bug is that any old invalidly encrypted PKCS#12
316 files cannot no longer be parsed by the fixed version. Under such circumstances
317 the B<pkcs12> utility will report that the MAC is OK but fail with a decryption
318 error when extracting private keys.
319
320 This problem can be resolved by extracting the private keys and certificates
321 from the PKCS#12 file using an older version of OpenSSL and recreating the PKCS#12
322 file from the keys and certificates using a newer version of OpenSSL. For example:
323
324  old-openssl -in bad.p12 -out keycerts.pem
325  openssl -in keycerts.pem -export -name "My PKCS#12 file" -out fixed.p12
326
327 =head1 SEE ALSO
328
329 L<pkcs8(1)|pkcs8(1)>
330