Struct CsrfConfig 

pub struct CsrfConfig { /* private fields */ }

Configuration for the CSRF protection middleware.

Build with CsrfConfig::new() and chain methods to customize the cookie name, header name, token length, rejection status, cookie path, or Secure flag. Then pass to CsrfLayer::new().

Examples

use http::StatusCode;
use rune_axum_csrf::CsrfConfig;

let config = CsrfConfig::new()
    .cookie_name("my_csrf")
    .token_bytes(64)
    .status(StatusCode::FORBIDDEN);

Implementations

impl CsrfConfig

pub fn new() -> CsrfConfig

Creates a CsrfConfig with defaults: 32-byte token, csrf_token cookie, x-csrf-token header, 403 Forbidden rejection, Path=/.

pub fn cookie_name(self, name: impl Into<String>) -> CsrfConfig

Sets the cookie name used to store the CSRF token.

Defaults to csrf_token.

pub fn header_name(self, name: HeaderName) -> CsrfConfig

Sets the request header name the client must use to echo the token.

Defaults to x-csrf-token.

pub fn token_bytes(self, bytes: usize) -> CsrfConfig

Sets the number of random bytes used to generate the token.

The token is hex-encoded, so the resulting string is twice as long. Defaults to 32 (a 64-character hex string).

pub fn status(self, status: StatusCode) -> CsrfConfig

Sets the HTTP status code returned when CSRF validation fails.

Defaults to 403 Forbidden.

pub fn cookie_path(self, path: impl Into<String>) -> CsrfConfig

Sets the Path attribute on the CSRF cookie.

Defaults to /.

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

Adds the Secure attribute to the CSRF cookie, restricting it to HTTPS connections.

Defaults to false. Set to true in production when serving exclusively over HTTPS.

Trait Implementations

impl Clone for CsrfConfig

fn clone(&self) -> CsrfConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsrfConfig

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

Formats the value using the given formatter.

impl Default for CsrfConfig

fn default() -> CsrfConfig

Returns the “default value” for a type.