Packages
ash_authentication
4.2.5
5.0.0-rc.12
5.0.0-rc.11
5.0.0-rc.10
5.0.0-rc.9
5.0.0-rc.8
5.0.0-rc.7
5.0.0-rc.6
5.0.0-rc.5
5.0.0-rc.4
5.0.0-rc.3
5.0.0-rc.2
5.0.0-rc.1
5.0.0-rc.0
4.14.1
4.14.0
4.13.7
4.13.6
4.13.5
4.13.4
4.13.3
4.13.2
retired
4.13.1
retired
4.13.0
4.12.0
4.11.0
4.10.0
4.9.9
4.9.8
4.9.7
4.9.6
4.9.5
4.9.4
4.9.3
4.9.2
4.9.1
4.9.0
4.8.7
4.8.6
4.8.5
4.8.3
4.8.2
4.8.1
4.8.0
4.7.6
4.7.5
4.7.4
4.7.3
4.7.2
4.7.1
4.7.0
4.6.4
4.6.3
4.6.2
4.6.1
4.6.0
4.5.6
4.5.5
4.5.4
4.5.3
4.5.2
4.5.1
4.5.0
4.4.9
4.4.8
4.4.7
4.4.6
4.4.5
4.4.4
4.4.3
4.4.2
4.4.1
4.4.0
4.3.12
4.3.11
4.3.10
4.3.9
4.3.8
4.3.7
4.3.6
4.3.5
4.3.4
4.3.3
4.3.2
4.3.1
4.3.0
4.2.7
4.2.6
4.2.5
4.2.4
4.2.3
4.2.2
4.2.1
4.2.0
4.1.0
4.0.4
4.0.3
4.0.2
4.0.1
4.0.0
4.0.0-rc.6
4.0.0-rc.5
4.0.0-rc.3
4.0.0-rc.2
4.0.0-rc.1
4.0.0-rc.0
3.12.4
3.12.3
3.12.2
3.12.1
3.12.0
3.11.16
3.11.15
3.11.14
3.11.13
3.11.12
3.11.11
3.11.10
3.11.9
3.11.8
3.11.7
3.11.6
3.11.5
3.11.4
3.11.3
3.11.2
3.11.1
3.11.0
3.10.8
3.10.7
3.10.6
3.10.5
3.10.4
3.10.3
3.10.2
3.10.1
3.10.0
3.9.6
3.9.5
3.9.4
3.9.3
3.9.2
3.9.1
3.9.0
3.8.0
3.7.9
3.7.8
3.7.6
3.7.5
3.7.4
3.7.3
3.7.2
3.7.1
3.7.0
3.6.1
3.6.0
3.5.3
3.5.2
3.5.1
3.5.0
3.3.1
3.3.0
3.2.2
3.2.1
3.2.0
3.1.0
3.0.3
Authentication extension for the Ash Framework.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/ash_authentication/strategies/oauth2/strategy.ex
defimpl AshAuthentication.Strategy, for: AshAuthentication.Strategy.OAuth2 do
@moduledoc """
Implmentation of `AshAuthentication.Strategy` for
`AshAuthentication.Strategy.OAuth2`.
"""
alias Ash.Resource
alias AshAuthentication.{Info, Strategy, Strategy.OAuth2}
alias Plug.Conn
@typedoc "The request phases supported by this strategy"
@type phase :: :request | :callback
@typedoc "The actions supported by this strategy"
@type action :: :register | :sign_in
@doc false
@spec name(OAuth2.t()) :: atom
def name(strategy), do: strategy.name
@doc false
@spec phases(OAuth2.t()) :: [phase]
def phases(_), do: [:request, :callback]
@doc false
@spec actions(OAuth2.t()) :: [action]
def actions(%OAuth2{registration_enabled?: true}), do: [:register]
def actions(%OAuth2{registration_enabled?: false}), do: [:sign_in]
@doc false
@spec method_for_phase(OAuth2.t(), phase) :: Strategy.http_method()
def method_for_phase(_, :request), do: :get
def method_for_phase(_, :callback), do: :post
@doc """
Return a list of routes for use by the strategy.
"""
@spec routes(OAuth2.t()) :: [Strategy.route()]
def routes(strategy) do
subject_name = Info.authentication_subject_name!(strategy.resource)
[request: nil, callback: :callback]
|> Enum.map(fn {phase, suffix} ->
path =
[subject_name, strategy.name, suffix]
|> Enum.map(&to_string/1)
|> Path.join()
{"/#{path}", phase}
end)
end
@doc """
Handle HTTP requests.
"""
@spec plug(OAuth2.t(), phase, Conn.t()) :: Conn.t()
def plug(strategy, :request, conn), do: OAuth2.Plug.request(conn, strategy)
def plug(strategy, :callback, conn), do: OAuth2.Plug.callback(conn, strategy)
@doc """
Perform actions.
"""
@spec action(OAuth2.t(), action, map, keyword) :: {:ok, Resource.record()} | {:error, any}
def action(strategy, :register, params, options),
do: OAuth2.Actions.register(strategy, params, options)
def action(strategy, :sign_in, params, options),
do: OAuth2.Actions.sign_in(strategy, params, options)
@doc false
@spec tokens_required?(OAuth2.t()) :: boolean
def tokens_required?(_), do: false
end