2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2020-06-05 05:47:20 -04:00
|
|
|
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
2014-09-03 04:43:11 -04:00
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
2020-01-20 12:34:13 -05:00
|
|
|
from collections import OrderedDict
|
|
|
|
from typing import Any, Optional, Tuple
|
2014-09-01 12:54:54 -04:00
|
|
|
|
2019-03-15 13:46:16 -04:00
|
|
|
from synapse.api.errors import LimitExceededError
|
2020-08-21 10:07:56 -04:00
|
|
|
from synapse.types import Requester
|
2020-06-05 05:47:20 -04:00
|
|
|
from synapse.util import Clock
|
2019-03-15 13:46:16 -04:00
|
|
|
|
2014-09-01 12:54:54 -04:00
|
|
|
|
2020-09-04 06:54:56 -04:00
|
|
|
class Ratelimiter:
|
2014-09-02 10:06:20 -04:00
|
|
|
"""
|
2020-06-05 05:47:20 -04:00
|
|
|
Ratelimit actions marked by arbitrary keys.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
clock: A homeserver clock, for retrieving the current time
|
|
|
|
rate_hz: The long term number of actions that can be performed in a second.
|
|
|
|
burst_count: How many actions that can be performed before being limited.
|
2014-09-02 10:06:20 -04:00
|
|
|
"""
|
2014-09-01 12:54:54 -04:00
|
|
|
|
2020-06-05 05:47:20 -04:00
|
|
|
def __init__(self, clock: Clock, rate_hz: float, burst_count: int):
|
|
|
|
self.clock = clock
|
|
|
|
self.rate_hz = rate_hz
|
|
|
|
self.burst_count = burst_count
|
|
|
|
|
|
|
|
# A ordered dictionary keeping track of actions, when they were last
|
|
|
|
# performed and how often. Each entry is a mapping from a key of arbitrary type
|
|
|
|
# to a tuple representing:
|
|
|
|
# * How many times an action has occurred since a point in time
|
|
|
|
# * The point in time
|
|
|
|
# * The rate_hz of this particular entry. This can vary per request
|
|
|
|
self.actions = OrderedDict() # type: OrderedDict[Any, Tuple[float, int, float]]
|
2014-09-01 12:54:54 -04:00
|
|
|
|
2020-08-21 10:07:56 -04:00
|
|
|
def can_requester_do_action(
|
|
|
|
self,
|
|
|
|
requester: Requester,
|
|
|
|
rate_hz: Optional[float] = None,
|
|
|
|
burst_count: Optional[int] = None,
|
|
|
|
update: bool = True,
|
|
|
|
_time_now_s: Optional[int] = None,
|
|
|
|
) -> Tuple[bool, float]:
|
|
|
|
"""Can the requester perform the action?
|
|
|
|
|
|
|
|
Args:
|
|
|
|
requester: The requester to key off when rate limiting. The user property
|
|
|
|
will be used.
|
|
|
|
rate_hz: The long term number of actions that can be performed in a second.
|
|
|
|
Overrides the value set during instantiation if set.
|
|
|
|
burst_count: How many actions that can be performed before being limited.
|
|
|
|
Overrides the value set during instantiation if set.
|
|
|
|
update: Whether to count this check as performing the action
|
|
|
|
_time_now_s: The current time. Optional, defaults to the current time according
|
|
|
|
to self.clock. Only used by tests.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
A tuple containing:
|
|
|
|
* A bool indicating if they can perform the action now
|
|
|
|
* The reactor timestamp for when the action can be performed next.
|
|
|
|
-1 if rate_hz is less than or equal to zero
|
|
|
|
"""
|
|
|
|
# Disable rate limiting of users belonging to any AS that is configured
|
|
|
|
# not to be rate limited in its registration file (rate_limited: true|false).
|
|
|
|
if requester.app_service and not requester.app_service.is_rate_limited():
|
|
|
|
return True, -1.0
|
|
|
|
|
|
|
|
return self.can_do_action(
|
|
|
|
requester.user.to_string(), rate_hz, burst_count, update, _time_now_s
|
|
|
|
)
|
|
|
|
|
2020-06-05 05:47:20 -04:00
|
|
|
def can_do_action(
|
|
|
|
self,
|
|
|
|
key: Any,
|
|
|
|
rate_hz: Optional[float] = None,
|
|
|
|
burst_count: Optional[int] = None,
|
|
|
|
update: bool = True,
|
|
|
|
_time_now_s: Optional[int] = None,
|
|
|
|
) -> Tuple[bool, float]:
|
2019-03-05 09:25:33 -05:00
|
|
|
"""Can the entity (e.g. user or IP address) perform the action?
|
2020-06-05 05:47:20 -04:00
|
|
|
|
2014-09-02 10:06:20 -04:00
|
|
|
Args:
|
2019-03-05 09:25:33 -05:00
|
|
|
key: The key we should use when rate limiting. Can be a user ID
|
|
|
|
(when sending events), an IP address, etc.
|
2020-06-05 05:47:20 -04:00
|
|
|
rate_hz: The long term number of actions that can be performed in a second.
|
|
|
|
Overrides the value set during instantiation if set.
|
|
|
|
burst_count: How many actions that can be performed before being limited.
|
|
|
|
Overrides the value set during instantiation if set.
|
|
|
|
update: Whether to count this check as performing the action
|
|
|
|
_time_now_s: The current time. Optional, defaults to the current time according
|
|
|
|
to self.clock. Only used by tests.
|
|
|
|
|
2014-09-02 10:06:20 -04:00
|
|
|
Returns:
|
2020-06-05 05:47:20 -04:00
|
|
|
A tuple containing:
|
|
|
|
* A bool indicating if they can perform the action now
|
|
|
|
* The reactor timestamp for when the action can be performed next.
|
|
|
|
-1 if rate_hz is less than or equal to zero
|
2014-09-02 10:06:20 -04:00
|
|
|
"""
|
2020-06-05 05:47:20 -04:00
|
|
|
# Override default values if set
|
|
|
|
time_now_s = _time_now_s if _time_now_s is not None else self.clock.time()
|
|
|
|
rate_hz = rate_hz if rate_hz is not None else self.rate_hz
|
|
|
|
burst_count = burst_count if burst_count is not None else self.burst_count
|
|
|
|
|
|
|
|
# Remove any expired entries
|
|
|
|
self._prune_message_counts(time_now_s)
|
|
|
|
|
|
|
|
# Check if there is an existing count entry for this key
|
|
|
|
action_count, time_start, _ = self.actions.get(key, (0.0, time_now_s, 0.0))
|
|
|
|
|
|
|
|
# Check whether performing another action is allowed
|
2014-09-02 10:06:20 -04:00
|
|
|
time_delta = time_now_s - time_start
|
2020-06-05 05:47:20 -04:00
|
|
|
performed_count = action_count - time_delta * rate_hz
|
|
|
|
if performed_count < 0:
|
|
|
|
# Allow, reset back to count 1
|
2014-09-02 10:06:20 -04:00
|
|
|
allowed = True
|
|
|
|
time_start = time_now_s
|
2020-06-05 05:47:20 -04:00
|
|
|
action_count = 1.0
|
|
|
|
elif performed_count > burst_count - 1.0:
|
|
|
|
# Deny, we have exceeded our burst count
|
2014-09-01 12:54:54 -04:00
|
|
|
allowed = False
|
|
|
|
else:
|
2020-06-05 05:47:20 -04:00
|
|
|
# We haven't reached our limit yet
|
2014-09-01 12:54:54 -04:00
|
|
|
allowed = True
|
2020-06-05 05:47:20 -04:00
|
|
|
action_count += 1.0
|
2014-09-02 10:06:20 -04:00
|
|
|
|
2016-10-19 05:45:24 -04:00
|
|
|
if update:
|
2020-06-05 05:47:20 -04:00
|
|
|
self.actions[key] = (action_count, time_start, rate_hz)
|
2014-09-02 10:06:20 -04:00
|
|
|
|
2019-03-05 09:25:33 -05:00
|
|
|
if rate_hz > 0:
|
2020-06-05 05:47:20 -04:00
|
|
|
# Find out when the count of existing actions expires
|
|
|
|
time_allowed = time_start + (action_count - burst_count + 1) / rate_hz
|
|
|
|
|
|
|
|
# Don't give back a time in the past
|
2014-09-02 10:06:20 -04:00
|
|
|
if time_allowed < time_now_s:
|
|
|
|
time_allowed = time_now_s
|
2020-06-05 05:47:20 -04:00
|
|
|
|
2014-09-02 10:06:20 -04:00
|
|
|
else:
|
2020-06-05 05:47:20 -04:00
|
|
|
# XXX: Why is this -1? This seems to only be used in
|
|
|
|
# self.ratelimit. I guess so that clients get a time in the past and don't
|
|
|
|
# feel afraid to try again immediately
|
2014-09-02 10:06:20 -04:00
|
|
|
time_allowed = -1
|
|
|
|
|
|
|
|
return allowed, time_allowed
|
|
|
|
|
2020-06-05 05:47:20 -04:00
|
|
|
def _prune_message_counts(self, time_now_s: int):
|
|
|
|
"""Remove message count entries that have not exceeded their defined
|
|
|
|
rate_hz limit
|
|
|
|
|
|
|
|
Args:
|
|
|
|
time_now_s: The current time
|
|
|
|
"""
|
|
|
|
# We create a copy of the key list here as the dictionary is modified during
|
|
|
|
# the loop
|
|
|
|
for key in list(self.actions.keys()):
|
|
|
|
action_count, time_start, rate_hz = self.actions[key]
|
|
|
|
|
|
|
|
# Rate limit = "seconds since we started limiting this action" * rate_hz
|
|
|
|
# If this limit has not been exceeded, wipe our record of this action
|
2014-09-02 10:06:20 -04:00
|
|
|
time_delta = time_now_s - time_start
|
2020-06-05 05:47:20 -04:00
|
|
|
if action_count - time_delta * rate_hz > 0:
|
|
|
|
continue
|
2014-09-02 10:06:20 -04:00
|
|
|
else:
|
2020-06-05 05:47:20 -04:00
|
|
|
del self.actions[key]
|
|
|
|
|
|
|
|
def ratelimit(
|
|
|
|
self,
|
|
|
|
key: Any,
|
|
|
|
rate_hz: Optional[float] = None,
|
|
|
|
burst_count: Optional[int] = None,
|
|
|
|
update: bool = True,
|
|
|
|
_time_now_s: Optional[int] = None,
|
|
|
|
):
|
|
|
|
"""Checks if an action can be performed. If not, raises a LimitExceededError
|
|
|
|
|
|
|
|
Args:
|
|
|
|
key: An arbitrary key used to classify an action
|
|
|
|
rate_hz: The long term number of actions that can be performed in a second.
|
|
|
|
Overrides the value set during instantiation if set.
|
|
|
|
burst_count: How many actions that can be performed before being limited.
|
|
|
|
Overrides the value set during instantiation if set.
|
|
|
|
update: Whether to count this check as performing the action
|
|
|
|
_time_now_s: The current time. Optional, defaults to the current time according
|
|
|
|
to self.clock. Only used by tests.
|
|
|
|
|
|
|
|
Raises:
|
|
|
|
LimitExceededError: If an action could not be performed, along with the time in
|
|
|
|
milliseconds until the action can be performed again
|
|
|
|
"""
|
|
|
|
time_now_s = _time_now_s if _time_now_s is not None else self.clock.time()
|
2019-03-15 13:46:16 -04:00
|
|
|
|
|
|
|
allowed, time_allowed = self.can_do_action(
|
2020-06-05 05:47:20 -04:00
|
|
|
key,
|
|
|
|
rate_hz=rate_hz,
|
|
|
|
burst_count=burst_count,
|
|
|
|
update=update,
|
|
|
|
_time_now_s=time_now_s,
|
2019-03-15 13:46:16 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
if not allowed:
|
|
|
|
raise LimitExceededError(
|
2019-06-20 05:32:02 -04:00
|
|
|
retry_after_ms=int(1000 * (time_allowed - time_now_s))
|
2019-03-15 13:46:16 -04:00
|
|
|
)
|