Packages
ash_authentication_phoenix
2.6.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
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/ash_authentication_phoenix/components/sign_in.ex
defmodule AshAuthentication.Phoenix.Components.SignIn do
use AshAuthentication.Phoenix.Overrides.Overridable,
root_class: "CSS class for the root `div` element.",
strategy_class: "CSS class for a `div` surrounding each strategy component.",
show_banner: "Whether or not to show the banner.",
authentication_error_container_class:
"CSS class for the container for the text of the authentication error.",
authentication_error_text_class: "CSS class for the authentication error text.",
strategy_display_order:
"Whether to display the form or link strategies first. Accepted values are `:forms_first` or `:links_first`."
@moduledoc """
Renders sign in mark-up for an authenticated resource.
This means that it will render sign-in UI for all of the authentication
strategies for a resource.
For each strategy configured on the resource a component name is inferred
(e.g. `AshAuthentication.Strategy.Password` becomes
`AshAuthentication.Phoenix.Components.Password`) and is rendered into the
output.
## Component hierarchy
This is the top-most authentication component.
Children:
* `AshAuthentication.Phoenix.Components.Password`.
* `AshAuthentication.Phoenix.Components.OAuth2`.
#{AshAuthentication.Phoenix.Overrides.Overridable.generate_docs()}
## Props
* `otp_app` - The otp app to look for authenticated resources in
* `live_action` - The live_action being routed to
* `path` - The path to use as the base for links
* `reset_path` - The path to use for reset links
* `register_path` - The path to use for register links
* `overrides` - A list of override modules.
* `gettext_fn` - Optional text translation function.
"""
use AshAuthentication.Phoenix.Web, :live_component
alias AshAuthentication.{Info, Phoenix.Components, Strategy}
alias Phoenix.LiveView.{Rendered, Socket}
import AshAuthentication.Phoenix.Components.Helpers
import Slug
@type props :: %{
optional(:path) => String.t(),
optional(:reset_path) => String.t(),
optional(:register_path) => String.t(),
optional(:current_tenant) => String.t(),
optional(:context) => map(),
optional(:overrides) => [module],
optional(:resources) => [module],
optional(:gettext_fn) => {module, atom}
}
@doc false
@impl true
@spec update(props, Socket.t()) :: {:ok, Socket.t()}
def update(assigns, socket) do
socket = assign(socket, assigns)
strategies_by_resource =
socket.assigns[:resources]
|> Kernel.||(
socket
|> otp_app_from_socket()
|> AshAuthentication.authenticated_resources()
)
|> Enum.sort_by(&Info.authentication_subject_name!/1)
|> Enum.map(fn resource ->
resource
|> Info.authentication_strategies()
|> Enum.group_by(&strategy_style/1)
|> Map.update(:form, [], &sort_strategies_by_name/1)
|> Map.update(:link, [], &sort_strategies_by_name/1)
end)
socket =
socket
|> assign(:strategies_by_resource, strategies_by_resource)
|> assign_new(:overrides, fn -> [AshAuthentication.Phoenix.Overrides.Default] end)
|> assign_new(:gettext_fn, fn -> nil end)
|> assign_new(:live_action, fn -> :sign_in end)
|> assign_new(:path, fn -> "/" end)
|> assign_new(:reset_path, fn -> nil end)
|> assign_new(:register_path, fn -> nil end)
|> assign_new(:current_tenant, fn -> nil end)
|> assign_new(:context, fn -> %{} end)
|> assign_new(:auth_routes_prefix, fn -> nil end)
{:ok, socket}
end
@doc false
@impl true
@spec render(Socket.assigns()) :: Rendered.t() | no_return
def render(assigns) do
~H"""
<div class={override_for(@overrides, :root_class)}>
<%= if override_for(@overrides, :show_banner, true) do %>
<.live_component
module={Components.Banner}
id="sign-in-banner"
overrides={@overrides}
gettext_fn={@gettext_fn}
/>
<% end %>
<%= for {strategies, i} <- Enum.with_index(@strategies_by_resource) do %>
<% [top_strategies, bottom_strategies] = ordered_strategies(@overrides, strategies) %>
<.strategies
live_action={@live_action}
strategies={top_strategies}
path={@path}
auth_routes_prefix={@auth_routes_prefix}
reset_path={@reset_path}
register_path={@register_path}
overrides={@overrides}
current_tenant={@current_tenant}
context={@context}
gettext_fn={@gettext_fn}
/>
<%= if Enum.any?(strategies.form) && Enum.any?(strategies.link) do %>
<.live_component
module={Components.HorizontalRule}
id={"sign-in-hr-#{i}"}
overrides={@overrides}
/>
<% end %>
<.strategies
live_action={@live_action}
strategies={bottom_strategies}
auth_routes_prefix={@auth_routes_prefix}
path={@path}
reset_path={@reset_path}
register_path={@register_path}
overrides={@overrides}
current_tenant={@current_tenant}
context={@context}
gettext_fn={@gettext_fn}
/>
<% end %>
</div>
"""
end
defp strategies(assigns) do
~H"""
<%= if Enum.any?(@strategies) do %>
<div :for={strategy <- @strategies} class={override_for(@overrides, :strategy_class)}>
<.live_component
module={component_for_strategy(strategy)}
id={strategy_id(strategy)}
strategy={strategy}
auth_routes_prefix={@auth_routes_prefix}
path={@path}
reset_path={@reset_path}
register_path={@register_path}
live_action={@live_action}
overrides={@overrides}
current_tenant={@current_tenant}
context={@context}
gettext_fn={@gettext_fn}
/>
</div>
<% end %>
"""
end
defp sort_strategies_by_name(strategies), do: Enum.sort_by(strategies, & &1.name)
defp ordered_strategies(overrides, strategy_group) do
case override_for(overrides, :strategy_display_order, :forms_first) do
:links_first ->
[strategy_group.link, strategy_group.form]
_ ->
[strategy_group.form, strategy_group.link]
end
end
defp strategy_id(strategy) do
subject_name =
strategy.resource
|> Info.authentication_subject_name!()
"sign-in-#{subject_name}-with-#{strategy.name}"
|> slugify()
end
defp strategy_style(%AshAuthentication.AddOn.Confirmation{}), do: nil
defp strategy_style(%Strategy.Password{}), do: :form
defp strategy_style(%Strategy.MagicLink{}), do: :link
defp strategy_style(_), do: :link
defp component_for_strategy(%{strategy_module: Strategy.Apple}), do: Components.Apple
defp component_for_strategy(strategy) do
strategy.__struct__
|> Module.split()
|> List.replace_at(1, "Components")
|> List.insert_at(1, "Phoenix")
|> Module.concat()
end
end