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