Struct rocket_oauth2::OAuth2

pub struct OAuth2<C> { /* fields omitted */ }

The OAuth2 structure implements OAuth in a Rocket application by setting up OAuth-related route handlers.

Redirect handler

OAuth2 handles the redirect URI. It verifies the state token to prevent CSRF attacks, then instructs the Adapter to perform the token exchange. The resulting token is passed to the Callback.

Login handler

OAuth2 optionally handles a login route, which simply redirects to the authorization URI generated by the Adapter. Whether or not OAuth2 is handling a login URI, get_redirect can be used to get a Redirect to the OAuth login flow manually.

Methods

impl<C: Callback> OAuth2<C>

pub fn fairing<A: Adapter>(
    adapter: A,
    callback: C,
    config_name: &str,
    callback_uri: &str,
    login: Option<(&str, Vec<String>)>
) -> impl Fairing

Returns an OAuth2 fairing. The fairing will place an instance of OAuth2<C> in managed state and mount a redirect handler. It will also mount a login handler if login is Some.

pub fn custom<A: Adapter>(
    adapter: A,
    callback: C,
    config: OAuthConfig,
    callback_uri: &str,
    login: Option<(&str, Vec<String>)>
) -> impl Fairing

Returns an OAuth2 fairing with custom configuration. The fairing will place an instance of OAuth2<C> in managed state and mount a redirect handler. It will also mount a login handler if login is Some.

pub fn get_redirect(
    &self,
    cookies: &mut Cookies,
    scopes: &[&str]
) -> Result<Redirect, Error>

Prepare an authentication redirect. This sets a state cookie and returns a Redirect to the provider's authorization page.

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

Request a new access token given a refresh token. The refresh token must have been returned by the provider in a previous TokenResponse.

Trait Implementations

impl<C: Debug> Debug for OAuth2<C>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.