2020-03-02 16:36:32 +00:00
|
|
|
#
|
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 2020-2021 The Matrix.org Foundation C.I.C.
|
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]
|
2020-03-02 16:36:32 +00:00
|
|
|
#
|
|
|
|
#
|
2021-09-06 14:23:50 +00:00
|
|
|
import logging
|
2021-02-11 15:05:15 +00:00
|
|
|
from typing import Any, Dict, Optional
|
|
|
|
|
|
|
|
import attr
|
2020-03-02 16:36:32 +00:00
|
|
|
|
2022-04-11 16:07:23 +00:00
|
|
|
from synapse.types import JsonDict
|
|
|
|
|
2020-03-03 10:54:44 +00:00
|
|
|
from ._base import Config
|
2020-03-02 16:36:32 +00:00
|
|
|
|
2021-09-06 14:23:50 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
LEGACY_TEMPLATE_DIR_WARNING = """
|
|
|
|
This server's configuration file is using the deprecated 'template_dir' setting in the
|
|
|
|
'sso' section. Support for this setting has been deprecated and will be removed in a
|
|
|
|
future version of Synapse. Server admins should instead use the new
|
2022-08-17 09:59:05 +00:00
|
|
|
'custom_template_directory' setting documented here:
|
2023-12-13 16:15:22 +00:00
|
|
|
https://element-hq.github.io/synapse/latest/templates.html
|
2021-09-06 14:23:50 +00:00
|
|
|
---------------------------------------------------------------------------------------"""
|
|
|
|
|
2020-03-02 16:36:32 +00:00
|
|
|
|
2021-12-01 12:28:23 +00:00
|
|
|
@attr.s(frozen=True, auto_attribs=True)
|
2021-02-11 15:05:15 +00:00
|
|
|
class SsoAttributeRequirement:
|
|
|
|
"""Object describing a single requirement for SSO attributes."""
|
|
|
|
|
2021-12-01 12:28:23 +00:00
|
|
|
attribute: str
|
2021-02-11 15:05:15 +00:00
|
|
|
# If a value is not given, than the attribute must simply exist.
|
2021-12-01 12:28:23 +00:00
|
|
|
value: Optional[str]
|
2021-02-11 15:05:15 +00:00
|
|
|
|
|
|
|
JSON_SCHEMA = {
|
|
|
|
"type": "object",
|
|
|
|
"properties": {"attribute": {"type": "string"}, "value": {"type": "string"}},
|
|
|
|
"required": ["attribute", "value"],
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-03-02 16:36:32 +00:00
|
|
|
class SSOConfig(Config):
|
|
|
|
"""SSO Configuration"""
|
|
|
|
|
|
|
|
section = "sso"
|
|
|
|
|
2022-04-11 16:07:23 +00:00
|
|
|
def read_config(self, config: JsonDict, **kwargs: Any) -> None:
|
2021-07-15 10:02:43 +00:00
|
|
|
sso_config: Dict[str, Any] = config.get("sso") or {}
|
2020-03-02 16:36:32 +00:00
|
|
|
|
2020-08-17 16:05:00 +00:00
|
|
|
# The sso-specific template_dir
|
2021-02-01 15:52:50 +00:00
|
|
|
self.sso_template_dir = sso_config.get("template_dir")
|
2021-09-06 14:23:50 +00:00
|
|
|
if self.sso_template_dir is not None:
|
|
|
|
logger.warning(LEGACY_TEMPLATE_DIR_WARNING)
|
2020-03-02 16:36:32 +00:00
|
|
|
|
2020-08-17 16:05:00 +00:00
|
|
|
# Read templates from disk
|
2021-08-17 12:45:24 +00:00
|
|
|
custom_template_directories = (
|
|
|
|
self.root.server.custom_template_directory,
|
|
|
|
self.sso_template_dir,
|
|
|
|
)
|
|
|
|
|
2020-08-17 16:05:00 +00:00
|
|
|
(
|
2021-01-05 11:25:28 +00:00
|
|
|
self.sso_login_idp_picker_template,
|
2020-08-17 16:05:00 +00:00
|
|
|
self.sso_redirect_confirm_template,
|
|
|
|
self.sso_auth_confirm_template,
|
|
|
|
self.sso_error_template,
|
|
|
|
sso_account_deactivated_template,
|
|
|
|
sso_auth_success_template,
|
2021-01-12 18:19:42 +00:00
|
|
|
self.sso_auth_bad_user_template,
|
2020-08-17 16:05:00 +00:00
|
|
|
) = self.read_templates(
|
|
|
|
[
|
2021-01-05 11:25:28 +00:00
|
|
|
"sso_login_idp_picker.html",
|
2020-08-17 16:05:00 +00:00
|
|
|
"sso_redirect_confirm.html",
|
|
|
|
"sso_auth_confirm.html",
|
|
|
|
"sso_error.html",
|
|
|
|
"sso_account_deactivated.html",
|
|
|
|
"sso_auth_success.html",
|
2021-01-12 18:19:42 +00:00
|
|
|
"sso_auth_bad_user.html",
|
2020-08-17 16:05:00 +00:00
|
|
|
],
|
2021-08-17 12:45:24 +00:00
|
|
|
(td for td in custom_template_directories if td),
|
2020-04-09 17:28:13 +00:00
|
|
|
)
|
2020-08-17 16:05:00 +00:00
|
|
|
|
|
|
|
# These templates have no placeholders, so render them here
|
|
|
|
self.sso_account_deactivated_template = (
|
|
|
|
sso_account_deactivated_template.render()
|
2020-04-17 17:34:55 +00:00
|
|
|
)
|
2020-08-17 16:05:00 +00:00
|
|
|
self.sso_auth_success_template = sso_auth_success_template.render()
|
2020-03-02 16:36:32 +00:00
|
|
|
|
2020-03-02 17:05:09 +00:00
|
|
|
self.sso_client_whitelist = sso_config.get("client_whitelist") or []
|
|
|
|
|
2021-06-21 22:48:57 +00:00
|
|
|
self.sso_update_profile_information = (
|
|
|
|
sso_config.get("update_profile_information") or False
|
|
|
|
)
|
|
|
|
|
2020-03-27 20:24:52 +00:00
|
|
|
# Attempt to also whitelist the server's login fallback, since that fallback sets
|
|
|
|
# the redirect URL to itself (so it can process the login token then return
|
|
|
|
# gracefully to the client). This would make it pointless to ask the user for
|
|
|
|
# confirmation, since the URL the confirmation page would be showing wouldn't be
|
|
|
|
# the client's.
|
2021-11-08 14:13:10 +00:00
|
|
|
login_fallback_url = (
|
|
|
|
self.root.server.public_baseurl + "_matrix/static/client/login"
|
|
|
|
)
|
|
|
|
self.sso_client_whitelist.append(login_fallback_url)
|