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
Implement Plugins API authorization (#3373)
hq1755345f4ba49
diff --git a/lib/plausible/plugins/api/tokens.ex b/lib/plausible/plugins/api/tokens.exindex 70d0be156f..cd3cff9625 100644--- a/lib/plausible/plugins/api/tokens.ex+++ b/lib/plausible/plugins/api/tokens.ex@@ -27,7 +27,8 @@ defmodule Plausible.Plugins.API.Tokens doinner_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+ where: s.domain == ^domain or s.domain_changed_from == ^domain,+ preload: [:site]))diff --git a/lib/plausible_web/plugins/api/errors.ex b/lib/plausible_web/plugins/api/errors.exnew file mode 100644index 0000000000..5c3a0980a7--- /dev/null+++ b/lib/plausible_web/plugins/api/errors.ex@@ -0,0 +1,31 @@+defmodule PlausibleWeb.Plugins.API.Errors do+ @moduledoc """+ Common responses for Plugins API+ """++ import Plug.Conn++ @spec unauthorized(Plug.Conn.t()) :: Plug.Conn.t()+ def unauthorized(conn) do+ conn+ |> put_resp_header("www-authenticate", ~s[Basic realm="Plugins API Access"])+ |> error(:unauthorized, "Plugins API: unauthorized")+ end++ @spec error(Plug.Conn.t(), Plug.Conn.status(), String.t() | [String.t()]) :: Plug.Conn.t()+ def error(conn, status, message) when is_binary(message) do+ error(conn, status, [message])+ end++ def error(conn, status, messages) when is_list(messages) do+ response =+ Jason.encode!(%{+ errors: Enum.map(messages, &%{detail: &1})+ })++ conn+ |> put_resp_content_type("application/json")+ |> send_resp(status, response)+ |> halt()+ end+enddiff --git a/lib/plausible_web/plugs/authorize_plugins_api.ex b/lib/plausible_web/plugs/authorize_plugins_api.exnew file mode 100644index 0000000000..d4dacff17b--- /dev/null+++ b/lib/plausible_web/plugs/authorize_plugins_api.ex@@ -0,0 +1,38 @@+defmodule PlausibleWeb.Plugs.AuthorizePluginsAPI do+ @moduledoc """+ Plug for Basic HTTP Authentication using+ Plugins API Tokens lookup.+ """++ alias PlausibleWeb.Plugins.API.Errors+ alias Plausible.Plugins.API.Tokens++ def init(opts), do: opts++ def call(conn, _opts \\ []) do+ with {:ok, domain, token} <- extract_token(conn),+ {:ok, conn} <- authorize(conn, domain, token) do+ conn+ end+ end++ defp authorize(conn, domain, token_value) do+ case Tokens.find(domain, token_value) do+ {:ok, token} ->+ {:ok, Plug.Conn.assign(conn, :authorized_site, token.site)}++ {:error, :not_found} ->+ Errors.unauthorized(conn)+ end+ end++ defp extract_token(conn) do+ case Plug.BasicAuth.parse_basic_auth(conn) do+ {token_identifier, token_value} ->+ {:ok, token_identifier, token_value}++ :error ->+ Errors.unauthorized(conn)+ end+ end+enddiff --git a/test/plausible_web/plugs/authorize_plugins_api_test.exs b/test/plausible_web/plugs/authorize_plugins_api_test.exsnew file mode 100644index 0000000000..a0ca9f4ee3--- /dev/null+++ b/test/plausible_web/plugs/authorize_plugins_api_test.exs@@ -0,0 +1,56 @@+defmodule PlausibleWeb.Plugs.AuthorizePluginsAPITest do+ use PlausibleWeb.ConnCase, async: true++ alias Plausible.Plugins.API.Tokens+ alias PlausibleWeb.Plugs.AuthorizePluginsAPI++ import Plug.Conn++ test "plug passes when a token is found" do+ %{id: site_id} = site = insert(:site, domain: "pass.example.com")+ {:ok, _, raw} = Tokens.create(site, "Some token")++ credentials = "Basic " <> Base.encode64("#{site.domain}:#{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" do+ site = insert(:site, domain: "pass.example.com")++ credentials = "Basic " <> Base.encode64("#{site.domain}:invalid-token")++ conn =+ build_conn()+ |> put_req_header("authorization", credentials)+ |> AuthorizePluginsAPI.call()++ assert conn.halted++ assert json_response(conn, 401) == %{+ "errors" => [+ %{"detail" => "Plugins API: unauthorized"}+ ]+ }+ end++ test "plug halts when no authorization header is passed" do+ conn =+ build_conn()+ |> AuthorizePluginsAPI.call()++ assert conn.halted++ assert json_response(conn, 401) == %{+ "errors" => [+ %{"detail" => "Plugins API: unauthorized"}+ ]+ }+ end+end