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

rust_web_server/
lib.rs
