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
use std::fmt;
use std::time::Duration;
use util::{self, IterExt, Seconds};
/// `StrictTransportSecurity` header, defined in [RFC6797](https://tools.ietf.org/html/rfc6797)
///
/// This specification defines a mechanism enabling web sites to declare
/// themselves accessible only via secure connections and/or for users to be
/// able to direct their user agent(s) to interact with given sites only over
/// secure connections. This overall policy is referred to as HTTP Strict
/// Transport Security (HSTS). The policy is declared by web sites via the
/// Strict-Transport-Security HTTP response header field and/or by other means,
/// such as user agent configuration, for example.
///
/// # ABNF
///
/// ```text
/// [ directive ] *( ";" [ directive ] )
///
/// directive = directive-name [ "=" directive-value ]
/// directive-name = token
/// directive-value = token | quoted-string
///
/// ```
///
/// # Example values
///
/// * `max-age=31536000`
/// * `max-age=15768000 ; includeSubdomains`
///
/// # Example
///
/// ```
/// # extern crate headers;
/// use std::time::Duration;
/// use headers::StrictTransportSecurity;
///
/// let sts = StrictTransportSecurity::including_subdomains(Duration::from_secs(31_536_000));
/// ```
#[derive(Clone, Debug, PartialEq)]
pub struct StrictTransportSecurity {
/// Signals the UA that the HSTS Policy applies to this HSTS Host as well as
/// any subdomains of the host's domain name.
include_subdomains: bool,
/// Specifies the number of seconds, after the reception of the STS header
/// field, during which the UA regards the host (from whom the message was
/// received) as a Known HSTS Host.
max_age: Seconds,
}
impl StrictTransportSecurity {
// NOTE: The two constructors exist to make a user *have* to decide if
// subdomains can be included or not, instead of forgetting due to an
// incorrect assumption about a default.
/// Create an STS header that includes subdomains
pub fn including_subdomains(max_age: Duration) -> StrictTransportSecurity {
StrictTransportSecurity {
max_age: max_age.into(),
include_subdomains: true,
}
}
/// Create an STS header that excludes subdomains
pub fn excluding_subdomains(max_age: Duration) -> StrictTransportSecurity {
StrictTransportSecurity {
max_age: max_age.into(),
include_subdomains: false,
}
}
// getters
/// Get whether this should include subdomains.
pub fn include_subdomains(&self) -> bool {
self.include_subdomains
}
/// Get the max-age.
pub fn max_age(&self) -> Duration {
self.max_age.into()
}
}
enum Directive {
MaxAge(u64),
IncludeSubdomains,
Unknown,
}
fn from_str(s: &str) -> Result<StrictTransportSecurity, ::Error> {
s.split(';')
.map(str::trim)
.map(|sub| {
if sub.eq_ignore_ascii_case("includeSubdomains") {
Some(Directive::IncludeSubdomains)
} else {
let mut sub = sub.splitn(2, '=');
match (sub.next(), sub.next()) {
(Some(left), Some(right)) if left.trim().eq_ignore_ascii_case("max-age") => {
right
.trim()
.trim_matches('"')
.parse()
.ok()
.map(Directive::MaxAge)
}
_ => Some(Directive::Unknown),
}
}
})
.fold(Some((None, None)), |res, dir| match (res, dir) {
(Some((None, sub)), Some(Directive::MaxAge(age))) => Some((Some(age), sub)),
(Some((age, None)), Some(Directive::IncludeSubdomains)) => Some((age, Some(()))),
(Some((Some(_), _)), Some(Directive::MaxAge(_)))
| (Some((_, Some(_))), Some(Directive::IncludeSubdomains))
| (_, None) => None,
(res, _) => res,
})
.and_then(|res| match res {
(Some(age), sub) => Some(StrictTransportSecurity {
max_age: Duration::from_secs(age).into(),
include_subdomains: sub.is_some(),
}),
_ => None,
})
.ok_or_else(::Error::invalid)
}
impl ::Header for StrictTransportSecurity {
fn name() -> &'static ::HeaderName {
&::http::header::STRICT_TRANSPORT_SECURITY
}
fn decode<'i, I: Iterator<Item = &'i ::HeaderValue>>(values: &mut I) -> Result<Self, ::Error> {
values
.just_one()
.and_then(|v| v.to_str().ok())
.map(from_str)
.unwrap_or_else(|| Err(::Error::invalid()))
}
fn encode<E: Extend<::HeaderValue>>(&self, values: &mut E) {
struct Adapter<'a>(&'a StrictTransportSecurity);
impl<'a> fmt::Display for Adapter<'a> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.0.include_subdomains {
write!(f, "max-age={}; includeSubdomains", self.0.max_age)
} else {
write!(f, "max-age={}", self.0.max_age)
}
}
}
values.extend(::std::iter::once(util::fmt(Adapter(self))));
}
}
#[cfg(test)]
mod tests {
use super::super::test_decode;
use super::StrictTransportSecurity;
use std::time::Duration;
#[test]
fn test_parse_max_age() {
let h = test_decode::<StrictTransportSecurity>(&["max-age=31536000"]).unwrap();
assert_eq!(
h,
StrictTransportSecurity {
include_subdomains: false,
max_age: Duration::from_secs(31536000).into(),
}
);
}
#[test]
fn test_parse_max_age_no_value() {
assert_eq!(test_decode::<StrictTransportSecurity>(&["max-age"]), None,);
}
#[test]
fn test_parse_quoted_max_age() {
let h = test_decode::<StrictTransportSecurity>(&["max-age=\"31536000\""]).unwrap();
assert_eq!(
h,
StrictTransportSecurity {
include_subdomains: false,
max_age: Duration::from_secs(31536000).into(),
}
);
}
#[test]
fn test_parse_spaces_max_age() {
let h = test_decode::<StrictTransportSecurity>(&["max-age = 31536000"]).unwrap();
assert_eq!(
h,
StrictTransportSecurity {
include_subdomains: false,
max_age: Duration::from_secs(31536000).into(),
}
);
}
#[test]
fn test_parse_include_subdomains() {
let h = test_decode::<StrictTransportSecurity>(&["max-age=15768000 ; includeSubDomains"])
.unwrap();
assert_eq!(
h,
StrictTransportSecurity {
include_subdomains: true,
max_age: Duration::from_secs(15768000).into(),
}
);
}
#[test]
fn test_parse_no_max_age() {
assert_eq!(
test_decode::<StrictTransportSecurity>(&["includeSubdomains"]),
None,
);
}
#[test]
fn test_parse_max_age_nan() {
assert_eq!(
test_decode::<StrictTransportSecurity>(&["max-age = izzy"]),
None,
);
}
#[test]
fn test_parse_duplicate_directives() {
assert_eq!(
test_decode::<StrictTransportSecurity>(&["max-age=1; max-age=2"]),
None,
);
}
}
//bench_header!(bench, StrictTransportSecurity, { vec![b"max-age=15768000 ; includeSubDomains".to_vec()] });