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

rust_web_server/
lib.rs
