mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-28 23:20:09 +03:00
23740eaa3d
During the migration the automated script to update the copyright headers accidentally got rid of some of the existing copyright lines. Reinstate them.
255 lines
9.2 KiB
Python
255 lines
9.2 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2019 Matrix.org Foundation
|
|
# 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]
|
|
#
|
|
#
|
|
|
|
from unittest.mock import AsyncMock
|
|
|
|
from synapse.api.errors import Codes, SynapseError
|
|
from synapse.rest import admin
|
|
from synapse.rest.client import login, room
|
|
from synapse.types import JsonDict, UserID, create_requester
|
|
|
|
from tests import unittest
|
|
|
|
|
|
class RoomComplexityTests(unittest.FederatingHomeserverTestCase):
|
|
servlets = [
|
|
admin.register_servlets,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def default_config(self) -> JsonDict:
|
|
config = super().default_config()
|
|
config["limit_remote_rooms"] = {"enabled": True, "complexity": 0.05}
|
|
return config
|
|
|
|
def test_complexity_simple(self) -> None:
|
|
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
|
|
channel = self.make_signed_federation_request(
|
|
"GET", "/_matrix/federation/unstable/rooms/%s/complexity" % (room_1,)
|
|
)
|
|
self.assertEqual(200, channel.code)
|
|
complexity = channel.json_body["v1"]
|
|
self.assertTrue(complexity > 0, complexity)
|
|
|
|
# Artificially raise the complexity
|
|
store = self.hs.get_datastores().main
|
|
|
|
async def get_current_state_event_counts(room_id: str) -> int:
|
|
return int(500 * 1.23)
|
|
|
|
store.get_current_state_event_counts = get_current_state_event_counts # type: ignore[method-assign]
|
|
|
|
# Get the room complexity again -- make sure it's our artificial value
|
|
channel = self.make_signed_federation_request(
|
|
"GET", "/_matrix/federation/unstable/rooms/%s/complexity" % (room_1,)
|
|
)
|
|
self.assertEqual(200, channel.code)
|
|
complexity = channel.json_body["v1"]
|
|
self.assertEqual(complexity, 1.23)
|
|
|
|
def test_join_too_large(self) -> None:
|
|
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
|
|
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]
|
|
return_value=("", 1)
|
|
)
|
|
|
|
d = handler._remote_join(
|
|
create_requester(u1),
|
|
["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)
|
|
|
|
def test_join_too_large_admin(self) -> None:
|
|
# 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
|
|
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]
|
|
return_value=("", 1)
|
|
)
|
|
|
|
d = handler._remote_join(
|
|
create_requester(u1),
|
|
["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)
|
|
|
|
def test_join_too_large_once_joined(self) -> None:
|
|
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
|
|
fed_transport.client.get_json = AsyncMock(return_value=None) # type: ignore[method-assign]
|
|
handler.federation_handler.do_invite_join = AsyncMock( # type: ignore[method-assign]
|
|
return_value=("", 1)
|
|
)
|
|
|
|
# Artificially raise the complexity
|
|
async def get_current_state_event_counts(room_id: str) -> int:
|
|
return 600
|
|
|
|
self.hs.get_datastores().main.get_current_state_event_counts = get_current_state_event_counts # type: ignore[method-assign]
|
|
|
|
d = handler._remote_join(
|
|
create_requester(u1),
|
|
["other.example.com"],
|
|
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)
|
|
|
|
|
|
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,
|
|
]
|
|
|
|
def default_config(self) -> JsonDict:
|
|
config = super().default_config()
|
|
config["limit_remote_rooms"] = {
|
|
"enabled": True,
|
|
"complexity": 0.05,
|
|
"admins_can_join": True,
|
|
}
|
|
return config
|
|
|
|
def test_join_too_large_no_admin(self) -> None:
|
|
# 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
|
|
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]
|
|
return_value=("", 1)
|
|
)
|
|
|
|
d = handler._remote_join(
|
|
create_requester(u1),
|
|
["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)
|
|
|
|
def test_join_too_large_admin(self) -> None:
|
|
# 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
|
|
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]
|
|
return_value=("", 1)
|
|
)
|
|
|
|
d = handler._remote_join(
|
|
create_requester(u1),
|
|
["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)
|