Add EVP_KDF-X942 to the fips module
[openssl.git] / doc / perlvars.pm
1 #! /usr/bin/env perl
2 # Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
3 #
4 # Licensed under the Apache License 2.0 (the "License").  You may not use
5 # this file except in compliance with the License.  You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7
8 # Set some Perl variables for use by util/dofile.pl when processing
9 # POD files (mainly man1).
10
11 use configdata;
12
13 # Verify options
14 $OpenSSL::safe::opt_v_synopsis = ""
15 . "[B<-allow_proxy_certs>]\n"
16 . "[B<-attime> I<timestamp>]\n"
17 . "[B<-no_check_time>]\n"
18 . "[B<-check_ss_sig>]\n"
19 . "[B<-crl_check>]\n"
20 . "[B<-crl_check_all>]\n"
21 . "[B<-explicit_policy>]\n"
22 . "[B<-extended_crl>]\n"
23 . "[B<-ignore_critical>]\n"
24 . "[B<-inhibit_any>]\n"
25 . "[B<-inhibit_map>]\n"
26 . "[B<-partial_chain>]\n"
27 . "[B<-policy> I<arg>]\n"
28 . "[B<-policy_check>]\n"
29 . "[B<-policy_print>]\n"
30 . "[B<-purpose> I<purpose>]\n"
31 . "[B<-suiteB_128>]\n"
32 . "[B<-suiteB_128_only>]\n"
33 . "[B<-suiteB_192>]\n"
34 . "[B<-trusted_first>]\n"
35 . "[B<-no_alt_chains>]\n"
36 . "[B<-use_deltas>]\n"
37 . "[B<-auth_level> I<num>]\n"
38 . "[B<-verify_depth> I<num>]\n"
39 . "[B<-verify_email> I<email>]\n"
40 . "[B<-verify_hostname> I<hostname>]\n"
41 . "[B<-verify_ip> I<ip>]\n"
42 . "[B<-verify_name> I<name>]\n"
43 . "[B<-x509_strict>]\n"
44 . "[B<-issuer_checks>]";
45 $OpenSSL::safe::opt_v_item = ""
46 . "=item B<-allow_proxy_certs>, B<-attime>, B<-no_check_time>,\n"
47 . "B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,\n"
48 . "B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,\n"
49 . "B<-inhibit_map>, B<-no_alt_chains>, B<-partial_chain>, B<-policy>,\n"
50 . "B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,\n"
51 . "B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,\n"
52 . "B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,\n"
53 . "B<-verify_ip>, B<-verify_name>, B<-x509_strict> B<-issuer_checks>\n"
54 . "\n"
55 . "Set various options of certificate chain verification.\n"
56 . "See L<openssl(1)/Verification Options> for details.";
57
58
59 # Extended validation options.
60 $OpenSSL::safe::opt_x_synopsis = ""
61 . "[B<-xkey>] I<infile>\n"
62 . "[B<-xcert> I<file>]\n"
63 . "[B<-xchain>] I<file>\n"
64 . "[B<-xchain_build>] I<file>\n"
65 . "[B<-xcertform> B<DER>|B<PEM>]>\n"
66 . "[B<-xkeyform> B<DER>|B<PEM>]>";
67 $OpenSSL::safe::opt_x_item = ""
68 . "=item B<xkey> I<infile>, B<-xcert> I<file>, B<-xchain> I<file>,\n"
69 . "B<-xchain_build> I<file>, B<-xcertform> B<DER>|B<PEM>,\n"
70 . "B<-xkeyform> B<DER>|B<PEM>\n"
71 . "\n"
72 . "Set extended certificate verification options.\n"
73 . "See L<openssl(1)/Extended Verification Options> for details.";
74
75 # Name output options
76 $OpenSSL::safe::opt_name_synopsis = ""
77 . "[B<-nameopt> I<option>]";
78 $OpenSSL::safe::opt_name_item = ""
79 . "=item B<-nameopt> I<option>\n"
80 . "\n"
81 . "This specifies how the subject or issuer names are displayed.\n"
82 . "See L<openssl(1)/Name Format Options> for details.";
83
84 # Random State Options
85 $OpenSSL::safe::opt_r_synopsis = ""
86 . "[B<-rand> I<files>]\n"
87 . "[B<-writerand> I<file>]";
88 $OpenSSL::safe::opt_r_item = ""
89 . "=item B<-rand> I<files>, B<-writerand> I<file>\n"
90 . "\n"
91 . "See L<openssl(1)/Random State Options> for details.";
92
93 # Provider options
94 $OpenSSL::safe::opt_provider_synopsis = ""
95 . "[B<-provider> I<name>]\n"
96 . "[B<-provider-path> I<path>]";
97 $OpenSSL::safe::opt_provider_item = ""
98 . "=item B<-provider> I<name>\n"
99 . "\n"
100 . "=item B<-provider-path> I<path>\n"
101 . "\n"
102 . "See L<openssl(1)/Provider Options>.";
103
104 # Configuration option
105 $OpenSSL::safe::opt_config_synopsis = ""
106 . "[B<-config> I<configfile>]";
107 $OpenSSL::safe::opt_config_item = ""
108 . "=item B<-config> I<configfile>\n"
109 . "\n"
110 . "See L<openssl(1)/Configuration Option>.";
111
112 # Engine option
113 $OpenSSL::safe::opt_engine_synopsis = "";
114 $OpenSSL::safe::opt_engine_item = "";
115 if (!$disabled{"deprecated-3.0"}) {
116   $OpenSSL::safe::opt_engine_synopsis = ""
117   . "[B<-engine> I<id>]\n";
118   $OpenSSL::safe::opt_engine_item = ""
119   . "=item B<-engine> I<id>\n"
120   . "\n"
121   . "See L<openssl(1)/Engine Options>.\n"
122   . "This option is deprecated.";
123 }
124
125 # Trusted certs options
126 $OpenSSL::safe::opt_trust_synopsis = ""
127 . "[B<-CAfile> I<file>]\n"
128 . "[B<-no-CAfile>]\n"
129 . "[B<-CApath> I<dir>]\n"
130 . "[B<-no-CApath>]\n"
131 . "[B<-CAstore> I<uri>]\n"
132 . "[B<-no-CAstore>]";
133 $OpenSSL::safe::opt_trust_item = ""
134 . "=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>,\n"
135 . "B<-CAstore> I<uri>, B<-no-CAstore>\n"
136 . "\n"
137 . "See L<openssl(1)/Trusted Certificate Options> for details.";
138
139 # TLS Version Options
140 $OpenSSL::safe::opt_versiontls_synopsis = ""
141 . "[B<-no_ssl3>]\n"
142 . "[B<-no_tls1>]\n"
143 . "[B<-no_tls1_1>]\n"
144 . "[B<-no_tls1_2>]\n"
145 . "[B<-no_tls1_3>]\n"
146 . "[B<-ssl3>]\n"
147 . "[B<-tls1>]\n"
148 . "[B<-tls1_1>]\n"
149 . "[B<-tls1_2>]\n"
150 . "[B<-tls1_3>]";
151 $OpenSSL::safe::opt_versiontls_item = ""
152 . "=item B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>,\n"
153 . "B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>\n"
154 . "\n"
155 . "See L<openssl(1)/TLS Version Options>.";
156
157 # TLS/DTLS Version Options
158 $OpenSSL::safe::opt_version_synopsis = ""
159 . "$OpenSSL::safe::opt_versiontls_synopsis\n"
160 . "[B<-dtls>]\n"
161 . "[B<-dtls1>]\n"
162 . "[B<-dtls1_2>]";
163 $OpenSSL::safe::opt_version_item = "\n"
164 . "$OpenSSL::safe::opt_versiontls_item\n"
165 . "\n"
166 . "=item B<-dtls>, B<-dtls1>, B<-dtls1_2>\n"
167 . "\n"
168 . "These specify the use of DTLS instead of TLS.\n"
169 . "See L<openssl(1)/TLS Version Options>.";
170
171 # SSL connection options.
172 # TODO # options will probably be re-ordered.
173 $OpenSSL::safe::opt_s_synopsis = ""
174 . "[B<-bugs>]\n"
175 . "[B<-no_comp>]\n"
176 . "[B<-comp>]\n"
177 . "[B<-no_ticket>]\n"
178 . "[B<-serverpref>]\n"
179 . "[B<-legacy_renegotiation>]\n"
180 . "[B<-no_renegotiation>]\n"
181 . "[B<-no_resumption_on_reneg>]\n"
182 . "[B<-legacy_server_connect>]\n"
183 . "[B<-no_legacy_server_connect>]\n"
184 . "[B<-allow_no_dhe_kex>]\n"
185 . "[B<-prioritize_chacha>]\n"
186 . "[B<-strict>]\n"
187 . "[B<-sigalgs> I<algs>]\n"
188 . "[B<-client_sigalgs> I<algs>]\n"
189 . "[B<-groups> I<groups>]\n"
190 . "[B<-curves> I<curves>]\n"
191 . "[B<-named_curve> I<curve>]\n"
192 . "[B<-cipher> I<ciphers>]\n"
193 . "[B<-ciphersuites> I<1.3ciphers>]\n"
194 . "[B<-min_protocol> I<minprot>]\n"
195 . "[B<-max_protocol> I<maxprot>]\n"
196 . "[B<-record_padding> I<padding>]\n"
197 . "[B<-debug_broken_protocol>]\n"
198 . "[B<-no_middlebox>]";
199 $OpenSSL::safe::opt_s_item = ""
200 . "=item B<-bugs>, B<-comp>, B<-no_comp>, B<-no_ticket>, B<-serverpref>,\n"
201 . "B<-legacy_renegotiation>, B<-no_renegotiation>, B<-no_resumption_on_reneg>,\n"
202 . "B<-legacy_server_connect>, B<-no_legacy_server_connect>,\n"
203 . "B<-allow_no_dhe_kex>, B<-prioritize_chacha>, B<-strict>, B<-sigalgs>\n"
204 . "I<algs>, B<-client_sigalgs> I<algs>, B<-groups> I<groups>, B<-curves>\n"
205 . "I<curves>, B<-named_curve> I<curve>, B<-cipher> I<ciphers>, B<-ciphersuites>\n"
206 . "I<1.3ciphers>, B<-min_protocol> I<minprot>, B<-max_protocol> I<maxprot>,\n"
207 . "B<-record_padding> I<padding>, B<-debug_broken_protocol>, B<-no_middlebox>\n"
208 . "\n"
209 . "See L<SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS> for details.";
210
211 package OpenSSL::safe;
212 sub output_do_not_edit_headers {
213     return "\n=begin comment\n\n"
214         . join("\n", @autowarntext)
215         . "\n\n=end comment";
216 }
217 1;