Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F85948924
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Flag For Later
Award Token
Authored By
Unknown
Size
7 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/changelog.d/cast-and-validate-many-params.fix b/changelog.d/cast-and-validate-many-params.fix
new file mode 100644
index 000000000..c44396618
--- /dev/null
+++ b/changelog.d/cast-and-validate-many-params.fix
@@ -0,0 +1 @@
+Drop all unexpected query params, not just the first one, when `Pleroma.Web.ApiSpec.CastAndValidate` `strict` is off
diff --git a/lib/pleroma/web/api_spec/cast_and_validate.ex b/lib/pleroma/web/api_spec/cast_and_validate.ex
index 92f1c5376..41e69727e 100644
--- a/lib/pleroma/web/api_spec/cast_and_validate.ex
+++ b/lib/pleroma/web/api_spec/cast_and_validate.ex
@@ -1,153 +1,171 @@
# Pleroma: A lightweight social networking server
# Copyright © 2019-2020 Moxley Stratton, Mike Buhot <https://github.com/open-api-spex/open_api_spex>, MPL-2.0
# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.Web.ApiSpec.CastAndValidate do
@moduledoc """
This plug is based on [`OpenApiSpex.Plug.CastAndValidate`]
(https://github.com/open-api-spex/open_api_spex/blob/master/lib/open_api_spex/plug/cast_and_validate.ex).
The main difference is ignoring unexpected query params instead of throwing
an error and a config option (`[Pleroma.Web.ApiSpec.CastAndValidate, :strict]`)
to disable this behavior. Also, the default rendering error module
is `Pleroma.Web.ApiSpec.RenderError`.
"""
@behaviour Plug
alias OpenApiSpex.Plug.PutApiSpec
alias Plug.Conn
require Logger
+ # How often to drop offending query params and retry in permissive mode
+ @max_retries 20
+
@impl Plug
def init(opts) do
opts
|> Map.new()
|> Map.put_new(:render_error, Pleroma.Web.ApiSpec.RenderError)
end
@impl Plug
def call(conn, %{operation_id: operation_id, render_error: render_error} = opts) do
{spec, operation_lookup} = PutApiSpec.get_spec_and_operation_lookup(conn)
operation = operation_lookup[operation_id]
cast_opts = opts |> Map.take([:replace_params]) |> Map.to_list()
content_type =
case Conn.get_req_header(conn, "content-type") do
[header_value | _] ->
header_value
|> String.split(";")
|> List.first()
_ ->
"application/json"
end
conn = Conn.put_private(conn, :operation_id, operation_id)
case cast_and_validate(spec, operation, conn, content_type, strict?(), cast_opts) do
{:ok, conn} ->
conn
{:error, reason} ->
Logger.error(
"Strict ApiSpec: request denied to #{conn.request_path} with params #{inspect(conn.params)}"
)
opts = render_error.init(reason)
conn
|> render_error.call(opts)
|> Plug.Conn.halt()
end
end
def call(
%{
private: %{
phoenix_controller: controller,
phoenix_action: action,
open_api_spex: %{spec_module: spec_module}
}
} = conn,
opts
) do
{spec, operation_lookup} = PutApiSpec.get_spec_and_operation_lookup(conn)
operation =
case operation_lookup[{controller, action}] do
nil ->
operation_id = controller.open_api_operation(action).operationId
operation = operation_lookup[operation_id]
operation_lookup = Map.put(operation_lookup, {controller, action}, operation)
OpenApiSpex.Plug.Cache.adapter().put(spec_module, {spec, operation_lookup})
operation
operation ->
operation
end
if operation.operationId do
call(conn, Map.put(opts, :operation_id, operation.operationId))
else
raise "operationId was not found in action API spec"
end
end
def call(conn, opts), do: OpenApiSpex.Plug.CastAndValidate.call(conn, opts)
defp cast_and_validate(spec, operation, conn, content_type, true = _strict, cast_opts) do
OpenApiSpex.cast_and_validate(spec, operation, conn, content_type, cast_opts)
end
defp cast_and_validate(
spec,
operation,
%Conn{} = conn,
content_type,
false = _strict,
cast_opts
) do
- case OpenApiSpex.cast_and_validate(spec, operation, conn, content_type, cast_opts) do
- {:ok, conn} ->
- {:ok, conn}
+ permissive_cast_and_validate(spec, operation, conn, content_type, cast_opts, @max_retries)
+ end
- # Remove unexpected query params and cast/validate again
- {:error, errors} ->
- query_params =
- Enum.reduce(errors, conn.query_params, fn
- %{reason: :unexpected_field, name: name, path: [name]}, params ->
- Map.delete(params, name)
+ # OpenApiSpex reports one offending param at a time, so drop it and cast/validate again
+ defp permissive_cast_and_validate(
+ spec,
+ operation,
+ %Conn{} = conn,
+ content_type,
+ cast_opts,
+ retries
+ ) do
+ with {:error, errors} = error <-
+ OpenApiSpex.cast_and_validate(spec, operation, conn, content_type, cast_opts) do
+ query_params = drop_invalid_query_params(errors, conn.query_params)
+
+ if retries > 0 and query_params != conn.query_params do
+ conn = %{conn | query_params: query_params}
+ permissive_cast_and_validate(spec, operation, conn, content_type, cast_opts, retries - 1)
+ else
+ error
+ end
+ end
+ end
- # Filter out empty params
- %{reason: :invalid_type, path: [name_atom], value: ""}, params ->
- Map.delete(params, to_string(name_atom))
+ defp drop_invalid_query_params(errors, query_params) do
+ Enum.reduce(errors, query_params, fn
+ %{reason: :unexpected_field, name: name, path: [name]}, params ->
+ Map.delete(params, name)
- %{reason: :invalid_enum, name: nil, path: path, value: value}, params ->
- path = path |> Enum.reverse() |> tl() |> Enum.reverse() |> list_items_to_string()
- update_in(params, path, &List.delete(&1, value))
+ # Filter out empty params
+ %{reason: :invalid_type, path: [name_atom], value: ""}, params ->
+ Map.delete(params, to_string(name_atom))
- _, params ->
- params
- end)
+ %{reason: :invalid_enum, name: nil, path: path, value: value}, params ->
+ path = path |> Enum.reverse() |> tl() |> Enum.reverse() |> list_items_to_string()
+ update_in(params, path, &List.delete(&1, value))
- conn = %Conn{conn | query_params: query_params}
- OpenApiSpex.cast_and_validate(spec, operation, conn, content_type, cast_opts)
- end
+ _, params ->
+ params
+ end)
end
defp list_items_to_string(list) do
Enum.map(list, fn
i when is_atom(i) -> to_string(i)
i -> i
end)
end
defp strict?, do: Pleroma.Config.get([__MODULE__, :strict], false)
end
diff --git a/test/pleroma/web/api_spec/cast_and_validate_test.exs b/test/pleroma/web/api_spec/cast_and_validate_test.exs
new file mode 100644
index 000000000..b7ee673e1
--- /dev/null
+++ b/test/pleroma/web/api_spec/cast_and_validate_test.exs
@@ -0,0 +1,24 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
+defmodule Pleroma.Web.ApiSpec.CastAndValidateTest do
+ use Pleroma.Web.ConnCase, async: false
+
+ describe "permissive mode" do
+ setup do: clear_config([Pleroma.Web.ApiSpec.CastAndValidate, :strict], false)
+
+ test "drops several unexpected query params", %{conn: conn} do
+ assert conn
+ |> get("/api/v1/timelines/public?foo=1&bar=2&baz=3&local=true")
+ |> json_response_and_validate_schema(200)
+ end
+
+ test "still rejects an invalid known param", %{conn: conn} do
+ assert %{"error" => _} =
+ conn
+ |> get("/api/v1/timelines/public?foo=1&bar=2&limit=lots")
+ |> json_response(400)
+ end
+ end
+end
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Tue, Nov 17, 3:36 PM (9 h, 58 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1839620
Default Alt Text
(7 KB)
Attached To
Mode
rPUBE pleroma-upstream
Attached
Detach File
Event Timeline