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
//! Request handler module intended to manage incoming HTTP requests.
//!
use headers::HeaderValue;
use hyper::{header::WWW_AUTHENTICATE, Body, Request, Response, StatusCode};
use std::{future::Future, net::IpAddr, net::SocketAddr, path::PathBuf, sync::Arc};
use crate::{
basic_auth, compression, control_headers, cors, custom_headers,
directory_listing::DirListFmt,
error_page,
exts::http::MethodExt,
fallback_page, redirects, rewrites, security_headers,
settings::Advanced,
static_files::{self, HandleOpts},
Error, Result,
};
/// It defines options for a request handler.
pub struct RequestHandlerOpts {
// General options
/// Root directory of static files.
pub root_dir: PathBuf,
/// Compression feature.
pub compression: bool,
/// Compression static feature.
pub compression_static: bool,
/// Directory listing feature.
pub dir_listing: bool,
/// Directory listing order feature.
pub dir_listing_order: u8,
/// Directory listing format feature.
pub dir_listing_format: DirListFmt,
/// CORS feature.
pub cors: Option<cors::Configured>,
/// Security headers feature.
pub security_headers: bool,
/// Cache control headers feature.
pub cache_control_headers: bool,
/// Page for 404 errors.
pub page404: Vec<u8>,
/// Page for 50x errors.
pub page50x: Vec<u8>,
/// Page fallback feature.
pub page_fallback: Vec<u8>,
/// Basic auth feature.
pub basic_auth: String,
/// Log remote address feature.
pub log_remote_address: bool,
/// Redirect trailing slash feature.
pub redirect_trailing_slash: bool,
/// Ignore hidden files feature.
pub ignore_hidden_files: bool,
/// Advanced options from the config file.
pub advanced_opts: Option<Advanced>,
}
/// It defines the main request handler used by the Hyper service request.
pub struct RequestHandler {
/// Request handler options.
pub opts: Arc<RequestHandlerOpts>,
}
impl RequestHandler {
/// Main entry point for incoming requests.
pub fn handle<'a>(
&'a self,
req: &'a mut Request<Body>,
remote_addr: Option<SocketAddr>,
) -> impl Future<Output = Result<Response<Body>, Error>> + Send + 'a {
let method = req.method();
let headers = req.headers();
let uri = req.uri();
let base_path = &self.opts.root_dir;
let mut uri_path = uri.path();
let uri_query = uri.query();
let dir_listing = self.opts.dir_listing;
let dir_listing_order = self.opts.dir_listing_order;
let dir_listing_format = &self.opts.dir_listing_format;
let log_remote_addr = self.opts.log_remote_address;
let redirect_trailing_slash = self.opts.redirect_trailing_slash;
let compression_static = self.opts.compression_static;
let ignore_hidden_files = self.opts.ignore_hidden_files;
let mut cors_headers: Option<http::HeaderMap> = None;
// Log request information with its remote address if available
let mut remote_addr_str = String::new();
if log_remote_addr {
remote_addr_str.push_str(" remote_addr=");
remote_addr_str.push_str(&remote_addr.map_or("".to_owned(), |v| v.to_string()));
if let Some(client_ip_address) = headers
.get("X-Forwarded-For")
.and_then(|v| v.to_str().ok())
.and_then(|s| s.split(',').next())
.and_then(|s| s.trim().parse::<IpAddr>().ok())
{
remote_addr_str.push_str(" real_remote_ip=");
remote_addr_str.push_str(&client_ip_address.to_string())
}
}
tracing::info!(
"incoming request: method={} uri={}{}",
method,
uri,
remote_addr_str,
);
async move {
// Reject in case of incoming HTTP request method is not allowed
if !method.is_allowed() {
return error_page::error_response(
uri,
method,
&StatusCode::METHOD_NOT_ALLOWED,
&self.opts.page404,
&self.opts.page50x,
);
}
// CORS
if let Some(cors) = &self.opts.cors {
match cors.check_request(method, headers) {
Ok((headers, state)) => {
tracing::debug!("cors state: {:?}", state);
cors_headers = Some(headers);
}
Err(err) => {
tracing::error!("cors error kind: {:?}", err);
return error_page::error_response(
uri,
method,
&StatusCode::FORBIDDEN,
&self.opts.page404,
&self.opts.page50x,
);
}
};
}
// `Basic` HTTP Authorization Schema
if !self.opts.basic_auth.is_empty() {
if let Some((user_id, password)) = self.opts.basic_auth.split_once(':') {
if let Err(err) = basic_auth::check_request(headers, user_id, password) {
tracing::warn!("basic authentication failed {:?}", err);
let mut resp = error_page::error_response(
uri,
method,
&StatusCode::UNAUTHORIZED,
&self.opts.page404,
&self.opts.page50x,
)?;
resp.headers_mut().insert(
WWW_AUTHENTICATE,
"Basic realm=\"Static Web Server\", charset=\"UTF-8\""
.parse()
.unwrap(),
);
return Ok(resp);
}
} else {
tracing::error!("invalid basic authentication `user_id:password` pairs");
return error_page::error_response(
uri,
method,
&StatusCode::INTERNAL_SERVER_ERROR,
&self.opts.page404,
&self.opts.page50x,
);
}
}
// Advanced options
if let Some(advanced) = &self.opts.advanced_opts {
// Redirects
if let Some(parts) = redirects::get_redirection(uri_path, &advanced.redirects) {
let (uri_dest, status) = parts;
match HeaderValue::from_str(uri_dest) {
Ok(loc) => {
let mut resp = Response::new(Body::empty());
resp.headers_mut().insert(hyper::header::LOCATION, loc);
*resp.status_mut() = *status;
tracing::trace!(
"uri matches redirect pattern, redirecting with status {}",
status.canonical_reason().unwrap_or_default()
);
return Ok(resp);
}
Err(err) => {
tracing::error!("invalid header value from current uri: {:?}", err);
return error_page::error_response(
uri,
method,
&StatusCode::INTERNAL_SERVER_ERROR,
&self.opts.page404,
&self.opts.page50x,
);
}
};
}
// Rewrites
if let Some(uri) = rewrites::rewrite_uri_path(uri_path, &advanced.rewrites) {
uri_path = uri
}
}
// Static files
match static_files::handle(&HandleOpts {
method,
headers,
base_path,
uri_path,
uri_query,
dir_listing,
dir_listing_order,
dir_listing_format,
redirect_trailing_slash,
compression_static,
ignore_hidden_files,
})
.await
{
Ok((mut resp, is_precompressed)) => {
// Append CORS headers if they are present
if let Some(cors_headers) = cors_headers {
if !cors_headers.is_empty() {
for (k, v) in cors_headers.iter() {
resp.headers_mut().insert(k, v.to_owned());
}
resp.headers_mut().remove(http::header::ALLOW);
}
}
// Auto compression based on the `Accept-Encoding` header
if self.opts.compression && !is_precompressed {
resp = match compression::auto(method, headers, resp) {
Ok(res) => res,
Err(err) => {
tracing::error!("error during body compression: {:?}", err);
return error_page::error_response(
uri,
method,
&StatusCode::INTERNAL_SERVER_ERROR,
&self.opts.page404,
&self.opts.page50x,
);
}
};
}
// Append `Cache-Control` headers for web assets
if self.opts.cache_control_headers {
control_headers::append_headers(uri_path, &mut resp);
}
// Append security headers
if self.opts.security_headers {
security_headers::append_headers(&mut resp);
}
// Add/update custom headers
if let Some(advanced) = &self.opts.advanced_opts {
custom_headers::append_headers(uri_path, &advanced.headers, &mut resp)
}
Ok(resp)
}
Err(status) => {
// Check for a fallback response
if method.is_get()
&& status == StatusCode::NOT_FOUND
&& !self.opts.page_fallback.is_empty()
{
return Ok(fallback_page::fallback_response(&self.opts.page_fallback));
}
// Otherwise return a response error
error_page::error_response(
uri,
method,
&status,
&self.opts.page404,
&self.opts.page50x,
)
}
}
}
}
}