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

rws_http/entry_point/config_file/
mod.rs
