Struct Csrf

pub struct Csrf<Inner>(/* private fields */);

This extractor wraps another extractor that returns some inner type that holds a CSRF token, and performs validation on the token. If the token is missing or invalid, then the extractor will return an error.

use actix_csrf::extractor::{Csrf, CsrfGuarded, CsrfToken};
use actix_web::{post, Responder};
use actix_web::web::Form;
use serde::Deserialize;

#[derive(Deserialize)]
struct Login {
   csrf: CsrfToken,
   email: String,
   password: String,
}

impl CsrfGuarded for Login {
    fn csrf_token(&self) -> &CsrfToken {
        &self.csrf
    }
}

#[post("/login")]
async fn login(form: Csrf<Form<Login>>) -> impl Responder {
   // If we got here, then the CSRF token passed validation!
   format!("hello, {}, your password is {}", &form.email, &form.password)
}

Implementations

impl<Inner> Csrf<Inner>

pub fn into_inner(self) -> Inner

Deconstruct to an inner value

Trait Implementations

impl<Inner: Debug> Debug for Csrf<Inner>

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

Formats the value using the given formatter.

impl<Inner> Deref for Csrf<Inner>

type Target = Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Inner> DerefMut for Csrf<Inner>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Inner> FromRequest for Csrf<Inner>

where Inner: FromRequest + CsrfGuarded,

type Error = CsrfExtractorError<<Inner as FromRequest>::Error>

The associated error which can be returned.

type Future = CsrfExtractorFuture<<Inner as FromRequest>::Future>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

impl<Inner: Hash> Hash for Csrf<Inner>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Inner: Ord> Ord for Csrf<Inner>

fn cmp(&self, other: &Csrf<Inner>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Inner: PartialEq> PartialEq for Csrf<Inner>

fn eq(&self, other: &Csrf<Inner>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Inner: PartialOrd> PartialOrd for Csrf<Inner>

fn partial_cmp(&self, other: &Csrf<Inner>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Inner: Eq> Eq for Csrf<Inner>

impl<Inner> StructuralPartialEq for Csrf<Inner>