doc/man1/openssl-pkcs12.pod

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