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