Guardian v1.1.1 Guardian.Plug View Source

Provides functions for the implementation module for dealing with Guardian in a Plug environment

defmodule MyApp.Tokens do
  use Guardian, otp_app: :my_app

  # ... snip
end

Your implementation module will be given a Plug module for interacting with plug.

If you’re using Guardian in your application most of the setters will be uninteresting. They’re mostly for library authors and Guardian itself.

The usual functions you’d use in your application are:

sign_in(conn, resource, claims \\ %{}, opts \\ [])

Sign in a resource for your application. This will generate a token for your resource according to your TokenModule and subject_for_token callback.

sign_in will also cache the resource, claims, and token on the connection.

conn = MyApp.Guardian.Plug.sign_in(conn, resource, my_custom_claims)

If there is a session present the token will be stored in the session to provide traditional session based authentication.

Link to this section Summary

Link to this section Functions

Link to this function authenticated?(conn, opts) View Source
authenticated?(Plug.Conn.t(), Guardian.opts()) :: true | false
Link to this function current_claims(conn, opts \\ []) View Source
current_claims(Plug.Conn.t(), Guardian.opts()) :: Guardian.Token.claims() | nil
Link to this function current_resource(conn, opts \\ []) View Source
current_resource(Plug.Conn.t(), Guardian.opts()) :: any() | nil
Link to this function current_token(conn, opts \\ []) View Source
current_token(Plug.Conn.t(), Guardian.opts()) :: Guardian.Token.token() | nil
Link to this function default_key() View Source
default_key() :: String.t()

Provides the default key for the location of a token in the session and connection

Link to this function put_current_claims(conn, claims, opts \\ []) View Source
put_current_claims(
  Plug.Conn.t(),
  Guardian.Token.claims() | nil,
  Guardian.opts()
) :: Plug.Conn.t()
Link to this function put_current_resource(conn, resource, opts \\ []) View Source
put_current_resource(Plug.Conn.t(), resource :: any() | nil, Guardian.opts()) ::
  Plug.Conn.t()
Link to this function put_current_token(conn, token, opts \\ []) View Source
put_current_token(Plug.Conn.t(), Guardian.Token.token() | nil, Guardian.opts()) ::
  Plug.Conn.t()
Link to this function remember_me(conn, mod, resource, claims \\ %{}, opts \\ []) View Source
Link to this function remember_me_from_token(conn, mod, token, claims_to_check \\ %{}, opts \\ []) View Source
Link to this function sign_in(conn, impl, resource, claims \\ %{}, opts \\ []) View Source
Link to this function sign_out(conn, impl, opts) View Source
sign_out(Plug.Conn.t(), module(), Guardian.opts()) :: Plug.Conn.t()