Enum axum_csrf_sync_pattern::RegenerateToken

pub enum RegenerateToken {
    PerSession,
    PerUse,
    PerRequest,
}

This enum is used with CsrfLayer::regenerate to determine at which occurences the CSRF token should be regenerated.

You could understand these options as modes to choose a level of paranoia, depending on your application’s requirements.

This paranoia level is a trade-off between ergonomics and security; as more frequent token invalidation requires more overhead for handling and renewing tokens on the client side, as well as retrying requests with a fresh token, should they fail.

Variants

PerSession

Generate one CSRF token per session and use this token until the session ends.

This is the default behavior and should work for most applications.

PerUse

Regenerate the CSRF token after each use. A “use” describes an unsafe HTTP method (POST, PUT, PATCH, DELETE).

CSRF tokens are not required for, and thus not invalidated by handling requests using safe HTTP methods (HEAD, GET, OPTIONS, TRACE, CONNECT).

PerRequest

Regenerate the CSRF token at each request, including safe HTTP methods (HEAD, GET, OPTIONS, TRACE, CONNECT).

This behavior might require elaborate token handling on the client side, as any concurrent requests mean race conditions from the client’s perspective, and each request’s response yields a new token to be used on the consecutive request.

Trait Implementations

impl Clone for RegenerateToken

fn clone(&self) -> RegenerateToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegenerateToken

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

Formats the value using the given formatter.

impl Default for RegenerateToken

fn default() -> RegenerateToken

Returns the “default value” for a type.

impl PartialEq<RegenerateToken> for RegenerateToken

fn eq(&self, other: &RegenerateToken) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RegenerateToken

impl Eq for RegenerateToken

impl StructuralEq for RegenerateToken

impl StructuralPartialEq for RegenerateToken