manifest / pal-oauth2

Pragmatic Authentication Library: OAuth2 workflows

Pragmatic Authentication Library: OAuth2 workflows

Collection of OAuth2 workflows for PAL.

Authorization Code Grant workflow

Options

You can configure the workflow by passing options below into pal:new/2 or pal:group/2 functions:

• client_id (required) - The client identifier, a unique string representing the registration information provided by the client.
• client_secret (required) - The client secret.
• authorization_uri (required) - The authorization code endpoint.
• access_token_uri (required) - The endpoint for retrieving the access token.
• redirect_uri (optional) - The client redirection endpoint. After completing its interaction with the resource owner, the authorization server directs the resource owner's user-agent to this uri.
• scope (optional) - The scope of the access request.
• request_options (optional) - Options for the hackney HTTP client.
• includes (optional) - Parts of authentication schema to be processed by the workflow. All by default, [uid, credentials, info, extra, rules].

Input Data

• code - The authorization code.
• state - The state was previously passed to the authentication provider.
• error If the request fails due to a missing, invalid, or mismatching redirection URI, or if the client identifier is missing or invalid.

Authentication Schema

An successful execution of pal:authenticate/{2,3} function returns the authentication schema below.

#{access_token  => <<"...">>,
  token_type    => <<"Bearer">>,
  expires_in    => 3600,
  refresh_token => <<"...">>}

Keys are named according to RFC 6749.

See a complete example using PAL and Cowboy HTTP server here.

License

The source code is provided under the terms of the MIT license.