keyring.py 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. # -*- coding: utf-8 -*-
  2. # Copyright 2014-2016 OpenMarket Ltd
  3. # Copyright 2017, 2018 New Vector Ltd
  4. #
  5. # Licensed under the Apache License, Version 2.0 (the "License");
  6. # you may not use this file except in compliance with the License.
  7. # You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. import logging
  17. import urllib
  18. from collections import defaultdict
  19. import attr
  20. from signedjson.key import (
  21. decode_verify_key_bytes,
  22. encode_verify_key_base64,
  23. is_signing_algorithm_supported,
  24. )
  25. from signedjson.sign import (
  26. SignatureVerifyException,
  27. encode_canonical_json,
  28. signature_ids,
  29. verify_signed_json,
  30. )
  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.logging.context import (
  40. PreserveLoggingContext,
  41. current_context,
  42. make_deferred_yieldable,
  43. preserve_fn,
  44. run_in_background,
  45. )
  46. from synapse.storage.keys import FetchKeyResult
  47. from synapse.util import unwrapFirstError
  48. from synapse.util.async_helpers import yieldable_gather_results
  49. from synapse.util.metrics import Measure
  50. from synapse.util.retryutils import NotRetryingDestination
  51. logger = logging.getLogger(__name__)
  52. @attr.s(slots=True, cmp=False)
  53. class VerifyJsonRequest:
  54. """
  55. A request to verify a JSON object.
  56. Attributes:
  57. server_name(str): The name of the server to verify against.
  58. key_ids(set[str]): The set of key_ids to that could be used to verify the
  59. JSON object
  60. json_object(dict): The JSON object to verify.
  61. minimum_valid_until_ts (int): time at which we require the signing key to
  62. be valid. (0 implies we don't care)
  63. key_ready (Deferred[str, str, nacl.signing.VerifyKey]):
  64. A deferred (server_name, key_id, verify_key) tuple that resolves when
  65. a verify key has been fetched. The deferreds' callbacks are run with no
  66. logcontext.
  67. If we are unable to find a key which satisfies the request, the deferred
  68. errbacks with an M_UNAUTHORIZED SynapseError.
  69. """
  70. server_name = attr.ib()
  71. json_object = attr.ib()
  72. minimum_valid_until_ts = attr.ib()
  73. request_name = attr.ib()
  74. key_ids = attr.ib(init=False)
  75. key_ready = attr.ib(default=attr.Factory(defer.Deferred))
  76. def __attrs_post_init__(self):
  77. self.key_ids = signature_ids(self.json_object, self.server_name)
  78. class KeyLookupError(ValueError):
  79. pass
  80. class Keyring:
  81. def __init__(self, hs, key_fetchers=None):
  82. self.clock = hs.get_clock()
  83. if key_fetchers is None:
  84. key_fetchers = (
  85. StoreKeyFetcher(hs),
  86. PerspectivesKeyFetcher(hs),
  87. ServerKeyFetcher(hs),
  88. )
  89. self._key_fetchers = key_fetchers
  90. # map from server name to Deferred. Has an entry for each server with
  91. # an ongoing key download; the Deferred completes once the download
  92. # completes.
  93. #
  94. # These are regular, logcontext-agnostic Deferreds.
  95. self.key_downloads = {}
  96. def verify_json_for_server(
  97. self, server_name, json_object, validity_time, request_name
  98. ):
  99. """Verify that a JSON object has been signed by a given server
  100. Args:
  101. server_name (str): name of the server which must have signed this object
  102. json_object (dict): object to be checked
  103. validity_time (int): timestamp at which we require the signing key to
  104. be valid. (0 implies we don't care)
  105. request_name (str): an identifier for this json object (eg, an event id)
  106. for logging.
  107. Returns:
  108. Deferred[None]: completes if the the object was correctly signed, otherwise
  109. errbacks with an error
  110. """
  111. req = VerifyJsonRequest(server_name, json_object, validity_time, request_name)
  112. requests = (req,)
  113. return make_deferred_yieldable(self._verify_objects(requests)[0])
  114. def verify_json_objects_for_server(self, server_and_json):
  115. """Bulk verifies signatures of json objects, bulk fetching keys as
  116. necessary.
  117. Args:
  118. server_and_json (iterable[Tuple[str, dict, int, str]):
  119. Iterable of (server_name, json_object, validity_time, request_name)
  120. tuples.
  121. validity_time is a timestamp at which the signing key must be
  122. valid.
  123. request_name is an identifier for this json object (eg, an event id)
  124. for logging.
  125. Returns:
  126. List<Deferred[None]>: for each input triplet, a deferred indicating success
  127. or failure to verify each json object's signature for the given
  128. server_name. The deferreds run their callbacks in the sentinel
  129. logcontext.
  130. """
  131. return self._verify_objects(
  132. VerifyJsonRequest(server_name, json_object, validity_time, request_name)
  133. for server_name, json_object, validity_time, request_name in server_and_json
  134. )
  135. def _verify_objects(self, verify_requests):
  136. """Does the work of verify_json_[objects_]for_server
  137. Args:
  138. verify_requests (iterable[VerifyJsonRequest]):
  139. Iterable of verification requests.
  140. Returns:
  141. List<Deferred[None]>: for each input item, a deferred indicating success
  142. or failure to verify each json object's signature for the given
  143. server_name. The deferreds run their callbacks in the sentinel
  144. logcontext.
  145. """
  146. # a list of VerifyJsonRequests which are awaiting a key lookup
  147. key_lookups = []
  148. handle = preserve_fn(_handle_key_deferred)
  149. def process(verify_request):
  150. """Process an entry in the request list
  151. Adds a key request to key_lookups, and returns a deferred which
  152. will complete or fail (in the sentinel context) when verification completes.
  153. """
  154. if not verify_request.key_ids:
  155. return defer.fail(
  156. SynapseError(
  157. 400,
  158. "Not signed by %s" % (verify_request.server_name,),
  159. Codes.UNAUTHORIZED,
  160. )
  161. )
  162. logger.debug(
  163. "Verifying %s for %s with key_ids %s, min_validity %i",
  164. verify_request.request_name,
  165. verify_request.server_name,
  166. verify_request.key_ids,
  167. verify_request.minimum_valid_until_ts,
  168. )
  169. # add the key request to the queue, but don't start it off yet.
  170. key_lookups.append(verify_request)
  171. # now run _handle_key_deferred, which will wait for the key request
  172. # to complete and then do the verification.
  173. #
  174. # We want _handle_key_request to log to the right context, so we
  175. # wrap it with preserve_fn (aka run_in_background)
  176. return handle(verify_request)
  177. results = [process(r) for r in verify_requests]
  178. if key_lookups:
  179. run_in_background(self._start_key_lookups, key_lookups)
  180. return results
  181. async def _start_key_lookups(self, verify_requests):
  182. """Sets off the key fetches for each verify request
  183. Once each fetch completes, verify_request.key_ready will be resolved.
  184. Args:
  185. verify_requests (List[VerifyJsonRequest]):
  186. """
  187. try:
  188. ctx = current_context()
  189. # map from server name to a set of outstanding request ids
  190. server_to_request_ids = {}
  191. for verify_request in verify_requests:
  192. server_name = verify_request.server_name
  193. request_id = id(verify_request)
  194. server_to_request_ids.setdefault(server_name, set()).add(request_id)
  195. # Wait for any previous lookups to complete before proceeding.
  196. await self.wait_for_previous_lookups(server_to_request_ids.keys())
  197. # take out a lock on each of the servers by sticking a Deferred in
  198. # key_downloads
  199. for server_name in server_to_request_ids.keys():
  200. self.key_downloads[server_name] = defer.Deferred()
  201. logger.debug("Got key lookup lock on %s", server_name)
  202. # When we've finished fetching all the keys for a given server_name,
  203. # drop the lock by resolving the deferred in key_downloads.
  204. def drop_server_lock(server_name):
  205. d = self.key_downloads.pop(server_name)
  206. d.callback(None)
  207. def lookup_done(res, verify_request):
  208. server_name = verify_request.server_name
  209. server_requests = server_to_request_ids[server_name]
  210. server_requests.remove(id(verify_request))
  211. # if there are no more requests for this server, we can drop the lock.
  212. if not server_requests:
  213. with PreserveLoggingContext(ctx):
  214. logger.debug("Releasing key lookup lock on %s", server_name)
  215. # ... but not immediately, as that can cause stack explosions if
  216. # we get a long queue of lookups.
  217. self.clock.call_later(0, drop_server_lock, server_name)
  218. return res
  219. for verify_request in verify_requests:
  220. verify_request.key_ready.addBoth(lookup_done, verify_request)
  221. # Actually start fetching keys.
  222. self._get_server_verify_keys(verify_requests)
  223. except Exception:
  224. logger.exception("Error starting key lookups")
  225. async def wait_for_previous_lookups(self, server_names) -> None:
  226. """Waits for any previous key lookups for the given servers to finish.
  227. Args:
  228. server_names (Iterable[str]): list of servers which we want to look up
  229. Returns:
  230. Resolves once all key lookups for the given servers have
  231. completed. Follows the synapse rules of logcontext preservation.
  232. """
  233. loop_count = 1
  234. while True:
  235. wait_on = [
  236. (server_name, self.key_downloads[server_name])
  237. for server_name in server_names
  238. if server_name in self.key_downloads
  239. ]
  240. if not wait_on:
  241. break
  242. logger.info(
  243. "Waiting for existing lookups for %s to complete [loop %i]",
  244. [w[0] for w in wait_on],
  245. loop_count,
  246. )
  247. with PreserveLoggingContext():
  248. await defer.DeferredList((w[1] for w in wait_on))
  249. loop_count += 1
  250. def _get_server_verify_keys(self, verify_requests):
  251. """Tries to find at least one key for each verify request
  252. For each verify_request, verify_request.key_ready is called back with
  253. params (server_name, key_id, VerifyKey) if a key is found, or errbacked
  254. with a SynapseError if none of the keys are found.
  255. Args:
  256. verify_requests (list[VerifyJsonRequest]): list of verify requests
  257. """
  258. remaining_requests = {rq for rq in verify_requests if not rq.key_ready.called}
  259. async def do_iterations():
  260. try:
  261. with Measure(self.clock, "get_server_verify_keys"):
  262. for f in self._key_fetchers:
  263. if not remaining_requests:
  264. return
  265. await self._attempt_key_fetches_with_fetcher(
  266. f, remaining_requests
  267. )
  268. # look for any requests which weren't satisfied
  269. with PreserveLoggingContext():
  270. for verify_request in remaining_requests:
  271. verify_request.key_ready.errback(
  272. SynapseError(
  273. 401,
  274. "No key for %s with ids in %s (min_validity %i)"
  275. % (
  276. verify_request.server_name,
  277. verify_request.key_ids,
  278. verify_request.minimum_valid_until_ts,
  279. ),
  280. Codes.UNAUTHORIZED,
  281. )
  282. )
  283. except Exception as err:
  284. # we don't really expect to get here, because any errors should already
  285. # have been caught and logged. But if we do, let's log the error and make
  286. # sure that all of the deferreds are resolved.
  287. logger.error("Unexpected error in _get_server_verify_keys: %s", err)
  288. with PreserveLoggingContext():
  289. for verify_request in remaining_requests:
  290. if not verify_request.key_ready.called:
  291. verify_request.key_ready.errback(err)
  292. run_in_background(do_iterations)
  293. async def _attempt_key_fetches_with_fetcher(self, fetcher, remaining_requests):
  294. """Use a key fetcher to attempt to satisfy some key requests
  295. Args:
  296. fetcher (KeyFetcher): fetcher to use to fetch the keys
  297. remaining_requests (set[VerifyJsonRequest]): outstanding key requests.
  298. Any successfully-completed requests will be removed from the list.
  299. """
  300. # dict[str, dict[str, int]]: keys to fetch.
  301. # server_name -> key_id -> min_valid_ts
  302. missing_keys = defaultdict(dict)
  303. for verify_request in remaining_requests:
  304. # any completed requests should already have been removed
  305. assert not verify_request.key_ready.called
  306. keys_for_server = missing_keys[verify_request.server_name]
  307. for key_id in verify_request.key_ids:
  308. # If we have several requests for the same key, then we only need to
  309. # request that key once, but we should do so with the greatest
  310. # min_valid_until_ts of the requests, so that we can satisfy all of
  311. # the requests.
  312. keys_for_server[key_id] = max(
  313. keys_for_server.get(key_id, -1),
  314. verify_request.minimum_valid_until_ts,
  315. )
  316. results = await fetcher.get_keys(missing_keys)
  317. completed = []
  318. for verify_request in remaining_requests:
  319. server_name = verify_request.server_name
  320. # see if any of the keys we got this time are sufficient to
  321. # complete this VerifyJsonRequest.
  322. result_keys = results.get(server_name, {})
  323. for key_id in verify_request.key_ids:
  324. fetch_key_result = result_keys.get(key_id)
  325. if not fetch_key_result:
  326. # we didn't get a result for this key
  327. continue
  328. if (
  329. fetch_key_result.valid_until_ts
  330. < verify_request.minimum_valid_until_ts
  331. ):
  332. # key was not valid at this point
  333. continue
  334. with PreserveLoggingContext():
  335. verify_request.key_ready.callback(
  336. (server_name, key_id, fetch_key_result.verify_key)
  337. )
  338. completed.append(verify_request)
  339. break
  340. remaining_requests.difference_update(completed)
  341. class KeyFetcher:
  342. async def get_keys(self, keys_to_fetch):
  343. """
  344. Args:
  345. keys_to_fetch (dict[str, dict[str, int]]):
  346. the keys to be fetched. server_name -> key_id -> min_valid_ts
  347. Returns:
  348. Deferred[dict[str, dict[str, synapse.storage.keys.FetchKeyResult|None]]]:
  349. map from server_name -> key_id -> FetchKeyResult
  350. """
  351. raise NotImplementedError
  352. class StoreKeyFetcher(KeyFetcher):
  353. """KeyFetcher impl which fetches keys from our data store"""
  354. def __init__(self, hs):
  355. self.store = hs.get_datastore()
  356. async def get_keys(self, keys_to_fetch):
  357. """see KeyFetcher.get_keys"""
  358. keys_to_fetch = (
  359. (server_name, key_id)
  360. for server_name, keys_for_server in keys_to_fetch.items()
  361. for key_id in keys_for_server.keys()
  362. )
  363. res = await self.store.get_server_verify_keys(keys_to_fetch)
  364. keys = {}
  365. for (server_name, key_id), key in res.items():
  366. keys.setdefault(server_name, {})[key_id] = key
  367. return keys
  368. class BaseV2KeyFetcher:
  369. def __init__(self, hs):
  370. self.store = hs.get_datastore()
  371. self.config = hs.get_config()
  372. async def process_v2_response(self, from_server, response_json, time_added_ms):
  373. """Parse a 'Server Keys' structure from the result of a /key request
  374. This is used to parse either the entirety of the response from
  375. GET /_matrix/key/v2/server, or a single entry from the list returned by
  376. POST /_matrix/key/v2/query.
  377. Checks that each signature in the response that claims to come from the origin
  378. server is valid, and that there is at least one such signature.
  379. Stores the json in server_keys_json so that it can be used for future responses
  380. to /_matrix/key/v2/query.
  381. Args:
  382. from_server (str): the name of the server producing this result: either
  383. the origin server for a /_matrix/key/v2/server request, or the notary
  384. for a /_matrix/key/v2/query.
  385. response_json (dict): the json-decoded Server Keys response object
  386. time_added_ms (int): the timestamp to record in server_keys_json
  387. Returns:
  388. Deferred[dict[str, FetchKeyResult]]: map from key_id to result object
  389. """
  390. ts_valid_until_ms = response_json["valid_until_ts"]
  391. # start by extracting the keys from the response, since they may be required
  392. # to validate the signature on the response.
  393. verify_keys = {}
  394. for key_id, key_data in response_json["verify_keys"].items():
  395. if is_signing_algorithm_supported(key_id):
  396. key_base64 = key_data["key"]
  397. key_bytes = decode_base64(key_base64)
  398. verify_key = decode_verify_key_bytes(key_id, key_bytes)
  399. verify_keys[key_id] = FetchKeyResult(
  400. verify_key=verify_key, valid_until_ts=ts_valid_until_ms
  401. )
  402. server_name = response_json["server_name"]
  403. verified = False
  404. for key_id in response_json["signatures"].get(server_name, {}):
  405. key = verify_keys.get(key_id)
  406. if not key:
  407. # the key may not be present in verify_keys if:
  408. # * we got the key from the notary server, and:
  409. # * the key belongs to the notary server, and:
  410. # * the notary server is using a different key to sign notary
  411. # responses.
  412. continue
  413. verify_signed_json(response_json, server_name, key.verify_key)
  414. verified = True
  415. break
  416. if not verified:
  417. raise KeyLookupError(
  418. "Key response for %s is not signed by the origin server"
  419. % (server_name,)
  420. )
  421. for key_id, key_data in response_json["old_verify_keys"].items():
  422. if is_signing_algorithm_supported(key_id):
  423. key_base64 = key_data["key"]
  424. key_bytes = decode_base64(key_base64)
  425. verify_key = decode_verify_key_bytes(key_id, key_bytes)
  426. verify_keys[key_id] = FetchKeyResult(
  427. verify_key=verify_key, valid_until_ts=key_data["expired_ts"]
  428. )
  429. key_json_bytes = encode_canonical_json(response_json)
  430. await make_deferred_yieldable(
  431. defer.gatherResults(
  432. [
  433. run_in_background(
  434. self.store.store_server_keys_json,
  435. server_name=server_name,
  436. key_id=key_id,
  437. from_server=from_server,
  438. ts_now_ms=time_added_ms,
  439. ts_expires_ms=ts_valid_until_ms,
  440. key_json_bytes=key_json_bytes,
  441. )
  442. for key_id in verify_keys
  443. ],
  444. consumeErrors=True,
  445. ).addErrback(unwrapFirstError)
  446. )
  447. return verify_keys
  448. class PerspectivesKeyFetcher(BaseV2KeyFetcher):
  449. """KeyFetcher impl which fetches keys from the "perspectives" servers"""
  450. def __init__(self, hs):
  451. super(PerspectivesKeyFetcher, self).__init__(hs)
  452. self.clock = hs.get_clock()
  453. self.client = hs.get_http_client()
  454. self.key_servers = self.config.key_servers
  455. async def get_keys(self, keys_to_fetch):
  456. """see KeyFetcher.get_keys"""
  457. async def get_key(key_server):
  458. try:
  459. result = await self.get_server_verify_key_v2_indirect(
  460. keys_to_fetch, key_server
  461. )
  462. return result
  463. except KeyLookupError as e:
  464. logger.warning(
  465. "Key lookup failed from %r: %s", key_server.server_name, e
  466. )
  467. except Exception as e:
  468. logger.exception(
  469. "Unable to get key from %r: %s %s",
  470. key_server.server_name,
  471. type(e).__name__,
  472. str(e),
  473. )
  474. return {}
  475. results = await make_deferred_yieldable(
  476. defer.gatherResults(
  477. [run_in_background(get_key, server) for server in self.key_servers],
  478. consumeErrors=True,
  479. ).addErrback(unwrapFirstError)
  480. )
  481. union_of_keys = {}
  482. for result in results:
  483. for server_name, keys in result.items():
  484. union_of_keys.setdefault(server_name, {}).update(keys)
  485. return union_of_keys
  486. async def get_server_verify_key_v2_indirect(self, keys_to_fetch, key_server):
  487. """
  488. Args:
  489. keys_to_fetch (dict[str, dict[str, int]]):
  490. the keys to be fetched. server_name -> key_id -> min_valid_ts
  491. key_server (synapse.config.key.TrustedKeyServer): notary server to query for
  492. the keys
  493. Returns:
  494. dict[str, dict[str, synapse.storage.keys.FetchKeyResult]]: map
  495. from server_name -> key_id -> FetchKeyResult
  496. Raises:
  497. KeyLookupError if there was an error processing the entire response from
  498. the server
  499. """
  500. perspective_name = key_server.server_name
  501. logger.info(
  502. "Requesting keys %s from notary server %s",
  503. keys_to_fetch.items(),
  504. perspective_name,
  505. )
  506. try:
  507. query_response = await self.client.post_json(
  508. destination=perspective_name,
  509. path="/_matrix/key/v2/query",
  510. data={
  511. "server_keys": {
  512. server_name: {
  513. key_id: {"minimum_valid_until_ts": min_valid_ts}
  514. for key_id, min_valid_ts in server_keys.items()
  515. }
  516. for server_name, server_keys in keys_to_fetch.items()
  517. }
  518. },
  519. )
  520. except (NotRetryingDestination, RequestSendFailed) as e:
  521. # these both have str() representations which we can't really improve upon
  522. raise KeyLookupError(str(e))
  523. except HttpResponseException as e:
  524. raise KeyLookupError("Remote server returned an error: %s" % (e,))
  525. keys = {}
  526. added_keys = []
  527. time_now_ms = self.clock.time_msec()
  528. for response in query_response["server_keys"]:
  529. # do this first, so that we can give useful errors thereafter
  530. server_name = response.get("server_name")
  531. if not isinstance(server_name, str):
  532. raise KeyLookupError(
  533. "Malformed response from key notary server %s: invalid server_name"
  534. % (perspective_name,)
  535. )
  536. try:
  537. self._validate_perspectives_response(key_server, response)
  538. processed_response = await self.process_v2_response(
  539. perspective_name, response, time_added_ms=time_now_ms
  540. )
  541. except KeyLookupError as e:
  542. logger.warning(
  543. "Error processing response from key notary server %s for origin "
  544. "server %s: %s",
  545. perspective_name,
  546. server_name,
  547. e,
  548. )
  549. # we continue to process the rest of the response
  550. continue
  551. added_keys.extend(
  552. (server_name, key_id, key) for key_id, key in processed_response.items()
  553. )
  554. keys.setdefault(server_name, {}).update(processed_response)
  555. await self.store.store_server_verify_keys(
  556. perspective_name, time_now_ms, added_keys
  557. )
  558. return keys
  559. def _validate_perspectives_response(self, key_server, response):
  560. """Optionally check the signature on the result of a /key/query request
  561. Args:
  562. key_server (synapse.config.key.TrustedKeyServer): the notary server that
  563. produced this result
  564. response (dict): the json-decoded Server Keys response object
  565. """
  566. perspective_name = key_server.server_name
  567. perspective_keys = key_server.verify_keys
  568. if perspective_keys is None:
  569. # signature checking is disabled on this server
  570. return
  571. if (
  572. "signatures" not in response
  573. or perspective_name not in response["signatures"]
  574. ):
  575. raise KeyLookupError("Response not signed by the notary server")
  576. verified = False
  577. for key_id in response["signatures"][perspective_name]:
  578. if key_id in perspective_keys:
  579. verify_signed_json(response, perspective_name, perspective_keys[key_id])
  580. verified = True
  581. if not verified:
  582. raise KeyLookupError(
  583. "Response not signed with a known key: signed with: %r, known keys: %r"
  584. % (
  585. list(response["signatures"][perspective_name].keys()),
  586. list(perspective_keys.keys()),
  587. )
  588. )
  589. class ServerKeyFetcher(BaseV2KeyFetcher):
  590. """KeyFetcher impl which fetches keys from the origin servers"""
  591. def __init__(self, hs):
  592. super(ServerKeyFetcher, self).__init__(hs)
  593. self.clock = hs.get_clock()
  594. self.client = hs.get_http_client()
  595. async def get_keys(self, keys_to_fetch):
  596. """
  597. Args:
  598. keys_to_fetch (dict[str, iterable[str]]):
  599. the keys to be fetched. server_name -> key_ids
  600. Returns:
  601. dict[str, dict[str, synapse.storage.keys.FetchKeyResult|None]]:
  602. map from server_name -> key_id -> FetchKeyResult
  603. """
  604. results = {}
  605. async def get_key(key_to_fetch_item):
  606. server_name, key_ids = key_to_fetch_item
  607. try:
  608. keys = await self.get_server_verify_key_v2_direct(server_name, key_ids)
  609. results[server_name] = keys
  610. except KeyLookupError as e:
  611. logger.warning(
  612. "Error looking up keys %s from %s: %s", key_ids, server_name, e
  613. )
  614. except Exception:
  615. logger.exception("Error getting keys %s from %s", key_ids, server_name)
  616. await yieldable_gather_results(get_key, keys_to_fetch.items())
  617. return results
  618. async def get_server_verify_key_v2_direct(self, server_name, key_ids):
  619. """
  620. Args:
  621. server_name (str):
  622. key_ids (iterable[str]):
  623. Returns:
  624. dict[str, FetchKeyResult]: map from key ID to lookup result
  625. Raises:
  626. KeyLookupError if there was a problem making the lookup
  627. """
  628. keys = {} # type: dict[str, FetchKeyResult]
  629. for requested_key_id in key_ids:
  630. # we may have found this key as a side-effect of asking for another.
  631. if requested_key_id in keys:
  632. continue
  633. time_now_ms = self.clock.time_msec()
  634. try:
  635. response = await self.client.get_json(
  636. destination=server_name,
  637. path="/_matrix/key/v2/server/"
  638. + urllib.parse.quote(requested_key_id),
  639. ignore_backoff=True,
  640. # we only give the remote server 10s to respond. It should be an
  641. # easy request to handle, so if it doesn't reply within 10s, it's
  642. # probably not going to.
  643. #
  644. # Furthermore, when we are acting as a notary server, we cannot
  645. # wait all day for all of the origin servers, as the requesting
  646. # server will otherwise time out before we can respond.
  647. #
  648. # (Note that get_json may make 4 attempts, so this can still take
  649. # almost 45 seconds to fetch the headers, plus up to another 60s to
  650. # read the response).
  651. timeout=10000,
  652. )
  653. except (NotRetryingDestination, RequestSendFailed) as e:
  654. # these both have str() representations which we can't really improve
  655. # upon
  656. raise KeyLookupError(str(e))
  657. except HttpResponseException as e:
  658. raise KeyLookupError("Remote server returned an error: %s" % (e,))
  659. if response["server_name"] != server_name:
  660. raise KeyLookupError(
  661. "Expected a response for server %r not %r"
  662. % (server_name, response["server_name"])
  663. )
  664. response_keys = await self.process_v2_response(
  665. from_server=server_name,
  666. response_json=response,
  667. time_added_ms=time_now_ms,
  668. )
  669. await self.store.store_server_verify_keys(
  670. server_name,
  671. time_now_ms,
  672. ((server_name, key_id, key) for key_id, key in response_keys.items()),
  673. )
  674. keys.update(response_keys)
  675. return keys
  676. async def _handle_key_deferred(verify_request) -> None:
  677. """Waits for the key to become available, and then performs a verification
  678. Args:
  679. verify_request (VerifyJsonRequest):
  680. Raises:
  681. SynapseError if there was a problem performing the verification
  682. """
  683. server_name = verify_request.server_name
  684. with PreserveLoggingContext():
  685. _, key_id, verify_key = await verify_request.key_ready
  686. json_object = verify_request.json_object
  687. try:
  688. verify_signed_json(json_object, server_name, verify_key)
  689. except SignatureVerifyException as e:
  690. logger.debug(
  691. "Error verifying signature for %s:%s:%s with key %s: %s",
  692. server_name,
  693. verify_key.alg,
  694. verify_key.version,
  695. encode_verify_key_base64(verify_key),
  696. str(e),
  697. )
  698. raise SynapseError(
  699. 401,
  700. "Invalid signature for server %s with key %s:%s: %s"
  701. % (server_name, verify_key.alg, verify_key.version, str(e)),
  702. Codes.UNAUTHORIZED,
  703. )