rust_web_server/entry_point/command_line_args/
mod.rs

1use std::env;
2use crate::entry_point::Config;
3
4#[cfg(test)]
5mod tests;
6
7pub fn override_environment_variables_from_command_line_args() {
8    println!("\n  Start of Reading Command Line Arguments Section");
9
10    let args = env::args().collect();
11    let params = CommandLineArgument::get_command_line_arg_list();
12    CommandLineArgument::_parse(args, params);
13
14    println!("  End of Reading Command Line Arguments\n");
15}
16
17/// Returns the text to print for an informational flag — `--version` / `-V`
18/// or `--help` — if `args` (as from `env::args()`, program name first)
19/// contains one, so the binary can print it and exit before starting a
20/// server. `None` means start normally. `-h` is not a help alias: it's
21/// already `--cors-allow-headers`'s short form.
22pub fn informational_flag_output(args: &[String]) -> Option<String> {
23    let flags = args.iter().skip(1);
24    for arg in flags {
25        match arg.as_str() {
26            "--version" | "-V" => {
27                return Some(format!("rws {}\n", env!("CARGO_PKG_VERSION")));
28            }
29            "--help" => return Some(help_text()),
30            _ => {}
31        }
32    }
33    None
34}
35
36fn help_text() -> String {
37    let mut text = format!(
38        "rws {} — HTTP/1.1, HTTP/2 and HTTP/3 web server and reverse proxy\n\n\
39         Usage: rws [OPTIONS]\n\n\
40         Serves the current directory on http://0.0.0.0:7878 by default. Drop an\n\
41         rws.config.toml with [[route]]/[[upstream]] sections in the working\n\
42         directory to run as a config-driven reverse proxy instead.\n\n\
43         Options (each also settable via the environment variable shown):\n",
44        env!("CARGO_PKG_VERSION")
45    );
46    for argument in CommandLineArgument::get_command_line_arg_list() {
47        let flag = if argument.short_form.is_empty() {
48            format!("    --{}=<value>", argument.long_form)
49        } else {
50            format!("-{}, --{}=<value>", argument.short_form, argument.long_form)
51        };
52        let hint = argument._hint.unwrap_or_default();
53        text.push_str(&format!("  {:<44} {}\n  {:<44} [env: {}]\n", flag, hint, "", argument.environment_variable));
54    }
55    text.push_str("      --check[=<file>]                         Validate rws.config.toml (or <file>) and exit:\n");
56    text.push_str("                                               0 if it has no errors, 1 otherwise\n");
57    text.push_str("  -V, --version                                Print version and exit\n");
58    text.push_str("      --help                                   Print this help and exit\n");
59    text.push_str("      --windows-service=<dir>                  (Windows) Run as a service serving <dir>\n\n");
60    text.push_str("Docs: https://rws8.tech\n");
61    text
62}
63
64pub struct CommandLineArgument {
65    pub short_form: String,
66    pub long_form: String,
67    pub environment_variable: String,
68    pub _hint: Option<String>,
69}
70
71impl CommandLineArgument {
72    pub fn get_command_line_arg_list() -> Vec<CommandLineArgument> {
73        let mut argument_list : Vec<CommandLineArgument> = vec![];
74
75        let argument = CommandLineArgument {
76            short_form: "p".to_string(),
77            long_form: "port".to_string(),
78            environment_variable: Config::RWS_CONFIG_PORT.to_string(),
79            _hint: Some("Port".to_string())
80        };
81        argument_list.push(argument);
82
83        let argument = CommandLineArgument {
84            short_form: "i".to_string(),
85            long_form: "ip".to_string(),
86            environment_variable: Config::RWS_CONFIG_IP.to_string(),
87            _hint: Some("IP or domain".to_string())
88        };
89        argument_list.push(argument);
90
91        let argument = CommandLineArgument {
92            short_form: "t".to_string(),
93            long_form: "thread-count".to_string(),
94            environment_variable: Config::RWS_CONFIG_THREAD_COUNT.to_string(),
95            _hint: Some("Number of threads".to_string())
96        };
97        argument_list.push(argument);
98
99
100        let argument = CommandLineArgument {
101            short_form: "a".to_string(),
102            long_form: "cors-allow-all".to_string(),
103            environment_variable: Config::RWS_CONFIG_CORS_ALLOW_ALL.to_string(),
104            _hint: Some("If set to true, will allow all CORS requests, other CORS properties will be ignored".to_string())
105        };
106        argument_list.push(argument);
107
108        let argument = CommandLineArgument {
109            short_form: "o".to_string(),
110            long_form: "cors-allow-origins".to_string(),
111            environment_variable: Config::RWS_CONFIG_CORS_ALLOW_ORIGINS.to_string(),
112            _hint: Some("Comma separated list of allowed origins, example: https://foo.example,https://bar.example".to_string())
113        };
114        argument_list.push(argument);
115
116        let argument = CommandLineArgument {
117            short_form: "m".to_string(),
118            long_form: "cors-allow-methods".to_string(),
119            environment_variable: Config::RWS_CONFIG_CORS_ALLOW_METHODS.to_string(),
120            _hint: Some("Comma separated list of allowed methods, example: POST,PUT".to_string())
121        };
122        argument_list.push(argument);
123
124        let argument = CommandLineArgument {
125            short_form: "h".to_string(),
126            long_form: "cors-allow-headers".to_string(),
127            environment_variable: Config::RWS_CONFIG_CORS_ALLOW_HEADERS.to_string(),
128            _hint: Some("Comma separated list of allowed request headers, in lowercase, example: content-type,x-custom-header".to_string())
129        };
130        argument_list.push(argument);
131
132        let argument = CommandLineArgument {
133            short_form: "c".to_string(),
134            long_form: "cors-allow-credentials".to_string(),
135            environment_variable: Config::RWS_CONFIG_CORS_ALLOW_CREDENTIALS.to_string(),
136            _hint: Some("If set to true, will allow to transmit credentials via CORS requests".to_string())
137        };
138        argument_list.push(argument);
139
140        let argument = CommandLineArgument {
141            short_form: "e".to_string(),
142            long_form: "cors-expose-headers".to_string(),
143            environment_variable: Config::RWS_CONFIG_CORS_EXPOSE_HEADERS.to_string(),
144            _hint: Some("Comma separated list of allowed response headers, in lowercase, example: content-type,x-custom-header".to_string())
145        };
146        argument_list.push(argument);
147
148        let argument = CommandLineArgument {
149            short_form: "g".to_string(),
150            long_form: "cors-max-age".to_string(),
151            environment_variable: Config::RWS_CONFIG_CORS_MAX_AGE.to_string(),
152            _hint: Some("How long results of preflight requests can be cached (in seconds)".to_string())
153        };
154        argument_list.push(argument);
155
156        let argument = CommandLineArgument {
157            short_form: "r".to_string(),
158            long_form: "request-allocation-size-in-bytes".to_string(),
159            environment_variable: Config::RWS_CONFIG_REQUEST_ALLOCATION_SIZE_IN_BYTES.to_string(),
160            _hint: Some("In bytes, how much memory to allocate for each request".to_string())
161        };
162        argument_list.push(argument);
163
164        let argument = CommandLineArgument {
165            short_form: "s".to_string(),
166            long_form: "tls-cert-file".to_string(),
167            environment_variable: Config::RWS_CONFIG_TLS_CERT_FILE.to_string(),
168            _hint: Some("Path to TLS certificate PEM file (enables HTTPS and HTTP/2)".to_string())
169        };
170        argument_list.push(argument);
171
172        let argument = CommandLineArgument {
173            short_form: "k".to_string(),
174            long_form: "tls-key-file".to_string(),
175            environment_variable: Config::RWS_CONFIG_TLS_KEY_FILE.to_string(),
176            _hint: Some("Path to TLS private key PEM file (enables HTTPS and HTTP/2)".to_string())
177        };
178        argument_list.push(argument);
179
180        // Long-form only (empty short_form): every single letter that reads
181        // naturally is taken. In rws.config.toml these are `http_redirect_port`
182        // at the top level and the keys of an `[acme]` section (`domains`,
183        // `email`, ...), which the config-file reader prefixes to `acme-*`.
184        let long_only = [
185            ("http-redirect-port", Config::RWS_CONFIG_HTTP_REDIRECT_PORT,
186                "Plain-HTTP port that 301-redirects to HTTPS (and answers ACME HTTP-01 challenges), e.g. 80"),
187            ("acme-domains", Config::RWS_CONFIG_ACME_DOMAINS,
188                "Comma separated domains to get a Let's Encrypt certificate for; enables automatic HTTPS"),
189            ("acme-email", Config::RWS_CONFIG_ACME_EMAIL,
190                "Contact email for the ACME account"),
191            ("acme-staging", Config::RWS_CONFIG_ACME_STAGING,
192                "If set to true, uses the Let's Encrypt staging environment (untrusted test certificates)"),
193            ("acme-directory", Config::RWS_CONFIG_ACME_DIRECTORY,
194                "ACME directory URL of a CA other than Let's Encrypt"),
195            ("acme-ca-file", Config::RWS_CONFIG_ACME_CA_FILE,
196                "PEM file of extra root CAs to trust for the ACME directory (private ACME CAs)"),
197            ("acme-challenge-port", Config::RWS_CONFIG_ACME_CHALLENGE_PORT,
198                "Port the CA connects to for HTTP-01 challenges (default 80)"),
199            ("acme-cert-path", Config::RWS_CONFIG_ACME_CERT_PATH,
200                "Where to store the issued certificate (default: tls-cert-file, else .rws/acme/cert.pem)"),
201            ("acme-key-path", Config::RWS_CONFIG_ACME_KEY_PATH,
202                "Where to store the certificate's private key (default: tls-key-file, else .rws/acme/key.pem)"),
203            ("acme-profile", Config::RWS_CONFIG_ACME_PROFILE,
204                "Certificate profile to order, as the CA offers them (e.g. classic, tlsserver, shortlived)"),
205            ("acme-challenge", Config::RWS_CONFIG_ACME_CHALLENGE,
206                "How to prove control of the domains: http-01 (default), tls-alpn-01, dns-01 (wildcards) or dns-persist-01"),
207            ("acme-dns-provider", Config::RWS_CONFIG_ACME_DNS_PROVIDER,
208                "DNS-01: rfc2136 (DNS UPDATE), cloudflare, route53 or exec (a program)"),
209            ("acme-dns-server", Config::RWS_CONFIG_ACME_DNS_SERVER,
210                "DNS-01 rfc2136: the primary DNS server, host[:port]"),
211            ("acme-dns-zone", Config::RWS_CONFIG_ACME_DNS_ZONE,
212                "DNS-01: the zone of the records (found by SOA lookup when not set)"),
213            ("acme-dns-tsig-key", Config::RWS_CONFIG_ACME_DNS_TSIG_KEY,
214                "DNS-01 rfc2136: TSIG key name (the secret goes in RWS_CONFIG_ACME_DNS_TSIG_SECRET)"),
215            ("acme-dns-tsig-algorithm", Config::RWS_CONFIG_ACME_DNS_TSIG_ALGORITHM,
216                "DNS-01 rfc2136: hmac-sha256 (default) or hmac-sha512"),
217            ("acme-dns-exec", Config::RWS_CONFIG_ACME_DNS_EXEC,
218                "DNS-01 exec: program run as <program> present|cleanup <fqdn> <value>"),
219            ("acme-dns-propagation-secs", Config::RWS_CONFIG_ACME_DNS_PROPAGATION_SECS,
220                "DNS-01: seconds to wait for the record to be visible (default 120)"),
221            ("acme-dns-api-url", Config::RWS_CONFIG_ACME_DNS_API_URL,
222                "DNS-01 cloudflare/route53: API base URL instead of the provider's (the token goes in RWS_CONFIG_ACME_DNS_API_TOKEN)"),
223            ("acme-dns-zone-id", Config::RWS_CONFIG_ACME_DNS_ZONE_ID,
224                "DNS-01 cloudflare/route53: the zone's id, instead of looking it up"),
225            ("acme-redis", Config::RWS_CONFIG_ACME_REDIS,
226                "Redis host:port shared by replicas: one orders each certificate, all install it"),
227            ("acme-redis-prefix", Config::RWS_CONFIG_ACME_REDIS_PREFIX,
228                "Key prefix in that Redis (default rws:acme)"),
229            ("acme-on-demand", Config::RWS_CONFIG_ACME_ON_DEMAND,
230                "true: order a certificate at the first handshake for a name the ask endpoint allows"),
231            ("acme-on-demand-ask", Config::RWS_CONFIG_ACME_ON_DEMAND_ASK,
232                "On-demand TLS: URL asked ?domain=<name> before each order; 2xx allows it"),
233        ];
234        for (long_form, environment_variable, hint) in long_only {
235            argument_list.push(CommandLineArgument {
236                short_form: "".to_string(),
237                long_form: long_form.to_string(),
238                environment_variable: environment_variable.to_string(),
239                _hint: Some(hint.to_string()),
240            });
241        }
242
243        argument_list
244    }
245
246    pub fn _parse(args: Vec<String>, argument_list : Vec<CommandLineArgument>) -> Vec<CommandLineArgument> {
247        for unparsed_argument in args.iter() {
248
249            let boxed_split = unparsed_argument.split_once('=');
250            if boxed_split.is_some() {
251
252                let (parameter, value) = boxed_split.unwrap();
253                println!("\n    {}={}", parameter, crate::entry_point::shown(parameter, value));
254                let boxed_predefined_argument =
255                    argument_list
256                        .iter()
257                        .find(
258                            |predefined_argument| {
259                                let short_form = predefined_argument.short_form.to_string();
260                                let long_form = predefined_argument.long_form.to_string();
261                                let _param_short_form = ["-", &short_form].join("");
262                                let _param_long_form = ["--", &long_form].join("");
263
264                                (!short_form.is_empty() && parameter.eq(_param_short_form.as_str())) ||
265                                    parameter.eq(_param_long_form.as_str())
266                });
267                if boxed_predefined_argument.is_some() {
268                    let predefined_argument = boxed_predefined_argument.unwrap();
269                    CommandLineArgument::set_environment_variable(predefined_argument, value.to_string());
270                }
271
272            }
273        }
274        argument_list
275    }
276
277    pub fn set_environment_variable(argument: &CommandLineArgument, value: String) {
278        if value.contains('\0') {
279            // env::set_var panics on NUL; reachable from rws.config.toml values.
280            eprintln!("    Warning: value for --{} contains a NUL byte — ignored", argument.long_form);
281            return;
282        }
283        env::set_var(&argument.environment_variable, &value);
284        crate::server_config::invalidate();
285        println!("    Set env variable '{}' to value '{}'", argument.environment_variable, crate::entry_point::shown(&argument.environment_variable, &value));
286    }
287}
rust_web_server/entry_point/command_line_args/mod.rs

rust_web_server/entry_point/command_line_args/
mod.rs
