2020-12-02 05:09:21 -07:00
|
|
|
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
2022-12-16 04:53:01 -07:00
|
|
|
from typing import Any, Dict, Optional, Set, Tuple
|
2023-08-25 07:27:21 -06:00
|
|
|
from unittest.mock import AsyncMock, Mock
|
2020-12-15 13:56:10 -07:00
|
|
|
|
2020-12-02 05:09:21 -07:00
|
|
|
import attr
|
|
|
|
|
2022-03-15 07:16:37 -06:00
|
|
|
from twisted.test.proto_helpers import MemoryReactor
|
|
|
|
|
2020-12-04 06:25:15 -07:00
|
|
|
from synapse.api.errors import RedirectException
|
2022-12-16 04:53:01 -07:00
|
|
|
from synapse.module_api import ModuleApi
|
2022-03-15 07:16:37 -06:00
|
|
|
from synapse.server import HomeServer
|
2022-12-16 04:53:01 -07:00
|
|
|
from synapse.types import JsonDict
|
2022-03-15 07:16:37 -06:00
|
|
|
from synapse.util import Clock
|
2020-12-02 05:09:21 -07:00
|
|
|
|
2020-12-02 05:45:42 -07:00
|
|
|
from tests.unittest import HomeserverTestCase, override_config
|
2020-12-02 05:09:21 -07:00
|
|
|
|
2020-12-09 10:23:30 -07:00
|
|
|
# Check if we have the dependencies to run the tests.
|
|
|
|
try:
|
|
|
|
import saml2.config
|
2022-12-16 04:53:01 -07:00
|
|
|
import saml2.response
|
2020-12-09 10:23:30 -07:00
|
|
|
from saml2.sigver import SigverError
|
|
|
|
|
|
|
|
has_saml2 = True
|
|
|
|
|
|
|
|
# pysaml2 can be installed and imported, but might not be able to find xmlsec1.
|
|
|
|
config = saml2.config.SPConfig()
|
|
|
|
try:
|
|
|
|
config.load({"metadata": {}})
|
|
|
|
has_xmlsec1 = True
|
|
|
|
except SigverError:
|
|
|
|
has_xmlsec1 = False
|
|
|
|
except ImportError:
|
|
|
|
has_saml2 = False
|
|
|
|
has_xmlsec1 = False
|
|
|
|
|
2020-12-02 05:09:21 -07:00
|
|
|
# These are a few constants that are used as config parameters in the tests.
|
|
|
|
BASE_URL = "https://synapse/"
|
|
|
|
|
|
|
|
|
|
|
|
@attr.s
|
|
|
|
class FakeAuthnResponse:
|
|
|
|
ava = attr.ib(type=dict)
|
2020-12-15 13:56:10 -07:00
|
|
|
assertions = attr.ib(type=list, factory=list)
|
|
|
|
in_response_to = attr.ib(type=Optional[str], default=None)
|
2020-12-02 05:09:21 -07:00
|
|
|
|
|
|
|
|
|
|
|
class TestMappingProvider:
|
2022-12-16 04:53:01 -07:00
|
|
|
def __init__(self, config: None, module: ModuleApi):
|
2020-12-02 05:09:21 -07:00
|
|
|
pass
|
|
|
|
|
|
|
|
@staticmethod
|
2022-12-16 04:53:01 -07:00
|
|
|
def parse_config(config: JsonDict) -> None:
|
|
|
|
return None
|
2020-12-02 05:09:21 -07:00
|
|
|
|
|
|
|
@staticmethod
|
2022-12-16 04:53:01 -07:00
|
|
|
def get_saml_attributes(config: None) -> Tuple[Set[str], Set[str]]:
|
2020-12-02 05:09:21 -07:00
|
|
|
return {"uid"}, {"displayName"}
|
|
|
|
|
2022-12-16 04:53:01 -07:00
|
|
|
def get_remote_user_id(
|
|
|
|
self, saml_response: "saml2.response.AuthnResponse", client_redirect_url: str
|
|
|
|
) -> str:
|
2020-12-02 05:09:21 -07:00
|
|
|
return saml_response.ava["uid"]
|
|
|
|
|
|
|
|
def saml_response_to_user_attributes(
|
2022-12-16 04:53:01 -07:00
|
|
|
self,
|
|
|
|
saml_response: "saml2.response.AuthnResponse",
|
|
|
|
failures: int,
|
|
|
|
client_redirect_url: str,
|
|
|
|
) -> dict:
|
2020-12-02 05:09:21 -07:00
|
|
|
localpart = saml_response.ava["username"] + (str(failures) if failures else "")
|
|
|
|
return {"mxid_localpart": localpart, "displayname": None}
|
|
|
|
|
|
|
|
|
2020-12-04 06:25:15 -07:00
|
|
|
class TestRedirectMappingProvider(TestMappingProvider):
|
|
|
|
def saml_response_to_user_attributes(
|
2022-12-16 04:53:01 -07:00
|
|
|
self,
|
|
|
|
saml_response: "saml2.response.AuthnResponse",
|
|
|
|
failures: int,
|
|
|
|
client_redirect_url: str,
|
|
|
|
) -> dict:
|
2020-12-04 06:25:15 -07:00
|
|
|
raise RedirectException(b"https://custom-saml-redirect/")
|
|
|
|
|
|
|
|
|
2020-12-02 05:09:21 -07:00
|
|
|
class SamlHandlerTestCase(HomeserverTestCase):
|
2022-03-15 07:16:37 -06:00
|
|
|
def default_config(self) -> Dict[str, Any]:
|
2020-12-02 05:09:21 -07:00
|
|
|
config = super().default_config()
|
|
|
|
config["public_baseurl"] = BASE_URL
|
2022-03-15 07:16:37 -06:00
|
|
|
saml_config: Dict[str, Any] = {
|
2020-12-02 05:09:21 -07:00
|
|
|
"sp_config": {"metadata": {}},
|
|
|
|
# Disable grandfathering.
|
|
|
|
"grandfathered_mxid_source_attribute": None,
|
|
|
|
"user_mapping_provider": {"module": __name__ + ".TestMappingProvider"},
|
|
|
|
}
|
2020-12-02 05:45:42 -07:00
|
|
|
|
|
|
|
# Update this config with what's in the default config so that
|
|
|
|
# override_config works as expected.
|
|
|
|
saml_config.update(config.get("saml2_config", {}))
|
2020-12-02 05:09:21 -07:00
|
|
|
config["saml2_config"] = saml_config
|
|
|
|
|
|
|
|
return config
|
|
|
|
|
2022-03-15 07:16:37 -06:00
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
2020-12-02 05:09:21 -07:00
|
|
|
hs = self.setup_test_homeserver()
|
|
|
|
|
|
|
|
self.handler = hs.get_saml_handler()
|
|
|
|
|
|
|
|
# Reduce the number of attempts when generating MXIDs.
|
|
|
|
sso_handler = hs.get_sso_handler()
|
|
|
|
sso_handler._MAP_USERNAME_RETRIES = 3
|
|
|
|
|
|
|
|
return hs
|
|
|
|
|
2020-12-09 10:23:30 -07:00
|
|
|
if not has_saml2:
|
|
|
|
skip = "Requires pysaml2"
|
|
|
|
elif not has_xmlsec1:
|
|
|
|
skip = "Requires xmlsec1"
|
|
|
|
|
2022-03-15 07:16:37 -06:00
|
|
|
def test_map_saml_response_to_user(self) -> None:
|
2020-12-02 05:09:21 -07:00
|
|
|
"""Ensure that mapping the SAML response returned from a provider to an MXID works properly."""
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-25 07:27:21 -06:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[assignment]
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# send a mocked-up SAML response to the callback
|
2020-12-02 05:09:21 -07:00
|
|
|
saml_response = FakeAuthnResponse({"uid": "test_user", "username": "test_user"})
|
2020-12-15 13:56:10 -07:00
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, "redirect_uri")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 10:43:06 -07:00
|
|
|
"@test_user:test",
|
|
|
|
"saml",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=True,
|
|
|
|
auth_provider_session_id=None,
|
2020-12-02 05:09:21 -07:00
|
|
|
)
|
|
|
|
|
2020-12-02 05:45:42 -07:00
|
|
|
@override_config({"saml2_config": {"grandfathered_mxid_source_attribute": "mxid"}})
|
2022-03-15 07:16:37 -06:00
|
|
|
def test_map_saml_response_to_existing_user(self) -> None:
|
2020-12-02 05:45:42 -07:00
|
|
|
"""Existing users can log in with SAML account."""
|
2022-02-23 04:04:02 -07:00
|
|
|
store = self.hs.get_datastores().main
|
2020-12-02 05:45:42 -07:00
|
|
|
self.get_success(
|
|
|
|
store.register_user(user_id="@test_user:test", password_hash=None)
|
|
|
|
)
|
|
|
|
|
2020-12-15 13:56:10 -07:00
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-25 07:27:21 -06:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[assignment]
|
2020-12-15 13:56:10 -07:00
|
|
|
|
2020-12-02 05:45:42 -07:00
|
|
|
# Map a user via SSO.
|
|
|
|
saml_response = FakeAuthnResponse(
|
|
|
|
{"uid": "tester", "mxid": ["test_user"], "username": "test_user"}
|
|
|
|
)
|
2020-12-15 13:56:10 -07:00
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, "")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 10:43:06 -07:00
|
|
|
"@test_user:test",
|
|
|
|
"saml",
|
|
|
|
request,
|
|
|
|
"",
|
|
|
|
None,
|
|
|
|
new_user=False,
|
|
|
|
auth_provider_session_id=None,
|
2020-12-02 05:45:42 -07:00
|
|
|
)
|
|
|
|
|
|
|
|
# Subsequent calls should map to the same mxid.
|
2020-12-15 13:56:10 -07:00
|
|
|
auth_handler.complete_sso_login.reset_mock()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, "")
|
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 10:43:06 -07:00
|
|
|
"@test_user:test",
|
|
|
|
"saml",
|
|
|
|
request,
|
|
|
|
"",
|
|
|
|
None,
|
|
|
|
new_user=False,
|
|
|
|
auth_provider_session_id=None,
|
2020-12-02 05:45:42 -07:00
|
|
|
)
|
|
|
|
|
2022-03-15 07:16:37 -06:00
|
|
|
def test_map_saml_response_to_invalid_localpart(self) -> None:
|
2020-12-02 05:09:21 -07:00
|
|
|
"""If the mapping provider generates an invalid localpart it should be rejected."""
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-25 07:27:21 -06:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[assignment]
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# mock out the error renderer too
|
|
|
|
sso_handler = self.hs.get_sso_handler()
|
2023-02-14 12:03:35 -07:00
|
|
|
sso_handler.render_error = Mock(return_value=None) # type: ignore[assignment]
|
2020-12-15 13:56:10 -07:00
|
|
|
|
2020-12-02 05:09:21 -07:00
|
|
|
saml_response = FakeAuthnResponse({"uid": "test", "username": "föö"})
|
2020-12-15 13:56:10 -07:00
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, ""),
|
|
|
|
)
|
|
|
|
sso_handler.render_error.assert_called_once_with(
|
|
|
|
request, "mapping_error", "localpart is invalid: föö"
|
2020-12-02 05:09:21 -07:00
|
|
|
)
|
2020-12-15 13:56:10 -07:00
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
2020-12-02 05:09:21 -07:00
|
|
|
|
2022-03-15 07:16:37 -06:00
|
|
|
def test_map_saml_response_to_user_retries(self) -> None:
|
2020-12-02 05:09:21 -07:00
|
|
|
"""The mapping provider can retry generating an MXID if the MXID is already in use."""
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# stub out the auth handler and error renderer
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-25 07:27:21 -06:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[assignment]
|
2020-12-15 13:56:10 -07:00
|
|
|
sso_handler = self.hs.get_sso_handler()
|
2023-02-14 12:03:35 -07:00
|
|
|
sso_handler.render_error = Mock(return_value=None) # type: ignore[assignment]
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# register a user to occupy the first-choice MXID
|
2022-02-23 04:04:02 -07:00
|
|
|
store = self.hs.get_datastores().main
|
2020-12-02 05:09:21 -07:00
|
|
|
self.get_success(
|
|
|
|
store.register_user(user_id="@test_user:test", password_hash=None)
|
|
|
|
)
|
2020-12-15 13:56:10 -07:00
|
|
|
|
|
|
|
# send the fake SAML response
|
2020-12-02 05:09:21 -07:00
|
|
|
saml_response = FakeAuthnResponse({"uid": "test", "username": "test_user"})
|
2020-12-15 13:56:10 -07:00
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, ""),
|
2020-12-02 05:09:21 -07:00
|
|
|
)
|
2020-12-15 13:56:10 -07:00
|
|
|
|
2020-12-02 05:09:21 -07:00
|
|
|
# test_user is already taken, so test_user1 gets registered instead.
|
2020-12-15 13:56:10 -07:00
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 10:43:06 -07:00
|
|
|
"@test_user1:test",
|
|
|
|
"saml",
|
|
|
|
request,
|
|
|
|
"",
|
|
|
|
None,
|
|
|
|
new_user=True,
|
|
|
|
auth_provider_session_id=None,
|
2020-12-15 13:56:10 -07:00
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.reset_mock()
|
2020-12-02 05:09:21 -07:00
|
|
|
|
|
|
|
# Register all of the potential mxids for a particular SAML username.
|
|
|
|
self.get_success(
|
|
|
|
store.register_user(user_id="@tester:test", password_hash=None)
|
|
|
|
)
|
|
|
|
for i in range(1, 3):
|
|
|
|
self.get_success(
|
|
|
|
store.register_user(user_id="@tester%d:test" % i, password_hash=None)
|
|
|
|
)
|
|
|
|
|
|
|
|
# Now attempt to map to a username, this will fail since all potential usernames are taken.
|
|
|
|
saml_response = FakeAuthnResponse({"uid": "tester", "username": "tester"})
|
2020-12-15 13:56:10 -07:00
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, ""),
|
2020-12-02 05:09:21 -07:00
|
|
|
)
|
2020-12-15 13:56:10 -07:00
|
|
|
sso_handler.render_error.assert_called_once_with(
|
|
|
|
request,
|
|
|
|
"mapping_error",
|
|
|
|
"Unable to generate a Matrix ID from the SSO response",
|
2020-12-02 05:09:21 -07:00
|
|
|
)
|
2020-12-15 13:56:10 -07:00
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
2020-12-04 06:25:15 -07:00
|
|
|
|
|
|
|
@override_config(
|
|
|
|
{
|
|
|
|
"saml2_config": {
|
|
|
|
"user_mapping_provider": {
|
|
|
|
"module": __name__ + ".TestRedirectMappingProvider"
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)
|
2022-03-15 07:16:37 -06:00
|
|
|
def test_map_saml_response_redirect(self) -> None:
|
2020-12-15 13:56:10 -07:00
|
|
|
"""Test a mapping provider that raises a RedirectException"""
|
|
|
|
|
2020-12-04 06:25:15 -07:00
|
|
|
saml_response = FakeAuthnResponse({"uid": "test", "username": "test_user"})
|
2020-12-15 13:56:10 -07:00
|
|
|
request = _mock_request()
|
2020-12-04 06:25:15 -07:00
|
|
|
e = self.get_failure(
|
2020-12-15 13:56:10 -07:00
|
|
|
self.handler._handle_authn_response(request, saml_response, ""),
|
2020-12-04 06:25:15 -07:00
|
|
|
RedirectException,
|
|
|
|
)
|
|
|
|
self.assertEqual(e.value.location, b"https://custom-saml-redirect/")
|
2020-12-15 13:56:10 -07:00
|
|
|
|
2021-02-11 08:05:15 -07:00
|
|
|
@override_config(
|
|
|
|
{
|
|
|
|
"saml2_config": {
|
|
|
|
"attribute_requirements": [
|
|
|
|
{"attribute": "userGroup", "value": "staff"},
|
|
|
|
{"attribute": "department", "value": "sales"},
|
|
|
|
],
|
|
|
|
},
|
|
|
|
}
|
|
|
|
)
|
2022-03-15 07:16:37 -06:00
|
|
|
def test_attribute_requirements(self) -> None:
|
2021-02-11 08:05:15 -07:00
|
|
|
"""The required attributes must be met from the SAML response."""
|
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-25 07:27:21 -06:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[assignment]
|
2021-02-11 08:05:15 -07:00
|
|
|
|
|
|
|
# The response doesn't have the proper userGroup or department.
|
|
|
|
saml_response = FakeAuthnResponse({"uid": "test_user", "username": "test_user"})
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, "redirect_uri")
|
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
|
|
|
|
|
|
|
# The response doesn't have the proper department.
|
|
|
|
saml_response = FakeAuthnResponse(
|
|
|
|
{"uid": "test_user", "username": "test_user", "userGroup": ["staff"]}
|
|
|
|
)
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, "redirect_uri")
|
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
|
|
|
|
|
|
|
# Add the proper attributes and it should succeed.
|
|
|
|
saml_response = FakeAuthnResponse(
|
|
|
|
{
|
|
|
|
"uid": "test_user",
|
|
|
|
"username": "test_user",
|
|
|
|
"userGroup": ["staff", "admin"],
|
|
|
|
"department": ["sales"],
|
|
|
|
}
|
|
|
|
)
|
|
|
|
request.reset_mock()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_authn_response(request, saml_response, "redirect_uri")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 10:43:06 -07:00
|
|
|
"@test_user:test",
|
|
|
|
"saml",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=True,
|
|
|
|
auth_provider_session_id=None,
|
2021-02-11 08:05:15 -07:00
|
|
|
)
|
|
|
|
|
2020-12-15 13:56:10 -07:00
|
|
|
|
2022-12-16 04:53:01 -07:00
|
|
|
def _mock_request() -> Mock:
|
2020-12-15 13:56:10 -07:00
|
|
|
"""Returns a mock which will stand in as a SynapseRequest"""
|
2022-04-28 09:49:50 -06:00
|
|
|
mock = Mock(
|
|
|
|
spec=[
|
|
|
|
"finish",
|
2022-05-04 12:11:21 -06:00
|
|
|
"getClientAddress",
|
2022-04-28 09:49:50 -06:00
|
|
|
"getHeader",
|
|
|
|
"setHeader",
|
|
|
|
"setResponseCode",
|
|
|
|
"write",
|
|
|
|
]
|
|
|
|
)
|
|
|
|
# `_disconnected` musn't be another `Mock`, otherwise it will be truthy.
|
|
|
|
mock._disconnected = False
|
|
|
|
return mock
|