Struct StrictTransportSecurity 

pub struct StrictTransportSecurity { /* private fields */ }

HTTP Strict Transport Security (HSTS) policy.

Examples

use http_security_headers::StrictTransportSecurity;
use std::time::Duration;

// One year HSTS with subdomains
let hsts = StrictTransportSecurity::new(Duration::from_secs(31536000))
    .include_subdomains(true);

// Custom configuration
let hsts = StrictTransportSecurity::new(Duration::from_secs(86400))
    .include_subdomains(false)
    .preload(true);

Implementations

impl StrictTransportSecurity

pub fn new(max_age: Duration) -> Self

Creates a new HSTS policy with the specified max-age.

Arguments

• max_age - The time, in seconds, that the browser should remember to only access the site using HTTPS.

Examples

use http_security_headers::StrictTransportSecurity;
use std::time::Duration;

let hsts = StrictTransportSecurity::new(Duration::from_secs(31536000)); // 1 year

pub fn include_subdomains(self, include: bool) -> Self

Sets whether the rule applies to all subdomains.

When enabled, this rule applies to all of the site’s subdomains as well.

pub fn preload(self, preload: bool) -> Self

Sets whether the site wishes to be included in the HSTS preload list.

Note: Before enabling preload, ensure your site meets the preload list requirements: https://hstspreload.org/

pub fn max_age(&self) -> Duration

Gets the max-age duration.

pub fn includes_subdomains(&self) -> bool

Returns whether subdomains are included.

pub fn is_preload(&self) -> bool

Returns whether preload is enabled.

pub fn to_header_value(&self) -> Result<String>

Converts the policy to its header value string.

pub fn parse(value: &str) -> Result<Self>

Parses an HSTS policy from a header value string.

Examples

use http_security_headers::StrictTransportSecurity;

let hsts = StrictTransportSecurity::parse("max-age=31536000; includeSubDomains").unwrap();

Trait Implementations

impl Clone for StrictTransportSecurity

fn clone(&self) -> StrictTransportSecurity

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StrictTransportSecurity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for StrictTransportSecurity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StrictTransportSecurity

fn eq(&self, other: &StrictTransportSecurity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StrictTransportSecurity

impl StructuralPartialEq for StrictTransportSecurity