forked from MirrorHub/synapse
Modify auth.get_user_by_req for authing appservices directly.
Add logic to map the appservice token to the autogenned appservice user ID. Add unit tests for all forms of get_user_by_req (user/appservice, valid/bad/missing tokens)
This commit is contained in:
parent
ac3183caaa
commit
5a7dd05818
5 changed files with 164 additions and 20 deletions
|
@ -302,27 +302,26 @@ class Auth(object):
|
||||||
|
|
||||||
# Check for application service tokens with a user_id override
|
# Check for application service tokens with a user_id override
|
||||||
try:
|
try:
|
||||||
if "user_id" not in request.args:
|
|
||||||
# This has to be done like this rather than relying on it
|
|
||||||
# natively throwing because tests use a Mock for the request
|
|
||||||
# object which doesn't throw :/
|
|
||||||
raise KeyError
|
|
||||||
|
|
||||||
masquerade_user_id = request.args["user_id"][0]
|
|
||||||
app_service = yield self.store.get_app_service_by_token(
|
app_service = yield self.store.get_app_service_by_token(
|
||||||
access_token
|
access_token
|
||||||
)
|
)
|
||||||
if not app_service:
|
if not app_service:
|
||||||
raise AuthError(
|
raise KeyError
|
||||||
403, "Invalid application service access token"
|
|
||||||
)
|
user_id = app_service.sender
|
||||||
if not app_service.is_interested_in_user(masquerade_user_id):
|
if "user_id" in request.args:
|
||||||
|
user_id = request.args["user_id"][0]
|
||||||
|
if not app_service.is_interested_in_user(user_id):
|
||||||
raise AuthError(
|
raise AuthError(
|
||||||
403,
|
403,
|
||||||
"Application service cannot masquerade as this user."
|
"Application service cannot masquerade as this user."
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if not user_id:
|
||||||
|
raise KeyError
|
||||||
|
|
||||||
defer.returnValue(
|
defer.returnValue(
|
||||||
(UserID.from_string(masquerade_user_id), ClientInfo("", ""))
|
(UserID.from_string(user_id), ClientInfo("", ""))
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
except KeyError:
|
except KeyError:
|
||||||
|
@ -366,8 +365,7 @@ class Auth(object):
|
||||||
try:
|
try:
|
||||||
ret = yield self.store.get_user_by_token(token=token)
|
ret = yield self.store.get_user_by_token(token=token)
|
||||||
if not ret:
|
if not ret:
|
||||||
raise StoreError()
|
raise StoreError(400, "Unknown token")
|
||||||
|
|
||||||
user_info = {
|
user_info = {
|
||||||
"admin": bool(ret.get("admin", False)),
|
"admin": bool(ret.get("admin", False)),
|
||||||
"device_id": ret.get("device_id"),
|
"device_id": ret.get("device_id"),
|
||||||
|
|
|
@ -215,6 +215,7 @@ class ApplicationServiceStore(SQLBaseStore):
|
||||||
"url": res["url"],
|
"url": res["url"],
|
||||||
"token": as_token,
|
"token": as_token,
|
||||||
"hs_token": res["hs_token"],
|
"hs_token": res["hs_token"],
|
||||||
|
"sender": res["sender"],
|
||||||
"namespaces": {
|
"namespaces": {
|
||||||
ApplicationService.NS_USERS: [],
|
ApplicationService.NS_USERS: [],
|
||||||
ApplicationService.NS_ALIASES: [],
|
ApplicationService.NS_ALIASES: [],
|
||||||
|
@ -240,6 +241,7 @@ class ApplicationServiceStore(SQLBaseStore):
|
||||||
token=service["token"],
|
token=service["token"],
|
||||||
url=service["url"],
|
url=service["url"],
|
||||||
namespaces=service["namespaces"],
|
namespaces=service["namespaces"],
|
||||||
hs_token=service["hs_token"]
|
hs_token=service["hs_token"],
|
||||||
|
sender=service["sender"]
|
||||||
))
|
))
|
||||||
|
|
||||||
|
|
139
tests/api/test_auth.py
Normal file
139
tests/api/test_auth.py
Normal file
|
@ -0,0 +1,139 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# Copyright 2015 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 tests import unittest
|
||||||
|
from twisted.internet import defer
|
||||||
|
|
||||||
|
from mock import Mock, NonCallableMock
|
||||||
|
|
||||||
|
from synapse.api.auth import Auth
|
||||||
|
from synapse.api.errors import AuthError
|
||||||
|
from synapse.types import UserID
|
||||||
|
|
||||||
|
class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.state_handler = Mock()
|
||||||
|
self.store = Mock()
|
||||||
|
|
||||||
|
self.hs = Mock()
|
||||||
|
self.hs.get_datastore = Mock(return_value=self.store)
|
||||||
|
self.hs.get_state_handler = Mock(return_value=self.state_handler)
|
||||||
|
self.auth = Auth(self.hs)
|
||||||
|
|
||||||
|
self.test_user = "@foo:bar"
|
||||||
|
self.test_token = "_test_token_"
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_get_user_by_req_user_valid_token(self):
|
||||||
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
user_info = {
|
||||||
|
"name": self.test_user,
|
||||||
|
"device_id": "nothing",
|
||||||
|
"token_id": "ditto",
|
||||||
|
"admin": False
|
||||||
|
}
|
||||||
|
self.store.get_user_by_token = Mock(return_value=user_info)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.args["access_token"] = [self.test_token]
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
(user, info) = yield self.auth.get_user_by_req(request)
|
||||||
|
self.assertEquals(user.to_string(), self.test_user)
|
||||||
|
|
||||||
|
def test_get_user_by_req_user_bad_token(self):
|
||||||
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
self.store.get_user_by_token = Mock(return_value=None)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.args["access_token"] = [self.test_token]
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
d = self.auth.get_user_by_req(request)
|
||||||
|
self.failureResultOf(d, AuthError)
|
||||||
|
|
||||||
|
def test_get_user_by_req_user_missing_token(self):
|
||||||
|
self.store.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
user_info = {
|
||||||
|
"name": self.test_user,
|
||||||
|
"device_id": "nothing",
|
||||||
|
"token_id": "ditto",
|
||||||
|
"admin": False
|
||||||
|
}
|
||||||
|
self.store.get_user_by_token = Mock(return_value=user_info)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
d = self.auth.get_user_by_req(request)
|
||||||
|
self.failureResultOf(d, AuthError)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_get_user_by_req_appservice_valid_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_token = Mock(return_value=None)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.args["access_token"] = [self.test_token]
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
(user, info) = yield self.auth.get_user_by_req(request)
|
||||||
|
self.assertEquals(user.to_string(), self.test_user)
|
||||||
|
|
||||||
|
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_token = Mock(return_value=None)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.args["access_token"] = [self.test_token]
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
d = self.auth.get_user_by_req(request)
|
||||||
|
self.failureResultOf(d, AuthError)
|
||||||
|
|
||||||
|
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_token = Mock(return_value=None)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
d = self.auth.get_user_by_req(request)
|
||||||
|
self.failureResultOf(d, AuthError)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_get_user_by_req_appservice_valid_token_valid_user_id(self):
|
||||||
|
masquerading_user_id = "@doppelganger:matrix.org"
|
||||||
|
app_service = Mock(token="foobar", url="a_url", sender=self.test_user)
|
||||||
|
app_service.is_interested_in_user = Mock(return_value=True)
|
||||||
|
self.store.get_app_service_by_token = Mock(return_value=app_service)
|
||||||
|
self.store.get_user_by_token = Mock(return_value=None)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.args["access_token"] = [self.test_token]
|
||||||
|
request.args["user_id"] = [masquerading_user_id]
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
(user, info) = yield self.auth.get_user_by_req(request)
|
||||||
|
self.assertEquals(user.to_string(), masquerading_user_id)
|
||||||
|
|
||||||
|
def test_get_user_by_req_appservice_valid_token_bad_user_id(self):
|
||||||
|
masquerading_user_id = "@doppelganger:matrix.org"
|
||||||
|
app_service = Mock(token="foobar", url="a_url", sender=self.test_user)
|
||||||
|
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_token = Mock(return_value=None)
|
||||||
|
|
||||||
|
request = Mock(args={})
|
||||||
|
request.args["access_token"] = [self.test_token]
|
||||||
|
request.args["user_id"] = [masquerading_user_id]
|
||||||
|
request.requestHeaders.getRawHeaders = Mock(return_value=[""])
|
||||||
|
d = self.auth.get_user_by_req(request)
|
||||||
|
self.failureResultOf(d, AuthError)
|
|
@ -65,6 +65,7 @@ class PresenceStateTestCase(unittest.TestCase):
|
||||||
hs.handlers = JustPresenceHandlers(hs)
|
hs.handlers = JustPresenceHandlers(hs)
|
||||||
|
|
||||||
self.datastore = hs.get_datastore()
|
self.datastore = hs.get_datastore()
|
||||||
|
self.datastore.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
|
||||||
def get_presence_list(*a, **kw):
|
def get_presence_list(*a, **kw):
|
||||||
return defer.succeed([])
|
return defer.succeed([])
|
||||||
|
@ -154,6 +155,7 @@ class PresenceListTestCase(unittest.TestCase):
|
||||||
hs.handlers = JustPresenceHandlers(hs)
|
hs.handlers = JustPresenceHandlers(hs)
|
||||||
|
|
||||||
self.datastore = hs.get_datastore()
|
self.datastore = hs.get_datastore()
|
||||||
|
self.datastore.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
|
||||||
def has_presence_state(user_localpart):
|
def has_presence_state(user_localpart):
|
||||||
return defer.succeed(
|
return defer.succeed(
|
||||||
|
@ -303,6 +305,7 @@ class PresenceEventStreamTestCase(unittest.TestCase):
|
||||||
hs.handlers.room_member_handler.get_rooms_for_user = get_rooms_for_user
|
hs.handlers.room_member_handler.get_rooms_for_user = get_rooms_for_user
|
||||||
|
|
||||||
self.mock_datastore = hs.get_datastore()
|
self.mock_datastore = hs.get_datastore()
|
||||||
|
self.mock_datastore.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
|
||||||
def get_profile_displayname(user_id):
|
def get_profile_displayname(user_id):
|
||||||
return defer.succeed("Frank")
|
return defer.succeed("Frank")
|
||||||
|
|
|
@ -59,6 +59,8 @@ class V2AlphaRestTestCase(unittest.TestCase):
|
||||||
r.register_servlets(hs, self.mock_resource)
|
r.register_servlets(hs, self.mock_resource)
|
||||||
|
|
||||||
def make_datastore_mock(self):
|
def make_datastore_mock(self):
|
||||||
return Mock(spec=[
|
store = Mock(spec=[
|
||||||
"insert_client_ip",
|
"insert_client_ip",
|
||||||
])
|
])
|
||||||
|
store.get_app_service_by_token = Mock(return_value=None)
|
||||||
|
return store
|
||||||
|
|
Loading…
Reference in a new issue