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

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