Home | History | Annotate | Line # | Download | only in doc 
      1 #! /usr/bin/env perl
      2 # Copyright 2019-2025 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-verification-options(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-verification-options(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-namedisplay-options(1)> 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>]\n"
     97 . "[B<-provparam> I<[name:]key=value>]\n"
     98 . "[B<-propquery> I<propq>]";
     99 $OpenSSL::safe::opt_provider_item = ""
    100 . "=item B<-provider> I<name>\n"
    101 . "\n"
    102 . "=item B<-provider-path> I<path>\n"
    103 . "\n"
    104 . "=item B<-provparam> I<[name:]key=value>\n"
    105 . "\n"
    106 . "=item B<-propquery> I<propq>\n"
    107 . "\n"
    108 . "See L<openssl(1)/Provider Options>, L<provider(7)>, and L<property(7)>.";
    109 
    110 # Configuration option
    111 $OpenSSL::safe::opt_config_synopsis = ""
    112 . "[B<-config> I<configfile>]";
    113 $OpenSSL::safe::opt_config_item = ""
    114 . "=item B<-config> I<configfile>\n"
    115 . "\n"
    116 . "See L<openssl(1)/Configuration Option>.";
    117 
    118 # Engine option
    119 $OpenSSL::safe::opt_engine_synopsis = "";
    120 $OpenSSL::safe::opt_engine_item = "";
    121 if (!$disabled{"deprecated-3.0"}) {
    122   $OpenSSL::safe::opt_engine_synopsis = ""
    123   . "[B<-engine> I<id>]\n";
    124   $OpenSSL::safe::opt_engine_item = ""
    125   . "=item B<-engine> I<id>\n"
    126   . "\n"
    127   . "See L<openssl(1)/Engine Options>.\n"
    128   . "This option is deprecated.";
    129 }
    130 
    131 # Trusted certs options
    132 $OpenSSL::safe::opt_trust_synopsis = ""
    133 . "[B<-CAfile> I<file>]\n"
    134 . "[B<-no-CAfile>]\n"
    135 . "[B<-CApath> I<dir>]\n"
    136 . "[B<-no-CApath>]\n"
    137 . "[B<-CAstore> I<uri>]\n"
    138 . "[B<-no-CAstore>]";
    139 $OpenSSL::safe::opt_trust_item = ""
    140 . "=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>,\n"
    141 . "B<-CAstore> I<uri>, B<-no-CAstore>\n"
    142 . "\n"
    143 . "See L<openssl-verification-options(1)/Trusted Certificate Options> for details.";
    144 
    145 # TLS Version Options
    146 $OpenSSL::safe::opt_versiontls_synopsis = ""
    147 . "[B<-no_ssl3>]\n"
    148 . "[B<-no_tls1>]\n"
    149 . "[B<-no_tls1_1>]\n"
    150 . "[B<-no_tls1_2>]\n"
    151 . "[B<-no_tls1_3>]\n"
    152 . "[B<-ssl3>]\n"
    153 . "[B<-tls1>]\n"
    154 . "[B<-tls1_1>]\n"
    155 . "[B<-tls1_2>]\n"
    156 . "[B<-tls1_3>]";
    157 $OpenSSL::safe::opt_versiontls_item = ""
    158 . "=item B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>,\n"
    159 . "B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>\n"
    160 . "\n"
    161 . "See L<openssl(1)/TLS Version Options>.";
    162 
    163 # TLS/DTLS Version Options
    164 $OpenSSL::safe::opt_version_synopsis = ""
    165 . "$OpenSSL::safe::opt_versiontls_synopsis\n"
    166 . "[B<-dtls>]\n"
    167 . "[B<-dtls1>]\n"
    168 . "[B<-dtls1_2>]";
    169 $OpenSSL::safe::opt_version_item = "\n"
    170 . "$OpenSSL::safe::opt_versiontls_item\n"
    171 . "\n"
    172 . "=item B<-dtls>, B<-dtls1>, B<-dtls1_2>\n"
    173 . "\n"
    174 . "These specify the use of DTLS instead of TLS.\n"
    175 . "See L<openssl(1)/TLS Version Options>.";
    176 
    177 # SSL connection options.
    178 # TODO # options will probably be re-ordered.
    179 $OpenSSL::safe::opt_s_synopsis = ""
    180 . "[B<-bugs>]\n"
    181 . "[B<-no_comp>]\n"
    182 . "[B<-comp>]\n"
    183 . "[B<-no_ticket>]\n"
    184 . "[B<-serverpref>]\n"
    185 . "[B<-client_renegotiation>]\n"
    186 . "[B<-legacy_renegotiation>]\n"
    187 . "[B<-no_renegotiation>]\n"
    188 . "[B<-no_resumption_on_reneg>]\n"
    189 . "[B<-legacy_server_connect>]\n"
    190 . "[B<-no_legacy_server_connect>]\n"
    191 . "[B<-no_etm>]\n"
    192 . "[B<-allow_no_dhe_kex>]\n"
    193 . "[B<-prefer_no_dhe_kex>]\n"
    194 . "[B<-prioritize_chacha>]\n"
    195 . "[B<-strict>]\n"
    196 . "[B<-sigalgs> I<algs>]\n"
    197 . "[B<-client_sigalgs> I<algs>]\n"
    198 . "[B<-groups> I<groups>]\n"
    199 . "[B<-curves> I<curves>]\n"
    200 . "[B<-named_curve> I<curve>]\n"
    201 . "[B<-cipher> I<ciphers>]\n"
    202 . "[B<-ciphersuites> I<1.3ciphers>]\n"
    203 . "[B<-min_protocol> I<minprot>]\n"
    204 . "[B<-max_protocol> I<maxprot>]\n"
    205 . "[B<-record_padding> I<padding>]\n"
    206 . "[B<-debug_broken_protocol>]\n"
    207 . "[B<-no_middlebox>]";
    208 $OpenSSL::safe::opt_s_item = ""
    209 . "=item B<-bugs>, B<-comp>, B<-no_comp>, B<-no_ticket>, B<-serverpref>,\n"
    210 . "B<-client_renegotiation>,\n"
    211 . "B<-legacy_renegotiation>, B<-no_renegotiation>,\n"
    212 . "B<-no_resumption_on_reneg>,\n"
    213 . "B<-legacy_server_connect>, B<-no_legacy_server_connect>, B<-no_etm>\n"
    214 . "B<-allow_no_dhe_kex>, B<-prefer_no_dhe_kex>,\n"
    215 . "B<-prioritize_chacha>, B<-strict>, B<-sigalgs>\n"
    216 . "I<algs>, B<-client_sigalgs> I<algs>, B<-groups> I<groups>, B<-curves>\n"
    217 . "I<curves>, B<-named_curve> I<curve>, B<-cipher> I<ciphers>, B<-ciphersuites>\n"
    218 . "I<1.3ciphers>, B<-min_protocol> I<minprot>, B<-max_protocol> I<maxprot>,\n"
    219 . "B<-record_padding> I<padding>, B<-debug_broken_protocol>, B<-no_middlebox>\n"
    220 . "\n"
    221 . "See L<SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS> for details.";
    222 
    223 package OpenSSL::safe;
    224 sub output_do_not_edit_headers {
    225     return "\n=begin comment\n\n"
    226         . join("\n", @autowarntext)
    227         . "\n\n=end comment";
    228 }
    229 1;
    230