doc/man1/openssl-pkcs12.pod.in

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