1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.Plugs.RateLimiter do
10 A keyword list of rate limiters where a key is a limiter name and value is the limiter configuration.
11 The basic configuration is a tuple where:
13 * The first element: `scale` (Integer). The time scale in milliseconds.
14 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
16 It is also possible to have different limits for unauthenticated and authenticated users: the keyword value must be a
17 list of two tuples where the first one is a config for unauthenticated users and the second one is for authenticated.
19 To disable a limiter set its value to `nil`.
23 config :pleroma, :rate_limit,
25 two: [{10_000, 10}, {10_000, 50}],
28 Here we have three limiters:
30 * `one` which is not over 10req/1s
31 * `two` which has two limits: 10req/10s for unauthenticated users and 50req/10s for authenticated users
32 * `foobar` which is disabled
38 plug(Pleroma.Web.Plugs.RateLimiter, name: :limiter_name)
39 plug(Pleroma.Web.Plugs.RateLimiter, options) # :name is a required option
43 * `name` required, always used to fetch the limit values from the config
44 * `bucket_name` overrides name for counting purposes (e.g. to have a separate limit for a set of actions)
45 * `params` appends values of specified request params (e.g. ["id"]) to bucket name
49 plug(Pleroma.Web.Plugs.RateLimiter, [name: :one] when action == :one)
50 plug(Pleroma.Web.Plugs.RateLimiter, [name: :two] when action in [:two, :three])
53 Pleroma.Web.Plugs.RateLimiter,
54 [name: :status_id_action, bucket_name: "status_id_action:fav_unfav", params: ["id"]]
55 when action in ~w(fav_status unfav_status)a
58 or inside a router pipeline:
62 plug(Pleroma.Web.Plugs.RateLimiter, name: :one)
66 import Pleroma.Web.TranslationHelpers
71 alias Pleroma.Web.Plugs.RateLimiter.LimiterSupervisor
75 @cachex Pleroma.Config.get([:cachex, :provider], Cachex)
78 def init(plug_opts) do
82 def call(conn, plug_opts) do
86 action_settings = action_settings(plug_opts)
87 handle(conn, action_settings)
91 defp handle_disabled(conn) do
93 "Rate limiter disabled due to forwarded IP not being found. Please ensure your reverse proxy is providing the X-Forwarded-For header or disable the RemoteIP plug/rate limiter."
99 defp handle(conn, nil), do: conn
101 defp handle(conn, action_settings) do
103 |> incorporate_conn_info(conn)
110 render_throttled_error(conn)
114 def disabled?(conn) do
115 if Map.has_key?(conn.assigns, :remote_ip_found),
116 do: !conn.assigns.remote_ip_found,
120 @inspect_bucket_not_found {:error, :not_found}
122 def inspect_bucket(conn, bucket_name_root, plug_opts) do
123 with %{name: _} = action_settings <- action_settings(plug_opts) do
124 action_settings = incorporate_conn_info(action_settings, conn)
125 bucket_name = make_bucket_name(%{action_settings | name: bucket_name_root})
126 key_name = make_key_name(action_settings)
127 limit = get_limits(action_settings)
129 case @cachex.get(bucket_name, key_name) do
130 {:error, :no_cache} ->
131 @inspect_bucket_not_found
137 {value, limit - value}
140 _ -> @inspect_bucket_not_found
144 def action_settings(plug_opts) do
145 with limiter_name when is_atom(limiter_name) <- plug_opts[:name],
146 limits when not is_nil(limits) <- Config.get([:rate_limit, limiter_name]) do
147 bucket_name_root = Keyword.get(plug_opts, :bucket_name, limiter_name)
150 name: bucket_name_root,
157 defp check_rate(action_settings) do
158 bucket_name = make_bucket_name(action_settings)
159 key_name = make_key_name(action_settings)
160 limit = get_limits(action_settings)
162 case @cachex.get_and_update(bucket_name, key_name, &increment_value(&1, limit)) do
169 {:error, :no_cache} ->
170 initialize_buckets!(action_settings)
171 check_rate(action_settings)
175 defp increment_value(nil, _limit), do: {:commit, 1}
177 defp increment_value(val, limit) when val >= limit, do: {:ignore, val}
179 defp increment_value(val, _limit), do: {:commit, val + 1}
181 defp incorporate_conn_info(action_settings, %{
182 assigns: %{user: %User{id: user_id}},
185 Map.merge(action_settings, %{
188 conn_info: "#{user_id}"
192 defp incorporate_conn_info(action_settings, %{params: params} = conn) do
193 Map.merge(action_settings, %{
196 conn_info: "#{ip(conn)}"
200 defp ip(%{remote_ip: remote_ip}) do
206 defp render_throttled_error(conn) do
208 |> render_error(:too_many_requests, "Throttled")
212 defp make_key_name(action_settings) do
214 |> attach_selected_params(action_settings)
215 |> attach_identity(action_settings)
218 defp get_scale(_, {scale, _}), do: scale
220 defp get_scale(:anon, [{scale, _}, {_, _}]), do: scale
222 defp get_scale(:user, [{_, _}, {scale, _}]), do: scale
224 defp get_limits(%{limits: {_scale, limit}}), do: limit
226 defp get_limits(%{mode: :user, limits: [_, {_, limit}]}), do: limit
228 defp get_limits(%{limits: [{_, limit}, _]}), do: limit
230 defp make_bucket_name(%{mode: :user, name: bucket_name_root}),
231 do: user_bucket_name(bucket_name_root)
233 defp make_bucket_name(%{mode: :anon, name: bucket_name_root}),
234 do: anon_bucket_name(bucket_name_root)
236 defp attach_selected_params(input, %{conn_params: conn_params, opts: plug_opts}) do
239 |> Keyword.get(:params, [])
241 |> Enum.map(&Map.get(conn_params, &1, ""))
244 [input, params_string]
246 |> String.replace_leading(":", "")
249 defp initialize_buckets!(%{name: _name, limits: nil}), do: :ok
251 defp initialize_buckets!(%{name: name, limits: limits}) do
253 LimiterSupervisor.add_or_return_limiter(anon_bucket_name(name), get_scale(:anon, limits))
256 LimiterSupervisor.add_or_return_limiter(user_bucket_name(name), get_scale(:user, limits))
261 defp attach_identity(base, %{mode: :user, conn_info: conn_info}),
262 do: "user:#{base}:#{conn_info}"
264 defp attach_identity(base, %{mode: :anon, conn_info: conn_info}),
265 do: "ip:#{base}:#{conn_info}"
267 defp user_bucket_name(bucket_name_root), do: "user:#{bucket_name_root}" |> String.to_atom()
268 defp anon_bucket_name(bucket_name_root), do: "anon:#{bucket_name_root}" |> String.to_atom()