doc/apps/pkcs12.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 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 filename>]
  15 [B<-certfile filename>]
  16 [B<-name name>]
  17 [B<-caname name>]
  18 [B<-in filename>]
  19 [B<-out 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 | -des3 | -idea | -aes128 | -aes192 | -aes256 | -camellia128 | -camellia192 | -camellia256 | -nodes>]
  28 [B<-noiter>]
  29 [B<-maciter | -nomaciter | -nomac>]
  30 [B<-twopass>]
  31 [B<-descert>]
  32 [B<-certpbe cipher>]
  33 [B<-keypbe cipher>]
  34 [B<-macalg digest>]
  35 [B<-keyex>]
  36 [B<-keysig>]
  37 [B<-password arg>]
  38 [B<-passin arg>]
  39 [B<-passout arg>]
  40 [B<-rand file(s)>]
  41 [B<-CAfile file>]
  42 [B<-CApath dir>]
  43 [B<-no-CAfile>]
  44 [B<-no-CApath>]
  45 [B<-CSP name>]
  46
  47 =head1 DESCRIPTION
  48
  49 The B<pkcs12> 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 COMMAND 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 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 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<-passin arg>
  78
  79 the PKCS#12 file (i.e. input file) password source. For more information about
  80 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
  81 L<openssl(1)>.
  82
  83 =item B<-passout arg>
  84
  85 pass phrase source to encrypt any outputted private keys with. For more
  86 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
  87 in L<openssl(1)>.
  88
  89 =item B<-password arg>
  90
  91 With -export, -password is equivalent to -passout.
  92 Otherwise, -password is equivalent to -passin.
  93
  94 =item B<-noout>
  95
  96 this option inhibits output of the keys and certificates to the output file
  97 version of the PKCS#12 file.
  98
  99 =item B<-clcerts>
 100
 101 only output client certificates (not CA certificates).
 102
 103 =item B<-cacerts>
 104
 105 only output CA certificates (not client certificates).
 106
 107 =item B<-nocerts>
 108
 109 no certificates at all will be output.
 110
 111 =item B<-nokeys>
 112
 113 no private keys will be output.
 114
 115 =item B<-info>
 116
 117 output additional information about the PKCS#12 file structure, algorithms used and
 118 iteration counts.
 119
 120 =item B<-des>
 121
 122 use DES to encrypt private keys before outputting.
 123
 124 =item B<-des3>
 125
 126 use triple DES to encrypt private keys before outputting, this is the default.
 127
 128 =item B<-idea>
 129
 130 use IDEA to encrypt private keys before outputting.
 131
 132 =item B<-aes128>, B<-aes192>, B<-aes256>
 133
 134 use AES to encrypt private keys before outputting.
 135
 136 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
 137
 138 use Camellia to encrypt private keys before outputting.
 139
 140 =item B<-nodes>
 141
 142 don't encrypt the private keys at all.
 143
 144 =item B<-nomacver>
 145
 146 don't attempt to verify the integrity MAC before reading the file.
 147
 148 =item B<-twopass>
 149
 150 prompt for separate integrity and encryption passwords: most software
 151 always assumes these are the same so this option will render such
 152 PKCS#12 files unreadable.
 153
 154 =back
 155
 156 =head1 FILE CREATION OPTIONS
 157
 158 =over 4
 159
 160 =item B<-export>
 161
 162 This option specifies that a PKCS#12 file will be created rather than
 163 parsed.
 164
 165 =item B<-out filename>
 166
 167 This specifies filename to write the PKCS#12 file to. Standard output is used
 168 by default.
 169
 170 =item B<-in filename>
 171
 172 The filename to read certificates and private keys from, standard input by
 173 default.  They must all be in PEM format. The order doesn't matter but one
 174 private key and its corresponding certificate should be present. If additional
 175 certificates are present they will also be included in the PKCS#12 file.
 176
 177 =item B<-inkey filename>
 178
 179 file to read private key from. If not present then a private key must be present
 180 in the input file.
 181
 182 =item B<-name friendlyname>
 183
 184 This specifies the "friendly name" for the certificate and private key. This
 185 name is typically displayed in list boxes by software importing the file.
 186
 187 =item B<-certfile filename>
 188
 189 A filename to read additional certificates from.
 190
 191 =item B<-caname friendlyname>
 192
 193 This specifies the "friendly name" for other certificates. This option may be
 194 used multiple times to specify names for all certificates in the order they
 195 appear. Netscape ignores friendly names on other certificates whereas MSIE
 196 displays them.
 197
 198 =item B<-pass arg>, B<-passout arg>
 199
 200 the PKCS#12 file (i.e. output file) password source. For more information about
 201 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
 202 L<openssl(1)>.
 203
 204 =item B<-passin password>
 205
 206 pass phrase source to decrypt any input private keys with. For more information
 207 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
 208 L<openssl(1)>.
 209
 210 =item B<-chain>
 211
 212 if this option is present then an attempt is made to include the entire
 213 certificate chain of the user certificate. The standard CA store is used
 214 for this search. If the search fails it is considered a fatal error.
 215
 216 =item B<-descert>
 217
 218 encrypt the certificate using triple DES, this may render the PKCS#12
 219 file unreadable by some "export grade" software. By default the private
 220 key is encrypted using triple DES and the certificate using 40 bit RC2.
 221
 222 =item B<-keypbe alg>, B<-certpbe alg>
 223
 224 these options allow the algorithm used to encrypt the private key and
 225 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
 226 can be used (see B<NOTES> section for more information). If a cipher name
 227 (as output by the B<list-cipher-algorithms> command is specified then it
 228 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
 229 use PKCS#12 algorithms.
 230
 231 =item B<-keyex|-keysig>
 232
 233 specifies that the private key is to be used for key exchange or just signing.
 234 This option is only interpreted by MSIE and similar MS software. Normally
 235 "export grade" software will only allow 512 bit RSA keys to be used for
 236 encryption purposes but arbitrary length keys for signing. The B<-keysig>
 237 option marks the key for signing only. Signing only keys can be used for
 238 S/MIME signing, authenticode (ActiveX control signing)  and SSL client
 239 authentication, however due to a bug only MSIE 5.0 and later support
 240 the use of signing only keys for SSL client authentication.
 241
 242 =item B<-macalg digest>
 243
 244 specify the MAC digest algorithm. If not included them SHA1 will be used.
 245
 246 =item B<-nomaciter>, B<-noiter>
 247
 248 these options affect the iteration counts on the MAC and key algorithms.
 249 Unless you wish to produce files compatible with MSIE 4.0 you should leave
 250 these options alone.
 251
 252 To discourage attacks by using large dictionaries of common passwords the
 253 algorithm that derives keys from passwords can have an iteration count applied
 254 to it: this causes a certain part of the algorithm to be repeated and slows it
 255 down. The MAC is used to check the file integrity but since it will normally
 256 have the same password as the keys and certificates it could also be attacked.
 257 By default both MAC and encryption iteration counts are set to 2048, using
 258 these options the MAC and encryption iteration counts can be set to 1, since
 259 this reduces the file security you should not use these options unless you
 260 really have to. Most software supports both MAC and key iteration counts.
 261 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
 262 option.
 263
 264 =item B<-maciter>
 265
 266 This option is included for compatibility with previous versions, it used
 267 to be needed to use MAC iterations counts but they are now used by default.
 268
 269 =item B<-nomac>
 270
 271 don't attempt to provide the MAC integrity.
 272
 273 =item B<-rand file(s)>
 274
 275 a file or files containing random data used to seed the random number
 276 generator, or an EGD socket (see L<RAND_egd(3)>).
 277 Multiple files can be specified separated by an OS-dependent character.
 278 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 279 all others.
 280
 281 =item B<-CAfile file>
 282
 283 CA storage as a file.
 284
 285 =item B<-CApath dir>
 286
 287 CA storage as a directory. This directory must be a standard certificate
 288 directory: that is a hash of each subject name (using B<x509 -hash>) should be
 289 linked to each certificate.
 290
 291 =item B<-no-CAfile>
 292
 293 Do not load the trusted CA certificates from the default file location
 294
 295 =item B<-no-CApath>
 296
 297 Do not load the trusted CA certificates from the default directory location
 298
 299 =item B<-CSP name>
 300
 301 write B<name> as a Microsoft CSP name.
 302
 303 =back
 304
 305 =head1 NOTES
 306
 307 Although there are a large number of options most of them are very rarely
 308 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
 309 for PKCS#12 file creation B<-export> and B<-name> are also used.
 310
 311 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
 312 then all certificates will be output in the order they appear in the input
 313 PKCS#12 files. There is no guarantee that the first certificate present is
 314 the one corresponding to the private key. Certain software which requires
 315 a private key and certificate and assumes the first certificate in the
 316 file is the one corresponding to the private key: this may not always
 317 be the case. Using the B<-clcerts> option will solve this problem by only
 318 outputting the certificate corresponding to the private key. If the CA
 319 certificates are required then they can be output to a separate file using
 320 the B<-nokeys -cacerts> options to just output CA certificates.
 321
 322 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
 323 algorithms for private keys and certificates to be specified. Normally
 324 the defaults are fine but occasionally software can't handle triple DES
 325 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
 326 be used to reduce the private key encryption to 40 bit RC2. A complete
 327 description of all algorithms is contained in the B<pkcs8> manual page.
 328
 329 =head1 EXAMPLES
 330
 331 Parse a PKCS#12 file and output it to a file:
 332
 333  openssl pkcs12 -in file.p12 -out file.pem
 334
 335 Output only client certificates to a file:
 336
 337  openssl pkcs12 -in file.p12 -clcerts -out file.pem
 338
 339 Don't encrypt the private key:
 340
 341  openssl pkcs12 -in file.p12 -out file.pem -nodes
 342
 343 Print some info about a PKCS#12 file:
 344
 345  openssl pkcs12 -in file.p12 -info -noout
 346
 347 Create a PKCS#12 file:
 348
 349  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
 350
 351 Include some extra certificates:
 352
 353  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
 354   -certfile othercerts.pem
 355
 356 =head1 SEE ALSO
 357
 358 L<pkcs8(1)>
 359
 360 =cut
 361
 362 =head1 COPYRIGHT
 363
 364 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 365
 366 Licensed under the OpenSSL license (the "License").  You may not use
 367 this file except in compliance with the License.  You can obtain a copy
 368 in the file LICENSE in the source distribution or at
 369 L<https://www.openssl.org/source/license.html>.
 370
 371 =cut