mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-28 12:16:26 +00:00
7d52ce7d4b
I thought ruff check would also format, but it doesn't. This runs ruff format in CI and dev scripts. The first commit is just a run of `ruff format .` in the root directory.
141 lines
4.8 KiB
Python
141 lines
4.8 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2023 New Vector, 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]
|
|
#
|
|
#
|
|
import logging
|
|
from typing import TYPE_CHECKING, Optional, Tuple, cast
|
|
|
|
from twisted.web.resource import Resource
|
|
from twisted.web.server import Request
|
|
|
|
from synapse.api.errors import NotFoundError
|
|
from synapse.http.server import DirectServeJsonResource
|
|
from synapse.http.site import SynapseRequest
|
|
from synapse.types import JsonDict
|
|
from synapse.util import json_encoder
|
|
from synapse.util.stringutils import parse_server_name
|
|
|
|
if TYPE_CHECKING:
|
|
from synapse.server import HomeServer
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class WellKnownBuilder:
|
|
def __init__(self, hs: "HomeServer"):
|
|
self._config = hs.config
|
|
self._auth = hs.get_auth()
|
|
|
|
async def get_well_known(self) -> Optional[JsonDict]:
|
|
if not self._config.server.serve_client_wellknown:
|
|
return None
|
|
|
|
result = {"m.homeserver": {"base_url": self._config.server.public_baseurl}}
|
|
|
|
if self._config.registration.default_identity_server:
|
|
result["m.identity_server"] = {
|
|
"base_url": self._config.registration.default_identity_server
|
|
}
|
|
|
|
# We use the MSC3861 values as they are used by multiple MSCs
|
|
if self._config.experimental.msc3861.enabled:
|
|
# If MSC3861 is enabled, we can assume self._auth is an instance of MSC3861DelegatedAuth
|
|
# We import lazily here because of the authlib requirement
|
|
from synapse.api.auth.msc3861_delegated import MSC3861DelegatedAuth
|
|
|
|
auth = cast(MSC3861DelegatedAuth, self._auth)
|
|
|
|
result["org.matrix.msc2965.authentication"] = {
|
|
"issuer": await auth.issuer(),
|
|
}
|
|
account_management_url = await auth.account_management_url()
|
|
if account_management_url is not None:
|
|
result["org.matrix.msc2965.authentication"]["account"] = (
|
|
account_management_url
|
|
)
|
|
|
|
if self._config.server.extra_well_known_client_content:
|
|
for (
|
|
key,
|
|
value,
|
|
) in self._config.server.extra_well_known_client_content.items():
|
|
if key not in result:
|
|
result[key] = value
|
|
|
|
return result
|
|
|
|
|
|
class ClientWellKnownResource(DirectServeJsonResource):
|
|
"""A Twisted web resource which renders the .well-known/matrix/client file"""
|
|
|
|
isLeaf = 1
|
|
|
|
def __init__(self, hs: "HomeServer"):
|
|
super().__init__()
|
|
self._well_known_builder = WellKnownBuilder(hs)
|
|
|
|
async def _async_render_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
|
|
r = await self._well_known_builder.get_well_known()
|
|
if not r:
|
|
raise NotFoundError(".well-known not available")
|
|
|
|
logger.debug("returning: %s", r)
|
|
return 200, r
|
|
|
|
|
|
class ServerWellKnownResource(Resource):
|
|
"""Resource for .well-known/matrix/server, redirecting to port 443"""
|
|
|
|
isLeaf = 1
|
|
|
|
def __init__(self, hs: "HomeServer"):
|
|
super().__init__()
|
|
self._serve_server_wellknown = hs.config.server.serve_server_wellknown
|
|
|
|
host, port = parse_server_name(hs.config.server.server_name)
|
|
|
|
# If we've got this far, then https://<server_name>/ must route to us, so
|
|
# we just redirect the traffic to port 443 instead of 8448.
|
|
if port is None:
|
|
port = 443
|
|
|
|
self._response = json_encoder.encode({"m.server": f"{host}:{port}"}).encode(
|
|
"utf-8"
|
|
)
|
|
|
|
def render_GET(self, request: Request) -> bytes:
|
|
if not self._serve_server_wellknown:
|
|
request.setResponseCode(404)
|
|
request.setHeader(b"Content-Type", b"text/plain")
|
|
return b"404. Is anything ever truly *well* known?\n"
|
|
|
|
request.setHeader(b"Content-Type", b"application/json")
|
|
return self._response
|
|
|
|
|
|
def well_known_resource(hs: "HomeServer") -> Resource:
|
|
"""Returns a Twisted web resource which handles '.well-known' requests"""
|
|
res = Resource()
|
|
matrix_resource = Resource()
|
|
res.putChild(b"matrix", matrix_resource)
|
|
|
|
matrix_resource.putChild(b"server", ServerWellKnownResource(hs))
|
|
matrix_resource.putChild(b"client", ClientWellKnownResource(hs))
|
|
|
|
return res
|