Struct JwtCsrf 

#[non_exhaustive]
pub struct JwtCsrf<C = Claims> {
    pub token: Jwt<C>,
    pub csrf_status: CsrfStatus,
}

Similar to Jwt, but allows extracting the JWT from the request cookies (if the auth.jwt.cookie-name config is set) in addition to the request header.

This is useful for use in web-apps because the JWT can be set as a cookie and be automatically sent along with every request instead of needing to add the header to every request (which would preclude the web-app from supporting clients without javascript enabled). However, THIS MAY MAKE THE CONSUMING APPLICATION VULNERABLE TO CSRF ATTACKS. If this struct is used, the consuming application should implement a CSRF protection mechanism. See the following for more information and recommendations:

• https://owasp.org/www-community/attacks/csrf
• https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html

If the functionality to extract from a cookie is not required, it’s recommended to use the normal Jwt directly.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

token: Jwt<C>

csrf_status: CsrfStatus

Implementations

impl<C> JwtCsrf<C>

pub fn builder() -> JwtCsrfBuilder<C>

Create an instance of JwtCsrf using the builder syntax

Trait Implementations

impl<'de, C> Deserialize<'de> for JwtCsrf<C>

where C: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S, C> FromRequestParts<S> for JwtCsrf<C>

where S: Clone + Send + Sync + 'static, AppContext: FromRef<S>, C: for<'de> Deserialize<'de>,

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

impl<C> OperationInput for JwtCsrf<C>

fn operation_input(ctx: &mut GenContext, operation: &mut Operation)

Modify the operation.

fn inferred_early_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred early responses are used to document early returns for extractors, guards inside handlers. For example these could represent JSON parsing errors, authentication failures.

impl<C> OperationOutput for JwtCsrf<C>

type Inner = JwtCsrf<C>

The type that is used in examples.

fn operation_response( ctx: &mut GenContext, operation: &mut Operation, ) -> Option<Response>

Return a response documentation for this type, alternatively modify the operation if required.

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred responses are used when the type is used as a request handler return type.

impl<C> Serialize for JwtCsrf<C>

where C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.