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
No longer require domain to seek Plugins API Tokens (#3409)
hq199efb930828f
diff --git a/lib/plausible/plugins/api/tokens.ex b/lib/plausible/plugins/api/tokens.exindex b5ab19a689..ceb9b7a871 100644--- a/lib/plausible/plugins/api/tokens.ex+++ b/lib/plausible/plugins/api/tokens.ex@@ -18,15 +18,14 @@ defmodule Plausible.Plugins.API.Tokens doendend- @spec find(String.t(), String.t()) :: {:ok, Token.t()} | {:error, :not_found}- def find(domain, raw) do+ @spec find(String.t()) :: {:ok, Token.t()} | {:error, :not_found}+ def find(raw) dofound =Repo.one(from(t in Token,inner_join: s in Site,on: s.id == t.site_id,where: t.token_hash == ^Token.hash(raw),- where: s.domain == ^domain or s.domain_changed_from == ^domain,preload: [:site]))diff --git a/lib/plausible_web/plugins/api/spec.ex b/lib/plausible_web/plugins/api/spec.exindex 31e0ba5a22..26d0720d31 100644--- a/lib/plausible_web/plugins/api/spec.ex+++ b/lib/plausible_web/plugins/api/spec.ex@@ -28,8 +28,9 @@ defmodule PlausibleWeb.Plugins.API.Spec dotype: "http",scheme: "basic",description: """- HTTP basic access authentication using your Site domain as the+ HTTP basic access authentication using your Site Domain as theusername and the Plugins API Token contents as the password.+ Note that Site Domain is optional, a password alone suffices.For more information seehttps://en.wikipedia.org/wiki/Basic_access_authenticationdiff --git a/lib/plausible_web/plugs/authorize_plugins_api.ex b/lib/plausible_web/plugs/authorize_plugins_api.exindex d4dacff17b..07460f5434 100644--- a/lib/plausible_web/plugs/authorize_plugins_api.ex+++ b/lib/plausible_web/plugs/authorize_plugins_api.ex@@ -6,18 +6,19 @@ defmodule PlausibleWeb.Plugs.AuthorizePluginsAPI doalias PlausibleWeb.Plugins.API.Errorsalias Plausible.Plugins.API.Tokens+ import Plug.Conndef init(opts), do: optsdef call(conn, _opts \\ []) do- with {:ok, domain, token} <- extract_token(conn),- {:ok, conn} <- authorize(conn, domain, token) do+ with {:ok, token} <- extract_token(conn),+ {:ok, conn} <- authorize(conn, token) doconnendend- defp authorize(conn, domain, token_value) do- case Tokens.find(domain, token_value) do+ defp authorize(conn, token_value) do+ case Tokens.find(token_value) do{:ok, token} ->{:ok, Plug.Conn.assign(conn, :authorized_site, token.site)}@@ -27,11 +28,14 @@ defmodule PlausibleWeb.Plugs.AuthorizePluginsAPI doenddefp extract_token(conn) do- case Plug.BasicAuth.parse_basic_auth(conn) do- {token_identifier, token_value} ->- {:ok, token_identifier, token_value}-- :error ->+ with ["Basic " <> encoded_user_and_pass] <- get_req_header(conn, "authorization"),+ {:ok, decoded_user_and_pass} <- Base.decode64(encoded_user_and_pass) do+ case :binary.split(decoded_user_and_pass, ":") do+ [_user, token_value] -> {:ok, token_value}+ [token_value] -> {:ok, token_value}+ end+ else+ _ ->Errors.unauthorized(conn)endenddiff --git a/test/plausible/plugins/api/tokens_test.exs b/test/plausible/plugins/api/tokens_test.exsindex fedaa3e282..d1be798739 100644--- a/test/plausible/plugins/api/tokens_test.exs+++ b/test/plausible/plugins/api/tokens_test.exs@@ -31,26 +31,13 @@ defmodule Plausible.Plugins.API.TokensTest dotest "finds the right token" dosite = insert(:site)assert {:ok, _, raw} = Tokens.create(site, "My test token")- assert {:ok, found} = Tokens.find(site.domain, raw)+ assert {:ok, found} = Tokens.find(raw)assert found.id == found.id- end-- test "finds the right token after domain change" do- site = insert(:site, domain: "foo1.example.com")- assert {:ok, _, raw} = Tokens.create(site, "My test token")-- {:ok, _} = Plausible.Site.Domain.change(site, "foo2.example.com")-- assert {:ok, found} = Tokens.find("foo1.example.com", raw)- assert {:ok, ^found} = Tokens.find("foo2.example.com", raw)+ assert found.site_id == site.idendtest "fails to find the token" do- site = insert(:site)- assert {:ok, _, _} = Tokens.create(site, "My test token")-- assert {:error, :not_found} = Tokens.find(site.domain, "non-existing")- assert {:error, :not_found} = Tokens.find("non-existing", "non-existing")+ assert {:error, :not_found} = Tokens.find("non-existing")endendenddiff --git a/test/plausible_web/plugs/authorize_plugins_api_test.exs b/test/plausible_web/plugs/authorize_plugins_api_test.exsindex a0ca9f4ee3..e1914043f9 100644--- a/test/plausible_web/plugs/authorize_plugins_api_test.exs+++ b/test/plausible_web/plugs/authorize_plugins_api_test.exs@@ -21,6 +21,21 @@ defmodule PlausibleWeb.Plugs.AuthorizePluginsAPITest doassert %Plausible.Site{id: ^site_id} = conn.assigns.authorized_siteend+ test "plug passes when a token is found, no domain provided" do+ %{id: site_id} = site = insert(:site, domain: "pass.example.com")+ {:ok, _, raw} = Tokens.create(site, "Some token")++ credentials = "Basic " <> Base.encode64(raw)++ conn =+ build_conn()+ |> put_req_header("authorization", credentials)+ |> AuthorizePluginsAPI.call()++ refute conn.halted+ assert %Plausible.Site{id: ^site_id} = conn.assigns.authorized_site+ end+test "plug halts when a token is not found" dosite = insert(:site, domain: "pass.example.com")