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