Skip to main content

OidcClient

Struct OidcClient 

Source
pub struct OidcClient<H = ReqwestOidcHttpClient> { /* private fields */ }
Expand description

Stateful OIDC client with discovery and JWKS caching.

Implementations§

Source§

impl OidcClient<ReqwestOidcHttpClient>

Source

pub fn new(config: OidcConfig) -> Result<Self, OidcError>

Create an OIDC client using the default HTTP client.

§Errors

Returns an error when the configuration is invalid or the default HTTP client cannot be constructed.

Source§

impl<H> OidcClient<H>
where H: OidcHttpClient,

Source

pub fn with_http_client( config: OidcConfig, http_client: H, ) -> Result<Self, OidcError>

Create an OIDC client with a caller-supplied HTTP implementation.

§Errors

Returns an error when the configuration is invalid.

Source

pub async fn discover(&self) -> Result<OidcProviderMetadata, OidcError>

Fetch and cache the provider discovery document.

§Errors

Returns an error when discovery fails or the document is invalid.

Source

pub async fn build_authorization_request( &self, scopes: &[&str], ) -> Result<OidcAuthorizationRequest, OidcError>

Build a secure authorization request using exact-match redirect URI, state, nonce, and PKCE.

§Errors

Returns an error when discovery fails.

Source

pub async fn build_token_exchange_request( &self, pending: &OidcAuthorizationRequest, code: &str, returned_state: &str, code_verifier: Option<&str>, ) -> Result<OidcTokenExchangeRequest, OidcError>

Build token-exchange parameters while enforcing state and PKCE rules.

§Errors

Returns an error when the callback state or PKCE data is invalid.

Source

pub async fn validate_id_token( &self, id_token: &str, expected_nonce: Option<&str>, ) -> Result<OidcClaims, OidcError>

Validate an ID token using discovery metadata, cached JWKS, and the configured nonce.

§Errors

Returns an error when the token is invalid or the provider cannot be reached.

Source

pub async fn fetch_userinfo( &self, access_token: &str, ) -> Result<OidcUserInfo, OidcError>

Fetch the provider’s userinfo document using the bearer access token.

§Errors

Returns an error when the provider does not expose userinfo or the request fails.

Trait Implementations§

Source§

impl<H: Debug> Debug for OidcClient<H>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<H = ReqwestOidcHttpClient> !RefUnwindSafe for OidcClient<H>

§

impl<H = ReqwestOidcHttpClient> !UnwindSafe for OidcClient<H>

§

impl<H> Freeze for OidcClient<H>
where H: Freeze,

§

impl<H> Send for OidcClient<H>
where H: Send,

§

impl<H> Sync for OidcClient<H>
where H: Sync,

§

impl<H> Unpin for OidcClient<H>
where H: Unpin,

§

impl<H> UnsafeUnpin for OidcClient<H>
where H: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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