Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
 

906 linhas
32 KiB

  1. # Copyright 2014-2021 The Matrix.org Foundation C.I.C.
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License");
  4. # you may not use this file except in compliance with the License.
  5. # You may obtain a copy of the License at
  6. #
  7. # http://www.apache.org/licenses/LICENSE-2.0
  8. #
  9. # Unless required by applicable law or agreed to in writing, software
  10. # distributed under the License is distributed on an "AS IS" BASIS,
  11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. import abc
  15. import logging
  16. from typing import TYPE_CHECKING, Callable, Dict, Iterable, List, Optional, Tuple
  17. import attr
  18. from signedjson.key import (
  19. decode_verify_key_bytes,
  20. encode_verify_key_base64,
  21. get_verify_key,
  22. is_signing_algorithm_supported,
  23. )
  24. from signedjson.sign import (
  25. SignatureVerifyException,
  26. encode_canonical_json,
  27. signature_ids,
  28. verify_signed_json,
  29. )
  30. from signedjson.types import VerifyKey
  31. from unpaddedbase64 import decode_base64
  32. from twisted.internet import defer
  33. from synapse.api.errors import (
  34. Codes,
  35. HttpResponseException,
  36. RequestSendFailed,
  37. SynapseError,
  38. )
  39. from synapse.config.key import TrustedKeyServer
  40. from synapse.events import EventBase
  41. from synapse.events.utils import prune_event_dict
  42. from synapse.logging.context import make_deferred_yieldable, run_in_background
  43. from synapse.storage.keys import FetchKeyResult
  44. from synapse.types import JsonDict
  45. from synapse.util import unwrapFirstError
  46. from synapse.util.async_helpers import yieldable_gather_results
  47. from synapse.util.batching_queue import BatchingQueue
  48. from synapse.util.retryutils import NotRetryingDestination
  49. if TYPE_CHECKING:
  50. from synapse.server import HomeServer
  51. logger = logging.getLogger(__name__)
  52. @attr.s(slots=True, frozen=True, cmp=False, auto_attribs=True)
  53. class VerifyJsonRequest:
  54. """
  55. A request to verify a JSON object.
  56. Attributes:
  57. server_name: The name of the server to verify against.
  58. get_json_object: A callback to fetch the JSON object to verify.
  59. A callback is used to allow deferring the creation of the JSON
  60. object to verify until needed, e.g. for events we can defer
  61. creating the redacted copy. This reduces the memory usage when
  62. there are large numbers of in flight requests.
  63. minimum_valid_until_ts: time at which we require the signing key to
  64. be valid. (0 implies we don't care)
  65. key_ids: The set of key_ids to that could be used to verify the JSON object
  66. """
  67. server_name: str
  68. get_json_object: Callable[[], JsonDict]
  69. minimum_valid_until_ts: int
  70. key_ids: List[str]
  71. @staticmethod
  72. def from_json_object(
  73. server_name: str,
  74. json_object: JsonDict,
  75. minimum_valid_until_ms: int,
  76. ) -> "VerifyJsonRequest":
  77. """Create a VerifyJsonRequest to verify all signatures on a signed JSON
  78. object for the given server.
  79. """
  80. key_ids = signature_ids(json_object, server_name)
  81. return VerifyJsonRequest(
  82. server_name,
  83. lambda: json_object,
  84. minimum_valid_until_ms,
  85. key_ids=key_ids,
  86. )
  87. @staticmethod
  88. def from_event(
  89. server_name: str,
  90. event: EventBase,
  91. minimum_valid_until_ms: int,
  92. ) -> "VerifyJsonRequest":
  93. """Create a VerifyJsonRequest to verify all signatures on an event
  94. object for the given server.
  95. """
  96. key_ids = list(event.signatures.get(server_name, []))
  97. return VerifyJsonRequest(
  98. server_name,
  99. # We defer creating the redacted json object, as it uses a lot more
  100. # memory than the Event object itself.
  101. lambda: prune_event_dict(event.room_version, event.get_pdu_json()),
  102. minimum_valid_until_ms,
  103. key_ids=key_ids,
  104. )
  105. class KeyLookupError(ValueError):
  106. pass
  107. @attr.s(slots=True, frozen=True, auto_attribs=True)
  108. class _FetchKeyRequest:
  109. """A request for keys for a given server.
  110. We will continue to try and fetch until we have all the keys listed under
  111. `key_ids` (with an appropriate `valid_until_ts` property) or we run out of
  112. places to fetch keys from.
  113. Attributes:
  114. server_name: The name of the server that owns the keys.
  115. minimum_valid_until_ts: The timestamp which the keys must be valid until.
  116. key_ids: The IDs of the keys to attempt to fetch
  117. """
  118. server_name: str
  119. minimum_valid_until_ts: int
  120. key_ids: List[str]
  121. class Keyring:
  122. """Handles verifying signed JSON objects and fetching the keys needed to do
  123. so.
  124. """
  125. def __init__(
  126. self, hs: "HomeServer", key_fetchers: "Optional[Iterable[KeyFetcher]]" = None
  127. ):
  128. self.clock = hs.get_clock()
  129. if key_fetchers is None:
  130. key_fetchers = (
  131. # Fetch keys from the database.
  132. StoreKeyFetcher(hs),
  133. # Fetch keys from a configured Perspectives server.
  134. PerspectivesKeyFetcher(hs),
  135. # Fetch keys from the origin server directly.
  136. ServerKeyFetcher(hs),
  137. )
  138. self._key_fetchers = key_fetchers
  139. self._fetch_keys_queue: BatchingQueue[
  140. _FetchKeyRequest, Dict[str, Dict[str, FetchKeyResult]]
  141. ] = BatchingQueue(
  142. "keyring_server",
  143. clock=hs.get_clock(),
  144. # The method called to fetch each key
  145. process_batch_callback=self._inner_fetch_key_requests,
  146. )
  147. self._hostname = hs.hostname
  148. # build a FetchKeyResult for each of our own keys, to shortcircuit the
  149. # fetcher.
  150. self._local_verify_keys: Dict[str, FetchKeyResult] = {}
  151. for key_id, key in hs.config.key.old_signing_keys.items():
  152. self._local_verify_keys[key_id] = FetchKeyResult(
  153. verify_key=key, valid_until_ts=key.expired
  154. )
  155. vk = get_verify_key(hs.signing_key)
  156. self._local_verify_keys[f"{vk.alg}:{vk.version}"] = FetchKeyResult(
  157. verify_key=vk,
  158. valid_until_ts=2**63, # fake future timestamp
  159. )
  160. async def verify_json_for_server(
  161. self,
  162. server_name: str,
  163. json_object: JsonDict,
  164. validity_time: int,
  165. ) -> None:
  166. """Verify that a JSON object has been signed by a given server
  167. Completes if the the object was correctly signed, otherwise raises.
  168. Args:
  169. server_name: name of the server which must have signed this object
  170. json_object: object to be checked
  171. validity_time: timestamp at which we require the signing key to
  172. be valid. (0 implies we don't care)
  173. """
  174. request = VerifyJsonRequest.from_json_object(
  175. server_name,
  176. json_object,
  177. validity_time,
  178. )
  179. return await self.process_request(request)
  180. def verify_json_objects_for_server(
  181. self, server_and_json: Iterable[Tuple[str, dict, int]]
  182. ) -> List["defer.Deferred[None]"]:
  183. """Bulk verifies signatures of json objects, bulk fetching keys as
  184. necessary.
  185. Args:
  186. server_and_json:
  187. Iterable of (server_name, json_object, validity_time)
  188. tuples.
  189. validity_time is a timestamp at which the signing key must be
  190. valid.
  191. Returns:
  192. For each input triplet, a deferred indicating success or failure to
  193. verify each json object's signature for the given server_name. The
  194. deferreds run their callbacks in the sentinel logcontext.
  195. """
  196. return [
  197. run_in_background(
  198. self.process_request,
  199. VerifyJsonRequest.from_json_object(
  200. server_name,
  201. json_object,
  202. validity_time,
  203. ),
  204. )
  205. for server_name, json_object, validity_time in server_and_json
  206. ]
  207. async def verify_event_for_server(
  208. self,
  209. server_name: str,
  210. event: EventBase,
  211. validity_time: int,
  212. ) -> None:
  213. await self.process_request(
  214. VerifyJsonRequest.from_event(
  215. server_name,
  216. event,
  217. validity_time,
  218. )
  219. )
  220. async def process_request(self, verify_request: VerifyJsonRequest) -> None:
  221. """Processes the `VerifyJsonRequest`. Raises if the object is not signed
  222. by the server, the signatures don't match or we failed to fetch the
  223. necessary keys.
  224. """
  225. if not verify_request.key_ids:
  226. raise SynapseError(
  227. 400,
  228. f"Not signed by {verify_request.server_name}",
  229. Codes.UNAUTHORIZED,
  230. )
  231. found_keys: Dict[str, FetchKeyResult] = {}
  232. # If we are the originating server, short-circuit the key-fetch for any keys
  233. # we already have
  234. if verify_request.server_name == self._hostname:
  235. for key_id in verify_request.key_ids:
  236. if key_id in self._local_verify_keys:
  237. found_keys[key_id] = self._local_verify_keys[key_id]
  238. key_ids_to_find = set(verify_request.key_ids) - found_keys.keys()
  239. if key_ids_to_find:
  240. # Add the keys we need to verify to the queue for retrieval. We queue
  241. # up requests for the same server so we don't end up with many in flight
  242. # requests for the same keys.
  243. key_request = _FetchKeyRequest(
  244. server_name=verify_request.server_name,
  245. minimum_valid_until_ts=verify_request.minimum_valid_until_ts,
  246. key_ids=list(key_ids_to_find),
  247. )
  248. found_keys_by_server = await self._fetch_keys_queue.add_to_queue(
  249. key_request, key=verify_request.server_name
  250. )
  251. # Since we batch up requests the returned set of keys may contain keys
  252. # from other servers, so we pull out only the ones we care about.
  253. found_keys.update(found_keys_by_server.get(verify_request.server_name, {}))
  254. # Verify each signature we got valid keys for, raising if we can't
  255. # verify any of them.
  256. verified = False
  257. for key_id in verify_request.key_ids:
  258. key_result = found_keys.get(key_id)
  259. if not key_result:
  260. continue
  261. if key_result.valid_until_ts < verify_request.minimum_valid_until_ts:
  262. continue
  263. await self._process_json(key_result.verify_key, verify_request)
  264. verified = True
  265. if not verified:
  266. raise SynapseError(
  267. 401,
  268. f"Failed to find any key to satisfy: {key_request}",
  269. Codes.UNAUTHORIZED,
  270. )
  271. async def _process_json(
  272. self, verify_key: VerifyKey, verify_request: VerifyJsonRequest
  273. ) -> None:
  274. """Processes the `VerifyJsonRequest`. Raises if the signature can't be
  275. verified.
  276. """
  277. try:
  278. verify_signed_json(
  279. verify_request.get_json_object(),
  280. verify_request.server_name,
  281. verify_key,
  282. )
  283. except SignatureVerifyException as e:
  284. logger.debug(
  285. "Error verifying signature for %s:%s:%s with key %s: %s",
  286. verify_request.server_name,
  287. verify_key.alg,
  288. verify_key.version,
  289. encode_verify_key_base64(verify_key),
  290. str(e),
  291. )
  292. raise SynapseError(
  293. 401,
  294. "Invalid signature for server %s with key %s:%s: %s"
  295. % (
  296. verify_request.server_name,
  297. verify_key.alg,
  298. verify_key.version,
  299. str(e),
  300. ),
  301. Codes.UNAUTHORIZED,
  302. )
  303. async def _inner_fetch_key_requests(
  304. self, requests: List[_FetchKeyRequest]
  305. ) -> Dict[str, Dict[str, FetchKeyResult]]:
  306. """Processing function for the queue of `_FetchKeyRequest`.
  307. Takes a list of key fetch requests, de-duplicates them and then carries out
  308. each request by invoking self._inner_fetch_key_request.
  309. Args:
  310. requests: A list of requests for homeserver verify keys.
  311. Returns:
  312. {server name: {key id: fetch key result}}
  313. """
  314. logger.debug("Starting fetch for %s", requests)
  315. # First we need to deduplicate requests for the same key. We do this by
  316. # taking the *maximum* requested `minimum_valid_until_ts` for each pair
  317. # of server name/key ID.
  318. server_to_key_to_ts: Dict[str, Dict[str, int]] = {}
  319. for request in requests:
  320. by_server = server_to_key_to_ts.setdefault(request.server_name, {})
  321. for key_id in request.key_ids:
  322. existing_ts = by_server.get(key_id, 0)
  323. by_server[key_id] = max(request.minimum_valid_until_ts, existing_ts)
  324. deduped_requests = [
  325. _FetchKeyRequest(server_name, minimum_valid_ts, [key_id])
  326. for server_name, by_server in server_to_key_to_ts.items()
  327. for key_id, minimum_valid_ts in by_server.items()
  328. ]
  329. logger.debug("Deduplicated key requests to %s", deduped_requests)
  330. # For each key we call `_inner_verify_request` which will handle
  331. # fetching each key. Note these shouldn't throw if we fail to contact
  332. # other servers etc.
  333. results_per_request = await yieldable_gather_results(
  334. self._inner_fetch_key_request,
  335. deduped_requests,
  336. )
  337. # We now convert the returned list of results into a map from server
  338. # name to key ID to FetchKeyResult, to return.
  339. to_return: Dict[str, Dict[str, FetchKeyResult]] = {}
  340. for request, results in zip(deduped_requests, results_per_request):
  341. to_return_by_server = to_return.setdefault(request.server_name, {})
  342. for key_id, key_result in results.items():
  343. existing = to_return_by_server.get(key_id)
  344. if not existing or existing.valid_until_ts < key_result.valid_until_ts:
  345. to_return_by_server[key_id] = key_result
  346. return to_return
  347. async def _inner_fetch_key_request(
  348. self, verify_request: _FetchKeyRequest
  349. ) -> Dict[str, FetchKeyResult]:
  350. """Attempt to fetch the given key by calling each key fetcher one by one.
  351. If a key is found, check whether its `valid_until_ts` attribute satisfies the
  352. `minimum_valid_until_ts` attribute of the `verify_request`. If it does, we
  353. refrain from asking subsequent fetchers for that key.
  354. Even if the above check fails, we still return the found key - the caller may
  355. still find the invalid key result useful. In this case, we continue to ask
  356. subsequent fetchers for the invalid key, in case they return a valid result
  357. for it. This can happen when fetching a stale key result from the database,
  358. before querying the origin server for an up-to-date result.
  359. Args:
  360. verify_request: The request for a verify key. Can include multiple key IDs.
  361. Returns:
  362. A map of {key_id: the key fetch result}.
  363. """
  364. logger.debug("Starting fetch for %s", verify_request)
  365. found_keys: Dict[str, FetchKeyResult] = {}
  366. missing_key_ids = set(verify_request.key_ids)
  367. for fetcher in self._key_fetchers:
  368. if not missing_key_ids:
  369. break
  370. logger.debug("Getting keys from %s for %s", fetcher, verify_request)
  371. keys = await fetcher.get_keys(
  372. verify_request.server_name,
  373. list(missing_key_ids),
  374. verify_request.minimum_valid_until_ts,
  375. )
  376. for key_id, key in keys.items():
  377. if not key:
  378. continue
  379. # If we already have a result for the given key ID, we keep the
  380. # one with the highest `valid_until_ts`.
  381. existing_key = found_keys.get(key_id)
  382. if existing_key and existing_key.valid_until_ts > key.valid_until_ts:
  383. continue
  384. # Check if this key's expiry timestamp is valid for the verify request.
  385. if key.valid_until_ts >= verify_request.minimum_valid_until_ts:
  386. # Stop looking for this key from subsequent fetchers.
  387. missing_key_ids.discard(key_id)
  388. # We always store the returned key even if it doesn't meet the
  389. # `minimum_valid_until_ts` requirement, as some verification
  390. # requests may still be able to be satisfied by it.
  391. found_keys[key_id] = key
  392. return found_keys
  393. class KeyFetcher(metaclass=abc.ABCMeta):
  394. def __init__(self, hs: "HomeServer"):
  395. self._queue = BatchingQueue(
  396. self.__class__.__name__, hs.get_clock(), self._fetch_keys
  397. )
  398. async def get_keys(
  399. self, server_name: str, key_ids: List[str], minimum_valid_until_ts: int
  400. ) -> Dict[str, FetchKeyResult]:
  401. results = await self._queue.add_to_queue(
  402. _FetchKeyRequest(
  403. server_name=server_name,
  404. key_ids=key_ids,
  405. minimum_valid_until_ts=minimum_valid_until_ts,
  406. )
  407. )
  408. return results.get(server_name, {})
  409. @abc.abstractmethod
  410. async def _fetch_keys(
  411. self, keys_to_fetch: List[_FetchKeyRequest]
  412. ) -> Dict[str, Dict[str, FetchKeyResult]]:
  413. pass
  414. class StoreKeyFetcher(KeyFetcher):
  415. """KeyFetcher impl which fetches keys from our data store"""
  416. def __init__(self, hs: "HomeServer"):
  417. super().__init__(hs)
  418. self.store = hs.get_datastores().main
  419. async def _fetch_keys(
  420. self, keys_to_fetch: List[_FetchKeyRequest]
  421. ) -> Dict[str, Dict[str, FetchKeyResult]]:
  422. key_ids_to_fetch = (
  423. (queue_value.server_name, key_id)
  424. for queue_value in keys_to_fetch
  425. for key_id in queue_value.key_ids
  426. )
  427. res = await self.store.get_server_verify_keys(key_ids_to_fetch)
  428. keys: Dict[str, Dict[str, FetchKeyResult]] = {}
  429. for (server_name, key_id), key in res.items():
  430. keys.setdefault(server_name, {})[key_id] = key
  431. return keys
  432. class BaseV2KeyFetcher(KeyFetcher):
  433. def __init__(self, hs: "HomeServer"):
  434. super().__init__(hs)
  435. self.store = hs.get_datastores().main
  436. self.config = hs.config
  437. async def process_v2_response(
  438. self, from_server: str, response_json: JsonDict, time_added_ms: int
  439. ) -> Dict[str, FetchKeyResult]:
  440. """Parse a 'Server Keys' structure from the result of a /key request
  441. This is used to parse either the entirety of the response from
  442. GET /_matrix/key/v2/server, or a single entry from the list returned by
  443. POST /_matrix/key/v2/query.
  444. Checks that each signature in the response that claims to come from the origin
  445. server is valid, and that there is at least one such signature.
  446. Stores the json in server_keys_json so that it can be used for future responses
  447. to /_matrix/key/v2/query.
  448. Args:
  449. from_server: the name of the server producing this result: either
  450. the origin server for a /_matrix/key/v2/server request, or the notary
  451. for a /_matrix/key/v2/query.
  452. response_json: the json-decoded Server Keys response object
  453. time_added_ms: the timestamp to record in server_keys_json
  454. Returns:
  455. Map from key_id to result object
  456. """
  457. ts_valid_until_ms = response_json["valid_until_ts"]
  458. # start by extracting the keys from the response, since they may be required
  459. # to validate the signature on the response.
  460. verify_keys = {}
  461. for key_id, key_data in response_json["verify_keys"].items():
  462. if is_signing_algorithm_supported(key_id):
  463. key_base64 = key_data["key"]
  464. key_bytes = decode_base64(key_base64)
  465. verify_key = decode_verify_key_bytes(key_id, key_bytes)
  466. verify_keys[key_id] = FetchKeyResult(
  467. verify_key=verify_key, valid_until_ts=ts_valid_until_ms
  468. )
  469. server_name = response_json["server_name"]
  470. verified = False
  471. for key_id in response_json["signatures"].get(server_name, {}):
  472. key = verify_keys.get(key_id)
  473. if not key:
  474. # the key may not be present in verify_keys if:
  475. # * we got the key from the notary server, and:
  476. # * the key belongs to the notary server, and:
  477. # * the notary server is using a different key to sign notary
  478. # responses.
  479. continue
  480. verify_signed_json(response_json, server_name, key.verify_key)
  481. verified = True
  482. break
  483. if not verified:
  484. raise KeyLookupError(
  485. "Key response for %s is not signed by the origin server"
  486. % (server_name,)
  487. )
  488. for key_id, key_data in response_json["old_verify_keys"].items():
  489. if is_signing_algorithm_supported(key_id):
  490. key_base64 = key_data["key"]
  491. key_bytes = decode_base64(key_base64)
  492. verify_key = decode_verify_key_bytes(key_id, key_bytes)
  493. verify_keys[key_id] = FetchKeyResult(
  494. verify_key=verify_key, valid_until_ts=key_data["expired_ts"]
  495. )
  496. key_json_bytes = encode_canonical_json(response_json)
  497. await make_deferred_yieldable(
  498. defer.gatherResults(
  499. [
  500. run_in_background(
  501. self.store.store_server_keys_json,
  502. server_name=server_name,
  503. key_id=key_id,
  504. from_server=from_server,
  505. ts_now_ms=time_added_ms,
  506. ts_expires_ms=ts_valid_until_ms,
  507. key_json_bytes=key_json_bytes,
  508. )
  509. for key_id in verify_keys
  510. ],
  511. consumeErrors=True,
  512. ).addErrback(unwrapFirstError)
  513. )
  514. return verify_keys
  515. class PerspectivesKeyFetcher(BaseV2KeyFetcher):
  516. """KeyFetcher impl which fetches keys from the "perspectives" servers"""
  517. def __init__(self, hs: "HomeServer"):
  518. super().__init__(hs)
  519. self.clock = hs.get_clock()
  520. self.client = hs.get_federation_http_client()
  521. self.key_servers = self.config.key.key_servers
  522. async def _fetch_keys(
  523. self, keys_to_fetch: List[_FetchKeyRequest]
  524. ) -> Dict[str, Dict[str, FetchKeyResult]]:
  525. """see KeyFetcher._fetch_keys"""
  526. async def get_key(key_server: TrustedKeyServer) -> Dict:
  527. try:
  528. return await self.get_server_verify_key_v2_indirect(
  529. keys_to_fetch, key_server
  530. )
  531. except KeyLookupError as e:
  532. logger.warning(
  533. "Key lookup failed from %r: %s", key_server.server_name, e
  534. )
  535. except Exception as e:
  536. logger.exception(
  537. "Unable to get key from %r: %s %s",
  538. key_server.server_name,
  539. type(e).__name__,
  540. str(e),
  541. )
  542. return {}
  543. results = await make_deferred_yieldable(
  544. defer.gatherResults(
  545. [run_in_background(get_key, server) for server in self.key_servers],
  546. consumeErrors=True,
  547. ).addErrback(unwrapFirstError)
  548. )
  549. union_of_keys: Dict[str, Dict[str, FetchKeyResult]] = {}
  550. for result in results:
  551. for server_name, keys in result.items():
  552. union_of_keys.setdefault(server_name, {}).update(keys)
  553. return union_of_keys
  554. async def get_server_verify_key_v2_indirect(
  555. self, keys_to_fetch: List[_FetchKeyRequest], key_server: TrustedKeyServer
  556. ) -> Dict[str, Dict[str, FetchKeyResult]]:
  557. """
  558. Args:
  559. keys_to_fetch:
  560. the keys to be fetched.
  561. key_server: notary server to query for the keys
  562. Returns:
  563. Map from server_name -> key_id -> FetchKeyResult
  564. Raises:
  565. KeyLookupError if there was an error processing the entire response from
  566. the server
  567. """
  568. perspective_name = key_server.server_name
  569. logger.info(
  570. "Requesting keys %s from notary server %s",
  571. keys_to_fetch,
  572. perspective_name,
  573. )
  574. request: JsonDict = {}
  575. for queue_value in keys_to_fetch:
  576. # there may be multiple requests for each server, so we have to merge
  577. # them intelligently.
  578. request_for_server = {
  579. key_id: {
  580. "minimum_valid_until_ts": queue_value.minimum_valid_until_ts,
  581. }
  582. for key_id in queue_value.key_ids
  583. }
  584. request.setdefault(queue_value.server_name, {}).update(request_for_server)
  585. logger.debug("Request to notary server %s: %s", perspective_name, request)
  586. try:
  587. query_response = await self.client.post_json(
  588. destination=perspective_name,
  589. path="/_matrix/key/v2/query",
  590. data={"server_keys": request},
  591. )
  592. except (NotRetryingDestination, RequestSendFailed) as e:
  593. # these both have str() representations which we can't really improve upon
  594. raise KeyLookupError(str(e))
  595. except HttpResponseException as e:
  596. raise KeyLookupError("Remote server returned an error: %s" % (e,))
  597. logger.debug(
  598. "Response from notary server %s: %s", perspective_name, query_response
  599. )
  600. keys: Dict[str, Dict[str, FetchKeyResult]] = {}
  601. added_keys: List[Tuple[str, str, FetchKeyResult]] = []
  602. time_now_ms = self.clock.time_msec()
  603. assert isinstance(query_response, dict)
  604. for response in query_response["server_keys"]:
  605. # do this first, so that we can give useful errors thereafter
  606. server_name = response.get("server_name")
  607. if not isinstance(server_name, str):
  608. raise KeyLookupError(
  609. "Malformed response from key notary server %s: invalid server_name"
  610. % (perspective_name,)
  611. )
  612. try:
  613. self._validate_perspectives_response(key_server, response)
  614. processed_response = await self.process_v2_response(
  615. perspective_name, response, time_added_ms=time_now_ms
  616. )
  617. except KeyLookupError as e:
  618. logger.warning(
  619. "Error processing response from key notary server %s for origin "
  620. "server %s: %s",
  621. perspective_name,
  622. server_name,
  623. e,
  624. )
  625. # we continue to process the rest of the response
  626. continue
  627. added_keys.extend(
  628. (server_name, key_id, key) for key_id, key in processed_response.items()
  629. )
  630. keys.setdefault(server_name, {}).update(processed_response)
  631. await self.store.store_server_verify_keys(
  632. perspective_name, time_now_ms, added_keys
  633. )
  634. return keys
  635. def _validate_perspectives_response(
  636. self, key_server: TrustedKeyServer, response: JsonDict
  637. ) -> None:
  638. """Optionally check the signature on the result of a /key/query request
  639. Args:
  640. key_server: the notary server that produced this result
  641. response: the json-decoded Server Keys response object
  642. """
  643. perspective_name = key_server.server_name
  644. perspective_keys = key_server.verify_keys
  645. if perspective_keys is None:
  646. # signature checking is disabled on this server
  647. return
  648. if (
  649. "signatures" not in response
  650. or perspective_name not in response["signatures"]
  651. ):
  652. raise KeyLookupError("Response not signed by the notary server")
  653. verified = False
  654. for key_id in response["signatures"][perspective_name]:
  655. if key_id in perspective_keys:
  656. verify_signed_json(response, perspective_name, perspective_keys[key_id])
  657. verified = True
  658. if not verified:
  659. raise KeyLookupError(
  660. "Response not signed with a known key: signed with: %r, known keys: %r"
  661. % (
  662. list(response["signatures"][perspective_name].keys()),
  663. list(perspective_keys.keys()),
  664. )
  665. )
  666. class ServerKeyFetcher(BaseV2KeyFetcher):
  667. """KeyFetcher impl which fetches keys from the origin servers"""
  668. def __init__(self, hs: "HomeServer"):
  669. super().__init__(hs)
  670. self.clock = hs.get_clock()
  671. self.client = hs.get_federation_http_client()
  672. async def get_keys(
  673. self, server_name: str, key_ids: List[str], minimum_valid_until_ts: int
  674. ) -> Dict[str, FetchKeyResult]:
  675. results = await self._queue.add_to_queue(
  676. _FetchKeyRequest(
  677. server_name=server_name,
  678. key_ids=key_ids,
  679. minimum_valid_until_ts=minimum_valid_until_ts,
  680. ),
  681. key=server_name,
  682. )
  683. return results.get(server_name, {})
  684. async def _fetch_keys(
  685. self, keys_to_fetch: List[_FetchKeyRequest]
  686. ) -> Dict[str, Dict[str, FetchKeyResult]]:
  687. """
  688. Args:
  689. keys_to_fetch:
  690. the keys to be fetched. server_name -> key_ids
  691. Returns:
  692. Map from server_name -> key_id -> FetchKeyResult
  693. """
  694. results = {}
  695. async def get_keys(key_to_fetch_item: _FetchKeyRequest) -> None:
  696. server_name = key_to_fetch_item.server_name
  697. try:
  698. keys = await self.get_server_verify_keys_v2_direct(server_name)
  699. results[server_name] = keys
  700. except KeyLookupError as e:
  701. logger.warning("Error looking up keys from %s: %s", server_name, e)
  702. except Exception:
  703. logger.exception("Error getting keys from %s", server_name)
  704. await yieldable_gather_results(get_keys, keys_to_fetch)
  705. return results
  706. async def get_server_verify_keys_v2_direct(
  707. self, server_name: str
  708. ) -> Dict[str, FetchKeyResult]:
  709. """
  710. Args:
  711. server_name: Server to request keys from
  712. Returns:
  713. Map from key ID to lookup result
  714. Raises:
  715. KeyLookupError if there was a problem making the lookup
  716. """
  717. time_now_ms = self.clock.time_msec()
  718. try:
  719. response = await self.client.get_json(
  720. destination=server_name,
  721. path="/_matrix/key/v2/server",
  722. ignore_backoff=True,
  723. # we only give the remote server 10s to respond. It should be an
  724. # easy request to handle, so if it doesn't reply within 10s, it's
  725. # probably not going to.
  726. #
  727. # Furthermore, when we are acting as a notary server, we cannot
  728. # wait all day for all of the origin servers, as the requesting
  729. # server will otherwise time out before we can respond.
  730. #
  731. # (Note that get_json may make 4 attempts, so this can still take
  732. # almost 45 seconds to fetch the headers, plus up to another 60s to
  733. # read the response).
  734. timeout=10000,
  735. )
  736. except (NotRetryingDestination, RequestSendFailed) as e:
  737. # these both have str() representations which we can't really improve
  738. # upon
  739. raise KeyLookupError(str(e))
  740. except HttpResponseException as e:
  741. raise KeyLookupError("Remote server returned an error: %s" % (e,))
  742. assert isinstance(response, dict)
  743. if response["server_name"] != server_name:
  744. raise KeyLookupError(
  745. "Expected a response for server %r not %r"
  746. % (server_name, response["server_name"])
  747. )
  748. return await self.process_v2_response(
  749. from_server=server_name,
  750. response_json=response,
  751. time_added_ms=time_now_ms,
  752. )