rust_web_server/
lib.rs

1//! # rust-web-server
2//!
3//! An HTTP/1.1, HTTP/2, and HTTP/3 (QUIC) server, reverse proxy, and
4//! application framework in one crate. HTTP/1.1 parsing, routing, middleware,
5//! JSON, WebSocket, and SSE are implemented in-crate; HTTP/2 and HTTP/3
6//! framing use the `h2` and `quinn`/`h3` crates, and TLS uses `rustls`.
7//!
8//! ## Use as a library
9//!
10//! Add to `Cargo.toml`:
11//!
12//! ```toml
13//! [dependencies]
14//! rust-web-server = "17"
15//! ```
16//!
17//! ## Quick start
18//!
19//! ```rust,no_run
20//! use rust_web_server::prelude::*;
21//!
22//! fn hello(_: &Request, _: &PathParams, _: &ConnectionInfo, _: &()) -> Response {
23//!     Response::text(STATUS_CODE_REASON_PHRASE.n200_ok, "Hello, world!")
24//! }
25//!
26//! fn main() {
27//!     let app = App::with_state(()).get("/hello", hello);
28//!     let (listener, pool) = Server::setup().unwrap();
29//!     Server::run(listener, pool, app);
30//! }
31//! ```
32//!
33//! See [DEVELOPER.md](https://github.com/bohdaq/rust-web-server/blob/main/DEVELOPER.md)
34//! for the full building blocks reference and use case examples.
35
36// Allows `::rust_web_server::…` paths to resolve from within this crate's own
37// tests, which is required by proc-macro derive output that uses that prefix.
38extern crate self as rust_web_server;
39
40pub mod app;
41#[cfg(feature = "auth")]
42pub mod auth;
43
44#[cfg(feature = "macros")]
45pub use rws_macros::{delete, get, patch, post, put, route, Config, FromRequest, JsonSchema, Validate};
46#[cfg(all(feature = "macros", any(feature = "model-sqlite", feature = "model-postgres", feature = "model-mysql")))]
47pub use rws_macros::Model;
48#[cfg(feature = "http2")]
49pub mod async_state;
50#[cfg(feature = "http2")]
51pub(crate) mod async_bridge;
52pub mod session;
53// Socket-coupled — see spec/WASM_SHIM.md for what a wasm32-wasip2 build
54// excludes and why (no OS threads, no raw TCP/TLS in a WASI guest).
55#[cfg(not(target_arch = "wasm32"))]
56pub(crate) mod redis_protocol;
57pub mod sse;
58pub mod compression;
59pub mod cookie;
60pub mod error;
61pub mod extract;
62pub mod ip_filter;
63pub mod macros;
64pub mod blocklist;
65pub mod cache;
66pub mod config_reload;
67#[cfg(not(target_arch = "wasm32"))]
68pub mod config_watch;
69pub mod config_check;
70/// RSA public keys and RS256 / rsa-sha256 signature verification (no `rsa` crate).
71#[cfg(any(feature = "auth-asymmetric", feature = "sso"))]
72pub mod rsa_key;
73pub mod server_config;
74pub mod feature;
75pub mod maintenance;
76pub mod metrics;
77pub mod mcp;
78pub mod request_log;
79pub mod request_id;
80#[cfg(not(target_arch = "wasm32"))]
81pub mod otel;
82#[cfg(feature = "acme")]
83pub mod acme;
84pub mod middleware;
85pub mod rate_limit;
86pub mod router;
87pub mod schema;
88pub mod state;
89pub mod test_client;
90pub mod application;
91pub mod body;
92pub mod client_hint;
93pub mod controller;
94pub mod core;
95pub mod cors;
96pub mod entry_point;
97pub mod ext;
98pub mod header;
99pub mod http;
100pub mod json;
101pub mod language;
102#[cfg(not(target_arch = "wasm32"))]
103pub mod log;
104pub mod mime_type;
105pub mod null;
106pub mod range;
107pub mod request;
108pub mod response;
109pub mod server;
110pub mod symbol;
111#[cfg(not(target_arch = "wasm32"))]
112pub mod thread_pool;
113pub mod url;
114pub mod pagination;
115#[cfg(not(target_arch = "wasm32"))]
116pub mod proxy;
117pub mod rewrite;
118pub mod scheduler;
119#[cfg(not(target_arch = "wasm32"))]
120pub mod tcp_proxy;
121#[cfg(not(target_arch = "wasm32"))]
122pub mod udp_proxy;
123#[cfg(not(target_arch = "wasm32"))]
124pub mod ws_proxy;
125#[cfg(not(target_arch = "wasm32"))]
126pub mod canary;
127#[cfg(not(target_arch = "wasm32"))]
128pub mod circuit_breaker;
129// `BackendPool`/`DiscoverySource` (DNS/etcd/Consul/Docker) are native-only —
130// gated internally in service_discovery/mod.rs, not at this declaration —
131// because `json_lite` (a plain JSON parser, no sockets) must stay available
132// for `secrets`'s Vault/AWS-SM/Key-Vault backends on every target.
133pub mod service_discovery;
134/// DNS wire format, shared by the SRV service discovery and ACME's DNS-01.
135pub(crate) mod dns;
136pub mod config_binding;
137pub mod di;
138#[cfg(not(target_arch = "wasm32"))]
139pub mod proxy_config;
140#[cfg(not(target_arch = "wasm32"))]
141pub mod llm;
142#[cfg(not(target_arch = "wasm32"))]
143pub mod admin;
144#[cfg(feature = "wasm-plugins")]
145pub mod wasm_plugin;
146#[cfg(not(target_arch = "wasm32"))]
147pub mod ingress;
148#[cfg(feature = "tera")]
149pub mod template;
150pub mod validate;
151pub mod virtual_host;
152#[cfg(any(feature = "model-sqlite", feature = "model-postgres", feature = "model-mysql"))]
153pub mod model;
154#[cfg(not(target_arch = "wasm32"))]
155pub mod websocket;
156// Has both a native (TcpStream/rustls) and a wasm32 (wasi:http outgoing-handler)
157// backend behind Client::send() — see the #[cfg(target_arch = "wasm32")]
158// `send_once` in this module. spec/WASM_SHIM.md Phase 2 item 7.
159pub mod http_client;
160#[cfg(feature = "crypto")]
161pub mod crypto;
162#[cfg(feature = "csrf")]
163pub mod csrf;
164#[cfg(feature = "sso")]
165pub mod sso;
166// SMTP is a raw-TCP protocol with no wasi:http equivalent (unlike
167// http_client, which the host can proxy via outgoing-handler) — genuinely
168// can't work in a wasi:http guest, not just ungated. spec/WASM_SHIM.md.
169#[cfg(all(feature = "mailer", not(target_arch = "wasm32")))]
170pub mod mailer;
171#[cfg(feature = "jobs")]
172pub mod jobs;
173// Also compiled under `secrets` — `secrets::aws_secrets_manager`/`azure_key_vault`
174// reuse `StorageError` and the SigV4/Managed-Identity credential helpers from here.
175#[cfg(any(feature = "storage-local", feature = "storage-s3", feature = "storage-azure", feature = "secrets"))]
176pub mod storage;
177#[cfg(feature = "openapi")]
178pub mod openapi;
179#[cfg(feature = "tower")]
180pub mod tower;
181#[cfg(feature = "gateway-api")]
182pub mod gateway_api;
183#[cfg(feature = "webhook")]
184pub mod webhook;
185#[cfg(feature = "secrets")]
186pub mod secrets;
187// Runs wrapped work on a background OS thread to bound wait time — needs
188// `std::thread::spawn`, unavailable on wasm32-wasip2. See spec/WASM_SHIM.md.
189#[cfg(not(target_arch = "wasm32"))]
190pub mod timeout;
191pub mod prelude;
192
193#[cfg(feature = "http2")]
194#[doc(hidden)]
195pub mod tls;
196
197#[cfg(feature = "http2")]
198#[doc(hidden)]
199pub mod h2_server;
200
201#[cfg(feature = "http3")]
202#[doc(hidden)]
203pub mod h3_handler;
204
205/// Shared infrastructure for tests that write process-wide environment variables.
206///
207/// Tests that call `override_environment_variables_from_config` or
208/// `CommandLineArgument::set_environment_variable` must hold this lock for
209/// their entire duration so they don't race with other tests reading the
210/// same variables.
211#[cfg(test)]
212mod stack_depth_tests;
213
214/// A rustls client-config builder with this crate's crypto provider
215/// (aws-lc-rs) named explicitly. `rustls::ClientConfig::builder()` uses the
216/// process-wide default provider and panics when none is installed and more
217/// than one is compiled in — which happens as soon as any dependency enables
218/// rustls's `ring` backend (e.g. sqlx). Every outbound TLS client in the
219/// crate starts here.
220#[cfg(all(any(feature = "http-client", feature = "http2"), not(target_arch = "wasm32")))]
221pub(crate) fn tls_client_builder() -> rustls::ConfigBuilder<rustls::ClientConfig, rustls::WantsVerifier> {
222    rustls::ClientConfig::builder_with_provider(std::sync::Arc::new(rustls::crypto::aws_lc_rs::default_provider()))
223        .with_safe_default_protocol_versions()
224        .expect("aws-lc-rs supports rustls's default protocol versions")
225}
226
227#[cfg(test)]
228pub mod test_env {
229    use std::sync::{Mutex, OnceLock};
230    static LOCK: OnceLock<Mutex<()>> = OnceLock::new();
231    pub fn lock() -> std::sync::MutexGuard<'static, ()> {
232        LOCK.get_or_init(|| Mutex::new(()))
233            .lock()
234            .unwrap_or_else(|e| e.into_inner())
235    }
236
237    /// A per-process path under the OS temp dir that is deleted (file or
238    /// directory) when dropped — so a test cleans up even when an assertion
239    /// fails before its last line.
240    pub struct TempPath(std::path::PathBuf);
241
242    impl TempPath {
243        pub fn new(name: &str) -> Self {
244            TempPath(std::env::temp_dir().join(format!("rws_test_{}_{}", std::process::id(), name)))
245        }
246
247        /// The same in the working directory (the static-file root), for
248        /// tests that need a file the server would serve.
249        pub fn new_in_cwd(name: &str) -> Self {
250            TempPath(std::env::current_dir().expect("working directory").join(format!("rws_test_{}_{}", std::process::id(), name)))
251        }
252
253        pub fn as_str(&self) -> &str {
254            self.0.to_str().expect("temp dir path is UTF-8")
255        }
256    }
257
258    impl std::ops::Deref for TempPath {
259        type Target = std::path::Path;
260        fn deref(&self) -> &std::path::Path {
261            &self.0
262        }
263    }
264
265    impl Drop for TempPath {
266        fn drop(&mut self) {
267            // A symlink is removed itself, never followed (a test may link
268            // to a system directory).
269            let is_link = std::fs::symlink_metadata(&self.0).is_ok_and(|m| m.file_type().is_symlink());
270            if is_link {
271                let _ = std::fs::remove_file(&self.0);
272            } else if self.0.is_dir() {
273                let _ = std::fs::remove_dir_all(&self.0);
274            } else {
275                let _ = std::fs::remove_file(&self.0);
276            }
277        }
278    }
279}
280
281/// Entry points for `fuzz/` targets that reach crate-private parsers.
282/// Compiled only under `--cfg fuzzing`, which `cargo fuzz` sets — never part
283/// of the public API.
284#[cfg(fuzzing)]
285#[doc(hidden)]
286pub mod fuzz_api {
287    /// Proxy route-matching normalization of a request target (#50): any
288    /// input, and normalizing twice changes nothing.
289    pub fn proxy_normalize_target(data: &[u8]) {
290        let Ok(target) = std::str::from_utf8(data) else { return };
291        let once = crate::proxy_config::normalize_request_target(target).into_owned();
292        let twice = crate::proxy_config::normalize_request_target(&once).into_owned();
293        assert_eq!(once, twice, "normalization is not idempotent for {:?}", target);
294    }
295
296    /// Static-file request-path decoding (#55). Must never panic; the
297    /// decoded path never carries a `..` segment past the web-root check.
298    pub fn static_path_decode(data: &[u8]) {
299        let Ok(path) = std::str::from_utf8(data) else { return };
300        if let Ok(fs_path) = crate::app::controller::static_resource::static_fs_path(path) {
301            let relative = &fs_path[crate::app::controller::static_resource::working_directory().len()..];
302            assert!(!relative.split(['/', '\\']).any(|segment| segment == ".."), "{:?} -> {:?}", path, fs_path);
303        }
304    }
305
306    /// `Accept-Encoding` negotiation (#7): any header value; the choice is
307    /// always one of the offered codings, and a coding the value refuses
308    /// (its first `q=` parameter is 0) is never chosen.
309    pub fn accept_encoding(data: &[u8]) {
310        let Ok(value) = std::str::from_utf8(data) else { return };
311        let request = crate::request::Request {
312            method: "GET".to_string(),
313            request_uri: "/".to_string(),
314            http_version: "HTTP/1.1".to_string(),
315            headers: vec![crate::header::Header::new(crate::header::Header::_ACCEPT_ENCODING, value.to_string())],
316            body: Default::default(),
317        };
318        for preference in [crate::compression::DYNAMIC_PREFERENCE, crate::compression::STATIC_PREFERENCE] {
319            if let Some(chosen) = crate::compression::negotiate(&request, preference) {
320                assert!(preference.contains(&chosen));
321                // Refused: the coding's first `q=` parameter is exactly 0.
322                let refused = value.split(',').any(|c| {
323                    let mut parts = c.split(';');
324                    parts.next().unwrap_or("").trim().eq_ignore_ascii_case(chosen.token())
325                        && parts
326                            .map(str::trim)
327                            .find(|p| p.as_bytes().get(..2).is_some_and(|b| b.eq_ignore_ascii_case(b"q=")))
328                            .is_some_and(|q| q[2..].trim().parse::<f32>() == Ok(0.0))
329                });
330                let listed_once = value.split(',').filter(|c| c.split(';').next().unwrap_or("").trim().eq_ignore_ascii_case(chosen.token())).count() == 1;
331                assert!(!(refused && listed_once), "{value:?} refused {chosen:?}");
332            }
333        }
334    }
335
336    /// What a WebAssembly plugin returns, as the host reads it (#40).
337    /// Must never panic.
338    #[cfg(feature = "wasm-plugins")]
339    pub fn wasm_plugin_output(data: &[u8]) {
340        let _ = crate::wasm_plugin::parse_request_output(data);
341        let _ = crate::wasm_plugin::parse_response_output(data);
342    }
343
344    /// A disk-cache entry file as the cache reads it back (#39): the header
345    /// line and key, then the stored response. Must never panic.
346    pub fn cache_entry(data: &[u8]) {
347        if let Some((_, _, _, offset)) = crate::cache::disk::parse_entry_header(data) {
348            let _ = crate::response::Response::parse_upstream(&data[offset..], crate::proxy::REGENERATED_OR_HOP_BY_HOP);
349        }
350    }
351
352    /// Provider responses as the LLM proxy reads them (#41): usage from a
353    /// JSON body or an event stream fed in pieces, and chunked framing.
354    /// Must never panic.
355    pub fn llm_usage(data: &[u8]) {
356        for content_type in ["application/json", "text/event-stream"] {
357            let mut parser = crate::llm::UsageParser::new(content_type);
358            for piece in data.chunks(7) {
359                parser.feed(piece);
360            }
361            let _ = parser.finish();
362        }
363        let mut decoder = crate::llm::usage::ChunkDecoder::default();
364        let mut out = Vec::new();
365        let _ = decoder.decode(data, &mut out);
366    }
367
368    /// An upstream MCP server's reply as the gateway reads it (#62): a JSON
369    /// body or an event stream, then the response's tools. Must never panic.
370    pub fn mcp_gateway_reply(data: &[u8]) {
371        for content_type in ["application/json", "text/event-stream"] {
372            if let Ok(result) = crate::mcp::gateway::parse_reply(content_type, data, 1) {
373                let _ = crate::mcp::gateway::fuzzing::tools(&result);
374            }
375        }
376    }
377
378    /// A WebSocket frame from a client (#8): any bytes; a frame never holds
379    /// more payload than the limit allows. Must never panic.
380    #[cfg(not(target_arch = "wasm32"))]
381    pub fn websocket_frame(data: &[u8]) {
382        let mut cursor = std::io::Cursor::new(data);
383        while let Ok(frame) = crate::websocket::WebSocket::read_frame_limited(&mut cursor, 4096) {
384            let len = match &frame {
385                crate::websocket::Frame::Text(t) => t.len(),
386                crate::websocket::Frame::Binary(b) | crate::websocket::Frame::Ping(b) | crate::websocket::Frame::Pong(b) => b.len(),
387                crate::websocket::Frame::Continuation { data, .. } => data.len(),
388                crate::websocket::Frame::Close(_, reason) => reason.len() + 2,
389            };
390            assert!(len <= 4096 + 2);
391        }
392    }
393
394    /// A DNS response read for SRV records (#8). Must never panic.
395    #[cfg(not(target_arch = "wasm32"))]
396    pub fn dns_srv_response(data: &[u8]) {
397        let id = data.get(..2).map_or(0, |b| u16::from_be_bytes([b[0], b[1]]));
398        let _ = crate::service_discovery::dns_srv::parse_response(data, id);
399    }
400
401    /// A DNS message: the shared parser (SRV discovery, ACME DNS-01), TXT
402    /// values and, with `acme`, a DNS UPDATE reply. Must never panic.
403    /// A certificate's subjectAltNames, as a BackendTLSPolicy checks a
404    /// backend's (untrusted) certificate. Must never panic.
405    pub fn x509_subject_alt_names(data: &[u8]) {
406        let _ = crate::core::x509::subject_alt_names(data);
407    }
408
409    pub fn dns_message(data: &[u8]) {
410        if let Ok(message) = crate::dns::parse(data) {
411            for record in message.answers.iter().chain(&message.authority).chain(&message.additional) {
412                let _ = crate::dns::txt_value(&data[record.rdata.clone()]);
413            }
414        }
415        #[cfg(feature = "acme")]
416        let _ = crate::acme::dns01::check_update_reply(data, 0);
417    }
418
419    /// A Redis (RESP) reply (#8). Must never panic.
420    #[cfg(not(target_arch = "wasm32"))]
421    pub fn redis_reply(data: &[u8]) {
422        let _ = crate::redis_protocol::read_reply(&mut std::io::Cursor::new(data));
423    }
424
425    /// A `Cookie` request header (#8): every parsed cookie has a name.
426    pub fn cookie_header(data: &[u8]) {
427        let Ok(value) = std::str::from_utf8(data) else { return };
428        let jar = crate::cookie::CookieJar::parse(value);
429        assert!(jar.cookies.iter().all(|c| !c.name.is_empty()));
430    }
431
432    /// A W3C `baggage` header (#25): members survive a round trip through
433    /// the header. Must never panic.
434    #[cfg(not(target_arch = "wasm32"))]
435    pub fn otel_baggage(data: &[u8]) {
436        let Ok(value) = std::str::from_utf8(data) else { return };
437        let baggage = crate::otel::Baggage::parse(value);
438        assert!(baggage.len() <= crate::otel::baggage::MAX_MEMBERS);
439        let again = crate::otel::Baggage::parse(&baggage.to_header());
440        for (key, value) in baggage.iter() {
441            if let Some(round_tripped) = again.get(key) {
442                assert_eq!(value, round_tripped);
443            }
444        }
445    }
446
447    /// What ACME renewal parses from the CA (#1): certificate DER (validity,
448    /// serial, Authority Key Identifier), renewalInfo windows (RFC 3339) and
449    /// directory profile names. Must never panic.
450    #[cfg(feature = "acme")]
451    pub fn acme_renewal(data: &[u8]) {
452        let _ = crate::acme::fuzzing::cert_info_from_der(data);
453        if let Ok(text) = std::str::from_utf8(data) {
454            let _ = crate::acme::fuzzing::parse_suggested_window(text);
455            let _ = crate::acme::fuzzing::parse_rfc3339(text);
456            let _ = crate::acme::fuzzing::json_object_keys(text, "profiles");
457        }
458    }
459
460    /// The SAML XML parser (`sso::saml::xml`), fed IdP-supplied documents.
461    #[cfg(feature = "sso-saml")]
462    pub fn saml_xml_parse(xml: &str) {
463        let _ = crate::sso::saml::xml_parse_for_fuzzing(xml);
464    }
465
466    /// HTTP/1.1 request framing (`server::framing`) over a raw connection
467    /// buffer: head detection, body framing, and the chunked body decoder,
468    /// fed in two pieces split at the first byte to mimic separate reads.
469    pub fn http1_framing(data: &[u8]) {
470        use crate::server::framing::{self, BodyFraming, ChunkedBody, HeadScan};
471        let mut pending = data.to_vec();
472        framing::skip_leading_empty_lines(&mut pending);
473        let HeadScan::Complete(head_len) = framing::scan_head(&pending) else { return };
474        assert!(head_len <= pending.len() && head_len <= framing::MAX_HEAD_SIZE);
475        let Ok(request) = crate::request::Request::parse(&pending[..head_len]) else { return };
476        for header in &request.headers {
477            let _ = crate::http::date::parse(&header.value);
478        }
479        let _ = framing::validate_head(&pending[..head_len], &request);
480        let _ = framing::keep_alive(&request);
481        let body = &pending[head_len..];
482        if let Ok(BodyFraming::Chunked) = framing::body_framing(&request) {
483            let split = data.first().map_or(0, |&b| b as usize).min(body.len());
484            let mut decoder = ChunkedBody::new(1 << 20);
485            let mut buffer = body[..split].to_vec();
486            for next in [&body[split..], &[][..]] {
487                match decoder.feed(&buffer) {
488                    Ok((consumed, _)) => {
489                        assert!(consumed <= buffer.len());
490                        buffer.drain(..consumed);
491                    }
492                    Err(_) => return,
493                }
494                buffer.extend_from_slice(next);
495            }
496            assert!(decoder.body.len() <= 1 << 20);
497        }
498    }
499}
500
501
502/// Compiles the README's Rust example as a doctest, so it can't drift from the API.
503#[cfg(all(doctest, feature = "http3"))]
504#[doc = include_str!("../README.md")]
505pub struct ReadmeDoctests;
rust_web_server/lib.rs

rust_web_server/
lib.rs
