doc/man1/pkcs12.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 pkcs12 - PKCS#12 file utility
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<pkcs12>
  10 [B<-help>]
  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 | -aria128 | -aria192 | -aria256 | -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<-no-CAfile>]
  43 [B<-no-CApath>]
  44 [B<-CSP name>]
  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 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<-help>
  63
  64 Print out a usage message.
  65
  66 =item B<-in filename>
  67
  68 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
  69 by default.
  70
  71 =item B<-out filename>
  72
  73 The filename to write certificates and private keys to, standard output by
  74 default.  They are all written in PEM format.
  75
  76 =item B<-passin arg>
  77
  78 The PKCS#12 file (i.e. input file) password source. For more information about
  79 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
  80 L<openssl(1)>.
  81
  82 =item B<-passout arg>
  83
  84 Pass phrase source to encrypt any outputted private keys with. For more
  85 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
  86 in L<openssl(1)>.
  87
  88 =item B<-password arg>
  89
  90 With -export, -password is equivalent to -passout.
  91 Otherwise, -password is equivalent to -passin.
  92
  93 =item B<-noout>
  94
  95 This option inhibits output of the keys and certificates to the output file
  96 version of the PKCS#12 file.
  97
  98 =item B<-clcerts>
  99
 100 Only output client certificates (not CA certificates).
 101
 102 =item B<-cacerts>
 103
 104 Only output CA certificates (not client certificates).
 105
 106 =item B<-nocerts>
 107
 108 No certificates at all will be output.
 109
 110 =item B<-nokeys>
 111
 112 No private keys will be output.
 113
 114 =item B<-info>
 115
 116 Output additional information about the PKCS#12 file structure, algorithms
 117 used and iteration counts.
 118
 119 =item B<-des>
 120
 121 Use DES to encrypt private keys before outputting.
 122
 123 =item B<-des3>
 124
 125 Use triple DES to encrypt private keys before outputting, this is the default.
 126
 127 =item B<-idea>
 128
 129 Use IDEA to encrypt private keys before outputting.
 130
 131 =item B<-aes128>, B<-aes192>, B<-aes256>
 132
 133 Use AES to encrypt private keys before outputting.
 134
 135 =item B<-aria128>, B<-aria192>, B<-aria256>
 136
 137 Use ARIA to encrypt private keys before outputting.
 138
 139 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
 140
 141 Use Camellia to encrypt private keys before outputting.
 142
 143 =item B<-nodes>
 144
 145 Don't encrypt the private keys at all.
 146
 147 =item B<-nomacver>
 148
 149 Don't attempt to verify the integrity MAC before reading the file.
 150
 151 =item B<-twopass>
 152
 153 Prompt for separate integrity and encryption passwords: most software
 154 always assumes these are the same so this option will render such
 155 PKCS#12 files unreadable.
 156
 157 =back
 158
 159 =head1 FILE CREATION OPTIONS
 160
 161 =over 4
 162
 163 =item B<-export>
 164
 165 This option specifies that a PKCS#12 file will be created rather than
 166 parsed.
 167
 168 =item B<-out filename>
 169
 170 This specifies filename to write the PKCS#12 file to. Standard output is used
 171 by default.
 172
 173 =item B<-in filename>
 174
 175 The filename to read certificates and private keys from, standard input by
 176 default.  They must all be in PEM format. The order doesn't matter but one
 177 private key and its corresponding certificate should be present. If additional
 178 certificates are present they will also be included in the PKCS#12 file.
 179
 180 =item B<-inkey filename>
 181
 182 File to read private key from. If not present then a private key must be present
 183 in the input file.
 184
 185 =item B<-name friendlyname>
 186
 187 This specifies the "friendly name" for the certificate and private key. This
 188 name is typically displayed in list boxes by software importing the file.
 189
 190 =item B<-certfile filename>
 191
 192 A filename to read additional certificates from.
 193
 194 =item B<-caname friendlyname>
 195
 196 This specifies the "friendly name" for other certificates. This option may be
 197 used multiple times to specify names for all certificates in the order they
 198 appear. Netscape ignores friendly names on other certificates whereas MSIE
 199 displays them.
 200
 201 =item B<-pass arg>, B<-passout arg>
 202
 203 The PKCS#12 file (i.e. output file) password source. For more information about
 204 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
 205 L<openssl(1)>.
 206
 207 =item B<-passin password>
 208
 209 Pass phrase source to decrypt any input private keys with. For more information
 210 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
 211 L<openssl(1)>.
 212
 213 =item B<-chain>
 214
 215 If this option is present then an attempt is made to include the entire
 216 certificate chain of the user certificate. The standard CA store is used
 217 for this search. If the search fails it is considered a fatal error.
 218
 219 =item B<-descert>
 220
 221 Encrypt the certificate using triple DES, this may render the PKCS#12
 222 file unreadable by some "export grade" software. By default the private
 223 key is encrypted using triple DES and the certificate using 40 bit RC2.
 224
 225 =item B<-keypbe alg>, B<-certpbe alg>
 226
 227 These options allow the algorithm used to encrypt the private key and
 228 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
 229 can be used (see B<NOTES> section for more information). If a cipher name
 230 (as output by the B<list-cipher-algorithms> command is specified then it
 231 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
 232 use PKCS#12 algorithms.
 233
 234 =item B<-keyex|-keysig>
 235
 236 Specifies that the private key is to be used for key exchange or just signing.
 237 This option is only interpreted by MSIE and similar MS software. Normally
 238 "export grade" software will only allow 512 bit RSA keys to be used for
 239 encryption purposes but arbitrary length keys for signing. The B<-keysig>
 240 option marks the key for signing only. Signing only keys can be used for
 241 S/MIME signing, authenticode (ActiveX control signing)  and SSL client
 242 authentication, however due to a bug only MSIE 5.0 and later support
 243 the use of signing only keys for SSL client authentication.
 244
 245 =item B<-macalg digest>
 246
 247 Specify the MAC digest algorithm. If not included them SHA1 will be used.
 248
 249 =item B<-nomaciter>, B<-noiter>
 250
 251 These options affect the iteration counts on the MAC and key algorithms.
 252 Unless you wish to produce files compatible with MSIE 4.0 you should leave
 253 these options alone.
 254
 255 To discourage attacks by using large dictionaries of common passwords the
 256 algorithm that derives keys from passwords can have an iteration count applied
 257 to it: this causes a certain part of the algorithm to be repeated and slows it
 258 down. The MAC is used to check the file integrity but since it will normally
 259 have the same password as the keys and certificates it could also be attacked.
 260 By default both MAC and encryption iteration counts are set to 2048, using
 261 these options the MAC and encryption iteration counts can be set to 1, since
 262 this reduces the file security you should not use these options unless you
 263 really have to. Most software supports both MAC and key iteration counts.
 264 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
 265 option.
 266
 267 =item B<-maciter>
 268
 269 This option is included for compatibility with previous versions, it used
 270 to be needed to use MAC iterations counts but they are now used by default.
 271
 272 =item B<-nomac>
 273
 274 Don't attempt to provide the MAC integrity.
 275
 276 =item B<-rand file(s)>
 277
 278 A file or files containing random data used to seed the random number
 279 generator, or an EGD socket (see L<RAND_egd(3)>).
 280 Multiple files can be specified separated by an OS-dependent character.
 281 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 282 all others.
 283
 284 =item B<-CAfile file>
 285
 286 CA storage as a file.
 287
 288 =item B<-CApath dir>
 289
 290 CA storage as a directory. This directory must be a standard certificate
 291 directory: that is a hash of each subject name (using B<x509 -hash>) should be
 292 linked to each certificate.
 293
 294 =item B<-no-CAfile>
 295
 296 Do not load the trusted CA certificates from the default file location.
 297
 298 =item B<-no-CApath>
 299
 300 Do not load the trusted CA certificates from the default directory location.
 301
 302 =item B<-CSP name>
 303
 304 Write B<name> as a Microsoft CSP name.
 305
 306 =back
 307
 308 =head1 NOTES
 309
 310 Although there are a large number of options most of them are very rarely
 311 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
 312 for PKCS#12 file creation B<-export> and B<-name> are also used.
 313
 314 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
 315 then all certificates will be output in the order they appear in the input
 316 PKCS#12 files. There is no guarantee that the first certificate present is
 317 the one corresponding to the private key. Certain software which requires
 318 a private key and certificate and assumes the first certificate in the
 319 file is the one corresponding to the private key: this may not always
 320 be the case. Using the B<-clcerts> option will solve this problem by only
 321 outputting the certificate corresponding to the private key. If the CA
 322 certificates are required then they can be output to a separate file using
 323 the B<-nokeys -cacerts> options to just output CA certificates.
 324
 325 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
 326 algorithms for private keys and certificates to be specified. Normally
 327 the defaults are fine but occasionally software can't handle triple DES
 328 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
 329 be used to reduce the private key encryption to 40 bit RC2. A complete
 330 description of all algorithms is contained in the B<pkcs8> manual page.
 331
 332 Prior 1.1 release passwords containing non-ASCII characters were encoded
 333 in non-compliant manner, which limited interoperability, in first hand
 334 with Windows. But switching to standard-compliant password encoding
 335 poses problem accessing old data protected with broken encoding. For
 336 this reason even legacy encodings is attempted when reading the
 337 data. If you use PKCS#12 files in production application you are advised
 338 to convert the data, because implemented heuristic approach is not
 339 MT-safe, its sole goal is to facilitate the data upgrade with this
 340 utility.
 341
 342 =head1 EXAMPLES
 343
 344 Parse a PKCS#12 file and output it to a file:
 345
 346  openssl pkcs12 -in file.p12 -out file.pem
 347
 348 Output only client certificates to a file:
 349
 350  openssl pkcs12 -in file.p12 -clcerts -out file.pem
 351
 352 Don't encrypt the private key:
 353
 354  openssl pkcs12 -in file.p12 -out file.pem -nodes
 355
 356 Print some info about a PKCS#12 file:
 357
 358  openssl pkcs12 -in file.p12 -info -noout
 359
 360 Create a PKCS#12 file:
 361
 362  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
 363
 364 Include some extra certificates:
 365
 366  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
 367   -certfile othercerts.pem
 368
 369 =head1 SEE ALSO
 370
 371 L<pkcs8(1)>
 372
 373 =head1 COPYRIGHT
 374
 375 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 376
 377 Licensed under the OpenSSL license (the "License").  You may not use
 378 this file except in compliance with the License.  You can obtain a copy
 379 in the file LICENSE in the source distribution or at
 380 L<https://www.openssl.org/source/license.html>.
 381
 382 =cut