pub struct OIDCClient {
pub client: OpenIDClient,
/* private fields */
}Expand description
A high-level OpenID Connect (OIDC) client abstraction for performing common flows:
- Discovering provider metadata
- Exchanging authorization codes for tokens
- Fetching user information
- Performing token exchange
Internally, OIDCClient combines:
- An OpenID Connect client (
OpenIDClient) - A reqwest HTTP client (
reqwest::Client) - Local configuration (
WorkingConfig)
This design allows dynamic discovery from OIDC configuration, while keeping a ready-to-use validator for verifying ID tokens or access tokens.
Fields§
§client: OpenIDClientImplementations§
Source§impl OIDCClient
impl OIDCClient
Sourcepub async fn from_oidc_config(
config: &OIDCConfig,
) -> Result<(Self, Validator), Box<dyn Error>>
pub async fn from_oidc_config( config: &OIDCConfig, ) -> Result<(Self, Validator), Box<dyn Error>>
Creates a new OIDCClient by dynamically discovering the provider metadata
and preparing a Validator to verify tokens.
This method:
- Builds a safe reqwest HTTP client (with redirect following disabled).
- Discovers the OpenID provider metadata from the issuer URL.
- Constructs default validation rules (audience, issuer, leeway).
- Loads the JWKS keys into a
Validator. - Initializes the OpenID Connect client with the discovered metadata.
§Arguments
config- High-level OIDC configuration.
§Returns
A tuple of:
OIDCClient(for performing login and userinfo flows)Validator(for verifying ID tokens or access tokens)
§Errors
Returns an error if discovery fails, the JWKS endpoint cannot be fetched, or if the HTTP client cannot be built.
Sourcepub async fn user_info(
&self,
access_token: AccessToken,
subject: Option<SubjectIdentifier>,
) -> Result<UserInfoClaims<AddClaims, PronounClaim>, UserInfoError<HttpClientError<Error>>>
pub async fn user_info( &self, access_token: AccessToken, subject: Option<SubjectIdentifier>, ) -> Result<UserInfoClaims<AddClaims, PronounClaim>, UserInfoError<HttpClientError<Error>>>
Fetches user information from the provider’s UserInfo endpoint.
§Arguments
access_token- The access token obtained after login.subject- Optionally, the subject (user ID) to query.
§Returns
The claims returned by the UserInfo endpoint.
§Errors
Returns an error if the request fails or the response is invalid.
Sourcepub async fn exchange_code(
&self,
code: AuthorizationCode,
) -> Result<CoreTokenResponse, Error>
pub async fn exchange_code( &self, code: AuthorizationCode, ) -> Result<CoreTokenResponse, Error>
Sourcepub async fn exchange_token_for_audience(
&self,
subject_token: &str,
audience: &str,
) -> Result<TokenExchangeResponse, Error>
pub async fn exchange_token_for_audience( &self, subject_token: &str, audience: &str, ) -> Result<TokenExchangeResponse, Error>
Performs OAuth2 token exchange to obtain a token scoped for a different audience.
§Arguments
subject_token- The current access token or ID token.audience- The target audience for the exchanged token.
§Returns
The token exchange response, containing the new token.
§Errors
Returns a reqwest error if the request fails.
§Note
I haven’t tested this in a full flow.
Sourcepub async fn from_oidc_config_with_validation(
config: &OIDCConfig,
custom_validation: Validation,
) -> Result<(Self, Validator), Box<dyn Error>>
pub async fn from_oidc_config_with_validation( config: &OIDCConfig, custom_validation: Validation, ) -> Result<(Self, Validator), Box<dyn Error>>
Like from_oidc_config, but allows the caller to provide a custom Validation template.
This can be used to:
- Disable signature verification for testing.
- Adjust expiration leeway, audience, issuer, etc.
- Support different algorithms.
Trait Implementations§
Source§impl Clone for OIDCClient
impl Clone for OIDCClient
Source§fn clone(&self) -> OIDCClient
fn clone(&self) -> OIDCClient
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for OIDCClient
impl !RefUnwindSafe for OIDCClient
impl Send for OIDCClient
impl Sync for OIDCClient
impl Unpin for OIDCClient
impl !UnwindSafe for OIDCClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);