Struct JwtAuth

#[non_exhaustive]
pub struct JwtAuth<C, D> {
    pub force_passed: bool,
    pub decoder: D,
    pub finders: Vec<Box<dyn JwtTokenFinder>>,
    /* private fields */
}

JWT Authentication middleware for Salvo.

JwtAuth extracts and validates JWT tokens from incoming requests based on the configured token finders and decoder. If valid, it stores the decoded data in the depot for later use.

Type Parameters

• C - The claims type that will be deserialized from the JWT payload.
• D - The decoder implementation used to validate and decode the JWT token.

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.

force_passed: bool

When set to true, the middleware will allow the request to proceed even if authentication fails, storing only the authentication state in the depot.

When set to false (default), requests with invalid or missing tokens will be immediately rejected with appropriate status codes.

decoder: D

The decoder used to validate and decode the JWT token.

finders: Vec<Box<dyn JwtTokenFinder>>

A list of token finders that will be used to extract the token from the request. Finders are tried in order until one returns a token.

Implementations

impl<C, D> JwtAuth<C, D>

where C: DeserializeOwned + Send + Sync + 'static, D: JwtAuthDecoder + Send + Sync + 'static,

pub fn new(decoder: D) -> JwtAuth<C, D>

Create new JwtAuth.

pub fn force_passed(self, force_passed: bool) -> JwtAuth<C, D>

Sets force_passed value and return Self.

pub fn decoder_mut(&mut self) -> &mut D

Get decoder mutable reference.

pub fn finders_mut(&mut self) -> &mut Vec<Box<dyn JwtTokenFinder>>

Gets a mutable reference to the extractor list.

pub fn finders(self, finders: Vec<Box<dyn JwtTokenFinder>>) -> JwtAuth<C, D>

Sets extractor list with new value and return Self.

Trait Implementations

impl<C, D> Handler for JwtAuth<C, D>

where C: DeserializeOwned + Send + Sync + 'static, D: JwtAuthDecoder + Send + Sync + 'static,

fn handle<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, req: &'life1 mut Request, depot: &'life2 mut Depot, res: &'life3 mut Response, ctrl: &'life4 mut FlowCtrl, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, JwtAuth<C, D>: 'async_trait,

Handle http request.

fn arc(self) -> ArcHandler

where Self: Sized,

Wrap to ArcHandler.

fn hooped<H>(self) -> HoopedHandler

where H: Handler, Self: Sized,

Wrap to HoopedHandler.

fn hoop<H>(self, hoop: H) -> HoopedHandler

where H: Handler, Self: Sized,

Hoop this handler with middleware.

fn hoop_when<H, F>(self, hoop: H, filter: F) -> HoopedHandler

where Self: Sized, H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Hoop this handler with middleware.