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: &str) -> 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::{HyperSyncRustlsAdapter, OAuth2, OAuthConfig};

struct GitHub;

fn main() {
    rocket::ignite()
        .attach(OAuth2::<GitHub>::fairing("github"))
        .launch();
}

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::{HyperSyncRustlsAdapter, OAuth2, OAuthConfig, StaticProvider};

struct MyProvider;

fn main() {
    rocket::ignite()
        .attach(AdHoc::on_attach("OAuth Config", |rocket| {
            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()),
            );
            Ok(rocket.attach(OAuth2::<MyProvider>::custom(HyperSyncRustlsAdapter, config)))
        }))
        .launch();
}

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 authorization endpoint.

Example

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

struct GitHub;

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

pub 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("/")]
fn index(oauth2: OAuth2<GitHub>) {
    // get previously stored refresh_token
    oauth2.refresh(refresh_token).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<'a, 'r, K: 'static> FromRequest<'a, 'r> for OAuth2<K>

type Error = ()

The associated error to be returned if derivation fails.

fn from_request(request: &'a Request<'r>) -> Outcome<Self, Self::Error>

Derives an instance of Self from the incoming request metadata.