123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703 |
- # -*- coding: utf-8 -*-
- # Copyright 2014-2016 OpenMarket Ltd
- # Copyright 2017-2018 New Vector Ltd
- # Copyright 2019 The Matrix.org Foundation C.I.C.
- #
- # 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.
- # 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
- import logging
- import os
- from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, TypeVar, cast
- import twisted
- from twisted.mail.smtp import sendmail
- from twisted.web.iweb import IPolicyForHTTPS
- from synapse.api.auth import Auth
- from synapse.api.filtering import Filtering
- from synapse.api.ratelimiting import Ratelimiter
- from synapse.appservice.api import ApplicationServiceApi
- 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
- from synapse.crypto.keyring import Keyring
- from synapse.events.builder import EventBuilderFactory
- from synapse.events.spamcheck import SpamChecker
- from synapse.events.third_party_rules import ThirdPartyEventRules
- from synapse.events.utils import EventClientSerializer
- from synapse.federation.federation_client import FederationClient
- from synapse.federation.federation_server import (
- FederationHandlerRegistry,
- FederationServer,
- )
- from synapse.federation.send_queue import FederationRemoteSendQueue
- from synapse.federation.sender import FederationSender
- from synapse.federation.transport.client import TransportLayerClient
- from synapse.groups.attestations import GroupAttestationSigning, GroupAttestionRenewer
- from synapse.groups.groups_server import GroupsServerHandler, GroupsServerWorkerHandler
- from synapse.handlers.account_validity import AccountValidityHandler
- from synapse.handlers.acme import AcmeHandler
- from synapse.handlers.admin import AdminHandler
- 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
- from synapse.handlers.devicemessage import DeviceMessageHandler
- from synapse.handlers.directory import DirectoryHandler
- from synapse.handlers.e2e_keys import E2eKeysHandler
- from synapse.handlers.e2e_room_keys import E2eRoomKeysHandler
- from synapse.handlers.events import EventHandler, EventStreamHandler
- from synapse.handlers.federation import FederationHandler
- from synapse.handlers.groups_local import GroupsLocalHandler, GroupsLocalWorkerHandler
- from synapse.handlers.identity import IdentityHandler
- from synapse.handlers.initial_sync import InitialSyncHandler
- 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 ProfileHandler
- 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.search import SearchHandler
- from synapse.handlers.set_password import SetPasswordHandler
- from synapse.handlers.sso import SsoHandler
- from synapse.handlers.stats import StatsHandler
- from synapse.handlers.sync import SyncHandler
- from synapse.handlers.typing import FollowerTypingHandler, TypingWriterHandler
- from synapse.handlers.user_directory import UserDirectoryHandler
- from synapse.http.client import InsecureInterceptableContextFactory, SimpleHttpClient
- from synapse.http.matrixfederationclient import MatrixFederationHttpClient
- from synapse.module_api import ModuleApi
- from synapse.notifier import Notifier
- from synapse.push.action_generator import ActionGenerator
- 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
- from synapse.server_notices.worker_server_notices_sender import (
- WorkerServerNoticesSender,
- )
- from synapse.state import StateHandler, StateResolutionHandler
- from synapse.storage import Databases, DataStore, Storage
- from synapse.streams.events import EventSources
- from synapse.types import DomainSpecificString
- from synapse.util import Clock
- from synapse.util.distributor import Distributor
- from synapse.util.ratelimitutils import FederationRateLimiter
- 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
- 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
- # 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):
- """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):
- _listening_services (list[twisted.internet.tcp.Port]): TCP ports that
- we are listening on to provide HTTP services.
- """
- REQUIRED_ON_BACKGROUND_TASK_STARTUP = [
- "account_validity",
- "auth",
- "deactivate_account",
- "message",
- "pagination",
- "profile",
- "stats",
- ]
- # 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,
- version_string="Synapse",
- ):
- """
- Args:
- hostname : The hostname for the server.
- config: The full config for the homeserver.
- """
- if not reactor:
- from twisted.internet import reactor as _reactor
- reactor = _reactor
- self._reactor = reactor
- 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]
- 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.version_string = version_string
- self.datastores = None # type: Optional[Databases]
- 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.")
- # Register background tasks required by this server. This must be done
- # somewhat manually due to the background tasks not being registered
- # unless handlers are instantiated.
- if self.config.run_background_tasks:
- self.setup_background_tasks()
- def setup_background_tasks(self) -> None:
- """
- 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.
- """
- for i in self.REQUIRED_ON_BACKGROUND_TASK_STARTUP:
- getattr(self, "get_" + i + "_handler")()
- 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:
- 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")
- 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:
- return FederationClient(self)
- @cache_in_self
- def get_federation_server(self) -> FederationServer:
- return FederationServer(self)
- @cache_in_self
- def get_notifier(self) -> Notifier:
- return Notifier(self)
- @cache_in_self
- def get_auth(self) -> Auth:
- return Auth(self)
- @cache_in_self
- def get_http_client_context_factory(self) -> IPolicyForHTTPS:
- return (
- 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:
- 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):
- if self.config.worker.writers.typing == self.get_instance_name():
- return TypingWriterHandler(self)
- else:
- return FollowerTypingHandler(self)
- @cache_in_self
- def get_sso_handler(self) -> SsoHandler:
- return SsoHandler(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:
- 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:
- return DeviceMessageHandler(self)
- @cache_in_self
- def get_directory_handler(self) -> DirectoryHandler:
- return DirectoryHandler(self)
- @cache_in_self
- def get_e2e_keys_handler(self) -> E2eKeysHandler:
- return E2eKeysHandler(self)
- @cache_in_self
- def get_e2e_room_keys_handler(self) -> E2eRoomKeysHandler:
- return E2eRoomKeysHandler(self)
- @cache_in_self
- def get_acme_handler(self) -> AcmeHandler:
- return AcmeHandler(self)
- @cache_in_self
- def get_admin_handler(self) -> AdminHandler:
- return AdminHandler(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:
- return EventHandler(self)
- @cache_in_self
- def get_event_stream_handler(self) -> EventStreamHandler:
- return EventStreamHandler(self)
- @cache_in_self
- def get_federation_handler(self) -> FederationHandler:
- return FederationHandler(self)
- @cache_in_self
- def get_identity_handler(self) -> IdentityHandler:
- return IdentityHandler(self)
- @cache_in_self
- def get_initial_sync_handler(self) -> InitialSyncHandler:
- return InitialSyncHandler(self)
- @cache_in_self
- def get_profile_handler(self):
- return ProfileHandler(self)
- @cache_in_self
- def get_event_creation_handler(self) -> EventCreationHandler:
- return EventCreationHandler(self)
- @cache_in_self
- def get_deactivate_account_handler(self) -> DeactivateAccountHandler:
- return DeactivateAccountHandler(self)
- @cache_in_self
- def get_search_handler(self) -> SearchHandler:
- return SearchHandler(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)
- @cache_in_self
- def get_pusherpool(self) -> PusherPool:
- return PusherPool(self)
- @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)
- @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:
- 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():
- 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:
- return ActionGenerator(self)
- @cache_in_self
- def get_user_directory_handler(self) -> UserDirectoryHandler:
- return UserDirectoryHandler(self)
- @cache_in_self
- def get_groups_local_handler(self):
- if self.config.worker_app:
- return GroupsLocalWorkerHandler(self)
- else:
- return GroupsLocalHandler(self)
- @cache_in_self
- def get_groups_server_handler(self):
- if self.config.worker_app:
- return GroupsServerWorkerHandler(self)
- else:
- return GroupsServerHandler(self)
- @cache_in_self
- def get_groups_attestation_signing(self) -> GroupAttestationSigning:
- return GroupAttestationSigning(self)
- @cache_in_self
- def get_groups_attestation_renewer(self) -> GroupAttestionRenewer:
- return GroupAttestionRenewer(self)
- @cache_in_self
- def get_secrets(self) -> Secrets:
- return Secrets()
- @cache_in_self
- def get_stats_handler(self) -> StatsHandler:
- return StatsHandler(self)
- @cache_in_self
- def get_spam_checker(self):
- 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:
- return RoomMemberWorkerHandler(self)
- return RoomMemberMasterHandler(self)
- @cache_in_self
- def get_federation_registry(self) -> FederationHandlerRegistry:
- 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
- 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())
- @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()}
- @cache_in_self
- def get_federation_ratelimiter(self) -> FederationRateLimiter:
- return FederationRateLimiter(self.clock, config=self.config.rc_federation)
- @cache_in_self
- def get_module_api(self) -> ModuleApi:
- return ModuleApi(self, self.get_auth_handler())
- 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"
- )
|