secure/usr.bin/openssl/man/pkcs12.1

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "PKCS12 1"
 136 .TH PKCS12 1 "2015-12-03" "0.9.8zh" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 pkcs12 \- PKCS#12 file utility
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBpkcs12\fR
 146 [\fB\-export\fR]
 147 [\fB\-chain\fR]
 148 [\fB\-inkey filename\fR]
 149 [\fB\-certfile filename\fR]
 150 [\fB\-name name\fR]
 151 [\fB\-caname name\fR]
 152 [\fB\-in filename\fR]
 153 [\fB\-out filename\fR]
 154 [\fB\-noout\fR]
 155 [\fB\-nomacver\fR]
 156 [\fB\-nocerts\fR]
 157 [\fB\-clcerts\fR]
 158 [\fB\-cacerts\fR]
 159 [\fB\-nokeys\fR]
 160 [\fB\-info\fR]
 161 [\fB\-des\fR]
 162 [\fB\-des3\fR]
 163 [\fB\-idea\fR]
 164 [\fB\-nodes\fR]
 165 [\fB\-noiter\fR]
 166 [\fB\-maciter\fR]
 167 [\fB\-twopass\fR]
 168 [\fB\-descert\fR]
 169 [\fB\-certpbe\fR]
 170 [\fB\-keypbe\fR]
 171 [\fB\-keyex\fR]
 172 [\fB\-keysig\fR]
 173 [\fB\-password arg\fR]
 174 [\fB\-passin arg\fR]
 175 [\fB\-passout arg\fR]
 176 [\fB\-rand file(s)\fR]
 177 .SH "DESCRIPTION"
 178 .IX Header "DESCRIPTION"
 179 The \fBpkcs12\fR command allows PKCS#12 files (sometimes referred to as
 180 \&\s-1PFX\s0 files) to be created and parsed. PKCS#12 files are used by several
 181 programs including Netscape, \s-1MSIE\s0 and \s-1MS\s0 Outlook.
 182 .SH "COMMAND OPTIONS"
 183 .IX Header "COMMAND OPTIONS"
 184 There are a lot of options the meaning of some depends of whether a PKCS#12 file
 185 is being created or parsed. By default a PKCS#12 file is parsed a PKCS#12
 186 file can be created by using the \fB\-export\fR option (see below).
 187 .SH "PARSING OPTIONS"
 188 .IX Header "PARSING OPTIONS"
 189 .IP "\fB\-in filename\fR" 4
 190 .IX Item "-in filename"
 191 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
 192 by default.
 193 .IP "\fB\-out filename\fR" 4
 194 .IX Item "-out filename"
 195 The filename to write certificates and private keys to, standard output by default.
 196 They are all written in \s-1PEM\s0 format.
 197 .IP "\fB\-pass arg\fR, \fB\-passin arg\fR" 4
 198 .IX Item "-pass arg, -passin arg"
 199 the PKCS#12 file (i.e. input file) password source. For more information about the
 200 format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
 201 \&\fIopenssl\fR\|(1).
 202 .IP "\fB\-passout arg\fR" 4
 203 .IX Item "-passout arg"
 204 pass phrase source to encrypt any outputed private keys with. For more information
 205 about the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
 206 \&\fIopenssl\fR\|(1).
 207 .IP "\fB\-noout\fR" 4
 208 .IX Item "-noout"
 209 this option inhibits output of the keys and certificates to the output file version
 210 of the PKCS#12 file.
 211 .IP "\fB\-clcerts\fR" 4
 212 .IX Item "-clcerts"
 213 only output client certificates (not \s-1CA\s0 certificates).
 214 .IP "\fB\-cacerts\fR" 4
 215 .IX Item "-cacerts"
 216 only output \s-1CA\s0 certificates (not client certificates).
 217 .IP "\fB\-nocerts\fR" 4
 218 .IX Item "-nocerts"
 219 no certificates at all will be output.
 220 .IP "\fB\-nokeys\fR" 4
 221 .IX Item "-nokeys"
 222 no private keys will be output.
 223 .IP "\fB\-info\fR" 4
 224 .IX Item "-info"
 225 output additional information about the PKCS#12 file structure, algorithms used and
 226 iteration counts.
 227 .IP "\fB\-des\fR" 4
 228 .IX Item "-des"
 229 use \s-1DES\s0 to encrypt private keys before outputting.
 230 .IP "\fB\-des3\fR" 4
 231 .IX Item "-des3"
 232 use triple \s-1DES\s0 to encrypt private keys before outputting, this is the default.
 233 .IP "\fB\-idea\fR" 4
 234 .IX Item "-idea"
 235 use \s-1IDEA\s0 to encrypt private keys before outputting.
 236 .IP "\fB\-nodes\fR" 4
 237 .IX Item "-nodes"
 238 don't encrypt the private keys at all.
 239 .IP "\fB\-nomacver\fR" 4
 240 .IX Item "-nomacver"
 241 don't attempt to verify the integrity \s-1MAC\s0 before reading the file.
 242 .IP "\fB\-twopass\fR" 4
 243 .IX Item "-twopass"
 244 prompt for separate integrity and encryption passwords: most software
 245 always assumes these are the same so this option will render such
 246 PKCS#12 files unreadable.
 247 .SH "FILE CREATION OPTIONS"
 248 .IX Header "FILE CREATION OPTIONS"
 249 .IP "\fB\-export\fR" 4
 250 .IX Item "-export"
 251 This option specifies that a PKCS#12 file will be created rather than
 252 parsed.
 253 .IP "\fB\-out filename\fR" 4
 254 .IX Item "-out filename"
 255 This specifies filename to write the PKCS#12 file to. Standard output is used
 256 by default.
 257 .IP "\fB\-in filename\fR" 4
 258 .IX Item "-in filename"
 259 The filename to read certificates and private keys from, standard input by default.
 260 They must all be in \s-1PEM\s0 format. The order doesn't matter but one private key and
 261 its corresponding certificate should be present. If additional certificates are
 262 present they will also be included in the PKCS#12 file.
 263 .IP "\fB\-inkey filename\fR" 4
 264 .IX Item "-inkey filename"
 265 file to read private key from. If not present then a private key must be present
 266 in the input file.
 267 .IP "\fB\-name friendlyname\fR" 4
 268 .IX Item "-name friendlyname"
 269 This specifies the \*(L"friendly name\*(R" for the certificate and private key. This name
 270 is typically displayed in list boxes by software importing the file.
 271 .IP "\fB\-certfile filename\fR" 4
 272 .IX Item "-certfile filename"
 273 A filename to read additional certificates from.
 274 .IP "\fB\-caname friendlyname\fR" 4
 275 .IX Item "-caname friendlyname"
 276 This specifies the \*(L"friendly name\*(R" for other certificates. This option may be
 277 used multiple times to specify names for all certificates in the order they
 278 appear. Netscape ignores friendly names on other certificates whereas \s-1MSIE\s0
 279 displays them.
 280 .IP "\fB\-pass arg\fR, \fB\-passout arg\fR" 4
 281 .IX Item "-pass arg, -passout arg"
 282 the PKCS#12 file (i.e. output file) password source. For more information about
 283 the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
 284 \&\fIopenssl\fR\|(1).
 285 .IP "\fB\-passin password\fR" 4
 286 .IX Item "-passin password"
 287 pass phrase source to decrypt any input private keys with. For more information
 288 about the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
 289 \&\fIopenssl\fR\|(1).
 290 .IP "\fB\-chain\fR" 4
 291 .IX Item "-chain"
 292 if this option is present then an attempt is made to include the entire
 293 certificate chain of the user certificate. The standard \s-1CA\s0 store is used
 294 for this search. If the search fails it is considered a fatal error.
 295 .IP "\fB\-descert\fR" 4
 296 .IX Item "-descert"
 297 encrypt the certificate using triple \s-1DES,\s0 this may render the PKCS#12
 298 file unreadable by some \*(L"export grade\*(R" software. By default the private
 299 key is encrypted using triple \s-1DES\s0 and the certificate using 40 bit \s-1RC2.\s0
 300 .IP "\fB\-keypbe alg\fR, \fB\-certpbe alg\fR" 4
 301 .IX Item "-keypbe alg, -certpbe alg"
 302 these options allow the algorithm used to encrypt the private key and
 303 certificates to be selected. Although any PKCS#5 v1.5 or PKCS#12 algorithms
 304 can be selected it is advisable only to use PKCS#12 algorithms. See the list
 305 in the \fB\s-1NOTES\s0\fR section for more information.
 306 .IP "\fB\-keyex|\-keysig\fR" 4
 307 .IX Item "-keyex|-keysig"
 308 specifies that the private key is to be used for key exchange or just signing.
 309 This option is only interpreted by \s-1MSIE\s0 and similar \s-1MS\s0 software. Normally
 310 \&\*(L"export grade\*(R" software will only allow 512 bit \s-1RSA\s0 keys to be used for
 311 encryption purposes but arbitrary length keys for signing. The \fB\-keysig\fR
 312 option marks the key for signing only. Signing only keys can be used for
 313 S/MIME signing, authenticode (ActiveX control signing)  and \s-1SSL\s0 client
 314 authentication, however due to a bug only \s-1MSIE 5.0\s0 and later support
 315 the use of signing only keys for \s-1SSL\s0 client authentication.
 316 .IP "\fB\-nomaciter\fR, \fB\-noiter\fR" 4
 317 .IX Item "-nomaciter, -noiter"
 318 these options affect the iteration counts on the \s-1MAC\s0 and key algorithms.
 319 Unless you wish to produce files compatible with \s-1MSIE 4.0\s0 you should leave
 320 these options alone.
 321 .Sp
 322 To discourage attacks by using large dictionaries of common passwords the
 323 algorithm that derives keys from passwords can have an iteration count applied
 324 to it: this causes a certain part of the algorithm to be repeated and slows it
 325 down. The \s-1MAC\s0 is used to check the file integrity but since it will normally
 326 have the same password as the keys and certificates it could also be attacked.
 327 By default both \s-1MAC\s0 and encryption iteration counts are set to 2048, using
 328 these options the \s-1MAC\s0 and encryption iteration counts can be set to 1, since
 329 this reduces the file security you should not use these options unless you
 330 really have to. Most software supports both \s-1MAC\s0 and key iteration counts.
 331 \&\s-1MSIE 4.0\s0 doesn't support \s-1MAC\s0 iteration counts so it needs the \fB\-nomaciter\fR
 332 option.
 333 .IP "\fB\-maciter\fR" 4
 334 .IX Item "-maciter"
 335 This option is included for compatibility with previous versions, it used
 336 to be needed to use \s-1MAC\s0 iterations counts but they are now used by default.
 337 .IP "\fB\-rand file(s)\fR" 4
 338 .IX Item "-rand file(s)"
 339 a file or files containing random data used to seed the random number
 340 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 341 Multiple files can be specified separated by a OS-dependent character.
 342 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 343 all others.
 344 .SH "NOTES"
 345 .IX Header "NOTES"
 346 Although there are a large number of options most of them are very rarely
 347 used. For PKCS#12 file parsing only \fB\-in\fR and \fB\-out\fR need to be used
 348 for PKCS#12 file creation \fB\-export\fR and \fB\-name\fR are also used.
 349 .PP
 350 If none of the \fB\-clcerts\fR, \fB\-cacerts\fR or \fB\-nocerts\fR options are present
 351 then all certificates will be output in the order they appear in the input
 352 PKCS#12 files. There is no guarantee that the first certificate present is
 353 the one corresponding to the private key. Certain software which requires
 354 a private key and certificate and assumes the first certificate in the
 355 file is the one corresponding to the private key: this may not always
 356 be the case. Using the \fB\-clcerts\fR option will solve this problem by only
 357 outputting the certificate corresponding to the private key. If the \s-1CA\s0
 358 certificates are required then they can be output to a separate file using
 359 the \fB\-nokeys \-cacerts\fR options to just output \s-1CA\s0 certificates.
 360 .PP
 361 The \fB\-keypbe\fR and \fB\-certpbe\fR algorithms allow the precise encryption
 362 algorithms for private keys and certificates to be specified. Normally
 363 the defaults are fine but occasionally software can't handle triple \s-1DES\s0
 364 encrypted private keys, then the option \fB\-keypbe \s-1PBE\-SHA1\-RC2\-40\s0\fR can
 365 be used to reduce the private key encryption to 40 bit \s-1RC2. A\s0 complete
 366 description of all algorithms is contained in the \fBpkcs8\fR manual page.
 367 .SH "EXAMPLES"
 368 .IX Header "EXAMPLES"
 369 Parse a PKCS#12 file and output it to a file:
 370 .PP
 371 .Vb 1
 372 \& openssl pkcs12 \-in file.p12 \-out file.pem
 373 .Ve
 374 .PP
 375 Output only client certificates to a file:
 376 .PP
 377 .Vb 1
 378 \& openssl pkcs12 \-in file.p12 \-clcerts \-out file.pem
 379 .Ve
 380 .PP
 381 Don't encrypt the private key:
 382 .PP
 383 .Vb 1
 384 \& openssl pkcs12 \-in file.p12 \-out file.pem \-nodes
 385 .Ve
 386 .PP
 387 Print some info about a PKCS#12 file:
 388 .PP
 389 .Vb 1
 390 \& openssl pkcs12 \-in file.p12 \-info \-noout
 391 .Ve
 392 .PP
 393 Create a PKCS#12 file:
 394 .PP
 395 .Vb 1
 396 \& openssl pkcs12 \-export \-in file.pem \-out file.p12 \-name "My Certificate"
 397 .Ve
 398 .PP
 399 Include some extra certificates:
 400 .PP
 401 .Vb 2
 402 \& openssl pkcs12 \-export \-in file.pem \-out file.p12 \-name "My Certificate" \e
 403 \&  \-certfile othercerts.pem
 404 .Ve
 405 .SH "BUGS"
 406 .IX Header "BUGS"
 407 Some would argue that the PKCS#12 standard is one big bug :\-)
 408 .PP
 409 Versions of OpenSSL before 0.9.6a had a bug in the PKCS#12 key generation
 410 routines. Under rare circumstances this could produce a PKCS#12 file encrypted
 411 with an invalid key. As a result some PKCS#12 files which triggered this bug
 412 from other implementations (\s-1MSIE\s0 or Netscape) could not be decrypted
 413 by OpenSSL and similarly OpenSSL could produce PKCS#12 files which could
 414 not be decrypted by other implementations. The chances of producing such
 415 a file are relatively small: less than 1 in 256.
 416 .PP
 417 A side effect of fixing this bug is that any old invalidly encrypted PKCS#12
 418 files cannot no longer be parsed by the fixed version. Under such circumstances
 419 the \fBpkcs12\fR utility will report that the \s-1MAC\s0 is \s-1OK\s0 but fail with a decryption
 420 error when extracting private keys.
 421 .PP
 422 This problem can be resolved by extracting the private keys and certificates
 423 from the PKCS#12 file using an older version of OpenSSL and recreating the PKCS#12
 424 file from the keys and certificates using a newer version of OpenSSL. For example:
 425 .PP
 426 .Vb 2
 427 \& old\-openssl \-in bad.p12 \-out keycerts.pem
 428 \& openssl \-in keycerts.pem \-export \-name "My PKCS#12 file" \-out fixed.p12
 429 .Ve
 430 .SH "SEE ALSO"
 431 .IX Header "SEE ALSO"
 432 \&\fIpkcs8\fR\|(1)