Skip to main content

OpenIDClient

Struct OpenIDClient 

Source
pub struct OpenIDClient {
    pub config: OpenIDConfig,
    pub jwks: Option<JwkSet>,
    pub opts: OpenIDClientOpts,
}
Expand description

OpenID client

Fields§

§config: OpenIDConfig§jwks: Option<JwkSet>§opts: OpenIDClientOpts

Implementations§

Source§

impl OpenIDClient

Source

pub async fn new( config: OpenIDConfig, jwks: Option<JwkSet>, opts: &OpenIDClientOpts, ) -> Self

Construct an OpenID client by give hard-coded configuration values

Source

pub async fn new_from_url( url: &str, opts: &OpenIDClientOpts, ) -> Result<Self, OpenIdError>

Construct an OpenID client by loading configuration from a given .well-known/openid-configuration URL

Source

pub fn gen_authorization_url( &self, state: &str, code_challenge: Option<CodeChallenge>, nonce: Option<&Nonce>, ) -> String

Get the authorization URL where a user should be redirect to perform authentication

Source

pub async fn request_token_from_code( &self, code: &str, code_verifier: Option<&CodeChallengeVerifier>, nonce: Option<&Nonce>, ) -> Result<(OpenIDTokenResponse, String), OpenIdError>

Query the token endpoint using an authorization code

Source

pub async fn request_token_from_refresh_token( &self, refresh_token: &str, ) -> Result<(OpenIDTokenResponse, String), OpenIdError>

Query the token endpoint using a refresh token

Source

pub fn verify_jwt<T: DeserializeOwned>( &self, jwt: &str, ) -> Result<TokenData<T>, OpenIdError>

Decode & verify a JWT signature

Source

pub async fn request_user_info( &self, token: &OpenIDTokenResponse, ) -> Result<(OpenIDUserInfo, String), OpenIdError>

Query the UserInfo endpoint.

This endpoint should be used after having successfully retrieved the token

This endpoint returns both the parsed value and the raw response, in case of presence of additional fields

Trait Implementations§

Source§

impl Clone for OpenIDClient

Source§

fn clone(&self) -> OpenIDClient

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

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<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> 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> 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> 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<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