doc/man1/openssl-pkcs12.pod.in

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