Pow v1.0.20 Pow.Store.CredentialsCache behaviour View Source

Default module for credentials session storage.

A key (session id) is used to store, fetch, or delete credentials. The credentials are expected to take the form of {credentials, session_metadata}, where session metadata is data exclusive to the session id.

This module also adds two utility methods:

users/2 - to list all current users
sessions/2 - to list all current sessions

Custom credentials cache module

Pow may use the utility methods in this module. To ensure all required methods has been implemented in a custom credentials cache module, the @behaviour of this module should be used:

defmodule MyApp.CredentialsStore do
  use Pow.Store.Base,
    ttl: :timer.minutes(30),
    namespace: "credentials"

  @behaviour Pow.Store.CredentialsCache

  @impl Pow.Store.CredentialsCache
  def users(config, struct) do
    # ...
  end

  @impl Pow.Store.CredentialsCache
  def put(config, key, value) do
    # ...
  end
end

Link to this section Summary

Functions

backend_config(config)

delete(config, key)

Delete the user credentials data from the backend store.

get(config, key)

Fetch user credentials from the backend store from session id.

put(config, key, value)

Add user credentials with the session id to the backend store.

sessions(config, user)

List all existing sessions for the user fetched from the backend store.

users(config, struct)

List all user for a certain user struct.

Callbacks

put(arg1, binary, {})

sessions(arg1, map)

users(arg1, module)

Link to this section Functions

backend_config(config)

backend_config(Pow.Store.Base.config()) :: Pow.Store.Base.config()

delete(config, key)

Delete the user credentials data from the backend store.

This following two key-value will be deleted:

{session_id, {[user_struct, :user, user_id], metadata}}
{[user_struct, :user, user_id, :session, session_id], inserted_at}

The {[user_struct, :user, user_id], user} key-value is expected to expire when reaching its TTL.

get(config, key)

get(Pow.Store.Base.config(), binary()) :: {map(), list()} | :not_found

Fetch user credentials from the backend store from session id.

put(config, key, value)

put(Pow.Store.Base.config(), binary(), {map(), list()}) :: :ok

Add user credentials with the session id to the backend store.

The credentials are expected to be in the format of {credentials, metadata}.

This following three key-value will be inserted:

{session_id, {[user_struct, :user, user_id], metadata}}
{[user_struct, :user, user_id], user}
{[user_struct, :user, user_id, :session, session_id], inserted_at}

If metadata has :fingerprint any active sessions for the user with the same :fingerprint in metadata will be deleted.