Skip to main content

ValidatorError

Enum ValidatorError 

Source
#[non_exhaustive]
pub enum ValidatorError {
#[non_exhaustive]
NoAudience { section: String, },
#[non_exhaustive]
NoAlgorithms { key: String, },
#[non_exhaustive]
LeewayTooLarge { key: String, leeway_secs: u64, max: u64, }, HttpClient(Box<dyn Error + Send + Sync + 'static>),
#[non_exhaustive]
FetchTimeoutOutOfRange { timeout: Duration, min: Duration, max: Duration, },
#[non_exhaustive]
InvalidRootCertificate { index: usize, reason: String, },
#[non_exhaustive]
InvalidProxy { proxy: String, reason: String, },
#[non_exhaustive]
InvalidInitialJwks { reason: String, }, }
Expand description

Why an OAuthValidator could not be built.

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

#[non_exhaustive]
NoAudience

Neither audience nor audiences holds a value. crate::OAuthConfig::resolve refuses this; only a hand-edited ResolvedOAuthConfig reaches it.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§section: String

The config block, named per its crate::KeyNaming.

§

#[non_exhaustive]
NoAlgorithms

The algorithm allowlist is empty. Refused by resolve as well.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§key: String

The algorithms setting, named per its crate::KeyNaming.

§

#[non_exhaustive]
LeewayTooLarge

leeway_secs is over crate::MAX_LEEWAY_SECS. Refused by resolve as well; re-checked because a larger leeway silently extends every token’s life (and past the current Unix time, overflows the expiry arithmetic).

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§key: String

The leeway_secs setting, named per its crate::KeyNaming.

§leeway_secs: u64

The configured value.

§

HttpClient(Box<dyn Error + Send + Sync + 'static>)

The HTTP client for metadata/JWKS fetches could not be built (in practice: the TLS backend failed to initialize).

The underlying error is boxed rather than named, so the HTTP client library’s version is not part of this crate’s public API; it is still reachable through std::error::Error::source.

§

#[non_exhaustive]
FetchTimeoutOutOfRange

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§timeout: Duration

The requested timeout.

§

#[non_exhaustive]
InvalidRootCertificate

A PEM passed to OAuthValidatorBuilder::add_root_certificate_pem holds no certificate, or one the TLS backend cannot parse or use as a trust anchor.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§index: usize

Which call it came from: 0 for the first add_root_certificate_pem, 1 for the second, and so on.

§reason: String

Why, for a log line. Certificates are public, so this may quote the TLS library’s error.

§

#[non_exhaustive]
InvalidProxy

The URL passed to OAuthValidatorBuilder::proxy is refused: malformed, or plain http on a non-loopback host with a credential in it and no allow_insecure_http.

§Security

A refused value is never echoed, not even redacted — a malformed URL can hide a credential where no parser sees userinfo. proxy is only the scheme (http://<redacted>) when it is a proxy scheme, and <redacted> otherwise; reason never quotes the URL. This error is safe to log whatever the proxy URL carries.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§proxy: String

<scheme>://<redacted>, or <redacted>: never the URL itself.

§reason: String

Why.

§

#[non_exhaustive]
InvalidInitialJwks

The JWK Set passed to OAuthValidatorBuilder::initial_jwks is too large, not JSON, not a JWK Set, or holds no key usable for a signature under the configured algorithms.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§reason: String

Why. Public keys only, so safe to log.

Trait Implementations§

Source§

impl Debug for ValidatorError

Source§

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

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

impl Display for ValidatorError

Source§

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

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

impl Error for ValidatorError

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<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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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