doc/apps/pkcs12.pod

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