Skip to main content

AssertionFailure

Enum AssertionFailure 

Source
#[non_exhaustive]
pub enum AssertionFailure { Malformed, AlgorithmMismatch, BadSignature, WrongPrincipal, WrongAudience, Expired, NotYetValid, MissingJti, Replayed, ReplayCheckUnavailable, }
Available on crate feature client-assertion only.
Expand description

Why an assertion was refused.

Every one of these becomes the same invalid_client on the wire (RFC 6749 section 5.2), for the same reason authenticate_client collapses “unknown client” and “wrong secret”: telling a caller WHICH check it failed is telling an attacker how to get closer. The distinction exists for the host’s audit channel, where the reader is not the attacker.

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.
§

Malformed

Not a compact JWS, or longer than MAX_ASSERTION_BYTES and so refused on size before anything is decoded, or its typ says it is some other kind of JWT.

§

AlgorithmMismatch

The header’s alg is not the one this registration signs with.

§

BadSignature

The signature did not verify under any registered key.

§

WrongPrincipal

iss or sub is absent, or is not the client this request claims to be.

§

WrongAudience

aud names neither this server’s token endpoint nor its issuer.

§

Expired

exp is absent, has passed, or is further out than this server will track a jti for.

§

NotYetValid

nbf or iat is in the future by more than CLOCK_SKEW_LEEWAY.

§

MissingJti

jti is absent or empty, so single use cannot be enforced.

§

Replayed

This jti has been seen before within the assertion’s own validity window.

§

ReplayCheckUnavailable

The single-use claim could not be RECORDED, so this assertion was refused without ever being judged: the storage seam behind crate::store::Storage::claim_replay_id failed.

The wire answer is the same invalid_client every other variant collapses to, and the refusal is deliberate — a claim that could not be recorded is a claim that did not happen, and treating a storage outage as “probably fine” would make every assertion replayable for the duration of it. What this variant exists for is the AUDIT channel: through 0.9.0 the outage was reported as AssertionFailure::Replayed, which crate::events::ClientAuthFailure::AssertionInvalid documents as “somebody who has captured a client’s traffic, which is a different incident and a much worse one”. An outage fails every private_key_jwt client at once, so that mislabel turned a store alarm into a burst of this crate’s worst-incident signal.

Trait Implementations§

Source§

impl Clone for AssertionFailure

Source§

fn clone(&self) -> AssertionFailure

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for AssertionFailure

Source§

impl Debug for AssertionFailure

Source§

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

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

impl Display for AssertionFailure

Source§

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

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

impl Eq for AssertionFailure

Source§

impl Error for AssertionFailure

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
Source§

impl Hash for AssertionFailure

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for AssertionFailure

Source§

fn eq(&self, other: &AssertionFailure) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AssertionFailure

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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, 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.