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