rws-http 18.37.0

The HTTP layer of rust-web-server (internal: use the rust-web-server crate).
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
use std::collections::HashMap;
use std::env;
use std::io::{BufRead, Cursor};
use crate::entry_point::command_line_args::CommandLineArgument;
use file_ext::FileExt;

#[doc(hidden)]
pub mod toml_str;
use toml_str::{unquote, Quotes};

#[cfg(test)]
mod tests;

/// Settings that have an `RWS_CONFIG_*` variable but no command-line flag.
/// In `rws.config.toml` they're written like any other key — the variable
/// name is the table path plus key, upper-cased: `[rate_limit] max_requests`
/// → `RWS_CONFIG_RATE_LIMIT_MAX_REQUESTS`. Settings that do have a flag are
/// taken from `CommandLineArgument::get_command_line_arg_list()` instead.
/// `tests.rs` checks this list against every `RWS_CONFIG_*` name in `src/`.
pub const SETTINGS_WITHOUT_FLAG: &[&str] = &[
    "RWS_CONFIG_CACHE_STATUS",
    "RWS_CONFIG_TLS_INTERNAL_DIR",
    "RWS_CONFIG_TLS_INTERNAL_NAMES",
    "RWS_CONFIG_ERROR_FORMAT",
    "RWS_CONFIG_MAINTENANCE_MESSAGE",
    "RWS_CONFIG_MAINTENANCE_RETRY_AFTER_SECS",
    "RWS_CONFIG_TLS_CLIENT_CRL_FILE",
    "RWS_CONFIG_TLS_CLIENT_CRL_STRICT",
    "RWS_CONFIG_FORWARDED_HEADER",
    "RWS_CONFIG_TRUSTED_PROXIES",
    "RWS_CONFIG_METRICS_ALLOW",
    "RWS_CONFIG_SHUTDOWN_DELAY_SECS",
    "RWS_CONFIG_SHUTDOWN_TIMEOUT_SECS",
    "RWS_CONFIG_CLIENT_IP",
    "RWS_CONFIG_PROXY_NAME",
    "RWS_CONFIG_PROXY_STATUS",
    "RWS_CONFIG_PROXY_STATUS_NEXT_HOP",
    "RWS_CONFIG_ACME_ACCOUNT_KEY_PATH",
    "RWS_CONFIG_ADMIN_ALLOWED_ORIGINS",
    "RWS_CONFIG_ADMIN_USERS",
    "RWS_CONFIG_ADMIN_COUNT_OWN_REQUESTS",
    "RWS_CONFIG_CLUSTER_NODE",
    "RWS_CONFIG_FLEET_SOURCE",
    "RWS_CONFIG_FLEET_INTERVAL_SECS",
    "RWS_CONFIG_FLEET_PUBLIC_KEY",
    "RWS_CONFIG_FLEET_INSECURE",
    "RWS_CONFIG_FLEET_REPORT_URL",
    "RWS_CONFIG_FLEET_S3_ENDPOINT",
    "RWS_CONFIG_CLUSTER_REDIS",
    "RWS_CONFIG_CLUSTER_REDIS_PASSWORD",
    "RWS_CONFIG_CLUSTER_PREFIX",
    "RWS_CONFIG_ADMIN_AUDIT_LOG",
    "RWS_CONFIG_ADMIN_OIDC_ISSUER",
    "RWS_CONFIG_ADMIN_OIDC_PROVIDER",
    "RWS_CONFIG_ADMIN_OIDC_TENANT",
    "RWS_CONFIG_ADMIN_OIDC_CLIENT_ID",
    "RWS_CONFIG_ADMIN_OIDC_CLIENT_SECRET_ENV",
    "RWS_CONFIG_ADMIN_OIDC_COOKIE_SECRET_ENV",
    "RWS_CONFIG_ADMIN_OIDC_ROLES",
    "RWS_CONFIG_ADMIN_OIDC_ROLE_CLAIM",
    "RWS_CONFIG_ADMIN_LISTEN",
    "RWS_CONFIG_ADMIN_TOKEN_ENV",
    "RWS_CONFIG_ACME_RENEW_BEFORE_DAYS",
    "RWS_CONFIG_ACME_RENEW_CHECK_INTERVAL_SECS",
    "RWS_CONFIG_CIRCUIT_BREAKER_FAILURE_THRESHOLD",
    "RWS_CONFIG_CIRCUIT_BREAKER_MAX_HALF_OPEN_PROBES",
    "RWS_CONFIG_CIRCUIT_BREAKER_RECOVERY_SECS",
    "RWS_CONFIG_CLIENT_HINTS",
    "RWS_CONFIG_CSP",
    "RWS_CONFIG_ACME_DNS_TSIG_SECRET",
    "RWS_CONFIG_ACME_REDIS_PASSWORD",
    "RWS_CONFIG_ACME_DNS_API_TOKEN",
    "RWS_CONFIG_ACCESS_LOG",
    "RWS_CONFIG_ACCESS_LOG_KEEP",
    "RWS_CONFIG_ACCESS_LOG_MAX_SIZE",
    "RWS_CONFIG_ACCESS_LOG_ANONYMIZE_IP",
    "RWS_CONFIG_ACCESS_LOG_IP_HASH_SECRET",
    "RWS_CONFIG_ACCESS_LOG_SYSLOG",
    "RWS_CONFIG_ACCESS_LOG_SYSLOG_FACILITY",
    "RWS_CONFIG_LOG_REDACT_HEADERS",
    "RWS_CONFIG_LOG_REDACT_QUERY",
    "RWS_CONFIG_GATEWAY_API_CONTROLLER_NAME",
    "RWS_CONFIG_GATEWAY_API_ENABLED",
    "RWS_CONFIG_GATEWAY_API_EXPERIMENTAL",
    "RWS_CONFIG_GATEWAY_API_GATEWAY",
    "RWS_CONFIG_GATEWAY_API_IMAGE",
    "RWS_CONFIG_GATEWAY_API_LEASE_NAMESPACE",
    "RWS_CONFIG_GATEWAY_API_MESH",
    "RWS_CONFIG_GATEWAY_API_MESH_CONFIG_URL",
    "RWS_CONFIG_GATEWAY_API_MESH_INIT_IMAGE",
    "RWS_CONFIG_GATEWAY_API_MESH_PORT",
    "RWS_CONFIG_GATEWAY_API_MESH_SIDECAR_IMAGE",
    "RWS_CONFIG_GATEWAY_API_MESH_WEBHOOK_CERT_FILE",
    "RWS_CONFIG_GATEWAY_API_MESH_WEBHOOK_KEY_FILE",
    "RWS_CONFIG_GATEWAY_API_MESH_WEBHOOK_PORT",
    "RWS_CONFIG_GATEWAY_API_MODE",
    "RWS_CONFIG_GATEWAY_API_POD_SELECTOR",
    "RWS_CONFIG_GATEWAY_API_PORT_RANGE",
    "RWS_CONFIG_GATEWAY_API_SERVICE_ACCOUNT",
    "RWS_CONFIG_GATEWAY_API_SERVICE_TYPE",
    "RWS_CONFIG_COMPRESSION_DICTIONARIES",
    "RWS_CONFIG_EARLY_HINTS_HTTP1",
    "RWS_CONFIG_LOG_FORMAT",
    "RWS_CONFIG_MAX_BODY_SIZE_IN_BYTES",
    "RWS_CONFIG_MIN_FREE_DISK",
    "RWS_CONFIG_NANOS_HEADERS",
    "RWS_CONFIG_OPEN_FILE_CACHE_SECS",
    "RWS_CONFIG_OPEN_FILE_CACHE_STRICT",
    "RWS_CONFIG_PROXY_PROTOCOL",
    "RWS_CONFIG_RATE_LIMIT_MAX_REQUESTS",
    "RWS_CONFIG_RATE_LIMIT_WINDOW_SECS",
    "RWS_CONFIG_RUNTIME",
    "RWS_CONFIG_SECURITY_HEADERS",
    "RWS_CONFIG_SERVE_DOTFILES",
    "RWS_CONFIG_SPA_FALLBACK",
    "RWS_CONFIG_SPA_FALLBACK_EXCLUDE_PREFIXES",
    "RWS_CONFIG_SPA_FALLBACK_ROUTES",
    "RWS_CONFIG_STATIC_CACHE_CONTROL",
    "RWS_CONFIG_DIRECTORY_LISTING",
    "RWS_CONFIG_TEMPLATE_DIR",
    "RWS_CONFIG_TLS_CLIENT_CA_FILE",
    "RWS_CONFIG_WATCH",
    "RWS_CONFIG_TRAFFIC_DATABASE_URL_ENV",
    "RWS_CONFIG_TRAFFIC_ENABLED",
    "RWS_CONFIG_TRAFFIC_EXCLUDE",
    "RWS_CONFIG_TRAFFIC_GEO_DB",
    "RWS_CONFIG_TRAFFIC_GOALS",
    "RWS_CONFIG_TRAFFIC_HOSTING_NETWORKS",
    "RWS_CONFIG_TRAFFIC_APPS",
    "RWS_CONFIG_TRAFFIC_OWNER_NETWORKS",
    "RWS_CONFIG_TRAFFIC_PROBE_ADDRESSES",
    "RWS_CONFIG_TRAFFIC_HIDE_HOSTS",
    "RWS_CONFIG_TRAFFIC_IGNORE_REFERRERS",
    "RWS_CONFIG_TRAFFIC_PERSIST",
    "RWS_CONFIG_TRAFFIC_RETENTION_DAYS",
    "RWS_CONFIG_TRAFFIC_SCRIPT",
];

/// Tables (and their sub-tables) read by `proxy_config`'s own parser, not
/// mapped to `RWS_CONFIG_*` variables.
const PROXY_TABLES: &[&str] = &["route", "upstream", "tcp_proxy", "udp_proxy", "ws_proxy", "middleware", "authz"];

/// `[[virtual_host]]` fields, set as `RWS_CONFIG_VIRTUAL_HOST_<n>_<FIELD>`.
const VIRTUAL_HOST_FIELDS: &[&str] = &["DOMAIN", "CERT_FILE", "KEY_FILE"];

/// The settings of a `rws.config.toml` document, resolved to the
/// `RWS_CONFIG_*` variables they set — without touching the environment.
#[derive(Debug, Default, PartialEq)]
pub struct ConfigSettings {
    /// `(RWS_CONFIG_* name, value)` in file order.
    pub settings: Vec<(String, String)>,
    /// Keys no setting answers to, as `key` or `[table] key`.
    pub unknown: Vec<String>,
}

/// Resolve every setting in a `rws.config.toml` document. `prefix` is the
/// table the document starts in (normally empty).
///
/// Top-level keys and keys in plain `[tables]` map to `RWS_CONFIG_<TABLE>_<KEY>`
/// (`[cors] allow_all` → `RWS_CONFIG_CORS_ALLOW_ALL`); each `[[virtual_host]]`
/// block maps to `RWS_CONFIG_VIRTUAL_HOST_<n>_*`. Strings keep their exact
/// contents (spaces, quotes inside them); arrays become comma-separated lists.
/// Proxy tables (`[[route]]`, `[[upstream]]`, …) are left to `proxy_config`.
pub fn collect_settings(
    cursor: Cursor<&[u8]>,
    prefix: String) -> Result<ConfigSettings, String> {

    let mut table = prefix;
    // Index of the current [[array-table]] entry, per array-table name.
    let mut array_table_counters: HashMap<String, usize> = HashMap::new();
    let mut array_index: Option<usize> = None;
    let mut resolved = ConfigSettings::default();
    let flags = CommandLineArgument::get_command_line_arg_list();

    for line in cursor.lines() {
        let line = line.map_err(|e| e.to_string())?;
        let line = strip_comment(&line).trim().to_string();
        if line.is_empty() {
            continue;
        }

        if let Some(name) = line.strip_prefix("[[").and_then(|l| l.strip_suffix("]]")) {
            let name = name.trim().to_string();
            let count = array_table_counters.entry(name.clone()).or_insert(0);
            array_index = Some(*count);
            *count += 1;
            table = name;
            continue;
        }
        if let Some(name) = line.strip_prefix('[').and_then(|l| l.strip_suffix(']')) {
            table = name.trim().to_string();
            array_index = None;
            continue;
        }

        let Some((raw_key, raw_value)) = line.split_once('=') else { continue };
        let key = raw_key.trim();

        let root = table.split('.').next().unwrap_or("");
        if PROXY_TABLES.contains(&root) {
            continue;
        }

        // An inline table, `rate_limit = { max_requests = 5 }`, is the
        // sub-table `[rate_limit]` (or `[<table>.rate_limit]`), as in TOML
        // and as in the proxy sections.
        if let Some(inner) = raw_value.trim().strip_prefix('{').and_then(|v| v.strip_suffix('}')) {
            let sub_table = if table.is_empty() { key.to_string() } else { format!("{}.{}", table, key) };
            for entry in split_top_level(inner) {
                if let Some((inner_key, inner_value)) = entry.split_once('=') {
                    resolve_setting(&sub_table, array_index, inner_key.trim(), parse_value(inner_value), &flags, &mut resolved);
                } else if !entry.trim().is_empty() {
                    resolved.unknown.push(qualified_key(&sub_table, entry.trim()));
                }
            }
            continue;
        }

        resolve_setting(&table, array_index, key, parse_value(raw_value), &flags, &mut resolved);
    }

    Ok(resolved)
}

/// Map one `key = value` in `table` to its `RWS_CONFIG_*` setting, or record
/// it as unknown.
fn resolve_setting(
    table: &str,
    array_index: Option<usize>,
    key: &str,
    value: String,
    flags: &[CommandLineArgument],
    resolved: &mut ConfigSettings,
) {
    if table == "virtual_host" {
        let field = key.to_ascii_uppercase();
        if VIRTUAL_HOST_FIELDS.contains(&field.as_str()) {
            let name = format!("RWS_CONFIG_VIRTUAL_HOST_{}_{}", array_index.unwrap_or(0), field);
            resolved.settings.push((name, value));
        } else {
            resolved.unknown.push(qualified_key(table, key));
        }
        return;
    }

    let path = if table.is_empty() { key.to_string() } else { format!("{}_{}", table.replace('.', "_"), key) };
    let long_form = path.replace('_', "-");
    if let Some(flag) = flags.iter().find(|f| f.long_form == long_form) {
        resolved.settings.push((flag.environment_variable.clone(), value));
        return;
    }
    let name = format!("RWS_CONFIG_{}", path.to_ascii_uppercase());
    if SETTINGS_WITHOUT_FLAG.contains(&name.as_str()) {
        resolved.settings.push((name, value));
    } else {
        resolved.unknown.push(qualified_key(table, key));
    }
}

/// Split an inline table's body on commas outside quotes and `[...]`.
fn split_top_level(inner: &str) -> Vec<&str> {
    let mut items = vec![];
    let mut quote: Option<char> = None;
    let mut depth = 0usize;
    let mut start = 0;
    for (i, c) in inner.char_indices() {
        match (quote, c) {
            (None, '"') | (None, '\'') => quote = Some(c),
            (Some(q), c) if c == q => quote = None,
            (None, '[') => depth += 1,
            (None, ']') => depth = depth.saturating_sub(1),
            (None, ',') if depth == 0 => {
                items.push(&inner[start..i]);
                start = i + 1;
            }
            _ => {}
        }
    }
    items.push(&inner[start..]);
    items
}

/// Apply every setting in a `rws.config.toml` document to the process
/// environment (see [`collect_settings`]). Unknown keys are reported on
/// stderr instead of being ignored silently.
pub fn read_config_file(
    cursor: Cursor<&[u8]>,
    prefix: String) -> Result<bool, String> {
    let resolved = collect_settings(cursor, prefix)?;
    for (name, value) in &resolved.settings {
        set_setting(name, value);
    }
    for key in &resolved.unknown {
        eprintln!("Warning: unknown setting '{}' in rws.config.toml — ignored{}", key, crate::entry_point::config_file::suggestion(key).map(|s| format!(" (did you mean '{s}'?)")).unwrap_or_default());
    }
    Ok(true)
}

/// The known setting closest to an unknown `key` (`[admn] listen` →
/// `[admin] listen`), written the way the unknown one was.
pub fn suggestion(key: &str) -> Option<String> {
    let (table, name) = match key.strip_prefix('[').and_then(|k| k.split_once("] ")) {
        Some((t, n)) => (t.to_string(), n.to_string()),
        None => (String::new(), key.to_string()),
    };
    let path = if table.is_empty() { name.clone() } else { format!("{}_{}", table.replace('.', "_"), name) };
    let path = path.to_ascii_lowercase();
    let mut known: Vec<String> = CommandLineArgument::get_command_line_arg_list().iter().map(|f| f.long_form.replace('-', "_")).collect();
    known.extend(SETTINGS_WITHOUT_FLAG.iter().map(|n| n.trim_start_matches("RWS_CONFIG_").to_ascii_lowercase()));
    let limit = if path.len() < 4 { 1 } else { 2 };
    let best = known
        .iter()
        .map(|k| (crate::entry_point::edit_distance(&path, k), k))
        .filter(|(d, _)| *d <= limit && *d > 0)
        .min_by_key(|(d, _)| *d)?
        .1
        .clone();
    // Same shape as the unknown key: `[table] key` when the key matches.
    if let Some(t) = best.strip_suffix(&format!("_{}", name.to_ascii_lowercase())) {
        return Some(format!("[{t}] {name}"));
    }
    if !table.is_empty() {
        for (i, _) in best.match_indices('_') {
            let (t, k) = (&best[..i], &best[i + 1..]);
            if crate::entry_point::edit_distance(t, &table) <= 2 {
                return Some(format!("[{t}] {k}"));
            }
        }
    }
    Some(best)
}

fn set_setting(name: &str, value: &str) {
    if value.contains('\0') {
        // env::set_var panics on NUL — a stray byte in the file must not crash startup.
        eprintln!("    Warning: value for {} contains a NUL byte — ignored", name);
        return;
    }
    env::set_var(name, value);
    crate::server_config::invalidate();
    startup_note!("    Set env variable '{}' to value '{}'", name, crate::entry_point::shown(name, value));
}

fn qualified_key(table: &str, key: &str) -> String {
    if table.is_empty() { key.to_string() } else { format!("[{}] {}", table, key) }
}

/// Drop a trailing `# comment`, ignoring `#` inside quoted strings.
fn strip_comment(line: &str) -> &str {
    let mut quotes = Quotes::default();
    for (i, c) in line.char_indices() {
        if !quotes.step(c) && c == '#' {
            return &line[..i];
        }
    }
    line
}

/// A TOML value as a plain string: quoted strings lose their quotes (basic
/// strings also their escapes, see [`toml_str::unquote`]), arrays become
/// `a,b,c`, anything else (numbers, booleans) is trimmed.
fn parse_value(raw: &str) -> String {
    let raw = raw.trim();
    if let Some(inner) = raw.strip_prefix('[').and_then(|r| r.strip_suffix(']')) {
        return split_array(inner)
            .iter()
            .map(|item| unquote(item.trim()))
            .filter(|item| !item.is_empty())
            .collect::<Vec<_>>()
            .join(",");
    }
    unquote(raw)
}

/// Split array items on commas outside quotes.
fn split_array(inner: &str) -> Vec<&str> {
    let mut items = vec![];
    let mut quotes = Quotes::default();
    let mut start = 0;
    for (i, c) in inner.char_indices() {
        if !quotes.step(c) && c == ',' {
            items.push(&inner[start..i]);
            start = i + 1;
        }
    }
    items.push(&inner[start..]);
    items
}

/// Load `rws.config.toml` into the environment: `filepath` (relative to the
/// working directory) when given, else the file named by `RWS_CONFIG_FILE`
/// (absolute, or relative to the working directory) — the same variable
/// `proxy_config` reads routes from — else `rws.config.toml` in the working
/// directory.
pub fn override_environment_variables_from_config(filepath: Option<&str>) {
    startup_note!("\n  Start of Config Section");

    let from_env = env::var("RWS_CONFIG_FILE").ok().filter(|p| !p.trim().is_empty());
    let resolved = match (filepath, from_env) {
        (Some(path), _) => FileExt::get_static_filepath(path),
        (None, Some(path)) => Ok(path),
        (None, None) => FileExt::get_static_filepath("/rws.config.toml"),
    };
    let path = match resolved {
        Ok(path) => path,
        Err(e) => {
            eprintln!("{}", e);
            startup_note!("  End of Config Section");
            return;
        }
    };

    let named = filepath.is_some() || env::var("RWS_CONFIG_FILE").is_ok_and(|p| !p.trim().is_empty());
    let mut source = None;
    match std::fs::read_to_string(&path) {
        Ok(content) => {
            if let Err(e) = read_config_file(Cursor::new(content.as_bytes()), String::new()) {
                eprintln!("    Unable to parse {}: {}", path, e);
            }
            source = Some(path.clone());
        }
        // No ./rws.config.toml is the normal config-less start, not an
        // error; a file named by RWS_CONFIG_FILE that can't be read is.
        Err(e) if e.kind() == std::io::ErrorKind::NotFound && !named => {
            startup_note!("    No {} — defaults, environment and flags only", path);
        }
        Err(e) => eprintln!("Unable to read {}: {}", path, e),
    }
    if let Ok(mut slot) = crate::entry_point::CONFIG_SOURCE.lock() {
        *slot = source;
    }

    startup_note!("  End of Config Section");
}