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

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