mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
f21e24ffc2
We do it this way round so that only the "owner" can delete the access token (i.e. `/logout/all` by the "owner" also deletes that token, but `/logout/all` by the "target user" doesn't).
A future PR will add an API for creating such a token.
When the target user and authenticated entity are different the `Processed request` log line will be logged with a: `{@admin:server as @bob:server} ...`. I'm not convinced by that format (especially since it adds spaces in there, making it harder to use `cut -d ' '` to chop off the start of log lines). Suggestions welcome.
171 lines
6.5 KiB
Python
171 lines
6.5 KiB
Python
from synapse.api.ratelimiting import LimitExceededError, Ratelimiter
|
|
from synapse.appservice import ApplicationService
|
|
from synapse.types import create_requester
|
|
|
|
from tests import unittest
|
|
|
|
|
|
class TestRatelimiter(unittest.TestCase):
|
|
def test_allowed_via_can_do_action(self):
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
allowed, time_allowed = limiter.can_do_action(key="test_id", _time_now_s=0)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(10.0, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_do_action(key="test_id", _time_now_s=5)
|
|
self.assertFalse(allowed)
|
|
self.assertEquals(10.0, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_do_action(key="test_id", _time_now_s=10)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(20.0, time_allowed)
|
|
|
|
def test_allowed_user_via_can_requester_do_action(self):
|
|
user_requester = create_requester("@user:example.com")
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
user_requester, _time_now_s=0
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(10.0, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
user_requester, _time_now_s=5
|
|
)
|
|
self.assertFalse(allowed)
|
|
self.assertEquals(10.0, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
user_requester, _time_now_s=10
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(20.0, time_allowed)
|
|
|
|
def test_allowed_appservice_ratelimited_via_can_requester_do_action(self):
|
|
appservice = ApplicationService(
|
|
None, "example.com", id="foo", rate_limited=True, sender="@as:example.com",
|
|
)
|
|
as_requester = create_requester("@user:example.com", app_service=appservice)
|
|
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
as_requester, _time_now_s=0
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(10.0, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
as_requester, _time_now_s=5
|
|
)
|
|
self.assertFalse(allowed)
|
|
self.assertEquals(10.0, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
as_requester, _time_now_s=10
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(20.0, time_allowed)
|
|
|
|
def test_allowed_appservice_via_can_requester_do_action(self):
|
|
appservice = ApplicationService(
|
|
None, "example.com", id="foo", rate_limited=False, sender="@as:example.com",
|
|
)
|
|
as_requester = create_requester("@user:example.com", app_service=appservice)
|
|
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
as_requester, _time_now_s=0
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(-1, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
as_requester, _time_now_s=5
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(-1, time_allowed)
|
|
|
|
allowed, time_allowed = limiter.can_requester_do_action(
|
|
as_requester, _time_now_s=10
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEquals(-1, time_allowed)
|
|
|
|
def test_allowed_via_ratelimit(self):
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
|
|
# Shouldn't raise
|
|
limiter.ratelimit(key="test_id", _time_now_s=0)
|
|
|
|
# Should raise
|
|
with self.assertRaises(LimitExceededError) as context:
|
|
limiter.ratelimit(key="test_id", _time_now_s=5)
|
|
self.assertEqual(context.exception.retry_after_ms, 5000)
|
|
|
|
# Shouldn't raise
|
|
limiter.ratelimit(key="test_id", _time_now_s=10)
|
|
|
|
def test_allowed_via_can_do_action_and_overriding_parameters(self):
|
|
"""Test that we can override options of can_do_action that would otherwise fail
|
|
an action
|
|
"""
|
|
# Create a Ratelimiter with a very low allowed rate_hz and burst_count
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
|
|
# First attempt should be allowed
|
|
allowed, time_allowed = limiter.can_do_action(("test_id",), _time_now_s=0,)
|
|
self.assertTrue(allowed)
|
|
self.assertEqual(10.0, time_allowed)
|
|
|
|
# Second attempt, 1s later, will fail
|
|
allowed, time_allowed = limiter.can_do_action(("test_id",), _time_now_s=1,)
|
|
self.assertFalse(allowed)
|
|
self.assertEqual(10.0, time_allowed)
|
|
|
|
# But, if we allow 10 actions/sec for this request, we should be allowed
|
|
# to continue.
|
|
allowed, time_allowed = limiter.can_do_action(
|
|
("test_id",), _time_now_s=1, rate_hz=10.0
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEqual(1.1, time_allowed)
|
|
|
|
# Similarly if we allow a burst of 10 actions
|
|
allowed, time_allowed = limiter.can_do_action(
|
|
("test_id",), _time_now_s=1, burst_count=10
|
|
)
|
|
self.assertTrue(allowed)
|
|
self.assertEqual(1.0, time_allowed)
|
|
|
|
def test_allowed_via_ratelimit_and_overriding_parameters(self):
|
|
"""Test that we can override options of the ratelimit method that would otherwise
|
|
fail an action
|
|
"""
|
|
# Create a Ratelimiter with a very low allowed rate_hz and burst_count
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
|
|
# First attempt should be allowed
|
|
limiter.ratelimit(key=("test_id",), _time_now_s=0)
|
|
|
|
# Second attempt, 1s later, will fail
|
|
with self.assertRaises(LimitExceededError) as context:
|
|
limiter.ratelimit(key=("test_id",), _time_now_s=1)
|
|
self.assertEqual(context.exception.retry_after_ms, 9000)
|
|
|
|
# But, if we allow 10 actions/sec for this request, we should be allowed
|
|
# to continue.
|
|
limiter.ratelimit(key=("test_id",), _time_now_s=1, rate_hz=10.0)
|
|
|
|
# Similarly if we allow a burst of 10 actions
|
|
limiter.ratelimit(key=("test_id",), _time_now_s=1, burst_count=10)
|
|
|
|
def test_pruning(self):
|
|
limiter = Ratelimiter(clock=None, rate_hz=0.1, burst_count=1)
|
|
limiter.can_do_action(key="test_id_1", _time_now_s=0)
|
|
|
|
self.assertIn("test_id_1", limiter.actions)
|
|
|
|
limiter.can_do_action(key="test_id_2", _time_now_s=10)
|
|
|
|
self.assertNotIn("test_id_1", limiter.actions)
|