mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 09:10:52 +00:00
Add config option to control alias creation
This commit is contained in:
parent
0d31109ed5
commit
084046456e
5 changed files with 135 additions and 15 deletions
|
@ -31,6 +31,7 @@ from .push import PushConfig
|
||||||
from .ratelimiting import RatelimitConfig
|
from .ratelimiting import RatelimitConfig
|
||||||
from .registration import RegistrationConfig
|
from .registration import RegistrationConfig
|
||||||
from .repository import ContentRepositoryConfig
|
from .repository import ContentRepositoryConfig
|
||||||
|
from .room_directory import RoomDirectoryConfig
|
||||||
from .saml2 import SAML2Config
|
from .saml2 import SAML2Config
|
||||||
from .server import ServerConfig
|
from .server import ServerConfig
|
||||||
from .server_notices_config import ServerNoticesConfig
|
from .server_notices_config import ServerNoticesConfig
|
||||||
|
@ -49,7 +50,7 @@ class HomeServerConfig(TlsConfig, ServerConfig, DatabaseConfig, LoggingConfig,
|
||||||
WorkerConfig, PasswordAuthProviderConfig, PushConfig,
|
WorkerConfig, PasswordAuthProviderConfig, PushConfig,
|
||||||
SpamCheckerConfig, GroupsConfig, UserDirectoryConfig,
|
SpamCheckerConfig, GroupsConfig, UserDirectoryConfig,
|
||||||
ConsentConfig,
|
ConsentConfig,
|
||||||
ServerNoticesConfig,
|
ServerNoticesConfig, RoomDirectoryConfig,
|
||||||
):
|
):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
101
synapse/config/room_directory.py
Normal file
101
synapse/config/room_directory.py
Normal file
|
@ -0,0 +1,101 @@
|
||||||
|
# -*- 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.
|
||||||
|
|
||||||
|
from synapse.util import glob_to_regex
|
||||||
|
|
||||||
|
from ._base import Config, ConfigError
|
||||||
|
|
||||||
|
|
||||||
|
class RoomDirectoryConfig(Config):
|
||||||
|
def read_config(self, config):
|
||||||
|
alias_creation_rules = config["alias_creation_rules"]
|
||||||
|
|
||||||
|
self._alias_creation_rules = [
|
||||||
|
_AliasRule(rule)
|
||||||
|
for rule in alias_creation_rules
|
||||||
|
]
|
||||||
|
|
||||||
|
def default_config(self, config_dir_path, server_name, **kwargs):
|
||||||
|
return """
|
||||||
|
# The `alias_creation` option controls who's allowed to create aliases
|
||||||
|
# on this server.
|
||||||
|
#
|
||||||
|
# The format of this option is a list of rules that contain globs that
|
||||||
|
# match against user_id and the new alias (fully qualified with server
|
||||||
|
# name). The action in the first rule that matches is taken, which can
|
||||||
|
# currently either be "allowed" or "denied".
|
||||||
|
#
|
||||||
|
# If no rules match the request is denied.
|
||||||
|
alias_creation_rules:
|
||||||
|
- user_id: "*"
|
||||||
|
alias: "*"
|
||||||
|
action: allowed
|
||||||
|
"""
|
||||||
|
|
||||||
|
def is_alias_creation_allowed(self, user_id, alias):
|
||||||
|
"""Checks if the given user is allowed to create the given alias
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id (str)
|
||||||
|
alias (str)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if user is allowed to crate the alias
|
||||||
|
"""
|
||||||
|
for rule in self._alias_creation_rules:
|
||||||
|
if rule.matches(user_id, alias):
|
||||||
|
return rule.action == "allowed"
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class _AliasRule(object):
|
||||||
|
def __init__(self, rule):
|
||||||
|
action = rule["action"]
|
||||||
|
user_id = rule["user_id"]
|
||||||
|
alias = rule["alias"]
|
||||||
|
|
||||||
|
if action in ("allowed", "denied"):
|
||||||
|
self.action = action
|
||||||
|
else:
|
||||||
|
raise ConfigError(
|
||||||
|
"alias_creation_rules rules can only have action of 'allowed'"
|
||||||
|
" or 'denied'"
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
self._user_id_regex = glob_to_regex(user_id)
|
||||||
|
self._alias_regex = glob_to_regex(alias)
|
||||||
|
except Exception as e:
|
||||||
|
raise ConfigError("Failed to parse glob into regex: %s", e)
|
||||||
|
|
||||||
|
def matches(self, user_id, alias):
|
||||||
|
"""Tests if this rule matches the given user_id and alias.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id (str)
|
||||||
|
alias (str)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
"""
|
||||||
|
|
||||||
|
if not self._user_id_regex.search(user_id):
|
||||||
|
return False
|
||||||
|
|
||||||
|
if not self._alias_regex.search(alias):
|
||||||
|
return False
|
||||||
|
|
||||||
|
return True
|
|
@ -14,7 +14,6 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
import logging
|
import logging
|
||||||
import re
|
|
||||||
|
|
||||||
import six
|
import six
|
||||||
from six import iteritems
|
from six import iteritems
|
||||||
|
@ -44,6 +43,7 @@ from synapse.replication.http.federation import (
|
||||||
ReplicationGetQueryRestServlet,
|
ReplicationGetQueryRestServlet,
|
||||||
)
|
)
|
||||||
from synapse.types import get_domain_from_id
|
from synapse.types import get_domain_from_id
|
||||||
|
from synapse.util import glob_to_regex
|
||||||
from synapse.util.async_helpers import Linearizer, concurrently_execute
|
from synapse.util.async_helpers import Linearizer, concurrently_execute
|
||||||
from synapse.util.caches.response_cache import ResponseCache
|
from synapse.util.caches.response_cache import ResponseCache
|
||||||
from synapse.util.logcontext import nested_logging_context
|
from synapse.util.logcontext import nested_logging_context
|
||||||
|
@ -729,22 +729,10 @@ def _acl_entry_matches(server_name, acl_entry):
|
||||||
if not isinstance(acl_entry, six.string_types):
|
if not isinstance(acl_entry, six.string_types):
|
||||||
logger.warn("Ignoring non-str ACL entry '%s' (is %s)", acl_entry, type(acl_entry))
|
logger.warn("Ignoring non-str ACL entry '%s' (is %s)", acl_entry, type(acl_entry))
|
||||||
return False
|
return False
|
||||||
regex = _glob_to_regex(acl_entry)
|
regex = glob_to_regex(acl_entry)
|
||||||
return regex.match(server_name)
|
return regex.match(server_name)
|
||||||
|
|
||||||
|
|
||||||
def _glob_to_regex(glob):
|
|
||||||
res = ''
|
|
||||||
for c in glob:
|
|
||||||
if c == '*':
|
|
||||||
res = res + '.*'
|
|
||||||
elif c == '?':
|
|
||||||
res = res + '.'
|
|
||||||
else:
|
|
||||||
res = res + re.escape(c)
|
|
||||||
return re.compile(res + "\\Z", re.IGNORECASE)
|
|
||||||
|
|
||||||
|
|
||||||
class FederationHandlerRegistry(object):
|
class FederationHandlerRegistry(object):
|
||||||
"""Allows classes to register themselves as handlers for a given EDU or
|
"""Allows classes to register themselves as handlers for a given EDU or
|
||||||
query type for incoming federation traffic.
|
query type for incoming federation traffic.
|
||||||
|
|
|
@ -43,6 +43,7 @@ class DirectoryHandler(BaseHandler):
|
||||||
self.state = hs.get_state_handler()
|
self.state = hs.get_state_handler()
|
||||||
self.appservice_handler = hs.get_application_service_handler()
|
self.appservice_handler = hs.get_application_service_handler()
|
||||||
self.event_creation_handler = hs.get_event_creation_handler()
|
self.event_creation_handler = hs.get_event_creation_handler()
|
||||||
|
self.config = hs.config
|
||||||
|
|
||||||
self.federation = hs.get_federation_client()
|
self.federation = hs.get_federation_client()
|
||||||
hs.get_federation_registry().register_query_handler(
|
hs.get_federation_registry().register_query_handler(
|
||||||
|
@ -111,6 +112,14 @@ class DirectoryHandler(BaseHandler):
|
||||||
403, "This user is not permitted to create this alias",
|
403, "This user is not permitted to create this alias",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if not self.config.is_alias_creation_allowed(user_id, room_alias.to_string()):
|
||||||
|
# Lets just return a generic message, as there may be all sorts of
|
||||||
|
# reasons why we said no. TODO: Allow configurable error messages
|
||||||
|
# per alias creation rule?
|
||||||
|
raise SynapseError(
|
||||||
|
403, "Not allowed to create alias",
|
||||||
|
)
|
||||||
|
|
||||||
can_create = yield self.can_modify_alias(
|
can_create = yield self.can_modify_alias(
|
||||||
room_alias,
|
room_alias,
|
||||||
user_id=user_id
|
user_id=user_id
|
||||||
|
|
|
@ -14,6 +14,7 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
from itertools import islice
|
from itertools import islice
|
||||||
|
|
||||||
import attr
|
import attr
|
||||||
|
@ -138,3 +139,23 @@ def log_failure(failure, msg, consumeErrors=True):
|
||||||
|
|
||||||
if not consumeErrors:
|
if not consumeErrors:
|
||||||
return failure
|
return failure
|
||||||
|
|
||||||
|
|
||||||
|
def glob_to_regex(glob):
|
||||||
|
"""Converts a glob to a compiled regex object
|
||||||
|
|
||||||
|
Args:
|
||||||
|
glob (str)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
re.RegexObject
|
||||||
|
"""
|
||||||
|
res = ''
|
||||||
|
for c in glob:
|
||||||
|
if c == '*':
|
||||||
|
res = res + '.*'
|
||||||
|
elif c == '?':
|
||||||
|
res = res + '.'
|
||||||
|
else:
|
||||||
|
res = res + re.escape(c)
|
||||||
|
return re.compile(res + "\\Z", re.IGNORECASE)
|
||||||
|
|
Loading…
Reference in a new issue