Struct CsrfLayer 

pub struct CsrfLayer { /* private fields */ }

Available on crate feature csrf only.

CSRF protection middleware.

Add to any application with .wrap(CsrfLayer::new()). Safe HTTP methods (GET, HEAD, OPTIONS, TRACE) always pass through; mutating methods are validated and rejected with 403 Forbidden on mismatch.

Defaults

Setting	Default
Cookie name	_csrf
Form field name	_csrf
Validated header	X-CSRF-Token
SameSite	Strict
HttpOnly	false (JS-readable for AJAX workflows)
Secure	false (enable in production behind HTTPS)

Implementations

impl CsrfLayer

pub fn new() -> CsrfLayer

Create a CsrfLayer with default settings.

pub fn cookie_name(self, name: &str) -> CsrfLayer

Override the cookie name (default: "_csrf").

pub fn field_name(self, name: &str) -> CsrfLayer

Override the form field name (default: "_csrf").

pub fn header_name(self, name: &str) -> CsrfLayer

Override the request header name that carries the token for AJAX (default: "X-CSRF-Token").

pub fn http_only(self, http_only: bool) -> CsrfLayer

Set the HttpOnly flag on the CSRF cookie (default: false).

Enable this if you only serve traditional HTML forms and never need JavaScript to read the token. When true, AJAX clients cannot access the token via document.cookie and must rely on a server-rendered token in the HTML.

pub fn secure(self, secure: bool) -> CsrfLayer

Set the Secure flag on the CSRF cookie (default: false).

Enable in production to prevent the cookie from being sent over plain HTTP.

Trait Implementations

impl Default for CsrfLayer

fn default() -> CsrfLayer

Returns the “default value” for a type.

impl Middleware for CsrfLayer

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer never reads request.body, so the inner application may receive it as a stream (Application::streams_body). A layer that inspects the body (CSRF tokens in a form, request signatures, rewriting) must keep the default false: it would see an empty body.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

fn layer_name(&self) -> &'static str

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.