forked from MirrorHub/synapse
add new endpoint to update backup versions
This commit is contained in:
parent
664c81e8b7
commit
8248637173
3 changed files with 87 additions and 1 deletions
|
@ -19,7 +19,8 @@ from six import iteritems
|
||||||
|
|
||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
from synapse.api.errors import NotFoundError, RoomKeysVersionError, StoreError
|
from synapse.api.errors import Codes, NotFoundError, RoomKeysVersionError, \
|
||||||
|
StoreError, SynapseError
|
||||||
from synapse.util.async_helpers import Linearizer
|
from synapse.util.async_helpers import Linearizer
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -307,3 +308,34 @@ class E2eRoomKeysHandler(object):
|
||||||
raise NotFoundError("Unknown backup version")
|
raise NotFoundError("Unknown backup version")
|
||||||
else:
|
else:
|
||||||
raise
|
raise
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def update_version(self, user_id, version, version_info):
|
||||||
|
"""Update the info about a given version of the user's backup
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id(str): the user whose current backup version we're updating
|
||||||
|
version(str): the backup version we're updating
|
||||||
|
version_info(dict): the new information about the backup
|
||||||
|
Raises:
|
||||||
|
NotFoundError: if the requested backup version doesn't exist
|
||||||
|
Returns:
|
||||||
|
A deferred of an empty dict.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
old_info = yield self.store.get_e2e_room_keys_version_info(user_id, version)
|
||||||
|
except StoreError as e:
|
||||||
|
if e.code == 404:
|
||||||
|
raise NotFoundError("Unknown backup version")
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
if old_info["algorithm"] != version_info["algorithm"]:
|
||||||
|
raise SynapseError(
|
||||||
|
400,
|
||||||
|
"Algorithm does not match",
|
||||||
|
Codes.INVALID_PARAM
|
||||||
|
)
|
||||||
|
|
||||||
|
yield self.store.update_e2e_room_keys_version(user_id, version, version_info)
|
||||||
|
|
||||||
|
defer.returnValue({})
|
||||||
|
|
|
@ -380,6 +380,39 @@ class RoomKeysVersionServlet(RestServlet):
|
||||||
)
|
)
|
||||||
defer.returnValue((200, {}))
|
defer.returnValue((200, {}))
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def on_PUT(self, request, version):
|
||||||
|
"""
|
||||||
|
Update the information about a given version of the user's room_keys backup.
|
||||||
|
|
||||||
|
POST /room_keys/version/12345 HTTP/1.1
|
||||||
|
Content-Type: application/json
|
||||||
|
{
|
||||||
|
"algorithm": "m.megolm_backup.v1",
|
||||||
|
"auth_data": {
|
||||||
|
"public_key": "abcdefg",
|
||||||
|
"signatures": {
|
||||||
|
"ed25519:something": "hijklmnop"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
HTTP/1.1 200 OK
|
||||||
|
Content-Type: application/json
|
||||||
|
{}
|
||||||
|
"""
|
||||||
|
requester = yield self.auth.get_user_by_req(request, allow_guest=False)
|
||||||
|
user_id = requester.user.to_string()
|
||||||
|
info = parse_json_object_from_request(request)
|
||||||
|
|
||||||
|
if version is None:
|
||||||
|
raise SynapseError(400, "No version specified to update", Codes.MISSING_PARAM)
|
||||||
|
|
||||||
|
yield self.e2e_room_keys_handler.update_version(
|
||||||
|
user_id, version, info
|
||||||
|
)
|
||||||
|
defer.returnValue((200, {}))
|
||||||
|
|
||||||
|
|
||||||
def register_servlets(hs, http_server):
|
def register_servlets(hs, http_server):
|
||||||
RoomKeysServlet(hs).register(http_server)
|
RoomKeysServlet(hs).register(http_server)
|
||||||
|
|
|
@ -298,6 +298,27 @@ class EndToEndRoomKeyStore(SQLBaseStore):
|
||||||
"create_e2e_room_keys_version_txn", _create_e2e_room_keys_version_txn
|
"create_e2e_room_keys_version_txn", _create_e2e_room_keys_version_txn
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def update_e2e_room_keys_version(self, user_id, version, info):
|
||||||
|
"""Update a given backup version
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id(str): the user whose backup version we're updating
|
||||||
|
version(str): the version ID of the backup version we're updating
|
||||||
|
info(dict): the new backup version info to store
|
||||||
|
"""
|
||||||
|
|
||||||
|
return self._simple_update(
|
||||||
|
table="e2e_room_keys_versions",
|
||||||
|
keyvalues={
|
||||||
|
"user_id": user_id,
|
||||||
|
"version": version,
|
||||||
|
},
|
||||||
|
updatevalues={
|
||||||
|
"auth_data": json.dumps(info["auth_data"]),
|
||||||
|
},
|
||||||
|
desc="update_e2e_room_keys_version"
|
||||||
|
)
|
||||||
|
|
||||||
def delete_e2e_room_keys_version(self, user_id, version=None):
|
def delete_e2e_room_keys_version(self, user_id, version=None):
|
||||||
"""Delete a given backup version of the user's room keys.
|
"""Delete a given backup version of the user's room keys.
|
||||||
Doesn't delete their actual key data.
|
Doesn't delete their actual key data.
|
||||||
|
|
Loading…
Reference in a new issue