Codebase list openssl / bee3f38
Document the behavior of the -inform and related options Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/15100) Tomas Mraz authored 3 years ago Matt Caswell committed 3 years ago
21 changed file(s) with 79 addition(s) and 112 deletion(s). Raw diff Collapse all Expand all
4949 behaviour of openssl-genpkey(1) for DH parameter generation.
5050
5151 *Shane Lontis*
52
53 * The openssl commands that read keys, certificates, and CRLs now
54 automatically detect the PEM or DER format of the input files so it is not
55 necessary to explicitly specify the input format anymore. However if the
56 input format option is used the specified format will be required.
57
58 *David von Oheimb, Richard Levitte, and Tomáš Mráz*
5259
5360 * Added enhanced PKCS#12 APIs which accept a library context `OSSL_LIB_CTX`
5461 and (where relevant) a property query. Other APIs which handle PKCS#7 and
113113
114114 =item B<-inform> B<DER>|B<PEM>
115115
116 The format of the data in certificate request input files.
117 The default is PEM.
116 The format of the data in certificate request input files;
117 unspecified by default.
118 See L<openssl-format-options(1)> for details.
118119
119120 =item B<-ss_cert> I<filename>
120121
149150
150151 =item B<-certform> B<DER>|B<PEM>|B<P12>
151152
152 The format of the data in certificate input files.
153 This option has no effect and is retained for backward compatibility only.
153 The format of the data in certificate input files; unspecified by default.
154 See L<openssl-format-options(1)> for details.
154155
155156 =item B<-keyfile> I<filename>|I<uri>
156157
159160
160161 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
161162
162 The format of the private key input file; the default is B<PEM>.
163 The only value with effect is B<ENGINE>; all others have become obsolete.
163 The format of the private key input file; unspecified by default.
164164 See L<openssl-format-options(1)> for details.
165165
166166 =item B<-sigopt> I<nm>:I<v>
817817
818818 The B<-section> option was added in OpenSSL 3.0.0.
819819
820 The B<-certform> and B<-multivalue-rdn> options
821 have become obsolete in OpenSSL 3.0.0 and have no effect.
822
823 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
824 and have no effect.
820 The B<-multivalue-rdn> option has become obsolete in OpenSSL 3.0.0 and
821 has no effect.
825822
826823 The B<-engine> option was deprecated in OpenSSL 3.0.
827824
731731
732732 =item B<-keyform> I<PEM|DER|P12|ENGINE>
733733
734 The format of the key input.
735 The only value with effect is B<ENGINE>.
734 The format of the key input; unspecified by default.
736735 See L<openssl(1)/Format Options> for details.
737736
738737 =item B<-otherpass> I<arg>
240240
241241 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
242242
243 The format of the private key file; the default is B<PEM>.
244 The only value with effect is B<ENGINE>; all others have become obsolete.
243 The format of the private key file; unspecified by default.
245244 See L<openssl-format-options(1)> for details.
246245
247246 =item B<-rctform> B<DER>|B<PEM>|B<SMIME>
785784
786785 The -no_alt_chains option was added in OpenSSL 1.0.2b.
787786
788 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
789 and have no effect.
790
791787 The B<-nameopt> option was added in OpenSSL 3.0.0.
792788
793789 The B<-engine> option was deprecated in OpenSSL 3.0.
4646
4747 =item B<-inform> B<DER>|B<PEM>
4848
49 The CRL input format.
50 This option has no effect and is retained for backward compatibility only.
49 The CRL input format; unspecified by default.
50 See L<openssl-format-options(1)> for details.
5151
5252 =item B<-outform> B<DER>|B<PEM>
5353
6060
6161 =item B<-keyform> B<DER>|B<PEM>|B<P12>
6262
63 The format of the private key file.
64 This option has no effect and is retained for backward compatibility only.
63 The format of the private key file; unspecified by default.
64 See L<openssl-format-options(1)> for details.
6565
6666 =item B<-in> I<filename>
6767
155155 L<openssl-x509(1)>,
156156 L<ossl_store-file(7)>
157157
158 =head1 HISTORY
159
160 The B<-inform> and B<-keyform> options have become obsolete in OpenSSL 3.0.0
161 and have no effect.
162
163158 =head1 COPYRIGHT
164159
165160 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
107107
108108 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
109109
110 The format of the key to sign with; the default is B<PEM>.
111 The only value with effect is B<ENGINE>; all others have become obsolete.
110 The format of the key to sign with; unspecified by default.
112111 See L<openssl-format-options(1)> for details.
113112
114113 =item B<-sigopt> I<nm>:I<v>
255254 The default digest was changed from MD5 to SHA256 in OpenSSL 1.1.0.
256255 The FIPS-related options were removed in OpenSSL 1.1.0.
257256
258 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
259 and have no effect.
260
261257 The B<-engine> and B<-engine_impl> options were deprecated in OpenSSL 3.0.
262258
263259 =head1 COPYRIGHT
5454
5555 Print out a usage message.
5656
57 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
57 =item B<-inform> B<DER>|B<PEM>
5858
59 The input and formats; the default is B<PEM>.
59 The key input format; unspecified by default.
60 See L<openssl-format-options(1)> for details.
61
62 =item B<-outform> B<DER>|B<PEM>
63
64 The key output format; the default is B<PEM>.
6065 See L<openssl-format-options(1)> for details.
6166
6267 Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
3535
3636 Print out a usage message.
3737
38 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
38 =item B<-inform> B<DER>|B<PEM>
3939
40 This option has become obsolete.
40 The DSA parameters input format; unspecified by default.
41 See L<openssl-format-options(1)> for details.
42
43 =item B<-outform> B<DER>|B<PEM>
44
45 The DSA parameters output format; the default is B<PEM>.
4146 See L<openssl-format-options(1)> for details.
4247
4348 Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
5252
5353 =item B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
5454
55 The key input format; the default is B<PEM>.
56 The only value with effect is B<ENGINE>; all others have become obsolete.
55 The key input format; unspecified by default.
5756 See L<openssl-format-options(1)> for details.
5857
5958 =item B<-outform> B<DER>|B<PEM>
6059
61 The key output formats; the default is B<PEM>.
60 The key output format; the default is B<PEM>.
6261 See L<openssl-format-options(1)> for details.
6362
6463 Private keys are an SEC1 private key or PKCS#8 format.
4242
4343 Print out a usage message.
4444
45 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
45 =item B<-inform> B<DER>|B<PEM>
4646
47 The input and formats; the default is B<PEM>.
47 The EC parameters input format; unspecified by default.
48 See L<openssl-format-options(1)> for details.
49
50 =item B<-outform> B<DER>|B<PEM>
51
52 The EC parameters output format; the default is B<PEM>.
4853 See L<openssl-format-options(1)> for details.
4954
5055 Parameters are encoded as B<EcpkParameters> as specified in IETF RFC 3279.
1414
1515 Several OpenSSL commands can take input or generate output in a variety
1616 of formats.
17
1718 Since OpenSSL 3.0 keys, single certificates, and CRLs can be read from
18 files in any of the B<DER>, B<PEM> or B<P12> formats,
19 while specifying their input format is no more needed.
19 files in any of the B<DER>, B<PEM> or B<P12> formats. Specifying their input
20 format is no more needed and the openssl commands will automatically try all
21 the possible formats. However if the B<DER> or B<PEM> input format is specified
22 it will be enforced.
23
2024 In order to access a key via an engine the input format B<ENGINE> may be used;
2125 alternatively the key identifier in the <uri> argument of the respective key
2226 option may be preceded by C<org.openssl.engine:>.
3842 =item B<-keyform> I<format>
3943
4044 Format of a private key input source.
41 The only value with effect is B<ENGINE>; all others have become obsolete.
42 See L<openssl(1)/Format Options> for details.
4345
4446 =item B<-CRLform> I<format>
4547
7777
7878 =item B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
7979
80 The key input format; the default is B<PEM>.
81 The only value with effect is B<ENGINE>; all others have become obsolete.
80 The key input format; unspecified by default.
8281 See L<openssl-format-options(1)> for details.
8382
8483 =item B<-passin> I<arg>
9090
9191 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
9292
93 The key format; the default is B<PEM>.
94 The only value with effect is B<ENGINE>; all others have become obsolete.
93 The key format; unspecified by default.
9594 See L<openssl-format-options(1)> for details.
9695
9796 =item B<-passin> I<arg>
105104
106105 =item B<-peerform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
107106
108 The peer key format; the default is B<PEM>.
109 The only value with effect is B<ENGINE>; all others have become obsolete.
107 The peer key format; unspecified by default.
110108 See L<openssl-format-options(1)> for details.
111109
112110 =item B<-pubin>
409407
410408 =head1 HISTORY
411409
412 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
413 and have no effect.
414
415410 The B<-engine> option was deprecated in OpenSSL 3.0.
416411
417412 =head1 COPYRIGHT
7373
7474 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
7575
76 The input and output formats; the default is B<PEM>.
76 The input and output formats; unspecified by default.
7777 See L<openssl-format-options(1)> for details.
7878
7979 The data is a PKCS#10 object.
196196
197197 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
198198
199 The format of the private key; the default is B<PEM>.
200 The only value with effect is B<ENGINE>; all others have become obsolete.
199 The format of the private key; unspecified by default.
201200 See L<openssl-format-options(1)> for details.
202201
203202 =item B<-keyout> I<filename>
736735
737736 The B<-section> option was added in OpenSSL 3.0.0.
738737
739 All B<-keyform> values except B<ENGINE> and the B<-multivalue-rdn> option
740 have become obsolete in OpenSSL 3.0.0 and have no effect.
738 The B<-multivalue-rdn> option has become obsolete in OpenSSL 3.0.0 and
739 has no effect.
741740
742741 The B<-engine> option was deprecated in OpenSSL 3.0.
743742 The <-nodes> option was deprecated in OpenSSL 3.0, too; use B<-noenc> instead.
5959
6060 =item B<-inform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
6161
62 The key input format; the default is B<PEM>.
63 The only value with effect is B<ENGINE>; all others have become obsolete.
62 The key input format; unspecified by default.
6463 See L<openssl-format-options(1)> for details.
6564
6665 =item B<-outform> B<DER>|B<PEM>
7272
7373 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
7474
75 The key format; the default is B<PEM>.
76 The only value with effect is B<ENGINE>; all others have become obsolete.
75 The key format; unspecified by default.
7776 See L<openssl-format-options(1)> for details.
7877
7978 =item B<-pubin>
230229
231230 This command was deprecated in OpenSSL 3.0.
232231
233 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
234 and have no effect.
235
236232 The B<-engine> option was deprecated in OpenSSL 3.0.
237233
238234 =head1 COPYRIGHT
242242
243243 =item B<-certform> B<DER>|B<PEM>|B<P12>
244244
245 The client certificate file format to use; the default is B<PEM>.
246 This option has no effect and is retained for backward compatibility only.
245 The client certificate file format to use; unspecified by default.
246 See L<openssl-format-options(1)> for details.
247247
248248 =item B<-cert_chain>
249249
262262
263263 =item B<-CRLform> B<DER>|B<PEM>
264264
265 The CRL file format; the default is B<PEM>.
265 The CRL file format; unspecified by default.
266266 See L<openssl-format-options(1)> for details.
267267
268268 =item B<-crl_download>
276276
277277 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
278278
279 The key format; the default is B<PEM>.
280 The only value with effect is B<ENGINE>; all others have become obsolete.
279 The key format; unspecified by default.
281280 See L<openssl-format-options(1)> for details.
282281
283282 =item B<-pass> I<arg>
911910
912911 The B<-certform> option has become obsolete in OpenSSL 3.0.0 and has no effect.
913912
914 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
915 and have no effect.
916
917913 The B<-engine> option was deprecated in OpenSSL 3.0.
918914
919915 =head1 COPYRIGHT
224224
225225 =item B<-certform> B<DER>|B<PEM>|B<P12>
226226
227 The server certificate file format.
228 This option has no effect and is retained for backward compatibility only.
227 The server certificate file format; unspecified by default.
228 See L<openssl-format-options(1)> for details.
229229
230230 =item B<-cert_chain>
231231
257257
258258 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
259259
260 The key format; the default is B<PEM>.
261 The only value with effect is B<ENGINE>; all others have become obsolete.
260 The key format; unspecified by default.
262261 See L<openssl-format-options(1)> for details.
263262
264263 =item B<-pass> I<val>
287286
288287 =item B<-dcertform> B<DER>|B<PEM>|B<P12>
289288
290 The format of the additional certificate file.
291 This option has no effect and is retained for backward compatibility only.
289 The format of the additional certificate file; unspecified by default.
290 See L<openssl-format-options(1)> for details.
292291
293292 =item B<-dkeyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
294293
295 The format of the additional private key; the default is B<PEM>.
296 The only value with effect is B<ENGINE>; all others have become obsolete.
297 See L<openssl-format-options(1)>.
294 The format of the additional private key; unspecified by default.
295 See L<openssl-format-options(1)> for details.
298296
299297 =item B<-dpass> I<val>
300298
332330
333331 =item B<-CRLform> B<DER>|B<PEM>
334332
335 The CRL file format; the default is B<PEM>.
333 The CRL file format; unspecified by default.
336334 See L<openssl-format-options(1)> for details.
337335
338336 =item B<-crl_download>
843841 The
844842 -allow-no-dhe-kex and -prioritize_chacha options were added in OpenSSL 1.1.1.
845843
846 All B<-keyform> and B<-dkeyform> values except B<ENGINE>
847 have become obsolete in OpenSSL 3.0.0 and have no effect.
848
849 The B<-certform> and B<-dcertform> options have become obsolete in OpenSSL 3.0.0
850 and have no effect.
851
852844 The B<-engine> option was deprecated in OpenSSL 3.0.
853845
854846 =head1 COPYRIGHT
126126
127127 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
128128
129 The key format; the default is B<PEM>.
130 The only value with effect is B<ENGINE>; all others have become obsolete.
129 The key format; unspecified by default.
131130 See L<openssl-format-options(1)> for details.
132131
133132 =item B<-stream>, B<-indef>, B<-noindef>
480479
481480 The -no_alt_chains option was added in OpenSSL 1.1.0.
482481
483 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
484 and have no effect.
485
486482 The B<-engine> option was deprecated in OpenSSL 3.0.
487483
488484 =head1 COPYRIGHT
5959
6060 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
6161
62 The key format; the default is B<PEM>.
63 The only value with effect is B<ENGINE>; all others have become obsolete.
62 The key format; unspecified by default.
6463 See L<openssl-format-options(1)> for details.
6564
6665 =item B<-passin> I<arg>
149148
150149 =head1 HISTORY
151150
152 All B<-keyform> values except B<ENGINE> have become obsolete in OpenSSL 3.0.0
153 and have no effect.
154
155151 The B<-engine> option was deprecated in OpenSSL 3.0.
156152
157153 =head1 COPYRIGHT
153153
154154 =item B<-inform> B<DER>|B<PEM>
155155
156 The CSR input file format; the default is B<PEM>.
156 The input file format; unspecified by default.
157157 See L<openssl-format-options(1)> for details.
158158
159159 =item B<-vfyopt> I<nm>:I<v>
180180
181181 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
182182
183 The key input format; the default is B<PEM>.
184 The only value with effect is B<ENGINE>; all others have become obsolete.
183 The key input format; unspecified by default.
185184 See L<openssl-format-options(1)> for details.
186185
187186 =item B<-out> I<filename>
467466
468467 =item B<-CAform> B<DER>|B<PEM>|B<P12>,
469468
470 The format for the CA certificate.
471 This option has no effect and is retained for backward compatibility.
469 The format for the CA certificate; unspecifed by default.
470 See L<openssl-format-options(1)> for details.
472471
473472 =item B<-CAkey> I<filename>|I<uri>
474473
478477
479478 =item B<-CAkeyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
480479
481 The format for the CA key; the default is B<PEM>.
482 The only value with effect is B<ENGINE>; all others have become obsolete.
480 The format for the CA key; unspecified by default.
483481 See L<openssl-format-options(1)> for details.
484482
485483 =item B<-CAserial> I<filename>
878876 The B<-signkey> option has been renamed to B<-key> in OpenSSL 3.0,
879877 keeping the old name as an alias.
880878
881 All B<-keyform> and B<-CAkeyform> values except B<ENGINE>
882 have become obsolete in OpenSSL 3.0.0 and have no effect.
883
884 The B<-CAform> option has become obsolete in OpenSSL 3.0.0 and has no effect.
885
886879 The B<-engine> option was deprecated in OpenSSL 3.0.
887880
888881 The B<-C> option was removed in OpenSSL 3.0.