mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-06-05 21:08:49 -04:00
f21e24ffc2
We do it this way round so that only the "owner" can delete the access token (i.e. `/logout/all` by the "owner" also deletes that token, but `/logout/all` by the "target user" doesn't).
A future PR will add an API for creating such a token.
When the target user and authenticated entity are different the `Processed request` log line will be logged with a: `{@admin:server as @bob:server} ...`. I'm not convinced by that format (especially since it adds spaces in there, making it harder to use `cut -d ' '` to chop off the start of log lines). Suggestions welcome.
433 lines
18 KiB
Python
433 lines
18 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2015 - 2016 OpenMarket Ltd
|
|
#
|
|
# 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.
|
|
|
|
from mock import Mock
|
|
|
|
import pymacaroons
|
|
|
|
from twisted.internet import defer
|
|
|
|
from synapse.api.auth import Auth
|
|
from synapse.api.constants import UserTypes
|
|
from synapse.api.errors import (
|
|
AuthError,
|
|
Codes,
|
|
InvalidClientCredentialsError,
|
|
InvalidClientTokenError,
|
|
MissingClientTokenError,
|
|
ResourceLimitError,
|
|
)
|
|
from synapse.storage.databases.main.registration import TokenLookupResult
|
|
from synapse.types import UserID
|
|
|
|
from tests import unittest
|
|
from tests.utils import mock_getRawHeaders, setup_test_homeserver
|
|
|
|
|
|
class AuthTestCase(unittest.TestCase):
|
|
@defer.inlineCallbacks
|
|
def setUp(self):
|
|
self.state_handler = Mock()
|
|
self.store = Mock()
|
|
|
|
self.hs = yield setup_test_homeserver(self.addCleanup)
|
|
self.hs.get_datastore = Mock(return_value=self.store)
|
|
self.hs.get_auth_handler().store = self.store
|
|
self.auth = Auth(self.hs)
|
|
|
|
# AuthBlocking reads from the hs' config on initialization. We need to
|
|
# modify its config instead of the hs'
|
|
self.auth_blocking = self.auth._auth_blocking
|
|
|
|
self.test_user = "@foo:bar"
|
|
self.test_token = b"_test_token_"
|
|
|
|
# this is overridden for the appservice tests
|
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
|
|
|
self.store.insert_client_ip = Mock(return_value=defer.succeed(None))
|
|
self.store.is_support_user = Mock(return_value=defer.succeed(False))
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_user_by_req_user_valid_token(self):
|
|
user_info = TokenLookupResult(
|
|
user_id=self.test_user, token_id=5, device_id="device"
|
|
)
|
|
self.store.get_user_by_access_token = Mock(
|
|
return_value=defer.succeed(user_info)
|
|
)
|
|
|
|
request = Mock(args={})
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
requester = yield defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
self.assertEquals(requester.user.to_string(), self.test_user)
|
|
|
|
def test_get_user_by_req_user_bad_token(self):
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
d = defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
f = self.failureResultOf(d, InvalidClientTokenError).value
|
|
self.assertEqual(f.code, 401)
|
|
self.assertEqual(f.errcode, "M_UNKNOWN_TOKEN")
|
|
|
|
def test_get_user_by_req_user_missing_token(self):
|
|
user_info = TokenLookupResult(user_id=self.test_user, token_id=5)
|
|
self.store.get_user_by_access_token = Mock(
|
|
return_value=defer.succeed(user_info)
|
|
)
|
|
|
|
request = Mock(args={})
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
d = defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
f = self.failureResultOf(d, MissingClientTokenError).value
|
|
self.assertEqual(f.code, 401)
|
|
self.assertEqual(f.errcode, "M_MISSING_TOKEN")
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_user_by_req_appservice_valid_token(self):
|
|
app_service = Mock(
|
|
token="foobar", url="a_url", sender=self.test_user, ip_range_whitelist=None
|
|
)
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.getClientIP.return_value = "127.0.0.1"
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
requester = yield defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
self.assertEquals(requester.user.to_string(), self.test_user)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_user_by_req_appservice_valid_token_good_ip(self):
|
|
from netaddr import IPSet
|
|
|
|
app_service = Mock(
|
|
token="foobar",
|
|
url="a_url",
|
|
sender=self.test_user,
|
|
ip_range_whitelist=IPSet(["192.168/16"]),
|
|
)
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.getClientIP.return_value = "192.168.10.10"
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
requester = yield defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
self.assertEquals(requester.user.to_string(), self.test_user)
|
|
|
|
def test_get_user_by_req_appservice_valid_token_bad_ip(self):
|
|
from netaddr import IPSet
|
|
|
|
app_service = Mock(
|
|
token="foobar",
|
|
url="a_url",
|
|
sender=self.test_user,
|
|
ip_range_whitelist=IPSet(["192.168/16"]),
|
|
)
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.getClientIP.return_value = "131.111.8.42"
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
d = defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
f = self.failureResultOf(d, InvalidClientTokenError).value
|
|
self.assertEqual(f.code, 401)
|
|
self.assertEqual(f.errcode, "M_UNKNOWN_TOKEN")
|
|
|
|
def test_get_user_by_req_appservice_bad_token(self):
|
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
d = defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
f = self.failureResultOf(d, InvalidClientTokenError).value
|
|
self.assertEqual(f.code, 401)
|
|
self.assertEqual(f.errcode, "M_UNKNOWN_TOKEN")
|
|
|
|
def test_get_user_by_req_appservice_missing_token(self):
|
|
app_service = Mock(token="foobar", url="a_url", sender=self.test_user)
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
d = defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
f = self.failureResultOf(d, MissingClientTokenError).value
|
|
self.assertEqual(f.code, 401)
|
|
self.assertEqual(f.errcode, "M_MISSING_TOKEN")
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_user_by_req_appservice_valid_token_valid_user_id(self):
|
|
masquerading_user_id = b"@doppelganger:matrix.org"
|
|
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 = Mock(
|
|
return_value=defer.succeed({"is_guest": False})
|
|
)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.getClientIP.return_value = "127.0.0.1"
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.args[b"user_id"] = [masquerading_user_id]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
requester = yield defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
self.assertEquals(
|
|
requester.user.to_string(), masquerading_user_id.decode("utf8")
|
|
)
|
|
|
|
def test_get_user_by_req_appservice_valid_token_bad_user_id(self):
|
|
masquerading_user_id = b"@doppelganger:matrix.org"
|
|
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=False)
|
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
request = Mock(args={})
|
|
request.getClientIP.return_value = "127.0.0.1"
|
|
request.args[b"access_token"] = [self.test_token]
|
|
request.args[b"user_id"] = [masquerading_user_id]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
d = defer.ensureDeferred(self.auth.get_user_by_req(request))
|
|
self.failureResultOf(d, AuthError)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_user_from_macaroon(self):
|
|
self.store.get_user_by_access_token = Mock(
|
|
return_value=defer.succeed(
|
|
TokenLookupResult(user_id="@baldrick:matrix.org", device_id="device")
|
|
)
|
|
)
|
|
|
|
user_id = "@baldrick:matrix.org"
|
|
macaroon = pymacaroons.Macaroon(
|
|
location=self.hs.config.server_name,
|
|
identifier="key",
|
|
key=self.hs.config.macaroon_secret_key,
|
|
)
|
|
macaroon.add_first_party_caveat("gen = 1")
|
|
macaroon.add_first_party_caveat("type = access")
|
|
macaroon.add_first_party_caveat("user_id = %s" % (user_id,))
|
|
user_info = yield defer.ensureDeferred(
|
|
self.auth.get_user_by_access_token(macaroon.serialize())
|
|
)
|
|
self.assertEqual(user_id, user_info.user_id)
|
|
|
|
# TODO: device_id should come from the macaroon, but currently comes
|
|
# from the db.
|
|
self.assertEqual(user_info.device_id, "device")
|
|
|
|
@defer.inlineCallbacks
|
|
def test_get_guest_user_from_macaroon(self):
|
|
self.store.get_user_by_id = Mock(return_value=defer.succeed({"is_guest": True}))
|
|
self.store.get_user_by_access_token = Mock(return_value=defer.succeed(None))
|
|
|
|
user_id = "@baldrick:matrix.org"
|
|
macaroon = pymacaroons.Macaroon(
|
|
location=self.hs.config.server_name,
|
|
identifier="key",
|
|
key=self.hs.config.macaroon_secret_key,
|
|
)
|
|
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()
|
|
|
|
user_info = yield defer.ensureDeferred(
|
|
self.auth.get_user_by_access_token(serialized)
|
|
)
|
|
self.assertEqual(user_id, user_info.user_id)
|
|
self.assertTrue(user_info.is_guest)
|
|
self.store.get_user_by_id.assert_called_with(user_id)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_cannot_use_regular_token_as_guest(self):
|
|
USER_ID = "@percy:matrix.org"
|
|
self.store.add_access_token_to_user = Mock(return_value=defer.succeed(None))
|
|
self.store.get_device = Mock(return_value=defer.succeed(None))
|
|
|
|
token = yield defer.ensureDeferred(
|
|
self.hs.get_auth_handler().get_access_token_for_user_id(
|
|
USER_ID, "DEVICE", valid_until_ms=None
|
|
)
|
|
)
|
|
self.store.add_access_token_to_user.assert_called_with(
|
|
USER_ID, token, "DEVICE", None
|
|
)
|
|
|
|
def get_user(tok):
|
|
if token != tok:
|
|
return defer.succeed(None)
|
|
return defer.succeed(
|
|
TokenLookupResult(
|
|
user_id=USER_ID, is_guest=False, token_id=1234, device_id="DEVICE",
|
|
)
|
|
)
|
|
|
|
self.store.get_user_by_access_token = get_user
|
|
self.store.get_user_by_id = Mock(
|
|
return_value=defer.succeed({"is_guest": False})
|
|
)
|
|
|
|
# check the token works
|
|
request = Mock(args={})
|
|
request.args[b"access_token"] = [token.encode("ascii")]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
requester = yield defer.ensureDeferred(
|
|
self.auth.get_user_by_req(request, allow_guest=True)
|
|
)
|
|
self.assertEqual(UserID.from_string(USER_ID), requester.user)
|
|
self.assertFalse(requester.is_guest)
|
|
|
|
# add an is_guest caveat
|
|
mac = pymacaroons.Macaroon.deserialize(token)
|
|
mac.add_first_party_caveat("guest = true")
|
|
guest_tok = mac.serialize()
|
|
|
|
# the token should *not* work now
|
|
request = Mock(args={})
|
|
request.args[b"access_token"] = [guest_tok.encode("ascii")]
|
|
request.requestHeaders.getRawHeaders = mock_getRawHeaders()
|
|
|
|
with self.assertRaises(InvalidClientCredentialsError) as cm:
|
|
yield defer.ensureDeferred(
|
|
self.auth.get_user_by_req(request, allow_guest=True)
|
|
)
|
|
|
|
self.assertEqual(401, cm.exception.code)
|
|
self.assertEqual("Guest access token used for regular user", cm.exception.msg)
|
|
|
|
self.store.get_user_by_id.assert_called_with(USER_ID)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_blocking_mau(self):
|
|
self.auth_blocking._limit_usage_by_mau = False
|
|
self.auth_blocking._max_mau_value = 50
|
|
lots_of_users = 100
|
|
small_number_of_users = 1
|
|
|
|
# Ensure no error thrown
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
|
|
self.store.get_monthly_active_count = Mock(
|
|
return_value=defer.succeed(lots_of_users)
|
|
)
|
|
|
|
with self.assertRaises(ResourceLimitError) as e:
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
|
self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
self.assertEquals(e.exception.code, 403)
|
|
|
|
# Ensure does not throw an error
|
|
self.store.get_monthly_active_count = Mock(
|
|
return_value=defer.succeed(small_number_of_users)
|
|
)
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
|
|
@defer.inlineCallbacks
|
|
def test_blocking_mau__depending_on_user_type(self):
|
|
self.auth_blocking._max_mau_value = 50
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
|
|
self.store.get_monthly_active_count = Mock(return_value=defer.succeed(100))
|
|
# Support users allowed
|
|
yield defer.ensureDeferred(
|
|
self.auth.check_auth_blocking(user_type=UserTypes.SUPPORT)
|
|
)
|
|
self.store.get_monthly_active_count = Mock(return_value=defer.succeed(100))
|
|
# Bots not allowed
|
|
with self.assertRaises(ResourceLimitError):
|
|
yield defer.ensureDeferred(
|
|
self.auth.check_auth_blocking(user_type=UserTypes.BOT)
|
|
)
|
|
self.store.get_monthly_active_count = Mock(return_value=defer.succeed(100))
|
|
# Real users not allowed
|
|
with self.assertRaises(ResourceLimitError):
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
|
|
@defer.inlineCallbacks
|
|
def test_reserved_threepid(self):
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
self.auth_blocking._max_mau_value = 1
|
|
self.store.get_monthly_active_count = lambda: defer.succeed(2)
|
|
threepid = {"medium": "email", "address": "reserved@server.com"}
|
|
unknown_threepid = {"medium": "email", "address": "unreserved@server.com"}
|
|
self.auth_blocking._mau_limits_reserved_threepids = [threepid]
|
|
|
|
with self.assertRaises(ResourceLimitError):
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
|
|
with self.assertRaises(ResourceLimitError):
|
|
yield defer.ensureDeferred(
|
|
self.auth.check_auth_blocking(threepid=unknown_threepid)
|
|
)
|
|
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking(threepid=threepid))
|
|
|
|
@defer.inlineCallbacks
|
|
def test_hs_disabled(self):
|
|
self.auth_blocking._hs_disabled = True
|
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
|
with self.assertRaises(ResourceLimitError) as e:
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
|
self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
self.assertEquals(e.exception.code, 403)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_hs_disabled_no_server_notices_user(self):
|
|
"""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
|
|
self.auth_blocking._server_notices_mxid = None
|
|
|
|
self.auth_blocking._hs_disabled = True
|
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
|
with self.assertRaises(ResourceLimitError) as e:
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
|
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
|
self.assertEquals(e.exception.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
self.assertEquals(e.exception.code, 403)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_server_notices_mxid_special_cased(self):
|
|
self.auth_blocking._hs_disabled = True
|
|
user = "@user:server"
|
|
self.auth_blocking._server_notices_mxid = user
|
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
|
yield defer.ensureDeferred(self.auth.check_auth_blocking(user))
|