2021-01-03 16:25:44 +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 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]
|
2021-01-03 16:25:44 +00:00
|
|
|
#
|
|
|
|
#
|
2022-03-17 11:25:50 +00:00
|
|
|
from typing import Any, Dict
|
2023-08-25 13:27:21 +00:00
|
|
|
from unittest.mock import AsyncMock, Mock
|
2021-01-03 16:25:44 +00:00
|
|
|
|
2022-03-17 11:25:50 +00:00
|
|
|
from twisted.test.proto_helpers import MemoryReactor
|
|
|
|
|
2021-04-20 18:55:20 +00:00
|
|
|
from synapse.handlers.cas import CasResponse
|
2022-03-17 11:25:50 +00:00
|
|
|
from synapse.server import HomeServer
|
|
|
|
from synapse.util import Clock
|
2021-01-03 16:25:44 +00:00
|
|
|
|
2021-02-11 15:05:15 +00:00
|
|
|
from tests.unittest import HomeserverTestCase, override_config
|
2021-01-03 16:25:44 +00:00
|
|
|
|
|
|
|
# These are a few constants that are used as config parameters in the tests.
|
|
|
|
BASE_URL = "https://synapse/"
|
|
|
|
SERVER_URL = "https://issuer/"
|
|
|
|
|
|
|
|
|
|
|
|
class CasHandlerTestCase(HomeserverTestCase):
|
2022-03-17 11:25:50 +00:00
|
|
|
def default_config(self) -> Dict[str, Any]:
|
2021-01-03 16:25:44 +00:00
|
|
|
config = super().default_config()
|
|
|
|
config["public_baseurl"] = BASE_URL
|
|
|
|
cas_config = {
|
|
|
|
"enabled": True,
|
|
|
|
"server_url": SERVER_URL,
|
|
|
|
"service_url": BASE_URL,
|
|
|
|
}
|
2021-02-11 15:05:15 +00:00
|
|
|
|
|
|
|
# Update this config with what's in the default config so that
|
|
|
|
# override_config works as expected.
|
|
|
|
cas_config.update(config.get("cas_config", {}))
|
2021-01-03 16:25:44 +00:00
|
|
|
config["cas_config"] = cas_config
|
|
|
|
|
|
|
|
return config
|
|
|
|
|
2022-03-17 11:25:50 +00:00
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
2021-01-03 16:25:44 +00:00
|
|
|
hs = self.setup_test_homeserver()
|
|
|
|
|
|
|
|
self.handler = hs.get_cas_handler()
|
|
|
|
|
|
|
|
# Reduce the number of attempts when generating MXIDs.
|
|
|
|
sso_handler = hs.get_sso_handler()
|
|
|
|
sso_handler._MAP_USERNAME_RETRIES = 3
|
|
|
|
|
|
|
|
return hs
|
|
|
|
|
2022-03-17 11:25:50 +00:00
|
|
|
def test_map_cas_user_to_user(self) -> None:
|
2021-01-03 16:25:44 +00:00
|
|
|
"""Ensure that mapping the CAS user returned from a provider to an MXID works properly."""
|
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-29 14:38:56 +00:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[method-assign]
|
2021-01-03 16:25:44 +00:00
|
|
|
|
|
|
|
cas_response = CasResponse("test_user", {})
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 17:43:06 +00:00
|
|
|
"@test_user:test",
|
|
|
|
"cas",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=True,
|
|
|
|
auth_provider_session_id=None,
|
2021-01-03 16:25:44 +00:00
|
|
|
)
|
|
|
|
|
2022-03-17 11:25:50 +00:00
|
|
|
def test_map_cas_user_to_existing_user(self) -> None:
|
2021-01-03 16:25:44 +00:00
|
|
|
"""Existing users can log in with CAS account."""
|
2022-02-23 11:04:02 +00:00
|
|
|
store = self.hs.get_datastores().main
|
2021-01-03 16:25:44 +00:00
|
|
|
self.get_success(
|
|
|
|
store.register_user(user_id="@test_user:test", password_hash=None)
|
|
|
|
)
|
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-29 14:38:56 +00:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[method-assign]
|
2021-01-03 16:25:44 +00:00
|
|
|
|
|
|
|
# Map a user via SSO.
|
|
|
|
cas_response = CasResponse("test_user", {})
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 17:43:06 +00:00
|
|
|
"@test_user:test",
|
|
|
|
"cas",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=False,
|
|
|
|
auth_provider_session_id=None,
|
2021-01-03 16:25:44 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
# Subsequent calls should map to the same mxid.
|
|
|
|
auth_handler.complete_sso_login.reset_mock()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 17:43:06 +00:00
|
|
|
"@test_user:test",
|
|
|
|
"cas",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=False,
|
|
|
|
auth_provider_session_id=None,
|
2021-01-03 16:25:44 +00:00
|
|
|
)
|
|
|
|
|
2022-03-17 11:25:50 +00:00
|
|
|
def test_map_cas_user_to_invalid_localpart(self) -> None:
|
2021-01-03 16:25:44 +00:00
|
|
|
"""CAS automaps invalid characters to base-64 encoding."""
|
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-29 14:38:56 +00:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[method-assign]
|
2021-01-03 16:25:44 +00:00
|
|
|
|
|
|
|
cas_response = CasResponse("föö", {})
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 17:43:06 +00:00
|
|
|
"@f=c3=b6=c3=b6:test",
|
|
|
|
"cas",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=True,
|
|
|
|
auth_provider_session_id=None,
|
2021-01-03 16:25:44 +00:00
|
|
|
)
|
|
|
|
|
2021-02-11 15:05:15 +00:00
|
|
|
@override_config(
|
|
|
|
{
|
|
|
|
"cas_config": {
|
|
|
|
"required_attributes": {"userGroup": "staff", "department": None}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)
|
2022-03-17 11:25:50 +00:00
|
|
|
def test_required_attributes(self) -> None:
|
2021-02-11 15:05:15 +00:00
|
|
|
"""The required attributes must be met from the CAS response."""
|
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
2023-08-29 14:38:56 +00:00
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[method-assign]
|
2021-02-11 15:05:15 +00:00
|
|
|
|
|
|
|
# The response doesn't have the proper userGroup or department.
|
|
|
|
cas_response = CasResponse("test_user", {})
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
|
|
|
|
|
|
|
# The response doesn't have any department.
|
2022-03-17 11:25:50 +00:00
|
|
|
cas_response = CasResponse("test_user", {"userGroup": ["staff"]})
|
2021-02-11 15:05:15 +00:00
|
|
|
request.reset_mock()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
|
|
|
|
|
|
|
# Add the proper attributes and it should succeed.
|
|
|
|
cas_response = CasResponse(
|
|
|
|
"test_user", {"userGroup": ["staff", "admin"], "department": ["sales"]}
|
|
|
|
)
|
|
|
|
request.reset_mock()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler got called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_called_once_with(
|
2021-12-06 17:43:06 +00:00
|
|
|
"@test_user:test",
|
|
|
|
"cas",
|
|
|
|
request,
|
|
|
|
"redirect_uri",
|
|
|
|
None,
|
|
|
|
new_user=True,
|
|
|
|
auth_provider_session_id=None,
|
2021-02-11 15:05:15 +00:00
|
|
|
)
|
|
|
|
|
2023-09-06 18:32:24 +00:00
|
|
|
@override_config({"cas_config": {"enable_registration": False}})
|
|
|
|
def test_map_cas_user_does_not_register_new_user(self) -> None:
|
|
|
|
"""Ensures new users are not registered if the enabled registration flag is disabled."""
|
|
|
|
|
|
|
|
# stub out the auth handler
|
|
|
|
auth_handler = self.hs.get_auth_handler()
|
|
|
|
auth_handler.complete_sso_login = AsyncMock() # type: ignore[method-assign]
|
|
|
|
|
|
|
|
cas_response = CasResponse("test_user", {})
|
|
|
|
request = _mock_request()
|
|
|
|
self.get_success(
|
|
|
|
self.handler._handle_cas_response(request, cas_response, "redirect_uri", "")
|
|
|
|
)
|
|
|
|
|
|
|
|
# check that the auth handler was not called as expected
|
|
|
|
auth_handler.complete_sso_login.assert_not_called()
|
|
|
|
|
2021-01-03 16:25:44 +00:00
|
|
|
|
2022-12-16 11:53:01 +00:00
|
|
|
def _mock_request() -> Mock:
|
2021-01-03 16:25:44 +00:00
|
|
|
"""Returns a mock which will stand in as a SynapseRequest"""
|
2022-04-28 15:49:50 +00:00
|
|
|
mock = Mock(
|
|
|
|
spec=[
|
|
|
|
"finish",
|
2022-05-04 18:11:21 +00:00
|
|
|
"getClientAddress",
|
2022-04-28 15:49:50 +00:00
|
|
|
"getHeader",
|
|
|
|
"setHeader",
|
|
|
|
"setResponseCode",
|
|
|
|
"write",
|
|
|
|
]
|
|
|
|
)
|
|
|
|
# `_disconnected` musn't be another `Mock`, otherwise it will be truthy.
|
|
|
|
mock._disconnected = False
|
|
|
|
return mock
|