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