defmodule WhoNeedHelpWeb.UserAuth do use WhoNeedHelpWeb, :verified_routes use Gettext, backend: WhoNeedHelpWeb.Gettext import Plug.Conn import Phoenix.Controller alias WhoNeedHelp.Accounts alias WhoNeedHelp.Accounts.Scope # Make the remember me cookie valid for 14 days. This should match # the session validity setting in UserToken. @max_cookie_age_in_days 14 @remember_me_cookie "_who_need_help_web_user_remember_me" @remember_me_options [ sign: true, max_age: @max_cookie_age_in_days * 24 * 60 * 60, same_site: "Lax" ] # How old the session token should be before a new one is issued. When a request is made # with a session token older than this value, then a new session token will be created # and the session and remember-me cookies (if set) will be updated with the new token. # Lowering this value will result in more tokens being created by active users. Increasing # it will result in less time before a session token expires for a user to get issued a new # token. This can be set to a value greater than `@max_cookie_age_in_days` to disable # the reissuing of tokens completely. @session_reissue_age_in_days 7 @doc """ Logs the user in. Redirects to the session's `:user_return_to` path or falls back to the `signed_in_path/1`. """ def log_in_user(conn, user, params \\ %{}) do user_return_to = get_session(conn, :user_return_to) conn |> create_or_extend_session(user, params) |> redirect(to: user_return_to || signed_in_path(conn)) end @doc """ Logs the user out. It clears all session data for safety. See renew_session. """ def log_out_user(conn) do user_token = get_session(conn, :user_token) user_token && Accounts.delete_user_session_token(user_token) if live_socket_id = get_session(conn, :live_socket_id) do WhoNeedHelpWeb.Endpoint.broadcast(live_socket_id, "disconnect", %{}) end conn |> renew_session(nil) |> delete_resp_cookie(@remember_me_cookie, @remember_me_options) |> redirect(to: ~p"/") end @doc """ Authenticates the user by looking into the session and remember me token. Will reissue the session token if it is older than the configured age. """ def fetch_current_scope_for_user(conn, _opts) do with {token, conn} <- ensure_user_token(conn), {user, token_inserted_at} <- Accounts.get_user_by_session_token(token) do conn |> assign(:current_scope, Scope.for_user(user)) |> maybe_reissue_user_session_token(user, token_inserted_at) else nil -> assign(conn, :current_scope, Scope.for_user(nil)) end end defp ensure_user_token(conn) do if token = get_session(conn, :user_token) do {token, conn} else conn = fetch_cookies(conn, signed: [@remember_me_cookie]) if token = conn.cookies[@remember_me_cookie] do {token, conn |> put_token_in_session(token) |> put_session(:user_remember_me, true)} else nil end end end # Reissue the session token if it is older than the configured reissue age. defp maybe_reissue_user_session_token(conn, user, token_inserted_at) do token_age = DateTime.diff(DateTime.utc_now(:second), token_inserted_at, :day) if token_age >= @session_reissue_age_in_days do create_or_extend_session(conn, user, %{}) else conn end end # This function is the one responsible for creating session tokens # and storing them safely in the session and cookies. It may be called # either when logging in, during sudo mode, or to renew a session which # will soon expire. # # When the session is created, rather than extended, the renew_session # function will clear the session to avoid fixation attacks. See the # renew_session function to customize this behaviour. defp create_or_extend_session(conn, user, params) do token = Accounts.generate_user_session_token(user) remember_me = get_session(conn, :user_remember_me) conn |> renew_session(user) |> put_token_in_session(token) |> maybe_write_remember_me_cookie(token, params, remember_me) end # Do not renew session if the user is already logged in # to prevent CSRF errors or data being lost in tabs that are still open defp renew_session(conn, user) when conn.assigns.current_scope.user.id == user.id do conn end # This function renews the session ID and erases the whole # session to avoid fixation attacks. If there is any data # in the session you may want to preserve after log in/log out, # you must explicitly fetch the session data before clearing # and then immediately set it after clearing, for example: # # defp renew_session(conn, _user) do # delete_csrf_token() # preferred_locale = get_session(conn, :preferred_locale) # # conn # |> configure_session(renew: true) # |> clear_session() # |> put_session(:preferred_locale, preferred_locale) # end # defp renew_session(conn, _user) do delete_csrf_token() conn |> configure_session(renew: true) |> clear_session() end defp maybe_write_remember_me_cookie(conn, token, %{"remember_me" => "true"}, _), do: write_remember_me_cookie(conn, token) defp maybe_write_remember_me_cookie(conn, token, _params, true), do: write_remember_me_cookie(conn, token) defp maybe_write_remember_me_cookie(conn, _token, _params, _), do: conn defp write_remember_me_cookie(conn, token) do conn |> put_session(:user_remember_me, true) |> put_resp_cookie(@remember_me_cookie, token, @remember_me_options) end defp put_token_in_session(conn, token) do put_session(conn, :user_token, token) end @doc """ Plug for routes that require sudo mode. """ def require_sudo_mode(conn, _opts) do if Accounts.sudo_mode?(conn.assigns.current_scope.user, -10) do conn else conn |> put_flash(:error, gettext("You must re-authenticate to access this page.")) |> maybe_store_return_to() |> redirect(to: ~p"/users/log-in") |> halt() end end @doc """ Plug for routes that require the user to not be authenticated. """ def redirect_if_user_is_authenticated(conn, _opts) do if conn.assigns.current_scope do conn |> redirect(to: signed_in_path(conn)) |> halt() else conn end end defp signed_in_path(_conn), do: ~p"/" @doc """ Plug for routes that require the user to be authenticated. """ def require_authenticated_user(conn, _opts) do if conn.assigns.current_scope && conn.assigns.current_scope.user do conn else conn |> put_flash(:error, gettext("You must log in to access this page.")) |> maybe_store_return_to() |> redirect(to: ~p"/users/log-in") |> halt() end end defp maybe_store_return_to(%{method: "GET"} = conn) do put_session(conn, :user_return_to, current_path(conn)) end defp maybe_store_return_to(conn), do: conn @doc "Loads the generated session token into LiveView's current scope." def on_mount(:mount_current_scope, _params, session, socket) do scope = live_scope(session) set_live_locale(scope, session) {:cont, Phoenix.Component.assign(socket, :current_scope, scope)} end def on_mount(:ensure_authenticated, _params, session, socket) do case live_scope(session) do %Scope{user: %Accounts.User{}} = scope -> set_live_locale(scope, session) {:cont, Phoenix.Component.assign(socket, :current_scope, scope)} _ -> socket = socket |> Phoenix.Component.assign(:current_scope, nil) |> Phoenix.LiveView.put_flash( :error, gettext("You must log in to access this page.") ) |> Phoenix.LiveView.redirect(to: ~p"/users/log-in") {:halt, socket} end end def on_mount(:ensure_moderator, _params, session, socket) do case live_scope(session) do %Scope{user: %Accounts.User{} = user} = scope -> if Accounts.moderator_authorized?(user) do set_live_locale(scope, session) {:cont, Phoenix.Component.assign(socket, :current_scope, scope)} else socket = socket |> Phoenix.Component.assign(:current_scope, scope) |> Phoenix.LiveView.put_flash(:error, gettext("Moderator access is required.")) |> Phoenix.LiveView.redirect(to: ~p"/requests") {:halt, socket} end _ -> socket = socket |> Phoenix.Component.assign(:current_scope, nil) |> Phoenix.LiveView.put_flash( :error, gettext("You must log in to access this page.") ) |> Phoenix.LiveView.redirect(to: ~p"/users/log-in") {:halt, socket} end end defp live_scope(%{"user_token" => token}) do case Accounts.get_user_by_session_token(token) do {user, _inserted_at} -> Scope.for_user(user) nil -> nil end end defp live_scope(_session), do: nil defp set_live_locale(_scope, %{"locale" => locale}) when locale in ~w(en uk ru) do Gettext.put_locale(WhoNeedHelpWeb.Gettext, locale) end defp set_live_locale(%Scope{user: %{locale: locale}}, _session) when locale in ~w(en uk ru) do Gettext.put_locale(WhoNeedHelpWeb.Gettext, locale) end defp set_live_locale(_scope, _session), do: Gettext.put_locale(WhoNeedHelpWeb.Gettext, "en") end