mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
101 lines
3.1 KiB
Python
101 lines
3.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# 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 logging
|
|
|
|
from synapse.config._base import ConfigError
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class DomainRuleChecker(object):
|
|
"""
|
|
A re-implementation of the SpamChecker that prevents users in one domain from
|
|
inviting users in other domains to rooms, based on a configuration.
|
|
|
|
Takes a config in the format:
|
|
|
|
spam_checker:
|
|
module: "rulecheck.DomainRuleChecker"
|
|
config:
|
|
domain_mapping:
|
|
"inviter_domain": [ "invitee_domain_permitted", "other_domain_permitted" ]
|
|
"other_inviter_domain": [ "invitee_domain_permitted" ]
|
|
default: False
|
|
}
|
|
|
|
Don't forget to consider if you can invite users from your own domain.
|
|
"""
|
|
|
|
def __init__(self, config):
|
|
self.domain_mapping = config["domain_mapping"] or {}
|
|
self.default = config["default"]
|
|
|
|
def check_event_for_spam(self, event):
|
|
"""Implements synapse.events.SpamChecker.check_event_for_spam
|
|
"""
|
|
return False
|
|
|
|
def user_may_invite(self, inviter_userid, invitee_userid, room_id):
|
|
"""Implements synapse.events.SpamChecker.user_may_invite
|
|
"""
|
|
inviter_domain = self._get_domain_from_id(inviter_userid)
|
|
invitee_domain = self._get_domain_from_id(invitee_userid)
|
|
|
|
if inviter_domain not in self.domain_mapping:
|
|
return self.default
|
|
|
|
return invitee_domain in self.domain_mapping[inviter_domain]
|
|
|
|
def user_may_create_room(self, userid):
|
|
"""Implements synapse.events.SpamChecker.user_may_create_room
|
|
"""
|
|
return True
|
|
|
|
def user_may_create_room_alias(self, userid, room_alias):
|
|
"""Implements synapse.events.SpamChecker.user_may_create_room_alias
|
|
"""
|
|
return True
|
|
|
|
def user_may_publish_room(self, userid, room_id):
|
|
"""Implements synapse.events.SpamChecker.user_may_publish_room
|
|
"""
|
|
return True
|
|
|
|
@staticmethod
|
|
def parse_config(config):
|
|
"""Implements synapse.events.SpamChecker.parse_config
|
|
"""
|
|
if "default" in config:
|
|
return config
|
|
else:
|
|
raise ConfigError("No default set for spam_config DomainRuleChecker")
|
|
|
|
@staticmethod
|
|
def _get_domain_from_id(mxid):
|
|
"""Parses a string and returns the domain part of the mxid.
|
|
|
|
Args:
|
|
mxid (str): a valid mxid
|
|
|
|
Returns:
|
|
str: the domain part of the mxid
|
|
|
|
"""
|
|
idx = mxid.find(":")
|
|
if idx == -1:
|
|
raise Exception("Invalid ID: %r" % (mxid,))
|
|
return mxid[idx + 1:]
|