synapse-product/synapse/rest/client/keys.py

349 lines
11 KiB
Python
Raw Normal View History

2016-01-06 23:26:29 -05:00
# Copyright 2015, 2016 OpenMarket Ltd
2019-07-25 11:08:24 -04:00
# Copyright 2019 New Vector Ltd
# Copyright 2020 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.
import logging
from typing import TYPE_CHECKING, Any, Optional, Tuple
from synapse.api.errors import InvalidAPICallError, SynapseError
from synapse.http.server import HttpServer
from synapse.http.servlet import (
2018-07-09 02:09:20 -04:00
RestServlet,
parse_integer,
parse_json_object_from_request,
parse_string,
)
from synapse.http.site import SynapseRequest
from synapse.logging.opentracing import log_kv, set_tag
from synapse.rest.client._base import client_patterns, interactive_auth_handler
from synapse.types import JsonDict, StreamToken
from synapse.util.cancellation import cancellable
if TYPE_CHECKING:
from synapse.server import HomeServer
logger = logging.getLogger(__name__)
class KeyUploadServlet(RestServlet):
"""
POST /keys/upload HTTP/1.1
Content-Type: application/json
{
"device_keys": {
"user_id": "<user_id>",
"device_id": "<device_id>",
"valid_until_ts": <millisecond_timestamp>,
"algorithms": [
"m.olm.curve25519-aes-sha2",
]
"keys": {
"<algorithm>:<device_id>": "<key_base64>",
},
"signatures:" {
"<user_id>" {
"<algorithm>:<device_id>": "<signature_base64>"
} } },
"one_time_keys": {
"<algorithm>:<key_id>": "<key_base64>"
},
}
"""
2019-06-20 05:32:02 -04:00
PATTERNS = client_patterns("/keys/upload(/(?P<device_id>[^/]+))?$")
def __init__(self, hs: "HomeServer"):
super().__init__()
self.auth = hs.get_auth()
self.e2e_keys_handler = hs.get_e2e_keys_handler()
self.device_handler = hs.get_device_handler()
async def on_POST(
self, request: SynapseRequest, device_id: Optional[str]
) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
requester = await self.auth.get_user_by_req(request, allow_guest=True)
user_id = requester.user.to_string()
body = parse_json_object_from_request(request)
if device_id is not None:
# Providing the device_id should only be done for setting keys
# for dehydrated devices; however, we allow it for any device for
# compatibility with older clients.
2019-06-20 05:32:02 -04:00
if requester.device_id is not None and device_id != requester.device_id:
dehydrated_device = await self.device_handler.get_dehydrated_device(
user_id
2019-06-20 05:32:02 -04:00
)
if dehydrated_device is not None and device_id != dehydrated_device[0]:
set_tag("error", True)
log_kv(
{
"message": "Client uploading keys for a different device",
"logged_in_id": requester.device_id,
"key_being_uploaded": device_id,
}
)
logger.warning(
"Client uploading keys for a different device "
"(logged in as %s, uploading for %s)",
requester.device_id,
device_id,
)
else:
device_id = requester.device_id
if device_id is None:
raise SynapseError(
2019-06-20 05:32:02 -04:00
400, "To upload keys, you must pass device_id when authenticating"
)
2019-12-05 11:46:37 -05:00
result = await self.e2e_keys_handler.upload_keys_for_user(
user_id, device_id, body
)
return 200, result
class KeyQueryServlet(RestServlet):
"""
POST /keys/query HTTP/1.1
Content-Type: application/json
{
"device_keys": {
"<user_id>": ["<device_id>"]
} }
HTTP/1.1 200 OK
{
"device_keys": {
"<user_id>": {
"<device_id>": {
"user_id": "<user_id>", // Duplicated to be signed
"device_id": "<device_id>", // Duplicated to be signed
"valid_until_ts": <millisecond_timestamp>,
"algorithms": [ // List of supported algorithms
"m.olm.curve25519-aes-sha2",
],
"keys": { // Must include a ed25519 signing key
"<algorithm>:<key_id>": "<key_base64>",
},
"signatures:" {
// Must be signed with device's ed25519 key
"<user_id>/<device_id>": {
"<algorithm>:<key_id>": "<signature_base64>"
}
// Must be signed by this server.
"<server_name>": {
"<algorithm>:<key_id>": "<signature_base64>"
} } } } } }
"""
PATTERNS = client_patterns("/keys/query$")
def __init__(self, hs: "HomeServer"):
super().__init__()
self.auth = hs.get_auth()
2016-08-01 13:02:07 -04:00
self.e2e_keys_handler = hs.get_e2e_keys_handler()
@cancellable
async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
requester = await self.auth.get_user_by_req(request, allow_guest=True)
2019-07-25 11:08:24 -04:00
user_id = requester.user.to_string()
device_id = requester.device_id
timeout = parse_integer(request, "timeout", 10 * 1000)
body = parse_json_object_from_request(request)
device_keys = body.get("device_keys")
if not isinstance(device_keys, dict):
raise InvalidAPICallError("'device_keys' must be a JSON object")
def is_list_of_strings(values: Any) -> bool:
return isinstance(values, list) and all(isinstance(v, str) for v in values)
if any(not is_list_of_strings(keys) for keys in device_keys.values()):
raise InvalidAPICallError(
"'device_keys' values must be a list of strings",
)
result = await self.e2e_keys_handler.query_devices(
body, timeout, user_id, device_id
)
return 200, result
2017-02-01 05:30:03 -05:00
class KeyChangesServlet(RestServlet):
2017-02-01 05:32:49 -05:00
"""Returns the list of changes of keys between two stream tokens (may return
2017-02-01 08:17:17 -05:00
spurious extra results, since we currently ignore the `to` param).
2017-02-01 05:32:49 -05:00
GET /keys/changes?from=...&to=...
200 OK
{ "changed": ["@foo:example.com"] }
"""
2019-06-20 05:32:02 -04:00
PATTERNS = client_patterns("/keys/changes$")
2017-02-01 05:30:03 -05:00
def __init__(self, hs: "HomeServer"):
super().__init__()
2017-02-01 05:30:03 -05:00
self.auth = hs.get_auth()
self.device_handler = hs.get_device_handler()
self.store = hs.get_datastores().main
2017-02-01 05:30:03 -05:00
@cancellable
async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
requester = await self.auth.get_user_by_req(request, allow_guest=True)
2017-02-01 05:30:03 -05:00
from_token_string = parse_string(request, "from", required=True)
set_tag("from", from_token_string)
2017-02-01 05:32:49 -05:00
# We want to enforce they do pass us one, but we ignore it and return
# changes after the "to" as well as before.
#
# XXX This does not enforce that "to" is passed.
set_tag("to", str(parse_string(request, "to")))
2017-02-01 05:30:03 -05:00
from_token = await StreamToken.from_string(self.store, from_token_string)
2017-02-01 05:30:03 -05:00
user_id = requester.user.to_string()
2019-12-05 11:46:37 -05:00
results = await self.device_handler.get_user_ids_changed(user_id, from_token)
2017-02-01 05:30:03 -05:00
return 200, results
2017-02-01 05:30:03 -05:00
class OneTimeKeyServlet(RestServlet):
"""
2015-07-14 08:08:33 -04:00
POST /keys/claim HTTP/1.1
{
"one_time_keys": {
"<user_id>": {
"<device_id>": "<algorithm>"
} } }
HTTP/1.1 200 OK
{
"one_time_keys": {
"<user_id>": {
"<device_id>": {
"<algorithm>:<key_id>": "<key_base64>"
} } } }
"""
2019-06-20 05:32:02 -04:00
PATTERNS = client_patterns("/keys/claim$")
def __init__(self, hs: "HomeServer"):
super().__init__()
self.auth = hs.get_auth()
self.e2e_keys_handler = hs.get_e2e_keys_handler()
async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
await self.auth.get_user_by_req(request, allow_guest=True)
timeout = parse_integer(request, "timeout", 10 * 1000)
body = parse_json_object_from_request(request)
2019-12-05 11:46:37 -05:00
result = await self.e2e_keys_handler.claim_one_time_keys(body, timeout)
return 200, result
2019-07-25 11:08:24 -04:00
class SigningKeyUploadServlet(RestServlet):
"""
POST /keys/device_signing/upload HTTP/1.1
Content-Type: application/json
{
}
"""
PATTERNS = client_patterns("/keys/device_signing/upload$", releases=("v3",))
2019-07-25 11:08:24 -04:00
def __init__(self, hs: "HomeServer"):
super().__init__()
2019-07-25 11:08:24 -04:00
self.hs = hs
self.auth = hs.get_auth()
self.e2e_keys_handler = hs.get_e2e_keys_handler()
self.auth_handler = hs.get_auth_handler()
@interactive_auth_handler
async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
requester = await self.auth.get_user_by_req(request)
2019-07-25 11:08:24 -04:00
user_id = requester.user.to_string()
body = parse_json_object_from_request(request)
2019-12-05 11:46:37 -05:00
await self.auth_handler.validate_user_via_ui_auth(
requester,
request,
body,
"add a device signing key to your account",
# Allow skipping of UI auth since this is frequently called directly
# after login and it is silly to ask users to re-auth immediately.
can_skip_ui_auth=True,
2019-07-25 11:08:24 -04:00
)
2019-12-05 11:46:37 -05:00
result = await self.e2e_keys_handler.upload_signing_keys_for_user(user_id, body)
2019-09-04 22:30:45 -04:00
return 200, result
2019-07-25 11:08:24 -04:00
class SignaturesUploadServlet(RestServlet):
"""
POST /keys/signatures/upload HTTP/1.1
Content-Type: application/json
{
"@alice:example.com": {
"<device_id>": {
"user_id": "<user_id>",
"device_id": "<device_id>",
"algorithms": [
"m.olm.curve25519-aes-sha2",
"m.megolm.v1.aes-sha2"
],
"keys": {
"<algorithm>:<device_id>": "<key_base64>",
},
"signatures": {
"<signing_user_id>": {
"<algorithm>:<signing_key_base64>": "<signature_base64>>"
}
}
}
}
}
"""
2019-07-22 12:52:39 -04:00
PATTERNS = client_patterns("/keys/signatures/upload$")
def __init__(self, hs: "HomeServer"):
super().__init__()
self.auth = hs.get_auth()
self.e2e_keys_handler = hs.get_e2e_keys_handler()
async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
2019-12-05 11:46:37 -05:00
requester = await self.auth.get_user_by_req(request, allow_guest=True)
user_id = requester.user.to_string()
body = parse_json_object_from_request(request)
2019-12-05 11:46:37 -05:00
result = await self.e2e_keys_handler.upload_signatures_for_device_keys(
user_id, body
)
2019-09-04 22:30:45 -04:00
return 200, result
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
KeyUploadServlet(hs).register(http_server)
KeyQueryServlet(hs).register(http_server)
2017-02-01 05:30:03 -05:00
KeyChangesServlet(hs).register(http_server)
OneTimeKeyServlet(hs).register(http_server)
2019-07-25 11:08:24 -04:00
SigningKeyUploadServlet(hs).register(http_server)
SignaturesUploadServlet(hs).register(http_server)