rust_web_server/server_config/mod.rs
1//! Typed server configuration.
2//!
3//! [`ServerConfig`] holds all per-instance configuration fields as typed Rust
4//! values. It replaces point-of-use `env::var("RWS_CONFIG_*")` calls with a
5//! struct that can be:
6//!
7//! - Built from environment variables once at startup: [`ServerConfig::from_env()`]
8//! - Constructed directly in tests without touching the environment:
9//! [`ServerConfig::default()`] / struct update syntax
10//! - Passed to [`App::with_config`] to create a fully isolated application
11//! instance — essential for parallel tests and embedded multi-tenant use
12//!
13//! # Test isolation example
14//!
15//! ```rust,ignore
16//! use rust_web_server::app::App;
17//! use rust_web_server::server_config::ServerConfig;
18//! use rust_web_server::test_client::TestClient;
19//!
20//! // No env writes, no lock needed.
21//! let app = App::with_config(ServerConfig {
22//! cors_allow_all: false,
23//! cors_allow_origins: "https://example.com".to_string(),
24//! ..ServerConfig::default()
25//! });
26//! let client = TestClient::new(app);
27//! let res = client.get("/").send();
28//! ```
29
30#[cfg(test)]
31mod tests;
32
33use std::sync::atomic::{AtomicU64, Ordering};
34use std::sync::{Arc, RwLock};
35
36use crate::entry_point::Config;
37
38/// Bumped whenever `RWS_CONFIG_*` variables change (see [`invalidate`]).
39static GENERATION: AtomicU64 = AtomicU64::new(1);
40
41/// The snapshot [`ServerConfig::current`] hands out, with the generation it
42/// was built at.
43static CURRENT: RwLock<Option<(u64, Arc<ServerConfig>)>> = RwLock::new(None);
44
45/// Mark the cached [`ServerConfig::current`] snapshot stale: the next call
46/// re-reads the environment. Called by everything in the crate that writes
47/// `RWS_CONFIG_*` variables (config file, command line, defaults,
48/// `config_reload::reload`); call it yourself after `std::env::set_var` of
49/// a setting that should take effect immediately.
50pub fn invalidate() {
51 GENERATION.fetch_add(1, Ordering::SeqCst);
52}
53
54/// Default `Content-Security-Policy` header value. Mirrors
55/// `Header::_CONTENT_SECURITY_POLICY_VALUE_DEFAULT` without creating a
56/// circular import (`server_config` ← `header` ← `cors` ← `server_config`).
57const CSP_DEFAULT: &str = "default-src 'self'";
58/// Default `Cache-Control` for static files: cache, but revalidate.
59pub(crate) const STATIC_CACHE_CONTROL_DEFAULT: &str = "no-cache";
60
61/// All runtime-configurable settings for one server instance.
62///
63/// Fields map 1-to-1 to `RWS_CONFIG_*` environment variable names documented
64/// in [`Config`]. Default values match the environment-variable defaults.
65///
66/// Construct via [`ServerConfig::from_env()`] at startup or
67/// [`ServerConfig::default()`] in tests.
68#[derive(Clone, Debug, PartialEq)]
69pub struct ServerConfig {
70 // ── CORS ─────────────────────────────────────────────────────────────────
71 /// `RWS_CONFIG_CORS_ALLOW_ALL` — when `true`, all cross-origin requests are
72 /// reflected back as allowed (echo the `Origin` header). Overrides all
73 /// other CORS fields. Default: `true`.
74 pub cors_allow_all: bool,
75 /// `RWS_CONFIG_CORS_ALLOW_ORIGINS` — comma-separated list of allowed
76 /// origins when `cors_allow_all` is `false`. Default: `""` (none).
77 pub cors_allow_origins: String,
78 /// `RWS_CONFIG_CORS_ALLOW_CREDENTIALS` — value for the
79 /// `Access-Control-Allow-Credentials` response header. Default: `""`.
80 pub cors_allow_credentials: String,
81 /// `RWS_CONFIG_CORS_ALLOW_METHODS` — value for
82 /// `Access-Control-Allow-Methods`. Default: `""`.
83 pub cors_allow_methods: String,
84 /// `RWS_CONFIG_CORS_ALLOW_HEADERS` — value for
85 /// `Access-Control-Allow-Headers`. Default: `""`.
86 pub cors_allow_headers: String,
87 /// `RWS_CONFIG_CORS_EXPOSE_HEADERS` — value for
88 /// `Access-Control-Expose-Headers`. Default: `""`.
89 pub cors_expose_headers: String,
90 /// `RWS_CONFIG_CORS_MAX_AGE` — value for `Access-Control-Max-Age`.
91 /// Default: `"86400"`.
92 pub cors_max_age: String,
93
94 // ── Security headers ──────────────────────────────────────────────────────
95 /// `RWS_CONFIG_CSP` — `Content-Security-Policy` header value. An empty
96 /// string suppresses the header. Unset: `default-src 'self'` when
97 /// [`security_headers`](Self::security_headers) is on, otherwise no header
98 /// (18.0.0; was always `default-src 'self'`).
99 pub csp: String,
100 /// `RWS_CONFIG_SECURITY_HEADERS` — send `X-Frame-Options: SAMEORIGIN`,
101 /// `Referrer-Policy` and `Permissions-Policy` on every response (and the
102 /// default CSP, unless `RWS_CONFIG_CSP` is set). Off by default (18.0.0;
103 /// was always on): nginx sends none of them, and over HTTP/2 every header
104 /// costs HPACK work. `X-Content-Type-Options: nosniff` is always sent.
105 pub security_headers: bool,
106 /// `RWS_CONFIG_NANOS_HEADERS` — send `Date-Unix-Epoch-Nanos` and, for
107 /// static files, `Last-Modified-Unix-Epoch-Nanos`. Off by default (18.0.0;
108 /// was always on): they change on every response, so HTTP/2 can't index
109 /// them, and `Date`/`Last-Modified` carry the same information to the second.
110 pub nanos_headers: bool,
111 /// `RWS_CONFIG_CLIENT_HINTS` — send `Accept-CH`, `Critical-CH` and the
112 /// client hints in `Vary` on every response. Off by default (18.0.0; was
113 /// always on): ~700 bytes per response, and `Critical-CH` makes Chromium
114 /// retry a request that came without the hints.
115 pub client_hints: bool,
116 /// `RWS_CONFIG_STATIC_CACHE_CONTROL` — `Cache-Control` for static files
117 /// (other responses keep `no-store, …`). Default `"no-cache"` (18.0.0; was
118 /// `no-store, …`): browsers keep the file and revalidate it with
119 /// `If-None-Match` / `If-Modified-Since` (a 304). An empty value keeps
120 /// the `no-store` default for static files too.
121 pub static_cache_control: String,
122 /// `RWS_CONFIG_ERROR_FORMAT` — `"text"` sends rws-made errors as plain
123 /// text (`502 Bad Gateway`) as before 18.17.0; anything else (default
124 /// `"problem"`) sends RFC 9457 `application/problem+json`.
125 pub error_format_text: bool,
126 /// `RWS_CONFIG_PROXY_STATUS` — when proxied responses carry
127 /// `Proxy-Status` (RFC 9209): `"always"` (default), `"errors"`, `"off"`.
128 pub proxy_status: String,
129 /// `RWS_CONFIG_PROXY_NAME` — this hop's name in `Proxy-Status` (and
130 /// `Cache-Status`). Default `"rws"`.
131 pub proxy_name: String,
132 /// `RWS_CONFIG_PROXY_STATUS_NEXT_HOP` — add the backend address
133 /// (`next-hop`) and failure text (`details`). Default `false`.
134 pub proxy_status_next_hop: bool,
135 /// `RWS_CONFIG_CACHE_STATUS` — `CacheLayer` responses carry
136 /// `Cache-Status` (RFC 9211). Default `true`.
137 pub cache_status: bool,
138 /// `RWS_CONFIG_FORWARDED_HEADER` — proxied requests carry RFC 7239
139 /// `Forwarded` beside `X-Forwarded-*`. Default on; `"off"` leaves it out.
140 pub forwarded_header: bool,
141 /// `trusted_proxies` (18.24.0): peers whose `X-Forwarded-*` and
142 /// `Forwarded` headers are passed on; from anyone else they are
143 /// replaced.
144 pub trusted_proxies: crate::ip_filter::TrustedProxies,
145 /// `RWS_CONFIG_EARLY_HINTS_HTTP1` — also send `103 Early Hints` to
146 /// HTTP/1.1 clients. Default `false`: browsers use them only over HTTP/2
147 /// and HTTP/3, and some old HTTP/1.1 clients mishandle extra `1xx`
148 /// responses (18.12.0).
149 pub early_hints_http1: bool,
150 /// `RWS_CONFIG_COMPRESSION_DICTIONARIES` — URL patterns (`/js/app.*.js`,
151 /// comma-separated) of static files used as compression dictionaries:
152 /// later versions go out as `dcz` / `dcb` deltas against the one the
153 /// browser has (18.12.0). Empty by default.
154 pub compression_dictionaries: Vec<String>,
155 /// `RWS_CONFIG_DIRECTORY_LISTING` — list a directory that has no
156 /// `index.html`. Default `true`; `false` answers 404 instead (18.8.4).
157 pub directory_listing: bool,
158
159 // ── Server internals ──────────────────────────────────────────────────────
160 /// `RWS_CONFIG_LOG_FORMAT` — `"json"` or `"combined"`. Default: `"json"`.
161 pub log_format: String,
162 /// `RWS_CONFIG_REQUEST_ALLOCATION_SIZE_IN_BYTES` — bytes allocated for
163 /// incoming request parsing. Default: `10000`.
164 pub request_allocation_size: i64,
165}
166
167impl Default for ServerConfig {
168 fn default() -> Self {
169 Self {
170 cors_allow_all: Config::RWS_CONFIG_CORS_ALLOW_ALL_DEFAULT_VALUE
171 .eq_ignore_ascii_case("true"),
172 cors_allow_origins: Config::RWS_CONFIG_CORS_ALLOW_ORIGINS_DEFAULT_VALUE.to_string(),
173 cors_allow_credentials: Config::RWS_CONFIG_CORS_ALLOW_CREDENTIALS_DEFAULT_VALUE
174 .to_string(),
175 cors_allow_methods: Config::RWS_CONFIG_CORS_ALLOW_METHODS_DEFAULT_VALUE.to_string(),
176 cors_allow_headers: Config::RWS_CONFIG_CORS_ALLOW_HEADERS_DEFAULT_VALUE.to_string(),
177 cors_expose_headers: Config::RWS_CONFIG_CORS_EXPOSE_HEADERS_DEFAULT_VALUE.to_string(),
178 cors_max_age: Config::RWS_CONFIG_CORS_MAX_AGE_DEFAULT_VALUE.to_string(),
179 csp: String::new(),
180 security_headers: false,
181 nanos_headers: false,
182 client_hints: false,
183 static_cache_control: STATIC_CACHE_CONTROL_DEFAULT.to_string(),
184 error_format_text: false,
185 proxy_status: "always".to_string(),
186 proxy_name: "rws".to_string(),
187 proxy_status_next_hop: false,
188 cache_status: true,
189 forwarded_header: true,
190 trusted_proxies: crate::ip_filter::TrustedProxies::parse("").expect("the default parses"),
191 early_hints_http1: false,
192 compression_dictionaries: Vec::new(),
193 directory_listing: true,
194 log_format: Config::RWS_CONFIG_LOG_FORMAT_DEFAULT_VALUE.to_string(),
195 request_allocation_size: *Config::RWS_DEFAULT_REQUEST_ALLOCATION_SIZE_IN_BYTES,
196 }
197 }
198}
199
200impl ServerConfig {
201 /// Build a `ServerConfig` by reading all `RWS_CONFIG_*` environment
202 /// variables. Missing variables fall back to their default values.
203 ///
204 /// Each call reads every variable — the environment lock is taken once
205 /// per variable — so per-request code uses [`ServerConfig::current`].
206 pub fn from_env() -> Self {
207 let read = |key: &str| std::env::var(key).unwrap_or_default();
208 Self {
209 cors_allow_all: read(Config::RWS_CONFIG_CORS_ALLOW_ALL)
210 .eq_ignore_ascii_case("true"),
211 cors_allow_origins: read(Config::RWS_CONFIG_CORS_ALLOW_ORIGINS),
212 cors_allow_credentials: read(Config::RWS_CONFIG_CORS_ALLOW_CREDENTIALS),
213 cors_allow_methods: read(Config::RWS_CONFIG_CORS_ALLOW_METHODS),
214 cors_allow_headers: read(Config::RWS_CONFIG_CORS_ALLOW_HEADERS),
215 cors_expose_headers: read(Config::RWS_CONFIG_CORS_EXPOSE_HEADERS),
216 cors_max_age: read(Config::RWS_CONFIG_CORS_MAX_AGE),
217 csp: std::env::var("RWS_CONFIG_CSP").unwrap_or_else(|_| {
218 if read("RWS_CONFIG_SECURITY_HEADERS").eq_ignore_ascii_case("true") {
219 CSP_DEFAULT.to_string()
220 } else {
221 String::new()
222 }
223 }),
224 security_headers: read("RWS_CONFIG_SECURITY_HEADERS").eq_ignore_ascii_case("true"),
225 nanos_headers: read("RWS_CONFIG_NANOS_HEADERS").eq_ignore_ascii_case("true"),
226 client_hints: read("RWS_CONFIG_CLIENT_HINTS").eq_ignore_ascii_case("true"),
227 static_cache_control: std::env::var("RWS_CONFIG_STATIC_CACHE_CONTROL")
228 .unwrap_or_else(|_| STATIC_CACHE_CONTROL_DEFAULT.to_string()),
229 error_format_text: read("RWS_CONFIG_ERROR_FORMAT").trim().eq_ignore_ascii_case("text"),
230 proxy_status: match read("RWS_CONFIG_PROXY_STATUS").trim().to_ascii_lowercase().as_str() {
231 "off" | "false" | "none" => "off".to_string(),
232 "errors" => "errors".to_string(),
233 _ => "always".to_string(),
234 },
235 proxy_name: Some(read("RWS_CONFIG_PROXY_NAME").trim().to_string()).filter(|n| !n.is_empty()).unwrap_or_else(|| "rws".to_string()),
236 proxy_status_next_hop: read("RWS_CONFIG_PROXY_STATUS_NEXT_HOP").eq_ignore_ascii_case("true"),
237 cache_status: !read("RWS_CONFIG_CACHE_STATUS").trim().eq_ignore_ascii_case("false"),
238 forwarded_header: !matches!(read("RWS_CONFIG_FORWARDED_HEADER").trim().to_ascii_lowercase().as_str(), "off" | "false" | "none"),
239 // A bad list is reported by `rws --check`; here it falls back to
240 // the default rather than trusting everyone.
241 trusted_proxies: crate::ip_filter::TrustedProxies::parse(&read("RWS_CONFIG_TRUSTED_PROXIES"))
242 .unwrap_or_else(|_| crate::ip_filter::TrustedProxies::parse("").expect("the default parses")),
243 early_hints_http1: read("RWS_CONFIG_EARLY_HINTS_HTTP1").eq_ignore_ascii_case("true"),
244 compression_dictionaries: read("RWS_CONFIG_COMPRESSION_DICTIONARIES")
245 .split(',')
246 .map(|p| p.trim().to_string())
247 .filter(|p| p.starts_with('/') && crate::early_hints::valid(p))
248 .collect(),
249 directory_listing: !read("RWS_CONFIG_DIRECTORY_LISTING").eq_ignore_ascii_case("false"),
250 log_format: read(Config::RWS_CONFIG_LOG_FORMAT),
251 request_allocation_size: std::env::var(
252 Config::RWS_CONFIG_REQUEST_ALLOCATION_SIZE_IN_BYTES,
253 )
254 .ok()
255 .and_then(|v| v.parse().ok())
256 .unwrap_or(*Config::RWS_DEFAULT_REQUEST_ALLOCATION_SIZE_IN_BYTES),
257 }
258 }
259
260 /// The configuration from the environment, read once and shared: an
261 /// atomic load and an `Arc` clone per call instead of ten `getenv`s.
262 /// Rebuilt after [`invalidate`] — which `config_reload::reload()` (SIGHUP,
263 /// `POST /admin/config/reload`) and every config writer in the crate call,
264 /// so hot reload still takes effect on the next request.
265 pub fn current() -> Arc<ServerConfig> {
266 let generation = GENERATION.load(Ordering::SeqCst);
267 if let Some((built_at, config)) = CURRENT.read().unwrap_or_else(|e| e.into_inner()).as_ref() {
268 if *built_at == generation {
269 return Arc::clone(config);
270 }
271 }
272 // Built from the generation read *before* the environment: a change
273 // during the rebuild leaves the cache stale, not wrong.
274 let fresh = Arc::new(ServerConfig::from_env());
275 *CURRENT.write().unwrap_or_else(|e| e.into_inner()) = Some((generation, Arc::clone(&fresh)));
276 fresh
277 }
278}