2018-12-07 07:11:11 -05:00
|
|
|
# -*- coding: utf-8 -*-
|
2019-04-11 12:08:13 -04:00
|
|
|
# Copyright 2018 New Vector Ltd
|
2019-09-19 15:29:11 -04:00
|
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
2018-12-07 07:11:11 -05:00
|
|
|
#
|
|
|
|
|
# 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.
|
2019-09-19 15:29:11 -04:00
|
|
|
|
2019-12-10 12:30:16 -05:00
|
|
|
import logging
|
2019-09-13 10:20:49 -04:00
|
|
|
|
2019-06-10 19:03:57 -04:00
|
|
|
from synapse.python_dependencies import DependencyException, check_requirements
|
2019-12-10 12:30:16 -05:00
|
|
|
from synapse.util.module_loader import load_module, load_python_module
|
2018-12-07 07:11:11 -05:00
|
|
|
|
|
|
|
|
from ._base import Config, ConfigError
|
|
|
|
|
|
2019-12-10 12:30:16 -05:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
DEFAULT_USER_MAPPING_PROVIDER = (
|
|
|
|
|
"synapse.handlers.saml_handler.DefaultSamlMappingProvider"
|
|
|
|
|
)
|
|
|
|
|
|
2020-03-10 09:49:11 -04:00
|
|
|
SAML2_ERROR_DEFAULT_HTML = """
|
|
|
|
|
<html>
|
|
|
|
|
<body>
|
|
|
|
|
<p>Oops! Something went wrong</p>
|
|
|
|
|
<p>
|
|
|
|
|
Try logging in again from the application and if the problem persists
|
|
|
|
|
please contact the administrator.
|
|
|
|
|
</p>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
"""
|
|
|
|
|
|
2018-12-07 07:11:11 -05:00
|
|
|
|
2019-09-24 06:15:08 -04:00
|
|
|
def _dict_merge(merge_dict, into_dict):
|
|
|
|
|
"""Do a deep merge of two dicts
|
|
|
|
|
|
|
|
|
|
Recursively merges `merge_dict` into `into_dict`:
|
|
|
|
|
* For keys where both `merge_dict` and `into_dict` have a dict value, the values
|
|
|
|
|
are recursively merged
|
|
|
|
|
* For all other keys, the values in `into_dict` (if any) are overwritten with
|
|
|
|
|
the value from `merge_dict`.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
merge_dict (dict): dict to merge
|
|
|
|
|
into_dict (dict): target dict
|
|
|
|
|
"""
|
2019-09-19 15:29:11 -04:00
|
|
|
for k, v in merge_dict.items():
|
2019-09-24 06:15:08 -04:00
|
|
|
if k not in into_dict:
|
|
|
|
|
into_dict[k] = v
|
2019-09-19 15:29:11 -04:00
|
|
|
continue
|
|
|
|
|
|
2019-09-24 06:15:08 -04:00
|
|
|
current_val = into_dict[k]
|
2019-09-19 15:29:11 -04:00
|
|
|
|
|
|
|
|
if isinstance(v, dict) and isinstance(current_val, dict):
|
|
|
|
|
_dict_merge(v, current_val)
|
|
|
|
|
continue
|
|
|
|
|
|
|
|
|
|
# otherwise we just overwrite
|
2019-09-24 06:15:08 -04:00
|
|
|
into_dict[k] = v
|
2019-09-19 15:29:11 -04:00
|
|
|
|
|
|
|
|
|
2018-12-07 07:11:11 -05:00
|
|
|
class SAML2Config(Config):
|
2019-10-10 04:39:35 -04:00
|
|
|
section = "saml2"
|
|
|
|
|
|
2019-06-24 06:34:45 -04:00
|
|
|
def read_config(self, config, **kwargs):
|
2018-12-07 07:11:11 -05:00
|
|
|
self.saml2_enabled = False
|
|
|
|
|
|
|
|
|
|
saml2_config = config.get("saml2_config")
|
|
|
|
|
|
|
|
|
|
if not saml2_config or not saml2_config.get("enabled", True):
|
|
|
|
|
return
|
|
|
|
|
|
2019-09-13 07:07:03 -04:00
|
|
|
if not saml2_config.get("sp_config") and not saml2_config.get("config_path"):
|
|
|
|
|
return
|
|
|
|
|
|
2019-06-10 19:03:57 -04:00
|
|
|
try:
|
2019-06-26 18:50:55 -04:00
|
|
|
check_requirements("saml2")
|
2019-06-10 19:03:57 -04:00
|
|
|
except DependencyException as e:
|
|
|
|
|
raise ConfigError(e.message)
|
|
|
|
|
|
2018-12-07 07:11:11 -05:00
|
|
|
self.saml2_enabled = True
|
|
|
|
|
|
2019-09-13 10:20:49 -04:00
|
|
|
self.saml2_grandfathered_mxid_source_attribute = saml2_config.get(
|
|
|
|
|
"grandfathered_mxid_source_attribute", "uid"
|
|
|
|
|
)
|
|
|
|
|
|
2019-12-10 12:30:16 -05:00
|
|
|
# user_mapping_provider may be None if the key is present but has no value
|
|
|
|
|
ump_dict = saml2_config.get("user_mapping_provider") or {}
|
|
|
|
|
|
|
|
|
|
# Use the default user mapping provider if not set
|
|
|
|
|
ump_dict.setdefault("module", DEFAULT_USER_MAPPING_PROVIDER)
|
|
|
|
|
|
|
|
|
|
# Ensure a config is present
|
|
|
|
|
ump_dict["config"] = ump_dict.get("config") or {}
|
|
|
|
|
|
|
|
|
|
if ump_dict["module"] == DEFAULT_USER_MAPPING_PROVIDER:
|
|
|
|
|
# Load deprecated options for use by the default module
|
|
|
|
|
old_mxid_source_attribute = saml2_config.get("mxid_source_attribute")
|
|
|
|
|
if old_mxid_source_attribute:
|
|
|
|
|
logger.warning(
|
|
|
|
|
"The config option saml2_config.mxid_source_attribute is deprecated. "
|
|
|
|
|
"Please use saml2_config.user_mapping_provider.config"
|
|
|
|
|
".mxid_source_attribute instead."
|
|
|
|
|
)
|
|
|
|
|
ump_dict["config"]["mxid_source_attribute"] = old_mxid_source_attribute
|
|
|
|
|
|
|
|
|
|
old_mxid_mapping = saml2_config.get("mxid_mapping")
|
|
|
|
|
if old_mxid_mapping:
|
|
|
|
|
logger.warning(
|
|
|
|
|
"The config option saml2_config.mxid_mapping is deprecated. Please "
|
|
|
|
|
"use saml2_config.user_mapping_provider.config.mxid_mapping instead."
|
|
|
|
|
)
|
|
|
|
|
ump_dict["config"]["mxid_mapping"] = old_mxid_mapping
|
|
|
|
|
|
|
|
|
|
# Retrieve an instance of the module's class
|
|
|
|
|
# Pass the config dictionary to the module for processing
|
|
|
|
|
(
|
|
|
|
|
self.saml2_user_mapping_provider_class,
|
|
|
|
|
self.saml2_user_mapping_provider_config,
|
|
|
|
|
) = load_module(ump_dict)
|
|
|
|
|
|
|
|
|
|
# Ensure loaded user mapping module has defined all necessary methods
|
|
|
|
|
# Note parse_config() is already checked during the call to load_module
|
|
|
|
|
required_methods = [
|
|
|
|
|
"get_saml_attributes",
|
|
|
|
|
"saml_response_to_user_attributes",
|
2020-01-17 05:32:47 -05:00
|
|
|
"get_remote_user_id",
|
2019-12-10 12:30:16 -05:00
|
|
|
]
|
|
|
|
|
missing_methods = [
|
|
|
|
|
method
|
|
|
|
|
for method in required_methods
|
|
|
|
|
if not hasattr(self.saml2_user_mapping_provider_class, method)
|
|
|
|
|
]
|
|
|
|
|
if missing_methods:
|
|
|
|
|
raise ConfigError(
|
|
|
|
|
"Class specified by saml2_config."
|
|
|
|
|
"user_mapping_provider.module is missing required "
|
|
|
|
|
"methods: %s" % (", ".join(missing_methods),)
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
# Get the desired saml auth response attributes from the module
|
|
|
|
|
saml2_config_dict = self._default_saml_config_dict(
|
|
|
|
|
*self.saml2_user_mapping_provider_class.get_saml_attributes(
|
|
|
|
|
self.saml2_user_mapping_provider_config
|
|
|
|
|
)
|
|
|
|
|
)
|
2019-09-24 06:15:08 -04:00
|
|
|
_dict_merge(
|
|
|
|
|
merge_dict=saml2_config.get("sp_config", {}), into_dict=saml2_config_dict
|
|
|
|
|
)
|
2018-12-07 07:11:11 -05:00
|
|
|
|
|
|
|
|
config_path = saml2_config.get("config_path", None)
|
|
|
|
|
if config_path is not None:
|
2019-09-19 15:29:11 -04:00
|
|
|
mod = load_python_module(config_path)
|
2019-09-24 06:15:08 -04:00
|
|
|
_dict_merge(merge_dict=mod.CONFIG, into_dict=saml2_config_dict)
|
2019-09-19 15:29:11 -04:00
|
|
|
|
|
|
|
|
import saml2.config
|
|
|
|
|
|
|
|
|
|
self.saml2_sp_config = saml2.config.SPConfig()
|
|
|
|
|
self.saml2_sp_config.load(saml2_config_dict)
|
2018-12-07 07:11:11 -05:00
|
|
|
|
2019-06-26 18:50:55 -04:00
|
|
|
# session lifetime: in milliseconds
|
|
|
|
|
self.saml2_session_lifetime = self.parse_duration(
|
|
|
|
|
saml2_config.get("saml_session_lifetime", "5m")
|
|
|
|
|
)
|
|
|
|
|
|
2020-03-10 09:49:11 -04:00
|
|
|
if "error_html_path" in config:
|
|
|
|
|
self.saml2_error_html_content = self.read_file(
|
|
|
|
|
config["error_html_path"], "saml2_config.error_html_path",
|
|
|
|
|
)
|
|
|
|
|
else:
|
|
|
|
|
self.saml2_error_html_content = SAML2_ERROR_DEFAULT_HTML
|
|
|
|
|
|
2019-12-10 12:30:16 -05:00
|
|
|
def _default_saml_config_dict(
|
|
|
|
|
self, required_attributes: set, optional_attributes: set
|
|
|
|
|
):
|
|
|
|
|
"""Generate a configuration dictionary with required and optional attributes that
|
|
|
|
|
will be needed to process new user registration
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
required_attributes: SAML auth response attributes that are
|
|
|
|
|
necessary to function
|
|
|
|
|
optional_attributes: SAML auth response attributes that can be used to add
|
|
|
|
|
additional information to Synapse user accounts, but are not required
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
dict: A SAML configuration dictionary
|
|
|
|
|
"""
|
2018-12-07 07:11:11 -05:00
|
|
|
import saml2
|
|
|
|
|
|
|
|
|
|
public_baseurl = self.public_baseurl
|
|
|
|
|
if public_baseurl is None:
|
2019-06-20 05:32:02 -04:00
|
|
|
raise ConfigError("saml2_config requires a public_baseurl to be set")
|
2018-12-07 07:11:11 -05:00
|
|
|
|
2019-09-13 10:20:49 -04:00
|
|
|
if self.saml2_grandfathered_mxid_source_attribute:
|
|
|
|
|
optional_attributes.add(self.saml2_grandfathered_mxid_source_attribute)
|
|
|
|
|
optional_attributes -= required_attributes
|
|
|
|
|
|
2018-12-07 07:11:11 -05:00
|
|
|
metadata_url = public_baseurl + "_matrix/saml2/metadata.xml"
|
|
|
|
|
response_url = public_baseurl + "_matrix/saml2/authn_response"
|
|
|
|
|
return {
|
|
|
|
|
"entityid": metadata_url,
|
|
|
|
|
"service": {
|
|
|
|
|
"sp": {
|
|
|
|
|
"endpoints": {
|
|
|
|
|
"assertion_consumer_service": [
|
2019-06-20 05:32:02 -04:00
|
|
|
(response_url, saml2.BINDING_HTTP_POST)
|
|
|
|
|
]
|
2018-12-07 07:11:11 -05:00
|
|
|
},
|
2019-09-13 10:20:49 -04:00
|
|
|
"required_attributes": list(required_attributes),
|
|
|
|
|
"optional_attributes": list(optional_attributes),
|
|
|
|
|
# "name_id_format": saml2.saml.NAMEID_FORMAT_PERSISTENT,
|
2019-06-20 05:32:02 -04:00
|
|
|
}
|
|
|
|
|
},
|
2018-12-07 07:11:11 -05:00
|
|
|
}
|
|
|
|
|
|
2019-06-21 19:00:20 -04:00
|
|
|
def generate_config_section(self, config_dir_path, server_name, **kwargs):
|
2019-03-19 06:06:40 -04:00
|
|
|
return """\
|
2018-12-07 07:11:11 -05:00
|
|
|
# Enable SAML2 for registration and login. Uses pysaml2.
|
|
|
|
|
#
|
2019-09-13 07:07:03 -04:00
|
|
|
# At least one of `sp_config` or `config_path` must be set in this section to
|
|
|
|
|
# enable SAML login.
|
2018-12-07 07:11:11 -05:00
|
|
|
#
|
2019-09-13 07:07:03 -04:00
|
|
|
# (You will probably also want to set the following options to `false` to
|
|
|
|
|
# disable the regular login/registration flows:
|
|
|
|
|
# * enable_registration
|
|
|
|
|
# * password_config.enabled
|
2018-12-07 07:11:11 -05:00
|
|
|
#
|
2019-06-26 19:37:41 -04:00
|
|
|
# Once SAML support is enabled, a metadata file will be exposed at
|
|
|
|
|
# https://<server>:<port>/_matrix/saml2/metadata.xml, which you may be able to
|
|
|
|
|
# use to configure your SAML IdP with. Alternatively, you can manually configure
|
|
|
|
|
# the IdP to use an ACS location of
|
|
|
|
|
# https://<server>:<port>/_matrix/saml2/authn_response.
|
|
|
|
|
#
|
2019-09-13 07:07:03 -04:00
|
|
|
saml2_config:
|
|
|
|
|
# `sp_config` is the configuration for the pysaml2 Service Provider.
|
|
|
|
|
# See pysaml2 docs for format of config.
|
|
|
|
|
#
|
|
|
|
|
# Default values will be used for the 'entityid' and 'service' settings,
|
|
|
|
|
# so it is not normally necessary to specify them unless you need to
|
|
|
|
|
# override them.
|
|
|
|
|
#
|
|
|
|
|
#sp_config:
|
|
|
|
|
# # point this to the IdP's metadata. You can use either a local file or
|
|
|
|
|
# # (preferably) a URL.
|
|
|
|
|
# metadata:
|
|
|
|
|
# #local: ["saml2/idp.xml"]
|
|
|
|
|
# remote:
|
|
|
|
|
# - url: https://our_idp/metadata.xml
|
|
|
|
|
#
|
|
|
|
|
# # By default, the user has to go to our login page first. If you'd like
|
2019-10-23 08:22:54 -04:00
|
|
|
# # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
|
2019-09-13 07:07:03 -04:00
|
|
|
# # 'service.sp' section:
|
|
|
|
|
# #
|
|
|
|
|
# #service:
|
|
|
|
|
# # sp:
|
|
|
|
|
# # allow_unsolicited: true
|
|
|
|
|
#
|
|
|
|
|
# # The examples below are just used to generate our metadata xml, and you
|
|
|
|
|
# # may well not need them, depending on your setup. Alternatively you
|
|
|
|
|
# # may need a whole lot more detail - see the pysaml2 docs!
|
|
|
|
|
#
|
|
|
|
|
# description: ["My awesome SP", "en"]
|
|
|
|
|
# name: ["Test SP", "en"]
|
|
|
|
|
#
|
|
|
|
|
# organization:
|
|
|
|
|
# name: Example com
|
|
|
|
|
# display_name:
|
|
|
|
|
# - ["Example co", "en"]
|
|
|
|
|
# url: "http://example.com"
|
|
|
|
|
#
|
|
|
|
|
# contact_person:
|
|
|
|
|
# - given_name: Bob
|
|
|
|
|
# sur_name: "the Sysadmin"
|
|
|
|
|
# email_address": ["admin@example.com"]
|
|
|
|
|
# contact_type": technical
|
|
|
|
|
|
|
|
|
|
# Instead of putting the config inline as above, you can specify a
|
|
|
|
|
# separate pysaml2 configuration file:
|
|
|
|
|
#
|
|
|
|
|
#config_path: "%(config_dir_path)s/sp_conf.py"
|
|
|
|
|
|
2019-12-10 12:30:16 -05:00
|
|
|
# The lifetime of a SAML session. This defines how long a user has to
|
2019-09-13 07:07:03 -04:00
|
|
|
# complete the authentication process, if allow_unsolicited is unset.
|
|
|
|
|
# The default is 5 minutes.
|
|
|
|
|
#
|
|
|
|
|
#saml_session_lifetime: 5m
|
2019-09-13 10:20:49 -04:00
|
|
|
|
2019-12-10 12:30:16 -05:00
|
|
|
# An external module can be provided here as a custom solution to
|
|
|
|
|
# mapping attributes returned from a saml provider onto a matrix user.
|
2019-09-13 10:20:49 -04:00
|
|
|
#
|
2019-12-10 12:30:16 -05:00
|
|
|
user_mapping_provider:
|
|
|
|
|
# The custom module's class. Uncomment to use a custom module.
|
|
|
|
|
#
|
|
|
|
|
#module: mapping_provider.SamlMappingProvider
|
|
|
|
|
|
|
|
|
|
# Custom configuration values for the module. Below options are
|
|
|
|
|
# intended for the built-in provider, they should be changed if
|
|
|
|
|
# using a custom module. This section will be passed as a Python
|
|
|
|
|
# dictionary to the module's `parse_config` method.
|
|
|
|
|
#
|
|
|
|
|
config:
|
|
|
|
|
# The SAML attribute (after mapping via the attribute maps) to use
|
|
|
|
|
# to derive the Matrix ID from. 'uid' by default.
|
|
|
|
|
#
|
|
|
|
|
# Note: This used to be configured by the
|
|
|
|
|
# saml2_config.mxid_source_attribute option. If that is still
|
|
|
|
|
# defined, its value will be used instead.
|
|
|
|
|
#
|
|
|
|
|
#mxid_source_attribute: displayName
|
|
|
|
|
|
|
|
|
|
# The mapping system to use for mapping the saml attribute onto a
|
|
|
|
|
# matrix ID.
|
|
|
|
|
#
|
|
|
|
|
# Options include:
|
|
|
|
|
# * 'hexencode' (which maps unpermitted characters to '=xx')
|
|
|
|
|
# * 'dotreplace' (which replaces unpermitted characters with
|
|
|
|
|
# '.').
|
|
|
|
|
# The default is 'hexencode'.
|
|
|
|
|
#
|
|
|
|
|
# Note: This used to be configured by the
|
|
|
|
|
# saml2_config.mxid_mapping option. If that is still defined, its
|
|
|
|
|
# value will be used instead.
|
|
|
|
|
#
|
|
|
|
|
#mxid_mapping: dotreplace
|
|
|
|
|
|
|
|
|
|
# In previous versions of synapse, the mapping from SAML attribute to
|
|
|
|
|
# MXID was always calculated dynamically rather than stored in a
|
|
|
|
|
# table. For backwards- compatibility, we will look for user_ids
|
|
|
|
|
# matching such a pattern before creating a new account.
|
2019-09-13 10:20:49 -04:00
|
|
|
#
|
|
|
|
|
# This setting controls the SAML attribute which will be used for this
|
2019-12-10 12:30:16 -05:00
|
|
|
# backwards-compatibility lookup. Typically it should be 'uid', but if
|
|
|
|
|
# the attribute maps are changed, it may be necessary to change it.
|
2019-09-13 10:20:49 -04:00
|
|
|
#
|
|
|
|
|
# The default is 'uid'.
|
|
|
|
|
#
|
|
|
|
|
#grandfathered_mxid_source_attribute: upn
|
2020-03-10 10:04:20 -04:00
|
|
|
|
2020-03-10 09:49:11 -04:00
|
|
|
# Path to a file containing HTML content to serve in case an error happens
|
|
|
|
|
# when the user gets redirected from the SAML IdP back to Synapse.
|
|
|
|
|
# If no file is provided, this defaults to some minimalistic HTML telling the
|
|
|
|
|
# user that something went wrong and they should try authenticating again.
|
|
|
|
|
#
|
|
|
|
|
#error_html_path: /path/to/static/content/saml_error.html
|
2019-06-20 05:32:02 -04:00
|
|
|
""" % {
|
|
|
|
|
"config_dir_path": config_dir_path
|
|
|
|
|
}
|
