3389e595fed7567cc8a3c836f9ca597acfd80a8e
[openssl.git] / doc / man1 / pkcs12.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-pkcs12,
6 pkcs12 - PKCS#12 file utility
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<pkcs12>
11 [B<-help>]
12 [B<-export>]
13 [B<-chain>]
14 [B<-inkey file_or_id>]
15 [B<-certfile filename>]
16 [B<-name name>]
17 [B<-caname name>]
18 [B<-in filename>]
19 [B<-out filename>]
20 [B<-noout>]
21 [B<-nomacver>]
22 [B<-nocerts>]
23 [B<-clcerts>]
24 [B<-cacerts>]
25 [B<-nokeys>]
26 [B<-info>]
27 [B<-des | -des3 | -idea | -aes128 | -aes192 | -aes256 | -aria128 | -aria192 | -aria256 | -camellia128 | -camellia192 | -camellia256 | -nodes>]
28 [B<-noiter>]
29 [B<-maciter | -nomaciter | -nomac>]
30 [B<-twopass>]
31 [B<-descert>]
32 [B<-certpbe cipher>]
33 [B<-keypbe cipher>]
34 [B<-macalg digest>]
35 [B<-keyex>]
36 [B<-keysig>]
37 [B<-password arg>]
38 [B<-passin arg>]
39 [B<-passout arg>]
40 [B<-rand file...>]
41 [B<-writerand file>]
42 [B<-CAfile file>]
43 [B<-CApath dir>]
44 [B<-no-CAfile>]
45 [B<-no-CApath>]
46 [B<-CSP name>]
47
48 =head1 DESCRIPTION
49
50 The B<pkcs12> command allows PKCS#12 files (sometimes referred to as
51 PFX files) to be created and parsed. PKCS#12 files are used by several
52 programs including Netscape, MSIE and MS Outlook.
53
54 =head1 OPTIONS
55
56 There are a lot of options the meaning of some depends of whether a PKCS#12 file
57 is being created or parsed. By default a PKCS#12 file is parsed. A PKCS#12
58 file can be created by using the B<-export> option (see below).
59
60 =head1 PARSING OPTIONS
61
62 =over 4
63
64 =item B<-help>
65
66 Print out a usage message.
67
68 =item B<-in filename>
69
70 This specifies filename of the PKCS#12 file to be parsed. Standard input is used
71 by default.
72
73 =item B<-out filename>
74
75 The filename to write certificates and private keys to, standard output by
76 default.  They are all written in PEM format.
77
78 =item B<-passin arg>
79
80 The PKCS#12 file (i.e. input file) password source. For more information about
81 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
82 L<openssl(1)>.
83
84 =item B<-passout arg>
85
86 Pass phrase source to encrypt any outputted private keys with. For more
87 information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section
88 in L<openssl(1)>.
89
90 =item B<-password arg>
91
92 With -export, -password is equivalent to -passout.
93 Otherwise, -password is equivalent to -passin.
94
95 =item B<-noout>
96
97 This option inhibits output of the keys and certificates to the output file
98 version of the PKCS#12 file.
99
100 =item B<-clcerts>
101
102 Only output client certificates (not CA certificates).
103
104 =item B<-cacerts>
105
106 Only output CA certificates (not client certificates).
107
108 =item B<-nocerts>
109
110 No certificates at all will be output.
111
112 =item B<-nokeys>
113
114 No private keys will be output.
115
116 =item B<-info>
117
118 Output additional information about the PKCS#12 file structure, algorithms
119 used and iteration counts.
120
121 =item B<-des>
122
123 Use DES to encrypt private keys before outputting.
124
125 =item B<-des3>
126
127 Use triple DES to encrypt private keys before outputting, this is the default.
128
129 =item B<-idea>
130
131 Use IDEA to encrypt private keys before outputting.
132
133 =item B<-aes128>, B<-aes192>, B<-aes256>
134
135 Use AES to encrypt private keys before outputting.
136
137 =item B<-aria128>, B<-aria192>, B<-aria256>
138
139 Use ARIA to encrypt private keys before outputting.
140
141 =item B<-camellia128>, B<-camellia192>, B<-camellia256>
142
143 Use Camellia to encrypt private keys before outputting.
144
145 =item B<-nodes>
146
147 Don't encrypt the private keys at all.
148
149 =item B<-nomacver>
150
151 Don't attempt to verify the integrity MAC before reading the file.
152
153 =item B<-twopass>
154
155 Prompt for separate integrity and encryption passwords: most software
156 always assumes these are the same so this option will render such
157 PKCS#12 files unreadable.
158
159 =back
160
161 =head1 FILE CREATION OPTIONS
162
163 =over 4
164
165 =item B<-export>
166
167 This option specifies that a PKCS#12 file will be created rather than
168 parsed.
169
170 =item B<-out filename>
171
172 This specifies filename to write the PKCS#12 file to. Standard output is used
173 by default.
174
175 =item B<-in filename>
176
177 The filename to read certificates and private keys from, standard input by
178 default.  They must all be in PEM format. The order doesn't matter but one
179 private key and its corresponding certificate should be present. If additional
180 certificates are present they will also be included in the PKCS#12 file.
181
182 =item B<-inkey file_or_id>
183
184 File to read private key from. If not present then a private key must be present
185 in the input file.
186 If no engine is used, the argument is taken as a file; if an engine is
187 specified, the argument is given to the engine as a key identifier.
188
189 =item B<-name friendlyname>
190
191 This specifies the "friendly name" for the certificate and private key. This
192 name is typically displayed in list boxes by software importing the file.
193
194 =item B<-certfile filename>
195
196 A filename to read additional certificates from.
197
198 =item B<-caname friendlyname>
199
200 This specifies the "friendly name" for other certificates. This option may be
201 used multiple times to specify names for all certificates in the order they
202 appear. Netscape ignores friendly names on other certificates whereas MSIE
203 displays them.
204
205 =item B<-pass arg>, B<-passout arg>
206
207 The PKCS#12 file (i.e. output file) password source. For more information about
208 the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
209 L<openssl(1)>.
210
211 =item B<-passin password>
212
213 Pass phrase source to decrypt any input private keys with. For more information
214 about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in
215 L<openssl(1)>.
216
217 =item B<-chain>
218
219 If this option is present then an attempt is made to include the entire
220 certificate chain of the user certificate. The standard CA store is used
221 for this search. If the search fails it is considered a fatal error.
222
223 =item B<-descert>
224
225 Encrypt the certificate using triple DES, this may render the PKCS#12
226 file unreadable by some "export grade" software. By default the private
227 key is encrypted using triple DES and the certificate using 40 bit RC2.
228
229 =item B<-keypbe alg>, B<-certpbe alg>
230
231 These options allow the algorithm used to encrypt the private key and
232 certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name
233 can be used (see B<NOTES> section for more information). If a cipher name
234 (as output by the B<list-cipher-algorithms> command is specified then it
235 is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only
236 use PKCS#12 algorithms.
237
238 =item B<-keyex|-keysig>
239
240 Specifies that the private key is to be used for key exchange or just signing.
241 This option is only interpreted by MSIE and similar MS software. Normally
242 "export grade" software will only allow 512 bit RSA keys to be used for
243 encryption purposes but arbitrary length keys for signing. The B<-keysig>
244 option marks the key for signing only. Signing only keys can be used for
245 S/MIME signing, authenticode (ActiveX control signing)  and SSL client
246 authentication, however due to a bug only MSIE 5.0 and later support
247 the use of signing only keys for SSL client authentication.
248
249 =item B<-macalg digest>
250
251 Specify the MAC digest algorithm. If not included them SHA1 will be used.
252
253 =item B<-nomaciter>, B<-noiter>
254
255 These options affect the iteration counts on the MAC and key algorithms.
256 Unless you wish to produce files compatible with MSIE 4.0 you should leave
257 these options alone.
258
259 To discourage attacks by using large dictionaries of common passwords the
260 algorithm that derives keys from passwords can have an iteration count applied
261 to it: this causes a certain part of the algorithm to be repeated and slows it
262 down. The MAC is used to check the file integrity but since it will normally
263 have the same password as the keys and certificates it could also be attacked.
264 By default both MAC and encryption iteration counts are set to 2048, using
265 these options the MAC and encryption iteration counts can be set to 1, since
266 this reduces the file security you should not use these options unless you
267 really have to. Most software supports both MAC and key iteration counts.
268 MSIE 4.0 doesn't support MAC iteration counts so it needs the B<-nomaciter>
269 option.
270
271 =item B<-maciter>
272
273 This option is included for compatibility with previous versions, it used
274 to be needed to use MAC iterations counts but they are now used by default.
275
276 =item B<-nomac>
277
278 Don't attempt to provide the MAC integrity.
279
280 =item B<-rand file...>
281
282 A file or files containing random data used to seed the random number
283 generator.
284 Multiple files can be specified separated by an OS-dependent character.
285 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
286 all others.
287
288 =item [B<-writerand file>]
289
290 Writes random data to the specified I<file> upon exit.
291 This can be used with a subsequent B<-rand> flag.
292
293 =item B<-CAfile file>
294
295 CA storage as a file.
296
297 =item B<-CApath dir>
298
299 CA storage as a directory. This directory must be a standard certificate
300 directory: that is a hash of each subject name (using B<x509 -hash>) should be
301 linked to each certificate.
302
303 =item B<-no-CAfile>
304
305 Do not load the trusted CA certificates from the default file location.
306
307 =item B<-no-CApath>
308
309 Do not load the trusted CA certificates from the default directory location.
310
311 =item B<-CSP name>
312
313 Write B<name> as a Microsoft CSP name.
314
315 =back
316
317 =head1 NOTES
318
319 Although there are a large number of options most of them are very rarely
320 used. For PKCS#12 file parsing only B<-in> and B<-out> need to be used
321 for PKCS#12 file creation B<-export> and B<-name> are also used.
322
323 If none of the B<-clcerts>, B<-cacerts> or B<-nocerts> options are present
324 then all certificates will be output in the order they appear in the input
325 PKCS#12 files. There is no guarantee that the first certificate present is
326 the one corresponding to the private key. Certain software which requires
327 a private key and certificate and assumes the first certificate in the
328 file is the one corresponding to the private key: this may not always
329 be the case. Using the B<-clcerts> option will solve this problem by only
330 outputting the certificate corresponding to the private key. If the CA
331 certificates are required then they can be output to a separate file using
332 the B<-nokeys -cacerts> options to just output CA certificates.
333
334 The B<-keypbe> and B<-certpbe> algorithms allow the precise encryption
335 algorithms for private keys and certificates to be specified. Normally
336 the defaults are fine but occasionally software can't handle triple DES
337 encrypted private keys, then the option B<-keypbe PBE-SHA1-RC2-40> can
338 be used to reduce the private key encryption to 40 bit RC2. A complete
339 description of all algorithms is contained in the B<pkcs8> manual page.
340
341 Prior 1.1 release passwords containing non-ASCII characters were encoded
342 in non-compliant manner, which limited interoperability, in first hand
343 with Windows. But switching to standard-compliant password encoding
344 poses problem accessing old data protected with broken encoding. For
345 this reason even legacy encodings is attempted when reading the
346 data. If you use PKCS#12 files in production application you are advised
347 to convert the data, because implemented heuristic approach is not
348 MT-safe, its sole goal is to facilitate the data upgrade with this
349 utility.
350
351 =head1 EXAMPLES
352
353 Parse a PKCS#12 file and output it to a file:
354
355  openssl pkcs12 -in file.p12 -out file.pem
356
357 Output only client certificates to a file:
358
359  openssl pkcs12 -in file.p12 -clcerts -out file.pem
360
361 Don't encrypt the private key:
362
363  openssl pkcs12 -in file.p12 -out file.pem -nodes
364
365 Print some info about a PKCS#12 file:
366
367  openssl pkcs12 -in file.p12 -info -noout
368
369 Create a PKCS#12 file:
370
371  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate"
372
373 Include some extra certificates:
374
375  openssl pkcs12 -export -in file.pem -out file.p12 -name "My Certificate" \
376   -certfile othercerts.pem
377
378 =head1 SEE ALSO
379
380 L<pkcs8(1)>
381
382 =head1 COPYRIGHT
383
384 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
385
386 Licensed under the OpenSSL license (the "License").  You may not use
387 this file except in compliance with the License.  You can obtain a copy
388 in the file LICENSE in the source distribution or at
389 L<https://www.openssl.org/source/license.html>.
390
391 =cut