Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Always expire SSO User sessions after `identity.expires_at` (#5429)

Adrian Gruntkowskib341f2735a19
diff --git a/lib/plausible/auth/user_session.ex b/lib/plausible/auth/user_session.ex
index 48d4018080..8e351c6e39 100644
--- a/lib/plausible/auth/user_session.ex
+++ b/lib/plausible/auth/user_session.ex
@@ -4,6 +4,7 @@ defmodule Plausible.Auth.UserSession do
"""
use Ecto.Schema
+ use Plausible
import Ecto.Changeset
@@ -37,12 +38,36 @@ defmodule Plausible.Auth.UserSession do
|> touch_session(now)
end
+ @spec new_sso_session(Auth.User.t(), String.t(), NaiveDateTime.t(), NaiveDateTime.t()) ::
+ Ecto.Changeset.t()
+ def new_sso_session(user, device, timeout_at, now \\ NaiveDateTime.utc_now(:second)) do
+ %__MODULE__{}
+ |> cast(%{device: device}, [:device])
+ |> generate_token()
+ |> put_assoc(:user, user)
+ |> put_change(:timeout_at, timeout_at)
+ |> touch_session(now)
+ end
+
@spec touch_session(t() | Ecto.Changeset.t(), NaiveDateTime.t()) :: Ecto.Changeset.t()
def touch_session(session, now \\ NaiveDateTime.utc_now(:second)) do
- session
- |> change()
- |> put_change(:last_used_at, now)
- |> put_change(:timeout_at, NaiveDateTime.shift(now, @timeout))
+ changeset = change(session)
+
+ on_ee do
+ case get_field(changeset, :user) do
+ %{type: :sso} ->
+ put_change(changeset, :last_used_at, now)
+
+ _ ->
+ changeset
+ |> put_change(:last_used_at, now)
+ |> put_change(:timeout_at, NaiveDateTime.shift(now, @timeout))
+ end
+ else
+ changeset
+ |> put_change(:last_used_at, now)
+ |> put_change(:timeout_at, NaiveDateTime.shift(now, @timeout))
+ end
end
defp generate_token(changeset) do
diff --git a/lib/plausible_web/user_auth.ex b/lib/plausible_web/user_auth.ex
index bdc1b8ee32..4c594932e7 100644
--- a/lib/plausible_web/user_auth.ex
+++ b/lib/plausible_web/user_auth.ex
@@ -26,15 +26,11 @@ defmodule PlausibleWeb.UserAuth do
def log_in_user(conn, subject, redirect_path \\ nil)
def log_in_user(conn, %Auth.User{} = user, redirect_path) do
- redirect_to =
- if String.starts_with?(redirect_path || "", "/") do
- redirect_path
- else
- Routes.site_path(conn, :index)
- end
+ redirect_to = login_redirect_path(conn, redirect_path)
+ {token, _} = create_user_session(conn, user)
conn
- |> set_user_session(user)
+ |> set_user_token(token)
|> set_logged_in_cookie()
|> Phoenix.Controller.redirect(to: redirect_to)
end
@@ -47,7 +43,13 @@ defmodule PlausibleWeb.UserAuth do
:ok = revoke_all_user_sessions(user)
end
- log_in_user(conn, user, redirect_path)
+ redirect_to = login_redirect_path(conn, redirect_path)
+ {token, _} = create_sso_user_session(conn, user, identity.expires_at)
+
+ conn
+ |> set_user_token(token)
+ |> set_logged_in_cookie()
+ |> Phoenix.Controller.redirect(to: redirect_to)
{:error, :integration_not_found} ->
conn
@@ -60,6 +62,17 @@ defmodule PlausibleWeb.UserAuth do
log_in_user(conn, user, redirect_path)
end
end
+
+ defp create_sso_user_session(conn, user, expires_at) do
+ device_name = get_device_name(conn)
+
+ user_session =
+ user
+ |> Auth.UserSession.new_sso_session(device_name, expires_at)
+ |> Repo.insert!()
+
+ {user_session.token, user_session}
+ end
end
@spec log_out_user(Plug.Conn.t()) :: Plug.Conn.t()
@@ -96,6 +109,7 @@ defmodule PlausibleWeb.UserAuth do
Plausible.Users.bump_last_seen(user_session.user_id, now)
user_session
+ |> Repo.preload(:user)
|> Auth.UserSession.touch_session(now)
|> Repo.update!(allow_stale: true)
else
@@ -188,15 +202,21 @@ defmodule PlausibleWeb.UserAuth do
end
end
- defp set_user_session(conn, user) do
- {token, _} = create_user_session(conn, user)
-
+ defp set_user_token(conn, token) do
conn
|> renew_session()
|> TwoFactor.Session.clear_2fa_user()
|> put_token_in_session(token)
end
+ defp login_redirect_path(conn, redirect_path) do
+ if String.starts_with?(redirect_path || "", "/") do
+ redirect_path
+ else
+ Routes.site_path(conn, :index)
+ end
+ end
+
defp renew_session(conn) do
Phoenix.Controller.delete_csrf_token()
diff --git a/test/plausible_web/plugs/user_session_touch_test.exs b/test/plausible_web/plugs/user_session_touch_test.exs
index 437873abe4..3ecfb9ca61 100644
--- a/test/plausible_web/plugs/user_session_touch_test.exs
+++ b/test/plausible_web/plugs/user_session_touch_test.exs
@@ -10,7 +10,7 @@ defmodule PlausibleWeb.Plugs.UserSessionTouchTest do
test "refreshes session", %{conn: conn, user: user} do
now = NaiveDateTime.utc_now(:second)
one_day_ago = NaiveDateTime.shift(now, day: -1)
- %{sessions: [user_session]} = Repo.preload(user, :sessions)
+ %{sessions: [user_session]} = Repo.preload(user, sessions: :user)
user_session
|> Plausible.Auth.UserSession.touch_session(one_day_ago)
diff --git a/test/plausible_web/user_auth_test.exs b/test/plausible_web/user_auth_test.exs
index a4c5c67607..358b8601f2 100644
--- a/test/plausible_web/user_auth_test.exs
+++ b/test/plausible_web/user_auth_test.exs
@@ -10,6 +10,10 @@ defmodule PlausibleWeb.UserAuthTest do
alias Plausible.Repo
alias PlausibleWeb.UserAuth
+ on_ee do
+ alias Plausible.Auth.SSO
+ end
+
alias PlausibleWeb.Router.Helpers, as: Routes
describe "log_in_user/2,3" do
@@ -44,8 +48,6 @@ defmodule PlausibleWeb.UserAuthTest do
end
on_ee do
- alias Plausible.Auth.SSO
-
test "sets up user session from SSO identity", %{conn: conn, user: user} do
team = new_site().team
integration = SSO.initiate_saml_integration(team)
@@ -65,6 +67,7 @@ defmodule PlausibleWeb.UserAuthTest do
assert %{sessions: [session]} = user |> Repo.reload!() |> Repo.preload(:sessions)
assert session.user_id == user.id
+ assert NaiveDateTime.compare(session.timeout_at, identity.expires_at) == :eq
assert redirected_to(conn, 302) == Routes.site_path(conn, :index)
assert conn.private[:plug_session_info] == :renew
@@ -282,6 +285,29 @@ defmodule PlausibleWeb.UserAuthTest do
refute Repo.reload(user_session)
end
+
+ on_ee do
+ test "only records last usage but does not refresh for SSO user", %{user: user} do
+ sixty_five_minutes_later =
+ NaiveDateTime.utc_now(:second)
+ |> NaiveDateTime.shift(minute: 65)
+
+ user = user |> Ecto.Changeset.change(type: :sso) |> Repo.update!()
+
+ %{sessions: [session]} = Repo.preload(user, :sessions)
+
+ assert refreshed_session =
+ %Auth.UserSession{} =
+ UserAuth.touch_user_session(session, sixty_five_minutes_later)
+
+ assert refreshed_session.id == session.id
+
+ assert NaiveDateTime.compare(refreshed_session.last_used_at, sixty_five_minutes_later) ==
+ :eq
+
+ assert NaiveDateTime.compare(refreshed_session.timeout_at, session.timeout_at) == :eq
+ end
+ end
end
describe "revoke_user_session/2" do