6 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>]
49 The B<pkcs12> command allows PKCS#12 files (sometimes referred to as
50 PFX files) to be created and parsed. PKCS#12 files are used by several
51 programs including Netscape, MSIE and MS Outlook.
53 =head1 COMMAND OPTIONS
55 There are a lot of options the meaning of some depends of whether a PKCS#12 file
56 is being created or parsed. By default a PKCS#12 file is parsed. A PKCS#12
57 file can be created by using the B<-export> option (see below).
59 =head1 PARSING OPTIONS
65 Print out a usage message.
69 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
72 =item B<-out filename>
74 The filename to write certificates and private keys to, standard output by
75 default. They are all written in PEM format.
79 the PKCS#12 file (i.e. input file) password source. For more information about
80 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
85 pass phrase source to encrypt any outputted private keys with. For more
86 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
89 =item B<-password arg>
91 With -export, -password is equivalent to -passout.
92 Otherwise, -password is equivalent to -passin.
96 this option inhibits output of the keys and certificates to the output file
97 version of the PKCS#12 file.
101 only output client certificates (not CA certificates).
105 only output CA certificates (not client certificates).
109 no certificates at all will be output.
113 no private keys will be output.
117 output additional information about the PKCS#12 file structure, algorithms used and
122 use DES to encrypt private keys before outputting.
126 use triple DES to encrypt private keys before outputting, this is the default.
130 use IDEA to encrypt private keys before outputting.
132 =item B<-aes128>, B<-aes192>, B<-aes256>
134 use AES to encrypt private keys before outputting.
136 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
138 use Camellia to encrypt private keys before outputting.
142 don't encrypt the private keys at all.
146 don't attempt to verify the integrity MAC before reading the file.
150 prompt for separate integrity and encryption passwords: most software
151 always assumes these are the same so this option will render such
152 PKCS#12 files unreadable.
156 =head1 FILE CREATION OPTIONS
162 This option specifies that a PKCS#12 file will be created rather than
165 =item B<-out filename>
167 This specifies filename to write the PKCS#12 file to. Standard output is used
170 =item B<-in filename>
172 The filename to read certificates and private keys from, standard input by
173 default. They must all be in PEM format. The order doesn't matter but one
174 private key and its corresponding certificate should be present. If additional
175 certificates are present they will also be included in the PKCS#12 file.
177 =item B<-inkey filename>
179 file to read private key from. If not present then a private key must be present
182 =item B<-name friendlyname>
184 This specifies the "friendly name" for the certificate and private key. This
185 name is typically displayed in list boxes by software importing the file.
187 =item B<-certfile filename>
189 A filename to read additional certificates from.
191 =item B<-caname friendlyname>
193 This specifies the "friendly name" for other certificates. This option may be
194 used multiple times to specify names for all certificates in the order they
195 appear. Netscape ignores friendly names on other certificates whereas MSIE
198 =item B<-pass arg>, B<-passout arg>
200 the PKCS#12 file (i.e. output file) password source. For more information about
201 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
204 =item B<-passin password>
206 pass phrase source to decrypt any input private keys with. For more information
207 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
212 if this option is present then an attempt is made to include the entire
213 certificate chain of the user certificate. The standard CA store is used
214 for this search. If the search fails it is considered a fatal error.
218 encrypt the certificate using triple DES, this may render the PKCS#12
219 file unreadable by some "export grade" software. By default the private
220 key is encrypted using triple DES and the certificate using 40 bit RC2.
222 =item B<-keypbe alg>, B<-certpbe alg>
224 these options allow the algorithm used to encrypt the private key and
225 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
226 can be used (see B<NOTES> section for more information). If a cipher name
227 (as output by the B<list-cipher-algorithms> command is specified then it
228 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
229 use PKCS#12 algorithms.
231 =item B<-keyex|-keysig>
233 specifies that the private key is to be used for key exchange or just signing.
234 This option is only interpreted by MSIE and similar MS software. Normally
235 "export grade" software will only allow 512 bit RSA keys to be used for
236 encryption purposes but arbitrary length keys for signing. The B<-keysig>
237 option marks the key for signing only. Signing only keys can be used for
238 S/MIME signing, authenticode (ActiveX control signing) and SSL client
239 authentication, however due to a bug only MSIE 5.0 and later support
240 the use of signing only keys for SSL client authentication.
242 =item B<-macalg digest>
244 specify the MAC digest algorithm. If not included them SHA1 will be used.
246 =item B<-nomaciter>, B<-noiter>
248 these options affect the iteration counts on the MAC and key algorithms.
249 Unless you wish to produce files compatible with MSIE 4.0 you should leave
252 To discourage attacks by using large dictionaries of common passwords the
253 algorithm that derives keys from passwords can have an iteration count applied
254 to it: this causes a certain part of the algorithm to be repeated and slows it
255 down. The MAC is used to check the file integrity but since it will normally
256 have the same password as the keys and certificates it could also be attacked.
257 By default both MAC and encryption iteration counts are set to 2048, using
258 these options the MAC and encryption iteration counts can be set to 1, since
259 this reduces the file security you should not use these options unless you
260 really have to. Most software supports both MAC and key iteration counts.
261 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
266 This option is included for compatibility with previous versions, it used
267 to be needed to use MAC iterations counts but they are now used by default.
271 don't attempt to provide the MAC integrity.
273 =item B<-rand file(s)>
275 a file or files containing random data used to seed the random number
276 generator, or an EGD socket (see L<RAND_egd(3)>).
277 Multiple files can be specified separated by an OS-dependent character.
278 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
281 =item B<-CAfile file>
283 CA storage as a file.
287 CA storage as a directory. This directory must be a standard certificate
288 directory: that is a hash of each subject name (using B<x509 -hash>) should be
289 linked to each certificate.
293 Do not load the trusted CA certificates from the default file location
297 Do not load the trusted CA certificates from the default directory location
301 write B<name> as a Microsoft CSP name.
307 Although there are a large number of options most of them are very rarely
308 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
309 for PKCS#12 file creation B<-export> and B<-name> are also used.
311 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
312 then all certificates will be output in the order they appear in the input
313 PKCS#12 files. There is no guarantee that the first certificate present is
314 the one corresponding to the private key. Certain software which requires
315 a private key and certificate and assumes the first certificate in the
316 file is the one corresponding to the private key: this may not always
317 be the case. Using the B<-clcerts> option will solve this problem by only
318 outputting the certificate corresponding to the private key. If the CA
319 certificates are required then they can be output to a separate file using
320 the B<-nokeys -cacerts> options to just output CA certificates.
322 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
323 algorithms for private keys and certificates to be specified. Normally
324 the defaults are fine but occasionally software can't handle triple DES
325 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
326 be used to reduce the private key encryption to 40 bit RC2. A complete
327 description of all algorithms is contained in the B<pkcs8> manual page.
331 Parse a PKCS#12 file and output it to a file:
333 openssl pkcs12 -in file.p12 -out file.pem
335 Output only client certificates to a file:
337 openssl pkcs12 -in file.p12 -clcerts -out file.pem
339 Don't encrypt the private key:
341 openssl pkcs12 -in file.p12 -out file.pem -nodes
343 Print some info about a PKCS#12 file:
345 openssl pkcs12 -in file.p12 -info -noout
347 Create a PKCS#12 file:
349 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
351 Include some extra certificates:
353 openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
354 -certfile othercerts.pem
364 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
366 Licensed under the OpenSSL license (the "License"). You may not use
367 this file except in compliance with the License. You can obtain a copy
368 in the file LICENSE in the source distribution or at
369 L<https://www.openssl.org/source/license.html>.