Struct rocket_oauth2::OAuth2

pub struct OAuth2<K>(_);

Utilities for OAuth authentication in Rocket applications.

Implementations

impl<K: 'static> OAuth2<K>

pub fn fairing(config_name: impl AsRef<str> + Send + 'static) -> impl Fairing

Create an OAuth2 fairing. The fairing will read the configuration in config_name and register itself in the application so that TokenResponse<K> can be used.

Example

use rocket::fairing::AdHoc;
use rocket_oauth2::{HyperRustlsAdapter, OAuth2, OAuthConfig};

struct GitHub;

#[rocket::launch]
fn rocket() -> _ {
    rocket::build().attach(OAuth2::<GitHub>::fairing("github"))
}

pub fn custom<A: Adapter>(adapter: A, config: OAuthConfig) -> impl Fairing

Create an OAuth2 fairing with a custom adapter and configuration.

Example

use rocket::fairing::AdHoc;
use rocket_oauth2::{HyperRustlsAdapter, OAuth2, OAuthConfig, StaticProvider};

struct MyProvider;

#[rocket::launch]
fn rocket() -> _ {
    rocket::build()
        .attach(AdHoc::on_ignite("OAuth Config", |rocket| async {
            let config = OAuthConfig::new(
                StaticProvider {
                    auth_uri: "auth uri".into(),
                    token_uri: "token uri".into(),
                },
                "client id".to_string(),
                "client secret".to_string(),
                Some("http://localhost:8000/auth".to_string()),
            );
            rocket.attach(OAuth2::<MyProvider>::custom(HyperRustlsAdapter::default(), config))
        }))
}

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

Prepare an authentication redirect. This sets a state cookie and returns a Redirect to the authorization endpoint.

Example

use rocket::http::CookieJar;
use rocket::response::Redirect;
use rocket_oauth2::OAuth2;

struct GitHub;

#[rocket::get("/login/github")]
fn github_login(oauth2: OAuth2<GitHub>, cookies: &CookieJar<'_>) -> Redirect {
    oauth2.get_redirect(cookies, &["user:read"]).unwrap()
}

pub fn get_redirect_extras(
    &self,
    cookies: &CookieJar<'_>,
    scopes: &[&str],
    extras: &[(&str, &str)]
) -> Result<Redirect, Error>

Prepare an authentication redirect. This sets a state cookie and returns a Redirect to the authorization endpoint. Unlike get_redirect, this method accepts additional query parameters in extras; this can be used to provide or request additional information to or from providers.

Example

use rocket::http::CookieJar;
use rocket::response::Redirect;
use rocket_oauth2::OAuth2;

struct Reddit;

#[rocket::get("/login/reddit")]
fn reddit_login(oauth2: OAuth2<Reddit>, cookies: &CookieJar<'_>) -> Redirect {
    oauth2.get_redirect_extras(cookies, &["identity"], &[("duration", "permanent")]).unwrap()
}

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

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

Example

use rocket_oauth2::OAuth2;

struct GitHub;

#[rocket::get("/")]
async fn index(oauth2: OAuth2<GitHub>) {
    // get previously stored refresh_token
    oauth2.refresh(refresh_token).await.unwrap();
}

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'r, K: 'static> FromRequest<'r> for OAuth2<K>

type Error = ()

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>(
    request: &'r Request<'life0>
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Derives an instance of Self from the incoming request metadata.

impl<K: 'static> Sentinel for OAuth2<K>

fn abort(rocket: &Rocket<Ignite>) -> bool

Returns true if launch should be aborted and false otherwise.