2015-04-14 15:04:52 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2015-04-14 15:04:52 +00:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
import logging
|
2022-10-20 15:32:47 +00:00
|
|
|
import re
|
|
|
|
from typing import TYPE_CHECKING, Optional, Tuple
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2015-08-24 15:17:38 +00:00
|
|
|
from signedjson.sign import sign_json
|
|
|
|
from unpaddedbase64 import encode_base64
|
2015-04-14 15:04:52 +00:00
|
|
|
|
2022-10-20 15:32:47 +00:00
|
|
|
from twisted.web.server import Request
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2022-10-20 15:32:47 +00:00
|
|
|
from synapse.http.servlet import RestServlet
|
2021-09-15 12:45:32 +00:00
|
|
|
from synapse.types import JsonDict
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
2015-04-14 15:04:52 +00:00
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2022-10-20 15:32:47 +00:00
|
|
|
class LocalKey(RestServlet):
|
2015-04-14 15:04:52 +00:00
|
|
|
"""HTTP resource containing encoding the TLS X.509 certificate and NACL
|
|
|
|
signature verification keys for this server::
|
|
|
|
|
2023-05-12 11:31:50 +00:00
|
|
|
GET /_matrix/key/v2/server HTTP/1.1
|
|
|
|
|
2015-04-22 13:21:08 +00:00
|
|
|
GET /_matrix/key/v2/server/a.key.id HTTP/1.1
|
2015-04-14 15:04:52 +00:00
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
Content-Type: application/json
|
|
|
|
{
|
2015-04-23 15:39:13 +00:00
|
|
|
"valid_until_ts": # integer posix timestamp when this result expires.
|
2015-04-14 15:04:52 +00:00
|
|
|
"server_name": "this.server.example.com"
|
|
|
|
"verify_keys": {
|
2015-04-23 15:39:13 +00:00
|
|
|
"algorithm:version": {
|
|
|
|
"key": # base64 encoded NACL verification key.
|
|
|
|
}
|
2015-04-14 15:04:52 +00:00
|
|
|
},
|
|
|
|
"old_verify_keys": {
|
|
|
|
"algorithm:version": {
|
2015-04-23 15:39:13 +00:00
|
|
|
"expired_ts": # integer posix timestamp when the key expired.
|
2015-04-14 15:04:52 +00:00
|
|
|
"key": # base64 encoded NACL verification key.
|
|
|
|
}
|
2016-10-12 13:45:13 +00:00
|
|
|
},
|
2015-04-14 15:04:52 +00:00
|
|
|
"signatures": {
|
|
|
|
"this.server.example.com": {
|
|
|
|
"algorithm:version": # NACL signature for this server
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
2022-10-20 15:32:47 +00:00
|
|
|
PATTERNS = (re.compile("^/_matrix/key/v2/server(/(?P<key_id>[^/]*))?$"),)
|
2015-04-22 13:21:08 +00:00
|
|
|
|
2021-09-15 12:45:32 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2015-04-14 15:04:52 +00:00
|
|
|
self.config = hs.config
|
2020-11-30 18:28:44 +00:00
|
|
|
self.clock = hs.get_clock()
|
2015-04-14 15:04:52 +00:00
|
|
|
self.update_response_body(self.clock.time_msec())
|
|
|
|
|
2021-09-15 12:45:32 +00:00
|
|
|
def update_response_body(self, time_now_msec: int) -> None:
|
2021-09-23 16:03:01 +00:00
|
|
|
refresh_interval = self.config.key.key_refresh_interval
|
2015-04-23 15:39:13 +00:00
|
|
|
self.valid_until_ts = int(time_now_msec + refresh_interval)
|
2022-10-20 15:32:47 +00:00
|
|
|
self.response_body = self.response_json_object()
|
2015-04-14 15:04:52 +00:00
|
|
|
|
2021-09-15 12:45:32 +00:00
|
|
|
def response_json_object(self) -> JsonDict:
|
2015-04-14 15:04:52 +00:00
|
|
|
verify_keys = {}
|
2022-03-29 21:37:50 +00:00
|
|
|
for signing_key in self.config.key.signing_key:
|
|
|
|
verify_key_bytes = signing_key.verify_key.encode()
|
|
|
|
key_id = "%s:%s" % (signing_key.alg, signing_key.version)
|
2015-04-20 15:23:47 +00:00
|
|
|
verify_keys[key_id] = {"key": encode_base64(verify_key_bytes)}
|
2015-04-14 15:04:52 +00:00
|
|
|
|
|
|
|
old_verify_keys = {}
|
2022-03-29 21:37:50 +00:00
|
|
|
for key_id, old_signing_key in self.config.key.old_signing_keys.items():
|
|
|
|
verify_key_bytes = old_signing_key.encode()
|
2015-04-14 15:04:52 +00:00
|
|
|
old_verify_keys[key_id] = {
|
|
|
|
"key": encode_base64(verify_key_bytes),
|
2022-03-29 21:37:50 +00:00
|
|
|
"expired_ts": old_signing_key.expired,
|
2015-04-14 15:04:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
json_object = {
|
2015-04-23 15:39:13 +00:00
|
|
|
"valid_until_ts": self.valid_until_ts,
|
2021-09-13 17:07:12 +00:00
|
|
|
"server_name": self.config.server.server_name,
|
2015-04-14 15:04:52 +00:00
|
|
|
"verify_keys": verify_keys,
|
|
|
|
"old_verify_keys": old_verify_keys,
|
|
|
|
}
|
2021-09-23 16:03:01 +00:00
|
|
|
for key in self.config.key.signing_key:
|
2021-09-13 17:07:12 +00:00
|
|
|
json_object = sign_json(json_object, self.config.server.server_name, key)
|
2015-04-14 15:04:52 +00:00
|
|
|
return json_object
|
|
|
|
|
2022-10-20 15:32:47 +00:00
|
|
|
def on_GET(
|
|
|
|
self, request: Request, key_id: Optional[str] = None
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2023-05-12 11:31:50 +00:00
|
|
|
# Matrix 1.6 drops support for passing the key_id, this is incompatible
|
|
|
|
# with earlier versions and is allowed in order to support both.
|
|
|
|
# A warning is issued to help determine when it is safe to drop this.
|
|
|
|
if key_id:
|
|
|
|
logger.warning(
|
|
|
|
"Request for local server key with deprecated key ID (logging to determine usage level for future removal): %s",
|
|
|
|
key_id,
|
|
|
|
)
|
|
|
|
|
2015-04-14 15:04:52 +00:00
|
|
|
time_now = self.clock.time_msec()
|
|
|
|
# Update the expiry time if less than half the interval remains.
|
2021-09-23 16:03:01 +00:00
|
|
|
if time_now + self.config.key.key_refresh_interval / 2 > self.valid_until_ts:
|
2015-04-23 15:39:13 +00:00
|
|
|
self.update_response_body(time_now)
|
2022-10-20 15:32:47 +00:00
|
|
|
return 200, self.response_body
|