1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
//! NOTE: This library was renamed to [Servlin](https://crates.io/crates/servlin).
//! ====
//!
//! Beatrice
//! ========
//!
//! A modular HTTP server library in Rust.
//!
//! # Features
//! - `forbid(unsafe_code)`
//! - Threaded request handlers:<br>
//! `FnOnce(Request) -> Response + 'static + Clone + Send + Sync`
//! - Uses async code internally for excellent performance under load
//! - JSON
//! - Server-Sent Events (SSE)
//! - Saves large request bodies to temp files
//! - Sends 100-Continue
//! - Limits number of threads and connections
//! - Modular: roll your own logging, write custom versions of internal methods, etc.
//! - No macros or complicated type params
//! - Good test coverage (63%)
//!
//! # Limitations
//! - New, not proven in production.
//! - To do:
//! - Request timeouts
//! - `chunked` transfer-encoding for request bodies
//! - gzip
//! - brotli
//! - TLS
//! - automatically getting TLS certs via ACME
//! - Drop idle connections when approaching connection limit.
//! - Denial-of-Service mitigation: source throttling, minimum throughput
//! - Complete functional test suite
//! - Missing load tests
//! - Disk space usage limits
//!
//! # Examples
//! Complete examples: [`examples/`](https://github.com/mleonhard/beatrice-rs/tree/main/examples).
//!
//! Simple example:
//! ```rust
//! use beatrice::{
//! print_log_response,
//! socket_addr_127_0_0_1,
//! HttpServerBuilder,
//! Request,
//! Response
//! };
//! use beatrice::reexport::{safina_executor, safina_timer};
//! use serde::Deserialize;
//! use serde_json::json;
//! use std::sync::Arc;
//! use temp_dir::TempDir;
//!
//! struct State {}
//!
//! fn hello(_state: Arc<State>, req: &Request) -> Result<Response, Response> {
//! #[derive(Deserialize)]
//! struct Input {
//! name: String,
//! }
//! let input: Input = req.json()?;
//! Ok(Response::json(200, json!({"message": format!("Hello, {}!", input.name)}))
//! .unwrap())
//! }
//!
//! fn handle_req(state: Arc<State>, req: &Request) -> Result<Response, Response> {
//! match (req.method(), req.url().path()) {
//! ("GET", "/ping") => Ok(Response::text(200, "ok")),
//! ("POST", "/hello") => hello(state, req),
//! _ => Ok(Response::text(404, "Not found")),
//! }
//! }
//!
//! let state = Arc::new(State {});
//! let request_handler = move |req: Request| {
//! print_log_response(&req, handle_req(state, &req))
//! };
//! let cache_dir = TempDir::new().unwrap();
//! safina_timer::start_timer_thread();
//! let executor = safina_executor::Executor::new(1, 9).unwrap();
//! # let permit = permit::Permit::new();
//! # let server_permit = permit.new_sub();
//! # std::thread::spawn(move || {
//! # std::thread::sleep(std::time::Duration::from_millis(100));
//! # drop(permit);
//! # });
//! executor.block_on(
//! HttpServerBuilder::new()
//! # .permit(server_permit)
//! .listen_addr(socket_addr_127_0_0_1(8000))
//! .max_conns(1000)
//! .small_body_len(64 * 1024)
//! .receive_large_bodies(cache_dir.path())
//! .spawn_and_join(request_handler)
//! ).unwrap();
//! ```
//! # Cargo Geiger Safety Report
//! # Alternatives
//! See [rust-webserver-comparison.md](https://github.com/mleonhard/beatrice-rs/blob/main/rust-webserver-comparison.md).
//!
//! # Changelog
//! - v0.3.2 - Renaming project to ['servlin'](https://crates.io/crates/servlin).
//! - v0.3.1 - Add `Response::include_dir`.
//! - v0.3.0
//! - Add `RequestBody::StaticBytes`.
//! - Add `ResponseBody::StaticBytes`.
//! - Remove `impl From<&[u8]>` for `RequestBody` and `ResponseBody`.
//! - v0.2.0 - Make `print_log_response` easier to use.
//! - v0.1.0 - First published version
//!
//! # TO DO
//! - Fix limitations above
//! - Support [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD)
//! responses that have Content-Length set and no body.
//! - Update `rust-webserver-comparison.md`
//! - Add missing data
//! - Add other servers from <https://www.arewewebyet.org/topics/frameworks/>
//! - Rearrange
//! - Generate geiger reports for each web server
#![forbid(unsafe_code)]
mod accept;
mod ascii_string;
mod body_async_reader;
mod body_reader;
mod content_type;
mod cookie;
mod event;
mod head;
mod headers;
mod http_conn;
mod http_error;
mod request;
mod request_body;
mod response;
mod response_body;
mod time;
mod token_set;
mod util;
pub use crate::accept::{
socket_addr_127_0_0_1, socket_addr_127_0_0_1_any_port, socket_addr_all_interfaces,
};
pub use crate::ascii_string::AsciiString;
pub use crate::body_async_reader::BodyAsyncReader;
pub use crate::body_reader::BodyReader;
pub use crate::content_type::ContentType;
pub use crate::cookie::{Cookie, SameSite};
pub use crate::event::{Event, EventSender};
pub use crate::headers::{Header, HeaderList};
pub use crate::http_conn::HttpConn;
pub use crate::request::Request;
pub use crate::request_body::RequestBody;
pub use crate::response::Response;
pub use crate::response_body::ResponseBody;
/// This part of the library is not covered by the semver guarantees.
/// If you use these in your program, a minor version upgrade could break your build.
///
/// If you use these items in a published library,
/// your library should depend on a specific version of this library.
pub mod internal {
pub use crate::accept::*;
pub use crate::body_async_reader::*;
pub use crate::body_reader::*;
pub use crate::content_type::*;
pub use crate::cookie::*;
pub use crate::event::*;
pub use crate::head::*;
pub use crate::headers::*;
pub use crate::http_conn::*;
pub use crate::http_error::*;
pub use crate::request::*;
pub use crate::request_body::*;
pub use crate::response::*;
pub use crate::response_body::*;
pub use crate::time::*;
pub use crate::token_set::*;
pub use crate::util::*;
}
pub mod reexport {
pub use permit;
pub use safina_executor;
pub use safina_sync;
pub use safina_timer;
}
use crate::accept::accept_loop;
use crate::http_conn::handle_http_conn;
use crate::token_set::TokenSet;
use async_net::TcpListener;
use permit::Permit;
use std::net::SocketAddr;
use std::path::PathBuf;
#[allow(clippy::needless_pass_by_value)]
#[must_use]
pub fn print_log_response(req: &Request, result: Result<Response, Response>) -> Response {
let response = result.unwrap_or_else(|e| e);
if !response.is_get_body_and_reprocess() {
println!(
"{} {} {} => {} {}",
if response.code / 100 == 5 {
"ERROR"
} else {
"INFO"
},
req.method(),
req.url().path(),
response.code,
if let Some(len) = response.body.len() {
format!("len={}", len)
} else {
"streamed".to_string()
},
);
}
response
}
/// Builds an HTTP server.
pub struct HttpServerBuilder {
opt_cache_dir: Option<PathBuf>,
listen_addr: SocketAddr,
max_conns: usize,
small_body_len: usize,
permit: Permit,
}
impl HttpServerBuilder {
/// Makes a new builder these default settings:
/// - Listens on 127.0.0.1
/// - Picks a random port
/// - 100 max connections
/// - 64 KiB small body length
/// - no cache dir, server rejects large request bodies
#[allow(clippy::new_without_default)]
#[must_use]
pub fn new() -> Self {
Self {
opt_cache_dir: None,
listen_addr: socket_addr_127_0_0_1_any_port(),
max_conns: 100,
small_body_len: 64 * 1024,
permit: Permit::new(),
}
}
#[must_use]
pub fn listen_addr(mut self, addr: SocketAddr) -> Self {
self.listen_addr = addr;
self
}
/// Sets the maximum number of connections to handle at one time.
///
/// When the server is handling the maximum number of connections,
/// it waits for a connection to drop before accepting new ones.
///
/// Each connection uses a file handle.
/// Some processes run with a limit on the number of file handles.
/// The OS kernel also has a limit for all processes combined.
///
/// # Panics
/// Panics when `n` is zero.
#[must_use]
pub fn max_conns(mut self, n: usize) -> Self {
assert!(n > 0, "refusing to set max_conns to zero");
self.max_conns = n;
self
}
/// Save large request bodies to this directory.
///
/// If you do not call this method, the server will refuse all
/// requests with bodies larger than `small_body_len` with `413 Payload Too Large`.
/// It will also refuse all bodies with unknown length.
///
/// # Example
/// ```
/// use std::io::Read;
/// use beatrice::{HttpServerBuilder, Request, Response};
/// use beatrice::reexport::{safina_executor, safina_timer};
///
/// let cache_dir = temp_dir::TempDir::new().unwrap();
/// let handler = move |req: Request| {
/// if req.body.is_pending() {
/// return Response::get_body_and_reprocess(1024 * 1024);
/// }
/// let len = req.body.reader().unwrap().bytes().count();
/// Response::text(200, format!("body len={}", len))
/// };
/// # let permit = permit::Permit::new();
/// # let server_permit = permit.new_sub();
/// # std::thread::spawn(move || {
/// # std::thread::sleep(std::time::Duration::from_millis(100));
/// # drop(permit);
/// # });
/// safina_timer::start_timer_thread();
/// safina_executor::Executor::default().block_on(
/// HttpServerBuilder::new()
/// # .permit(server_permit)
/// .receive_large_bodies(cache_dir.path())
/// .spawn_and_join(handler)
/// ).unwrap();
/// ```
#[must_use]
pub fn receive_large_bodies(mut self, cache_dir: &std::path::Path) -> Self {
self.opt_cache_dir = Some(cache_dir.to_path_buf());
self
}
/// Automatically receive request bodies up to length `n`,
/// saving them in memory.
///
/// The default value is 64 KiB.
///
/// Reject larger requests with `413 Payload Too Large`.
/// See [`receive_large_bodies`](ServerBuilder::receive_large_bodies).
///
/// You can estimate the server memory usage with:
/// `small_body_len * max_conns`.
/// Using the default settings: 64 KiB * 100 connections => 6.4 MiB.
#[must_use]
pub fn small_body_len(mut self, n: usize) -> Self {
self.small_body_len = n;
self
}
/// Sets the permit used by the server.
///
/// Revoke the permit to make the server gracefully shut down.
///
/// # Example
/// ```
/// use std::net::SocketAddr;
/// use permit::Permit;
/// use beatrice::{Response, HttpServerBuilder};
/// use beatrice::reexport::{safina_executor, safina_timer};
/// # fn do_some_requests(addr: SocketAddr) -> Result<(),()> { Ok(()) }
///
/// safina_timer::start_timer_thread();
/// let executor = safina_executor::Executor::default();
/// let permit = Permit::new();
/// let (addr, stopped_receiver) = executor.block_on(
/// HttpServerBuilder::new()
/// .permit(permit.new_sub())
/// .spawn(move |req| Response::text(200, "yo"))
/// ).unwrap();
/// do_some_requests(addr).unwrap();
/// drop(permit); // Tell server to shut down.
/// stopped_receiver.recv(); // Wait for server to stop.
/// ```
#[must_use]
pub fn permit(mut self, p: Permit) -> Self {
self.permit = p;
self
}
/// Spawns the server task.
///
/// Returns `(addr, stopped_receiver)`.
/// The server is listening on `addr`.
/// After the server gracefully shuts down, it sends a message on `stopped_receiver`.
///
/// # Errors
/// Returns an error when it fails to bind to the [`listen_addr`](ServerBuilder::listen_addr).
pub async fn spawn<F>(
self,
request_handler: F,
) -> Result<(SocketAddr, reexport::safina_sync::Receiver<()>), std::io::Error>
where
F: FnOnce(Request) -> Response + 'static + Clone + Send + Sync,
{
let async_request_handler = |req: Request| async move {
let request_handler_clone = request_handler.clone();
safina_executor::schedule_blocking(move || request_handler_clone(req))
.await
.unwrap_or_else(|_| Response::text(500, "Server error"))
};
let conn_handler = move |permit, token, stream: async_net::TcpStream, addr| {
let http_conn = HttpConn::new(addr, stream);
safina_executor::spawn(handle_http_conn(
permit,
token,
http_conn,
self.opt_cache_dir,
self.small_body_len,
async_request_handler,
));
};
let listener = TcpListener::bind(self.listen_addr).await?;
let addr = listener.local_addr()?;
let token_set = TokenSet::new(self.max_conns);
let (sender, receiver) = safina_sync::oneshot();
safina_executor::spawn(async move {
accept_loop(self.permit, listener, token_set, conn_handler).await;
// TODO: Wait for connection tokens to return.
let _ignored = sender.send(());
});
Ok((addr, receiver))
}
/// Spawns the server task and waits for it to shutdown gracefully.
///
/// # Errors
/// Returns an error when it fails to bind to the [`listen_addr`](ServerBuilder::listen_addr).
pub async fn spawn_and_join<F>(self, request_handler: F) -> Result<(), std::io::Error>
where
F: FnOnce(Request) -> Response + 'static + Clone + Send + Sync,
{
let (_addr, mut stopped_receiver) = self.spawn(request_handler).await?;
let _ignored = stopped_receiver.async_recv().await;
Ok(())
}
}