webgates-codecs 1.0.0

Framework-agnostic JWT codecs and validation helpers for webgates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Types describing the outcome of JWT validation.
//!
//! This module contains [`JwtValidationResult`], the high-level result returned
//! by JWT validation helpers after decoding and issuer checks.

use super::JwtClaims;

/// Result of validating a JWT token.
///
/// This type separates successful validation from the two expected failure
/// categories exposed by this crate:
/// - the token could not be decoded or validated
/// - the token decoded successfully but did not match the expected issuer
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum JwtValidationResult<T> {
    /// Token is valid and contains decoded claims.
    Valid(JwtClaims<T>),

    /// Token could not be decoded or failed JWT validation.
    ///
    /// This includes malformed tokens and tokens rejected by the configured JWT
    /// validation settings.
    InvalidToken,

    /// Token decoded successfully but has the wrong issuer.
    InvalidIssuer {
        /// Issuer expected by the validation service.
        expected: String,

        /// Issuer found in the decoded token.
        actual: String,
    },
}