Struct CsrfLayer 

pub struct CsrfLayer<T = DefaultResponseForProtectionError> { /* private fields */ }

Available on crate feature csrf only.

Layer that applies the Csrf middleware.

See the module docs for an example.

Implementations

impl CsrfLayer

pub fn new() -> Self

Creates a new CsrfLayer with no trusted origins, no bypass, and the default rejection response.

impl<T> CsrfLayer<T>

pub fn add_trusted_origin<S: AsRef<str>>( self, origin: S, ) -> Result<Self, ConfigError>

Adds a trusted origin that allows all requests whose Origin header matches the given value.

The value is matched byte-for-byte against the request’s Origin header — there is no normalization (this mirrors the Go reference). It must therefore be written exactly as a browser sends it:

• form scheme://host[:port], where scheme is http or https;
• the host lowercased (browsers lowercase it; IDN hosts must be given in punycode, e.g. xn--exmple-cua.com);
• default ports omitted — browsers drop :80/:443, so an explicit default port (e.g. https://example.com:443) will never match;
• no trailing slash, path, query, or fragment.

Inputs that can’t represent a browser Origin are rejected with a ConfigError; inputs that parse but aren’t in the canonical browser form above are accepted but will silently never match.

// Matches `Origin: https://example.com`:
let layer = CsrfLayer::new().add_trusted_origin("https://example.com")?;

// Accepted, but never matches a browser Origin (explicit default port):
let layer = CsrfLayer::new().add_trusted_origin("https://example.com:443")?;

pub fn with_insecure_bypass<F>(self, predicate: F) -> Self

where F: Fn(&Method, &Uri) -> bool + Send + Sync + 'static,

Adds a bypass predicate that returns true for requests which should skip CSRF protection.

This is an escape hatch for endpoints that legitimately need to accept cross-origin POSTs (e.g. webhook receivers). Bypassed endpoints must have their own protection (signed payloads, authentication tokens, etc.) — otherwise they are CSRF-vulnerable.

pub fn with_rejection_response<R>(self, rejection_response: R) -> CsrfLayer<R>

where R: Clone,

Replaces the response builder used when a request is rejected.

Accepts any type that implements ResponseForProtectionError, including a FnMut(ProtectionError) -> Response<B> + Clone closure. The default builder returns a 403 Forbidden with an empty body. Regardless of the builder, Csrf attaches the ProtectionError to the response’s extensions, so a custom builder need not re-attach it.

Trait Implementations

impl<T: Clone> Clone for CsrfLayer<T>

fn clone(&self) -> CsrfLayer<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CsrfLayer<T>

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

Formats the value using the given formatter.

impl Default for CsrfLayer

fn default() -> Self

Returns the “default value” for a type.

impl<S, T> Layer<S> for CsrfLayer<T>

where T: Clone,

type Service = Csrf<S, T>

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.