7f0cf167d30fc40ada3e80cf8660c15c530805ba
[openssl.git] / doc / perlvars.pm
1 #! /usr/bin/env perl
2 # Copyright 2019 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 # Verify options
12 $OpenSSL::safe::opt_v_synopsis = ""
13 . "[B<-attime> I<timestamp>]\n"
14 . "[B<-check_ss_sig>]\n"
15 . "[B<-crl_check>]\n"
16 . "[B<-crl_check_all>]\n"
17 . "[B<-explicit_policy>]\n"
18 . "[B<-extended_crl>]\n"
19 . "[B<-ignore_critical>]\n"
20 . "[B<-inhibit_any>]\n"
21 . "[B<-inhibit_map>]\n"
22 . "[B<-partial_chain>]\n"
23 . "[B<-policy> I<arg>]\n"
24 . "[B<-policy_check>]\n"
25 . "[B<-policy_print>]\n"
26 . "[B<-purpose> I<purpose>]\n"
27 . "[B<-suiteB_128>]\n"
28 . "[B<-suiteB_128_only>]\n"
29 . "[B<-suiteB_192>]\n"
30 . "[B<-trusted_first>]\n"
31 . "[B<-no_alt_chains>]\n"
32 . "[B<-use_deltas>]\n"
33 . "[B<-auth_level> I<num>]\n"
34 . "[B<-verify_depth> I<num>]\n"
35 . "[B<-verify_email> I<email>]\n"
36 . "[B<-verify_hostname> I<hostname>]\n"
37 . "[B<-verify_ip> I<ip>]\n"
38 . "[B<-verify_name> I<name>]\n"
39 . "[B<-x509_strict>]\n"
40 . "[B<-certfile> I<file>]";
41 $OpenSSL::safe::opt_v_item = ""
42 . "=item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,\n"
43 . "B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,\n"
44 . "B<-inhibit_map>, B<-no_alt_chains>, B<-partial_chain>, B<-policy>,\n"
45 . "B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,\n"
46 . "B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,\n"
47 . "B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,\n"
48 . "B<-verify_ip>, B<-verify_name>, B<-x509_strict>\n"
49 . "\n"
50 . "Set various options of certificate chain verification.\n"
51 . "See L<openssl(1)/Verification Options> for details.";
52
53
54 # Extended validation options.
55 $OpenSSL::safe::opt_x_synopsis = ""
56 . "[B<-xkey>] I<infile>\n"
57 . "[B<-xcert> I<file>]\n"
58 . "[B<-xchain>] I<file>\n"
59 . "[B<-xchain_build>] I<file>\n"
60 . "[B<-xcertform> B<DER>|B<PEM>]>\n"
61 . "[B<-xkeyform> B<DER>|B<PEM>]>";
62 $OpenSSL::safe::opt_x_item = ""
63 . "=item B<xkey> I<infile>, B<-xcert> I<file>, B<-xchain> I<file>,\n"
64 . "B<-xchain_build> I<file>, B<-xcertform> B<DER>|B<PEM>,\n"
65 . "B<-xkeyform> B<DER>|B<PEM>>\n"
66 . "\n"
67 . "Set extended certificate verification options.\n"
68 . "See L<openssl(1)/Extended Verification Options> for details.";
69
70 # Name output options
71 $OpenSSL::safe::opt_name_synopsis = ""
72 . "[B<-nameopt> I<option>]";
73 $OpenSSL::safe::opt_name_item = ""
74 . "=item B<-nameopt> I<option>\n"
75 . "\n"
76 . "This specifies how the subject or issuer names are displayed.\n"
77 . "See L<openssl(1)/Name Format Options> for details.";
78
79 # Random State Options
80 $OpenSSL::safe::opt_r_synopsis = ""
81 . "[B<-rand> I<files>]\n"
82 . "[B<-writerand> I<file>]";
83 $OpenSSL::safe::opt_r_item = ""
84 . "=item B<-rand> I<files>, B<-writerand> I<file>\n"
85 . "\n"
86 . "See L<openssl(1)/Random State Options> for details.";
87
88 # Engine option
89 $OpenSSL::safe::opt_engine_synopsis = ""
90 . "[B<-engine> I<id>]";
91 $OpenSSL::safe::opt_engine_item = ""
92 . "=item B<-engine> I<id>\n"
93 . "\n"
94 . "See L<openssl(1)/Engine Options>.";
95
96 # Trusted certs options
97 $OpenSSL::safe::opt_trust_synopsis = ""
98 . "[B<-CAfile> I<file>]\n"
99 . "[B<-no-CAfile>]\n"
100 . "[B<-CApath> I<dir>]\n"
101 . "[B<-no-CApath>]\n"
102 . "[B<-CAstore> I<uri>]\n"
103 . "[B<-no-CAstore>]";
104 $OpenSSL::safe::opt_trust_item = ""
105 . "=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>,\n"
106 . "B<-CAstore> I<uri>, B<-no-CAstore>\n"
107 . "\n"
108 . "See L<openssl(1)/Trusted Certificate Options> for details.";
109
110 # TLS Version Options
111 $OpenSSL::safe::opt_versiontls_synopsis = ""
112 . "[B<-no_ssl3>]\n"
113 . "[B<-no_tls1>]\n"
114 . "[B<-no_tls1_1>]\n"
115 . "[B<-no_tls1_2>]\n"
116 . "[B<-no_tls1_3>]\n"
117 . "[B<-ssl3>]\n"
118 . "[B<-tls1>]\n"
119 . "[B<-tls1_1>]\n"
120 . "[B<-tls1_2>]\n"
121 . "[B<-tls1_3>]";
122 $OpenSSL::safe::opt_versiontls_item = ""
123 . "=item B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>,\n"
124 . "B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>\n"
125 . "\n"
126 . "See L<openssl(1)/TLS Version Options>.";
127
128 # TLS/DTLS Version Options
129 $OpenSSL::safe::opt_version_synopsis = ""
130 . "$OpenSSL::safe::opt_versiontls_synopsis\n"
131 . "[B<-dtls>]\n"
132 . "[B<-dtls1>]\n"
133 . "[B<-dtls1_2>]";
134 $OpenSSL::safe::opt_version_item = "\n"
135 . "$OpenSSL::safe::opt_versiontls_item\n"
136 . "\n"
137 . "=item B<-dtls>, B<-dtls1>, B<-dtls1_2>\n"
138 . "\n"
139 . "These specify the use of DTLS instead of TLS.\n"
140 . "See L<openssl(1)/TLS Version Options>.";
141
142 # SSL connection options.
143 # TODO(3.0) Not currently used.  The refactoring needs to be done, and
144 # the options will probably be re-ordered.
145 $OpenSSL::safe::opt_s_synopsis = ""
146 . "[B<-bugs>]\n"
147 . "[B<-no_comp>]\n"
148 . "[B<-no_ticket>]\n"
149 . "[B<-serverpref>]\n"
150 . "[B<-legacy_renegotiation>]\n"
151 . "[B<-no_renegotiation>]\n"
152 . "[B<-legacy_server_connect>]\n"
153 . "[B<-no_resumption_on_reneg>]\n"
154 . "[B<-no_legacy_server_connect>]\n"
155 . "[B<-allow_no_dhe_kex>]\n"
156 . "[B<-prioritize_chacha>]\n"
157 . "[B<-strict>]\n"
158 . "[B<-sigalgs> I<algs>]\n"
159 . "[B<-client_sigalgs> I<algs>]\n"
160 . "[B<-groups> I<groups>]\n"
161 . "[B<-curves> I<curves>]\n"
162 . "[B<-named_curve> I<curves>]\n"
163 . "[B<-cipher> I<ciphers>]\n"
164 . "[B<-ciphersuites> I<1.3ciphers>]\n"
165 . "[B<-min_protocol> I<minprot>]\n"
166 . "[B<-max_protocol> I<maxprot>]\n"
167 . "[B<-record_padding> I<padding>]\n"
168 . "[B<-debug_broken_protocol>]\n"
169 . "[B<-no_middlebox>]";
170 $OpenSSL::safe::opt_s_item = ""
171 . "=item B<-bugs>, B<-no_comp>, B<-no_ticket>, B<-serverpref>,"
172 . "B<-legacy_renegotiation>, B<-no_renegotiation>, B<-legacy_server_connect>,\n"
173 . "B<-no_resumption_on_reneg>, B<-no_legacy_server_connect>,\n"
174 . "B<-allow_no_dhe_kex>, B<-prioritize_chacha>, B<-strict>, B<-sigalgs>\n"
175 . "I<algs>, B<-client_sigalgs> I<algs>, B<-groups> I<groups>, B<-curves>\n"
176 . "I<curves>, B<-named_curve> I<curves>, B<-cipher> I<ciphers>, B<-ciphersuites>\n"
177 . "I<1.3ciphers>, B<-min_protocol> I<minprot>, B<-max_protocol> I<maxprot>,\n"
178 . "B<-record_padding> I<padding>, B<-debug_broken_protocol>, B<-no_middlebox>\n"
179 . "\n"
180 . "See L<SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS> for details.";
181
182 package OpenSSL::safe;
183 sub output_do_not_edit_headers {
184     return "\n=begin comment\n\n"
185         . join("\n", @autowarntext)
186         . "\n\n=end comment";
187 }
188 1;