Add -CAstore and similar to all openssl commands that have -CApath
[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
71 # Random State Options
72 $OpenSSL::safe::opt_r_synopsis = ""
73 . "[B<-rand> I<files>]\n"
74 . "[B<-writerand> I<file>]";
75 $OpenSSL::safe::opt_r_item = ""
76 . "=item B<-rand> I<files>, B<-writerand> I<file>\n"
77 . "\n"
78 . "See L<openssl(1)/Random State Options> for details.";
79
80 # Trusted certs options
81 $OpenSSL::safe::opt_trust_synopsis = ""
82 . "[B<-CAfile> I<file>]\n"
83 . "[B<-no-CAfile>]\n"
84 . "[B<-CApath> I<dir>]\n"
85 . "[B<-no-CApath>]\n"
86 . "[B<-CAstore> I<uri>]\n"
87 . "[B<-no-CAstore>]";
88 $OpenSSL::safe::opt_trust_item = ""
89 . "=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>,\n"
90 . "B<-CAstore> I<uri>, B<-no-CAstore>\n"
91 . "\n"
92 . "See L<openssl(1)/Trusted Certificate Options> for details.";
93
94 # SSL connection options.
95 # TODO(3.0) Not currently used.  The refactoring needs to be done, and
96 # the options will probably be re-ordered.
97 $OpenSSL::safe::opt_s_synopsis = ""
98 . "[B<-bugs>]\n"
99 . "[B<-no_comp>]\n"
100 . "[B<-no_ticket>]\n"
101 . "[B<-serverpref>]\n"
102 . "[B<-legacy_renegotiation>]\n"
103 . "[B<-no_renegotiation>]\n"
104 . "[B<-legacy_server_connect>]\n"
105 . "[B<-no_resumption_on_reneg>]\n"
106 . "[B<-no_legacy_server_connect>]\n"
107 . "[B<-allow_no_dhe_kex>]\n"
108 . "[B<-prioritize_chacha>]\n"
109 . "[B<-strict>]\n"
110 . "[B<-sigalgs> I<algs>]\n"
111 . "[B<-client_sigalgs> I<algs>]\n"
112 . "[B<-groups> I<groups>]\n"
113 . "[B<-curves> I<curves>]\n"
114 . "[B<-named_curve> I<curves>]\n"
115 . "[B<-cipher> I<ciphers>]\n"
116 . "[B<-ciphersuites> I<1.3ciphers>]\n"
117 . "[B<-min_protocol> I<minprot>]\n"
118 . "[B<-max_protocol> I<maxprot>]\n"
119 . "[B<-record_padding> I<padding>]\n"
120 . "[B<-debug_broken_protocol>]\n"
121 . "[B<-no_middlebox>]";
122 $OpenSSL::safe::opt_s_item = ""
123 . "=item B<-bugs>, B<-no_comp>, B<-no_ticket>, B<-serverpref>,"
124 . "B<-legacy_renegotiation>, B<-no_renegotiation>, B<-legacy_server_connect>,\n"
125 . "B<-no_resumption_on_reneg>, B<-no_legacy_server_connect>,\n"
126 . "B<-allow_no_dhe_kex>, B<-prioritize_chacha>, B<-strict>, B<-sigalgs>\n"
127 . "I<algs>, B<-client_sigalgs> I<algs>, B<-groups> I<groups>, B<-curves>\n"
128 . "I<curves>, B<-named_curve> I<curves>, B<-cipher> I<ciphers>, B<-ciphersuites>\n"
129 . "I<1.3ciphers>, B<-min_protocol> I<minprot>, B<-max_protocol> I<maxprot>,\n"
130 . "B<-record_padding> I<padding>, B<-debug_broken_protocol>, B<-no_middlebox>\n"
131 . "\n"
132 . "See L<SSL_CONF_cmd(3)/SUPPORTED COMMAND LINE COMMANDS> for details.";