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

rws_http/entry_point/config_file/
mod.rs
