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

rws_http/entry_point/config_file/
mod.rs
