Struct SecurityHeaders 

pub struct SecurityHeaders { /* private fields */ }

A bundle of security headers applied as a single Tower Layer.

Use SecurityHeaders::recommended for a sensible default set, or build a custom set with SecurityHeaders::new and add.

Call use_dev_headers(true) in development to skip all headers (e.g. HSTS) that interfere with localhost workflows.

Example

use axum::Router;
use axum_security::headers::{SecurityHeaders, XssProtection};

let headers = SecurityHeaders::recommended()
    .add(XssProtection::ZERO);

let app = Router::<()>::new().layer(headers);

Implementations

impl SecurityHeaders

pub fn new() -> Self

Create an empty SecurityHeaders set.

pub fn recommended() -> Self

Create a SecurityHeaders set with sensible defaults.

Includes: Cross-Origin-Opener-Policy: same-origin, Cross-Origin-Resource-Policy: same-origin, Origin-Agent-Cluster: ?1, Referrer-Policy: no-referrer, Strict-Transport-Security: max-age=31536000; includeSubDomains, X-Content-Type-Options: nosniff, X-Frame-Options: SAMEORIGIN, X-XSS-Protection: 0.

pub fn use_dev_headers(self, dev_headers: bool) -> Self

When true, clears all headers so nothing is added to responses.

Use this in development to avoid HSTS and other headers that interfere with localhost or plain HTTP.

pub fn add(self, header: impl IntoSecurityHeader) -> Self

Add a header, replacing any existing header with the same name.

pub fn try_add(self, header: impl IntoSecurityHeader) -> Self

Add a header only if no header with that name exists yet.

Trait Implementations

impl Clone for SecurityHeaders

fn clone(&self) -> SecurityHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SecurityHeaders

fn default() -> Self

Returns the “default value” for a type.

impl<S> Layer<S> for SecurityHeaders

type Service = SecurityHeadersLayer<S>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.