tako-rs 1.1.2

Multi-transport Rust framework for modern network services.
Documentation 
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

//! Security headers middleware for common HTTP security best practices.
//!
//! Adds standard security headers to all responses:
//! - `X-Content-Type-Options: nosniff`
//! - `X-Frame-Options: DENY`
//! - `X-XSS-Protection: 0`
//! - `Referrer-Policy: strict-origin-when-cross-origin`
//! - `Strict-Transport-Security` (opt-in via builder)

use std::future::Future;
use std::pin::Pin;

use http::HeaderValue;

use crate::middleware::IntoMiddleware;
use crate::middleware::Next;
use crate::types::Request;
use crate::types::Response;

/// Security headers middleware configuration.
///
/// # Examples
///
/// ```rust
/// use tako::middleware::security_headers::SecurityHeaders;
/// use tako::middleware::IntoMiddleware;
///
/// let headers = SecurityHeaders::new();
/// let mw = headers.into_middleware();
///
/// // With HSTS enabled
/// let headers = SecurityHeaders::new().hsts(true);
/// ```
pub struct SecurityHeaders {
  frame_options: HeaderValue,
  hsts: bool,
  hsts_max_age: u64,
  hsts_include_subdomains: bool,
  referrer_policy: HeaderValue,
}

impl Default for SecurityHeaders {
  fn default() -> Self {
    Self::new()
  }
}

impl SecurityHeaders {
  /// Creates a new SecurityHeaders middleware with sensible defaults.
  pub fn new() -> Self {
    Self {
      frame_options: HeaderValue::from_static("DENY"),
      hsts: false,
      hsts_max_age: 31536000,
      hsts_include_subdomains: true,
      referrer_policy: HeaderValue::from_static("strict-origin-when-cross-origin"),
    }
  }

  /// Sets the `X-Frame-Options` value (e.g., "DENY", "SAMEORIGIN").
  pub fn frame_options(mut self, value: &'static str) -> Self {
    self.frame_options = HeaderValue::from_static(value);
    self
  }

  /// Enables or disables `Strict-Transport-Security` header.
  pub fn hsts(mut self, enable: bool) -> Self {
    self.hsts = enable;
    self
  }

  /// Sets the HSTS `max-age` value in seconds. Default: 31536000 (1 year).
  pub fn hsts_max_age(mut self, seconds: u64) -> Self {
    self.hsts_max_age = seconds;
    self
  }

  /// Sets the `Referrer-Policy` value.
  pub fn referrer_policy(mut self, value: &'static str) -> Self {
    self.referrer_policy = HeaderValue::from_static(value);
    self
  }
}

impl IntoMiddleware for SecurityHeaders {
  fn into_middleware(
    self,
  ) -> impl Fn(Request, Next) -> Pin<Box<dyn Future<Output = Response> + Send + 'static>>
  + Clone
  + Send
  + Sync
  + 'static {
    let frame_options = self.frame_options;
    let hsts_value = if self.hsts {
      let val = if self.hsts_include_subdomains {
        format!(
          "max-age={}; includeSubDomains",
          self.hsts_max_age
        )
      } else {
        format!("max-age={}", self.hsts_max_age)
      };
      Some(HeaderValue::from_str(&val).expect("valid HSTS header"))
    } else {
      None
    };
    let referrer_policy = self.referrer_policy;

    move |req: Request, next: Next| {
      let frame_options = frame_options.clone();
      let hsts_value = hsts_value.clone();
      let referrer_policy = referrer_policy.clone();

      Box::pin(async move {
        let mut resp = next.run(req).await;
        let headers = resp.headers_mut();

        headers.insert("x-content-type-options", HeaderValue::from_static("nosniff"));
        headers.insert("x-frame-options", frame_options);
        headers.insert("x-xss-protection", HeaderValue::from_static("0"));
        headers.insert("referrer-policy", referrer_policy);

        if let Some(hsts) = hsts_value {
          headers.insert("strict-transport-security", hsts);
        }

        resp
      })
    }
  }
}