Struct Client 

pub struct Client {
    pub oauth2: Client<BasicErrorResponse, BasicTokenResponse, BasicTokenIntrospectionResponse, StandardRevocableToken, BasicRevocationErrorResponse, EndpointSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointMaybeSet>,
    pub profile_url: Url,
    pub http_client: Client,
    pub flow_states: HashMap<String, (PkceCodeVerifier, Instant)>,
    pub scopes: Vec<Scope>,
    pub csrf_token_timeout: Duration,
    pub cookie_config: CookieConfig,
}

Client that acts as a client for the Authorization Code Grant flow.

Fields

oauth2: Client<BasicErrorResponse, BasicTokenResponse, BasicTokenIntrospectionResponse, StandardRevocableToken, BasicRevocationErrorResponse, EndpointSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointMaybeSet>

BasicClient instance for the OAuth2 client.

profile_url: Url

Url instance for the OAuth2 client’s profile URL.

http_client: Client

reqwest::Client instance for the OAuth2 client’s HTTP client.

flow_states: HashMap<String, (PkceCodeVerifier, Instant)>

A flow states hashMap <CSRF Token, (PKCE Code Verifier, Created time)> for managing the expiration of the CSRF tokens and PKCE code verifiers.

scopes: Vec<Scope>

A vector of Scope for the getting the user’s profile.

csrf_token_timeout: Duration

A std::time::Duration for the OAuth2 client’s CSRF token timeout which defaults to 10 minutes (600s).

cookie_config: CookieConfig

An optional CookieConfig for the OAuth2 client’s cookie during middleware

Implementations

impl Client

pub fn new( credentials: Credentials, config: UrlConfig, cookie_config: CookieConfig, timeout_seconds: Option<u64>, ) -> OAuth2ClientResult<Self>

Create a new instance of [OAuth2Client].

Arguments

• credentials - A Credentials struct that holds the OAuth2 client credentials.
• config - A UrlConfig struct that holds the OAuth2 client related URLs.
• timeout_seconds - An optional timeout in seconds for the csrf token. Defaults to 10 minutes (600s).

Returns

A Client instance

Errors

OAuth2ClientError::UrlError if the auth_url, token_url, redirect_url or profile_url is invalid.

Example

let credentials = AuthorizationCodeCredentials {
   client_id: "test_client_id".to_string(),
  client_secret: Some("test_client_secret".to_string()),
};
let config = AuthorizationCodeUrlConfig {
    auth_url: "https://accounts.google.com/o/oauth2/v2/auth".to_string(),
    token_url: Some("https://www.googleapis.com/oauth2/v3/token".to_string()),
    redirect_url: "http://localhost:8000/api/auth/google_callback".to_string(),
    profile_url: "https://openidconnect.googleapis.com/v1/userinfo".to_string(),
    scopes: vec!["https://www.googleapis.com/auth/userinfo.email".to_string()],
};
let client = AuthorizationCodeClient::new(credentials, config, None)?;

Trait Implementations

impl GrantTrait for Client

fn get_authorization_code_client(&mut self) -> &mut Client

Get authorization code client

fn get_cookie_config(&self) -> &CookieConfig

Get AuthorizationCodeCookieConfig instance

fn get_authorization_url(&mut self) -> (Url, CsrfToken)

Get authorization URL

fn verify_code_from_callback<'life0, 'async_trait>( &'life0 mut self, code: String, state: String, csrf_token: String, ) -> Pin<Box<dyn Future<Output = OAuth2ClientResult<(BasicTokenResponse, Response)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Verify code from the provider callback request after returns from the OAuth2 provider’s login page.