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

rust_web_server/entry_point/config_file/
mod.rs
