Struct rocket_oauth2::OAuthConfig

pub struct OAuthConfig { /* fields omitted */ }

Holds configuration for an OAuth application. This consists of the Provider details, a client_id and client_secret, and an optional redirect_uri.

Implementations

impl OAuthConfig

pub fn new(
    provider: impl Provider,
    client_id: String,
    client_secret: String,
    redirect_uri: Option<String>
) -> OAuthConfig

Construct an OAuthConfig specifying all parameters manually.

Example

use rocket_oauth2::{OAuthConfig, StaticProvider};

let provider = StaticProvider::GitHub;
let client_id = "...".to_string();
let client_secret = "...".to_string();
let redirect_uri = Some("http://localhost:8000/auth/github".to_string());

let config = OAuthConfig::new(provider, client_id, client_secret, redirect_uri);

pub fn from_config(config: &Config, name: &str) -> Result<OAuthConfig>

Construct an OAuthConfig from Rocket configuration.

Example

Rocket.toml

[global.oauth.github]
provider = "GitHub"
client_id = "..."
client_secret = "..."
redirect_uri = "http://localhost:8000/auth/github"

main.rs

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

struct GitHub;

fn main() {
    rocket::ignite()
        .attach(AdHoc::on_attach("OAuth Config", |rocket| {
            let config = OAuthConfig::from_config(rocket.config(), "github").unwrap();
            Ok(rocket.attach(OAuth2::<GitHub>::custom(HyperSyncRustlsAdapter::default(), config)))
        }))
        .launch();
}

pub fn provider(&self) -> &dyn Provider

Get the Provider for this configuration.

pub fn client_id(&self) -> &str

Get the client id for this configuration.

pub fn client_secret(&self) -> &str

Get the client secret for this configuration.

pub fn redirect_uri(&self) -> Option<&str>

Get the redirect URI for this configuration.

Trait Implementations

impl Debug for OAuthConfig

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

Formats the value using the given formatter.