rws_http/entry_point/config_file/
mod.rs

1use std::collections::HashMap;
2use std::env;
3use std::io::{BufRead, Cursor};
4use crate::entry_point::command_line_args::CommandLineArgument;
5use file_ext::FileExt;
6
7#[doc(hidden)]
8pub mod toml_str;
9use toml_str::{unquote, Quotes};
10
11#[cfg(test)]
12mod tests;
13
14/// Settings that have an `RWS_CONFIG_*` variable but no command-line flag.
15/// In `rws.config.toml` they're written like any other key — the variable
16/// name is the table path plus key, upper-cased: `[rate_limit] max_requests`
17/// → `RWS_CONFIG_RATE_LIMIT_MAX_REQUESTS`. Settings that do have a flag are
18/// taken from `CommandLineArgument::get_command_line_arg_list()` instead.
19/// `tests.rs` checks this list against every `RWS_CONFIG_*` name in `src/`.
20pub const SETTINGS_WITHOUT_FLAG: &[&str] = &[
21    "RWS_CONFIG_CACHE_STATUS",
22    "RWS_CONFIG_TLS_INTERNAL_DIR",
23    "RWS_CONFIG_TLS_INTERNAL_NAMES",
24    "RWS_CONFIG_ERROR_FORMAT",
25    "RWS_CONFIG_TLS_CLIENT_CRL_FILE",
26    "RWS_CONFIG_TLS_CLIENT_CRL_STRICT",
27    "RWS_CONFIG_FORWARDED_HEADER",
28    "RWS_CONFIG_TRUSTED_PROXIES",
29    "RWS_CONFIG_METRICS_ALLOW",
30    "RWS_CONFIG_SHUTDOWN_DELAY_SECS",
31    "RWS_CONFIG_CLIENT_IP",
32    "RWS_CONFIG_PROXY_NAME",
33    "RWS_CONFIG_PROXY_STATUS",
34    "RWS_CONFIG_PROXY_STATUS_NEXT_HOP",
35    "RWS_CONFIG_ACME_ACCOUNT_KEY_PATH",
36    "RWS_CONFIG_ADMIN_ALLOWED_ORIGINS",
37    "RWS_CONFIG_ADMIN_USERS",
38    "RWS_CONFIG_CLUSTER_NODE",
39    "RWS_CONFIG_FLEET_SOURCE",
40    "RWS_CONFIG_FLEET_INTERVAL_SECS",
41    "RWS_CONFIG_FLEET_PUBLIC_KEY",
42    "RWS_CONFIG_FLEET_INSECURE",
43    "RWS_CONFIG_FLEET_REPORT_URL",
44    "RWS_CONFIG_FLEET_S3_ENDPOINT",
45    "RWS_CONFIG_CLUSTER_REDIS",
46    "RWS_CONFIG_CLUSTER_REDIS_PASSWORD",
47    "RWS_CONFIG_CLUSTER_PREFIX",
48    "RWS_CONFIG_ADMIN_AUDIT_LOG",
49    "RWS_CONFIG_ADMIN_OIDC_ISSUER",
50    "RWS_CONFIG_ADMIN_OIDC_PROVIDER",
51    "RWS_CONFIG_ADMIN_OIDC_TENANT",
52    "RWS_CONFIG_ADMIN_OIDC_CLIENT_ID",
53    "RWS_CONFIG_ADMIN_OIDC_CLIENT_SECRET_ENV",
54    "RWS_CONFIG_ADMIN_OIDC_COOKIE_SECRET_ENV",
55    "RWS_CONFIG_ADMIN_OIDC_ROLES",
56    "RWS_CONFIG_ADMIN_OIDC_ROLE_CLAIM",
57    "RWS_CONFIG_ADMIN_LISTEN",
58    "RWS_CONFIG_ADMIN_TOKEN_ENV",
59    "RWS_CONFIG_ACME_RENEW_BEFORE_DAYS",
60    "RWS_CONFIG_ACME_RENEW_CHECK_INTERVAL_SECS",
61    "RWS_CONFIG_CIRCUIT_BREAKER_FAILURE_THRESHOLD",
62    "RWS_CONFIG_CIRCUIT_BREAKER_MAX_HALF_OPEN_PROBES",
63    "RWS_CONFIG_CIRCUIT_BREAKER_RECOVERY_SECS",
64    "RWS_CONFIG_CLIENT_HINTS",
65    "RWS_CONFIG_CSP",
66    "RWS_CONFIG_ACME_DNS_TSIG_SECRET",
67    "RWS_CONFIG_ACME_REDIS_PASSWORD",
68    "RWS_CONFIG_ACME_DNS_API_TOKEN",
69    "RWS_CONFIG_ACCESS_LOG",
70    "RWS_CONFIG_ACCESS_LOG_KEEP",
71    "RWS_CONFIG_ACCESS_LOG_MAX_SIZE",
72    "RWS_CONFIG_ACCESS_LOG_ANONYMIZE_IP",
73    "RWS_CONFIG_ACCESS_LOG_IP_HASH_SECRET",
74    "RWS_CONFIG_ACCESS_LOG_SYSLOG",
75    "RWS_CONFIG_ACCESS_LOG_SYSLOG_FACILITY",
76    "RWS_CONFIG_LOG_REDACT_HEADERS",
77    "RWS_CONFIG_LOG_REDACT_QUERY",
78    "RWS_CONFIG_GATEWAY_API_CONTROLLER_NAME",
79    "RWS_CONFIG_GATEWAY_API_ENABLED",
80    "RWS_CONFIG_GATEWAY_API_GATEWAY",
81    "RWS_CONFIG_GATEWAY_API_IMAGE",
82    "RWS_CONFIG_GATEWAY_API_LEASE_NAMESPACE",
83    "RWS_CONFIG_GATEWAY_API_MODE",
84    "RWS_CONFIG_GATEWAY_API_POD_SELECTOR",
85    "RWS_CONFIG_GATEWAY_API_PORT_RANGE",
86    "RWS_CONFIG_GATEWAY_API_SERVICE_ACCOUNT",
87    "RWS_CONFIG_GATEWAY_API_SERVICE_TYPE",
88    "RWS_CONFIG_COMPRESSION_DICTIONARIES",
89    "RWS_CONFIG_EARLY_HINTS_HTTP1",
90    "RWS_CONFIG_LOG_FORMAT",
91    "RWS_CONFIG_MAX_BODY_SIZE_IN_BYTES",
92    "RWS_CONFIG_MIN_FREE_DISK",
93    "RWS_CONFIG_NANOS_HEADERS",
94    "RWS_CONFIG_OPEN_FILE_CACHE_SECS",
95    "RWS_CONFIG_OPEN_FILE_CACHE_STRICT",
96    "RWS_CONFIG_PROXY_PROTOCOL",
97    "RWS_CONFIG_RATE_LIMIT_MAX_REQUESTS",
98    "RWS_CONFIG_RATE_LIMIT_WINDOW_SECS",
99    "RWS_CONFIG_RUNTIME",
100    "RWS_CONFIG_SECURITY_HEADERS",
101    "RWS_CONFIG_SERVE_DOTFILES",
102    "RWS_CONFIG_SPA_FALLBACK",
103    "RWS_CONFIG_SPA_FALLBACK_EXCLUDE_PREFIXES",
104    "RWS_CONFIG_SPA_FALLBACK_ROUTES",
105    "RWS_CONFIG_STATIC_CACHE_CONTROL",
106    "RWS_CONFIG_DIRECTORY_LISTING",
107    "RWS_CONFIG_TEMPLATE_DIR",
108    "RWS_CONFIG_TLS_CLIENT_CA_FILE",
109    "RWS_CONFIG_WATCH",
110    "RWS_CONFIG_TRAFFIC_DATABASE_URL_ENV",
111    "RWS_CONFIG_TRAFFIC_ENABLED",
112    "RWS_CONFIG_TRAFFIC_EXCLUDE",
113    "RWS_CONFIG_TRAFFIC_GEO_DB",
114    "RWS_CONFIG_TRAFFIC_GOALS",
115    "RWS_CONFIG_TRAFFIC_PERSIST",
116    "RWS_CONFIG_TRAFFIC_RETENTION_DAYS",
117    "RWS_CONFIG_TRAFFIC_SCRIPT",
118];
119
120/// Tables (and their sub-tables) read by `proxy_config`'s own parser, not
121/// mapped to `RWS_CONFIG_*` variables.
122const PROXY_TABLES: &[&str] = &["route", "upstream", "tcp_proxy", "udp_proxy", "ws_proxy", "middleware", "authz"];
123
124/// `[[virtual_host]]` fields, set as `RWS_CONFIG_VIRTUAL_HOST_<n>_<FIELD>`.
125const VIRTUAL_HOST_FIELDS: &[&str] = &["DOMAIN", "CERT_FILE", "KEY_FILE"];
126
127/// The settings of a `rws.config.toml` document, resolved to the
128/// `RWS_CONFIG_*` variables they set — without touching the environment.
129#[derive(Debug, Default, PartialEq)]
130pub struct ConfigSettings {
131    /// `(RWS_CONFIG_* name, value)` in file order.
132    pub settings: Vec<(String, String)>,
133    /// Keys no setting answers to, as `key` or `[table] key`.
134    pub unknown: Vec<String>,
135}
136
137/// Resolve every setting in a `rws.config.toml` document. `prefix` is the
138/// table the document starts in (normally empty).
139///
140/// Top-level keys and keys in plain `[tables]` map to `RWS_CONFIG_<TABLE>_<KEY>`
141/// (`[cors] allow_all` → `RWS_CONFIG_CORS_ALLOW_ALL`); each `[[virtual_host]]`
142/// block maps to `RWS_CONFIG_VIRTUAL_HOST_<n>_*`. Strings keep their exact
143/// contents (spaces, quotes inside them); arrays become comma-separated lists.
144/// Proxy tables (`[[route]]`, `[[upstream]]`, …) are left to `proxy_config`.
145pub fn collect_settings(
146    cursor: Cursor<&[u8]>,
147    prefix: String) -> Result<ConfigSettings, String> {
148
149    let mut table = prefix;
150    // Index of the current [[array-table]] entry, per array-table name.
151    let mut array_table_counters: HashMap<String, usize> = HashMap::new();
152    let mut array_index: Option<usize> = None;
153    let mut resolved = ConfigSettings::default();
154    let flags = CommandLineArgument::get_command_line_arg_list();
155
156    for line in cursor.lines() {
157        let line = line.map_err(|e| e.to_string())?;
158        let line = strip_comment(&line).trim().to_string();
159        if line.is_empty() {
160            continue;
161        }
162
163        if let Some(name) = line.strip_prefix("[[").and_then(|l| l.strip_suffix("]]")) {
164            let name = name.trim().to_string();
165            let count = array_table_counters.entry(name.clone()).or_insert(0);
166            array_index = Some(*count);
167            *count += 1;
168            table = name;
169            continue;
170        }
171        if let Some(name) = line.strip_prefix('[').and_then(|l| l.strip_suffix(']')) {
172            table = name.trim().to_string();
173            array_index = None;
174            continue;
175        }
176
177        let Some((raw_key, raw_value)) = line.split_once('=') else { continue };
178        let key = raw_key.trim();
179
180        let root = table.split('.').next().unwrap_or("");
181        if PROXY_TABLES.contains(&root) {
182            continue;
183        }
184
185        // An inline table, `rate_limit = { max_requests = 5 }`, is the
186        // sub-table `[rate_limit]` (or `[<table>.rate_limit]`), as in TOML
187        // and as in the proxy sections.
188        if let Some(inner) = raw_value.trim().strip_prefix('{').and_then(|v| v.strip_suffix('}')) {
189            let sub_table = if table.is_empty() { key.to_string() } else { format!("{}.{}", table, key) };
190            for entry in split_top_level(inner) {
191                if let Some((inner_key, inner_value)) = entry.split_once('=') {
192                    resolve_setting(&sub_table, array_index, inner_key.trim(), parse_value(inner_value), &flags, &mut resolved);
193                } else if !entry.trim().is_empty() {
194                    resolved.unknown.push(qualified_key(&sub_table, entry.trim()));
195                }
196            }
197            continue;
198        }
199
200        resolve_setting(&table, array_index, key, parse_value(raw_value), &flags, &mut resolved);
201    }
202
203    Ok(resolved)
204}
205
206/// Map one `key = value` in `table` to its `RWS_CONFIG_*` setting, or record
207/// it as unknown.
208fn resolve_setting(
209    table: &str,
210    array_index: Option<usize>,
211    key: &str,
212    value: String,
213    flags: &[CommandLineArgument],
214    resolved: &mut ConfigSettings,
215) {
216    if table == "virtual_host" {
217        let field = key.to_ascii_uppercase();
218        if VIRTUAL_HOST_FIELDS.contains(&field.as_str()) {
219            let name = format!("RWS_CONFIG_VIRTUAL_HOST_{}_{}", array_index.unwrap_or(0), field);
220            resolved.settings.push((name, value));
221        } else {
222            resolved.unknown.push(qualified_key(table, key));
223        }
224        return;
225    }
226
227    let path = if table.is_empty() { key.to_string() } else { format!("{}_{}", table.replace('.', "_"), key) };
228    let long_form = path.replace('_', "-");
229    if let Some(flag) = flags.iter().find(|f| f.long_form == long_form) {
230        resolved.settings.push((flag.environment_variable.clone(), value));
231        return;
232    }
233    let name = format!("RWS_CONFIG_{}", path.to_ascii_uppercase());
234    if SETTINGS_WITHOUT_FLAG.contains(&name.as_str()) {
235        resolved.settings.push((name, value));
236    } else {
237        resolved.unknown.push(qualified_key(table, key));
238    }
239}
240
241/// Split an inline table's body on commas outside quotes and `[...]`.
242fn split_top_level(inner: &str) -> Vec<&str> {
243    let mut items = vec![];
244    let mut quote: Option<char> = None;
245    let mut depth = 0usize;
246    let mut start = 0;
247    for (i, c) in inner.char_indices() {
248        match (quote, c) {
249            (None, '"') | (None, '\'') => quote = Some(c),
250            (Some(q), c) if c == q => quote = None,
251            (None, '[') => depth += 1,
252            (None, ']') => depth = depth.saturating_sub(1),
253            (None, ',') if depth == 0 => {
254                items.push(&inner[start..i]);
255                start = i + 1;
256            }
257            _ => {}
258        }
259    }
260    items.push(&inner[start..]);
261    items
262}
263
264/// Apply every setting in a `rws.config.toml` document to the process
265/// environment (see [`collect_settings`]). Unknown keys are reported on
266/// stderr instead of being ignored silently.
267pub fn read_config_file(
268    cursor: Cursor<&[u8]>,
269    prefix: String) -> Result<bool, String> {
270    let resolved = collect_settings(cursor, prefix)?;
271    for (name, value) in &resolved.settings {
272        set_setting(name, value);
273    }
274    for key in &resolved.unknown {
275        eprintln!("    Warning: unknown setting '{}' in rws.config.toml — ignored", key);
276    }
277    Ok(true)
278}
279
280fn set_setting(name: &str, value: &str) {
281    if value.contains('\0') {
282        // env::set_var panics on NUL — a stray byte in the file must not crash startup.
283        eprintln!("    Warning: value for {} contains a NUL byte — ignored", name);
284        return;
285    }
286    env::set_var(name, value);
287    crate::server_config::invalidate();
288    println!("    Set env variable '{}' to value '{}'", name, crate::entry_point::shown(name, value));
289}
290
291fn qualified_key(table: &str, key: &str) -> String {
292    if table.is_empty() { key.to_string() } else { format!("[{}] {}", table, key) }
293}
294
295/// Drop a trailing `# comment`, ignoring `#` inside quoted strings.
296fn strip_comment(line: &str) -> &str {
297    let mut quotes = Quotes::default();
298    for (i, c) in line.char_indices() {
299        if !quotes.step(c) && c == '#' {
300            return &line[..i];
301        }
302    }
303    line
304}
305
306/// A TOML value as a plain string: quoted strings lose their quotes (basic
307/// strings also their escapes, see [`toml_str::unquote`]), arrays become
308/// `a,b,c`, anything else (numbers, booleans) is trimmed.
309fn parse_value(raw: &str) -> String {
310    let raw = raw.trim();
311    if let Some(inner) = raw.strip_prefix('[').and_then(|r| r.strip_suffix(']')) {
312        return split_array(inner)
313            .iter()
314            .map(|item| unquote(item.trim()))
315            .filter(|item| !item.is_empty())
316            .collect::<Vec<_>>()
317            .join(",");
318    }
319    unquote(raw)
320}
321
322/// Split array items on commas outside quotes.
323fn split_array(inner: &str) -> Vec<&str> {
324    let mut items = vec![];
325    let mut quotes = Quotes::default();
326    let mut start = 0;
327    for (i, c) in inner.char_indices() {
328        if !quotes.step(c) && c == ',' {
329            items.push(&inner[start..i]);
330            start = i + 1;
331        }
332    }
333    items.push(&inner[start..]);
334    items
335}
336
337/// Load `rws.config.toml` into the environment: `filepath` (relative to the
338/// working directory) when given, else the file named by `RWS_CONFIG_FILE`
339/// (absolute, or relative to the working directory) — the same variable
340/// `proxy_config` reads routes from — else `rws.config.toml` in the working
341/// directory.
342pub fn override_environment_variables_from_config(filepath: Option<&str>) {
343    println!("\n  Start of Config Section");
344
345    let from_env = env::var("RWS_CONFIG_FILE").ok().filter(|p| !p.trim().is_empty());
346    let resolved = match (filepath, from_env) {
347        (Some(path), _) => FileExt::get_static_filepath(path),
348        (None, Some(path)) => Ok(path),
349        (None, None) => FileExt::get_static_filepath("/rws.config.toml"),
350    };
351    let path = match resolved {
352        Ok(path) => path,
353        Err(e) => {
354            eprintln!("{}", e);
355            println!("  End of Config Section");
356            return;
357        }
358    };
359
360    match std::fs::read_to_string(&path) {
361        Ok(content) => {
362            if let Err(e) = read_config_file(Cursor::new(content.as_bytes()), String::new()) {
363                eprintln!("    Unable to parse {}: {}", path, e);
364            }
365        }
366        Err(e) => eprintln!("    Unable to read {}: {}", path, e),
367    }
368
369    println!("  End of Config Section");
370}
rws_http/entry_point/config_file/mod.rs

rws_http/entry_point/config_file/
mod.rs
