Struct rocket_oauth2::HyperSyncRustlsAdapter

pub struct HyperSyncRustlsAdapter { /* fields omitted */ }

The default Adapter implementation. Uses hyper and rustls to perform the token exchange.

By defualt, this adapter will use HTTP Basic Authentication. If this is not supported by your authorization server, the basic_auth method can be used to change this behavior.

Implementations

impl HyperSyncRustlsAdapter

pub fn basic_auth(self, use_basic_auth: bool) -> Self

Sets whether or not this adapter will use HTTP Basic Authentication. Although servers are required to support it (RFC 6749 §2.3.1), not all do.

If this is set to false, the client_id and client_secret will be sent as part of the request body instead of an Authorization header.

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::from_config(rocket.config(), "my_provider").unwrap();
            Ok(rocket.attach(OAuth2::<MyProvider>::custom(
                HyperSyncRustlsAdapter::default().basic_auth(false), config)
            ))
        }))
        .launch();
}

Trait Implementations

impl Adapter for HyperSyncRustlsAdapter

fn authorization_uri(
    &self,
    config: &OAuthConfig,
    state: &str,
    scopes: &[&str],
    extras: &[(&str, &str)]
) -> Result<Absolute<'static>, Error>

Generate an authorization URI as described by RFC 6749 §4.1.1 given configuration, state, and scopes. Implementations should include extra_params in the URI as additional query parameters.

fn exchange_code(
    &self,
    config: &OAuthConfig,
    token: TokenRequest
) -> Result<TokenResponse<()>, Error>

Perform the token exchange in accordance with RFC 6749 §4.1.3 given the authorization code provided by the service.

impl Clone for HyperSyncRustlsAdapter

fn clone(&self) -> HyperSyncRustlsAdapter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperSyncRustlsAdapter

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

Formats the value using the given formatter.

impl Default for HyperSyncRustlsAdapter

fn default() -> Self

Returns the "default value" for a type.