Skip to main content

GenericOAuth2Provider

Struct GenericOAuth2Provider 

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

通用 OAuth2 提供商 — 对齐 Laravel Socialite GenericProvider

接收 OAuth2ConfigOAuth2HttpTransport,支持任意标准 OAuth2 提供商。

§工作流程

  1. GenericOAuth2Provider::redirect_url:构造授权 URL,引导用户跳转到授权服务器
  2. 授权服务器回调,携带 codestate
  3. GenericOAuth2Provider::user_from_token
    • POST token_url 换取 access_token(grant_type=authorization_code)
    • 如果配置了 user_url,POST 用户信息端点获取用户资料
    • 返回 SocialiteUser

§用法

use std::sync::Arc;
use sz_rust_auth_facade::oauth::{
    GenericOAuth2Provider, MemoryOAuth2HttpTransport, OAuth2Config, OAuth2Provider,
};

let config = OAuth2Config::new(
    "client_id",
    "client_secret",
    "https://example.com/callback",
    "https://provider.com/oauth2.0/authorize",
    "https://provider.com/oauth2.0/token",
)
.with_user_url("https://provider.com/user/info");

let transport = Arc::new(MemoryOAuth2HttpTransport::new());
let provider = GenericOAuth2Provider::new(config, transport);

let url = provider.redirect_url("random_state");
let user = provider.user_from_token("auth_code").unwrap();

Implementations§

Source§

impl GenericOAuth2Provider

Source

pub fn new( config: OAuth2Config, transport: Arc<dyn OAuth2HttpTransport>, ) -> GenericOAuth2Provider

创建通用 OAuth2 提供商

§参数
  • config: OAuth2 配置
  • transport: HTTP 传输实现(业务方注入 reqwest / hyper / etc.)
Source

pub fn with_audit_logger( self, logger: Arc<dyn OAuth2AuditLogger>, ) -> GenericOAuth2Provider

注入审计日志

Source

pub fn refresh_token( &self, refresh_token: &str, ) -> Result<TokenResponse, OAuth2Error>

用 refresh_token 换取新的 access_token

POST token_url,body 为 JSON:

{
  "grant_type": "refresh_token",
  "refresh_token": "<refresh_token>",
  "client_id": "<client_id>",
  "client_secret": "<client_secret>"
}
Source§

impl GenericOAuth2Provider

Source

pub fn redirect_url_with_pkce(&self, state: &str, pkce: &PkceParams) -> String

构造授权 URL(带 PKCE 参数)

当配置了 PKCE 参数时,授权 URL 追加 code_challengecode_challenge_method=S256

Source

pub fn user_from_token_with_pkce( &self, code: &str, code_verifier: Option<&str>, ) -> Result<SocialiteUser, OAuth2Error>

用授权码换取用户信息(可选 PKCE code_verifier)

code_verifierSome 时,token 交换 POST body 追加 code_verifier 字段。

Trait Implementations§

Source§

impl OAuth2Provider for GenericOAuth2Provider

Source§

fn redirect_url(&self, state: &str) -> String

生成授权 URL(对齐 Socialite::driver('qq')->redirect()Read more
Source§

fn user_from_token(&self, code: &str) -> Result<SocialiteUser, OAuth2Error>

用授权码换取访问令牌并获取用户信息(对齐 Socialite::driver('qq')->user()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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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