Skip to main content

AuthClient

Struct AuthClient 

Source
pub struct AuthClient { /* private fields */ }
Expand description

Verifies tokens issued by one auth instance, for one registered client.

Implementations§

Source§

impl AuthClient

Source

pub fn new( http: Arc<dyn HttpClient>, clock: Arc<dyn Clock>, issuer: impl Into<String>, client_id: impl Into<String>, ) -> Self

issuer is the auth service’s base URL, exactly as it appears in the iss claim. client_id is this app’s registered id, and is what every token’s aud must equal.

Source

pub async fn verify(&self, token: &str) -> Result<Claims, VerifyError>

Verifies a bearer token and returns its claims.

On an unknown key id the key set is refetched once — that is what makes rotation invisible to a running app — but no more often than crate::JWKS_MIN_REFETCH_SECS.

§Errors

VerifyError describing the first check that failed. Callers should log it and answer 401 without saying which.

Trait Implementations§

Source§

impl Auth for AuthClient

Source§

fn identify<'life0, 'life1, 'async_trait>( &'life0 self, headers: &'life1 HeaderMap, ) -> Pin<Box<dyn Future<Output = Result<Caller, AuthError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Identifies the caller from an Authorization: Bearer header.

No header is Caller::Anonymous. A header that is present and does not verify is AuthError::NotVerified — never anonymity, which would let an expired token read a public table and tell its holder nothing was wrong.

AuthError::Unavailable is never returned here, and that is a property of the verifier rather than an omission: a JWKS fetch that fails leaves the previously fetched keys in place, so an unreachable auth service does not invalidate a running app’s sessions. The one case it cannot cover is a cold start that has never fetched a key set, where every token is an unknown key and so a refusal.

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

Source§

type Output = T

Should always be Self
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