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.