headers.rs 94.3%

116 of 123 lines run, 29 of 49 functions · run #530 on main · run missed

//! Security headers on every response (oxygenhub#222), and the endpoint
//! the browser reports Content-Security-Policy violations to.
//!
//! The policy is enforced (#227): the pages carry no inline scripts or
//! handlers, and in the week of reports before it was switched on the only
//! thing it would block was Cloudflare's analytics beacon, which the
//! policy now allows. Violations are still reported and logged; going back
//! to report-only is one constant ([`ENFORCE`]).
//! Responses that set their own policy (report frames, #127; a job's
//! HTML artifact) keep theirs, and may be framed as they say.
//! Strict-Transport-Security is sent only when `[server] hsts_max_age` is
//! set (oxygenhub#231), raised in stages: browsers keep it.

use axum::http::{header, HeaderName, HeaderValue};
use axum::response::Response;
use std::collections::HashMap;
use std::sync::Mutex;

/// Where violation reports go.
pub const REPORT_PATH: &str = "/csp-report";

/// Enforce the policy rather than only report it.
const ENFORCE: bool = true;

/// What the pages may load: their own scripts (and WebAssembly, for the
/// backdrop), styles (inline too: style attributes are everywhere), images
/// from anywhere over https (READMEs show badges), and forms posted only to
/// the hub (sign-in providers are reached by links, not forms). Cloudflare,
/// in front of oxygenhub.io, adds its Web Analytics beacon to pages: its
/// script and where it reports are allowed, nothing else of theirs.
const POLICY: &str = "default-src 'self'; script-src 'self' 'wasm-unsafe-eval' https://static.cloudflareinsights.com; \
style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self'; \
connect-src 'self' https://cloudflareinsights.com; media-src 'self'; object-src 'none'; \
base-uri 'self'; form-action 'self'; frame-ancestors 'none'; report-uri /csp-report; report-to csp";

const PERMISSIONS: &str = "camera=(), microphone=(), geolocation=(), payment=(), usb=(), serial=(), bluetooth=(), \
midi=(), magnetometer=(), gyroscope=(), accelerometer=(), display-capture=(), browsing-topics=(), interest-cohort=()";

/// The Strict-Transport-Security value for a site, if it sends one
/// (oxygenhub#231): only for an https address and a max-age above 0.
pub fn hsts(base_url: &str, max_age: u64) -> Option<HeaderValue> {
    (base_url.starts_with("https://") && max_age > 0).then(|| HeaderValue::from_str(&format!("max-age={max_age}")).ok()).flatten()
}

/// Adds the headers a response does not already carry.
pub async fn security_headers(
    axum::extract::State(hsts): axum::extract::State<Option<HeaderValue>>,
    req: axum::extract::Request,
    next: axum::middleware::Next,
) -> Response {
    let mut res = next.run(req).await;
    let h = res.headers_mut();
    if let Some(v) = hsts {
        h.entry(header::STRICT_TRANSPORT_SECURITY).or_insert(v);
    }
    let own_policy = h.contains_key(header::CONTENT_SECURITY_POLICY);
    let mut set = |name: HeaderName, value: &'static str| {
        h.entry(name).or_insert(HeaderValue::from_static(value));
    };
    set(header::X_CONTENT_TYPE_OPTIONS, "nosniff");
    set(header::REFERRER_POLICY, "strict-origin-when-cross-origin");
    set(HeaderName::from_static("permissions-policy"), PERMISSIONS);
    if !own_policy {
        set(header::X_FRAME_OPTIONS, "DENY");
        set(HeaderName::from_static("reporting-endpoints"), "csp=\"/csp-report\"");
        let name = if ENFORCE { header::CONTENT_SECURITY_POLICY } else { header::CONTENT_SECURITY_POLICY_REPORT_ONLY };
        set(name, POLICY);
    }
    res
}

/// One violation, as either report format gives it.
#[derive(Debug, PartialEq)]
pub struct Violation {
    pub page: String,
    pub directive: String,
    pub blocked: String,
    pub source: String,
}

/// The violations in a report body: the older `application/csp-report`
/// (`{"csp-report": {...}}`) or the Reporting API's list.
pub fn violations(body: &[u8]) -> Vec<Violation> {
    let Ok(v) = serde_json::from_slice::<serde_json::Value>(body) else { return vec![] };
    let s = |v: &serde_json::Value, keys: &[&str]| {
        keys.iter().find_map(|k| v.get(*k).and_then(|x| x.as_str().map(String::from).or_else(|| x.as_u64().map(|n| n.to_string()))))
    };
    let one = |r: &serde_json::Value, page: &[&str], dir: &[&str], blocked: &[&str], file: &[&str], line: &[&str]| Violation {
        page: s(r, page).unwrap_or_default(),
        directive: s(r, dir).unwrap_or_default(),
        blocked: s(r, blocked).unwrap_or_default(),
        source: match (s(r, file), s(r, line)) {
            (Some(f), Some(l)) => format!("{f}:{l}"),
            (Some(f), None) => f,
            _ => String::new(),
        },
    };
    if let Some(r) = v.get("csp-report") {
        return vec![one(
            r,
            &["document-uri"],
            &["effective-directive", "violated-directive"],
            &["blocked-uri"],
            &["source-file"],
            &["line-number"],
        )];
    }
    v.as_array()
        .map(|list| {
            list.iter()
                .filter(|r| r.get("type").and_then(|t| t.as_str()) == Some("csp-violation"))
                .filter_map(|r| r.get("body"))
                .map(|b| one(b, &["documentURL"], &["effectiveDirective"], &["blockedURL"], &["sourceFile"], &["lineNumber"]))
                .collect()
        })
        .unwrap_or_default()
}

/// Each distinct violation is logged once an hour, so a busy page does not
/// flood the log.
static SEEN: Mutex<Option<HashMap<String, i64>>> = Mutex::new(None);
const LOG_EVERY_MS: i64 = 60 * 60_000;

fn first_in_a_while(key: String, now_ms: i64) -> bool {
    let mut seen = SEEN.lock().unwrap();
    let seen = seen.get_or_insert_with(HashMap::new);
    if seen.len() > 1000 {
        seen.retain(|_, t| now_ms - *t < LOG_EVERY_MS);
    }
    match seen.get(&key) {
        Some(t) if now_ms - t < LOG_EVERY_MS => false,
        _ => {
            seen.insert(key, now_ms);
            true
        }
    }
}

/// `POST /csp-report`: log what the policy would block.
pub async fn csp_report(body: axum::body::Bytes) -> axum::http::StatusCode {
    let clip = |s: &str| s.chars().filter(|c| !c.is_control()).take(200).collect::<String>();
    for v in violations(&body) {
        // The page's path only: a query can hold anything.
        let page = v.page.split(['?', '#']).next().unwrap_or("").to_string();
        let key = format!("{}|{}|{}", v.directive, v.blocked, v.source);
        if first_in_a_while(key, crate::db::now_ms()) {
            tracing::warn!("csp would block: {} {} on {} ({})", clip(&v.directive), clip(&v.blocked), clip(&page), clip(&v.source));
        }
    }
    axum::http::StatusCode::NO_CONTENT
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn both_report_formats_are_read() {
        let old = br#"{"csp-report":{"document-uri":"https://hub.example/a?b","violated-directive":"script-src-elem","blocked-uri":"inline","source-file":"https://hub.example/a","line-number":12}}"#;
        assert_eq!(
            violations(old),
            vec![Violation {
                page: "https://hub.example/a?b".into(),
                directive: "script-src-elem".into(),
                blocked: "inline".into(),
                source: "https://hub.example/a:12".into()
            }]
        );
        let new = br#"[{"type":"csp-violation","url":"https://hub.example/x","body":{"documentURL":"https://hub.example/x","effectiveDirective":"img-src","blockedURL":"http://cdn.example/i.png"}},{"type":"deprecation","body":{}}]"#;
        let v = violations(new);
        assert_eq!(v.len(), 1);
        assert_eq!((v[0].directive.as_str(), v[0].blocked.as_str(), v[0].source.as_str()), ("img-src", "http://cdn.example/i.png", ""));
        assert!(violations(b"not json").is_empty());
    }

    #[test]
    fn a_violation_is_logged_once_an_hour() {
        let k = || "script-src|inline|test-only".to_string();
        assert!(first_in_a_while(k(), 1_000));
        assert!(!first_in_a_while(k(), 2_000));
        assert!(first_in_a_while(k(), 1_000 + LOG_EVERY_MS));
    }
}

1		//! Security headers on every response (oxygenhub#222), and the endpoint
2		//! the browser reports Content-Security-Policy violations to.
3		//!
4		//! The policy is enforced (#227): the pages carry no inline scripts or
5		//! handlers, and in the week of reports before it was switched on the only
6		//! thing it would block was Cloudflare's analytics beacon, which the
7		//! policy now allows. Violations are still reported and logged; going back
8		//! to report-only is one constant ([`ENFORCE`]).
9		//! Responses that set their own policy (report frames, #127; a job's
10		//! HTML artifact) keep theirs, and may be framed as they say.
11		//! Strict-Transport-Security is sent only when `[server] hsts_max_age` is
12		//! set (oxygenhub#231), raised in stages: browsers keep it.
13
14		use axum::http::{header, HeaderName, HeaderValue};
15		use axum::response::Response;
16		use std::collections::HashMap;
17		use std::sync::Mutex;
18
19		/// Where violation reports go.
20		pub const REPORT_PATH: &str = "/csp-report";
21
22		/// Enforce the policy rather than only report it.
23		const ENFORCE: bool = true;
24
25		/// What the pages may load: their own scripts (and WebAssembly, for the
26		/// backdrop), styles (inline too: style attributes are everywhere), images
27		/// from anywhere over https (READMEs show badges), and forms posted only to
28		/// the hub (sign-in providers are reached by links, not forms). Cloudflare,
29		/// in front of oxygenhub.io, adds its Web Analytics beacon to pages: its
30		/// script and where it reports are allowed, nothing else of theirs.
31		const POLICY: &str = "default-src 'self'; script-src 'self' 'wasm-unsafe-eval' https://static.cloudflareinsights.com; \
32		style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self'; \
33		connect-src 'self' https://cloudflareinsights.com; media-src 'self'; object-src 'none'; \
34		base-uri 'self'; form-action 'self'; frame-ancestors 'none'; report-uri /csp-report; report-to csp";
35
36		const PERMISSIONS: &str = "camera=(), microphone=(), geolocation=(), payment=(), usb=(), serial=(), bluetooth=(), \
37		midi=(), magnetometer=(), gyroscope=(), accelerometer=(), display-capture=(), browsing-topics=(), interest-cohort=()";
38
39		/// The Strict-Transport-Security value for a site, if it sends one
40		/// (oxygenhub#231): only for an https address and a max-age above 0.
41	2845×	pub fn hsts(base_url: &str, max_age: u64) -> Option<HeaderValue> {
42	2845×	(base_url.starts_with("https://") && max_age > 0).then(\|\| HeaderValue::from_str(&format!("max-age={max_age}")).ok()).flatten()
43	2845×	}
44
45		/// Adds the headers a response does not already carry.
46	3861×	pub async fn security_headers(
47	3861×	axum::extract::State(hsts): axum::extract::State<Option<HeaderValue>>,
48	3861×	req: axum::extract::Request,
49	3861×	next: axum::middleware::Next,
50	3861×	) -> Response {
51	3861×	let mut res = next.run(req).await;
52	3861×	let h = res.headers_mut();
53	3861×	if let Some(v) = hsts {
54	0×	h.entry(header::STRICT_TRANSPORT_SECURITY).or_insert(v);
55	3861×	}
56	3861×	let own_policy = h.contains_key(header::CONTENT_SECURITY_POLICY);
57	23136×	let mut set = \|name: HeaderName, value: &'static str\| {
58	23136×	h.entry(name).or_insert(HeaderValue::from_static(value));
59	23136×	};
60	3861×	set(header::X_CONTENT_TYPE_OPTIONS, "nosniff");
61	3861×	set(header::REFERRER_POLICY, "strict-origin-when-cross-origin");
62	3861×	set(HeaderName::from_static("permissions-policy"), PERMISSIONS);
63	3861×	if !own_policy {
64	3851×	set(header::X_FRAME_OPTIONS, "DENY");
65	3851×	set(HeaderName::from_static("reporting-endpoints"), "csp=\"/csp-report\"");
66	3851×	let name = if ENFORCE { header::CONTENT_SECURITY_POLICY } else { header::CONTENT_SECURITY_POLICY_REPORT_ONLY };
67	3851×	set(name, POLICY);
68	10×	}
69	3861×	res
70	3861×	}
71
72		/// One violation, as either report format gives it.
73		#[derive(Debug, PartialEq)]
74		pub struct Violation {
75		pub page: String,
76		pub directive: String,
77		pub blocked: String,
78		pub source: String,
79		}
80
81		/// The violations in a report body: the older `application/csp-report`
82		/// (`{"csp-report": {...}}`) or the Reporting API's list.
83	4×	pub fn violations(body: &[u8]) -> Vec<Violation> {
84	4×	let Ok(v) = serde_json::from_slice::<serde_json::Value>(body) else { return vec![] };
85	15×	let s = \|v: &serde_json::Value, keys: &[&str]\| {
86	17×	keys.iter().find_map(\|k\| v.get(*k).and_then(\|x\| x.as_str().map(String::from).or_else(\|\| x.as_u64().map(\|n\| n.to_string()))))
87	15×	};
88	3×	let one = \|r: &serde_json::Value, page: &[&str], dir: &[&str], blocked: &[&str], file: &[&str], line: &[&str]\| Violation {
89	3×	page: s(r, page).unwrap_or_default(),
90	3×	directive: s(r, dir).unwrap_or_default(),
91	3×	blocked: s(r, blocked).unwrap_or_default(),
92	3×	source: match (s(r, file), s(r, line)) {
93	1×	(Some(f), Some(l)) => format!("{f}:{l}"),
94	0×	(Some(f), None) => f,
95	2×	_ => String::new(),
96		},
97	3×	};
98	3×	if let Some(r) = v.get("csp-report") {
99	2×	return vec![one(
100	2×	r,
101	2×	&["document-uri"],
102	2×	&["effective-directive", "violated-directive"],
103	2×	&["blocked-uri"],
104	2×	&["source-file"],
105	2×	&["line-number"],
106	2×	)];
107	1×	}
108	1×	v.as_array()
109	1×	.map(\|list\| {
110	1×	list.iter()
111	2×	.filter(\|r\| r.get("type").and_then(\|t\| t.as_str()) == Some("csp-violation"))
112	1×	.filter_map(\|r\| r.get("body"))
113	1×	.map(\|b\| one(b, &["documentURL"], &["effectiveDirective"], &["blockedURL"], &["sourceFile"], &["lineNumber"]))
114	1×	.collect()
115	1×	})
116	1×	.unwrap_or_default()
117	4×	}
118
119		/// Each distinct violation is logged once an hour, so a busy page does not
120		/// flood the log.
121		static SEEN: Mutex<Option<HashMap<String, i64>>> = Mutex::new(None);
122		const LOG_EVERY_MS: i64 = 60 * 60_000;
123
124	4×	fn first_in_a_while(key: String, now_ms: i64) -> bool {
125	4×	let mut seen = SEEN.lock().unwrap();
126	4×	let seen = seen.get_or_insert_with(HashMap::new);
127	4×	if seen.len() > 1000 {
128	0×	seen.retain(\|_, t\| now_ms - *t < LOG_EVERY_MS);
129	4×	}
130	4×	match seen.get(&key) {
131	2×	Some(t) if now_ms - t < LOG_EVERY_MS => false,
132		_ => {
133	3×	seen.insert(key, now_ms);
134	3×	true
135		}
136		}
137	4×	}
138
139		/// `POST /csp-report`: log what the policy would block.
140	1×	pub async fn csp_report(body: axum::body::Bytes) -> axum::http::StatusCode {
141	1×	let clip = \|s: &str\| s.chars().filter(\|c\| !c.is_control()).take(200).collect::<String>();
142	1×	for v in violations(&body) {
143		// The page's path only: a query can hold anything.
144	1×	let page = v.page.split(['?', '#']).next().unwrap_or("").to_string();
145	1×	let key = format!("{}\|{}\|{}", v.directive, v.blocked, v.source);
146	1×	if first_in_a_while(key, crate::db::now_ms()) {
147	1×	tracing::warn!("csp would block: {} {} on {} ({})", clip(&v.directive), clip(&v.blocked), clip(&page), clip(&v.source));
148	0×	}
149		}
150	1×	axum::http::StatusCode::NO_CONTENT
151	1×	}
152
153		#[cfg(test)]
154		mod tests {
155		use super::*;
156
157		#[test]
158	1×	fn both_report_formats_are_read() {
159	1×	let old = br#"{"csp-report":{"document-uri":"https://hub.example/a?b","violated-directive":"script-src-elem","blocked-uri":"inline","source-file":"https://hub.example/a","line-number":12}}"#;
160	1×	assert_eq!(
161	1×	violations(old),
162	1×	vec![Violation {
163	1×	page: "https://hub.example/a?b".into(),
164	1×	directive: "script-src-elem".into(),
165	1×	blocked: "inline".into(),
166	1×	source: "https://hub.example/a:12".into()
167	1×	}]
168		);
169	1×	let new = br#"[{"type":"csp-violation","url":"https://hub.example/x","body":{"documentURL":"https://hub.example/x","effectiveDirective":"img-src","blockedURL":"http://cdn.example/i.png"}},{"type":"deprecation","body":{}}]"#;
170	1×	let v = violations(new);
171	1×	assert_eq!(v.len(), 1);
172	1×	assert_eq!((v[0].directive.as_str(), v[0].blocked.as_str(), v[0].source.as_str()), ("img-src", "http://cdn.example/i.png", ""));
173	1×	assert!(violations(b"not json").is_empty());
174	1×	}
175
176		#[test]
177	1×	fn a_violation_is_logged_once_an_hour() {
178	3×	let k = \|\| "script-src\|inline\|test-only".to_string();
179	1×	assert!(first_in_a_while(k(), 1_000));
180	1×	assert!(!first_in_a_while(k(), 2_000));
181	1×	assert!(first_in_a_while(k(), 1_000 + LOG_EVERY_MS));
182	1×	}
183		}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

Coverage / crates/hub/src/headers.rs 94.3%

Keyboard