5 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 Print out a usage message.
68 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
71 =item B<-out filename>
73 The filename to write certificates and private keys to, standard output by
74 default. They are all written in PEM format.
78 the PKCS#12 file (i.e. input file) password source. For more information about
79 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
84 pass phrase source to encrypt any outputted private keys with. For more
85 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
88 =item B<-password arg>
90 With -export, -password is equivalent to -passout.
91 Otherwise, -password is equivalent to -passin.
95 this option inhibits output of the keys and certificates to the output file
96 version of the PKCS#12 file.
100 only output client certificates (not CA certificates).
104 only output CA certificates (not client certificates).
108 no certificates at all will be output.
112 no private keys will be output.
116 output additional information about the PKCS#12 file structure, algorithms used and
121 use DES to encrypt private keys before outputting.
125 use triple DES to encrypt private keys before outputting, this is the default.
129 use IDEA to encrypt private keys before outputting.
131 =item B<-aes128>, B<-aes192>, B<-aes256>
133 use AES to encrypt private keys before outputting.
135 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
137 use Camellia to encrypt private keys before outputting.
141 don't encrypt the private keys at all.
145 don't attempt to verify the integrity MAC before reading the file.
149 prompt for separate integrity and encryption passwords: most software
150 always assumes these are the same so this option will render such
151 PKCS#12 files unreadable.
155 =head1 FILE CREATION OPTIONS
161 This option specifies that a PKCS#12 file will be created rather than
164 =item B<-out filename>
166 This specifies filename to write the PKCS#12 file to. Standard output is used
169 =item B<-in filename>
171 The filename to read certificates and private keys from, standard input by
172 default. They must all be in PEM format. The order doesn't matter but one
173 private key and its corresponding certificate should be present. If additional
174 certificates are present they will also be included in the PKCS#12 file.
176 =item B<-inkey filename>
178 file to read private key from. If not present then a private key must be present
181 =item B<-name friendlyname>
183 This specifies the "friendly name" for the certificate and private key. This
184 name is typically displayed in list boxes by software importing the file.
186 =item B<-certfile filename>
188 A filename to read additional certificates from.
190 =item B<-caname friendlyname>
192 This specifies the "friendly name" for other certificates. This option may be
193 used multiple times to specify names for all certificates in the order they
194 appear. Netscape ignores friendly names on other certificates whereas MSIE
197 =item B<-pass arg>, B<-passout arg>
199 the PKCS#12 file (i.e. output file) password source. For more information about
200 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
203 =item B<-passin password>
205 pass phrase source to decrypt any input private keys with. For more information
206 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
211 if this option is present then an attempt is made to include the entire
212 certificate chain of the user certificate. The standard CA store is used
213 for this search. If the search fails it is considered a fatal error.
217 encrypt the certificate using triple DES, this may render the PKCS#12
218 file unreadable by some "export grade" software. By default the private
219 key is encrypted using triple DES and the certificate using 40 bit RC2.
221 =item B<-keypbe alg>, B<-certpbe alg>
223 these options allow the algorithm used to encrypt the private key and
224 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
225 can be used (see B<NOTES> section for more information). If a cipher name
226 (as output by the B<list-cipher-algorithms> command is specified then it
227 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
228 use PKCS#12 algorithms.
230 =item B<-keyex|-keysig>
232 specifies that the private key is to be used for key exchange or just signing.
233 This option is only interpreted by MSIE and similar MS software. Normally
234 "export grade" software will only allow 512 bit RSA keys to be used for
235 encryption purposes but arbitrary length keys for signing. The B<-keysig>
236 option marks the key for signing only. Signing only keys can be used for
237 S/MIME signing, authenticode (ActiveX control signing) and SSL client
238 authentication, however due to a bug only MSIE 5.0 and later support
239 the use of signing only keys for SSL client authentication.
241 =item B<-macalg digest>
243 specify the MAC digest algorithm. If not included them SHA1 will be used.
245 =item B<-nomaciter>, B<-noiter>
247 these options affect the iteration counts on the MAC and key algorithms.
248 Unless you wish to produce files compatible with MSIE 4.0 you should leave
251 To discourage attacks by using large dictionaries of common passwords the
252 algorithm that derives keys from passwords can have an iteration count applied
253 to it: this causes a certain part of the algorithm to be repeated and slows it
254 down. The MAC is used to check the file integrity but since it will normally
255 have the same password as the keys and certificates it could also be attacked.
256 By default both MAC and encryption iteration counts are set to 2048, using
257 these options the MAC and encryption iteration counts can be set to 1, since
258 this reduces the file security you should not use these options unless you
259 really have to. Most software supports both MAC and key iteration counts.
260 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
265 This option is included for compatibility with previous versions, it used
266 to be needed to use MAC iterations counts but they are now used by default.
270 don't attempt to provide the MAC integrity.
272 =item B<-rand file(s)>
274 a file or files containing random data used to seed the random number
275 generator, or an EGD socket (see L<RAND_egd(3)>).
276 Multiple files can be specified separated by an OS-dependent character.
277 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
280 =item B<-CAfile file>
282 CA storage as a file.
286 CA storage as a directory. This directory must be a standard certificate
287 directory: that is a hash of each subject name (using B<x509 -hash>) should be
288 linked to each certificate.
292 Do not load the trusted CA certificates from the default file location
296 Do not load the trusted CA certificates from the default directory location
300 write B<name> as a Microsoft CSP name.
306 Although there are a large number of options most of them are very rarely
307 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
308 for PKCS#12 file creation B<-export> and B<-name> are also used.
310 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
311 then all certificates will be output in the order they appear in the input
312 PKCS#12 files. There is no guarantee that the first certificate present is
313 the one corresponding to the private key. Certain software which requires
314 a private key and certificate and assumes the first certificate in the
315 file is the one corresponding to the private key: this may not always
316 be the case. Using the B<-clcerts> option will solve this problem by only
317 outputting the certificate corresponding to the private key. If the CA
318 certificates are required then they can be output to a separate file using
319 the B<-nokeys -cacerts> options to just output CA certificates.
321 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
322 algorithms for private keys and certificates to be specified. Normally
323 the defaults are fine but occasionally software can't handle triple DES
324 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
325 be used to reduce the private key encryption to 40 bit RC2. A complete
326 description of all algorithms is contained in the B<pkcs8> manual page.
330 Parse a PKCS#12 file and output it to a file:
332 openssl pkcs12 -in file.p12 -out file.pem
334 Output only client certificates to a file:
336 openssl pkcs12 -in file.p12 -clcerts -out file.pem
338 Don't encrypt the private key:
340 openssl pkcs12 -in file.p12 -out file.pem -nodes
342 Print some info about a PKCS#12 file:
344 openssl pkcs12 -in file.p12 -info -noout
346 Create a PKCS#12 file:
348 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
350 Include some extra certificates:
352 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
353 -certfile othercerts.pem
363 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
365 Licensed under the OpenSSL license (the "License"). You may not use
366 this file except in compliance with the License. You can obtain a copy
367 in the file LICENSE in the source distribution or at
368 L<https://www.openssl.org/source/license.html>.