Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Allow configuring `AuthorizeSiteAccess` plug site param (#4597)
Artur Patacac4ad20c9d7
diff --git a/config/dev.exs b/config/dev.exsindex 997825eb29..ecfa88de89 100644--- a/config/dev.exs+++ b/config/dev.exs@@ -8,7 +8,7 @@ config :plausible, PlausibleWeb.Endpoint,watchers: [esbuild: {Esbuild, :install_and_run, [:default, ~w(--sourcemap=inline --watch)]},tailwind: {Tailwind, :install_and_run, [:default, ~w(--watch)]},- npm: ["--prefix", "assets", "run", "typecheck", "--", "--watch"],+ npm: ["--prefix", "assets", "run", "typecheck", "--", "--watch", "--preserveWatchOutput"],npm: ["run","deploy",diff --git a/lib/plausible_web/plugs/authorize_site_access.ex b/lib/plausible_web/plugs/authorize_site_access.exindex c33c6185eb..651eda6e43 100644--- a/lib/plausible_web/plugs/authorize_site_access.ex+++ b/lib/plausible_web/plugs/authorize_site_access.ex@@ -1,6 +1,36 @@defmodule PlausibleWeb.Plugs.AuthorizeSiteAccess do@moduledoc """Plug restricting access to site and shared link, when present.++ In order to permit access to site regardless of role:++ ```elixir+ plug AuthorizeSiteAccess+ ```++ or++ ```elixir+ plug AuthorizeSiteAccess, :all_roles+ ```++ Permit access for a subset of roles only:++ ```elixir+ plug AuthorizeSiteAccess, [:admin, :owner, :super_admin]+ ```++ Permit access using a custom site param:++ ```elixir+ plug AuthorizeSiteAccess, {[:admin, :owner, :super_admin], "site_id"}+ ```++ or in case where any role is allowed:++ ```elixir+ plug AuthorizeSiteAccess, {:all_roles, "site_id"}+ ```"""use Plausible.Repo@@ -10,22 +40,45 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccess do@all_roles [:public, :viewer, :admin, :super_admin, :owner]- def init([]), do: @all_roles+ def init([]), do: {@all_roles, nil}++ def init(:all_roles), do: {@all_roles, nil}++ def init(allowed_roles) when is_list(allowed_roles) do+ init({allowed_roles, nil})+ end++ def init({:all_roles, site_param}) do+ init({@all_roles, site_param})+ end++ def init({allowed_roles, site_param}) when is_list(allowed_roles) do+ allowed_roles =+ if allowed_roles == [] do+ @all_roles+ else+ allowed_roles+ end- def init(allowed_roles) dounknown_roles = allowed_roles -- @all_rolesif unknown_roles != [] doraise ArgumentError, "Unknown allowed roles configured: #{inspect(unknown_roles)}"end- allowed_roles+ if !is_binary(site_param) && !is_nil(site_param) do+ raise ArgumentError, "Invalid site param configured: #{inspect(site_param)}"+ end++ {allowed_roles, site_param}end- def call(conn, allowed_roles) do+ def call(conn, {allowed_roles, site_param}) docurrent_user = conn.assigns[:current_user]- with {:ok, %{site: site, role: membership_role}} <- get_site_with_role(conn, current_user),+ with {:ok, domain} <- get_domain(conn, site_param),+ {:ok, %{site: site, role: membership_role}} <-+ get_site_with_role(conn, current_user, domain),{:ok, shared_link} <- maybe_get_shared_link(conn, site) dorole =cond do@@ -63,13 +116,25 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccess doendend- defp get_site_with_role(conn, current_user) do- # addition is flimsy, do we need an extra argument on plug init to control where we look for the domain?- domain =- conn.path_params["domain"] ||- (conn.method == "POST" && conn.path_info == ["api", "docs", "query"] &&- conn.params["site_id"])+ defp get_domain(conn, nil) do+ if domain = conn.path_params["domain"] do+ {:ok, domain}+ else+ error_not_found(conn)+ end+ end++ defp get_domain(conn, site_param) do+ domain = conn.params[site_param]++ if is_binary(domain) do+ {:ok, domain}+ else+ error_not_found(conn)+ end+ end+ defp get_site_with_role(conn, current_user, domain) dosite_query =from(s in Plausible.Site,diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.exindex 3394eae25d..633c8c85ed 100644--- a/lib/plausible_web/router.ex+++ b/lib/plausible_web/router.ex@@ -50,7 +50,7 @@ defmodule PlausibleWeb.Router doplug :accepts, ["json"]plug :fetch_sessionplug PlausibleWeb.AuthPlug- plug PlausibleWeb.Plugs.AuthorizeSiteAccess, [:admin, :super_admin, :owner]+ plug PlausibleWeb.Plugs.AuthorizeSiteAccess, {[:admin, :super_admin, :owner], "site_id"}plug PlausibleWeb.Plugs.NoRobotsend@@ -99,6 +99,26 @@ defmodule PlausibleWeb.Router doendend+ # Routes for plug integration testing+ if Mix.env() in [:test, :ce_test] do+ scope "/plug-tests", PlausibleWeb do+ scope [] do+ pipe_through :browser++ get("/basic", TestController, :browser)+ get("/:domain/shared-link/:slug", TestController, :browser)+ get("/:domain/with-domain", TestController, :browser)+ end++ scope [] do+ pipe_through :api++ get("/api-basic", TestController, :api)+ get("/:domain/api-with-domain", TestController, :api)+ end+ end+ end+scope path: "/api/plugins", as: :plugins_api dopipeline :plugins_api_auth doplug(PlausibleWeb.Plugs.AuthorizePluginsAPI)diff --git a/test/plausible_web/controllers/api/internal_controller/docs_query_test.exs b/test/plausible_web/controllers/api/internal_controller/docs_query_test.exsindex 6106154976..5d96942804 100644--- a/test/plausible_web/controllers/api/internal_controller/docs_query_test.exs+++ b/test/plausible_web/controllers/api/internal_controller/docs_query_test.exs@@ -40,7 +40,20 @@ defmodule PlausibleWeb.Api.InternalController.DocsQueryTest do}end- test "returns aggregated metrics", %{conn: conn, site: site} do+ test "rejects when using invalid param name", %{conn: conn, site: site} do+ conn =+ post(conn, "/api/docs/query", %{+ "domain" => site.domain,+ "metrics" => ["pageviews"],+ "date_range" => "all"+ })++ assert json_response(conn, 404) == %{+ "error" => "Site does not exist or user does not have sufficient access."+ }+ end++ test "returns aggregated metrics when site id given", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, user_id: @user_id, timestamp: ~N[2021-01-01 00:00:00]),build(:pageview, user_id: @user_id, timestamp: ~N[2021-01-01 00:25:00]),@@ -48,7 +61,7 @@ defmodule PlausibleWeb.Api.InternalController.DocsQueryTest do])conn =- post(conn, "/api/docs/query", %{+ post(conn, "/api/docs/query?site_id=ignored_when_site_id_present_in_body", %{"site_id" => site.domain,"metrics" => ["pageviews"],"date_range" => "all"@@ -56,5 +69,22 @@ defmodule PlausibleWeb.Api.InternalController.DocsQueryTest doassert json_response(conn, 200)["results"] == [%{"metrics" => [3], "dimensions" => []}]end++ test "succeeds when site_id missing in body, but present in query params", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview, user_id: @user_id, timestamp: ~N[2021-01-01 00:00:00])+ ])++ conn =+ post(conn, "/api/docs/query?site_id=#{site.domain}", %{+ "metrics" => ["pageviews"],+ "date_range" => "all"+ })++ assert json_response(conn, 200)["results"] == [%{"metrics" => [1], "dimensions" => []}]+ endendenddiff --git a/test/plausible_web/plugs/authorize_site_access_test.exs b/test/plausible_web/plugs/authorize_site_access_test.exsindex 8690cc90a4..85c2686042 100644--- a/test/plausible_web/plugs/authorize_site_access_test.exs+++ b/test/plausible_web/plugs/authorize_site_access_test.exs@@ -10,43 +10,105 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest doendend+ for init_argument <- [+ [],+ :all_roles,+ {:all_roles, nil},+ {[:public, :viewer, :admin, :super_admin, :owner], nil}+ ] do+ test "init resolves to expected options with argument #{inspect(init_argument)}" do+ assert {[:public, :viewer, :admin, :super_admin, :owner], nil} ==+ AuthorizeSiteAccess.init(unquote(init_argument))+ end+ end++ for invalid_site_param <- [[], 1, :invalid] do+ test "init rejects invalid site_param #{inspect(invalid_site_param)}" do+ assert_raise ArgumentError, fn ->+ AuthorizeSiteAccess.init({[:super_admin], unquote(invalid_site_param)})+ end+ end+ end+test "returns 404 on non-existent site", %{conn: conn} do+ opts = AuthorizeSiteAccess.init(:all_roles)+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/invalid.domain")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [])+ |> get("/plug-tests/invalid.domain/with-domain")+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert html_response(conn, 404)endtest "rejects user completely unrelated to the site", %{conn: conn} do+ opts = AuthorizeSiteAccess.init(:all_roles)+site = insert(:site, members: [build(:user)])conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [])+ |> get("/plug-tests/#{site.domain}/with-domain")+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert html_response(conn, 404)end+ test "can be configured to expect site domain at conn.params['some_key'], fails when this is not met",+ %{+ conn: conn,+ site: site+ } do+ opts =+ AuthorizeSiteAccess.init({:all_roles, "some_key"})++ conn =+ conn+ |> bypass_through(PlausibleWeb.Router)+ |> get("/plug-tests/basic", %{"wrong_key" => site.domain})+ |> AuthorizeSiteAccess.call(opts)++ assert conn.halted+ assert conn.status == 404+ end++ test "can be configured to expect site domain at conn.params['some_key'], succeeds when it is met",+ %{+ conn: conn,+ site: site+ } do+ opts =+ AuthorizeSiteAccess.init({:all_roles, "some_key"})++ conn =+ conn+ |> bypass_through(PlausibleWeb.Router)+ |> get("/plug-tests/basic", %{"some_key" => site.domain})+ |> AuthorizeSiteAccess.call(opts)++ refute conn.halted+ assert conn.assigns.site.id == site.id+ end+test "doesn't allow bypassing :domain in path with :domain in query param", %{conn: conn,site: site} doother_site = insert(:site, members: [build(:user)])+ opts = AuthorizeSiteAccess.init([:admin, :owner])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/sites/#{other_site.domain}/change-domain", %{+ |> get("/plug-tests/#{other_site.domain}/with-domain", %{"domain" => site.domain})- |> AuthorizeSiteAccess.call(_allowed_roles = [:admin, :owner])+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert conn.status == 404@@ -56,11 +118,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dotest "returns 404 with custom error message for failed API routes", %{conn: conn, user: user} dosite = insert(:site, memberships: [build(:site_membership, user: user, role: :viewer)])+ opts = AuthorizeSiteAccess.init([:admin, :owner, :super_admin])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/api/stats/#{site.domain}/main-graph")- |> AuthorizeSiteAccess.call([:admin, :owner, :super_admin])+ |> get("/plug-tests/#{site.domain}/api-with-domain")+ |> AuthorizeSiteAccess.call(opts)assert conn.halted@@ -77,11 +141,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest doparams = %{"shared_link" => %{"name" => "some name"}}+ opts = AuthorizeSiteAccess.init([:super_admin, :admin, :owner])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> put("/sites/#{site.domain}/shared-links/#{shared_link_other_site.slug}", params)- |> AuthorizeSiteAccess.call(_allowed_roles = [:super_admin, :admin, :owner])+ |> get("/plug-tests/#{site.domain}/shared-link/#{shared_link_other_site.slug}", params)+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert conn.status == 404@@ -96,11 +162,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest doshared_link = insert(:shared_link, site: site)other_site = insert(:site, members: [user])+ opts = AuthorizeSiteAccess.init([:super_admin, :admin, :owner])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{other_site.domain}", %{"auth" => shared_link.slug})- |> AuthorizeSiteAccess.call(_all_allowed_roles = [])+ |> get("/plug-tests/#{other_site.domain}/with-domain", %{"auth" => shared_link.slug})+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert conn.status == 404@@ -119,11 +187,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest do"auth" => shared_link.slug}+ opts = AuthorizeSiteAccess.init([:super_admin, :admin, :owner])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> put("/sites/#{site.domain}/shared-links/#{shared_link_other_site.slug}", params)- |> AuthorizeSiteAccess.call(_allowed_roles = [:super_admin, :admin, :owner])+ |> get("/plug-tests/#{site.domain}/shared-link/#{shared_link_other_site.slug}", params)+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert conn.status == 404@@ -133,11 +203,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dosite =insert(:site, memberships: [build(:site_membership, user: user, role: :admin)])+ opts = AuthorizeSiteAccess.init([:owner])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [:owner])+ |> get("/plug-tests/#{site.domain}/with-domain")+ |> AuthorizeSiteAccess.call(opts)assert conn.haltedassert html_response(conn, 404)@@ -148,11 +220,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dosite =insert(:site, memberships: [build(:site_membership, user: user, role: unquote(role))])+ opts = AuthorizeSiteAccess.init([unquote(role)])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [unquote(role)])+ |> get("/plug-tests/#{site.domain}/with-domain")+ |> AuthorizeSiteAccess.call(opts)refute conn.haltedassert conn.assigns.site.id == site.id@@ -166,11 +240,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dopatch_env(:super_admin_user_ids, [user.id])+ opts = AuthorizeSiteAccess.init([:super_admin])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [:super_admin])+ |> get("/plug-tests/#{site.domain}/with-domain")+ |> AuthorizeSiteAccess.call(opts)refute conn.haltedassert conn.assigns.site.id == site.id@@ -180,11 +256,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dotest "allows user based on website visibility (authenticated user)", %{conn: conn} dosite = insert(:site, members: [build(:user)], public: true)+ opts = AuthorizeSiteAccess.init([:public])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [:public])+ |> get("/plug-tests/#{site.domain}/with-domain")+ |> AuthorizeSiteAccess.call(opts)refute conn.haltedassert conn.assigns.site.id == site.id@@ -193,11 +271,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dotest "allows user based on website visibility (anonymous request)" dosite = insert(:site, members: [build(:user)], public: true)+ opts = AuthorizeSiteAccess.init([:public])+conn =build_conn()|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}")- |> AuthorizeSiteAccess.call(_all_allowed_roles = [:public])+ |> get("/plug-tests/#{site.domain}/with-domain")+ |> AuthorizeSiteAccess.call(opts)refute conn.haltedassert conn.assigns.site.id == site.id@@ -207,11 +287,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dosite = insert(:site, members: [build(:user)])shared_link = insert(:shared_link, site: site)+ opts = AuthorizeSiteAccess.init([:public])+conn =conn|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}", %{"auth" => shared_link.slug})- |> AuthorizeSiteAccess.call(_all_allowed_roles = [:public])+ |> get("/plug-tests/#{site.domain}/with-domain", %{"auth" => shared_link.slug})+ |> AuthorizeSiteAccess.call(opts)refute conn.haltedassert conn.assigns.site.id == site.id@@ -221,11 +303,13 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccessTest dosite = insert(:site, members: [build(:user)])shared_link = insert(:shared_link, site: site)+ opts = AuthorizeSiteAccess.init([:public])+conn =build_conn()|> bypass_through(PlausibleWeb.Router)- |> get("/#{site.domain}", %{"auth" => shared_link.slug})- |> AuthorizeSiteAccess.call(_all_allowed_roles = [:public])+ |> get("/plug-tests/#{site.domain}/with-domain", %{"auth" => shared_link.slug})+ |> AuthorizeSiteAccess.call(opts)refute conn.haltedassert conn.assigns.site.id == site.iddiff --git a/test/support/test_controller.ex b/test/support/test_controller.exnew file mode 100644index 0000000000..053e6d6656--- /dev/null+++ b/test/support/test_controller.ex@@ -0,0 +1,11 @@+defmodule PlausibleWeb.TestController do+ use PlausibleWeb, :controller++ def browser_basic(conn, _params) do+ send_resp(conn, 200, "ok")+ end++ def api_basic(conn, _params) do+ send_resp(conn, 200, Jason.encode!(%{"ok" => true}))+ end+end