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