219 lines
7.8 KiB
Python
219 lines
7.8 KiB
Python
# Copyright 2022 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.
|
|
from typing import Any, List, Mapping, Sequence, Union
|
|
from unittest.mock import Mock
|
|
|
|
from twisted.test.proto_helpers import MemoryReactor
|
|
|
|
from synapse.api.errors import HttpResponseException
|
|
from synapse.appservice import ApplicationService
|
|
from synapse.server import HomeServer
|
|
from synapse.types import JsonDict
|
|
from synapse.util import Clock
|
|
|
|
from tests import unittest
|
|
|
|
PROTOCOL = "myproto"
|
|
TOKEN = "myastoken"
|
|
URL = "http://mytestservice"
|
|
|
|
|
|
class ApplicationServiceApiTestCase(unittest.HomeserverTestCase):
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
self.api = hs.get_application_service_api()
|
|
self.service = ApplicationService(
|
|
id="unique_identifier",
|
|
sender="@as:test",
|
|
url=URL,
|
|
token="unused",
|
|
hs_token=TOKEN,
|
|
)
|
|
|
|
def test_query_3pe_authenticates_token(self) -> None:
|
|
"""
|
|
Tests that 3pe queries to the appservice are authenticated
|
|
with the appservice's token.
|
|
"""
|
|
|
|
SUCCESS_RESULT_USER = [
|
|
{
|
|
"protocol": PROTOCOL,
|
|
"userid": "@a:user",
|
|
"fields": {
|
|
"more": "fields",
|
|
},
|
|
}
|
|
]
|
|
SUCCESS_RESULT_LOCATION = [
|
|
{
|
|
"protocol": PROTOCOL,
|
|
"alias": "#a:room",
|
|
"fields": {
|
|
"more": "fields",
|
|
},
|
|
}
|
|
]
|
|
|
|
URL_USER = f"{URL}/_matrix/app/v1/thirdparty/user/{PROTOCOL}"
|
|
URL_LOCATION = f"{URL}/_matrix/app/v1/thirdparty/location/{PROTOCOL}"
|
|
|
|
self.request_url = None
|
|
|
|
async def get_json(
|
|
url: str,
|
|
args: Mapping[Any, Any],
|
|
headers: Mapping[Union[str, bytes], Sequence[Union[str, bytes]]],
|
|
) -> List[JsonDict]:
|
|
# Ensure the access token is passed as both a header and query arg.
|
|
if not headers.get("Authorization") or not args.get(b"access_token"):
|
|
raise RuntimeError("Access token not provided")
|
|
|
|
self.assertEqual(headers.get("Authorization"), [f"Bearer {TOKEN}"])
|
|
self.assertEqual(args.get(b"access_token"), TOKEN)
|
|
self.request_url = url
|
|
if url == URL_USER:
|
|
return SUCCESS_RESULT_USER
|
|
elif url == URL_LOCATION:
|
|
return SUCCESS_RESULT_LOCATION
|
|
else:
|
|
raise RuntimeError(
|
|
"URL provided was invalid. This should never be seen."
|
|
)
|
|
|
|
# We assign to a method, which mypy doesn't like.
|
|
self.api.get_json = Mock(side_effect=get_json) # type: ignore[assignment]
|
|
|
|
result = self.get_success(
|
|
self.api.query_3pe(self.service, "user", PROTOCOL, {b"some": [b"field"]})
|
|
)
|
|
self.assertEqual(self.request_url, URL_USER)
|
|
self.assertEqual(result, SUCCESS_RESULT_USER)
|
|
result = self.get_success(
|
|
self.api.query_3pe(
|
|
self.service, "location", PROTOCOL, {b"some": [b"field"]}
|
|
)
|
|
)
|
|
self.assertEqual(self.request_url, URL_LOCATION)
|
|
self.assertEqual(result, SUCCESS_RESULT_LOCATION)
|
|
|
|
def test_fallback(self) -> None:
|
|
"""
|
|
Tests that the fallback to legacy URLs works.
|
|
"""
|
|
SUCCESS_RESULT_USER = [
|
|
{
|
|
"protocol": PROTOCOL,
|
|
"userid": "@a:user",
|
|
"fields": {
|
|
"more": "fields",
|
|
},
|
|
}
|
|
]
|
|
|
|
URL_USER = f"{URL}/_matrix/app/v1/thirdparty/user/{PROTOCOL}"
|
|
FALLBACK_URL_USER = f"{URL}/_matrix/app/unstable/thirdparty/user/{PROTOCOL}"
|
|
|
|
self.request_url = None
|
|
self.v1_seen = False
|
|
|
|
async def get_json(
|
|
url: str,
|
|
args: Mapping[Any, Any],
|
|
headers: Mapping[Union[str, bytes], Sequence[Union[str, bytes]]],
|
|
) -> List[JsonDict]:
|
|
# Ensure the access token is passed as both a header and query arg.
|
|
if not headers.get("Authorization") or not args.get(b"access_token"):
|
|
raise RuntimeError("Access token not provided")
|
|
|
|
self.assertEqual(headers.get("Authorization"), [f"Bearer {TOKEN}"])
|
|
self.assertEqual(args.get(b"access_token"), TOKEN)
|
|
self.request_url = url
|
|
if url == URL_USER:
|
|
self.v1_seen = True
|
|
raise HttpResponseException(404, "NOT_FOUND", b"NOT_FOUND")
|
|
elif url == FALLBACK_URL_USER:
|
|
return SUCCESS_RESULT_USER
|
|
else:
|
|
raise RuntimeError(
|
|
"URL provided was invalid. This should never be seen."
|
|
)
|
|
|
|
# We assign to a method, which mypy doesn't like.
|
|
self.api.get_json = Mock(side_effect=get_json) # type: ignore[assignment]
|
|
|
|
result = self.get_success(
|
|
self.api.query_3pe(self.service, "user", PROTOCOL, {b"some": [b"field"]})
|
|
)
|
|
self.assertTrue(self.v1_seen)
|
|
self.assertEqual(self.request_url, FALLBACK_URL_USER)
|
|
self.assertEqual(result, SUCCESS_RESULT_USER)
|
|
|
|
def test_claim_keys(self) -> None:
|
|
"""
|
|
Tests that the /keys/claim response is properly parsed for missing
|
|
keys.
|
|
"""
|
|
|
|
RESPONSE: JsonDict = {
|
|
"@alice:example.org": {
|
|
"DEVICE_1": {
|
|
"signed_curve25519:AAAAHg": {
|
|
# We don't really care about the content of the keys,
|
|
# they get passed back transparently.
|
|
},
|
|
"signed_curve25519:BBBBHg": {},
|
|
},
|
|
"DEVICE_2": {"signed_curve25519:CCCCHg": {}},
|
|
},
|
|
}
|
|
|
|
async def post_json_get_json(
|
|
uri: str,
|
|
post_json: Any,
|
|
headers: Mapping[Union[str, bytes], Sequence[Union[str, bytes]]],
|
|
) -> JsonDict:
|
|
# Ensure the access token is passed as both a header and query arg.
|
|
if not headers.get("Authorization"):
|
|
raise RuntimeError("Access token not provided")
|
|
|
|
self.assertEqual(headers.get("Authorization"), [f"Bearer {TOKEN}"])
|
|
return RESPONSE
|
|
|
|
# We assign to a method, which mypy doesn't like.
|
|
self.api.post_json_get_json = Mock(side_effect=post_json_get_json) # type: ignore[assignment]
|
|
|
|
MISSING_KEYS = [
|
|
# Known user, known device, missing algorithm.
|
|
("@alice:example.org", "DEVICE_2", "xyz", 1),
|
|
# Known user, missing device.
|
|
("@alice:example.org", "DEVICE_3", "signed_curve25519", 1),
|
|
# Unknown user.
|
|
("@bob:example.org", "DEVICE_4", "signed_curve25519", 1),
|
|
]
|
|
|
|
claimed_keys, missing = self.get_success(
|
|
self.api.claim_client_keys(
|
|
self.service,
|
|
[
|
|
# Found devices
|
|
("@alice:example.org", "DEVICE_1", "signed_curve25519", 1),
|
|
("@alice:example.org", "DEVICE_2", "signed_curve25519", 1),
|
|
]
|
|
+ MISSING_KEYS,
|
|
)
|
|
)
|
|
|
|
self.assertEqual(claimed_keys, RESPONSE)
|
|
self.assertEqual(missing, MISSING_KEYS)
|