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