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