forked-synapse/synapse/server.py

654 lines
22 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
# Copyright 2017-2018 New Vector Ltd
# Copyright 2019 The Matrix.org Foundation C.I.C.
2014-08-12 10:10:52 -04:00
#
# 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.
2014-08-12 10:10:52 -04:00
# This file provides some classes for setting up (partially-populated)
# homeservers; either as a full homeserver as a real application, or a small
# partial one for unit test mocking.
# Imports required for the default HomeServer() implementation
import abc
import functools
2016-08-01 13:02:07 -04:00
import logging
import os
from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, TypeVar, cast
2016-08-01 13:02:07 -04:00
import twisted
from twisted.mail.smtp import sendmail
from twisted.web.iweb import IPolicyForHTTPS
2016-01-26 08:52:29 -05:00
2016-08-01 13:02:07 -04:00
from synapse.api.auth import Auth
from synapse.api.filtering import Filtering
from synapse.api.ratelimiting import Ratelimiter
from synapse.appservice.api import ApplicationServiceApi
2016-08-01 13:02:07 -04:00
from synapse.appservice.scheduler import ApplicationServiceScheduler
from synapse.config.homeserver import HomeServerConfig
from synapse.crypto import context_factory
from synapse.crypto.context_factory import RegularPolicyForHTTPS
2016-08-01 13:02:07 -04:00
from synapse.crypto.keyring import Keyring
from synapse.events.builder import EventBuilderFactory
2017-09-26 14:20:23 -04:00
from synapse.events.spamcheck import SpamChecker
from synapse.events.third_party_rules import ThirdPartyEventRules
from synapse.events.utils import EventClientSerializer
2018-03-12 10:34:31 -04:00
from synapse.federation.federation_client import FederationClient
2018-07-09 02:09:20 -04:00
from synapse.federation.federation_server import (
FederationHandlerRegistry,
FederationServer,
)
from synapse.federation.send_queue import FederationRemoteSendQueue
2019-03-13 16:02:56 -04:00
from synapse.federation.sender import FederationSender
2018-07-09 02:09:20 -04:00
from synapse.federation.transport.client import TransportLayerClient
from synapse.groups.attestations import GroupAttestationSigning, GroupAttestionRenewer
from synapse.groups.groups_server import GroupsServerHandler, GroupsServerWorkerHandler
2014-08-12 10:10:52 -04:00
from synapse.handlers import Handlers
from synapse.handlers.account_validity import AccountValidityHandler
from synapse.handlers.acme import AcmeHandler
2016-08-01 13:02:07 -04:00
from synapse.handlers.appservice import ApplicationServicesHandler
from synapse.handlers.auth import AuthHandler, MacaroonGenerator
from synapse.handlers.cas_handler import CasHandler
from synapse.handlers.deactivate_account import DeactivateAccountHandler
from synapse.handlers.device import DeviceHandler, DeviceWorkerHandler
2018-07-09 02:09:20 -04:00
from synapse.handlers.devicemessage import DeviceMessageHandler
2016-08-01 13:02:07 -04:00
from synapse.handlers.e2e_keys import E2eKeysHandler
2017-12-05 16:44:25 -05:00
from synapse.handlers.e2e_room_keys import E2eRoomKeysHandler
2018-07-09 02:09:20 -04:00
from synapse.handlers.events import EventHandler, EventStreamHandler
from synapse.handlers.groups_local import GroupsLocalHandler, GroupsLocalWorkerHandler
2018-07-09 02:09:20 -04:00
from synapse.handlers.initial_sync import InitialSyncHandler
2018-07-20 10:32:23 -04:00
from synapse.handlers.message import EventCreationHandler, MessageHandler
from synapse.handlers.pagination import PaginationHandler
from synapse.handlers.password_policy import PasswordPolicyHandler
from synapse.handlers.presence import PresenceHandler
from synapse.handlers.profile import BaseProfileHandler, MasterProfileHandler
2018-07-09 02:09:20 -04:00
from synapse.handlers.read_marker import ReadMarkerHandler
from synapse.handlers.receipts import ReceiptsHandler
from synapse.handlers.register import RegistrationHandler
from synapse.handlers.room import (
RoomContextHandler,
RoomCreationHandler,
RoomShutdownHandler,
)
from synapse.handlers.room_list import RoomListHandler
from synapse.handlers.room_member import RoomMemberMasterHandler
from synapse.handlers.room_member_worker import RoomMemberWorkerHandler
from synapse.handlers.set_password import SetPasswordHandler
2019-05-21 12:36:50 -04:00
from synapse.handlers.stats import StatsHandler
from synapse.handlers.sync import SyncHandler
2020-07-16 10:12:54 -04:00
from synapse.handlers.typing import FollowerTypingHandler, TypingWriterHandler
from synapse.handlers.user_directory import UserDirectoryHandler
2018-07-09 02:09:20 -04:00
from synapse.http.client import InsecureInterceptableContextFactory, SimpleHttpClient
2016-08-01 13:02:07 -04:00
from synapse.http.matrixfederationclient import MatrixFederationHttpClient
from synapse.notifier import Notifier
2017-05-18 13:17:40 -04:00
from synapse.push.action_generator import ActionGenerator
2016-08-01 13:02:07 -04:00
from synapse.push.pusherpool import PusherPool
from synapse.replication.tcp.client import ReplicationDataHandler
from synapse.replication.tcp.handler import ReplicationCommandHandler
from synapse.replication.tcp.resource import ReplicationStreamer
from synapse.replication.tcp.streams import STREAMS_MAP, Stream
from synapse.rest.media.v1.media_repository import (
MediaRepository,
MediaRepositoryResource,
)
from synapse.secrets import Secrets
from synapse.server_notices.server_notices_manager import ServerNoticesManager
from synapse.server_notices.server_notices_sender import ServerNoticesSender
2019-06-20 05:32:02 -04:00
from synapse.server_notices.worker_server_notices_sender import (
WorkerServerNoticesSender,
)
from synapse.state import StateHandler, StateResolutionHandler
from synapse.storage import Databases, DataStore, Storage
2016-08-01 13:02:07 -04:00
from synapse.streams.events import EventSources
from synapse.types import DomainSpecificString
2014-08-12 10:10:52 -04:00
from synapse.util import Clock
from synapse.util.distributor import Distributor
from synapse.util.stringutils import random_string
logger = logging.getLogger(__name__)
if TYPE_CHECKING:
from synapse.handlers.oidc_handler import OidcHandler
from synapse.handlers.saml_handler import SamlHandler
2014-08-12 10:10:52 -04:00
T = TypeVar("T", bound=Callable[..., Any])
def cache_in_self(builder: T) -> T:
"""Wraps a function called e.g. `get_foo`, checking if `self.foo` exists and
returning if so. If not, calls the given function and sets `self.foo` to it.
Also ensures that dependency cycles throw an exception correctly, rather
than overflowing the stack.
"""
if not builder.__name__.startswith("get_"):
raise Exception(
"@cache_in_self can only be used on functions starting with `get_`"
)
depname = builder.__name__[len("get_") :]
building = [False]
@functools.wraps(builder)
def _get(self):
try:
return getattr(self, depname)
except AttributeError:
pass
# Prevent cyclic dependencies from deadlocking
if building[0]:
raise ValueError("Cyclic dependency while building %s" % (depname,))
building[0] = True
try:
dep = builder(self)
setattr(self, depname, dep)
finally:
building[0] = False
return dep
2020-08-11 17:01:12 -04:00
# We cast here as we need to tell mypy that `_get` has the same signature as
# `builder`.
return cast(T, _get)
class HomeServer(metaclass=abc.ABCMeta):
2014-08-12 10:10:52 -04:00
"""A basic homeserver object without lazy component builders.
This will need all of the components it requires to either be passed as
constructor arguments, or the relevant methods overriding to create them.
Typically this would only be used for unit tests.
Dependencies should be added by creating a `def get_<depname>(self)`
function, wrapping it in `@cache_in_self`.
Attributes:
config (synapse.config.homeserver.HomeserverConfig):
2019-02-11 05:36:26 -05:00
_listening_services (list[twisted.internet.tcp.Port]): TCP ports that
we are listening on to provide HTTP services.
2014-08-12 10:10:52 -04:00
"""
2019-06-20 05:32:02 -04:00
REQUIRED_ON_MASTER_STARTUP = ["user_directory_handler", "stats_handler"]
# This is overridden in derived application classes
# (such as synapse.app.homeserver.SynapseHomeServer) and gives the class to be
# instantiated during setup() for future return by get_datastore()
DATASTORE_CLASS = abc.abstractproperty()
def __init__(self, hostname: str, config: HomeServerConfig, reactor=None, **kwargs):
2014-08-12 10:10:52 -04:00
"""
Args:
hostname : The hostname for the server.
config: The full config for the homeserver.
2014-08-12 10:10:52 -04:00
"""
if not reactor:
from twisted.internet import reactor as _reactor
reactor = _reactor
self._reactor = reactor
2014-08-12 10:10:52 -04:00
self.hostname = hostname
# the key we use to sign events and requests
self.signing_key = config.key.signing_key[0]
self.config = config
self._listening_services = [] # type: List[twisted.internet.tcp.Port]
self.start_time = None # type: Optional[int]
2014-08-12 10:10:52 -04:00
self._instance_id = random_string(5)
self._instance_name = config.worker_name or "master"
self.clock = Clock(reactor)
self.distributor = Distributor()
self.registration_ratelimiter = Ratelimiter(
clock=self.clock,
rate_hz=config.rc_registration.per_second,
burst_count=config.rc_registration.burst_count,
)
self.datastores = None # type: Optional[Databases]
2014-08-12 10:10:52 -04:00
# Other kwargs are explicit dependencies
for depname in kwargs:
setattr(self, depname, kwargs[depname])
def get_instance_id(self) -> str:
"""A unique ID for this synapse process instance.
This is used to distinguish running instances in worker-based
deployments.
"""
return self._instance_id
def get_instance_name(self) -> str:
"""A unique name for this synapse process.
Used to identify the process over replication and in config. Does not
change over restarts.
"""
return self._instance_name
def setup(self) -> None:
logger.info("Setting up.")
self.start_time = int(self.get_clock().time())
self.datastores = Databases(self.DATASTORE_CLASS, self)
logger.info("Finished setting up.")
def setup_master(self) -> None:
2019-03-12 10:17:51 -04:00
"""
Some handlers have side effects on instantiation (like registering
background updates). This function causes them to be fetched, and
therefore instantiated, to run those side effects.
"""
2019-03-11 06:13:35 -04:00
for i in self.REQUIRED_ON_MASTER_STARTUP:
getattr(self, "get_" + i)()
def get_reactor(self) -> twisted.internet.base.ReactorBase:
"""
Fetch the Twisted reactor in use by this HomeServer.
"""
return self._reactor
def get_ip_from_request(self, request) -> str:
# X-Forwarded-For is handled by our custom request type.
return request.getClientIP()
def is_mine(self, domain_specific_string: DomainSpecificString) -> bool:
return domain_specific_string.domain == self.hostname
def is_mine_id(self, string: str) -> bool:
2016-01-19 11:11:39 -05:00
return string.split(":", 1)[1] == self.hostname
def get_clock(self) -> Clock:
return self.clock
def get_datastore(self) -> DataStore:
if not self.datastores:
raise Exception("HomeServer.setup must be called before getting datastores")
2019-10-23 07:02:36 -04:00
return self.datastores.main
def get_datastores(self) -> Databases:
if not self.datastores:
raise Exception("HomeServer.setup must be called before getting datastores")
return self.datastores
def get_config(self) -> HomeServerConfig:
return self.config
def get_distributor(self) -> Distributor:
return self.distributor
def get_registration_ratelimiter(self) -> Ratelimiter:
return self.registration_ratelimiter
@cache_in_self
def get_federation_client(self) -> FederationClient:
2018-03-12 10:34:31 -04:00
return FederationClient(self)
@cache_in_self
def get_federation_server(self) -> FederationServer:
2018-03-12 10:34:31 -04:00
return FederationServer(self)
2014-08-12 10:10:52 -04:00
@cache_in_self
def get_handlers(self) -> Handlers:
2014-08-12 10:10:52 -04:00
return Handlers(self)
@cache_in_self
def get_notifier(self) -> Notifier:
2014-08-12 10:10:52 -04:00
return Notifier(self)
@cache_in_self
def get_auth(self) -> Auth:
2014-08-12 10:10:52 -04:00
return Auth(self)
@cache_in_self
def get_http_client_context_factory(self) -> IPolicyForHTTPS:
return (
2015-09-15 10:50:13 -04:00
InsecureInterceptableContextFactory()
if self.config.use_insecure_ssl_client_just_for_testing_do_not_use
else RegularPolicyForHTTPS()
)
@cache_in_self
def get_simple_http_client(self) -> SimpleHttpClient:
return SimpleHttpClient(self)
@cache_in_self
def get_proxied_http_client(self) -> SimpleHttpClient:
return SimpleHttpClient(
self,
http_proxy=os.getenvb(b"http_proxy"),
https_proxy=os.getenvb(b"HTTPS_PROXY"),
)
@cache_in_self
def get_room_creation_handler(self) -> RoomCreationHandler:
return RoomCreationHandler(self)
@cache_in_self
def get_room_shutdown_handler(self) -> RoomShutdownHandler:
return RoomShutdownHandler(self)
@cache_in_self
def get_sendmail(self) -> sendmail:
return sendmail
@cache_in_self
def get_state_handler(self) -> StateHandler:
2014-08-12 10:10:52 -04:00
return StateHandler(self)
@cache_in_self
def get_state_resolution_handler(self) -> StateResolutionHandler:
return StateResolutionHandler(self)
@cache_in_self
def get_presence_handler(self) -> PresenceHandler:
return PresenceHandler(self)
@cache_in_self
def get_typing_handler(self):
2020-07-16 10:12:54 -04:00
if self.config.worker.writers.typing == self.get_instance_name():
return TypingWriterHandler(self)
else:
return FollowerTypingHandler(self)
@cache_in_self
def get_sync_handler(self) -> SyncHandler:
return SyncHandler(self)
@cache_in_self
def get_room_list_handler(self) -> RoomListHandler:
return RoomListHandler(self)
@cache_in_self
def get_auth_handler(self) -> AuthHandler:
2016-06-02 08:31:45 -04:00
return AuthHandler(self)
@cache_in_self
def get_macaroon_generator(self) -> MacaroonGenerator:
return MacaroonGenerator(self)
@cache_in_self
def get_device_handler(self):
if self.config.worker_app:
return DeviceWorkerHandler(self)
else:
return DeviceHandler(self)
@cache_in_self
def get_device_message_handler(self) -> DeviceMessageHandler:
2016-09-06 13:16:20 -04:00
return DeviceMessageHandler(self)
@cache_in_self
def get_e2e_keys_handler(self) -> E2eKeysHandler:
2016-08-01 13:02:07 -04:00
return E2eKeysHandler(self)
2017-12-05 16:44:25 -05:00
@cache_in_self
def get_e2e_room_keys_handler(self) -> E2eRoomKeysHandler:
2017-12-05 16:44:25 -05:00
return E2eRoomKeysHandler(self)
2016-08-01 13:02:07 -04:00
@cache_in_self
def get_acme_handler(self) -> AcmeHandler:
return AcmeHandler(self)
@cache_in_self
def get_application_service_api(self) -> ApplicationServiceApi:
return ApplicationServiceApi(self)
@cache_in_self
def get_application_service_scheduler(self) -> ApplicationServiceScheduler:
return ApplicationServiceScheduler(self)
@cache_in_self
def get_application_service_handler(self) -> ApplicationServicesHandler:
return ApplicationServicesHandler(self)
@cache_in_self
def get_event_handler(self) -> EventHandler:
2016-08-12 10:31:44 -04:00
return EventHandler(self)
@cache_in_self
def get_event_stream_handler(self) -> EventStreamHandler:
2016-08-12 10:31:44 -04:00
return EventStreamHandler(self)
@cache_in_self
def get_initial_sync_handler(self) -> InitialSyncHandler:
return InitialSyncHandler(self)
@cache_in_self
def get_profile_handler(self):
if self.config.worker_app:
return BaseProfileHandler(self)
else:
return MasterProfileHandler(self)
2017-08-25 09:34:56 -04:00
@cache_in_self
def get_event_creation_handler(self) -> EventCreationHandler:
2018-01-15 11:52:07 -05:00
return EventCreationHandler(self)
@cache_in_self
def get_deactivate_account_handler(self) -> DeactivateAccountHandler:
return DeactivateAccountHandler(self)
@cache_in_self
def get_set_password_handler(self) -> SetPasswordHandler:
return SetPasswordHandler(self)
@cache_in_self
def get_event_sources(self) -> EventSources:
return EventSources(self)
@cache_in_self
def get_keyring(self) -> Keyring:
return Keyring(self)
@cache_in_self
def get_event_builder_factory(self) -> EventBuilderFactory:
return EventBuilderFactory(self)
@cache_in_self
def get_filtering(self) -> Filtering:
return Filtering(self)
2015-01-29 09:55:27 -05:00
@cache_in_self
def get_pusherpool(self) -> PusherPool:
return PusherPool(self)
2016-01-26 08:52:29 -05:00
@cache_in_self
def get_http_client(self) -> MatrixFederationHttpClient:
tls_client_options_factory = context_factory.FederationPolicyForHTTPS(
self.config
)
return MatrixFederationHttpClient(self, tls_client_options_factory)
2016-01-26 08:52:29 -05:00
@cache_in_self
def get_media_repository_resource(self) -> MediaRepositoryResource:
# build the media repo resource. This indirects through the HomeServer
# to ensure that we only have a single instance of
return MediaRepositoryResource(self)
@cache_in_self
def get_media_repository(self) -> MediaRepository:
2016-06-29 09:57:59 -04:00
return MediaRepository(self)
@cache_in_self
def get_federation_transport_client(self) -> TransportLayerClient:
return TransportLayerClient(self)
@cache_in_self
def get_federation_sender(self):
if self.should_send_federation():
2019-03-13 16:02:56 -04:00
return FederationSender(self)
elif not self.config.worker_app:
return FederationRemoteSendQueue(self)
else:
raise Exception("Workers cannot send federation traffic")
@cache_in_self
def get_receipts_handler(self) -> ReceiptsHandler:
return ReceiptsHandler(self)
@cache_in_self
def get_read_marker_handler(self) -> ReadMarkerHandler:
return ReadMarkerHandler(self)
@cache_in_self
def get_tcp_replication(self) -> ReplicationCommandHandler:
return ReplicationCommandHandler(self)
@cache_in_self
def get_action_generator(self) -> ActionGenerator:
2017-05-18 13:17:40 -04:00
return ActionGenerator(self)
@cache_in_self
def get_user_directory_handler(self) -> UserDirectoryHandler:
return UserDirectoryHandler(self)
2017-05-31 06:51:01 -04:00
@cache_in_self
def get_groups_local_handler(self):
if self.config.worker_app:
return GroupsLocalWorkerHandler(self)
else:
return GroupsLocalHandler(self)
2017-07-10 09:52:27 -04:00
@cache_in_self
def get_groups_server_handler(self):
if self.config.worker_app:
return GroupsServerWorkerHandler(self)
else:
return GroupsServerHandler(self)
2017-07-10 10:44:15 -04:00
@cache_in_self
def get_groups_attestation_signing(self) -> GroupAttestationSigning:
2017-07-10 10:44:15 -04:00
return GroupAttestationSigning(self)
@cache_in_self
def get_groups_attestation_renewer(self) -> GroupAttestionRenewer:
2017-07-10 10:44:15 -04:00
return GroupAttestionRenewer(self)
@cache_in_self
def get_secrets(self) -> Secrets:
return Secrets()
@cache_in_self
def get_stats_handler(self) -> StatsHandler:
2019-05-21 12:36:50 -04:00
return StatsHandler(self)
@cache_in_self
def get_spam_checker(self):
2017-09-26 14:20:23 -04:00
return SpamChecker(self)
@cache_in_self
def get_third_party_event_rules(self) -> ThirdPartyEventRules:
return ThirdPartyEventRules(self)
@cache_in_self
def get_room_member_handler(self):
if self.config.worker_app:
2018-03-13 12:32:37 -04:00
return RoomMemberWorkerHandler(self)
return RoomMemberMasterHandler(self)
2018-03-01 05:54:37 -05:00
@cache_in_self
def get_federation_registry(self) -> FederationHandlerRegistry:
2020-07-16 10:12:54 -04:00
return FederationHandlerRegistry(self)
@cache_in_self
def get_server_notices_manager(self):
if self.config.worker_app:
raise Exception("Workers cannot send server notices")
return ServerNoticesManager(self)
@cache_in_self
def get_server_notices_sender(self):
if self.config.worker_app:
return WorkerServerNoticesSender(self)
return ServerNoticesSender(self)
@cache_in_self
def get_message_handler(self) -> MessageHandler:
return MessageHandler(self)
@cache_in_self
def get_pagination_handler(self) -> PaginationHandler:
return PaginationHandler(self)
@cache_in_self
def get_room_context_handler(self) -> RoomContextHandler:
return RoomContextHandler(self)
@cache_in_self
def get_registration_handler(self) -> RegistrationHandler:
return RegistrationHandler(self)
@cache_in_self
def get_account_validity_handler(self) -> AccountValidityHandler:
return AccountValidityHandler(self)
@cache_in_self
def get_cas_handler(self) -> CasHandler:
return CasHandler(self)
@cache_in_self
def get_saml_handler(self) -> "SamlHandler":
from synapse.handlers.saml_handler import SamlHandler
2019-06-26 19:37:41 -04:00
return SamlHandler(self)
@cache_in_self
def get_oidc_handler(self) -> "OidcHandler":
from synapse.handlers.oidc_handler import OidcHandler
return OidcHandler(self)
@cache_in_self
def get_event_client_serializer(self) -> EventClientSerializer:
return EventClientSerializer(self)
@cache_in_self
def get_password_policy_handler(self) -> PasswordPolicyHandler:
return PasswordPolicyHandler(self)
@cache_in_self
def get_storage(self) -> Storage:
return Storage(self, self.get_datastores())
2019-10-23 07:02:36 -04:00
@cache_in_self
def get_replication_streamer(self) -> ReplicationStreamer:
return ReplicationStreamer(self)
@cache_in_self
def get_replication_data_handler(self) -> ReplicationDataHandler:
return ReplicationDataHandler(self)
@cache_in_self
def get_replication_streams(self) -> Dict[str, Stream]:
return {stream.NAME: stream(self) for stream in STREAMS_MAP.values()}
async def remove_pusher(self, app_id: str, push_key: str, user_id: str):
return await self.get_pusherpool().remove_pusher(app_id, push_key, user_id)
def should_send_federation(self) -> bool:
"Should this server be sending federation traffic directly?"
return self.config.send_federation and (
not self.config.worker_app
or self.config.worker_app == "synapse.app.federation_sender"
)