Struct CsrfLayer 

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

Available on crate feature http only.

Layer that applies the Csrf middleware.

See the module docs for an example.

Implementations

impl CsrfLayer

pub fn new() -> CsrfLayer

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>( self, origin: S, ) -> Result<CsrfLayer<T>, ConfigError>

where S: AsRef<str>,

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

The value is compared structurally (via rama_net::uri::Uri) against the request’s Origin: the host is matched case-insensitively and a default port compares equal whether written explicitly or omitted. The input must be a bare origin of the form scheme://host[:port] with an http/https scheme and no userinfo, path, query, or fragment; anything else is rejected with a ConfigError.

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

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 Fn(ProtectionError) -> Response<B> + Clone + Send + Sync + 'static 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 for CsrfLayer<T>

where T: Clone,

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<(), Error>

Formats the value using the given formatter.

impl Default for CsrfLayer

fn default() -> CsrfLayer

Returns the “default value” for a type.

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

where T: Clone,

type Service = Csrf<S, T>

The service produced by the layer.

fn layer(&self, inner: S) -> <CsrfLayer<T> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> <CsrfLayer<T> as Layer<S>>::Service

Same as layer but consuming self after the service was created.