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

rust_web_server/entry_point/config_file/
mod.rs
