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