Packages
ash_authentication_phoenix
2.10.2
3.0.0-rc.9
3.0.0-rc.8
3.0.0-rc.7
3.0.0-rc.6
3.0.0-rc.4
3.0.0-rc.3
3.0.0-rc.2
3.0.0-rc.1
3.0.0-rc.0
2.17.2
2.17.1
2.17.0
2.16.0
2.15.0
2.14.1
2.14.0
2.13.1
2.13.0
2.12.2
2.12.1
2.12.0
2.11.0
2.10.5
2.10.4
2.10.3
2.10.2
2.10.1
2.10.0
2.9.0
2.8.0
2.7.0
2.6.3
2.6.2
2.6.1
2.6.0
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.4.8
2.4.7
2.4.6
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.0
2.2.1
2.2.0
2.1.11
2.1.10
2.1.9
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
2.0.0-rc.2
2.0.0-rc.1
2.0.0-rc.0
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.1
1.5.0
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.1
1.3.0
1.2.0
1.1.0
1.0.1
1.0.0
Phoenix integration for Ash Authentication
Current section
Files
Jump to
Current section
Files
lib/ash_authentication_phoenix/plug.ex
defmodule AshAuthentication.Phoenix.Plug do
@moduledoc """
Helper plugs mixed in to your router.
When you `use AshAuthentication.Phoenix.Router` this module is included, so
that you can use these plugs in your pipelines.
"""
alias AshAuthentication.Plug.Helpers
alias Plug.Conn
@doc """
Attempt to retrieve all actors from the connections' session.
A wrapper around `AshAuthentication.Plug.Helpers.retrieve_from_session/2`
with the `otp_app` as extracted from the endpoint.
"""
@spec load_from_session(Conn.t(), keyword) :: Conn.t()
def load_from_session(conn, opts) do
{maybe_otp_app, opts} = Keyword.pop(opts, :otp_app)
otp_app = maybe_otp_app || conn.private.phoenix_endpoint.config(:otp_app)
Helpers.retrieve_from_session(conn, otp_app, opts)
end
@doc """
Attempt to retrieve actors from the `Authorization` header(s).
A wrapper around `AshAuthentication.Plug.Helpers.retrieve_from_bearer/2` with
the `otp_app` as extracted from the endpoint.
"""
@spec load_from_bearer(Conn.t(), keyword) :: Conn.t()
def load_from_bearer(conn, opts) do
{maybe_otp_app, opts} = Keyword.pop(opts, :otp_app)
otp_app = maybe_otp_app || conn.private.phoenix_endpoint.config(:otp_app)
Helpers.retrieve_from_bearer(conn, otp_app, opts)
end
@doc """
Revoke all token(s) in the `Authorization` header(s).
A wrapper around `AshAuthentication.Plug.Helpers.revoke_bearer_tokens/2` with
the `otp_app` as extracted from the endpoint.
"""
@spec revoke_bearer_tokens(Conn.t(), any) :: Conn.t()
def revoke_bearer_tokens(conn, _opts) do
otp_app = conn.private.phoenix_endpoint.config(:otp_app)
Helpers.revoke_bearer_tokens(conn, otp_app)
end
@doc """
Revoke all token(s) in the session.
A wrapper around `AshAuthentication.Plug.Helpers.revoke_session_tokens/2` with
the `otp_app` as extracted from the endpoint.
"""
@spec revoke_session_tokens(Conn.t(), any) :: Conn.t()
def revoke_session_tokens(conn, _opts) do
otp_app = conn.private.phoenix_endpoint.config(:otp_app)
Helpers.revoke_session_tokens(conn, otp_app)
end
@doc """
Store the actor in the connections' session.
"""
@spec store_in_session(Conn.t(), Ash.Resource.record()) :: Conn.t()
defdelegate store_in_session(conn, actor), to: AshAuthentication.Plug.Helpers
end