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 file_or_id>]
  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 file_or_id>
 181
 182 File to read private key from. If not present then a private key must be present
 183 in the input file.
 184 If no engine is used, the argument is taken as a file; if an engine is
 185 specified, the argument is given to the engine as a key identifier.
 186
 187 =item B<-name friendlyname>
 188
 189 This specifies the "friendly name" for the certificate and private key. This
 190 name is typically displayed in list boxes by software importing the file.
 191
 192 =item B<-certfile filename>
 193
 194 A filename to read additional certificates from.
 195
 196 =item B<-caname friendlyname>
 197
 198 This specifies the "friendly name" for other certificates. This option may be
 199 used multiple times to specify names for all certificates in the order they
 200 appear. Netscape ignores friendly names on other certificates whereas MSIE
 201 displays them.
 202
 203 =item B<-pass arg>, B<-passout arg>
 204
 205 The PKCS#12 file (i.e. output file) password source. For more information about
 206 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
 207 L<openssl(1)>.
 208
 209 =item B<-passin password>
 210
 211 Pass phrase source to decrypt any input private keys with. For more information
 212 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
 213 L<openssl(1)>.
 214
 215 =item B<-chain>
 216
 217 If this option is present then an attempt is made to include the entire
 218 certificate chain of the user certificate. The standard CA store is used
 219 for this search. If the search fails it is considered a fatal error.
 220
 221 =item B<-descert>
 222
 223 Encrypt the certificate using triple DES, this may render the PKCS#12
 224 file unreadable by some "export grade" software. By default the private
 225 key is encrypted using triple DES and the certificate using 40 bit RC2.
 226
 227 =item B<-keypbe alg>, B<-certpbe alg>
 228
 229 These options allow the algorithm used to encrypt the private key and
 230 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
 231 can be used (see B<NOTES> section for more information). If a cipher name
 232 (as output by the B<list-cipher-algorithms> command is specified then it
 233 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
 234 use PKCS#12 algorithms.
 235
 236 =item B<-keyex|-keysig>
 237
 238 Specifies that the private key is to be used for key exchange or just signing.
 239 This option is only interpreted by MSIE and similar MS software. Normally
 240 "export grade" software will only allow 512 bit RSA keys to be used for
 241 encryption purposes but arbitrary length keys for signing. The B<-keysig>
 242 option marks the key for signing only. Signing only keys can be used for
 243 S/MIME signing, authenticode (ActiveX control signing)  and SSL client
 244 authentication, however due to a bug only MSIE 5.0 and later support
 245 the use of signing only keys for SSL client authentication.
 246
 247 =item B<-macalg digest>
 248
 249 Specify the MAC digest algorithm. If not included them SHA1 will be used.
 250
 251 =item B<-nomaciter>, B<-noiter>
 252
 253 These options affect the iteration counts on the MAC and key algorithms.
 254 Unless you wish to produce files compatible with MSIE 4.0 you should leave
 255 these options alone.
 256
 257 To discourage attacks by using large dictionaries of common passwords the
 258 algorithm that derives keys from passwords can have an iteration count applied
 259 to it: this causes a certain part of the algorithm to be repeated and slows it
 260 down. The MAC is used to check the file integrity but since it will normally
 261 have the same password as the keys and certificates it could also be attacked.
 262 By default both MAC and encryption iteration counts are set to 2048, using
 263 these options the MAC and encryption iteration counts can be set to 1, since
 264 this reduces the file security you should not use these options unless you
 265 really have to. Most software supports both MAC and key iteration counts.
 266 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
 267 option.
 268
 269 =item B<-maciter>
 270
 271 This option is included for compatibility with previous versions, it used
 272 to be needed to use MAC iterations counts but they are now used by default.
 273
 274 =item B<-nomac>
 275
 276 Don't attempt to provide the MAC integrity.
 277
 278 =item B<-rand file(s)>
 279
 280 A file or files containing random data used to seed the random number
 281 generator, or an EGD socket (see L<RAND_egd(3)>).
 282 Multiple files can be specified separated by an OS-dependent character.
 283 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 284 all others.
 285
 286 =item B<-CAfile file>
 287
 288 CA storage as a file.
 289
 290 =item B<-CApath dir>
 291
 292 CA storage as a directory. This directory must be a standard certificate
 293 directory: that is a hash of each subject name (using B<x509 -hash>) should be
 294 linked to each certificate.
 295
 296 =item B<-no-CAfile>
 297
 298 Do not load the trusted CA certificates from the default file location.
 299
 300 =item B<-no-CApath>
 301
 302 Do not load the trusted CA certificates from the default directory location.
 303
 304 =item B<-CSP name>
 305
 306 Write B<name> as a Microsoft CSP name.
 307
 308 =back
 309
 310 =head1 NOTES
 311
 312 Although there are a large number of options most of them are very rarely
 313 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
 314 for PKCS#12 file creation B<-export> and B<-name> are also used.
 315
 316 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
 317 then all certificates will be output in the order they appear in the input
 318 PKCS#12 files. There is no guarantee that the first certificate present is
 319 the one corresponding to the private key. Certain software which requires
 320 a private key and certificate and assumes the first certificate in the
 321 file is the one corresponding to the private key: this may not always
 322 be the case. Using the B<-clcerts> option will solve this problem by only
 323 outputting the certificate corresponding to the private key. If the CA
 324 certificates are required then they can be output to a separate file using
 325 the B<-nokeys -cacerts> options to just output CA certificates.
 326
 327 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
 328 algorithms for private keys and certificates to be specified. Normally
 329 the defaults are fine but occasionally software can't handle triple DES
 330 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
 331 be used to reduce the private key encryption to 40 bit RC2. A complete
 332 description of all algorithms is contained in the B<pkcs8> manual page.
 333
 334 Prior 1.1 release passwords containing non-ASCII characters were encoded
 335 in non-compliant manner, which limited interoperability, in first hand
 336 with Windows. But switching to standard-compliant password encoding
 337 poses problem accessing old data protected with broken encoding. For
 338 this reason even legacy encodings is attempted when reading the
 339 data. If you use PKCS#12 files in production application you are advised
 340 to convert the data, because implemented heuristic approach is not
 341 MT-safe, its sole goal is to facilitate the data upgrade with this
 342 utility.
 343
 344 =head1 EXAMPLES
 345
 346 Parse a PKCS#12 file and output it to a file:
 347
 348  openssl pkcs12 -in file.p12 -out file.pem
 349
 350 Output only client certificates to a file:
 351
 352  openssl pkcs12 -in file.p12 -clcerts -out file.pem
 353
 354 Don't encrypt the private key:
 355
 356  openssl pkcs12 -in file.p12 -out file.pem -nodes
 357
 358 Print some info about a PKCS#12 file:
 359
 360  openssl pkcs12 -in file.p12 -info -noout
 361
 362 Create a PKCS#12 file:
 363
 364  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
 365
 366 Include some extra certificates:
 367
 368  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
 369   -certfile othercerts.pem
 370
 371 =head1 SEE ALSO
 372
 373 L<pkcs8(1)>
 374
 375 =head1 COPYRIGHT
 376
 377 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 378
 379 Licensed under the OpenSSL license (the "License").  You may not use
 380 this file except in compliance with the License.  You can obtain a copy
 381 in the file LICENSE in the source distribution or at
 382 L<https://www.openssl.org/source/license.html>.
 383
 384 =cut