anonymousland-synapse/tests/handlers/test_e2e_room_keys.py

640 lines
21 KiB
Python
Raw Normal View History

2017-12-31 09:11:15 -05:00
# -*- coding: utf-8 -*-
# Copyright 2016 OpenMarket Ltd
# Copyright 2017 New Vector Ltd
# Copyright 2019 Matrix.org Foundation C.I.C.
2017-12-31 09:11:15 -05: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.
2018-09-06 11:23:16 -04:00
import copy
2017-12-31 09:11:15 -05:00
import mock
2018-09-06 11:23:16 -04:00
2017-12-31 09:11:15 -05:00
from twisted.internet import defer
import synapse.api.errors
import synapse.handlers.e2e_room_keys
import synapse.storage
2018-09-06 11:23:16 -04:00
from synapse.api import errors
2017-12-31 09:11:15 -05:00
2018-09-06 11:23:16 -04:00
from tests import unittest, utils
2017-12-31 09:11:15 -05:00
# sample room_key data for use in the tests
room_keys = {
"rooms": {
"!abc:matrix.org": {
"sessions": {
"c0ff33": {
"first_message_index": 1,
"forwarded_count": 1,
"is_verified": False,
2019-05-10 01:12:11 -04:00
"session_data": "SSBBTSBBIEZJU0gK",
}
}
}
}
}
2017-12-31 12:50:55 -05:00
2017-12-31 09:11:15 -05:00
class E2eRoomKeysHandlerTestCase(unittest.TestCase):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
2019-05-10 01:12:11 -04:00
self.hs = None # type: synapse.server.HomeServer
2017-12-31 09:11:15 -05:00
self.handler = None # type: synapse.handlers.e2e_keys.E2eRoomKeysHandler
@defer.inlineCallbacks
def setUp(self):
self.hs = yield utils.setup_test_homeserver(
2019-05-10 01:12:11 -04:00
self.addCleanup, handlers=None, replication_layer=mock.Mock()
2017-12-31 09:11:15 -05:00
)
2017-12-31 09:35:25 -05:00
self.handler = synapse.handlers.e2e_room_keys.E2eRoomKeysHandler(self.hs)
2017-12-31 12:50:55 -05:00
self.local_user = "@boris:" + self.hs.hostname
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_get_missing_current_version_info(self):
"""Check that we get a 404 if we ask for info about the current version
if there is no version.
"""
2017-12-31 09:35:25 -05:00
res = None
2017-12-31 09:11:15 -05:00
try:
yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
2017-12-31 09:11:15 -05:00
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_get_missing_version_info(self):
"""Check that we get a 404 if we ask for info about a specific version
if it doesn't exist.
"""
2017-12-31 09:35:25 -05:00
res = None
2017-12-31 09:11:15 -05:00
try:
yield defer.ensureDeferred(
self.handler.get_version_info(self.local_user, "bogus_version")
)
2017-12-31 09:11:15 -05:00
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_create_version(self):
"""Check that we can create and then retrieve versions.
"""
res = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
2017-12-31 09:42:10 -05:00
self.assertEqual(res, "1")
2017-12-31 09:11:15 -05:00
# check we can retrieve it as the current version
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
version_etag = res["etag"]
self.assertIsInstance(version_etag, str)
del res["etag"]
2019-05-10 01:12:11 -04:00
self.assertDictEqual(
res,
{
"version": "1",
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
"count": 0,
2019-05-10 01:12:11 -04:00
},
)
2017-12-31 09:11:15 -05:00
# check we can retrieve it as a specific version
res = yield defer.ensureDeferred(
self.handler.get_version_info(self.local_user, "1")
)
self.assertEqual(res["etag"], version_etag)
del res["etag"]
2019-05-10 01:12:11 -04:00
self.assertDictEqual(
res,
{
"version": "1",
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
"count": 0,
2019-05-10 01:12:11 -04:00
},
)
2017-12-31 09:11:15 -05:00
# upload a new one...
res = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "second_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
2017-12-31 09:42:10 -05:00
self.assertEqual(res, "2")
2017-12-31 09:11:15 -05:00
# check we can retrieve it as the current version
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
del res["etag"]
2019-05-10 01:12:11 -04:00
self.assertDictEqual(
res,
{
"version": "2",
"algorithm": "m.megolm_backup.v1",
"auth_data": "second_version_auth_data",
"count": 0,
2019-05-10 01:12:11 -04:00
},
)
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_update_version(self):
"""Check that we can update versions.
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
res = yield defer.ensureDeferred(
self.handler.update_version(
self.local_user,
version,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "revised_first_version_auth_data",
"version": version,
},
)
2019-05-10 01:12:11 -04:00
)
self.assertDictEqual(res, {})
# check we can retrieve it as the current version
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
del res["etag"]
2019-05-10 01:12:11 -04:00
self.assertDictEqual(
res,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "revised_first_version_auth_data",
"version": version,
"count": 0,
2019-05-10 01:12:11 -04:00
},
)
@defer.inlineCallbacks
def test_update_missing_version(self):
"""Check that we get a 404 on updating nonexistent versions
"""
res = None
try:
yield defer.ensureDeferred(
self.handler.update_version(
self.local_user,
"1",
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "revised_first_version_auth_data",
"version": "1",
},
)
2019-05-10 01:12:11 -04:00
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
@defer.inlineCallbacks
2019-10-10 08:54:07 -04:00
def test_update_omitted_version(self):
"""Check that the update succeeds if the version is missing from the body
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
yield defer.ensureDeferred(
self.handler.update_version(
self.local_user,
version,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "revised_first_version_auth_data",
},
)
)
# check we can retrieve it as the current version
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
del res["etag"] # etag is opaque, so don't test its contents
self.assertDictEqual(
res,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "revised_first_version_auth_data",
"version": version,
"count": 0,
},
)
@defer.inlineCallbacks
def test_update_bad_version(self):
"""Check that we get a 400 if the version in the body doesn't match
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
)
self.assertEqual(version, "1")
res = None
try:
yield defer.ensureDeferred(
self.handler.update_version(
self.local_user,
version,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "revised_first_version_auth_data",
"version": "incorrect",
},
)
2019-05-10 01:12:11 -04:00
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 400)
@defer.inlineCallbacks
def test_delete_missing_version(self):
"""Check that we get a 404 on deleting nonexistent versions
"""
res = None
try:
yield defer.ensureDeferred(
self.handler.delete_version(self.local_user, "1")
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
@defer.inlineCallbacks
def test_delete_missing_current_version(self):
"""Check that we get a 404 on deleting nonexistent current version
"""
res = None
try:
yield defer.ensureDeferred(self.handler.delete_version(self.local_user))
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_delete_version(self):
"""Check that we can create and then delete versions.
"""
res = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
2017-12-31 09:42:10 -05:00
self.assertEqual(res, "1")
2017-12-31 09:11:15 -05:00
# check we can delete it
yield defer.ensureDeferred(self.handler.delete_version(self.local_user, "1"))
2017-12-31 09:11:15 -05:00
# check that it's gone
2017-12-31 09:42:10 -05:00
res = None
2017-12-31 09:11:15 -05:00
try:
yield defer.ensureDeferred(
self.handler.get_version_info(self.local_user, "1")
)
2017-12-31 09:11:15 -05:00
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_get_missing_backup(self):
"""Check that we get a 404 on querying missing backup
"""
res = None
try:
yield defer.ensureDeferred(
self.handler.get_room_keys(self.local_user, "bogus_version")
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
@defer.inlineCallbacks
def test_get_missing_room_keys(self):
"""Check we get an empty response from an empty backup
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
res = yield defer.ensureDeferred(
self.handler.get_room_keys(self.local_user, version)
)
2019-05-10 01:12:11 -04:00
self.assertDictEqual(res, {"rooms": {}})
# TODO: test the locking semantics when uploading room_keys,
# although this is probably best done in sytest
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_upload_room_keys_no_versions(self):
"""Check that we get a 404 on uploading keys when no versions are defined
"""
res = None
try:
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, "no_version", room_keys)
2019-05-10 01:12:11 -04:00
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
@defer.inlineCallbacks
def test_upload_room_keys_bogus_version(self):
2017-12-31 12:50:55 -05:00
"""Check that we get a 404 on uploading keys when an nonexistent version
is specified
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
res = None
try:
yield defer.ensureDeferred(
self.handler.upload_room_keys(
self.local_user, "bogus_version", room_keys
)
2017-12-31 12:50:55 -05:00
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 404)
@defer.inlineCallbacks
def test_upload_room_keys_wrong_version(self):
"""Check that we get a 403 on uploading keys for an old version
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "second_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "2")
res = None
try:
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, "1", room_keys)
)
except errors.SynapseError as e:
res = e.code
self.assertEqual(res, 403)
@defer.inlineCallbacks
def test_upload_room_keys_insert(self):
"""Check that we can insert and retrieve keys for a session
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, room_keys)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(self.local_user, version)
)
self.assertDictEqual(res, room_keys)
# check getting room_keys for a given room
res = yield defer.ensureDeferred(
self.handler.get_room_keys(
self.local_user, version, room_id="!abc:matrix.org"
)
)
self.assertDictEqual(res, room_keys)
# check getting room_keys for a given session_id
res = yield defer.ensureDeferred(
self.handler.get_room_keys(
self.local_user, version, room_id="!abc:matrix.org", session_id="c0ff33"
)
)
self.assertDictEqual(res, room_keys)
@defer.inlineCallbacks
def test_upload_room_keys_merge(self):
"""Check that we can upload a new room_key for an existing session and
have it correctly merged"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, room_keys)
)
# get the etag to compare to future versions
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
backup_etag = res["etag"]
self.assertEqual(res["count"], 1)
new_room_keys = copy.deepcopy(room_keys)
2019-06-20 05:32:02 -04:00
new_room_key = new_room_keys["rooms"]["!abc:matrix.org"]["sessions"]["c0ff33"]
# test that increasing the message_index doesn't replace the existing session
2019-06-20 05:32:02 -04:00
new_room_key["first_message_index"] = 2
new_room_key["session_data"] = "new"
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, new_room_keys)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(self.local_user, version)
)
self.assertEqual(
2019-06-20 05:32:02 -04:00
res["rooms"]["!abc:matrix.org"]["sessions"]["c0ff33"]["session_data"],
2019-05-10 01:12:11 -04:00
"SSBBTSBBIEZJU0gK",
)
# the etag should be the same since the session did not change
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
self.assertEqual(res["etag"], backup_etag)
# test that marking the session as verified however /does/ replace it
2019-06-20 05:32:02 -04:00
new_room_key["is_verified"] = True
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, new_room_keys)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(self.local_user, version)
)
self.assertEqual(
2019-06-20 05:32:02 -04:00
res["rooms"]["!abc:matrix.org"]["sessions"]["c0ff33"]["session_data"], "new"
)
# the etag should NOT be equal now, since the key changed
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
self.assertNotEqual(res["etag"], backup_etag)
backup_etag = res["etag"]
# test that a session with a higher forwarded_count doesn't replace one
# with a lower forwarding count
2019-06-20 05:32:02 -04:00
new_room_key["forwarded_count"] = 2
new_room_key["session_data"] = "other"
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, new_room_keys)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(self.local_user, version)
)
self.assertEqual(
2019-06-20 05:32:02 -04:00
res["rooms"]["!abc:matrix.org"]["sessions"]["c0ff33"]["session_data"], "new"
)
# the etag should be the same since the session did not change
res = yield defer.ensureDeferred(self.handler.get_version_info(self.local_user))
self.assertEqual(res["etag"], backup_etag)
# TODO: check edge cases as well as the common variations here
2017-12-31 09:11:15 -05:00
@defer.inlineCallbacks
def test_delete_room_keys(self):
"""Check that we can insert and delete keys for a session
"""
version = yield defer.ensureDeferred(
self.handler.create_version(
self.local_user,
{
"algorithm": "m.megolm_backup.v1",
"auth_data": "first_version_auth_data",
},
)
2019-05-10 01:12:11 -04:00
)
self.assertEqual(version, "1")
# check for bulk-delete
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, room_keys)
)
yield defer.ensureDeferred(
self.handler.delete_room_keys(self.local_user, version)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(
self.local_user, version, room_id="!abc:matrix.org", session_id="c0ff33"
)
)
2019-05-10 01:12:11 -04:00
self.assertDictEqual(res, {"rooms": {}})
# check for bulk-delete per room
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, room_keys)
)
yield defer.ensureDeferred(
self.handler.delete_room_keys(
self.local_user, version, room_id="!abc:matrix.org"
)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(
self.local_user, version, room_id="!abc:matrix.org", session_id="c0ff33"
)
)
2019-05-10 01:12:11 -04:00
self.assertDictEqual(res, {"rooms": {}})
# check for bulk-delete per session
yield defer.ensureDeferred(
self.handler.upload_room_keys(self.local_user, version, room_keys)
)
yield defer.ensureDeferred(
self.handler.delete_room_keys(
self.local_user, version, room_id="!abc:matrix.org", session_id="c0ff33"
)
)
res = yield defer.ensureDeferred(
self.handler.get_room_keys(
self.local_user, version, room_id="!abc:matrix.org", session_id="c0ff33"
)
)
2019-05-10 01:12:11 -04:00
self.assertDictEqual(res, {"rooms": {}})