openssl: Adjust manual pages for 1.0.1o.
[dragonfly.git] / secure / usr.bin / openssl / man / pkcs12.1
1 .\" Automatically generated by Pod::Man 2.27 (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-06-12" "1.0.1o" "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 | \-des3 | \-idea | \-aes128 | \-aes192 | \-aes256 | \-camellia128 | \-camellia192 | \-camellia256 | \-nodes\fR]
162 [\fB\-noiter\fR]
163 [\fB\-maciter | \-nomaciter | \-nomac\fR]
164 [\fB\-twopass\fR]
165 [\fB\-descert\fR]
166 [\fB\-certpbe cipher\fR]
167 [\fB\-keypbe cipher\fR]
168 [\fB\-macalg digest\fR]
169 [\fB\-keyex\fR]
170 [\fB\-keysig\fR]
171 [\fB\-password arg\fR]
172 [\fB\-passin arg\fR]
173 [\fB\-passout arg\fR]
174 [\fB\-rand file(s)\fR]
175 [\fB\-CAfile file\fR]
176 [\fB\-CApath dir\fR]
177 [\fB\-CSP name\fR]
178 .SH "DESCRIPTION"
179 .IX Header "DESCRIPTION"
180 The \fBpkcs12\fR command allows PKCS#12 files (sometimes referred to as
181 \&\s-1PFX\s0 files) to be created and parsed. PKCS#12 files are used by several
182 programs including Netscape, \s-1MSIE\s0 and \s-1MS\s0 Outlook.
183 .SH "COMMAND OPTIONS"
184 .IX Header "COMMAND OPTIONS"
185 There are a lot of options the meaning of some depends of whether a PKCS#12 file
186 is being created or parsed. By default a PKCS#12 file is parsed. A PKCS#12
187 file can be created by using the \fB\-export\fR option (see below).
188 .SH "PARSING OPTIONS"
189 .IX Header "PARSING OPTIONS"
190 .IP "\fB\-in filename\fR" 4
191 .IX Item "-in filename"
192 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
193 by default.
194 .IP "\fB\-out filename\fR" 4
195 .IX Item "-out filename"
196 The filename to write certificates and private keys to, standard output by
197 default.  They are all written in \s-1PEM\s0 format.
198 .IP "\fB\-passin arg\fR" 4
199 .IX Item "-passin arg"
200 the PKCS#12 file (i.e. input file) password source. For more information about
201 the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
202 \&\fIopenssl\fR\|(1).
203 .IP "\fB\-passout arg\fR" 4
204 .IX Item "-passout arg"
205 pass phrase source to encrypt any outputted private keys with. For more
206 information about the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section
207 in \fIopenssl\fR\|(1).
208 .IP "\fB\-password arg\fR" 4
209 .IX Item "-password arg"
210 With \-export, \-password is equivalent to \-passout.
211 Otherwise, \-password is equivalent to \-passin.
212 .IP "\fB\-noout\fR" 4
213 .IX Item "-noout"
214 this option inhibits output of the keys and certificates to the output file
215 version of the PKCS#12 file.
216 .IP "\fB\-clcerts\fR" 4
217 .IX Item "-clcerts"
218 only output client certificates (not \s-1CA\s0 certificates).
219 .IP "\fB\-cacerts\fR" 4
220 .IX Item "-cacerts"
221 only output \s-1CA\s0 certificates (not client certificates).
222 .IP "\fB\-nocerts\fR" 4
223 .IX Item "-nocerts"
224 no certificates at all will be output.
225 .IP "\fB\-nokeys\fR" 4
226 .IX Item "-nokeys"
227 no private keys will be output.
228 .IP "\fB\-info\fR" 4
229 .IX Item "-info"
230 output additional information about the PKCS#12 file structure, algorithms used and
231 iteration counts.
232 .IP "\fB\-des\fR" 4
233 .IX Item "-des"
234 use \s-1DES\s0 to encrypt private keys before outputting.
235 .IP "\fB\-des3\fR" 4
236 .IX Item "-des3"
237 use triple \s-1DES\s0 to encrypt private keys before outputting, this is the default.
238 .IP "\fB\-idea\fR" 4
239 .IX Item "-idea"
240 use \s-1IDEA\s0 to encrypt private keys before outputting.
241 .IP "\fB\-aes128\fR, \fB\-aes192\fR, \fB\-aes256\fR" 4
242 .IX Item "-aes128, -aes192, -aes256"
243 use \s-1AES\s0 to encrypt private keys before outputting.
244 .IP "\fB\-camellia128\fR, \fB\-camellia192\fR, \fB\-camellia256\fR" 4
245 .IX Item "-camellia128, -camellia192, -camellia256"
246 use Camellia to encrypt private keys before outputting.
247 .IP "\fB\-nodes\fR" 4
248 .IX Item "-nodes"
249 don't encrypt the private keys at all.
250 .IP "\fB\-nomacver\fR" 4
251 .IX Item "-nomacver"
252 don't attempt to verify the integrity \s-1MAC\s0 before reading the file.
253 .IP "\fB\-twopass\fR" 4
254 .IX Item "-twopass"
255 prompt for separate integrity and encryption passwords: most software
256 always assumes these are the same so this option will render such
257 PKCS#12 files unreadable.
258 .SH "FILE CREATION OPTIONS"
259 .IX Header "FILE CREATION OPTIONS"
260 .IP "\fB\-export\fR" 4
261 .IX Item "-export"
262 This option specifies that a PKCS#12 file will be created rather than
263 parsed.
264 .IP "\fB\-out filename\fR" 4
265 .IX Item "-out filename"
266 This specifies filename to write the PKCS#12 file to. Standard output is used
267 by default.
268 .IP "\fB\-in filename\fR" 4
269 .IX Item "-in filename"
270 The filename to read certificates and private keys from, standard input by
271 default.  They must all be in \s-1PEM\s0 format. The order doesn't matter but one
272 private key and its corresponding certificate should be present. If additional
273 certificates are present they will also be included in the PKCS#12 file.
274 .IP "\fB\-inkey filename\fR" 4
275 .IX Item "-inkey filename"
276 file to read private key from. If not present then a private key must be present
277 in the input file.
278 .IP "\fB\-name friendlyname\fR" 4
279 .IX Item "-name friendlyname"
280 This specifies the \*(L"friendly name\*(R" for the certificate and private key. This
281 name is typically displayed in list boxes by software importing the file.
282 .IP "\fB\-certfile filename\fR" 4
283 .IX Item "-certfile filename"
284 A filename to read additional certificates from.
285 .IP "\fB\-caname friendlyname\fR" 4
286 .IX Item "-caname friendlyname"
287 This specifies the \*(L"friendly name\*(R" for other certificates. This option may be
288 used multiple times to specify names for all certificates in the order they
289 appear. Netscape ignores friendly names on other certificates whereas \s-1MSIE\s0
290 displays them.
291 .IP "\fB\-pass arg\fR, \fB\-passout arg\fR" 4
292 .IX Item "-pass arg, -passout arg"
293 the PKCS#12 file (i.e. output file) password source. For more information about
294 the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
295 \&\fIopenssl\fR\|(1).
296 .IP "\fB\-passin password\fR" 4
297 .IX Item "-passin password"
298 pass phrase source to decrypt any input private keys with. For more information
299 about the format of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in
300 \&\fIopenssl\fR\|(1).
301 .IP "\fB\-chain\fR" 4
302 .IX Item "-chain"
303 if this option is present then an attempt is made to include the entire
304 certificate chain of the user certificate. The standard \s-1CA\s0 store is used
305 for this search. If the search fails it is considered a fatal error.
306 .IP "\fB\-descert\fR" 4
307 .IX Item "-descert"
308 encrypt the certificate using triple \s-1DES,\s0 this may render the PKCS#12
309 file unreadable by some \*(L"export grade\*(R" software. By default the private
310 key is encrypted using triple \s-1DES\s0 and the certificate using 40 bit \s-1RC2.\s0
311 .IP "\fB\-keypbe alg\fR, \fB\-certpbe alg\fR" 4
312 .IX Item "-keypbe alg, -certpbe alg"
313 these options allow the algorithm used to encrypt the private key and
314 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 \s-1PBE\s0 algorithm name
315 can be used (see \fB\s-1NOTES\s0\fR section for more information). If a a cipher name
316 (as output by the \fBlist-cipher-algorithms\fR command is specified then it
317 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
318 use PKCS#12 algorithms.
319 .IP "\fB\-keyex|\-keysig\fR" 4
320 .IX Item "-keyex|-keysig"
321 specifies that the private key is to be used for key exchange or just signing.
322 This option is only interpreted by \s-1MSIE\s0 and similar \s-1MS\s0 software. Normally
323 \&\*(L"export grade\*(R" software will only allow 512 bit \s-1RSA\s0 keys to be used for
324 encryption purposes but arbitrary length keys for signing. The \fB\-keysig\fR
325 option marks the key for signing only. Signing only keys can be used for
326 S/MIME signing, authenticode (ActiveX control signing)  and \s-1SSL\s0 client
327 authentication, however due to a bug only \s-1MSIE 5.0\s0 and later support
328 the use of signing only keys for \s-1SSL\s0 client authentication.
329 .IP "\fB\-macalg digest\fR" 4
330 .IX Item "-macalg digest"
331 specify the \s-1MAC\s0 digest algorithm. If not included them \s-1SHA1\s0 will be used.
332 .IP "\fB\-nomaciter\fR, \fB\-noiter\fR" 4
333 .IX Item "-nomaciter, -noiter"
334 these options affect the iteration counts on the \s-1MAC\s0 and key algorithms.
335 Unless you wish to produce files compatible with \s-1MSIE 4.0\s0 you should leave
336 these options alone.
337 .Sp
338 To discourage attacks by using large dictionaries of common passwords the
339 algorithm that derives keys from passwords can have an iteration count applied
340 to it: this causes a certain part of the algorithm to be repeated and slows it
341 down. The \s-1MAC\s0 is used to check the file integrity but since it will normally
342 have the same password as the keys and certificates it could also be attacked.
343 By default both \s-1MAC\s0 and encryption iteration counts are set to 2048, using
344 these options the \s-1MAC\s0 and encryption iteration counts can be set to 1, since
345 this reduces the file security you should not use these options unless you
346 really have to. Most software supports both \s-1MAC\s0 and key iteration counts.
347 \&\s-1MSIE 4.0\s0 doesn't support \s-1MAC\s0 iteration counts so it needs the \fB\-nomaciter\fR
348 option.
349 .IP "\fB\-maciter\fR" 4
350 .IX Item "-maciter"
351 This option is included for compatibility with previous versions, it used
352 to be needed to use \s-1MAC\s0 iterations counts but they are now used by default.
353 .IP "\fB\-nomac\fR" 4
354 .IX Item "-nomac"
355 don't attempt to provide the \s-1MAC\s0 integrity.
356 .IP "\fB\-rand file(s)\fR" 4
357 .IX Item "-rand file(s)"
358 a file or files containing random data used to seed the random number
359 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
360 Multiple files can be specified separated by a OS-dependent character.
361 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
362 all others.
363 .IP "\fB\-CAfile file\fR" 4
364 .IX Item "-CAfile file"
365 \&\s-1CA\s0 storage as a file.
366 .IP "\fB\-CApath dir\fR" 4
367 .IX Item "-CApath dir"
368 \&\s-1CA\s0 storage as a directory. This directory must be a standard certificate
369 directory: that is a hash of each subject name (using \fBx509 \-hash\fR) should be
370 linked to each certificate.
371 .IP "\fB\-CSP name\fR" 4
372 .IX Item "-CSP name"
373 write \fBname\fR as a Microsoft \s-1CSP\s0 name.
374 .SH "NOTES"
375 .IX Header "NOTES"
376 Although there are a large number of options most of them are very rarely
377 used. For PKCS#12 file parsing only \fB\-in\fR and \fB\-out\fR need to be used
378 for PKCS#12 file creation \fB\-export\fR and \fB\-name\fR are also used.
379 .PP
380 If none of the \fB\-clcerts\fR, \fB\-cacerts\fR or \fB\-nocerts\fR options are present
381 then all certificates will be output in the order they appear in the input
382 PKCS#12 files. There is no guarantee that the first certificate present is
383 the one corresponding to the private key. Certain software which requires
384 a private key and certificate and assumes the first certificate in the
385 file is the one corresponding to the private key: this may not always
386 be the case. Using the \fB\-clcerts\fR option will solve this problem by only
387 outputting the certificate corresponding to the private key. If the \s-1CA\s0
388 certificates are required then they can be output to a separate file using
389 the \fB\-nokeys \-cacerts\fR options to just output \s-1CA\s0 certificates.
390 .PP
391 The \fB\-keypbe\fR and \fB\-certpbe\fR algorithms allow the precise encryption
392 algorithms for private keys and certificates to be specified. Normally
393 the defaults are fine but occasionally software can't handle triple \s-1DES\s0
394 encrypted private keys, then the option \fB\-keypbe \s-1PBE\-SHA1\-RC2\-40\s0\fR can
395 be used to reduce the private key encryption to 40 bit \s-1RC2. A\s0 complete
396 description of all algorithms is contained in the \fBpkcs8\fR manual page.
397 .SH "EXAMPLES"
398 .IX Header "EXAMPLES"
399 Parse a PKCS#12 file and output it to a file:
400 .PP
401 .Vb 1
402 \& openssl pkcs12 \-in file.p12 \-out file.pem
403 .Ve
404 .PP
405 Output only client certificates to a file:
406 .PP
407 .Vb 1
408 \& openssl pkcs12 \-in file.p12 \-clcerts \-out file.pem
409 .Ve
410 .PP
411 Don't encrypt the private key:
412 .PP
413 .Vb 1
414 \& openssl pkcs12 \-in file.p12 \-out file.pem \-nodes
415 .Ve
416 .PP
417 Print some info about a PKCS#12 file:
418 .PP
419 .Vb 1
420 \& openssl pkcs12 \-in file.p12 \-info \-noout
421 .Ve
422 .PP
423 Create a PKCS#12 file:
424 .PP
425 .Vb 1
426 \& openssl pkcs12 \-export \-in file.pem \-out file.p12 \-name "My Certificate"
427 .Ve
428 .PP
429 Include some extra certificates:
430 .PP
431 .Vb 2
432 \& openssl pkcs12 \-export \-in file.pem \-out file.p12 \-name "My Certificate" \e
433 \&  \-certfile othercerts.pem
434 .Ve
435 .SH "BUGS"
436 .IX Header "BUGS"
437 Some would argue that the PKCS#12 standard is one big bug :\-)
438 .PP
439 Versions of OpenSSL before 0.9.6a had a bug in the PKCS#12 key generation
440 routines. Under rare circumstances this could produce a PKCS#12 file encrypted
441 with an invalid key. As a result some PKCS#12 files which triggered this bug
442 from other implementations (\s-1MSIE\s0 or Netscape) could not be decrypted
443 by OpenSSL and similarly OpenSSL could produce PKCS#12 files which could
444 not be decrypted by other implementations. The chances of producing such
445 a file are relatively small: less than 1 in 256.
446 .PP
447 A side effect of fixing this bug is that any old invalidly encrypted PKCS#12
448 files cannot no longer be parsed by the fixed version. Under such circumstances
449 the \fBpkcs12\fR utility will report that the \s-1MAC\s0 is \s-1OK\s0 but fail with a decryption
450 error when extracting private keys.
451 .PP
452 This problem can be resolved by extracting the private keys and certificates
453 from the PKCS#12 file using an older version of OpenSSL and recreating the PKCS#12
454 file from the keys and certificates using a newer version of OpenSSL. For example:
455 .PP
456 .Vb 2
457 \& old\-openssl \-in bad.p12 \-out keycerts.pem
458 \& openssl \-in keycerts.pem \-export \-name "My PKCS#12 file" \-out fixed.p12
459 .Ve
460 .SH "SEE ALSO"
461 .IX Header "SEE ALSO"
462 \&\fIpkcs8\fR\|(1)