Struct actix_csrf::CsrfMiddleware

source · [−]

pub struct CsrfMiddleware<Rng> { /* private fields */ }

Expand description

CSRF middleware to manage CSRF cookies and tokens.

Implementations

impl<Rng: TokenRng + SeedableRng> CsrfMiddleware<Rng>

pub fn new() -> Self

Creates a CSRF middleware with secure defaults. Namely:

The CSRF cookie will be prefixed with __Host-
SameSite is set to Strict.
Secure is set.
HttpOnly is set.
Path is set to /.

This represents the strictest possible configuration. Requests must be always sent over HTTPS. Users must explicitly relax these restrictions.

impl<Rng: TokenRng> CsrfMiddleware<Rng>

pub fn with_rng(rng: Rng) -> Self

Creates a CSRF middleware with secure defaults and the provided Rng. Namely:

The CSRF cookie will be prefixed with __Host-
SameSite is set to Strict.
Secure is set.
HttpOnly is set.
Path is set to /.

This represents the strictest possible configuration. Requests must be always sent over HTTPS. Users must explicitly relax these restrictions.

impl<Rng> CsrfMiddleware<Rng>

pub const fn enabled(self, enabled: bool) -> Self

Control whether we check for the token on requests.

pub fn set_cookie<T: Into<String>>(self, method: Method, uri: T) -> Self

Set a method and path to set a CSRF cookie. This should be all locations that whose response should set a cookie (via a Set-Cookie header) or those that need the CSRF token value in the response, such as for forms.

pub fn cookie_name<T: Into<String>>(self, name: T) -> Self

Sets the cookie name. Consider prefixing the cookie name with __Host- or __Secure- as an additional defense-in-depth measure against CSRF attacks.

pub const fn same_site(self, same_site: Option<SameSite>) -> Self

Sets the SameSite attribute on the cookie.

pub const fn http_only(self, enabled: bool) -> Self

Sets the HttpOnly attribute on the cookie.

pub const fn secure(self, enabled: bool) -> Self

Sets the Secure attribute on the cookie.

Trait Implementations

impl<Rng: Clone> Clone for CsrfMiddleware<Rng>

fn clone(&self) -> CsrfMiddleware<Rng>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<Rng: Debug> Debug for CsrfMiddleware<Rng>

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

Formats the value using the given formatter. Read more

impl<Rng: TokenRng + SeedableRng> Default for CsrfMiddleware<Rng>

fn default() -> Self

Returns the “default value” for a type. Read more

impl<Rng: PartialEq> PartialEq<CsrfMiddleware<Rng>> for CsrfMiddleware<Rng>

fn eq(&self, other: &CsrfMiddleware<Rng>) -> bool

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

fn ne(&self, other: &CsrfMiddleware<Rng>) -> bool

This method tests for !=.

impl<S, Rng> Transform<S, ServiceRequest> for CsrfMiddleware<Rng> where
S: Service<ServiceRequest, Response = ServiceResponse>,
Rng: TokenRng + Clone,

type Response = ServiceResponse

Responses produced by the service.

type Error = S::Error

Errors produced by the service.

type InitError = ()

Errors produced while building a transform service.

type Transform = CsrfMiddlewareImpl<S, Rng>

The TransformService value created by this factory

type Future = Ready<Result<Self::Transform, Self::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

impl<Rng: Eq> Eq for CsrfMiddleware<Rng>

impl<Rng> StructuralEq for CsrfMiddleware<Rng>

impl<Rng> StructuralPartialEq for CsrfMiddleware<Rng>

Auto Trait Implementations

impl<Rng> !RefUnwindSafe for CsrfMiddleware<Rng>

impl<Rng> !Send for CsrfMiddleware<Rng>

impl<Rng> !Sync for CsrfMiddleware<Rng>

impl<Rng> Unpin for CsrfMiddleware<Rng> where
Rng: Unpin,

impl<Rng> UnwindSafe for CsrfMiddleware<Rng> where
Rng: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more