MatrixSynapse/synapse/rest/key/v2/local_key_resource.py

108 lines
3.9 KiB
Python
Raw Normal View History

2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
2015-04-14 17:04:52 +02: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-07-09 08:09:20 +02:00
import logging
import re
from typing import TYPE_CHECKING, Optional, Tuple
2018-07-09 08:09:20 +02:00
from signedjson.sign import sign_json
from unpaddedbase64 import encode_base64
2015-04-14 17:04:52 +02:00
from twisted.web.server import Request
2018-07-09 08:09:20 +02:00
from synapse.http.servlet import RestServlet
from synapse.types import JsonDict
if TYPE_CHECKING:
from synapse.server import HomeServer
2015-04-14 17:04:52 +02:00
logger = logging.getLogger(__name__)
class LocalKey(RestServlet):
2015-04-14 17:04:52 +02:00
"""HTTP resource containing encoding the TLS X.509 certificate and NACL
signature verification keys for this server::
2015-04-22 15:21:08 +02:00
GET /_matrix/key/v2/server/a.key.id HTTP/1.1
2015-04-14 17:04:52 +02:00
HTTP/1.1 200 OK
Content-Type: application/json
{
"valid_until_ts": # integer posix timestamp when this result expires.
2015-04-14 17:04:52 +02:00
"server_name": "this.server.example.com"
"verify_keys": {
"algorithm:version": {
"key": # base64 encoded NACL verification key.
}
2015-04-14 17:04:52 +02:00
},
"old_verify_keys": {
"algorithm:version": {
"expired_ts": # integer posix timestamp when the key expired.
2015-04-14 17:04:52 +02:00
"key": # base64 encoded NACL verification key.
}
2016-10-12 15:45:13 +02:00
},
2015-04-14 17:04:52 +02:00
"signatures": {
"this.server.example.com": {
"algorithm:version": # NACL signature for this server
}
}
}
"""
PATTERNS = (re.compile("^/_matrix/key/v2/server(/(?P<key_id>[^/]*))?$"),)
2015-04-22 15:21:08 +02:00
def __init__(self, hs: "HomeServer"):
2015-04-14 17:04:52 +02:00
self.config = hs.config
self.clock = hs.get_clock()
2015-04-14 17:04:52 +02:00
self.update_response_body(self.clock.time_msec())
def update_response_body(self, time_now_msec: int) -> None:
refresh_interval = self.config.key.key_refresh_interval
self.valid_until_ts = int(time_now_msec + refresh_interval)
self.response_body = self.response_json_object()
2015-04-14 17:04:52 +02:00
def response_json_object(self) -> JsonDict:
2015-04-14 17:04:52 +02:00
verify_keys = {}
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)
2019-06-20 11:32:02 +02:00
verify_keys[key_id] = {"key": encode_base64(verify_key_bytes)}
2015-04-14 17:04:52 +02:00
old_verify_keys = {}
for key_id, old_signing_key in self.config.key.old_signing_keys.items():
verify_key_bytes = old_signing_key.encode()
2015-04-14 17:04:52 +02:00
old_verify_keys[key_id] = {
2019-06-20 11:32:02 +02:00
"key": encode_base64(verify_key_bytes),
"expired_ts": old_signing_key.expired,
2015-04-14 17:04:52 +02:00
}
json_object = {
2019-06-20 11:32:02 +02:00
"valid_until_ts": self.valid_until_ts,
"server_name": self.config.server.server_name,
2019-06-20 11:32:02 +02:00
"verify_keys": verify_keys,
"old_verify_keys": old_verify_keys,
2015-04-14 17:04:52 +02:00
}
for key in self.config.key.signing_key:
json_object = sign_json(json_object, self.config.server.server_name, key)
2015-04-14 17:04:52 +02:00
return json_object
def on_GET(
self, request: Request, key_id: Optional[str] = None
) -> Tuple[int, JsonDict]:
2015-04-14 17:04:52 +02:00
time_now = self.clock.time_msec()
# Update the expiry time if less than half the interval remains.
if time_now + self.config.key.key_refresh_interval / 2 > self.valid_until_ts:
self.update_response_body(time_now)
return 200, self.response_body