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