mirror of
https://github.com/element-hq/synapse.git
synced 2026-11-11 12:17:54 +00:00
Part of #19415 (Support Matrix 1.17). Companion test PRs: - Complement: https://github.com/matrix-org/complement/pull/920 - Sytest: https://github.com/matrix-org/sytest/pull/1430 **What this does:** `experimental_features.msc4210_enabled` default value changed `true` ([MSC4210](https://github.com/matrix-org/matrix-spec-proposals/pull/4210)). The rest of the changes is fixing the tests, making sure test relying en mentions sends the proper `m.mentions` attribute. ## Migration plan Element Web has been writing both rule sets together since September 2023 ([matrix-react-sdk#11667](https://github.com/matrix-org/matrix-react-sdk/pull/11667), [element-web@0d367a7c7e](https://github.com/element-hq/element-web/commit/0d367a7c7e)), so for its users `.m.rule.is_user_mention` and `.m.rule.is_room_mention` already carry the same customisations as the legacy rules. <strike>For everyone else, #20215 adds a background update that migrates the overrides on the legacy rules to the intentional ones.</strike> ## Opt-out ```yaml experimental_features: msc4210_enabled: false ``` --- ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
827 lines
28 KiB
Python
827 lines
28 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
# Copyright (C) 2026 Element Creations 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 http import HTTPStatus
|
|
|
|
import canonicaljson
|
|
from parameterized.parameterized import parameterized
|
|
|
|
import synapse
|
|
from synapse.api.errors import Codes
|
|
from synapse.rest.client import login, push_rule, room
|
|
from synapse.types import JsonDict
|
|
|
|
from tests.unittest import HomeserverTestCase, override_config
|
|
|
|
|
|
class PushRuleAttributesTestCase(HomeserverTestCase):
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
push_rule.register_servlets,
|
|
]
|
|
hijack_auth = False
|
|
|
|
def test_enabled_on_creation(self) -> None:
|
|
"""
|
|
Tests the GET and PUT of push rules' `enabled` endpoints.
|
|
Tests that a rule is enabled upon creation, even though a rule with that
|
|
ruleId existed previously and was disabled.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# GET enabled for that new rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["enabled"], True)
|
|
|
|
def test_enabled_on_recreation(self) -> None:
|
|
"""
|
|
Tests the GET and PUT of push rules' `enabled` endpoints.
|
|
Tests that a rule is enabled upon creation, even if a rule with that
|
|
ruleId existed previously and was disabled.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# disable the rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/best.friend/enabled",
|
|
{"enabled": False},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# check rule disabled
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["enabled"], False)
|
|
|
|
# DELETE the rule
|
|
channel = self.make_request(
|
|
"DELETE", "/pushrules/global/override/best.friend", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# GET enabled for that new rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["enabled"], True)
|
|
|
|
def test_enabled_disable(self) -> None:
|
|
"""
|
|
Tests the GET and PUT of push rules' `enabled` endpoints.
|
|
Tests that a rule is disabled and enabled when we ask for it.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# disable the rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/best.friend/enabled",
|
|
{"enabled": False},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# check rule disabled
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["enabled"], False)
|
|
|
|
# re-enable the rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/best.friend/enabled",
|
|
{"enabled": True},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# check rule enabled
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["enabled"], True)
|
|
|
|
def test_enabled_404_when_get_non_existent(self) -> None:
|
|
"""
|
|
Tests that `enabled` gives 404 when the rule doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# GET enabled for that new rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# DELETE the rule
|
|
channel = self.make_request(
|
|
"DELETE", "/pushrules/global/override/best.friend", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# check 404 for deleted rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_enabled_404_when_get_non_existent_server_rule(self) -> None:
|
|
"""
|
|
Tests that `enabled` gives 404 when the server-default rule doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
# check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/.m.muahahaha/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_enabled_404_when_put_non_existent_rule(self) -> None:
|
|
"""
|
|
Tests that `enabled` gives 404 when we put to a rule that doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
# enable & check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/best.friend/enabled",
|
|
{"enabled": True},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_enabled_404_when_put_non_existent_server_rule(self) -> None:
|
|
"""
|
|
Tests that `enabled` gives 404 when we put to a server-default rule that doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
# enable & check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/.m.muahahah/enabled",
|
|
{"enabled": True},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_actions_get(self) -> None:
|
|
"""
|
|
Tests that `actions` gives you what you expect on a fresh rule.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# GET actions for that new rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/actions", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(
|
|
channel.json_body["actions"], ["notify", {"set_tweak": "highlight"}]
|
|
)
|
|
|
|
def test_actions_put(self) -> None:
|
|
"""
|
|
Tests that PUT on actions updates the value you'd get from GET.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# change the rule actions
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/best.friend/actions",
|
|
{"actions": ["dont_notify"]},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# GET actions for that new rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/actions", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["actions"], ["dont_notify"])
|
|
|
|
def test_actions_404_when_get_non_existent(self) -> None:
|
|
"""
|
|
Tests that `actions` gives 404 when the rule doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
body = {
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "sender", "pattern": "@user2:hs"}
|
|
],
|
|
"actions": ["notify", {"set_tweak": "highlight"}],
|
|
}
|
|
|
|
# check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
# PUT a new rule
|
|
channel = self.make_request(
|
|
"PUT", "/pushrules/global/override/best.friend", body, access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# DELETE the rule
|
|
channel = self.make_request(
|
|
"DELETE", "/pushrules/global/override/best.friend", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# check 404 for deleted rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/best.friend/enabled", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_actions_404_when_get_non_existent_server_rule(self) -> None:
|
|
"""
|
|
Tests that `actions` gives 404 when the server-default rule doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
# check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"GET", "/pushrules/global/override/.m.muahahaha/actions", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_actions_404_when_put_non_existent_rule(self) -> None:
|
|
"""
|
|
Tests that `actions` gives 404 when putting to a rule that doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
# enable & check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/best.friend/actions",
|
|
{"actions": ["dont_notify"]},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def test_actions_404_when_put_non_existent_server_rule(self) -> None:
|
|
"""
|
|
Tests that `actions` gives 404 when putting to a server-default rule that doesn't exist.
|
|
"""
|
|
self.register_user("user", "pass")
|
|
token = self.login("user", "pass")
|
|
|
|
# enable & check 404 for never-heard-of rule
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/override/.m.muahahah/actions",
|
|
{"actions": ["dont_notify"]},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
def _assert_default_rule_absent(self, token: str, rule_path: str) -> None:
|
|
"""Checks that a server-default rule is neither served nor modifiable."""
|
|
channel = self.make_request(
|
|
"GET", f"/pushrules/{rule_path}", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
f"/pushrules/{rule_path}/enabled",
|
|
{"enabled": False},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
f"/pushrules/{rule_path}/actions",
|
|
{"actions": ["notify"]},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
_, kind, rule_id = rule_path.split("/")
|
|
channel = self.make_request("GET", "/pushrules/", access_token=token)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertNotIn(
|
|
rule_id,
|
|
[rule["rule_id"] for rule in channel.json_body["global"].get(kind, [])],
|
|
)
|
|
|
|
def _assert_default_rule_modifiable(self, token: str, rule_path: str) -> None:
|
|
"""Checks that a server-default rule is served and can be modified."""
|
|
channel = self.make_request(
|
|
"GET", f"/pushrules/{rule_path}", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
f"/pushrules/{rule_path}/actions",
|
|
{"actions": ["notify"]},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
f"/pushrules/{rule_path}/enabled",
|
|
{"enabled": False},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
channel = self.make_request(
|
|
"GET", f"/pushrules/{rule_path}", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertEqual(channel.json_body["actions"], ["notify"])
|
|
self.assertEqual(channel.json_body["enabled"], False)
|
|
|
|
# A server-default rule gated behind an experimental feature is only served,
|
|
# and thus only modifiable, while the feature is enabled. One such rule is
|
|
# enough to check this; the MSC3664 reply rule is used below. When MSC3664
|
|
# stabilises, swap in another gated rule, or drop these two tests if none
|
|
# remain.
|
|
|
|
def test_gated_default_rule_disabled(self) -> None:
|
|
"""
|
|
Tests that a server-default rule gated behind an experimental feature
|
|
is neither served nor modifiable while the feature is disabled.
|
|
"""
|
|
self.register_user("bob", "pass")
|
|
token = self.login("bob", "pass")
|
|
self._assert_default_rule_absent(
|
|
token, "global/override/.im.nheko.msc3664.reply"
|
|
)
|
|
|
|
@override_config({"experimental_features": {"msc3664_enabled": True}})
|
|
def test_gated_default_rule_enabled(self) -> None:
|
|
"""
|
|
Tests that a server-default rule gated behind an experimental feature
|
|
is served and modifiable once the feature is enabled.
|
|
"""
|
|
self.register_user("bob", "pass")
|
|
token = self.login("bob", "pass")
|
|
self._assert_default_rule_modifiable(
|
|
token, "global/override/.im.nheko.msc3664.reply"
|
|
)
|
|
|
|
@parameterized.expand(
|
|
[
|
|
("global/override/.m.rule.contains_display_name",),
|
|
("global/content/.m.rule.contains_user_name",),
|
|
("global/override/.m.rule.roomnotif",),
|
|
]
|
|
)
|
|
def test_legacy_mention_rules_removed(self, rule_path: str) -> None:
|
|
"""
|
|
Tests that the legacy mention rules, which Matrix v1.17 (MSC4210) removed
|
|
from the base rule set, are not served by default.
|
|
"""
|
|
self.register_user("bob", "pass")
|
|
token = self.login("bob", "pass")
|
|
|
|
channel = self.make_request(
|
|
"GET", f"/pushrules/{rule_path}", access_token=token
|
|
)
|
|
self.assertEqual(channel.code, 404)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
|
|
|
_, kind, rule_id = rule_path.split("/")
|
|
channel = self.make_request("GET", "/pushrules/", access_token=token)
|
|
self.assertEqual(channel.code, 200)
|
|
self.assertNotIn(
|
|
rule_id, [rule["rule_id"] for rule in channel.json_body["global"][kind]]
|
|
)
|
|
|
|
@override_config({"experimental_features": {"msc4210_enabled": False}})
|
|
def test_contains_user_name_with_legacy_mentions(self) -> None:
|
|
"""
|
|
Tests that, when the legacy mention rules are restored, the
|
|
`contains_user_name` rule is present and has the proper value in `pattern`.
|
|
"""
|
|
username = "bob"
|
|
self.register_user(username, "pass")
|
|
token = self.login(username, "pass")
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
"/pushrules/global/content/.m.rule.contains_user_name",
|
|
access_token=token,
|
|
)
|
|
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
self.assertEqual(
|
|
{
|
|
"rule_id": ".m.rule.contains_user_name",
|
|
"default": True,
|
|
"enabled": True,
|
|
"pattern": username,
|
|
"actions": [
|
|
"notify",
|
|
{"set_tweak": "highlight"},
|
|
{"set_tweak": "sound", "value": "default"},
|
|
],
|
|
},
|
|
channel.json_body,
|
|
)
|
|
|
|
def test_is_user_mention(self) -> None:
|
|
"""
|
|
Tests that `is_user_mention` rule is present and have proper value in `value`.
|
|
"""
|
|
user = self.register_user("bob", "pass")
|
|
token = self.login("bob", "pass")
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
"/pushrules/global/override/.m.rule.is_user_mention",
|
|
access_token=token,
|
|
)
|
|
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
self.assertEqual(
|
|
{
|
|
"rule_id": ".m.rule.is_user_mention",
|
|
"default": True,
|
|
"enabled": True,
|
|
"conditions": [
|
|
{
|
|
"kind": "event_property_contains",
|
|
"key": "content.m\\.mentions.user_ids",
|
|
"value": user,
|
|
}
|
|
],
|
|
"actions": [
|
|
"notify",
|
|
{"set_tweak": "highlight"},
|
|
{"set_tweak": "sound", "value": "default"},
|
|
],
|
|
},
|
|
channel.json_body,
|
|
)
|
|
|
|
def test_no_user_defined_postcontent_rules(self) -> None:
|
|
"""
|
|
Tests that clients are not permitted to create MSC4306 `postcontent` rules.
|
|
"""
|
|
self.register_user("bob", "pass")
|
|
token = self.login("bob", "pass")
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/postcontent/some.user.rule",
|
|
{},
|
|
access_token=token,
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.BAD_REQUEST)
|
|
self.assertEqual(
|
|
Codes.INVALID_PARAM,
|
|
channel.json_body["errcode"],
|
|
)
|
|
|
|
|
|
class PushRuleLimitTestCase(HomeserverTestCase):
|
|
"""
|
|
Tests for server-configured limits on push rule size.
|
|
|
|
See: https://github.com/element-hq/synapse/security/advisories/GHSA-fp53-rw9v-hcf9
|
|
"""
|
|
|
|
servlets = [
|
|
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
push_rule.register_servlets,
|
|
]
|
|
hijack_auth = False
|
|
|
|
def default_config(self) -> JsonDict:
|
|
config = super().default_config()
|
|
# Set some small limits for push rule sizes so that
|
|
# we can easily test them.
|
|
config["push_rules"] = {
|
|
"limits": {
|
|
# Size limit of each rule in bytes (canonical JSON)
|
|
"rule_size": 64,
|
|
# Size limit of the rule ID (in bytes)
|
|
"rule_id_length": 24,
|
|
# Limit on how many rules you can have
|
|
"rule_count": 2,
|
|
}
|
|
}
|
|
return config
|
|
|
|
@parameterized.expand(
|
|
(
|
|
(
|
|
{
|
|
"actions": ["notify"],
|
|
"conditions": [{"kind": "event_match", "key": "a", "pattern": "a"}],
|
|
},
|
|
58,
|
|
True,
|
|
),
|
|
(
|
|
{
|
|
"actions": ["notify"],
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "a", "pattern": "abcdefg"}
|
|
],
|
|
},
|
|
64,
|
|
True,
|
|
),
|
|
(
|
|
{
|
|
"actions": ["notify"],
|
|
"conditions": [
|
|
{"kind": "event_match", "key": "a", "pattern": "abcdefgH"}
|
|
],
|
|
},
|
|
65,
|
|
False,
|
|
),
|
|
)
|
|
)
|
|
def test_limit_on_push_rule_size(
|
|
self, body: JsonDict, expected_body_num_bytes: int, expected_allowed: bool
|
|
) -> None:
|
|
"""
|
|
Tests that the `push_rules.limits.rule_size` applies to the size of the push rule.
|
|
"""
|
|
self.register_user("alice", "pass")
|
|
token = self.login("alice", "pass")
|
|
|
|
# Sanity check the test data: the canonical JSON size of the push rule body
|
|
# should be exactly as we expect, otherwise our test is void.
|
|
body_bytes = canonicaljson.encode_canonical_json(body)
|
|
# We exclude the size of the wrapper, as our implementation currently only
|
|
# counts the size of the actions and conditions fragments themselves.
|
|
self.assertEqual(
|
|
len(body_bytes) - len('{"actions":,"conditions":}'.encode("utf-8")),
|
|
expected_body_num_bytes,
|
|
)
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/underride/rule1",
|
|
body,
|
|
access_token=token,
|
|
)
|
|
if expected_allowed:
|
|
self.assertEqual(
|
|
channel.code,
|
|
HTTPStatus.OK,
|
|
f"Push rule ({body_bytes!r}) within size limit should be accepted: {channel.json_body}",
|
|
)
|
|
else:
|
|
self.assertEqual(
|
|
channel.code,
|
|
HTTPStatus.REQUEST_ENTITY_TOO_LARGE,
|
|
f"Push rule ({body_bytes!r}) exceeding size limit should be rejected",
|
|
)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.UNKNOWN)
|
|
|
|
@parameterized.expand(
|
|
(
|
|
(
|
|
18,
|
|
True,
|
|
),
|
|
(
|
|
24,
|
|
True,
|
|
),
|
|
(
|
|
25,
|
|
False,
|
|
),
|
|
)
|
|
)
|
|
def test_limit_on_rule_id_length(
|
|
self, rule_id_length: int, expected_allowed: bool
|
|
) -> None:
|
|
"""
|
|
Tests that the `push_rules.limits.rule_id_length` applies to the byte length
|
|
of the push rule ID.
|
|
"""
|
|
self.register_user("alice", "pass")
|
|
token = self.login("alice", "pass")
|
|
|
|
PREFIX = "global/underride/"
|
|
rule_suffix_length = rule_id_length - len(PREFIX)
|
|
assert rule_suffix_length >= 1, "can't construct a rule ID that short"
|
|
channel = self.make_request(
|
|
"PUT",
|
|
f"/pushrules/{PREFIX}{rule_suffix_length * 'a'}",
|
|
{"conditions": [], "actions": ["notify"]},
|
|
access_token=token,
|
|
)
|
|
if expected_allowed:
|
|
self.assertEqual(
|
|
channel.code,
|
|
HTTPStatus.OK,
|
|
f"Push rule ID ({rule_id_length} B) within size limit should be accepted: {channel.json_body}",
|
|
)
|
|
else:
|
|
self.assertEqual(
|
|
channel.code,
|
|
HTTPStatus.REQUEST_ENTITY_TOO_LARGE,
|
|
"Push rule ID ({rule_id_length} B) exceeding size limit should be rejected",
|
|
)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.UNKNOWN)
|
|
|
|
def test_limit_on_push_rule_count(self) -> None:
|
|
"""
|
|
Tests that we are allowed to create exactly the number of push rules
|
|
specified by `push_rules.limits.rule_count`, but not a single one more.
|
|
"""
|
|
self.register_user("bob", "pass")
|
|
token = self.login("bob", "pass")
|
|
|
|
# First 2 rules are allowable
|
|
for i in range(2):
|
|
channel = self.make_request(
|
|
"PUT",
|
|
f"/pushrules/global/underride/rule{i}",
|
|
{"actions": ["notify"], "conditions": []},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(
|
|
channel.code,
|
|
HTTPStatus.OK,
|
|
f"Push rule within count limit should be allowed: {channel.json_body}",
|
|
)
|
|
|
|
# 3rd rule gets denied as it goes over the limit
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/pushrules/global/underride/rule3",
|
|
{"actions": ["notify"], "conditions": []},
|
|
access_token=token,
|
|
)
|
|
self.assertEqual(
|
|
channel.code,
|
|
HTTPStatus.BAD_REQUEST,
|
|
"Push rule exceeding count limit should be rejected",
|
|
)
|
|
self.assertEqual(channel.json_body["errcode"], Codes.UNKNOWN)
|