akkoma/test/plugs/rate_limiter_test.exs

243 lines
8.1 KiB
Elixir
Raw Normal View History

# Pleroma: A lightweight social networking server
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
2019-06-11 07:27:41 +00:00
defmodule Pleroma.Plugs.RateLimiterTest do
use ExUnit.Case, async: true
use Plug.Test
alias Pleroma.Plugs.RateLimiter
import Pleroma.Factory
# Note: each example must work with separate buckets in order to prevent concurrency issues
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
describe "config" do
test "config is required for plug to work" do
limiter_name = :test_init
Pleroma.Config.put([:rate_limit, limiter_name], {1, 1})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
assert %{limits: {1, 1}, name: :test_init, opts: [name: :test_init]} ==
RateLimiter.init(name: limiter_name)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
assert nil == RateLimiter.init(name: :foo)
end
2019-06-11 07:27:41 +00:00
test "it is disabled for localhost" do
limiter_name = :test_init
Pleroma.Config.put([:rate_limit, limiter_name], {1, 1})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {127, 0, 0, 1})
Pleroma.Config.put([Pleroma.Plugs.RemoteIp, :enabled], false)
assert RateLimiter.disabled?() == true
end
test "it is disabled for socket" do
limiter_name = :test_init
Pleroma.Config.put([:rate_limit, limiter_name], {1, 1})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {:local, "/path/to/pleroma.sock"})
Pleroma.Config.put([Pleroma.Plugs.RemoteIp, :enabled], false)
assert RateLimiter.disabled?() == true
end
test "it is enabled for socket when remote ip is enabled" do
limiter_name = :test_init
Pleroma.Config.put([:rate_limit, limiter_name], {1, 1})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {:local, "/path/to/pleroma.sock"})
Pleroma.Config.put([Pleroma.Plugs.RemoteIp, :enabled], true)
assert RateLimiter.disabled?() == false
end
2019-11-11 12:13:06 +00:00
test "it restricts based on config values" do
limiter_name = :test_opts
scale = 80
2019-11-11 12:13:06 +00:00
limit = 5
2019-06-11 07:27:41 +00:00
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-11-11 12:13:06 +00:00
Pleroma.Config.put([:rate_limit, limiter_name], {scale, limit})
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
opts = RateLimiter.init(name: limiter_name)
conn = conn(:get, "/")
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
for i <- 1..5 do
conn = RateLimiter.call(conn, opts)
assert {^i, _} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
Process.sleep(10)
end
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = RateLimiter.call(conn, opts)
assert %{"error" => "Throttled"} = Phoenix.ConnTest.json_response(conn, :too_many_requests)
assert conn.halted
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
Process.sleep(50)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = conn(:get, "/")
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = RateLimiter.call(conn, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
refute conn.status == Plug.Conn.Status.code(:too_many_requests)
refute conn.resp_body
refute conn.halted
end
end
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
describe "options" do
test "`bucket_name` option overrides default bucket name" do
limiter_name = :test_bucket_name
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
Pleroma.Config.put([:rate_limit, limiter_name], {1000, 5})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
base_bucket_name = "#{limiter_name}:group1"
opts = RateLimiter.init(name: limiter_name, bucket_name: base_bucket_name)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = conn(:get, "/")
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
RateLimiter.call(conn, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn, base_bucket_name, opts)
assert {:err, :not_found} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
end
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
test "`params` option allows different queries to be tracked independently" do
limiter_name = :test_params
Pleroma.Config.put([:rate_limit, limiter_name], {1000, 5})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-11-11 12:13:06 +00:00
opts = RateLimiter.init(name: limiter_name, params: ["id"])
2019-11-11 12:13:06 +00:00
conn = conn(:get, "/?id=1")
conn = Plug.Conn.fetch_query_params(conn)
conn_2 = conn(:get, "/?id=2")
2019-11-11 12:13:06 +00:00
RateLimiter.call(conn, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
assert {0, 5} = RateLimiter.inspect_bucket(conn_2, limiter_name, opts)
end
2019-11-11 12:13:06 +00:00
test "it supports combination of options modifying bucket name" do
limiter_name = :test_options_combo
Pleroma.Config.put([:rate_limit, limiter_name], {1000, 5})
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-11-11 12:13:06 +00:00
base_bucket_name = "#{limiter_name}:group1"
opts = RateLimiter.init(name: limiter_name, bucket_name: base_bucket_name, params: ["id"])
id = "100"
2019-11-11 12:13:06 +00:00
conn = conn(:get, "/?id=#{id}")
conn = Plug.Conn.fetch_query_params(conn)
conn_2 = conn(:get, "/?id=#{101}")
2019-11-11 12:13:06 +00:00
RateLimiter.call(conn, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn, base_bucket_name, opts)
assert {0, 5} = RateLimiter.inspect_bucket(conn_2, base_bucket_name, opts)
end
end
2019-11-11 12:13:06 +00:00
describe "unauthenticated users" do
test "are restricted based on remote IP" do
limiter_name = :test_unauthenticated
Pleroma.Config.put([:rate_limit, limiter_name], [{1000, 5}, {1, 10}])
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-11-11 12:13:06 +00:00
opts = RateLimiter.init(name: limiter_name)
2019-11-11 12:13:06 +00:00
conn = %{conn(:get, "/") | remote_ip: {127, 0, 0, 2}}
conn_2 = %{conn(:get, "/") | remote_ip: {127, 0, 0, 3}}
2019-11-11 12:13:06 +00:00
for i <- 1..5 do
conn = RateLimiter.call(conn, opts)
assert {^i, _} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
refute conn.halted
end
2019-11-11 12:13:06 +00:00
conn = RateLimiter.call(conn, opts)
2019-11-11 12:13:06 +00:00
assert %{"error" => "Throttled"} = Phoenix.ConnTest.json_response(conn, :too_many_requests)
assert conn.halted
conn_2 = RateLimiter.call(conn_2, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn_2, limiter_name, opts)
refute conn_2.status == Plug.Conn.Status.code(:too_many_requests)
refute conn_2.resp_body
refute conn_2.halted
end
end
2019-11-11 12:13:06 +00:00
describe "authenticated users" do
setup do
Ecto.Adapters.SQL.Sandbox.checkout(Pleroma.Repo)
:ok
end
test "can have limits seperate from unauthenticated connections" do
limiter_name = :test_authenticated
scale = 1000
limit = 5
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-11-11 12:13:06 +00:00
Pleroma.Config.put([:rate_limit, limiter_name], [{1, 10}, {scale, limit}])
opts = RateLimiter.init(name: limiter_name)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
user = insert(:user)
conn = conn(:get, "/") |> assign(:user, user)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
for i <- 1..5 do
conn = RateLimiter.call(conn, opts)
assert {^i, _} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
refute conn.halted
end
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = RateLimiter.call(conn, opts)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
assert %{"error" => "Throttled"} = Phoenix.ConnTest.json_response(conn, :too_many_requests)
assert conn.halted
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
Process.sleep(1550)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = conn(:get, "/") |> assign(:user, user)
conn = RateLimiter.call(conn, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
refute conn.status == Plug.Conn.Status.code(:too_many_requests)
refute conn.resp_body
refute conn.halted
end
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
test "diffrerent users are counted independently" do
limiter_name = :test_authenticated
Pleroma.Config.put([:rate_limit, limiter_name], [{1, 10}, {1000, 5}])
Pleroma.Config.put([Pleroma.Web.Endpoint, :http, :ip], {8, 8, 8, 8})
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
opts = RateLimiter.init(name: limiter_name)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
user = insert(:user)
conn = conn(:get, "/") |> assign(:user, user)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
user_2 = insert(:user)
conn_2 = conn(:get, "/") |> assign(:user, user_2)
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
for i <- 1..5 do
conn = RateLimiter.call(conn, opts)
assert {^i, _} = RateLimiter.inspect_bucket(conn, limiter_name, opts)
end
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn = RateLimiter.call(conn, opts)
assert %{"error" => "Throttled"} = Phoenix.ConnTest.json_response(conn, :too_many_requests)
assert conn.halted
2019-06-11 07:27:41 +00:00
2019-11-11 12:13:06 +00:00
conn_2 = RateLimiter.call(conn_2, opts)
assert {1, 4} = RateLimiter.inspect_bucket(conn_2, limiter_name, opts)
refute conn_2.status == Plug.Conn.Status.code(:too_many_requests)
refute conn_2.resp_body
refute conn_2.halted
end
2019-06-11 07:27:41 +00:00
end
end