Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Rate limiti joins per-room, accounting for joins created by other servers #13169

Closed
wants to merge 23 commits into from
Closed

Rate limiti joins per-room, accounting for joins created by other servers #13169

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
bd873e6
Define config for room-level join limiter
Jun 28, 2022
453f621
Rate limiter: describe leaky bucket
Jun 28, 2022
c2e3025
Rate limiter: Pull out some small methods
Jun 28, 2022
c594ab7
Rate limiter: Introduce `record_action`
Jun 28, 2022
9d4cdae
Notifier: accept callbacks to fire on room joins
Jul 4, 2022
77de159
Room member: drive-by-comment
Jun 28, 2022
ae788ca
Replication: include `outlier` in event rows
Jun 29, 2022
4230112
Add helper to determine if we persist event or not
Jul 4, 2022
6b47e82
Track per-room join rates actioned by this worker
Jun 29, 2022
0bb4122
Snoop on replication to learn about joins on other workers
Jun 29, 2022
7a14b94
Test cases
Jun 29, 2022
240e32f
Fixes to unit tests
Jul 4, 2022
121590a
Changelog
Jul 4, 2022
dcb1683
Move comment translating between bucket terminology
Jul 8, 2022
4da8f29
Tweak phrasing; note the version adding the option
Jul 8, 2022
9d92531
Announce new config option in the changelog
Jul 8, 2022
e16294e
Be more explicit about the default values
Jul 8, 2022
81eb4ab
Update rate limiter in the event persister logic
Jul 8, 2022
8377172
Use `add_hashes_and_signatures_from_other_server`
Jul 11, 2022
47acf46
Don't require `ratelimit` to notify for joins
Jul 11, 2022
fda6252
Also notify of join events via another path
Jul 11, 2022
5cf6700
Monstrous test update of doom
Jul 11, 2022
80e2e0b
Don't use newsfiles for config changes
Jul 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docker/complement/conf/workers-shared-extra.yaml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ rc_joins:
per_second: 9999
burst_count: 9999

rc_joins_per_room:
per_second: 9999
burst_count: 9999

rc_3pid_validation:
per_second: 1000
burst_count: 1000
Expand Down
16 changes: 16 additions & 0 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1380,6 +1380,22 @@ rc_joins:
burst_count: 12
```
---
### `rc_joins_per_room`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind adding info here about what release this config option will be added in?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can do.


This option allows for ratelimiting joins to a room based on the number of recent
joins (local or remote) to that room. It is intended to mitigate mass-join spam
waves which target multiple homeservers.

Sensible values for this option are provided by default; most server admins
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved
won't need to adjust this setting.

Example configuration:
```yaml
rc_joins_per_room:
per_second: 1
burst_count: 10
```
---
### `rc_3pid_validation`

This option ratelimits how often a user or IP can attempt to validate a 3PID.
Expand Down
7 changes: 7 additions & 0 deletions synapse/config/ratelimiting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ def read_config(self, config: JsonDict, **kwargs: Any) -> None:
defaults={"per_second": 0.01, "burst_count": 10},
)

# Track the rate of joins to a given room. If there are too many, temporarily
# prevent local joins and remote joins via this server.
self.rc_joins_per_room = RateLimitConfig(
config.get("rc_joins_per_room", {}),
defaults={"per_second": 1, "burst_count": 10},
)

# Ratelimit cross-user key requests:
# * For local requests this is keyed by the sending device.
# * For requests received over federation this is keyed by the origin.
Expand Down
1 change: 1 addition & 0 deletions tests/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ def default_config(name, parse=False):
"local": {"per_second": 10000, "burst_count": 10000},
"remote": {"per_second": 10000, "burst_count": 10000},
},
"rc_joins_per_room": {"per_second": 10000, "burst_count": 10000},
"rc_invites": {
"per_room": {"per_second": 10000, "burst_count": 10000},
"per_user": {"per_second": 10000, "burst_count": 10000},
Expand Down