6 pkcs12 - PKCS#12 file utility
14 [B<-certfile filename>]
26 [B<-des | -des3 | -idea | -aes128 | -aes192 | -aes256 | -camellia128 | -camellia192 | -camellia256 | -nodes>]
28 [B<-maciter | -nomaciter | -nomac>]
48 The B<pkcs12> command allows PKCS#12 files (sometimes referred to as
49 PFX files) to be created and parsed. PKCS#12 files are used by several
50 programs including Netscape, MSIE and MS Outlook.
52 =head1 COMMAND OPTIONS
54 There are a lot of options the meaning of some depends of whether a PKCS#12 file
55 is being created or parsed. By default a PKCS#12 file is parsed. A PKCS#12
56 file can be created by using the B<-export> option (see below).
58 =head1 PARSING OPTIONS
64 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
67 =item B<-out filename>
69 The filename to write certificates and private keys to, standard output by
70 default. They are all written in PEM format.
74 the PKCS#12 file (i.e. input file) password source. For more information about
75 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
80 pass phrase source to encrypt any outputted private keys with. For more
81 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
84 =item B<-password arg>
86 With -export, -password is equivalent to -passout.
87 Otherwise, -password is equivalent to -passin.
91 this option inhibits output of the keys and certificates to the output file
92 version of the PKCS#12 file.
96 only output client certificates (not CA certificates).
100 only output CA certificates (not client certificates).
104 no certificates at all will be output.
108 no private keys will be output.
112 output additional information about the PKCS#12 file structure, algorithms used and
117 use DES to encrypt private keys before outputting.
121 use triple DES to encrypt private keys before outputting, this is the default.
125 use IDEA to encrypt private keys before outputting.
127 =item B<-aes128>, B<-aes192>, B<-aes256>
129 use AES to encrypt private keys before outputting.
131 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
133 use Camellia to encrypt private keys before outputting.
137 don't encrypt the private keys at all.
141 don't attempt to verify the integrity MAC before reading the file.
145 prompt for separate integrity and encryption passwords: most software
146 always assumes these are the same so this option will render such
147 PKCS#12 files unreadable.
151 =head1 FILE CREATION OPTIONS
157 This option specifies that a PKCS#12 file will be created rather than
160 =item B<-out filename>
162 This specifies filename to write the PKCS#12 file to. Standard output is used
165 =item B<-in filename>
167 The filename to read certificates and private keys from, standard input by
168 default. They must all be in PEM format. The order doesn't matter but one
169 private key and its corresponding certificate should be present. If additional
170 certificates are present they will also be included in the PKCS#12 file.
172 =item B<-inkey filename>
174 file to read private key from. If not present then a private key must be present
177 =item B<-name friendlyname>
179 This specifies the "friendly name" for the certificate and private key. This
180 name is typically displayed in list boxes by software importing the file.
182 =item B<-certfile filename>
184 A filename to read additional certificates from.
186 =item B<-caname friendlyname>
188 This specifies the "friendly name" for other certificates. This option may be
189 used multiple times to specify names for all certificates in the order they
190 appear. Netscape ignores friendly names on other certificates whereas MSIE
193 =item B<-pass arg>, B<-passout arg>
195 the PKCS#12 file (i.e. output file) password source. For more information about
196 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
199 =item B<-passin password>
201 pass phrase source to decrypt any input private keys with. For more information
202 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
207 if this option is present then an attempt is made to include the entire
208 certificate chain of the user certificate. The standard CA store is used
209 for this search. If the search fails it is considered a fatal error.
213 encrypt the certificate using triple DES, this may render the PKCS#12
214 file unreadable by some "export grade" software. By default the private
215 key is encrypted using triple DES and the certificate using 40 bit RC2.
217 =item B<-keypbe alg>, B<-certpbe alg>
219 these options allow the algorithm used to encrypt the private key and
220 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
221 can be used (see B<NOTES> section for more information). If a cipher name
222 (as output by the B<list-cipher-algorithms> command is specified then it
223 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
224 use PKCS#12 algorithms.
226 =item B<-keyex|-keysig>
228 specifies that the private key is to be used for key exchange or just signing.
229 This option is only interpreted by MSIE and similar MS software. Normally
230 "export grade" software will only allow 512 bit RSA keys to be used for
231 encryption purposes but arbitrary length keys for signing. The B<-keysig>
232 option marks the key for signing only. Signing only keys can be used for
233 S/MIME signing, authenticode (ActiveX control signing) and SSL client
234 authentication, however due to a bug only MSIE 5.0 and later support
235 the use of signing only keys for SSL client authentication.
237 =item B<-macalg digest>
239 specify the MAC digest algorithm. If not included them SHA1 will be used.
241 =item B<-nomaciter>, B<-noiter>
243 these options affect the iteration counts on the MAC and key algorithms.
244 Unless you wish to produce files compatible with MSIE 4.0 you should leave
247 To discourage attacks by using large dictionaries of common passwords the
248 algorithm that derives keys from passwords can have an iteration count applied
249 to it: this causes a certain part of the algorithm to be repeated and slows it
250 down. The MAC is used to check the file integrity but since it will normally
251 have the same password as the keys and certificates it could also be attacked.
252 By default both MAC and encryption iteration counts are set to 2048, using
253 these options the MAC and encryption iteration counts can be set to 1, since
254 this reduces the file security you should not use these options unless you
255 really have to. Most software supports both MAC and key iteration counts.
256 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
261 This option is included for compatibility with previous versions, it used
262 to be needed to use MAC iterations counts but they are now used by default.
266 don't attempt to provide the MAC integrity.
268 =item B<-rand file(s)>
270 a file or files containing random data used to seed the random number
271 generator, or an EGD socket (see L<RAND_egd(3)>).
272 Multiple files can be specified separated by a OS-dependent character.
273 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
276 =item B<-CAfile file>
278 CA storage as a file.
282 CA storage as a directory. This directory must be a standard certificate
283 directory: that is a hash of each subject name (using B<x509 -hash>) should be
284 linked to each certificate.
288 Do not load the trusted CA certificates from the default file location
292 Do not load the trusted CA certificates from the default directory location
296 write B<name> as a Microsoft CSP name.
302 Although there are a large number of options most of them are very rarely
303 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
304 for PKCS#12 file creation B<-export> and B<-name> are also used.
306 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
307 then all certificates will be output in the order they appear in the input
308 PKCS#12 files. There is no guarantee that the first certificate present is
309 the one corresponding to the private key. Certain software which requires
310 a private key and certificate and assumes the first certificate in the
311 file is the one corresponding to the private key: this may not always
312 be the case. Using the B<-clcerts> option will solve this problem by only
313 outputting the certificate corresponding to the private key. If the CA
314 certificates are required then they can be output to a separate file using
315 the B<-nokeys -cacerts> options to just output CA certificates.
317 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
318 algorithms for private keys and certificates to be specified. Normally
319 the defaults are fine but occasionally software can't handle triple DES
320 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
321 be used to reduce the private key encryption to 40 bit RC2. A complete
322 description of all algorithms is contained in the B<pkcs8> manual page.
326 Parse a PKCS#12 file and output it to a file:
328 openssl pkcs12 -in file.p12 -out file.pem
330 Output only client certificates to a file:
332 openssl pkcs12 -in file.p12 -clcerts -out file.pem
334 Don't encrypt the private key:
336 openssl pkcs12 -in file.p12 -out file.pem -nodes
338 Print some info about a PKCS#12 file:
340 openssl pkcs12 -in file.p12 -info -noout
342 Create a PKCS#12 file:
344 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
346 Include some extra certificates:
348 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
349 -certfile othercerts.pem