[−][src]Crate oauth2

A simple implementation of the OAuth2 flow, trying to adhere as much as possible to RFC 6749.

Getting started: Authorization Code Grant

This is the most common OAuth2 flow.

Example

use oauth2::*;
use url::Url;

// Create an OAuth2 client by specifying the client ID, client secret, authorization URL and
// token URL.
let mut client = Client::new("client_id", Url::parse("http://authorize")?, Url::parse("http://token")?);
client.set_client_secret("client_secret");
// Set the URL the user will be redirected to after the authorization process.
client.set_redirect_url(Url::parse("http://redirect")?);
// Set the desired scopes.
client.add_scope("read");
client.add_scope("write");

// Generate the full authorization URL.
let state = State::new_random();
let auth_url = client.authorize_url(&state);

// This is the URL you should redirect the user to, in order to trigger the authorization
// process.
println!("Browse to: {}", auth_url);

// Once the user has been redirected to the redirect URL, you'll have access to the
// authorization code. For security reasons, your code should verify that the `state`
// parameter returned by the server matches `state`.

// Now you can trade it for an access token.
let token_result = client.exchange_code("some authorization code");

// Unwrapping token_result will either produce a Token or a RequestTokenError.

Implicit Grant

This flow fetches an access token directly from the authorization endpoint. Be sure to understand the security implications of this flow before using it. In most cases, the Authorization Code Grant flow is preferable to the Implicit Grant flow.

Example:

use oauth2::*;
use url::Url;

let mut client = Client::new("client_id", Url::parse("http://authorize")?, Url::parse("http://token")?);
client.set_client_secret("client_secret");

// Generate the full authorization URL.
let state = State::new_random();
let auth_url = client.authorize_url_implicit(&state);

// This is the URL you should redirect the user to, in order to trigger the authorization
// process.
println!("Browse to: {}", auth_url);

// Once the user has been redirected to the redirect URL, you'll have the access code.
// For security reasons, your code should verify that the `state` parameter returned by the
// server matches `state`.

Resource Owner Password Credentials Grant

You can ask for a password access token by calling the Client::exchange_password method, while including the username and password.

Example

use oauth2::*;
use url::Url;

let reqwest_client = reqwest::Client::new();
let mut client = Client::new("client_id", Url::parse("http://authorize")?, Url::parse("http://token")?);

client.set_client_secret("client_secret");
client.add_scope("read");

let token = client
    .exchange_password("user", "pass")
    .with_client(&reqwest_client)
    .execute::<StandardToken>()
    .await?;

Client Credentials Grant

You can ask for a client credentials access token by calling the Client::exchange_client_credentials method.

Example:

use oauth2::*;
use url::Url;

let reqwest_client = reqwest::Client::new();
let mut client = Client::new("client_id", Url::parse("http://authorize")?, Url::parse("http://token")?);
client.set_client_secret("client_secret");
client.add_scope("read");

let token_result = client.exchange_client_credentials()
    .with_client(&reqwest_client)
    .execute::<StandardToken>();

Other examples

More specific implementations are available as part of the examples:

Modules

helpers

Helper methods used by OAuth2 implementations/extensions.

Structs

AccessToken	Access token returned by the token endpoint and used to access protected resources.
AuthorizationCode	Authorization code returned from the authorization endpoint.
Client	Stores the configuration for an OAuth2 client.
ClientRequest	A request wrapped in a client, ready to be executed.
ClientSecret	Client password issued to the client during the registration process described by Section 2.2.
ErrorResponse	Error response returned by server after requesting an access token.
PkceCodeChallengeMethod	Code Challenge Method used for PKCE protection via the `code_challenge_method` parameter.
PkceCodeChallengeS256	Code Challenge used for PKCE protection via the `code_challenge` parameter.
PkceCodeVerifierS256	Code Verifier used for PKCE protection via the `code_verifier` parameter. The value must have a minimum length of 43 characters and a maximum length of 128 characters. Each character must be ASCII alphanumeric or one of the characters "-" / "." / "_" / "~".
RefreshToken	Refresh token used to obtain a new access token (if supported by the authorization server).
Request	A token request that is in progress.
ResourceOwnerPassword	Resource owner's password used directly as an authorization grant to obtain an access token.
Scope	Access token scope, as defined by the authorization server.
StandardToken	Standard OAuth2 token response.
State	Value used for CSRF protection via the `state` parameter.
Url	A parsed URL record.

Enums

AuthType	Indicates whether requests to the authorization server should use basic authentication or include the parameters in the request body for requests in which either is valid.
ErrorField	These error types are defined in Section 5.2 of RFC 6749.
NewClientError	Errors when creating new clients.
RequestTokenError	Error encountered while requesting access token.
TokenType	Basic OAuth2 authorization token types.

Traits

Token

Common methods shared by all OAuth2 token implementations.