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