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

rust_web_server/
lib.rs
