Struct StrictTransportSecurity

pub struct StrictTransportSecurity {
    pub include_subdomains: bool,
    pub preload: bool,
    /* private fields */
}

HTTP Strict Transport Security (HSTS) configuration.

Care should be taken when setting up HSTS for your site; misconfiguration can potentially leave parts of your site in an unusable state.

Default

The Default implementation uses a 5 minute max-age and does not include subdomains or preloading. This default is intentionally conservative to prevent accidental misconfiguration causing irrecoverable problems for users.

Once you have configured and tested the default HSTS config, recommended can be used as a secure default for production.

References

See the HSTS page on MDN for more information.

Fields

include_subdomains: bool

The includeSubdomains directive.

preload: bool

The preload directive.

Implementations

impl StrictTransportSecurity

pub fn new(duration: Duration) -> Self

Constructs a new HSTS configuration using the given duration.

Other values take their default.

pub fn recommended() -> Self

Constructs a secure, production-ready HSTS configuration.

Uses a max-age of 2 years and includes subdomains.

pub fn include_subdomains(self) -> Self

Send includeSubdomains directive with header.

pub fn preload(self) -> Self

Send preload directive with header.

See https://hstspreload.org/ for more information.

Trait Implementations

impl Clone for StrictTransportSecurity

fn clone(&self) -> StrictTransportSecurity

Returns a copy 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 Default for StrictTransportSecurity

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for StrictTransportSecurity

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(val: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Header for StrictTransportSecurity

fn name() -> HeaderName

Returns the name of the header field.

fn parse<M: HttpMessage>(msg: &M) -> Result<Self, ParseError>

Parse the header from a HTTP message.

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 TryIntoHeaderValue for StrictTransportSecurity

type Error = Infallible

The type returned in the event of a conversion error.

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.

impl Copy for StrictTransportSecurity

impl Eq for StrictTransportSecurity

impl StructuralPartialEq for StrictTransportSecurity