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