7 pkcs12 - PKCS#12 file utility
15 [B<-certfile filename>]
27 [B<-des | -des3 | -idea | -aes128 | -aes192 | -aes256 | -camellia128 | -camellia192 | -camellia256 | -nodes>]
29 [B<-maciter | -nomaciter | -nomac>]
47 The B<pkcs12> command allows PKCS#12 files (sometimes referred to as
48 PFX files) to be created and parsed. PKCS#12 files are used by several
49 programs including Netscape, MSIE and MS Outlook.
51 =head1 COMMAND OPTIONS
53 There are a lot of options the meaning of some depends of whether a PKCS#12 file
54 is being created or parsed. By default a PKCS#12 file is parsed. A PKCS#12
55 file can be created by using the B<-export> option (see below).
57 =head1 PARSING OPTIONS
63 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
66 =item B<-out filename>
68 The filename to write certificates and private keys to, standard output by
69 default. They are all written in PEM format.
73 the PKCS#12 file (i.e. input file) password source. For more information about
74 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
75 L<openssl(1)|openssl(1)>.
79 pass phrase source to encrypt any outputted private keys with. For more
80 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
81 in L<openssl(1)|openssl(1)>.
83 =item B<-password arg>
85 With -export, -password is equivalent to -passout.
86 Otherwise, -password is equivalent to -passin.
90 this option inhibits output of the keys and certificates to the output file
91 version of the PKCS#12 file.
95 only output client certificates (not CA certificates).
99 only output CA certificates (not client certificates).
103 no certificates at all will be output.
107 no private keys will be output.
111 output additional information about the PKCS#12 file structure, algorithms used and
116 use DES to encrypt private keys before outputting.
120 use triple DES to encrypt private keys before outputting, this is the default.
124 use IDEA to encrypt private keys before outputting.
126 =item B<-aes128>, B<-aes192>, B<-aes256>
128 use AES to encrypt private keys before outputting.
130 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
132 use Camellia to encrypt private keys before outputting.
136 don't encrypt the private keys at all.
140 don't attempt to verify the integrity MAC before reading the file.
144 prompt for separate integrity and encryption passwords: most software
145 always assumes these are the same so this option will render such
146 PKCS#12 files unreadable.
150 =head1 FILE CREATION OPTIONS
156 This option specifies that a PKCS#12 file will be created rather than
159 =item B<-out filename>
161 This specifies filename to write the PKCS#12 file to. Standard output is used
164 =item B<-in filename>
166 The filename to read certificates and private keys from, standard input by
167 default. They must all be in PEM format. The order doesn't matter but one
168 private key and its corresponding certificate should be present. If additional
169 certificates are present they will also be included in the PKCS#12 file.
171 =item B<-inkey filename>
173 file to read private key from. If not present then a private key must be present
176 =item B<-name friendlyname>
178 This specifies the "friendly name" for the certificate and private key. This
179 name is typically displayed in list boxes by software importing the file.
181 =item B<-certfile filename>
183 A filename to read additional certificates from.
185 =item B<-caname friendlyname>
187 This specifies the "friendly name" for other certificates. This option may be
188 used multiple times to specify names for all certificates in the order they
189 appear. Netscape ignores friendly names on other certificates whereas MSIE
192 =item B<-pass arg>, B<-passout arg>
194 the PKCS#12 file (i.e. output file) password source. For more information about
195 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
196 L<openssl(1)|openssl(1)>.
198 =item B<-passin password>
200 pass phrase source to decrypt any input private keys with. For more information
201 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
202 L<openssl(1)|openssl(1)>.
206 if this option is present then an attempt is made to include the entire
207 certificate chain of the user certificate. The standard CA store is used
208 for this search. If the search fails it is considered a fatal error.
212 encrypt the certificate using triple DES, this may render the PKCS#12
213 file unreadable by some "export grade" software. By default the private
214 key is encrypted using triple DES and the certificate using 40 bit RC2.
216 =item B<-keypbe alg>, B<-certpbe alg>
218 these options allow the algorithm used to encrypt the private key and
219 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
220 can be used (see B<NOTES> section for more information). If a cipher name
221 (as output by the B<list-cipher-algorithms> command is specified then it
222 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
223 use PKCS#12 algorithms.
225 =item B<-keyex|-keysig>
227 specifies that the private key is to be used for key exchange or just signing.
228 This option is only interpreted by MSIE and similar MS software. Normally
229 "export grade" software will only allow 512 bit RSA keys to be used for
230 encryption purposes but arbitrary length keys for signing. The B<-keysig>
231 option marks the key for signing only. Signing only keys can be used for
232 S/MIME signing, authenticode (ActiveX control signing) and SSL client
233 authentication, however due to a bug only MSIE 5.0 and later support
234 the use of signing only keys for SSL client authentication.
236 =item B<-macalg digest>
238 specify the MAC digest algorithm. If not included them SHA1 will be used.
240 =item B<-nomaciter>, B<-noiter>
242 these options affect the iteration counts on the MAC and key algorithms.
243 Unless you wish to produce files compatible with MSIE 4.0 you should leave
246 To discourage attacks by using large dictionaries of common passwords the
247 algorithm that derives keys from passwords can have an iteration count applied
248 to it: this causes a certain part of the algorithm to be repeated and slows it
249 down. The MAC is used to check the file integrity but since it will normally
250 have the same password as the keys and certificates it could also be attacked.
251 By default both MAC and encryption iteration counts are set to 2048, using
252 these options the MAC and encryption iteration counts can be set to 1, since
253 this reduces the file security you should not use these options unless you
254 really have to. Most software supports both MAC and key iteration counts.
255 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
260 This option is included for compatibility with previous versions, it used
261 to be needed to use MAC iterations counts but they are now used by default.
265 don't attempt to provide the MAC integrity.
267 =item B<-rand file(s)>
269 a file or files containing random data used to seed the random number
270 generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
271 Multiple files can be specified separated by a OS-dependent character.
272 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
275 =item B<-CAfile file>
277 CA storage as a file.
281 CA storage as a directory. This directory must be a standard certificate
282 directory: that is a hash of each subject name (using B<x509 -hash>) should be
283 linked to each certificate.
287 write B<name> as a Microsoft CSP name.
293 Although there are a large number of options most of them are very rarely
294 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
295 for PKCS#12 file creation B<-export> and B<-name> are also used.
297 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
298 then all certificates will be output in the order they appear in the input
299 PKCS#12 files. There is no guarantee that the first certificate present is
300 the one corresponding to the private key. Certain software which requires
301 a private key and certificate and assumes the first certificate in the
302 file is the one corresponding to the private key: this may not always
303 be the case. Using the B<-clcerts> option will solve this problem by only
304 outputting the certificate corresponding to the private key. If the CA
305 certificates are required then they can be output to a separate file using
306 the B<-nokeys -cacerts> options to just output CA certificates.
308 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
309 algorithms for private keys and certificates to be specified. Normally
310 the defaults are fine but occasionally software can't handle triple DES
311 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
312 be used to reduce the private key encryption to 40 bit RC2. A complete
313 description of all algorithms is contained in the B<pkcs8> manual page.
317 Parse a PKCS#12 file and output it to a file:
319 openssl pkcs12 -in file.p12 -out file.pem
321 Output only client certificates to a file:
323 openssl pkcs12 -in file.p12 -clcerts -out file.pem
325 Don't encrypt the private key:
327 openssl pkcs12 -in file.p12 -out file.pem -nodes
329 Print some info about a PKCS#12 file:
331 openssl pkcs12 -in file.p12 -info -noout
333 Create a PKCS#12 file:
335 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
337 Include some extra certificates:
339 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
340 -certfile othercerts.pem
344 Some would argue that the PKCS#12 standard is one big bug :-)
346 Versions of OpenSSL before 0.9.6a had a bug in the PKCS#12 key generation
347 routines. Under rare circumstances this could produce a PKCS#12 file encrypted
348 with an invalid key. As a result some PKCS#12 files which triggered this bug
349 from other implementations (MSIE or Netscape) could not be decrypted
350 by OpenSSL and similarly OpenSSL could produce PKCS#12 files which could
351 not be decrypted by other implementations. The chances of producing such
352 a file are relatively small: less than 1 in 256.
354 A side effect of fixing this bug is that any old invalidly encrypted PKCS#12
355 files cannot no longer be parsed by the fixed version. Under such circumstances
356 the B<pkcs12> utility will report that the MAC is OK but fail with a decryption
357 error when extracting private keys.
359 This problem can be resolved by extracting the private keys and certificates
360 from the PKCS#12 file using an older version of OpenSSL and recreating the PKCS#12
361 file from the keys and certificates using a newer version of OpenSSL. For example:
363 old-openssl -in bad.p12 -out keycerts.pem
364 openssl -in keycerts.pem -export -name "My PKCS#12 file" -out fixed.p12