Packages
ash_authentication
5.0.0-rc.0
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/totp/strategy.ex
# SPDX-FileCopyrightText: 2022 Alembic Pty Ltd
#
# SPDX-License-Identifier: MIT
defimpl AshAuthentication.Strategy, for: AshAuthentication.Strategy.Totp do
@moduledoc """
Implementation of `AshAuthentication.Strategy` for `AshAuthentication.Strategy.Totp`.
"""
alias Ash.Resource
alias AshAuthentication.{Info, Strategy, Strategy.Totp}
alias Plug.Conn
@doc false
@spec name(Totp.t()) :: atom
def name(strategy), do: strategy.name
@doc false
@spec phases(Totp.t()) :: [atom]
def phases(strategy) do
[]
|> maybe_add(strategy.setup_enabled?, :setup)
|> maybe_add(strategy.confirm_setup_enabled?, :confirm_setup)
|> maybe_add(strategy.sign_in_enabled?, :sign_in)
|> maybe_add(strategy.verify_enabled?, :verify)
end
@doc false
@spec actions(Totp.t()) :: [atom]
def actions(strategy) do
[]
|> maybe_add(strategy.setup_enabled?, :setup)
|> maybe_add(strategy.confirm_setup_enabled?, :confirm_setup)
|> maybe_add(strategy.sign_in_enabled?, :sign_in)
|> maybe_add(strategy.verify_enabled?, :verify)
end
@doc false
@spec method_for_phase(Totp.t(), atom) :: Strategy.http_method()
def method_for_phase(_strategy, :confirm_setup), do: :post
def method_for_phase(_strategy, :setup), do: :post
def method_for_phase(_strategy, :sign_in), do: :post
def method_for_phase(_strategy, :verify), do: :post
@doc false
@spec routes(Totp.t()) :: [Strategy.route()]
def routes(strategy) do
subject_name = Info.authentication_subject_name!(strategy.resource)
base = "/#{subject_name}/#{strategy.name}"
[]
|> maybe_add(strategy.setup_enabled?, {"#{base}/setup", :setup})
|> maybe_add(strategy.confirm_setup_enabled?, {"#{base}/confirm_setup", :confirm_setup})
|> maybe_add(strategy.sign_in_enabled?, {"#{base}/sign_in", :sign_in})
|> maybe_add(strategy.verify_enabled?, {"#{base}/verify", :verify})
end
@doc false
@spec plug(Totp.t(), atom, Conn.t()) :: Conn.t()
def plug(strategy, :confirm_setup, conn), do: Totp.Plug.confirm_setup(conn, strategy)
def plug(strategy, :setup, conn), do: Totp.Plug.setup(conn, strategy)
def plug(strategy, :sign_in, conn), do: Totp.Plug.sign_in(conn, strategy)
def plug(strategy, :verify, conn), do: Totp.Plug.verify(conn, strategy)
@doc false
@spec action(Totp.t(), atom, map, keyword) ::
{:ok, Resource.record()} | {:ok, boolean} | {:error, any}
def action(strategy, :confirm_setup, params, options),
do: Totp.Actions.confirm_setup(strategy, params, options)
def action(strategy, :setup, params, options),
do: Totp.Actions.setup(strategy, params, options)
def action(strategy, :sign_in, params, options),
do: Totp.Actions.sign_in(strategy, params, options)
def action(strategy, :verify, params, options),
do: Totp.Actions.verify(strategy, params, options)
@doc false
@spec tokens_required?(Totp.t()) :: boolean
def tokens_required?(strategy), do: strategy.confirm_setup_enabled?
defp maybe_add(list, true, item), do: list ++ [item]
defp maybe_add(list, false, _item), do: list
end