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