Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Erlang Oauth2 implementation
Erlang Makefile
Tree: 0b7edbd411

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.


This library is designed to simplify the implementation of the server side of OAuth2 ( It provides no support for developing clients. See oauth2_client for support in accessing Oauth2 enabled services.


Check out the examples



A token is a (randomly generated) string provided to the client by the server in response to some form of authorization request. There are several types of tokens:

  • Access Token: An access token identifies the origin of a request for a privileged resource.
  • Refresh Token: A refresh token can be used to replace an expired access token.


Access tokens can (optionally) be set to expire after a certain amount of time. An expired token cannot be used to gain access to resources.


A token is associated with an identity -- a value that uniquely identifies a user, client or agent within your system. Typically, this is a user identifier.


The scope is handled by the backend implementation. The specification outlines that the scope is a space delimetered set of parameters. This library has been developed with the following in mind.

Scope is implemented as a set and loosely modeled after the Solaris RBAC priviliges, i.e. solaris.x.* and implemented as a MAC with the ability to narrow the scope but not extend it beyond the predefined scope.

But since the scope is opaque to this Oauth2 implementation you can use the scoping strategy that best suit your workflow.

There is a utility module to work with scope. The recommendation is to pass a Scope as a list of binaries, i.e. [<<"root.a.c.b">>, <<"root.x.y.z">>] you can then validate these against another set like:

> oauth2_priv_set:is_subset(oauth2_priv_set:new([<<"root.a.b">>, <<"root.x.y">>]),
> oauth2_priv_set:is_subset(oauth2_priv_set:new([<<"root.a.b">>, <<"root.x.y">>]),
> oauth2_priv_set:is_subset(oauth2_priv_set:new([<<"root.a.b">>, <<"root.x.y">>]),
                            oauth2_priv_set:new([<<"root.a.*">>, <<"root.x.y">>])).


If you have many diverse clients connecting to your service -- for instance, a web client and an iPhone app -- it's desirable to be able to distinguish them from one another and to be able to grant or revoke privileges based on the type the client issuing a request. As described in the OAuth2 specification, clients come in two flavors:

  • Confidential clients, which can be expected to keep their credentials from being disclosed. For instance, a web site owned and operated by you could be regarded as confidential.
  • Public clients, whose credentials are assumed to be compromised the moment the client software is released to the public.

Clients are distinguished by their identifiers, and can (optionally) be authenticated using a secret key shared between the client and server.


If you want to run the EUnit test cases, you can do so with:

$ rebar -C rebar.tests.config get-deps
$ rebar -C rebar.tests.config compile
$ rebar -C rebar.tests.config eunit skip_deps=true


The library makes no assumptions as to how you want to implement authentication and persistence of users, clients and tokens. Instead, it provides a proxy module (oauth2_backend) for directing calls to a backend plugin supplied by you. To direct calls to a different backend module, simply set {backend, your_backend_module} in the oauth2 section of your app.config.

The following example demonstrates a basic app.config section for oauth2.

    {oauth2, [
        %% Default expiry_time for access_tokens unless
        %% overridden per flow
        {expiry_time, 3600}
        ,{backend, backend_goes_here}

        %% Optional expiry_time override per flow
        ,{password_credentials, [
            {expiry_time, 7200}
        ,{client_credentials, [
            {expiry_time, 86400}
        ,{code_grant, [
            %% Recommended absolute expiry time from the spec
            {expiry_time, 600}

A complete list of functions that your backend must provide is available by looking at oauth2_backend.erl, which contains documentation and function specifications.


The KIVRA oauth2 library uses an MIT license. So go ahead and do what you want!

Something went wrong with that request. Please try again.