Skip to main content

SecurityHeaders

Struct SecurityHeaders 

Source
pub struct SecurityHeaders { /* private fields */ }
Expand description

Which security headers to add, and with what values.

None for any field disables that header. Defaults:

HeaderDefault
X-Content-Type-Optionsnosniff
X-Frame-OptionsDENY
Referrer-Policyno-referrer
Strict-Transport-Securitymax-age=31536000, only when TLS is configured
Permissions-Policysensors and high-risk features locked off (see below)
Cross-Origin-Resource-Policysame-origin
Content-Security-Policyoff

There is no default Content-Security-Policy on purpose: a useful one is application-specific, and a generic one either breaks pages or is so permissive that it implies protection it does not give.

The default Permissions-Policy disables camera, microphone, geolocation, payment, USB, and interest-cohort (FLoC) access. JSON APIs never need those browser features, and an HTML app that does can override the header.

Cross-Origin-Resource-Policy: same-origin blocks no-cors cross-origin reads (Spectre-class resource loading). Cross-origin clients that use CORS still work; only opaque cross-origin embedding is refused.

Implementations§

Source§

impl SecurityHeaders

Source

pub fn new() -> Self

The default set. Equivalent to SecurityHeaders::default.

Source

pub fn content_type_options(self, v: Option<&str>) -> Self

Set or disable X-Content-Type-Options.

Source

pub fn frame_options(self, v: Option<&str>) -> Self

Set or disable X-Frame-Options.

Source

pub fn referrer_policy(self, v: Option<&str>) -> Self

Set or disable Referrer-Policy.

Source

pub fn hsts(self, v: Option<&str>) -> Self

Set or disable Strict-Transport-Security.

Only sent when the response is known to be going out over TLS. Announcing HSTS over plaintext tells a client nothing it can trust, and behind a terminating proxy it can pin a hostname to HTTPS the origin does not actually serve.

Two things establish that knowledge. Over TCP it is AppBuilder::tls: this process holding the certificate is what rules out a plaintext hop in front of it. Over HTTP/3 nothing needs to be configured, because QUIC has no plaintext mode — server_config_from_pem pins TLS 1.3 — so an h3 response is encrypted whether or not the builder was ever told about a certificate.

Source

pub fn content_security_policy(self, v: Option<&str>) -> Self

Set a Content-Security-Policy. Off by default.

Source

pub fn permissions_policy(self, v: Option<&str>) -> Self

Set or disable Permissions-Policy (formerly Feature-Policy).

Source

pub fn cross_origin_resource_policy(self, v: Option<&str>) -> Self

Set or disable Cross-Origin-Resource-Policy.

Default same-origin. Use cross-origin only when you deliberately serve assets for no-cors embedding from other sites.

Trait Implementations§

Source§

impl Clone for SecurityHeaders

Source§

fn clone(&self) -> SecurityHeaders

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SecurityHeaders

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SecurityHeaders

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more