2016-01-05 18:01:18 +00:00
|
|
|
# Copyright 2015 - 2016 OpenMarket Ltd
|
2015-02-09 14:14:15 +00: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.
|
|
|
|
|
2021-04-09 17:44:38 +00:00
|
|
|
from unittest.mock import Mock
|
2018-07-09 06:09:20 +00:00
|
|
|
|
|
|
|
import pymacaroons
|
|
|
|
|
2022-02-23 11:04:02 +00:00
|
|
|
from twisted.test.proto_helpers import MemoryReactor
|
|
|
|
|
2022-06-17 12:48:55 +00:00
|
|
|
from synapse.api.auth.internal import InternalAuth
|
2022-06-14 08:51:15 +00:00
|
|
|
from synapse.api.auth_blocking import AuthBlocking
|
2019-09-11 17:22:18 +00:00
|
|
|
from synapse.api.constants import UserTypes
|
2019-07-11 10:06:23 +00:00
|
|
|
from synapse.api.errors import (
|
|
|
|
AuthError,
|
|
|
|
Codes,
|
|
|
|
InvalidClientTokenError,
|
|
|
|
MissingClientTokenError,
|
|
|
|
ResourceLimitError,
|
|
|
|
)
|
2021-09-24 09:41:18 +00:00
|
|
|
from synapse.appservice import ApplicationService
|
2022-02-23 11:04:02 +00:00
|
|
|
from synapse.server import HomeServer
|
2020-10-29 15:58:44 +00:00
|
|
|
from synapse.storage.databases.main.registration import TokenLookupResult
|
2023-02-03 20:03:23 +00:00
|
|
|
from synapse.types import Requester, UserID
|
2022-02-23 11:04:02 +00:00
|
|
|
from synapse.util import Clock
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2016-12-06 15:31:37 +00:00
|
|
|
from tests import unittest
|
2021-02-16 13:04:15 +00:00
|
|
|
from tests.test_utils import simple_async_mock
|
2021-12-15 10:40:52 +00:00
|
|
|
from tests.unittest import override_config
|
2021-02-16 13:04:15 +00:00
|
|
|
from tests.utils import mock_getRawHeaders
|
2015-08-26 12:22:23 +00:00
|
|
|
|
2016-12-06 15:31:37 +00:00
|
|
|
|
2021-02-16 13:04:15 +00:00
|
|
|
class AuthTestCase(unittest.HomeserverTestCase):
|
2023-02-03 20:03:23 +00:00
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
2015-02-09 14:14:15 +00:00
|
|
|
self.store = Mock()
|
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
# type-ignore: datastores is None until hs.setup() is called---but it'll
|
|
|
|
# have been called by the HomeserverTestCase machinery.
|
|
|
|
hs.datastores.main = self.store # type: ignore[union-attr]
|
2021-02-16 13:04:15 +00:00
|
|
|
hs.get_auth_handler().store = self.store
|
2022-06-17 12:48:55 +00:00
|
|
|
self.auth = InternalAuth(hs)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2020-05-06 14:54:58 +00:00
|
|
|
# AuthBlocking reads from the hs' config on initialization. We need to
|
|
|
|
# modify its config instead of the hs'
|
2022-06-14 08:51:15 +00:00
|
|
|
self.auth_blocking = AuthBlocking(hs)
|
2020-05-06 14:54:58 +00:00
|
|
|
|
2015-02-09 14:14:15 +00:00
|
|
|
self.test_user = "@foo:bar"
|
2018-08-01 14:54:06 +00:00
|
|
|
self.test_token = b"_test_token_"
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2016-12-06 15:31:37 +00:00
|
|
|
# this is overridden for the appservice tests
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
|
|
|
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.insert_client_ip = simple_async_mock(None)
|
|
|
|
self.store.is_support_user = simple_async_mock(False)
|
2018-12-14 18:20:59 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_user_valid_token(self) -> None:
|
2020-10-29 15:58:44 +00:00
|
|
|
user_info = TokenLookupResult(
|
|
|
|
user_id=self.test_user, token_id=5, device_id="device"
|
|
|
|
)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(user_info)
|
2021-06-24 13:33:20 +00:00
|
|
|
self.store.mark_access_token_as_used = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
requester = self.get_success(self.auth.get_user_by_req(request))
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(requester.user.to_string(), self.test_user)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_user_bad_token(self) -> None:
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
f = self.get_failure(
|
|
|
|
self.auth.get_user_by_req(request), InvalidClientTokenError
|
|
|
|
).value
|
2019-07-11 10:06:23 +00:00
|
|
|
self.assertEqual(f.code, 401)
|
|
|
|
self.assertEqual(f.errcode, "M_UNKNOWN_TOKEN")
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_user_missing_token(self) -> None:
|
2020-10-29 15:58:44 +00:00
|
|
|
user_info = TokenLookupResult(user_id=self.test_user, token_id=5)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(user_info)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
f = self.get_failure(
|
|
|
|
self.auth.get_user_by_req(request), MissingClientTokenError
|
|
|
|
).value
|
2019-07-11 10:06:23 +00:00
|
|
|
self.assertEqual(f.code, 401)
|
|
|
|
self.assertEqual(f.errcode, "M_MISSING_TOKEN")
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token(self) -> None:
|
2018-06-28 19:56:07 +00:00
|
|
|
app_service = Mock(
|
2018-08-10 13:54:09 +00:00
|
|
|
token="foobar", url="a_url", sender=self.test_user, ip_range_whitelist=None
|
2018-06-28 19:56:07 +00:00
|
|
|
)
|
2015-02-09 14:14:15 +00:00
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
requester = self.get_success(self.auth.get_user_by_req(request))
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(requester.user.to_string(), self.test_user)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token_good_ip(self) -> None:
|
2018-06-28 20:14:16 +00:00
|
|
|
from netaddr import IPSet
|
2018-08-10 13:54:09 +00:00
|
|
|
|
2018-06-28 20:14:16 +00:00
|
|
|
app_service = Mock(
|
2018-08-10 13:54:09 +00:00
|
|
|
token="foobar",
|
|
|
|
url="a_url",
|
|
|
|
sender=self.test_user,
|
2018-06-28 20:14:16 +00:00
|
|
|
ip_range_whitelist=IPSet(["192.168/16"]),
|
|
|
|
)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2018-06-28 20:14:16 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "192.168.10.10"
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
2018-06-28 20:14:16 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
requester = self.get_success(self.auth.get_user_by_req(request))
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(requester.user.to_string(), self.test_user)
|
2018-06-28 20:14:16 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token_bad_ip(self) -> None:
|
2018-06-28 20:14:16 +00:00
|
|
|
from netaddr import IPSet
|
2018-08-10 13:54:09 +00:00
|
|
|
|
2018-06-28 20:14:16 +00:00
|
|
|
app_service = Mock(
|
2018-08-10 13:54:09 +00:00
|
|
|
token="foobar",
|
|
|
|
url="a_url",
|
|
|
|
sender=self.test_user,
|
2018-06-28 20:14:16 +00:00
|
|
|
ip_range_whitelist=IPSet(["192.168/16"]),
|
|
|
|
)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2018-06-28 20:14:16 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "131.111.8.42"
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
2018-06-28 20:14:16 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
f = self.get_failure(
|
|
|
|
self.auth.get_user_by_req(request), InvalidClientTokenError
|
|
|
|
).value
|
2019-07-11 10:06:23 +00:00
|
|
|
self.assertEqual(f.code, 401)
|
|
|
|
self.assertEqual(f.errcode, "M_UNKNOWN_TOKEN")
|
2018-06-28 20:14:16 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_bad_token(self) -> None:
|
2015-02-09 14:14:15 +00:00
|
|
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
f = self.get_failure(
|
|
|
|
self.auth.get_user_by_req(request), InvalidClientTokenError
|
|
|
|
).value
|
2019-07-11 10:06:23 +00:00
|
|
|
self.assertEqual(f.code, 401)
|
|
|
|
self.assertEqual(f.errcode, "M_UNKNOWN_TOKEN")
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_missing_token(self) -> None:
|
2015-02-09 14:14:15 +00:00
|
|
|
app_service = Mock(token="foobar", url="a_url", sender=self.test_user)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
f = self.get_failure(
|
|
|
|
self.auth.get_user_by_req(request), MissingClientTokenError
|
|
|
|
).value
|
2019-07-11 10:06:23 +00:00
|
|
|
self.assertEqual(f.code, 401)
|
|
|
|
self.assertEqual(f.errcode, "M_MISSING_TOKEN")
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token_valid_user_id(self) -> None:
|
2018-08-01 14:54:06 +00:00
|
|
|
masquerading_user_id = b"@doppelganger:matrix.org"
|
2018-06-28 19:56:07 +00:00
|
|
|
app_service = Mock(
|
2018-08-10 13:54:09 +00:00
|
|
|
token="foobar", url="a_url", sender=self.test_user, ip_range_whitelist=None
|
2018-06-28 19:56:07 +00:00
|
|
|
)
|
2015-02-09 14:14:15 +00:00
|
|
|
app_service.is_interested_in_user = Mock(return_value=True)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
2020-08-06 12:30:06 +00:00
|
|
|
# This just needs to return a truth-y value.
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_id = simple_async_mock({"is_guest": False})
|
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
|
|
|
request.args[b"user_id"] = [masquerading_user_id]
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
requester = self.get_success(self.auth.get_user_by_req(request))
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(
|
2019-06-20 09:32:02 +00:00
|
|
|
requester.user.to_string(), masquerading_user_id.decode("utf8")
|
2018-08-01 14:54:06 +00:00
|
|
|
)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token_bad_user_id(self) -> None:
|
2018-08-01 14:54:06 +00:00
|
|
|
masquerading_user_id = b"@doppelganger:matrix.org"
|
2018-06-28 19:56:07 +00:00
|
|
|
app_service = Mock(
|
2018-08-10 13:54:09 +00:00
|
|
|
token="foobar", url="a_url", sender=self.test_user, ip_range_whitelist=None
|
2018-06-28 19:56:07 +00:00
|
|
|
)
|
2015-02-09 14:14:15 +00:00
|
|
|
app_service.is_interested_in_user = Mock(return_value=False)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-02-09 14:14:15 +00:00
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2018-08-01 14:54:06 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
|
|
|
request.args[b"user_id"] = [masquerading_user_id]
|
2016-09-12 09:46:02 +00:00
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
2021-02-16 13:04:15 +00:00
|
|
|
self.get_failure(self.auth.get_user_by_req(request), AuthError)
|
2015-08-26 12:22:23 +00:00
|
|
|
|
2021-12-15 10:40:52 +00:00
|
|
|
@override_config({"experimental_features": {"msc3202_device_masquerading": True}})
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token_valid_device_id(self) -> None:
|
2021-12-15 10:40:52 +00:00
|
|
|
"""
|
|
|
|
Tests that when an application service passes the device_id URL parameter
|
|
|
|
with the ID of a valid device for the user in question,
|
|
|
|
the requester instance tracks that device ID.
|
|
|
|
"""
|
|
|
|
masquerading_user_id = b"@doppelganger:matrix.org"
|
|
|
|
masquerading_device_id = b"DOPPELDEVICE"
|
|
|
|
app_service = Mock(
|
|
|
|
token="foobar", url="a_url", sender=self.test_user, ip_range_whitelist=None
|
|
|
|
)
|
|
|
|
app_service.is_interested_in_user = Mock(return_value=True)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
|
|
# This just needs to return a truth-y value.
|
|
|
|
self.store.get_user_by_id = simple_async_mock({"is_guest": False})
|
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
|
|
|
# This also needs to just return a truth-y value
|
|
|
|
self.store.get_device = simple_async_mock({"hidden": False})
|
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2021-12-15 10:40:52 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
|
|
|
request.args[b"user_id"] = [masquerading_user_id]
|
|
|
|
request.args[b"org.matrix.msc3202.device_id"] = [masquerading_device_id]
|
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
|
|
requester = self.get_success(self.auth.get_user_by_req(request))
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(
|
2021-12-15 10:40:52 +00:00
|
|
|
requester.user.to_string(), masquerading_user_id.decode("utf8")
|
|
|
|
)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(requester.device_id, masquerading_device_id.decode("utf8"))
|
2021-12-15 10:40:52 +00:00
|
|
|
|
|
|
|
@override_config({"experimental_features": {"msc3202_device_masquerading": True}})
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req_appservice_valid_token_invalid_device_id(self) -> None:
|
2021-12-15 10:40:52 +00:00
|
|
|
"""
|
|
|
|
Tests that when an application service passes the device_id URL parameter
|
|
|
|
with an ID that is not a valid device ID for the user in question,
|
|
|
|
the request fails with the appropriate error code.
|
|
|
|
"""
|
|
|
|
masquerading_user_id = b"@doppelganger:matrix.org"
|
|
|
|
masquerading_device_id = b"NOT_A_REAL_DEVICE_ID"
|
|
|
|
app_service = Mock(
|
|
|
|
token="foobar", url="a_url", sender=self.test_user, ip_range_whitelist=None
|
|
|
|
)
|
|
|
|
app_service.is_interested_in_user = Mock(return_value=True)
|
|
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
|
|
# This just needs to return a truth-y value.
|
|
|
|
self.store.get_user_by_id = simple_async_mock({"is_guest": False})
|
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
|
|
|
# This also needs to just return a falsey value
|
|
|
|
self.store.get_device = simple_async_mock(None)
|
|
|
|
|
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2021-12-15 10:40:52 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
|
|
|
request.args[b"user_id"] = [masquerading_user_id]
|
|
|
|
request.args[b"org.matrix.msc3202.device_id"] = [masquerading_device_id]
|
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
|
|
|
|
|
|
failure = self.get_failure(self.auth.get_user_by_req(request), AuthError)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(failure.value.code, 400)
|
|
|
|
self.assertEqual(failure.value.errcode, Codes.EXCLUSIVE)
|
2021-12-15 10:40:52 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req__puppeted_token__not_tracking_puppeted_mau(self) -> None:
|
2022-01-12 16:09:36 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(
|
|
|
|
TokenLookupResult(
|
|
|
|
user_id="@baldrick:matrix.org",
|
|
|
|
device_id="device",
|
2022-08-22 13:17:59 +00:00
|
|
|
token_id=5,
|
2022-01-12 16:09:36 +00:00
|
|
|
token_owner="@admin:matrix.org",
|
2022-08-22 13:17:59 +00:00
|
|
|
token_used=True,
|
2022-01-12 16:09:36 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
self.store.insert_client_ip = simple_async_mock(None)
|
2022-08-22 13:17:59 +00:00
|
|
|
self.store.mark_access_token_as_used = simple_async_mock(None)
|
2022-01-12 16:09:36 +00:00
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2022-01-12 16:09:36 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
|
|
self.get_success(self.auth.get_user_by_req(request))
|
|
|
|
self.store.insert_client_ip.assert_called_once()
|
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_by_req__puppeted_token__tracking_puppeted_mau(self) -> None:
|
2022-01-12 16:09:36 +00:00
|
|
|
self.auth._track_puppeted_user_ips = True
|
|
|
|
self.store.get_user_by_access_token = simple_async_mock(
|
|
|
|
TokenLookupResult(
|
|
|
|
user_id="@baldrick:matrix.org",
|
|
|
|
device_id="device",
|
2022-08-22 13:17:59 +00:00
|
|
|
token_id=5,
|
2022-01-12 16:09:36 +00:00
|
|
|
token_owner="@admin:matrix.org",
|
2022-08-22 13:17:59 +00:00
|
|
|
token_used=True,
|
2022-01-12 16:09:36 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
self.store.insert_client_ip = simple_async_mock(None)
|
2022-08-22 13:17:59 +00:00
|
|
|
self.store.mark_access_token_as_used = simple_async_mock(None)
|
2022-01-12 16:09:36 +00:00
|
|
|
request = Mock(args={})
|
2022-05-04 18:11:21 +00:00
|
|
|
request.getClientAddress.return_value.host = "127.0.0.1"
|
2022-01-12 16:09:36 +00:00
|
|
|
request.args[b"access_token"] = [self.test_token]
|
|
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
|
|
self.get_success(self.auth.get_user_by_req(request))
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(self.store.insert_client_ip.call_count, 2)
|
2022-01-12 16:09:36 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_user_from_macaroon(self) -> None:
|
2022-06-14 13:12:08 +00:00
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2015-08-26 12:22:23 +00:00
|
|
|
|
2015-09-01 11:41:16 +00:00
|
|
|
user_id = "@baldrick:matrix.org"
|
2015-08-26 12:22:23 +00:00
|
|
|
macaroon = pymacaroons.Macaroon(
|
2021-09-29 10:44:15 +00:00
|
|
|
location=self.hs.config.server.server_name,
|
2015-08-26 12:22:23 +00:00
|
|
|
identifier="key",
|
2021-09-23 16:03:01 +00:00
|
|
|
key=self.hs.config.key.macaroon_secret_key,
|
2018-08-10 13:54:09 +00:00
|
|
|
)
|
2022-06-14 13:12:08 +00:00
|
|
|
# "Legacy" macaroons should not work for regular users not in the database
|
2015-08-26 12:22:23 +00:00
|
|
|
macaroon.add_first_party_caveat("gen = 1")
|
|
|
|
macaroon.add_first_party_caveat("type = access")
|
2015-09-01 11:41:16 +00:00
|
|
|
macaroon.add_first_party_caveat("user_id = %s" % (user_id,))
|
2022-06-14 13:12:08 +00:00
|
|
|
serialized = macaroon.serialize()
|
|
|
|
self.get_failure(
|
|
|
|
self.auth.get_user_by_access_token(serialized), InvalidClientTokenError
|
2020-04-15 16:40:18 +00:00
|
|
|
)
|
2016-07-20 14:25:40 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_get_guest_user_from_macaroon(self) -> None:
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_user_by_id = simple_async_mock({"is_guest": True})
|
|
|
|
self.store.get_user_by_access_token = simple_async_mock(None)
|
2016-12-06 15:31:37 +00:00
|
|
|
|
2015-11-04 17:29:07 +00:00
|
|
|
user_id = "@baldrick:matrix.org"
|
|
|
|
macaroon = pymacaroons.Macaroon(
|
2021-09-29 10:44:15 +00:00
|
|
|
location=self.hs.config.server.server_name,
|
2015-11-04 17:29:07 +00:00
|
|
|
identifier="key",
|
2021-09-23 16:03:01 +00:00
|
|
|
key=self.hs.config.key.macaroon_secret_key,
|
2018-08-10 13:54:09 +00:00
|
|
|
)
|
2015-11-04 17:29:07 +00:00
|
|
|
macaroon.add_first_party_caveat("gen = 1")
|
|
|
|
macaroon.add_first_party_caveat("type = access")
|
|
|
|
macaroon.add_first_party_caveat("user_id = %s" % (user_id,))
|
|
|
|
macaroon.add_first_party_caveat("guest = true")
|
|
|
|
serialized = macaroon.serialize()
|
|
|
|
|
2021-02-16 13:04:15 +00:00
|
|
|
user_info = self.get_success(self.auth.get_user_by_access_token(serialized))
|
2022-08-22 13:17:59 +00:00
|
|
|
self.assertEqual(user_id, user_info.user.to_string())
|
2020-10-29 15:58:44 +00:00
|
|
|
self.assertTrue(user_info.is_guest)
|
2016-12-06 15:31:37 +00:00
|
|
|
self.store.get_user_by_id.assert_called_with(user_id)
|
2015-11-04 17:29:07 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_blocking_mau(self) -> None:
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._limit_usage_by_mau = False
|
|
|
|
self.auth_blocking._max_mau_value = 50
|
2018-08-02 15:57:35 +00:00
|
|
|
lots_of_users = 100
|
|
|
|
small_number_of_users = 1
|
|
|
|
|
|
|
|
# Ensure no error thrown
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_success(self.auth_blocking.check_auth_blocking())
|
2018-08-02 15:57:35 +00:00
|
|
|
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._limit_usage_by_mau = True
|
2018-08-02 15:57:35 +00:00
|
|
|
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_monthly_active_count = simple_async_mock(lots_of_users)
|
2018-08-02 15:57:35 +00:00
|
|
|
|
2022-06-14 08:51:15 +00:00
|
|
|
e = self.get_failure(
|
|
|
|
self.auth_blocking.check_auth_blocking(), ResourceLimitError
|
|
|
|
)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(e.value.admin_contact, self.hs.config.server.admin_contact)
|
|
|
|
self.assertEqual(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
self.assertEqual(e.value.code, 403)
|
2018-08-02 15:57:35 +00:00
|
|
|
|
|
|
|
# Ensure does not throw an error
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_monthly_active_count = simple_async_mock(small_number_of_users)
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_success(self.auth_blocking.check_auth_blocking())
|
2018-08-04 21:07:04 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_blocking_mau__depending_on_user_type(self) -> None:
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._max_mau_value = 50
|
|
|
|
self.auth_blocking._limit_usage_by_mau = True
|
2019-09-11 17:22:18 +00:00
|
|
|
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_monthly_active_count = simple_async_mock(100)
|
2019-09-11 17:22:18 +00:00
|
|
|
# Support users allowed
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_success(
|
|
|
|
self.auth_blocking.check_auth_blocking(user_type=UserTypes.SUPPORT)
|
|
|
|
)
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_monthly_active_count = simple_async_mock(100)
|
2019-09-11 17:22:18 +00:00
|
|
|
# Bots not allowed
|
2021-02-16 13:04:15 +00:00
|
|
|
self.get_failure(
|
2022-06-14 08:51:15 +00:00
|
|
|
self.auth_blocking.check_auth_blocking(user_type=UserTypes.BOT),
|
|
|
|
ResourceLimitError,
|
2021-02-16 13:04:15 +00:00
|
|
|
)
|
|
|
|
self.store.get_monthly_active_count = simple_async_mock(100)
|
2019-09-11 17:22:18 +00:00
|
|
|
# Real users not allowed
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_failure(self.auth_blocking.check_auth_blocking(), ResourceLimitError)
|
2019-09-11 17:22:18 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_blocking_mau__appservice_requester_allowed_when_not_tracking_ips(
|
|
|
|
self,
|
|
|
|
) -> None:
|
2021-09-24 09:41:18 +00:00
|
|
|
self.auth_blocking._max_mau_value = 50
|
|
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
|
|
self.auth_blocking._track_appservice_user_ips = False
|
|
|
|
|
|
|
|
self.store.get_monthly_active_count = simple_async_mock(100)
|
|
|
|
self.store.user_last_seen_monthly_active = simple_async_mock()
|
|
|
|
self.store.is_trial_user = simple_async_mock()
|
|
|
|
|
|
|
|
appservice = ApplicationService(
|
|
|
|
"abcd",
|
|
|
|
id="1234",
|
|
|
|
namespaces={
|
|
|
|
"users": [{"regex": "@_appservice.*:sender", "exclusive": True}]
|
|
|
|
},
|
|
|
|
sender="@appservice:sender",
|
|
|
|
)
|
|
|
|
requester = Requester(
|
2023-02-03 20:03:23 +00:00
|
|
|
user=UserID.from_string("@appservice:server"),
|
2021-09-24 09:41:18 +00:00
|
|
|
access_token_id=None,
|
|
|
|
device_id="FOOBAR",
|
|
|
|
is_guest=False,
|
2022-06-17 14:58:05 +00:00
|
|
|
scope=set(),
|
2021-09-24 09:41:18 +00:00
|
|
|
shadow_banned=False,
|
|
|
|
app_service=appservice,
|
|
|
|
authenticated_entity="@appservice:server",
|
|
|
|
)
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_success(self.auth_blocking.check_auth_blocking(requester=requester))
|
2021-09-24 09:41:18 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_blocking_mau__appservice_requester_disallowed_when_tracking_ips(
|
|
|
|
self,
|
|
|
|
) -> None:
|
2021-09-24 09:41:18 +00:00
|
|
|
self.auth_blocking._max_mau_value = 50
|
|
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
|
|
self.auth_blocking._track_appservice_user_ips = True
|
|
|
|
|
|
|
|
self.store.get_monthly_active_count = simple_async_mock(100)
|
|
|
|
self.store.user_last_seen_monthly_active = simple_async_mock()
|
|
|
|
self.store.is_trial_user = simple_async_mock()
|
|
|
|
|
|
|
|
appservice = ApplicationService(
|
|
|
|
"abcd",
|
|
|
|
id="1234",
|
|
|
|
namespaces={
|
|
|
|
"users": [{"regex": "@_appservice.*:sender", "exclusive": True}]
|
|
|
|
},
|
|
|
|
sender="@appservice:sender",
|
|
|
|
)
|
|
|
|
requester = Requester(
|
2023-02-03 20:03:23 +00:00
|
|
|
user=UserID.from_string("@appservice:server"),
|
2021-09-24 09:41:18 +00:00
|
|
|
access_token_id=None,
|
|
|
|
device_id="FOOBAR",
|
|
|
|
is_guest=False,
|
2022-06-17 14:58:05 +00:00
|
|
|
scope=set(),
|
2021-09-24 09:41:18 +00:00
|
|
|
shadow_banned=False,
|
|
|
|
app_service=appservice,
|
|
|
|
authenticated_entity="@appservice:server",
|
|
|
|
)
|
|
|
|
self.get_failure(
|
2022-06-14 08:51:15 +00:00
|
|
|
self.auth_blocking.check_auth_blocking(requester=requester),
|
|
|
|
ResourceLimitError,
|
2021-09-24 09:41:18 +00:00
|
|
|
)
|
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_reserved_threepid(self) -> None:
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
|
|
self.auth_blocking._max_mau_value = 1
|
2021-02-16 13:04:15 +00:00
|
|
|
self.store.get_monthly_active_count = simple_async_mock(2)
|
2019-06-20 09:32:02 +00:00
|
|
|
threepid = {"medium": "email", "address": "reserved@server.com"}
|
|
|
|
unknown_threepid = {"medium": "email", "address": "unreserved@server.com"}
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._mau_limits_reserved_threepids = [threepid]
|
2018-08-31 09:49:14 +00:00
|
|
|
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_failure(self.auth_blocking.check_auth_blocking(), ResourceLimitError)
|
2018-08-31 09:49:14 +00:00
|
|
|
|
2021-02-16 13:04:15 +00:00
|
|
|
self.get_failure(
|
2022-06-14 08:51:15 +00:00
|
|
|
self.auth_blocking.check_auth_blocking(threepid=unknown_threepid),
|
|
|
|
ResourceLimitError,
|
2021-02-16 13:04:15 +00:00
|
|
|
)
|
2018-08-31 09:49:14 +00:00
|
|
|
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_success(self.auth_blocking.check_auth_blocking(threepid=threepid))
|
2018-08-31 09:49:14 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_hs_disabled(self) -> None:
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._hs_disabled = True
|
|
|
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
2022-06-14 08:51:15 +00:00
|
|
|
e = self.get_failure(
|
|
|
|
self.auth_blocking.check_auth_blocking(), ResourceLimitError
|
|
|
|
)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(e.value.admin_contact, self.hs.config.server.admin_contact)
|
|
|
|
self.assertEqual(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
self.assertEqual(e.value.code, 403)
|
2018-08-18 11:31:08 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_hs_disabled_no_server_notices_user(self) -> None:
|
2019-03-19 11:04:12 +00:00
|
|
|
"""Check that 'hs_disabled_message' works correctly when there is no
|
|
|
|
server_notices user.
|
|
|
|
"""
|
|
|
|
# this should be the default, but we had a bug where the test was doing the wrong
|
|
|
|
# thing, so let's make it explicit
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._server_notices_mxid = None
|
2019-03-19 11:04:12 +00:00
|
|
|
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._hs_disabled = True
|
|
|
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
2022-06-14 08:51:15 +00:00
|
|
|
e = self.get_failure(
|
|
|
|
self.auth_blocking.check_auth_blocking(), ResourceLimitError
|
|
|
|
)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(e.value.admin_contact, self.hs.config.server.admin_contact)
|
|
|
|
self.assertEqual(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
self.assertEqual(e.value.code, 403)
|
2019-03-19 11:04:12 +00:00
|
|
|
|
2023-02-03 20:03:23 +00:00
|
|
|
def test_server_notices_mxid_special_cased(self) -> None:
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._hs_disabled = True
|
2018-08-18 11:31:08 +00:00
|
|
|
user = "@user:server"
|
2020-05-06 14:54:58 +00:00
|
|
|
self.auth_blocking._server_notices_mxid = user
|
|
|
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
2022-06-14 08:51:15 +00:00
|
|
|
self.get_success(self.auth_blocking.check_auth_blocking(user))
|