Skip to main content

TokenProvider

Struct TokenProvider 

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

Fetches and caches an OAuth2 bearer token via the client-credentials grant, refreshing it shortly before expiry. Cloning shares the cache.

Implementations§

Source§

impl TokenProvider

Source

pub fn new(config: OidcConfig) -> Self

Create a provider for the given OIDC configuration.

Token fetches are bounded by a per-request timeout (see Self::token), so a hung token endpoint can never block callers indefinitely (the fetch holds the cache lock while in flight).

Source

pub async fn invalidate(&self)

Drop the cached token so the next Self::token call fetches a fresh one. Call this after a server rejects a token as expired/invalid so the client can self-heal instead of replaying the stale token.

Source

pub async fn token(&self) -> Result<String>

Return a valid bearer token, fetching or refreshing if the cached one is absent or within the refresh-skew window of expiry.

Concurrent callers that arrive during a refresh serialize behind a single in-flight fetch (single-flight de-duplication), bounded by the HTTP client’s timeout — a slow IdP therefore stalls concurrent token consumers for at most that timeout rather than triggering a fetch storm.

§Errors

Returns Error::Auth if the endpoint rejects the credentials (401/403, e.g. invalid_client); Error::Http for other non-success statuses (5xx/429 stay retriable); Error::Connection if the endpoint is unreachable or the fetch times out; Error::Json if the response cannot be parsed.

Trait Implementations§

Source§

impl Clone for TokenProvider

Source§

fn clone(&self) -> TokenProvider

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 Debug for TokenProvider

Source§

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

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

impl TokenSource for TokenProvider

Lets a TokenProvider back the SDK’s shared canton_core::Auth without canton-core depending on this crate: Config::with_oidc(provider) stores it as an Arc<dyn TokenSource>.

Source§

fn fetch_bearer( &self, ) -> Pin<Box<dyn Future<Output = Result<Option<String>>> + Send + '_>>

Resolve the current bearer token (fetching/refreshing as needed), or None for an unauthenticated call.

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> 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, 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, <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