Skip to main content

OidcProvider

Struct OidcProvider 

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

OpenID Connect Provider.

This extends the OAuth server with OIDC identity features.

Implementations§

Source§

impl OidcProvider

Source

pub fn new( oauth: Arc<OAuthServer>, config: OidcProviderConfig, ) -> Result<OidcProvider, OidcError>

Creates a new OIDC provider with the given OAuth server.

Source

pub fn with_defaults(oauth: Arc<OAuthServer>) -> Result<OidcProvider, OidcError>

Creates a new OIDC provider with default configuration.

Source

pub fn config(&self) -> &OidcProviderConfig

Returns the OIDC configuration.

Source

pub fn oauth(&self) -> &Arc<OAuthServer>

Returns a reference to the underlying OAuth server.

Source

pub fn set_hmac_key(&self, key: impl AsRef<[u8]>)

Sets the HMAC signing key.

Source

pub fn set_claims_provider<P>(&self, provider: P)
where P: ClaimsProvider + 'static,

Sets the claims provider.

Source

pub fn set_claims_fn<F>(&self, func: F)
where F: Fn(&str) -> Option<UserClaims> + Send + Sync + 'static,

Sets a function-based claims provider.

Source

pub fn discovery_document( &self, base_url: impl Into<String>, ) -> DiscoveryDocument

Generates the discovery document.

Source

pub fn jwks(&self) -> Option<Value>

Returns the configured JSON Web Key Set (JWKS), if any.

For HS256 this is typically None. For RS256 it is required and should be served at /.well-known/jwks.json alongside the discovery document.

Source

pub fn issue_id_token( &self, access_token: &OAuthToken, nonce: Option<&str>, ) -> Result<IdToken, OidcError>

Issues an ID token for the given access token.

This should be called after a successful token exchange when the openid scope was requested.

Source

pub fn get_id_token(&self, access_token: &str) -> Option<IdToken>

Gets the ID token associated with an access token.

Source

pub fn userinfo(&self, access_token: &str) -> Result<UserClaims, OidcError>

Handles a userinfo request.

Returns the user’s claims filtered by the access token’s scopes.

Source

pub fn cleanup_expired(&self)

Removes expired ID tokens from cache.

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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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 = 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<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