Struct headers::common::strict_transport_security::StrictTransportSecurity

pub struct StrictTransportSecurity {
    include_subdomains: bool,
    max_age: Seconds,
}

StrictTransportSecurity header, defined in 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

     [ 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

use std::time::Duration;
use headers::StrictTransportSecurity;

let sts = StrictTransportSecurity::including_subdomains(Duration::from_secs(31_536_000));

Fields

include_subdomains: bool

Signals the UA that the HSTS Policy applies to this HSTS Host as well as any subdomains of the host’s domain name.

max_age: Seconds

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.

Implementations

impl StrictTransportSecurity

pub fn including_subdomains(max_age: Duration) -> StrictTransportSecurity

Create an STS header that includes subdomains

pub fn excluding_subdomains(max_age: Duration) -> StrictTransportSecurity

Create an STS header that excludes subdomains

pub fn include_subdomains(&self) -> bool

Get whether this should include subdomains.

pub fn max_age(&self) -> Duration

Get the max-age.

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

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I: Iterator<Item = &'i HeaderValue>>( values: &mut I, ) -> Result<Self, Error>

Decode this type from an iterator of HeaderValues.

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap.

impl PartialEq for StrictTransportSecurity

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StrictTransportSecurity