Skip to main content

OidcClient

Struct OidcClient 

Source
pub struct OidcClient<PS>{ /* private fields */ }
Expand description

Wraps the OIDC discovered client for login/callback flows.

The redirect URI is resolved dynamically per-request so that external_base_url = "auto" can produce the correct absolute callback URL based on the incoming request headers.

Implementations§

Source§

impl<PS> OidcClient<PS>

Source

pub async fn from_config( config: OidcClientConfig<PS::Config>, ) -> OidcResult<Self>

Source

pub async fn from_provider( provider: Arc<OAuthProviderRuntime>, config: OidcClientConfig<PS::Config>, ) -> OidcResult<Self>

Source

pub fn provider(&self) -> &Arc<OAuthProviderRuntime>

Source

pub async fn handle_code_authorize( &self, external_base_url: &Url, ) -> OidcResult<OidcCodeFlowAuthorizationRequest>

Source

pub async fn handle_code_authorize_with_redirect_override( &self, external_base_url: &Url, redirect_url_override: Option<&str>, ) -> OidcResult<OidcCodeFlowAuthorizationRequest>

Source

pub async fn handle_code_authorize_with_redirect_override_and_extra_data( &self, external_base_url: &Url, redirect_url_override: Option<&str>, extra_data: Option<Value>, ) -> OidcResult<OidcCodeFlowAuthorizationRequest>

Source

pub async fn handle_device_authorize( &self, ) -> OidcResult<OidcDeviceAuthorizationResult>

Source

pub async fn handle_device_token_poll( &self, device_authorization: &OidcDeviceAuthorizationResult, current_interval: Option<Duration>, ) -> OidcResult<OidcDeviceTokenPollResult>

Source

pub async fn handle_device_token_poll_until_complete( &self, device_authorization: &OidcDeviceAuthorizationResult, timeout: Option<Duration>, ) -> OidcResult<OidcDeviceTokenResult>

Source

pub async fn handle_code_callback( &self, search_params: OidcCodeCallbackSearchParams, external_base_url: &Url, ) -> OidcResult<OidcCodeCallbackResult>

Source

pub async fn handle_code_callback_with_redirect_override( &self, search_params: OidcCodeCallbackSearchParams, external_base_url: &Url, redirect_url_override: Option<&str>, ) -> OidcResult<OidcCodeCallbackResult>

Source

pub async fn handle_code_callback_with_redirect_override_diagnosed( &self, search_params: OidcCodeCallbackSearchParams, external_base_url: &Url, redirect_url_override: Option<&str>, ) -> DiagnosedResult<OidcCodeCallbackResult, OidcError>

Source

pub async fn handle_token_refresh( &self, refresh_token: String, id_token: Option<String>, ) -> OidcResult<OidcRefreshTokenResult>

Source

pub async fn handle_token_refresh_diagnosed( &self, refresh_token: String, id_token: Option<String>, ) -> DiagnosedResult<OidcRefreshTokenResult, OidcError>

Source

pub async fn handle_token_revoke( &self, token: OidcRevocableToken, ) -> OidcResult<()>

Source

pub async fn handle_user_info_exchange( &self, id_token_raw: &str, access_token: &str, ) -> OidcResult<UserInfoExchangeResult>

Shared user_info exchange helper for backend modes.

Given a raw id_token string and a bearer access_token, this method:

  1. Decodes and verifies the ID token (nonce validation is skipped, since this is a server-side post-flow call, not an in-flight callback).
  2. Optionally calls the provider’s userinfo endpoint (if available).
  3. Runs check_claims to produce a ClaimsCheckResult.

Backend OIDC presets (pure, mediated, etc.) should call this helper rather than reimplementing the user-info protocol stack.

Source

pub fn authorize_url( &self, external_base_url: &Url, ) -> OidcResult<OidcCodeFlowAuthorizationRequest>

Source

pub fn authorize_url_with_redirect_override( &self, external_base_url: &Url, redirect_url_override: Option<&str>, ) -> OidcResult<OidcCodeFlowAuthorizationRequest>

Source

pub async fn exchange_code( &self, external_base_url: &Url, code: &str, nonce: &Nonce, pkce_verifier_secret: Option<&str>, ) -> OidcResult<OidcCodeExchangeResult>

Source

pub async fn exchange_code_with_redirect_override( &self, external_base_url: &Url, code: &str, nonce: &Nonce, pkce_verifier_secret: Option<&str>, redirect_url_override: Option<&str>, ) -> OidcResult<OidcCodeExchangeResult>

Auto Trait Implementations§

§

impl<PS> Freeze for OidcClient<PS>
where PS: Freeze, <PS as PendingOauthStore>::Config: Freeze,

§

impl<PS> !RefUnwindSafe for OidcClient<PS>

§

impl<PS> Send for OidcClient<PS>

§

impl<PS> Sync for OidcClient<PS>

§

impl<PS> Unpin for OidcClient<PS>
where PS: Unpin, <PS as PendingOauthStore>::Config: Unpin,

§

impl<PS> UnsafeUnpin for OidcClient<PS>

§

impl<PS> !UnwindSafe for OidcClient<PS>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,