CPub.Web.Authorization (CPub v0.3.0) View Source

An OAuth 2.0 Authorization.

An CPub.Web.Authorization.Authorization includes a code that can be used to obtain a CPub.Web.Authorization.Token. The token can be used to access resources. The Authorization can only be used once and is valid for only 10 minutes after creation.

The CPub.Web.Authorization.Authorization remains in the database and can be reused to refresh a token (see https://tools.ietf.org/html/rfc6749#section-6) until it is explicitly revoked (deleted). On deletion all CPub.Web.Authorization.Tokens that were created based on the Authorization are revoked (deleted).

Protected routes have a authorization assigned (see CPub.Web.Authorization.AuthorizationPlug).

Link to this section Summary

Types

t()

Functions

create(user, scope)

Create a new Authorization for the given user and scope without associating a client.

create(user, client, scope)

Create a new Authorization for the given user, client and scope.

expired?(authentication)

Returns true if the Authorization has expired (has been created more than 10 minutes ago).

get(id)

Get an authorization by id.

get_by_code(code)

Get an authorization by the code.

get_by_refresh_token(token)

Get an authorization by the refresh token.

use_code!(authorization)

Mark the authorization code as used.

valid_for()

Returns the number of seconds the Authorization code is valid for after initial creation.

Link to this section Types

t()

Specs

t() :: %CPub.Web.Authorization{
  __meta__: term(),
  authorization_code: String.t(),
  client: String.t(),
  code_used: bool(),
  created_at: NaiveDateTime.t(),
  id: String.t(),
  refresh_token: String.t(),
  scope: [atom()],
  user: String.t()
}

Link to this section Functions

create(user, scope)

Specs

create(CPub.User.t(), [String.t()]) :: {:ok, t()} | {:error, any()}

Create a new Authorization for the given user and scope without associating a client.

create(user, client, scope)

Specs

create(CPub.User.t(), CPub.Web.Authorization.Client.t(), [String.t() | atom()]) ::
  {:ok, t()} | {:error, any()}

Create a new Authorization for the given user, client and scope.

expired?(authentication)

Specs

expired?(t()) :: bool()

Returns true if the Authorization has expired (has been created more than 10 minutes ago).

get(id)

Specs

get(String.t()) :: {:ok, t()} | {:error, any()}

Get an authorization by id.

get_by_code(code)

Specs

get_by_code(String.t()) :: {:ok, t()} | {:error, any()}

Get an authorization by the code.

get_by_refresh_token(token)

Specs

get_by_refresh_token(String.t()) :: {:ok, t()} | {:error, any()}

Get an authorization by the refresh token.

use_code!(authorization)

Specs

use_code!(t()) :: {:ok, t()} | {:error, any()}

Mark the authorization code as used.

valid_for()

Specs

valid_for() :: non_neg_integer()

Returns the number of seconds the Authorization code is valid for after initial creation.