Enum JWTError 

pub enum JWTError {
    InvalidFormat,
    InvalidHeader,
    UnsupportedAlgorithm {
        algorithm: String,
        key_type: String,
    },
    InvalidClaims,
    InvalidSignature,
    SystemTimeError,
    TokenExpired,
    TokenNotValidYet,
    SignatureVerificationFailed,
    InvalidPayload,
    InvalidPayloadJson,
    MissingClaim {
        claim: String,
    },
    InvalidTokenType {
        expected: String,
        actual: String,
    },
    HttpMethodMismatch {
        expected: String,
        actual: String,
    },
    HttpUriMismatch {
        expected: String,
        actual: String,
    },
    AccessTokenHashMismatch,
    InvalidNonce {
        nonce: String,
    },
    InvalidTimestamp {
        reason: String,
    },
}

Error types that can occur when working with JSON Web Tokens

Variants

InvalidFormat

Occurs when JWT does not have the expected 3-part format (header.payload.signature)

InvalidHeader

Occurs when JWT header cannot be base64 decoded or parsed as JSON

UnsupportedAlgorithm

Occurs when JWT algorithm does not match the provided key type

Fields

algorithm: String

The algorithm specified in the JWT header

key_type: String

The type of key provided for verification

InvalidClaims

Occurs when JWT claims cannot be base64 decoded or parsed as JSON

InvalidSignature

Occurs when JWT signature cannot be base64 decoded

SystemTimeError

Occurs when system time cannot be obtained for timestamp validation

TokenExpired

Occurs when JWT has passed its expiration time

TokenNotValidYet

Occurs when JWT is used before its not-before time

SignatureVerificationFailed

Occurs when signature verification fails

InvalidPayload

Occurs when JWT payload cannot be base64 decoded

InvalidPayloadJson

Occurs when JWT payload cannot be parsed as JSON

MissingClaim

Occurs when a required JWT claim is missing

Fields

claim: String

The name of the missing claim

InvalidTokenType

Occurs when JWT type field has wrong value

Fields

expected: String

The expected token type

actual: String

The actual token type found

HttpMethodMismatch

Occurs when HTTP method in JWT doesn’t match expected value

Fields

expected: String

The expected HTTP method

actual: String

The actual HTTP method in the JWT

HttpUriMismatch

Occurs when HTTP URI in JWT doesn’t match expected value

Fields

expected: String

The expected HTTP URI

actual: String

The actual HTTP URI in the JWT

AccessTokenHashMismatch

Occurs when access token hash validation fails

InvalidNonce

Occurs when nonce value is not in the expected values list

Fields

nonce: String

The nonce value that was not found in expected values

InvalidTimestamp

Occurs when JWT has invalid timestamp claim

Fields

reason: String

The reason for the timestamp validation failure

Trait Implementations

impl Debug for JWTError

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

Formats the value using the given formatter.

impl Display for JWTError

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

Formats the value using the given formatter.

impl Error for JWTError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.