2023-11-21 20:29:58 +00:00
|
|
|
#
|
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 11:26:48 +00:00
|
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
|
|
# Copyright 2017 Vector Creations Ltd
|
|
|
|
# Copyright 2016 OpenMarket Ltd
|
2023-11-21 20:29:58 +00:00
|
|
|
# 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]
|
|
|
|
#
|
|
|
|
#
|
2016-01-06 18:08:52 +00:00
|
|
|
|
|
|
|
import logging
|
|
|
|
import re
|
2021-08-23 12:14:17 +00:00
|
|
|
from typing import TYPE_CHECKING, Tuple
|
|
|
|
|
|
|
|
from twisted.web.server import Request
|
2016-01-06 18:08:52 +00:00
|
|
|
|
2020-09-18 11:56:20 +00:00
|
|
|
from synapse.api.constants import RoomCreationPreset
|
2021-08-23 12:14:17 +00:00
|
|
|
from synapse.http.server import HttpServer
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.http.servlet import RestServlet
|
2021-08-23 12:14:17 +00:00
|
|
|
from synapse.types import JsonDict
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2016-01-06 18:08:52 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
class VersionsRestServlet(RestServlet):
|
|
|
|
PATTERNS = [re.compile("^/_matrix/client/versions$")]
|
2023-03-23 12:11:14 +00:00
|
|
|
CATEGORY = "Client API requests"
|
2016-01-06 18:08:52 +00:00
|
|
|
|
2021-08-23 12:14:17 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2019-09-06 10:35:28 +00:00
|
|
|
self.config = hs.config
|
|
|
|
|
2020-09-18 11:56:20 +00:00
|
|
|
# Calculate these once since they shouldn't change after start-up.
|
|
|
|
self.e2ee_forced_public = (
|
|
|
|
RoomCreationPreset.PUBLIC_CHAT
|
2021-09-24 11:25:21 +00:00
|
|
|
in self.config.room.encryption_enabled_by_default_for_room_presets
|
2020-09-18 11:56:20 +00:00
|
|
|
)
|
|
|
|
self.e2ee_forced_private = (
|
|
|
|
RoomCreationPreset.PRIVATE_CHAT
|
2021-09-24 11:25:21 +00:00
|
|
|
in self.config.room.encryption_enabled_by_default_for_room_presets
|
2020-09-18 11:56:20 +00:00
|
|
|
)
|
|
|
|
self.e2ee_forced_trusted_private = (
|
|
|
|
RoomCreationPreset.TRUSTED_PRIVATE_CHAT
|
2021-09-24 11:25:21 +00:00
|
|
|
in self.config.room.encryption_enabled_by_default_for_room_presets
|
2020-09-18 11:56:20 +00:00
|
|
|
)
|
|
|
|
|
2021-08-23 12:14:17 +00:00
|
|
|
def on_GET(self, request: Request) -> Tuple[int, JsonDict]:
|
2016-01-06 18:08:52 +00:00
|
|
|
return (
|
|
|
|
200,
|
|
|
|
{
|
2016-07-28 08:14:21 +00:00
|
|
|
"versions": [
|
2018-08-16 13:22:47 +00:00
|
|
|
# XXX: at some point we need to decide whether we need to include
|
|
|
|
# the previous version numbers, given we've defined r0.3.0 to be
|
|
|
|
# backwards compatible with r0.2.0. But need to check how
|
|
|
|
# conscientious we've been in compatibility, and decide whether the
|
|
|
|
# middle number is the major revision when at 0.X.Y (as opposed to
|
|
|
|
# X.Y.Z). And we need to decide whether it's fair to make clients
|
|
|
|
# parse the version string to figure out what's going on.
|
2016-07-28 08:14:21 +00:00
|
|
|
"r0.0.1",
|
2016-07-28 09:14:07 +00:00
|
|
|
"r0.1.0",
|
2016-07-28 08:14:21 +00:00
|
|
|
"r0.2.0",
|
2017-11-15 16:24:22 +00:00
|
|
|
"r0.3.0",
|
2019-02-08 21:09:56 +00:00
|
|
|
"r0.4.0",
|
2019-06-05 15:11:31 +00:00
|
|
|
"r0.5.0",
|
2020-06-05 11:27:37 +00:00
|
|
|
"r0.6.0",
|
2021-11-01 13:28:39 +00:00
|
|
|
"r0.6.1",
|
2022-02-18 12:49:53 +00:00
|
|
|
"v1.1",
|
2022-02-21 15:59:29 +00:00
|
|
|
"v1.2",
|
2022-10-04 14:21:16 +00:00
|
|
|
"v1.3",
|
2022-10-14 13:21:55 +00:00
|
|
|
"v1.4",
|
2022-11-29 15:49:23 +00:00
|
|
|
"v1.5",
|
2023-05-12 11:31:50 +00:00
|
|
|
"v1.6",
|
2023-11-29 20:02:09 +00:00
|
|
|
"v1.7",
|
|
|
|
"v1.8",
|
|
|
|
"v1.9",
|
2024-04-29 13:09:03 +00:00
|
|
|
"v1.10",
|
2018-08-16 13:22:47 +00:00
|
|
|
],
|
|
|
|
# as per MSC1497:
|
2019-09-23 17:52:43 +00:00
|
|
|
"unstable_features": {
|
2019-11-01 10:41:23 +00:00
|
|
|
# Implements support for label-based filtering as described in
|
|
|
|
# MSC2326.
|
|
|
|
"org.matrix.label_based_filtering": True,
|
2020-01-16 09:46:14 +00:00
|
|
|
# Implements support for cross signing as described in MSC1756
|
|
|
|
"org.matrix.e2e_cross_signing": True,
|
2020-02-19 10:40:27 +00:00
|
|
|
# Implements additional endpoints as described in MSC2432
|
|
|
|
"org.matrix.msc2432": True,
|
2020-09-02 12:18:40 +00:00
|
|
|
# Implements additional endpoints as described in MSC2666
|
2023-05-18 16:49:12 +00:00
|
|
|
"uk.half-shot.msc2666.query_mutual_rooms": True,
|
2020-09-18 11:56:20 +00:00
|
|
|
# Whether new rooms will be set to encrypted or not (based on presets).
|
|
|
|
"io.element.e2ee_forced.public": self.e2ee_forced_public,
|
|
|
|
"io.element.e2ee_forced.private": self.e2ee_forced_private,
|
|
|
|
"io.element.e2ee_forced.trusted_private": self.e2ee_forced_trusted_private,
|
2021-03-18 15:34:47 +00:00
|
|
|
# Supports the busy presence state described in MSC3026.
|
2021-03-19 17:19:50 +00:00
|
|
|
"org.matrix.msc3026.busy_presence": self.config.experimental.msc3026_enabled,
|
2022-05-05 12:31:25 +00:00
|
|
|
# Supports receiving private read receipts as per MSC2285
|
2022-08-05 15:09:33 +00:00
|
|
|
"org.matrix.msc2285.stable": True, # TODO: Remove when MSC2285 becomes a part of the spec
|
2022-07-27 18:46:57 +00:00
|
|
|
# Supports filtering of /publicRooms by room type as per MSC3827
|
|
|
|
"org.matrix.msc3827.stable": True,
|
2022-02-28 18:29:09 +00:00
|
|
|
# Adds support for thread relations, per MSC3440.
|
2022-03-10 15:36:13 +00:00
|
|
|
"org.matrix.msc3440.stable": True, # TODO: remove when "v1.3" is added above
|
2022-10-04 13:47:04 +00:00
|
|
|
# Support for thread read receipts & notification counts.
|
2022-10-07 13:26:40 +00:00
|
|
|
"org.matrix.msc3771": True,
|
2022-10-04 13:47:04 +00:00
|
|
|
"org.matrix.msc3773": self.config.experimental.msc3773_enabled,
|
2022-04-20 11:57:39 +00:00
|
|
|
# Allows moderators to fetch redacted event content as described in MSC2815
|
|
|
|
"fi.mau.msc2815": self.config.experimental.msc2815_enabled,
|
2023-03-16 14:00:03 +00:00
|
|
|
# Adds a ping endpoint for appservices to check HS->AS connection
|
2023-05-09 19:02:36 +00:00
|
|
|
"fi.mau.msc2659.stable": True, # TODO: remove when "v1.7" is added above
|
2023-06-01 12:52:51 +00:00
|
|
|
# TODO: this is no longer needed once unstable MSC3882 does not need to be supported:
|
|
|
|
"org.matrix.msc3882": self.config.auth.login_via_existing_enabled,
|
2022-09-21 16:18:44 +00:00
|
|
|
# Adds support for remotely enabling/disabling pushers, as per MSC3881
|
|
|
|
"org.matrix.msc3881": self.config.experimental.msc3881_enabled,
|
2022-10-17 15:32:11 +00:00
|
|
|
# Adds support for filtering /messages by event relation.
|
|
|
|
"org.matrix.msc3874": self.config.experimental.msc3874_enabled,
|
2022-10-18 15:52:25 +00:00
|
|
|
# Adds support for simple HTTP rendezvous as per MSC3886
|
|
|
|
"org.matrix.msc3886": self.config.experimental.msc3886_endpoint
|
|
|
|
is not None,
|
2022-11-03 16:21:31 +00:00
|
|
|
# Adds support for relation-based redactions as per MSC3912.
|
|
|
|
"org.matrix.msc3912": self.config.experimental.msc3912_enabled,
|
2023-05-15 08:54:49 +00:00
|
|
|
# Whether recursively provide relations is supported.
|
2024-04-09 16:11:08 +00:00
|
|
|
# TODO This is no longer needed once unstable MSC3981 does not need to be supported.
|
|
|
|
"org.matrix.msc3981": True,
|
2023-05-11 09:38:32 +00:00
|
|
|
# Adds support for deleting account data.
|
|
|
|
"org.matrix.msc3391": self.config.experimental.msc3391_enabled,
|
2023-12-04 11:36:12 +00:00
|
|
|
# Allows clients to inhibit profile update propagation.
|
|
|
|
"org.matrix.msc4069": self.config.experimental.msc4069_profile_inhibit_propagation,
|
2024-01-16 14:36:08 +00:00
|
|
|
# Allows clients to handle push for encrypted events.
|
|
|
|
"org.matrix.msc4028": self.config.experimental.msc4028_push_encrypted_events,
|
2024-04-17 14:47:35 +00:00
|
|
|
# MSC4108: Mechanism to allow OIDC sign in and E2EE set up via QR code
|
2024-04-25 12:50:12 +00:00
|
|
|
"org.matrix.msc4108": (
|
|
|
|
self.config.experimental.msc4108_enabled
|
|
|
|
or (
|
|
|
|
self.config.experimental.msc4108_delegation_endpoint
|
|
|
|
is not None
|
|
|
|
)
|
|
|
|
),
|
2019-09-23 17:52:43 +00:00
|
|
|
},
|
2018-08-16 13:22:47 +00:00
|
|
|
},
|
2016-01-06 18:08:52 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
2021-08-23 12:14:17 +00:00
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
2019-09-06 10:35:28 +00:00
|
|
|
VersionsRestServlet(hs).register(http_server)
|