Skip to main content

VerifyError

Enum VerifyError 

Source
#[non_exhaustive]
pub enum VerifyError {
Show 14 variants MalformedToken, AlgorithmNotAllowed, UnknownKey, InvalidKey, SignatureInvalid, IssuerMismatch, AudienceMismatch, AuthorizedPartyMismatch, AuthorizedPartyMissing, Expired, ImmatureToken, NonceMismatch, JwksUnavailable, InvalidToken,
}
Expand description

Re-exported from axum_security_oidc: the standard ID-token claim set and the ID-token verification error (OidcContext::warm_jwks returns it). A failure while verifying an ID token.

Every variant is a rejection reason — the token is not trusted. The distinctions exist for diagnostics/logging; a caller should treat all of them as “authentication failed”.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

MalformedToken

The JWT could not be parsed (bad header, wrong number of segments, non-base64url payload).

§

AlgorithmNotAllowed

The token’s alg header is not in the verifier’s allow-list. Guards against algorithm-confusion / key-substitution attacks.

§

UnknownKey

No key in the JWKS matches the token’s kid (or the token carried no kid and the JWKS does not hold exactly one key).

§

InvalidKey

The matched JWK could not be turned into a verification key.

§

SignatureInvalid

The signature did not verify against the selected key.

§

IssuerMismatch

The iss claim did not match the expected issuer.

§

AudienceMismatch

The aud claim did not contain the expected audience (the client id).

§

AuthorizedPartyMismatch

The azp (authorized party) claim was present but did not equal the expected audience (the client id). Per OpenID Connect Core §3.1.3.7, a token minted for a different authorized party must not be accepted even if it lists this client in aud.

§

AuthorizedPartyMissing

The token named more than one audience but carried no azp claim. Per OpenID Connect Core §3.1.3.7 a multi-audience token must identify its authorized party, so it cannot be attributed to this client.

§

Expired

The exp claim is in the past (outside the configured leeway).

§

ImmatureToken

The nbf claim is in the future (outside the configured leeway).

§

NonceMismatch

The nonce claim did not match the expected value — replay protection.

§

JwksUnavailable

The signing keys could not be fetched from the provider’s jwks_uri (network error, non-2xx status, or unparsable JWK set), so the token could not be checked.

§

InvalidToken

A standard-claim check failed for a reason not covered above.

Trait Implementations§

Source§

impl Debug for VerifyError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for VerifyError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for VerifyError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more