Skip to content

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

Harden API input validation (#2869)

hq16a831d989834
diff --git a/lib/plausible/ingestion/request.ex b/lib/plausible/ingestion/request.ex
index 953f27f7a3..6e03e2aea0 100644
--- a/lib/plausible/ingestion/request.ex
+++ b/lib/plausible/ingestion/request.ex
@@ -74,7 +74,7 @@ defmodule Plausible.Ingestion.Request do
{:ok, body, _conn} = Plug.Conn.read_body(conn)
case Jason.decode(body) do
- {:ok, params} -> {:ok, params}
+ {:ok, params} when is_map(params) -> {:ok, params}
_ -> {:error, :invalid_json}
end
diff --git a/lib/plausible/stats/filter_parser.ex b/lib/plausible/stats/filter_parser.ex
index 160638893e..52f885f80b 100644
--- a/lib/plausible/stats/filter_parser.ex
+++ b/lib/plausible/stats/filter_parser.ex
@@ -27,7 +27,8 @@ defmodule Plausible.Stats.FilterParser do
"""
def parse_filters(filters) when is_binary(filters) do
case Jason.decode(filters) do
- {:ok, parsed} -> parsed
+ {:ok, parsed} when is_map(parsed) -> parsed
+ {:ok, _} -> %{}
{:error, err} -> parse_filter_expression(err.data)
end
end
@@ -61,12 +62,24 @@ defmodule Plausible.Stats.FilterParser do
is_negated -> {key, {:is_not, final_value}}
true -> {key, {:is, final_value}}
end
+ |> reject_invalid_country_codes()
_ ->
:error
end
end
+ defp reject_invalid_country_codes({"visit:country", {_, code_or_codes}} = filter) do
+ code_or_codes
+ |> List.wrap()
+ |> Enum.reduce_while(filter, fn
+ value, _ when byte_size(value) == 2 -> {:cont, filter}
+ _, _ -> {:halt, :error}
+ end)
+ end
+
+ defp reject_invalid_country_codes(filter), do: filter
+
defp to_kv(str) do
str
|> String.trim()
diff --git a/lib/plausible/stats/filters.ex b/lib/plausible/stats/filters.ex
index 1ea60e736d..621d7941cd 100644
--- a/lib/plausible/stats/filters.ex
+++ b/lib/plausible/stats/filters.ex
@@ -44,6 +44,9 @@ defmodule Plausible.Stats.Filters do
Enum.reduce(val, new_filters, fn {prop_key, prop_val}, new_filters ->
Map.put(new_filters, "event:props:" <> prop_key, filter_value(name, prop_val))
end)
+
+ true ->
+ new_filters
end
end)
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index e820b20821..93d63ff822 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -7,6 +7,8 @@ defmodule PlausibleWeb.Api.StatsController do
require Logger
+ plug :validate_common_input
+
@doc """
Returns a time-series based on given parameters.
@@ -1129,18 +1131,14 @@ defmodule PlausibleWeb.Api.StatsController do
def filter_suggestions(conn, params) do
site = conn.assigns[:site]
- with :ok <- validate_params(params) do
- query =
- Query.from(site, params)
- |> Filters.add_prefix()
-
- json(
- conn,
- Stats.filter_suggestions(site, query, params["filter_name"], params["q"])
- )
- else
- {:error, message} when is_binary(message) -> bad_request(conn, message)
- end
+ query =
+ Query.from(site, params)
+ |> Filters.add_prefix()
+
+ json(
+ conn,
+ Stats.filter_suggestions(site, query, params["filter_name"], params["q"])
+ )
end
defp transform_keys(results, keys_to_replace) do
@@ -1238,24 +1236,33 @@ defmodule PlausibleWeb.Api.StatsController do
end
end
+ defp validate_common_input(conn, _opts) do
+ case validate_params(conn.params) do
+ :ok -> conn
+ {:error, message} when is_binary(message) -> bad_request(conn, message)
+ end
+ end
+
defp validate_params(params) do
- with :ok <- validate_date(params),
+ with :ok <- validate_dates(params),
:ok <- validate_interval(params),
do: validate_interval_granularity(params)
end
- defp validate_date(params) do
- with %{"date" => date} <- params,
- {:ok, _} <- Date.from_iso8601(date) do
- :ok
- else
- %{} ->
- :ok
-
- {:error, _reason} ->
- {:error,
- "Failed to parse date argument. Only ISO 8601 dates are allowed, e.g. `2019-09-07`, `2020-01-01`"}
- end
+ defp validate_dates(params) do
+ params
+ |> Map.take(["from", "to", "date"])
+ |> Enum.reduce_while(:ok, fn {key, value}, _ ->
+ case Date.from_iso8601(value) do
+ {:ok, _} ->
+ {:cont, :ok}
+
+ _ ->
+ {:halt,
+ {:error,
+ "Failed to parse '#{key}' argument. Only ISO 8601 dates are allowed, e.g. `2019-09-07`, `2020-01-01`"}}
+ end
+ end)
end
defp validate_interval(params) do
@@ -1290,6 +1297,7 @@ defmodule PlausibleWeb.Api.StatsController do
conn
|> put_status(400)
|> json(%{error: message})
+ |> halt()
end
defp parse_comparison_opts(params) do
diff --git a/test/plausible/ingestion/request_test.exs b/test/plausible/ingestion/request_test.exs
index 6263d6904b..14051aa7b6 100644
--- a/test/plausible/ingestion/request_test.exs
+++ b/test/plausible/ingestion/request_test.exs
@@ -226,4 +226,10 @@ defmodule Plausible.Ingestion.RequestTest do
assert {:error, changeset} = Request.build(conn)
assert {"should be at most %{count} character(s)", _} = changeset.errors[:pathname]
end
+
+ test "malicious input, technically valid json" do
+ conn = build_conn(:post, "/api/events", "\"<script>\"")
+ assert {:error, changeset} = Request.build(conn)
+ assert changeset.errors[:request]
+ end
end
diff --git a/test/plausible/stats/filter_parser_test.exs b/test/plausible/stats/filter_parser_test.exs
index 9e7c09866c..9e78c1fbdb 100644
--- a/test/plausible/stats/filter_parser_test.exs
+++ b/test/plausible/stats/filter_parser_test.exs
@@ -81,5 +81,20 @@ defmodule Plausible.Stats.FilterParserTest do
"bfg10309\uff1cs1\ufe65s2\u02bas3\u02b9hjl10309"
|> assert_parsed(%{})
end
+
+ test "gracefully fails to parse garbage with double quotes" do
+ "\";print(md5(31337));$a=\""
+ |> assert_parsed(%{})
+ end
+
+ test "gracefully fails to parse garbage country code" do
+ "visit:country==AKSJSDFKJSS"
+ |> assert_parsed(%{})
+ end
+
+ test "gracefully fails to parse garbage country code (with pipes)" do
+ "visit:country==ET'||DBMS_PIPE.RECEIVE_MESSAGE(CHR(98)||CHR(98)||CHR(98),15)||'"
+ |> assert_parsed(%{})
+ end
end
end
diff --git a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs
index f62fc34870..a0d15e1fc3 100644
--- a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs
@@ -212,6 +212,18 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do
}
]
end
+
+ test "garbage filters don't crash the call", %{conn: conn, site: site} do
+ filters =
+ "{\"source\":\"Direct / None\",\"screen\":\"Desktop\",\"browser\":\"Chrome\",\"os\":\"Mac\",\"os_version\":\"10.15\",\"country\":\"DE\",\"city\":\"2950159\"}%' AND 2*3*8=6*8 AND 'L9sv'!='L9sv%"
+
+ resp =
+ conn
+ |> get("/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}")
+ |> json_response(200)
+
+ assert resp == []
+ end
end
describe "GET /api/stats/:domain/conversions - with goal filter" do
diff --git a/test/plausible_web/controllers/api/stats_controller/regions_test.exs b/test/plausible_web/controllers/api/stats_controller/regions_test.exs
index decf947ecf..a2b8c22ae7 100644
--- a/test/plausible_web/controllers/api/stats_controller/regions_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/regions_test.exs
@@ -31,5 +31,47 @@ defmodule PlausibleWeb.Api.StatsController.RegionsTest do
%{"code" => "EE-39", "country_flag" => "🇪🇪", "name" => "Hiiumaa", "visitors" => 2}
]
end
+
+ test "malicious input - date", %{conn: conn, site: site} do
+ filters = Jason.encode!(%{region: "EE-39"})
+ garbage = "2020-07-30'||DBMS_PIPE.RECEIVE_MESSAGE(CHR(98)||CHR(98)||CHR(98),15)||'"
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/regions?period=custom&filters=#{filters}&date=#{garbage}"
+ )
+
+ assert resp = response(conn, 400)
+ assert resp =~ "Failed to parse 'date' argument."
+ end
+
+ test "malicious input - from", %{conn: conn, site: site} do
+ filters = Jason.encode!(%{region: "EE-39"})
+ garbage = "2020-07-30'||DBMS_PIPE.RECEIVE_MESSAGE(CHR(98)||CHR(98)||CHR(98),15)||'"
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/regions?period=custom&filters=#{filters}&from=#{garbage}"
+ )
+
+ assert resp = response(conn, 400)
+ assert resp =~ "Failed to parse 'from' argument."
+ end
+
+ test "malicious input - to", %{conn: conn, site: site} do
+ filters = Jason.encode!(%{region: "EE-39"})
+ garbage = "2020-07-30'||DBMS_PIPE.RECEIVE_MESSAGE(CHR(98)||CHR(98)||CHR(98),15)||'"
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/regions?period=custom&filters=#{filters}&from=2020-04-01&to=#{garbage}"
+ )
+
+ assert resp = response(conn, 400)
+ assert resp =~ "Failed to parse 'to' argument."
+ end
end
end
diff --git a/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs b/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs
index 6056dd6d8e..be4004327f 100644
--- a/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/suggestions_test.exs
@@ -382,7 +382,7 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
assert json_response(conn, 400) == %{
"error" =>
- "Failed to parse date argument. Only ISO 8601 dates are allowed, e.g. `2019-09-07`, `2020-01-01`"
+ "Failed to parse 'date' argument. Only ISO 8601 dates are allowed, e.g. `2019-09-07`, `2020-01-01`"
}
end
end