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

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