Skip to content

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

Limit docs query API, return 401 for API routes (#4570)

Karl-Aksel Puulmanndd1021eff3c0
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 074ba7df9a..fa59728637 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -39,6 +39,7 @@ All notable changes to this project will be documented in this file.
- Improve Google error messages in CE plausible/analytics#4485
- Better compress static assets in CE plausible/analytics#4476
- Return domain-less cookies in CE plausible/analytics#4482
+- Internal stats API routes now return a JSON error over HTML in case of invalid access.
### Fixed
diff --git a/lib/plausible_web/plugs/authorize_site_access.ex b/lib/plausible_web/plugs/authorize_site_access.ex
index 0f8cd981b7..dc2572916e 100644
--- a/lib/plausible_web/plugs/authorize_site_access.ex
+++ b/lib/plausible_web/plugs/authorize_site_access.ex
@@ -1,5 +1,6 @@
defmodule PlausibleWeb.AuthorizeSiteAccess do
import Plug.Conn
+ import Phoenix.Controller, only: [get_format: 1]
use Plausible.Repo
def init([]), do: [:public, :viewer, :admin, :super_admin, :owner]
@@ -18,7 +19,7 @@ defmodule PlausibleWeb.AuthorizeSiteAccess do
shared_link_auth && Repo.get_by(Plausible.Site.SharedLink, slug: shared_link_auth)
if !site do
- PlausibleWeb.ControllerHelpers.render_error(conn, 404) |> halt
+ fail(conn)
else
user_id =
case PlausibleWeb.UserAuth.get_user_session(conn) do
@@ -57,8 +58,21 @@ defmodule PlausibleWeb.AuthorizeSiteAccess do
merge_assigns(conn, site: site, current_user_role: role)
else
- PlausibleWeb.ControllerHelpers.render_error(conn, 404) |> halt
+ fail(conn)
end
end
end
+
+ defp fail(conn) do
+ case get_format(conn) do
+ "json" ->
+ PlausibleWeb.Api.Helpers.not_found(
+ conn,
+ "Site does not exist or user does not have sufficient access."
+ )
+
+ _ ->
+ PlausibleWeb.ControllerHelpers.render_error(conn, 404) |> halt
+ end
+ end
end
diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex
index 5edb275981..fb601c259d 100644
--- a/lib/plausible_web/router.ex
+++ b/lib/plausible_web/router.ex
@@ -48,6 +48,16 @@ defmodule PlausibleWeb.Router do
plug PlausibleWeb.Plugs.NoRobots
end
+ pipeline :docs_stats_api do
+ plug :accepts, ["json"]
+ plug :fetch_session
+ plug PlausibleWeb.AuthPlug
+
+ plug PlausibleWeb.AuthorizeSiteAccess, [:admin, :super_admin, :owner]
+
+ plug PlausibleWeb.Plugs.NoRobots
+ end
+
pipeline :public_api do
plug :accepts, ["json"]
end
@@ -191,7 +201,7 @@ defmodule PlausibleWeb.Router do
get "/query/schema.json", ExternalQueryApiController, :schema
scope [] do
- pipe_through :internal_stats_api
+ pipe_through :docs_stats_api
post "/query", ExternalQueryApiController, :query
end
diff --git a/test/plausible_web/plugs/authorise_site_access_test.exs b/test/plausible_web/plugs/authorise_site_access_test.exs
index d8fb8bbd47..ddc8d91ad5 100644
--- a/test/plausible_web/plugs/authorise_site_access_test.exs
+++ b/test/plausible_web/plugs/authorise_site_access_test.exs
@@ -14,10 +14,26 @@ defmodule PlausibleWeb.AuthorizeSiteAccessTest do
conn
|> bypass_through(PlausibleWeb.Router)
|> get("/#{other_site.domain}/settings", %{"domain" => my_site.domain})
- |> AuthorizeSiteAccess.call(_allowed_roles = [:admin, :owner])
+ |> AuthorizeSiteAccess.call([:admin, :owner])
assert conn.halted
assert conn.status == 404
assert conn.path_params == %{"website" => other_site.domain}
end
+
+ test "returns 404 with custom error message for failed API routes", %{conn: conn, user: user} do
+ site = insert(:site, memberships: [build(:site_membership, user: user, role: :viewer)])
+
+ conn =
+ conn
+ |> bypass_through(PlausibleWeb.Router)
+ |> get("/api/stats/#{site.domain}/main-graph")
+ |> AuthorizeSiteAccess.call([:admin, :owner, :super_admin])
+
+ assert conn.halted
+ assert conn.status == 404
+
+ assert conn.resp_body ==
+ "{\"error\":\"Site does not exist or user does not have sufficient access.\"}"
+ end
end