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 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
// SPDX-License-Identifier: MIT OR Apache-2.0
// This file is part of Static Web Server.
// See https://static-web-server.net/ for more information
// Copyright (C) 2019-present Jose Quintana <joseluisq.net>
//! Module that provides all settings of SWS.
//!
use clap::Parser;
use globset::{Glob, GlobMatcher};
use headers::HeaderMap;
use hyper::StatusCode;
use regex::Regex;
use std::path::{Path, PathBuf};
use crate::{helpers, logger, Context, Result};
pub mod cli;
pub mod file;
#[cfg(windows)]
pub use cli::Commands;
use cli::General;
use self::file::{RedirectsKind, Settings as FileSettings};
/// The `headers` file options.
pub struct Headers {
/// Source pattern glob matcher
pub source: GlobMatcher,
/// Map of custom HTTP headers
pub headers: HeaderMap,
}
/// The `Rewrites` file options.
pub struct Rewrites {
/// Source pattern Regex matcher
pub source: Regex,
/// A local file that must exist
pub destination: String,
/// Optional redirect type either 301 (Moved Permanently) or 302 (Found).
pub redirect: Option<RedirectsKind>,
}
/// The `Redirects` file options.
pub struct Redirects {
/// Optional host to match against an incoming URI host if specified
pub host: Option<String>,
/// Source pattern Regex matcher
pub source: Regex,
/// A local file that must exist
pub destination: String,
/// Redirection type either 301 (Moved Permanently) or 302 (Found)
pub kind: StatusCode,
}
/// The `VirtualHosts` file options.
pub struct VirtualHosts {
/// The value to check for in the "Host" header
pub host: String,
/// The root directory for this virtual host
pub root: PathBuf,
}
/// The `advanced` file options.
pub struct Advanced {
/// Headers list.
pub headers: Option<Vec<Headers>>,
/// Rewrites list.
pub rewrites: Option<Vec<Rewrites>>,
/// Redirects list.
pub redirects: Option<Vec<Redirects>>,
/// Name-based virtual hosting
pub virtual_hosts: Option<Vec<VirtualHosts>>,
}
/// The full server CLI and File options.
pub struct Settings {
/// General server options
pub general: General,
/// Advanced server options
pub advanced: Option<Advanced>,
}
impl Settings {
/// Reads CLI/Env and config file options returning the server settings.
/// It also takes care to initialize the logging system with its level
/// once the `general` settings are determined.
pub fn get(log_init: bool) -> Result<Settings> {
let opts = General::parse();
// Define the general CLI/file options
let mut host = opts.host;
let mut port = opts.port;
let mut root = opts.root;
let mut log_level = opts.log_level;
let mut config_file = opts.config_file.clone();
let mut cache_control_headers = opts.cache_control_headers;
#[cfg(feature = "compression")]
let mut compression = opts.compression;
#[cfg(feature = "compression")]
let mut compression_static = opts.compression_static;
let mut page404 = opts.page404;
let mut page50x = opts.page50x;
#[cfg(feature = "http2")]
let mut http2 = opts.http2;
#[cfg(feature = "http2")]
let mut http2_tls_cert = opts.http2_tls_cert;
#[cfg(feature = "http2")]
let mut http2_tls_key = opts.http2_tls_key;
#[cfg(feature = "http2")]
let mut https_redirect = opts.https_redirect;
#[cfg(feature = "http2")]
let mut https_redirect_host = opts.https_redirect_host;
#[cfg(feature = "http2")]
let mut https_redirect_from_port = opts.https_redirect_from_port;
#[cfg(feature = "http2")]
let mut https_redirect_from_hosts = opts.https_redirect_from_hosts;
let mut security_headers = opts.security_headers;
let mut cors_allow_origins = opts.cors_allow_origins;
let mut cors_allow_headers = opts.cors_allow_headers;
let mut cors_expose_headers = opts.cors_expose_headers;
#[cfg(feature = "directory-listing")]
let mut directory_listing = opts.directory_listing;
#[cfg(feature = "directory-listing")]
let mut directory_listing_order = opts.directory_listing_order;
#[cfg(feature = "directory-listing")]
let mut directory_listing_format = opts.directory_listing_format;
#[cfg(feature = "basic-auth")]
let mut basic_auth = opts.basic_auth;
let mut fd = opts.fd;
let mut threads_multiplier = opts.threads_multiplier;
let mut max_blocking_threads = opts.max_blocking_threads;
let mut grace_period = opts.grace_period;
#[cfg(feature = "fallback-page")]
let mut page_fallback = opts.page_fallback;
let mut log_remote_address = opts.log_remote_address;
let mut redirect_trailing_slash = opts.redirect_trailing_slash;
let mut ignore_hidden_files = opts.ignore_hidden_files;
let mut index_files = opts.index_files;
let mut health = opts.health;
#[cfg(all(unix, feature = "experimental"))]
let mut experimental_metrics = opts.experimental_metrics;
let mut maintenance_mode = opts.maintenance_mode;
let mut maintenance_mode_status = opts.maintenance_mode_status;
let mut maintenance_mode_file = opts.maintenance_mode_file;
// Windows-only options
#[cfg(windows)]
let mut windows_service = opts.windows_service;
// Define the advanced file options
let mut settings_advanced: Option<Advanced> = None;
// Handle "config file options" and set them when available
// NOTE: All config file based options shouldn't be mandatory, therefore `Some()` wrapped
if let Some((settings, config_file_resolved)) = read_file_settings(&opts.config_file)? {
config_file = config_file_resolved;
// File-based "general" options
let has_general_settings = settings.general.is_some();
if has_general_settings {
let general = settings.general.unwrap();
if let Some(v) = general.host {
host = v
}
if let Some(v) = general.port {
port = v
}
if let Some(v) = general.root {
root = v
}
if let Some(ref v) = general.log_level {
log_level = v.name().to_lowercase();
}
if let Some(v) = general.cache_control_headers {
cache_control_headers = v
}
#[cfg(feature = "compression")]
if let Some(v) = general.compression {
compression = v
}
#[cfg(feature = "compression")]
if let Some(v) = general.compression_static {
compression_static = v
}
if let Some(v) = general.page404 {
page404 = v
}
if let Some(v) = general.page50x {
page50x = v
}
#[cfg(feature = "http2")]
if let Some(v) = general.http2 {
http2 = v
}
#[cfg(feature = "http2")]
if let Some(v) = general.http2_tls_cert {
http2_tls_cert = Some(v)
}
#[cfg(feature = "http2")]
if let Some(v) = general.http2_tls_key {
http2_tls_key = Some(v)
}
#[cfg(feature = "http2")]
if let Some(v) = general.https_redirect {
https_redirect = v
}
#[cfg(feature = "http2")]
if let Some(v) = general.https_redirect_host {
https_redirect_host = v
}
#[cfg(feature = "http2")]
if let Some(v) = general.https_redirect_from_port {
https_redirect_from_port = v
}
#[cfg(feature = "http2")]
if let Some(v) = general.https_redirect_from_hosts {
https_redirect_from_hosts = v
}
#[cfg(feature = "http2")]
match general.security_headers {
Some(v) => security_headers = v,
_ => {
if http2 {
security_headers = true;
}
}
}
#[cfg(not(feature = "http2"))]
if let Some(v) = general.security_headers {
security_headers = v
}
if let Some(ref v) = general.cors_allow_origins {
cors_allow_origins = v.to_owned()
}
if let Some(ref v) = general.cors_allow_headers {
cors_allow_headers = v.to_owned()
}
if let Some(ref v) = general.cors_expose_headers {
cors_expose_headers = v.to_owned()
}
#[cfg(feature = "directory-listing")]
if let Some(v) = general.directory_listing {
directory_listing = v
}
#[cfg(feature = "directory-listing")]
if let Some(v) = general.directory_listing_order {
directory_listing_order = v
}
#[cfg(feature = "directory-listing")]
if let Some(v) = general.directory_listing_format {
directory_listing_format = v
}
#[cfg(feature = "basic-auth")]
if let Some(ref v) = general.basic_auth {
basic_auth = v.to_owned()
}
if let Some(v) = general.fd {
fd = Some(v)
}
if let Some(v) = general.threads_multiplier {
threads_multiplier = v
}
if let Some(v) = general.max_blocking_threads {
max_blocking_threads = v
}
if let Some(v) = general.grace_period {
grace_period = v
}
#[cfg(feature = "fallback-page")]
if let Some(v) = general.page_fallback {
page_fallback = v
}
if let Some(v) = general.log_remote_address {
log_remote_address = v
}
if let Some(v) = general.redirect_trailing_slash {
redirect_trailing_slash = v
}
if let Some(v) = general.ignore_hidden_files {
ignore_hidden_files = v
}
if let Some(v) = general.health {
health = v
}
#[cfg(all(unix, feature = "experimental"))]
if let Some(v) = general.experimental_metrics {
experimental_metrics = v
}
if let Some(v) = general.index_files {
index_files = v
}
if let Some(v) = general.maintenance_mode {
maintenance_mode = v
}
if let Some(v) = general.maintenance_mode_status {
maintenance_mode_status =
StatusCode::from_u16(v).with_context(|| "invalid HTTP status code")?
}
if let Some(v) = general.maintenance_mode_file {
maintenance_mode_file = v
}
// Windows-only options
#[cfg(windows)]
if let Some(v) = general.windows_service {
windows_service = v
}
}
// Logging system initialization in config file context
if log_init {
logger::init(log_level.as_str())?;
}
tracing::debug!("config file read successfully");
tracing::debug!("config file path provided: {}", opts.config_file.display());
tracing::debug!("config file path resolved: {}", config_file.display());
if !has_general_settings {
server_warn!(
"config file empty or no `general` settings found, using default values"
);
}
// File-based "advanced" options
if let Some(advanced) = settings.advanced {
// 1. Custom HTTP headers assignment
let headers_entries = match advanced.headers {
Some(headers_entries) => {
let mut headers_vec: Vec<Headers> = Vec::new();
// Compile a glob pattern for each header sources entry
for headers_entry in headers_entries.iter() {
let source = Glob::new(&headers_entry.source)
.with_context(|| {
format!(
"can not compile glob pattern for header source: {}",
&headers_entry.source
)
})?
.compile_matcher();
headers_vec.push(Headers {
source,
headers: headers_entry.headers.to_owned(),
});
}
Some(headers_vec)
}
_ => None,
};
// 2. Rewrites assignment
let rewrites_entries = match advanced.rewrites {
Some(rewrites_entries) => {
let mut rewrites_vec: Vec<Rewrites> = Vec::new();
// Compile a glob pattern for each rewrite sources entry
for rewrites_entry in rewrites_entries.iter() {
let source = Glob::new(&rewrites_entry.source)
.with_context(|| {
format!(
"can not compile glob pattern for rewrite source: {}",
&rewrites_entry.source
)
})?
.compile_matcher();
let pattern = source
.glob()
.regex()
.trim_start_matches("(?-u)")
.replace("?:.*", ".*")
.replace("?:", "")
.replace(".*.*", ".*")
.to_owned();
tracing::debug!(
"url rewrites glob pattern: {}",
&rewrites_entry.source
);
tracing::debug!("url rewrites regex equivalent: {}", pattern);
let source = Regex::new(&pattern).with_context(|| {
format!(
"can not compile regex pattern equivalent for rewrite source: {}",
&pattern
)
})?;
rewrites_vec.push(Rewrites {
source,
destination: rewrites_entry.destination.to_owned(),
redirect: rewrites_entry.redirect.to_owned(),
});
}
Some(rewrites_vec)
}
_ => None,
};
// 3. Redirects assignment
let redirects_entries = match advanced.redirects {
Some(redirects_entries) => {
let mut redirects_vec: Vec<Redirects> = Vec::new();
// Compile a glob pattern for each redirect sources entry
for redirects_entry in redirects_entries.iter() {
let source = Glob::new(&redirects_entry.source)
.with_context(|| {
format!(
"can not compile glob pattern for redirect source: {}",
&redirects_entry.source
)
})?
.compile_matcher();
let pattern = source
.glob()
.regex()
.trim_start_matches("(?-u)")
.replace("?:.*", ".*")
.replace("?:", "")
.replace(".*.*", ".*")
.to_owned();
tracing::debug!(
"url redirects glob pattern: {}",
&redirects_entry.source
);
tracing::debug!("url redirects regex equivalent: {}", pattern);
let source = Regex::new(&pattern).with_context(|| {
format!(
"can not compile regex pattern equivalent for redirect source: {}",
&pattern
)
})?;
let status_code = redirects_entry.kind.to_owned() as u16;
redirects_vec.push(Redirects {
host: redirects_entry.host.to_owned(),
source,
destination: redirects_entry.destination.to_owned(),
kind: StatusCode::from_u16(status_code).with_context(|| {
format!("invalid redirect status code: {status_code}")
})?,
});
}
Some(redirects_vec)
}
_ => None,
};
// 3. Virtual hosts assignment
let vhosts_entries = match advanced.virtual_hosts {
Some(vhosts_entries) => {
let mut vhosts_vec: Vec<VirtualHosts> = Vec::new();
for vhosts_entry in vhosts_entries.iter() {
if let Some(root) = vhosts_entry.root.to_owned() {
// Make sure path is valid
let root_dir = helpers::get_valid_dirpath(&root)
.with_context(|| "root directory for virtual host was not found or inaccessible")?;
tracing::debug!(
"added virtual host: {} -> {}",
vhosts_entry.host,
root_dir.display()
);
vhosts_vec.push(VirtualHosts {
host: vhosts_entry.host.to_owned(),
root: root_dir,
});
}
}
Some(vhosts_vec)
}
_ => None,
};
settings_advanced = Some(Advanced {
headers: headers_entries,
rewrites: rewrites_entries,
redirects: redirects_entries,
virtual_hosts: vhosts_entries,
});
}
} else if log_init {
// Logging system initialization on demand
logger::init(log_level.as_str())?;
}
Ok(Settings {
general: General {
host,
port,
root,
log_level,
config_file,
cache_control_headers,
#[cfg(feature = "compression")]
compression,
#[cfg(feature = "compression")]
compression_static,
page404,
page50x,
#[cfg(feature = "http2")]
http2,
#[cfg(feature = "http2")]
http2_tls_cert,
#[cfg(feature = "http2")]
http2_tls_key,
#[cfg(feature = "http2")]
https_redirect,
#[cfg(feature = "http2")]
https_redirect_host,
#[cfg(feature = "http2")]
https_redirect_from_port,
#[cfg(feature = "http2")]
https_redirect_from_hosts,
security_headers,
cors_allow_origins,
cors_allow_headers,
cors_expose_headers,
#[cfg(feature = "directory-listing")]
directory_listing,
#[cfg(feature = "directory-listing")]
directory_listing_order,
#[cfg(feature = "directory-listing")]
directory_listing_format,
#[cfg(feature = "basic-auth")]
basic_auth,
fd,
threads_multiplier,
max_blocking_threads,
grace_period,
#[cfg(feature = "fallback-page")]
page_fallback,
log_remote_address,
redirect_trailing_slash,
ignore_hidden_files,
index_files,
health,
#[cfg(all(unix, feature = "experimental"))]
experimental_metrics,
maintenance_mode,
maintenance_mode_status,
maintenance_mode_file,
// Windows-only options and commands
#[cfg(windows)]
windows_service,
#[cfg(windows)]
commands: opts.commands,
},
advanced: settings_advanced,
})
}
}
fn read_file_settings(config_file: &Path) -> Result<Option<(FileSettings, PathBuf)>> {
if config_file.is_file() {
let file_path_resolved = config_file
.canonicalize()
.with_context(|| "unable to resolve toml config file path")?;
let settings = FileSettings::read(&file_path_resolved).with_context(|| {
"unable to read toml config file because has invalid format or unsupported options"
})?;
return Ok(Some((settings, file_path_resolved)));
}
Ok(None)
}