567 lines
18 KiB
Python
567 lines
18 KiB
Python
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# 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 unittest
|
|
from typing import Optional
|
|
|
|
from synapse import event_auth
|
|
from synapse.api.constants import EventContentFields
|
|
from synapse.api.errors import AuthError
|
|
from synapse.api.room_versions import RoomVersions
|
|
from synapse.events import EventBase, make_event_from_dict
|
|
from synapse.types import JsonDict, get_domain_from_id
|
|
|
|
|
|
class EventAuthTestCase(unittest.TestCase):
|
|
def test_random_users_cannot_send_state_before_first_pl(self):
|
|
"""
|
|
Check that, before the first PL lands, the creator is the only user
|
|
that can send a state event.
|
|
"""
|
|
creator = "@creator:example.com"
|
|
joiner = "@joiner:example.com"
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
("m.room.member", joiner): _join_event(joiner),
|
|
}
|
|
|
|
# creator should be able to send state
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_random_state_event(creator),
|
|
auth_events,
|
|
)
|
|
|
|
# joiner should not be able to send state
|
|
self.assertRaises(
|
|
AuthError,
|
|
event_auth.check_auth_rules_for_event,
|
|
RoomVersions.V1,
|
|
_random_state_event(joiner),
|
|
auth_events,
|
|
)
|
|
|
|
def test_state_default_level(self):
|
|
"""
|
|
Check that users above the state_default level can send state and
|
|
those below cannot
|
|
"""
|
|
creator = "@creator:example.com"
|
|
pleb = "@joiner:example.com"
|
|
king = "@joiner2:example.com"
|
|
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
("m.room.power_levels", ""): _power_levels_event(
|
|
creator, {"state_default": "30", "users": {pleb: "29", king: "30"}}
|
|
),
|
|
("m.room.member", pleb): _join_event(pleb),
|
|
("m.room.member", king): _join_event(king),
|
|
}
|
|
|
|
# pleb should not be able to send state
|
|
self.assertRaises(
|
|
AuthError,
|
|
event_auth.check_auth_rules_for_event,
|
|
RoomVersions.V1,
|
|
_random_state_event(pleb),
|
|
auth_events,
|
|
),
|
|
|
|
# king should be able to send state
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_random_state_event(king),
|
|
auth_events,
|
|
)
|
|
|
|
def test_alias_event(self):
|
|
"""Alias events have special behavior up through room version 6."""
|
|
creator = "@creator:example.com"
|
|
other = "@other:example.com"
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
}
|
|
|
|
# creator should be able to send aliases
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_alias_event(creator),
|
|
auth_events,
|
|
)
|
|
|
|
# Reject an event with no state key.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_alias_event(creator, state_key=""),
|
|
auth_events,
|
|
)
|
|
|
|
# If the domain of the sender does not match the state key, reject.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_alias_event(creator, state_key="test.com"),
|
|
auth_events,
|
|
)
|
|
|
|
# Note that the member does *not* need to be in the room.
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_alias_event(other),
|
|
auth_events,
|
|
)
|
|
|
|
def test_msc2432_alias_event(self):
|
|
"""After MSC2432, alias events have no special behavior."""
|
|
creator = "@creator:example.com"
|
|
other = "@other:example.com"
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
}
|
|
|
|
# creator should be able to send aliases
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_alias_event(creator),
|
|
auth_events,
|
|
)
|
|
|
|
# No particular checks are done on the state key.
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_alias_event(creator, state_key=""),
|
|
auth_events,
|
|
)
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_alias_event(creator, state_key="test.com"),
|
|
auth_events,
|
|
)
|
|
|
|
# Per standard auth rules, the member must be in the room.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_alias_event(other),
|
|
auth_events,
|
|
)
|
|
|
|
def test_msc2209(self):
|
|
"""
|
|
Notifications power levels get checked due to MSC2209.
|
|
"""
|
|
creator = "@creator:example.com"
|
|
pleb = "@joiner:example.com"
|
|
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
("m.room.power_levels", ""): _power_levels_event(
|
|
creator, {"state_default": "30", "users": {pleb: "30"}}
|
|
),
|
|
("m.room.member", pleb): _join_event(pleb),
|
|
}
|
|
|
|
# pleb should be able to modify the notifications power level.
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V1,
|
|
_power_levels_event(pleb, {"notifications": {"room": 100}}),
|
|
auth_events,
|
|
)
|
|
|
|
# But an MSC2209 room rejects this change.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_power_levels_event(pleb, {"notifications": {"room": 100}}),
|
|
auth_events,
|
|
)
|
|
|
|
def test_join_rules_public(self):
|
|
"""
|
|
Test joining a public room.
|
|
"""
|
|
creator = "@creator:example.com"
|
|
pleb = "@joiner:example.com"
|
|
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
("m.room.join_rules", ""): _join_rules_event(creator, "public"),
|
|
}
|
|
|
|
# Check join.
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user cannot be force-joined to a room.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_member_event(pleb, "join", sender=creator),
|
|
auth_events,
|
|
)
|
|
|
|
# Banned should be rejected.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "ban")
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user who left can re-join.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "leave")
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user can send a join if they're in the room.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "join")
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user can accept an invite.
|
|
auth_events[("m.room.member", pleb)] = _member_event(
|
|
pleb, "invite", sender=creator
|
|
)
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
def test_join_rules_invite(self):
|
|
"""
|
|
Test joining an invite only room.
|
|
"""
|
|
creator = "@creator:example.com"
|
|
pleb = "@joiner:example.com"
|
|
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
("m.room.join_rules", ""): _join_rules_event(creator, "invite"),
|
|
}
|
|
|
|
# A join without an invite is rejected.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user cannot be force-joined to a room.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_member_event(pleb, "join", sender=creator),
|
|
auth_events,
|
|
)
|
|
|
|
# Banned should be rejected.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "ban")
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user who left cannot re-join.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "leave")
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user can send a join if they're in the room.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "join")
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user can accept an invite.
|
|
auth_events[("m.room.member", pleb)] = _member_event(
|
|
pleb, "invite", sender=creator
|
|
)
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
def test_join_rules_msc3083_restricted(self):
|
|
"""
|
|
Test joining a restricted room from MSC3083.
|
|
|
|
This is similar to the public test, but has some additional checks on
|
|
signatures.
|
|
|
|
The checks which care about signatures fake them by simply adding an
|
|
object of the proper form, not generating valid signatures.
|
|
"""
|
|
creator = "@creator:example.com"
|
|
pleb = "@joiner:example.com"
|
|
|
|
auth_events = {
|
|
("m.room.create", ""): _create_event(creator),
|
|
("m.room.member", creator): _join_event(creator),
|
|
("m.room.power_levels", ""): _power_levels_event(creator, {"invite": 0}),
|
|
("m.room.join_rules", ""): _join_rules_event(creator, "restricted"),
|
|
}
|
|
|
|
# Older room versions don't understand this join rule
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V6,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A properly formatted join event should work.
|
|
authorised_join_event = _join_event(
|
|
pleb,
|
|
additional_content={
|
|
EventContentFields.AUTHORISING_USER: "@creator:example.com"
|
|
},
|
|
)
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
authorised_join_event,
|
|
auth_events,
|
|
)
|
|
|
|
# A join issued by a specific user works (i.e. the power level checks
|
|
# are done properly).
|
|
pl_auth_events = auth_events.copy()
|
|
pl_auth_events[("m.room.power_levels", "")] = _power_levels_event(
|
|
creator, {"invite": 100, "users": {"@inviter:foo.test": 150}}
|
|
)
|
|
pl_auth_events[("m.room.member", "@inviter:foo.test")] = _join_event(
|
|
"@inviter:foo.test"
|
|
)
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
_join_event(
|
|
pleb,
|
|
additional_content={
|
|
EventContentFields.AUTHORISING_USER: "@inviter:foo.test"
|
|
},
|
|
),
|
|
pl_auth_events,
|
|
)
|
|
|
|
# A join which is missing an authorised server is rejected.
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# An join authorised by a user who is not in the room is rejected.
|
|
pl_auth_events = auth_events.copy()
|
|
pl_auth_events[("m.room.power_levels", "")] = _power_levels_event(
|
|
creator, {"invite": 100, "users": {"@other:example.com": 150}}
|
|
)
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
_join_event(
|
|
pleb,
|
|
additional_content={
|
|
EventContentFields.AUTHORISING_USER: "@other:example.com"
|
|
},
|
|
),
|
|
auth_events,
|
|
)
|
|
|
|
# A user cannot be force-joined to a room. (This uses an event which
|
|
# *would* be valid, but is sent be a different user.)
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
_member_event(
|
|
pleb,
|
|
"join",
|
|
sender=creator,
|
|
additional_content={
|
|
EventContentFields.AUTHORISING_USER: "@inviter:foo.test"
|
|
},
|
|
),
|
|
auth_events,
|
|
)
|
|
|
|
# Banned should be rejected.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "ban")
|
|
with self.assertRaises(AuthError):
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
authorised_join_event,
|
|
auth_events,
|
|
)
|
|
|
|
# A user who left can re-join.
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "leave")
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
authorised_join_event,
|
|
auth_events,
|
|
)
|
|
|
|
# A user can send a join if they're in the room. (This doesn't need to
|
|
# be authorised since the user is already joined.)
|
|
auth_events[("m.room.member", pleb)] = _member_event(pleb, "join")
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
# A user can accept an invite. (This doesn't need to be authorised since
|
|
# the user was invited.)
|
|
auth_events[("m.room.member", pleb)] = _member_event(
|
|
pleb, "invite", sender=creator
|
|
)
|
|
event_auth.check_auth_rules_for_event(
|
|
RoomVersions.V8,
|
|
_join_event(pleb),
|
|
auth_events,
|
|
)
|
|
|
|
|
|
# helpers for making events
|
|
|
|
TEST_ROOM_ID = "!test:room"
|
|
|
|
|
|
def _create_event(user_id: str) -> EventBase:
|
|
return make_event_from_dict(
|
|
{
|
|
"room_id": TEST_ROOM_ID,
|
|
"event_id": _get_event_id(),
|
|
"type": "m.room.create",
|
|
"sender": user_id,
|
|
"content": {"creator": user_id},
|
|
}
|
|
)
|
|
|
|
|
|
def _member_event(
|
|
user_id: str,
|
|
membership: str,
|
|
sender: Optional[str] = None,
|
|
additional_content: Optional[dict] = None,
|
|
) -> EventBase:
|
|
return make_event_from_dict(
|
|
{
|
|
"room_id": TEST_ROOM_ID,
|
|
"event_id": _get_event_id(),
|
|
"type": "m.room.member",
|
|
"sender": sender or user_id,
|
|
"state_key": user_id,
|
|
"content": {"membership": membership, **(additional_content or {})},
|
|
"prev_events": [],
|
|
}
|
|
)
|
|
|
|
|
|
def _join_event(user_id: str, additional_content: Optional[dict] = None) -> EventBase:
|
|
return _member_event(user_id, "join", additional_content=additional_content)
|
|
|
|
|
|
def _power_levels_event(sender: str, content: JsonDict) -> EventBase:
|
|
return make_event_from_dict(
|
|
{
|
|
"room_id": TEST_ROOM_ID,
|
|
"event_id": _get_event_id(),
|
|
"type": "m.room.power_levels",
|
|
"sender": sender,
|
|
"state_key": "",
|
|
"content": content,
|
|
}
|
|
)
|
|
|
|
|
|
def _alias_event(sender: str, **kwargs) -> EventBase:
|
|
data = {
|
|
"room_id": TEST_ROOM_ID,
|
|
"event_id": _get_event_id(),
|
|
"type": "m.room.aliases",
|
|
"sender": sender,
|
|
"state_key": get_domain_from_id(sender),
|
|
"content": {"aliases": []},
|
|
}
|
|
data.update(**kwargs)
|
|
return make_event_from_dict(data)
|
|
|
|
|
|
def _random_state_event(sender: str) -> EventBase:
|
|
return make_event_from_dict(
|
|
{
|
|
"room_id": TEST_ROOM_ID,
|
|
"event_id": _get_event_id(),
|
|
"type": "test.state",
|
|
"sender": sender,
|
|
"state_key": "",
|
|
"content": {"membership": "join"},
|
|
}
|
|
)
|
|
|
|
|
|
def _join_rules_event(sender: str, join_rule: str) -> EventBase:
|
|
return make_event_from_dict(
|
|
{
|
|
"room_id": TEST_ROOM_ID,
|
|
"event_id": _get_event_id(),
|
|
"type": "m.room.join_rules",
|
|
"sender": sender,
|
|
"state_key": "",
|
|
"content": {
|
|
"join_rule": join_rule,
|
|
},
|
|
}
|
|
)
|
|
|
|
|
|
event_count = 0
|
|
|
|
|
|
def _get_event_id() -> str:
|
|
global event_count
|
|
c = event_count
|
|
event_count += 1
|
|
return "!%i:example.com" % (c,)
|