Guardian.Token behaviour (Guardian v2.2.4) View Source

The behaviour module for all token modules.

Token modules are responsible for all the heavy lifting in Guardian.

Link to this section Summary

Types

claims()

decoding_error()

encoding_error()

resource()

secret_error()

signing_error()

token()

ttl()

Callbacks

build_claims(mod, resource, sub, claims, options)

Build the default claims for the token.

create_token(mod, claims, options)

Create the token including serializing and signing.

decode_token(mod, token, options)

Decode the token. Without verification of the claims within it.

exchange(mod, old_token, from_type, to_type, options)

Exchange a token from one type to another.

peek(module, token)

Inspect the contents of the token without validation or signature checking.

refresh(mod, old_token, options)

Refresh a token.

revoke(mod, claims, token, options)

Revoke a token (if appropriate).

token_id()

Generate a unique id for a token.

verify_claims(mod, claims, options)

Verify the claims of a token.

Link to this section Types

claims()

Specs

claims() :: map()

decoding_error()

Specs

decoding_error() :: {:error, atom()}

encoding_error()

Specs

encoding_error() :: {:error, atom()}

resource()

Specs

resource() :: any()

secret_error()

Specs

secret_error() :: {:error, :secret_not_found}

signing_error()

Specs

signing_error() :: {:error, :signing_error}

token()

Specs

token() :: String.t()

ttl()

Specs

ttl() ::
  {pos_integer(), :second}
  | {pos_integer(), :seconds}
  | {pos_integer(), :minute}
  | {pos_integer(), :minutes}
  | {pos_integer(), :hour}
  | {pos_integer(), :hours}
  | {pos_integer(), :day}
  | {pos_integer(), :days}
  | {pos_integer(), :week}
  | {pos_integer(), :weeks}

Link to this section Callbacks

build_claims(mod, resource, sub, claims, options)

Specs

build_claims(
  mod :: module(),
  resource :: any(),
  sub :: String.t(),
  claims :: claims(),
  options :: Keyword.t()
) :: {:ok, claims()} | {:error, atom()}

Build the default claims for the token.

create_token(mod, claims, options)

Specs

create_token(mod :: module(), claims :: claims(), options :: Guardian.options()) ::
  {:ok, token()} | signing_error() | secret_error() | encoding_error()

Create the token including serializing and signing.

decode_token(mod, token, options)

Specs

decode_token(mod :: module(), token :: token(), options :: Guardian.options()) ::
  {:ok, token()} | secret_error() | decoding_error()

Decode the token. Without verification of the claims within it.

exchange(mod, old_token, from_type, to_type, options)

Specs

exchange(
  mod :: module(),
  old_token :: token(),
  from_type :: String.t() | [String.t(), ...],
  to_type :: String.t(),
  options :: Guardian.options()
) :: {:ok, {token(), claims()}, {token(), claims()}} | {:error, any()}

Exchange a token from one type to another.

peek(module, token)

Specs

peek(module :: module(), token :: token()) :: map()

Inspect the contents of the token without validation or signature checking.

refresh(mod, old_token, options)

Specs

refresh(mod :: module(), old_token :: token(), options :: Guardian.options()) ::
  {:ok, {token(), claims()}, {token(), claims()}} | {:error, any()}

Refresh a token.

revoke(mod, claims, token, options)

Specs

revoke(
  mod :: module(),
  claims :: claims(),
  token :: token(),
  options :: Guardian.options()
) :: {:ok, claims()} | {:error, any()}

Revoke a token (if appropriate).

token_id()

Specs

token_id() :: String.t()

Generate a unique id for a token.

verify_claims(mod, claims, options)

Specs

verify_claims(
  mod :: module(),
  claims :: claims(),
  options :: Guardian.options()
) :: {:ok, claims()} | {:error, any()}

Verify the claims of a token.