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

rust_web_server/entry_point/config_file/
mod.rs
