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