2019-05-29 09:47:16 -06:00
|
|
|
#
|
2023-11-21 13:29:58 -07:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2019-05-29 09:47:16 -06:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
2023-08-24 17:38:46 -06:00
|
|
|
from unittest.mock import AsyncMock
|
2019-07-29 10:47:27 -06:00
|
|
|
|
|
|
|
from synapse.api.errors import Codes, SynapseError
|
2019-05-29 09:47:16 -06:00
|
|
|
from synapse.rest import admin
|
2021-08-17 05:57:58 -06:00
|
|
|
from synapse.rest.client import login, room
|
2023-02-14 12:03:35 -07:00
|
|
|
from synapse.types import JsonDict, UserID, create_requester
|
2019-05-29 09:47:16 -06:00
|
|
|
|
|
|
|
from tests import unittest
|
|
|
|
|
|
|
|
|
2019-11-27 14:54:07 -07:00
|
|
|
class RoomComplexityTests(unittest.FederatingHomeserverTestCase):
|
2019-05-29 09:47:16 -06:00
|
|
|
servlets = [
|
|
|
|
admin.register_servlets,
|
|
|
|
room.register_servlets,
|
|
|
|
login.register_servlets,
|
|
|
|
]
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def default_config(self) -> JsonDict:
|
2020-03-24 12:33:49 -06:00
|
|
|
config = super().default_config()
|
2019-07-29 10:47:27 -06:00
|
|
|
config["limit_remote_rooms"] = {"enabled": True, "complexity": 0.05}
|
2019-05-29 09:47:16 -06:00
|
|
|
return config
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def test_complexity_simple(self) -> None:
|
2019-05-29 09:47:16 -06:00
|
|
|
u1 = self.register_user("u1", "pass")
|
|
|
|
u1_token = self.login("u1", "pass")
|
|
|
|
|
|
|
|
room_1 = self.helper.create_room_as(u1, tok=u1_token)
|
|
|
|
self.helper.send_state(
|
|
|
|
room_1, event_type="m.room.topic", body={"topic": "foo"}, tok=u1_token
|
|
|
|
)
|
|
|
|
|
|
|
|
# Get the room complexity
|
2022-02-11 05:06:02 -07:00
|
|
|
channel = self.make_signed_federation_request(
|
2019-05-29 09:47:16 -06:00
|
|
|
"GET", "/_matrix/federation/unstable/rooms/%s/complexity" % (room_1,)
|
|
|
|
)
|
2022-08-05 08:59:09 -06:00
|
|
|
self.assertEqual(200, channel.code)
|
2019-05-29 09:47:16 -06:00
|
|
|
complexity = channel.json_body["v1"]
|
|
|
|
self.assertTrue(complexity > 0, complexity)
|
|
|
|
|
|
|
|
# Artificially raise the complexity
|
2022-02-23 04:04:02 -07:00
|
|
|
store = self.hs.get_datastores().main
|
2023-02-14 12:03:35 -07:00
|
|
|
|
|
|
|
async def get_current_state_event_counts(room_id: str) -> int:
|
|
|
|
return int(500 * 1.23)
|
|
|
|
|
2023-08-29 08:38:56 -06:00
|
|
|
store.get_current_state_event_counts = get_current_state_event_counts # type: ignore[method-assign]
|
2019-05-29 09:47:16 -06:00
|
|
|
|
|
|
|
# Get the room complexity again -- make sure it's our artificial value
|
2022-02-11 05:06:02 -07:00
|
|
|
channel = self.make_signed_federation_request(
|
2019-05-29 09:47:16 -06:00
|
|
|
"GET", "/_matrix/federation/unstable/rooms/%s/complexity" % (room_1,)
|
|
|
|
)
|
2022-08-05 08:59:09 -06:00
|
|
|
self.assertEqual(200, channel.code)
|
2019-05-29 09:47:16 -06:00
|
|
|
complexity = channel.json_body["v1"]
|
|
|
|
self.assertEqual(complexity, 1.23)
|
2019-07-29 10:47:27 -06:00
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def test_join_too_large(self) -> None:
|
2019-07-29 10:47:27 -06:00
|
|
|
u1 = self.register_user("u1", "pass")
|
|
|
|
|
|
|
|
handler = self.hs.get_room_member_handler()
|
|
|
|
fed_transport = self.hs.get_federation_transport_client()
|
|
|
|
|
|
|
|
# Mock out some things, because we don't want to test the whole join
|
2023-08-29 08:38:56 -06:00
|
|
|
fed_transport.client.get_json = AsyncMock(return_value={"v1": 9999}) # type: ignore[method-assign]
|
|
|
|
handler.federation_handler.do_invite_join = AsyncMock( # type: ignore[method-assign]
|
2023-08-24 17:38:46 -06:00
|
|
|
return_value=("", 1)
|
2020-05-22 07:21:54 -06:00
|
|
|
)
|
2019-07-29 10:47:27 -06:00
|
|
|
|
|
|
|
d = handler._remote_join(
|
2023-02-14 12:03:35 -07:00
|
|
|
create_requester(u1),
|
2019-11-27 14:54:07 -07:00
|
|
|
["other.example.com"],
|
2019-07-29 10:47:27 -06:00
|
|
|
"roomid",
|
|
|
|
UserID.from_string(u1),
|
|
|
|
{"membership": "join"},
|
|
|
|
)
|
|
|
|
|
|
|
|
self.pump()
|
|
|
|
|
|
|
|
# The request failed with a SynapseError saying the resource limit was
|
|
|
|
# exceeded.
|
|
|
|
f = self.get_failure(d, SynapseError)
|
|
|
|
self.assertEqual(f.value.code, 400, f.value)
|
|
|
|
self.assertEqual(f.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def test_join_too_large_admin(self) -> None:
|
2020-07-28 06:41:44 -06:00
|
|
|
# Check whether an admin can join if option "admins_can_join" is undefined,
|
|
|
|
# this option defaults to false, so the join should fail.
|
|
|
|
|
|
|
|
u1 = self.register_user("u1", "pass", admin=True)
|
|
|
|
|
|
|
|
handler = self.hs.get_room_member_handler()
|
|
|
|
fed_transport = self.hs.get_federation_transport_client()
|
|
|
|
|
|
|
|
# Mock out some things, because we don't want to test the whole join
|
2023-08-29 08:38:56 -06:00
|
|
|
fed_transport.client.get_json = AsyncMock(return_value={"v1": 9999}) # type: ignore[method-assign]
|
|
|
|
handler.federation_handler.do_invite_join = AsyncMock( # type: ignore[method-assign]
|
2023-08-24 17:38:46 -06:00
|
|
|
return_value=("", 1)
|
2020-07-28 06:41:44 -06:00
|
|
|
)
|
|
|
|
|
|
|
|
d = handler._remote_join(
|
2023-02-14 12:03:35 -07:00
|
|
|
create_requester(u1),
|
2020-07-28 06:41:44 -06:00
|
|
|
["other.example.com"],
|
|
|
|
"roomid",
|
|
|
|
UserID.from_string(u1),
|
|
|
|
{"membership": "join"},
|
|
|
|
)
|
|
|
|
|
|
|
|
self.pump()
|
|
|
|
|
|
|
|
# The request failed with a SynapseError saying the resource limit was
|
|
|
|
# exceeded.
|
|
|
|
f = self.get_failure(d, SynapseError)
|
|
|
|
self.assertEqual(f.value.code, 400, f.value)
|
|
|
|
self.assertEqual(f.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def test_join_too_large_once_joined(self) -> None:
|
2019-07-29 10:47:27 -06:00
|
|
|
u1 = self.register_user("u1", "pass")
|
|
|
|
u1_token = self.login("u1", "pass")
|
|
|
|
|
|
|
|
# Ok, this might seem a bit weird -- I want to test that we actually
|
|
|
|
# leave the room, but I don't want to simulate two servers. So, we make
|
|
|
|
# a local room, which we say we're joining remotely, even if there's no
|
|
|
|
# remote, because we mock that out. Then, we'll leave the (actually
|
|
|
|
# local) room, which will be propagated over federation in a real
|
|
|
|
# scenario.
|
|
|
|
room_1 = self.helper.create_room_as(u1, tok=u1_token)
|
|
|
|
|
|
|
|
handler = self.hs.get_room_member_handler()
|
|
|
|
fed_transport = self.hs.get_federation_transport_client()
|
|
|
|
|
|
|
|
# Mock out some things, because we don't want to test the whole join
|
2023-08-29 08:38:56 -06:00
|
|
|
fed_transport.client.get_json = AsyncMock(return_value=None) # type: ignore[method-assign]
|
|
|
|
handler.federation_handler.do_invite_join = AsyncMock( # type: ignore[method-assign]
|
2023-08-24 17:38:46 -06:00
|
|
|
return_value=("", 1)
|
2020-05-22 07:21:54 -06:00
|
|
|
)
|
2019-07-29 10:47:27 -06:00
|
|
|
|
|
|
|
# Artificially raise the complexity
|
2023-02-14 12:03:35 -07:00
|
|
|
async def get_current_state_event_counts(room_id: str) -> int:
|
|
|
|
return 600
|
|
|
|
|
2023-08-29 08:38:56 -06:00
|
|
|
self.hs.get_datastores().main.get_current_state_event_counts = get_current_state_event_counts # type: ignore[method-assign]
|
2019-07-29 10:47:27 -06:00
|
|
|
|
|
|
|
d = handler._remote_join(
|
2023-02-14 12:03:35 -07:00
|
|
|
create_requester(u1),
|
2019-11-27 14:54:07 -07:00
|
|
|
["other.example.com"],
|
2019-07-29 10:47:27 -06:00
|
|
|
room_1,
|
|
|
|
UserID.from_string(u1),
|
|
|
|
{"membership": "join"},
|
|
|
|
)
|
|
|
|
|
|
|
|
self.pump()
|
|
|
|
|
|
|
|
# The request failed with a SynapseError saying the resource limit was
|
|
|
|
# exceeded.
|
|
|
|
f = self.get_failure(d, SynapseError)
|
|
|
|
self.assertEqual(f.value.code, 400)
|
|
|
|
self.assertEqual(f.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
2020-07-28 06:41:44 -06:00
|
|
|
|
|
|
|
|
|
|
|
class RoomComplexityAdminTests(unittest.FederatingHomeserverTestCase):
|
|
|
|
# Test the behavior of joining rooms which exceed the complexity if option
|
|
|
|
# limit_remote_rooms.admins_can_join is True.
|
|
|
|
|
|
|
|
servlets = [
|
|
|
|
admin.register_servlets,
|
|
|
|
room.register_servlets,
|
|
|
|
login.register_servlets,
|
|
|
|
]
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def default_config(self) -> JsonDict:
|
2020-07-28 06:41:44 -06:00
|
|
|
config = super().default_config()
|
|
|
|
config["limit_remote_rooms"] = {
|
|
|
|
"enabled": True,
|
|
|
|
"complexity": 0.05,
|
|
|
|
"admins_can_join": True,
|
|
|
|
}
|
|
|
|
return config
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def test_join_too_large_no_admin(self) -> None:
|
2020-07-28 06:41:44 -06:00
|
|
|
# A user which is not an admin should not be able to join a remote room
|
|
|
|
# which is too complex.
|
|
|
|
|
|
|
|
u1 = self.register_user("u1", "pass")
|
|
|
|
|
|
|
|
handler = self.hs.get_room_member_handler()
|
|
|
|
fed_transport = self.hs.get_federation_transport_client()
|
|
|
|
|
|
|
|
# Mock out some things, because we don't want to test the whole join
|
2023-08-29 08:38:56 -06:00
|
|
|
fed_transport.client.get_json = AsyncMock(return_value={"v1": 9999}) # type: ignore[method-assign]
|
|
|
|
handler.federation_handler.do_invite_join = AsyncMock( # type: ignore[method-assign]
|
2023-08-24 17:38:46 -06:00
|
|
|
return_value=("", 1)
|
2020-07-28 06:41:44 -06:00
|
|
|
)
|
|
|
|
|
|
|
|
d = handler._remote_join(
|
2023-02-14 12:03:35 -07:00
|
|
|
create_requester(u1),
|
2020-07-28 06:41:44 -06:00
|
|
|
["other.example.com"],
|
|
|
|
"roomid",
|
|
|
|
UserID.from_string(u1),
|
|
|
|
{"membership": "join"},
|
|
|
|
)
|
|
|
|
|
|
|
|
self.pump()
|
|
|
|
|
|
|
|
# The request failed with a SynapseError saying the resource limit was
|
|
|
|
# exceeded.
|
|
|
|
f = self.get_failure(d, SynapseError)
|
|
|
|
self.assertEqual(f.value.code, 400, f.value)
|
|
|
|
self.assertEqual(f.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
|
2023-02-06 09:05:06 -07:00
|
|
|
def test_join_too_large_admin(self) -> None:
|
2020-07-28 06:41:44 -06:00
|
|
|
# An admin should be able to join rooms where a complexity check fails.
|
|
|
|
|
|
|
|
u1 = self.register_user("u1", "pass", admin=True)
|
|
|
|
|
|
|
|
handler = self.hs.get_room_member_handler()
|
|
|
|
fed_transport = self.hs.get_federation_transport_client()
|
|
|
|
|
|
|
|
# Mock out some things, because we don't want to test the whole join
|
2023-08-29 08:38:56 -06:00
|
|
|
fed_transport.client.get_json = AsyncMock(return_value={"v1": 9999}) # type: ignore[method-assign]
|
|
|
|
handler.federation_handler.do_invite_join = AsyncMock( # type: ignore[method-assign]
|
2023-08-24 17:38:46 -06:00
|
|
|
return_value=("", 1)
|
2020-07-28 06:41:44 -06:00
|
|
|
)
|
|
|
|
|
|
|
|
d = handler._remote_join(
|
2023-02-14 12:03:35 -07:00
|
|
|
create_requester(u1),
|
2020-07-28 06:41:44 -06:00
|
|
|
["other.example.com"],
|
|
|
|
"roomid",
|
|
|
|
UserID.from_string(u1),
|
|
|
|
{"membership": "join"},
|
|
|
|
)
|
|
|
|
|
|
|
|
self.pump()
|
|
|
|
|
|
|
|
# The request success since the user is an admin
|
|
|
|
self.get_success(d)
|