mirror of
https://mau.dev/maunium/synapse.git
synced 2024-05-20 04:23:44 +02:00
2e92b718d5
Co-authored-by: Hugh Nimmo-Smith <hughns@element.io> Co-authored-by: Hugh Nimmo-Smith <hughns@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
87 lines
3.2 KiB
Python
87 lines
3.2 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2021 The Matrix.org Foundation C.I.C.
|
|
# 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]
|
|
#
|
|
#
|
|
|
|
from typing import TYPE_CHECKING, Mapping
|
|
|
|
from twisted.web.resource import Resource
|
|
|
|
from synapse.rest.synapse.client.new_user_consent import NewUserConsentResource
|
|
from synapse.rest.synapse.client.pick_idp import PickIdpResource
|
|
from synapse.rest.synapse.client.pick_username import pick_username_resource
|
|
from synapse.rest.synapse.client.rendezvous import MSC4108RendezvousSessionResource
|
|
from synapse.rest.synapse.client.sso_register import SsoRegisterResource
|
|
from synapse.rest.synapse.client.unsubscribe import UnsubscribeResource
|
|
|
|
if TYPE_CHECKING:
|
|
from synapse.server import HomeServer
|
|
|
|
|
|
def build_synapse_client_resource_tree(hs: "HomeServer") -> Mapping[str, Resource]:
|
|
"""Builds a resource tree to include synapse-specific client resources
|
|
|
|
These are resources which should be loaded on all workers which expose a C-S API:
|
|
ie, the main process, and any generic workers so configured.
|
|
|
|
Returns:
|
|
map from path to Resource.
|
|
"""
|
|
resources = {
|
|
# SSO bits. These are always loaded, whether or not SSO login is actually
|
|
# enabled (they just won't work very well if it's not)
|
|
"/_synapse/client/pick_idp": PickIdpResource(hs),
|
|
"/_synapse/client/pick_username": pick_username_resource(hs),
|
|
"/_synapse/client/new_user_consent": NewUserConsentResource(hs),
|
|
"/_synapse/client/sso_register": SsoRegisterResource(hs),
|
|
# Unsubscribe to notification emails link
|
|
"/_synapse/client/unsubscribe": UnsubscribeResource(hs),
|
|
}
|
|
|
|
# Expose the JWKS endpoint if OAuth2 delegation is enabled
|
|
if hs.config.experimental.msc3861.enabled:
|
|
from synapse.rest.synapse.client.jwks import JwksResource
|
|
|
|
resources["/_synapse/jwks"] = JwksResource(hs)
|
|
|
|
# provider-specific SSO bits. Only load these if they are enabled, since they
|
|
# rely on optional dependencies.
|
|
if hs.config.oidc.oidc_enabled:
|
|
from synapse.rest.synapse.client.oidc import OIDCResource
|
|
|
|
resources["/_synapse/client/oidc"] = OIDCResource(hs)
|
|
|
|
if hs.config.saml2.saml2_enabled:
|
|
from synapse.rest.synapse.client.saml2 import SAML2Resource
|
|
|
|
res = SAML2Resource(hs)
|
|
resources["/_synapse/client/saml2"] = res
|
|
|
|
# This is also mounted under '/_matrix' for backwards-compatibility.
|
|
# To be removed in Synapse v1.32.0.
|
|
resources["/_matrix/saml2"] = res
|
|
|
|
if hs.config.experimental.msc4108_enabled:
|
|
resources["/_synapse/client/rendezvous"] = MSC4108RendezvousSessionResource(hs)
|
|
|
|
return resources
|
|
|
|
|
|
__all__ = ["build_synapse_client_resource_tree"]
|