Struct splinter::oauth::OAuthClient

pub struct OAuthClient { /* fields omitted */ }

An OAuth2 client for Splinter

This client currently supports OAuth2 authorization code grants (https://tools.ietf.org/html/rfc6749#section-4.1).

Implementations

impl OAuthClient

pub fn get_authorization_url(
    &self,
    client_redirect_url: String
) -> Result<String, InternalError>

Generates the URL that the end user should be redirected to for authorization

Arguments

• client_redirect_url - The endpoint that Splinter will redirect to after it has completed authorization and the code exchange

pub fn exchange_authorization_code(
    &self,
    auth_code: String,
    csrf_token: &str
) -> Result<Option<(UserInfo, String)>, InternalError>

Exchanges the given authorization code for an access token and the client redirect URL provided in the original auth request, represented by a String.

Arguments

• auth_code - The authorization code that was supplied by the OAuth provider
• csrf_token - The CSRF token that was provided in the original auth request, which is used to prevent CSRF attacks and to correlate the auth code with the original auth request.

pub fn exchange_refresh_token(
    &self,
    refresh_token: String
) -> Result<String, InternalError>

Exchanges the given refresh token for an access token.

pub fn get_subject(
    &self,
    access_token: &str
) -> Result<Option<String>, InternalError>

Attempts to get the subject that the given access token is for from the OAuth server. This method will return Ok(None) if the access token could not be resolved to a subject.

Trait Implementations

impl Clone for OAuthClient

fn clone(&self) -> OAuthClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.