123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313 |
- # Copyright 2020 The Matrix.org Foundation C.I.C.
- #
- # 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.
- import logging
- from typing import Tuple
- from synapse.api.constants import EventTypes
- from synapse.events import EventBase
- from synapse.events.snapshot import EventContext
- from synapse.rest import admin
- from synapse.rest.client import login, room
- from synapse.types import create_requester
- from synapse.util.stringutils import random_string
- from tests import unittest
- from tests.test_utils.event_injection import create_event
- logger = logging.getLogger(__name__)
- class EventCreationTestCase(unittest.HomeserverTestCase):
- servlets = [
- admin.register_servlets,
- login.register_servlets,
- room.register_servlets,
- ]
- def prepare(self, reactor, clock, hs):
- self.handler = self.hs.get_event_creation_handler()
- self.persist_event_storage = self.hs.get_storage().persistence
- self.user_id = self.register_user("tester", "foobar")
- self.access_token = self.login("tester", "foobar")
- self.room_id = self.helper.create_room_as(self.user_id, tok=self.access_token)
- self.info = self.get_success(
- self.hs.get_datastores().main.get_user_by_access_token(
- self.access_token,
- )
- )
- self.token_id = self.info.token_id
- self.requester = create_requester(self.user_id, access_token_id=self.token_id)
- def _create_and_persist_member_event(self) -> Tuple[EventBase, EventContext]:
- # Create a member event we can use as an auth_event
- memberEvent, memberEventContext = self.get_success(
- create_event(
- self.hs,
- room_id=self.room_id,
- type="m.room.member",
- sender=self.requester.user.to_string(),
- state_key=self.requester.user.to_string(),
- content={"membership": "join"},
- )
- )
- self.get_success(
- self.persist_event_storage.persist_event(memberEvent, memberEventContext)
- )
- return memberEvent, memberEventContext
- def _create_duplicate_event(self, txn_id: str) -> Tuple[EventBase, EventContext]:
- """Create a new event with the given transaction ID. All events produced
- by this method will be considered duplicates.
- """
- # We create a new event with a random body, as otherwise we'll produce
- # *exactly* the same event with the same hash, and so same event ID.
- return self.get_success(
- self.handler.create_event(
- self.requester,
- {
- "type": EventTypes.Message,
- "room_id": self.room_id,
- "sender": self.requester.user.to_string(),
- "content": {"msgtype": "m.text", "body": random_string(5)},
- },
- txn_id=txn_id,
- )
- )
- def test_duplicated_txn_id(self):
- """Test that attempting to handle/persist an event with a transaction ID
- that has already been persisted correctly returns the old event and does
- *not* produce duplicate messages.
- """
- txn_id = "something_suitably_random"
- event1, context = self._create_duplicate_event(txn_id)
- ret_event1 = self.get_success(
- self.handler.handle_new_client_event(self.requester, event1, context)
- )
- stream_id1 = ret_event1.internal_metadata.stream_ordering
- self.assertEqual(event1.event_id, ret_event1.event_id)
- event2, context = self._create_duplicate_event(txn_id)
- # We want to test that the deduplication at the persit event end works,
- # so we want to make sure we test with different events.
- self.assertNotEqual(event1.event_id, event2.event_id)
- ret_event2 = self.get_success(
- self.handler.handle_new_client_event(self.requester, event2, context)
- )
- stream_id2 = ret_event2.internal_metadata.stream_ordering
- # Assert that the returned values match those from the initial event
- # rather than the new one.
- self.assertEqual(ret_event1.event_id, ret_event2.event_id)
- self.assertEqual(stream_id1, stream_id2)
- # Let's test that calling `persist_event` directly also does the right
- # thing.
- event3, context = self._create_duplicate_event(txn_id)
- self.assertNotEqual(event1.event_id, event3.event_id)
- ret_event3, event_pos3, _ = self.get_success(
- self.persist_event_storage.persist_event(event3, context)
- )
- # Assert that the returned values match those from the initial event
- # rather than the new one.
- self.assertEqual(ret_event1.event_id, ret_event3.event_id)
- self.assertEqual(stream_id1, event_pos3.stream)
- # Let's test that calling `persist_events` directly also does the right
- # thing.
- event4, context = self._create_duplicate_event(txn_id)
- self.assertNotEqual(event1.event_id, event3.event_id)
- events, _ = self.get_success(
- self.persist_event_storage.persist_events([(event3, context)])
- )
- ret_event4 = events[0]
- # Assert that the returned values match those from the initial event
- # rather than the new one.
- self.assertEqual(ret_event1.event_id, ret_event4.event_id)
- def test_duplicated_txn_id_one_call(self):
- """Test that we correctly handle duplicates that we try and persist at
- the same time.
- """
- txn_id = "something_else_suitably_random"
- # Create two duplicate events to persist at the same time
- event1, context1 = self._create_duplicate_event(txn_id)
- event2, context2 = self._create_duplicate_event(txn_id)
- # Ensure their event IDs are different to start with
- self.assertNotEqual(event1.event_id, event2.event_id)
- events, _ = self.get_success(
- self.persist_event_storage.persist_events(
- [(event1, context1), (event2, context2)]
- )
- )
- # Check that we've deduplicated the events.
- self.assertEqual(len(events), 2)
- self.assertEqual(events[0].event_id, events[1].event_id)
- def test_when_empty_prev_events_allowed_create_event_with_empty_prev_events(self):
- """When we set allow_no_prev_events=True, should be able to create a
- event without any prev_events (only auth_events).
- """
- # Create a member event we can use as an auth_event
- memberEvent, _ = self._create_and_persist_member_event()
- # Try to create the event with empty prev_events bit with some auth_events
- event, _ = self.get_success(
- self.handler.create_event(
- self.requester,
- {
- "type": EventTypes.Message,
- "room_id": self.room_id,
- "sender": self.requester.user.to_string(),
- "content": {"msgtype": "m.text", "body": random_string(5)},
- },
- # Empty prev_events is the key thing we're testing here
- prev_event_ids=[],
- # But with some auth_events
- auth_event_ids=[memberEvent.event_id],
- # Allow no prev_events!
- allow_no_prev_events=True,
- )
- )
- self.assertIsNotNone(event)
- def test_when_empty_prev_events_not_allowed_reject_event_with_empty_prev_events(
- self,
- ):
- """When we set allow_no_prev_events=False, shouldn't be able to create a
- event without any prev_events even if it has auth_events. Expect an
- exception to be raised.
- """
- # Create a member event we can use as an auth_event
- memberEvent, _ = self._create_and_persist_member_event()
- # Try to create the event with empty prev_events but with some auth_events
- self.get_failure(
- self.handler.create_event(
- self.requester,
- {
- "type": EventTypes.Message,
- "room_id": self.room_id,
- "sender": self.requester.user.to_string(),
- "content": {"msgtype": "m.text", "body": random_string(5)},
- },
- # Empty prev_events is the key thing we're testing here
- prev_event_ids=[],
- # But with some auth_events
- auth_event_ids=[memberEvent.event_id],
- # We expect the test to fail because empty prev_events are not
- # allowed here!
- allow_no_prev_events=False,
- ),
- AssertionError,
- )
- def test_when_empty_prev_events_allowed_reject_event_with_empty_prev_events_and_auth_events(
- self,
- ):
- """When we set allow_no_prev_events=True, should be able to create a
- event without any prev_events or auth_events. Expect an exception to be
- raised.
- """
- # Try to create the event with empty prev_events and empty auth_events
- self.get_failure(
- self.handler.create_event(
- self.requester,
- {
- "type": EventTypes.Message,
- "room_id": self.room_id,
- "sender": self.requester.user.to_string(),
- "content": {"msgtype": "m.text", "body": random_string(5)},
- },
- prev_event_ids=[],
- # The event should be rejected when there are no auth_events
- auth_event_ids=[],
- # Allow no prev_events!
- allow_no_prev_events=True,
- ),
- AssertionError,
- )
- class ServerAclValidationTestCase(unittest.HomeserverTestCase):
- servlets = [
- admin.register_servlets,
- login.register_servlets,
- room.register_servlets,
- ]
- def prepare(self, reactor, clock, hs):
- self.user_id = self.register_user("tester", "foobar")
- self.access_token = self.login("tester", "foobar")
- self.room_id = self.helper.create_room_as(self.user_id, tok=self.access_token)
- def test_allow_server_acl(self):
- """Test that sending an ACL that blocks everyone but ourselves works."""
- self.helper.send_state(
- self.room_id,
- EventTypes.ServerACL,
- body={"allow": [self.hs.hostname]},
- tok=self.access_token,
- expect_code=200,
- )
- def test_deny_server_acl_block_outselves(self):
- """Test that sending an ACL that blocks ourselves does not work."""
- self.helper.send_state(
- self.room_id,
- EventTypes.ServerACL,
- body={},
- tok=self.access_token,
- expect_code=400,
- )
- def test_deny_redact_server_acl(self):
- """Test that attempting to redact an ACL is blocked."""
- body = self.helper.send_state(
- self.room_id,
- EventTypes.ServerACL,
- body={"allow": [self.hs.hostname]},
- tok=self.access_token,
- expect_code=200,
- )
- event_id = body["event_id"]
- # Redaction of event should fail.
- path = "/_matrix/client/r0/rooms/%s/redact/%s" % (self.room_id, event_id)
- channel = self.make_request(
- "POST", path, content={}, access_token=self.access_token
- )
- self.assertEqual(int(channel.result["code"]), 403)
|