Skip to main content

OAuth2Flow

Struct OAuth2Flow 

Source
pub struct OAuth2Flow<P: OAuthProvider, M: UserMapper = ()> { /* private fields */ }
Expand description

Orchestrates the Authorization Code flow.

Implementations§

Source§

impl<P: OAuthProvider> OAuth2Flow<P, ()>

Source

pub fn new(provider: P) -> Self

Source§

impl<P: OAuthProvider, M: UserMapper> OAuth2Flow<P, M>

Source

pub fn with_mapper(provider: P, mapper: M) -> Self

Source

pub fn initiate_login( &self, scopes: &[&str], pkce_challenge: Option<&str>, ) -> (String, String)

Generates the redirect URL and CSRF state.

Source

pub async fn finalize_login( &self, code: &str, received_state: &str, expected_state: &str, pkce_verifier: Option<&str>, ) -> Result<(Identity, OAuthToken, Option<M::LocalUser>), AuthError>

Completes the flow by exchanging the code. If a mapper is provided, it will also map the identity to a local user.

Source

pub async fn refresh_access_token( &self, refresh_token: &str, ) -> Result<OAuthToken, AuthError>

Refresh an access token using a refresh token.

Source

pub async fn revoke_token(&self, token: &str) -> Result<(), AuthError>

Revoke an access token.

Auto Trait Implementations§

§

impl<P, M> Freeze for OAuth2Flow<P, M>
where P: Freeze, M: Freeze,

§

impl<P, M> RefUnwindSafe for OAuth2Flow<P, M>

§

impl<P, M> Send for OAuth2Flow<P, M>

§

impl<P, M> Sync for OAuth2Flow<P, M>

§

impl<P, M> Unpin for OAuth2Flow<P, M>
where P: Unpin, M: Unpin,

§

impl<P, M> UnwindSafe for OAuth2Flow<P, M>
where P: UnwindSafe, M: UnwindSafe,

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