X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=doc%2Fperlvars.pm;fp=doc%2Fperlvars.pm;h=ca62ca5ce9c08cf8bac77f104140f67d18188a60;hp=0000000000000000000000000000000000000000;hb=9fcb9702fba8aa135945f96aefddf050a6f4f11d;hpb=fb1ecf85c9f732e5827771ff243d7a70e06ce112 diff --git a/doc/perlvars.pm b/doc/perlvars.pm new file mode 100644 index 0000000000..ca62ca5ce9 --- /dev/null +++ b/doc/perlvars.pm @@ -0,0 +1,129 @@ +#! /usr/bin/env perl +# Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. +# +# Licensed under the Apache License 2.0 (the "License"). You may not use +# this file except in compliance with the License. You can obtain a copy +# in the file LICENSE in the source distribution or at + +# Set some Perl variables for use by util/dofile.pl when processing +# POD files (mainly man1). + +# Verify options +$OpenSSL::safe::opt_v_synopsis = "" +. "[B<-attime> I]\n" +. "[B<-check_ss_sig>]\n" +. "[B<-crl_check>]\n" +. "[B<-crl_check_all>]\n" +. "[B<-explicit_policy>]\n" +. "[B<-extended_crl>]\n" +. "[B<-ignore_critical>]\n" +. "[B<-inhibit_any>]\n" +. "[B<-inhibit_map>]\n" +. "[B<-partial_chain>]\n" +. "[B<-policy> I]\n" +. "[B<-policy_check>]\n" +. "[B<-policy_print>]\n" +. "[B<-purpose> I]\n" +. "[B<-suiteB_128>]\n" +. "[B<-suiteB_128_only>]\n" +. "[B<-suiteB_192>]\n" +. "[B<-trusted_first>]\n" +. "[B<-no_alt_chains>]\n" +. "[B<-use_deltas>]\n" +. "[B<-auth_level> I]\n" +. "[B<-verify_depth> I]\n" +. "[B<-verify_email> I]\n" +. "[B<-verify_hostname> I]\n" +. "[B<-verify_ip> I]\n" +. "[B<-verify_name> I]\n" +. "[B<-x509_strict>]\n" +. "[B<-certfile> I]"; +$OpenSSL::safe::opt_v_item = "" +. "=item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>,\n" +. "B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>,\n" +. "B<-inhibit_map>, B<-no_alt_chains>, B<-partial_chain>, B<-policy>,\n" +. "B<-policy_check>, B<-policy_print>, B<-purpose>, B<-suiteB_128>,\n" +. "B<-suiteB_128_only>, B<-suiteB_192>, B<-trusted_first>, B<-use_deltas>,\n" +. "B<-auth_level>, B<-verify_depth>, B<-verify_email>, B<-verify_hostname>,\n" +. "B<-verify_ip>, B<-verify_name>, B<-x509_strict>\n" +. "\n" +. "Set various options of certificate chain verification.\n" +. "See L for details."; + + +# Extended validation options. +$OpenSSL::safe::opt_x_synopsis = "" +. "[B<-xkey>] I\n" +. "[B<-xcert> I]\n" +. "[B<-xchain>] I\n" +. "[B<-xchain_build>] I\n" +. "[B<-xcertform> B|B]>\n" +. "[B<-xkeyform> B|B]>"; +$OpenSSL::safe::opt_x_item = "" +. "=item B I, B<-xcert> I, B<-xchain> I,\n" +. "B<-xchain_build> I, B<-xcertform> B|B,\n" +. "B<-xkeyform> B|B>\n" +. "\n" +. "Set extended certificate verification options.\n" +. "See L for details."; + + +# Random State Options +$OpenSSL::safe::opt_r_synopsis = "" +. "[B<-rand> I]\n" +. "[B<-writerand> I]"; +$OpenSSL::safe::opt_r_item = "" +. "=item B<-rand> I, B<-writerand> I\n" +. "\n" +. "See L for details."; + +# Trusted certs options +$OpenSSL::safe::opt_trust_synopsis = "" +. "[B<-CAfile> I]\n" +. "[B<-no-CAfile>]\n" +. "[B<-CApath> I]\n" +. "[B<-no-CApath>]"; +$OpenSSL::safe::opt_trust_item = "" +. "=item B<-CAfile> I, B<-no-CAfile>, B<-CApath> I, B<-no-CApath>\n" +. "\n" +. "See L for details."; + +# SSL connection options. +# TODO(3.0) Not currently used. The refactoring needs to be done, and +# the options will probably be re-ordered. +$OpenSSL::safe::opt_s_synopsis = "" +. "[B<-bugs>]\n" +. "[B<-no_comp>]\n" +. "[B<-no_ticket>]\n" +. "[B<-serverpref>]\n" +. "[B<-legacy_renegotiation>]\n" +. "[B<-no_renegotiation>]\n" +. "[B<-legacy_server_connect>]\n" +. "[B<-no_resumption_on_reneg>]\n" +. "[B<-no_legacy_server_connect>]\n" +. "[B<-allow_no_dhe_kex>]\n" +. "[B<-prioritize_chacha>]\n" +. "[B<-strict>]\n" +. "[B<-sigalgs> I]\n" +. "[B<-client_sigalgs> I]\n" +. "[B<-groups> I]\n" +. "[B<-curves> I]\n" +. "[B<-named_curve> I]\n" +. "[B<-cipher> I]\n" +. "[B<-ciphersuites> I<1.3ciphers>]\n" +. "[B<-min_protocol> I]\n" +. "[B<-max_protocol> I]\n" +. "[B<-record_padding> I]\n" +. "[B<-debug_broken_protocol>]\n" +. "[B<-no_middlebox>]"; +$OpenSSL::safe::opt_s_item = "" +. "=item B<-bugs>, B<-no_comp>, B<-no_ticket>, B<-serverpref>," +. "B<-legacy_renegotiation>, B<-no_renegotiation>, B<-legacy_server_connect>,\n" +. "B<-no_resumption_on_reneg>, B<-no_legacy_server_connect>,\n" +. "B<-allow_no_dhe_kex>, B<-prioritize_chacha>, B<-strict>, B<-sigalgs>\n" +. "I, B<-client_sigalgs> I, B<-groups> I, B<-curves>\n" +. "I, B<-named_curve> I, B<-cipher> I, B<-ciphersuites>\n" +. "I<1.3ciphers>, B<-min_protocol> I, B<-max_protocol> I,\n" +. "B<-record_padding> I, B<-debug_broken_protocol>, B<-no_middlebox>\n" +. "\n" +. "See L for details.";