View Source AshAuthentication.Strategy protocol (ash_authentication v4.0.0)

The protocol used for interacting with authentication strategies.

Any new Authentication strategy must implement this protocol.

Summary

Types

action()

The name of an individual action supported by the strategy.

http_method()

path()

A path to match in web requests

phase()

The "phase" of the request.

route()

An individual route.

t()

All the types that implement this protocol.

Functions

action(strategy, action_name, params, options \\ [])

Perform an named action.

actions(strategy)

Return a list of actions supported by the strategy.

method_for_phase(t, phase)

Return the HTTP method for a phase.

name(strategy)

The "short name" of the strategy, used for genererating routes, etc.

phases(strategy)

Return a list of phases supported by the strategy.

plug(strategy, phase, conn)

Handle requests routed to the strategy.

routes(strategy)

Used to build the routing table to route web requests to request phases for each strategy.

tokens_required?(strategy)

Indicates that the strategy creates or consumes tokens.

Types

action()

@type action() :: atom()

The name of an individual action supported by the strategy.

This maybe not be the action name on the underlying resource, which may be generated, but the name that the strategy itself calls the action.

http_method()

@type http_method() ::
  :get | :head | :post | :put | :delete | :connect | :options | :trace | :patch

path()

@type path() :: String.t()

A path to match in web requests

phase()

@type phase() :: atom()

The "phase" of the request.

Usually :request or :callback but can be any atom.

route()

@type route() :: {path(), phase()}

An individual route.

Eg: {"/user/password/sign_in", :sign_in}

t()

@type t() :: term()

All the types that implement this protocol.

Functions

action(strategy, action_name, params, options \\ [])

@spec action(t(), action(), params :: map(), options :: keyword()) ::
  :ok | {:ok, Ash.Resource.record()} | {:error, any()}

Perform an named action.

Different strategies are likely to implement a number of different actions depending on their configuration. Calling them via this function will ensure that the context is correctly set, etc.

See actions/1 for a list of actions provided by the strategy.

Any options passed to the action will be passed to the underlying Ash.Domain function.

actions(strategy)

@spec actions(t()) :: [action()]

Return a list of actions supported by the strategy.

Example

iex> strategy = Info.strategy!(Example.User, :password)
...> actions(strategy)
[:sign_in_with_token, :register, :sign_in, :reset_request, :reset]

method_for_phase(t, phase)

@spec method_for_phase(t(), phase()) :: http_method()

Return the HTTP method for a phase.

Example

iex> strategy = Info.strategy!(Example.User, :oauth2)
...> method_for_phase(strategy, :request)
:get

name(strategy)

@spec name(t()) :: atom()

The "short name" of the strategy, used for genererating routes, etc.

This is most likely the same value that you use for the entity's name argument.

phases(strategy)

@spec phases(t()) :: [phase()]

Return a list of phases supported by the strategy.

Example

iex> strategy = Info.strategy!(Example.User, :password)
...> phases(strategy)
[:sign_in_with_token, :register, :sign_in, :reset_request, :reset]

plug(strategy, phase, conn)

@spec plug(t(), phase(), Plug.Conn.t()) :: Plug.Conn.t()

Handle requests routed to the strategy.

Each phase will be an atom (ie the second element in the route tuple).

See phases/1 for a list of phases supported by the strategy.

routes(strategy)

@spec routes(t()) :: [route()]

Used to build the routing table to route web requests to request phases for each strategy.

Example

iex> strategy = Info.strategy!(Example.User, :password)
...> routes(strategy)
[
  {"/user/password/sign_in_with_token", :sign_in_with_token},
  {"/user/password/register", :register},
  {"/user/password/sign_in", :sign_in},
  {"/user/password/reset_request", :reset_request},
  {"/user/password/reset", :reset}
]

tokens_required?(strategy)

@spec tokens_required?(t()) :: boolean()

Indicates that the strategy creates or consumes tokens.