2014-10-14 13:54:26 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 11:26:48 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2023-11-21 20:29:58 +00:00
|
|
|
# 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]
|
2014-10-14 13:54:26 +00:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
2023-02-10 23:29:00 +00:00
|
|
|
from typing import Collection, Dict, List, Mapping, Tuple
|
2020-09-01 12:39:04 +00:00
|
|
|
|
2015-08-24 15:17:38 +00:00
|
|
|
from unpaddedbase64 import encode_base64
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2022-01-21 09:18:10 +00:00
|
|
|
from synapse.crypto.event_signing import compute_event_reference_hash
|
|
|
|
from synapse.storage.databases.main.events_worker import (
|
|
|
|
EventRedactBehaviour,
|
|
|
|
EventsWorkerStore,
|
|
|
|
)
|
2016-05-31 14:32:32 +00:00
|
|
|
from synapse.util.caches.descriptors import cached, cachedList
|
2014-12-04 11:27:59 +00:00
|
|
|
|
2014-10-14 13:54:26 +00:00
|
|
|
|
2022-01-21 09:18:10 +00:00
|
|
|
class SignatureWorkerStore(EventsWorkerStore):
|
2016-08-19 10:59:29 +00:00
|
|
|
@cached()
|
2023-02-10 23:29:00 +00:00
|
|
|
def get_event_reference_hash(self, event_id: str) -> Mapping[str, bytes]:
|
2018-03-01 16:40:27 +00:00
|
|
|
# This is a dummy function to allow get_event_reference_hashes
|
|
|
|
# to use its cache
|
|
|
|
raise NotImplementedError()
|
2016-05-31 14:32:32 +00:00
|
|
|
|
2019-04-03 09:07:29 +00:00
|
|
|
@cachedList(
|
|
|
|
cached_method_name="get_event_reference_hash", list_name="event_ids", num_args=1
|
|
|
|
)
|
2020-09-01 12:39:04 +00:00
|
|
|
async def get_event_reference_hashes(
|
2022-01-21 09:18:10 +00:00
|
|
|
self, event_ids: Collection[str]
|
2023-02-10 23:29:00 +00:00
|
|
|
) -> Mapping[str, Mapping[str, bytes]]:
|
2020-09-01 12:39:04 +00:00
|
|
|
"""Get all hashes for given events.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
event_ids: The event IDs to get hashes for.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
A mapping of event ID to a mapping of algorithm to hash.
|
2022-01-21 09:18:10 +00:00
|
|
|
Returns an empty dict for a given event id if that event is unknown.
|
2020-09-01 12:39:04 +00:00
|
|
|
"""
|
2022-01-21 09:18:10 +00:00
|
|
|
events = await self.get_events(
|
|
|
|
event_ids,
|
2022-05-04 11:26:11 +00:00
|
|
|
redact_behaviour=EventRedactBehaviour.as_is,
|
2022-01-21 09:18:10 +00:00
|
|
|
allow_rejected=True,
|
|
|
|
)
|
2020-09-01 12:39:04 +00:00
|
|
|
|
2022-01-21 09:18:10 +00:00
|
|
|
hashes: Dict[str, Dict[str, bytes]] = {}
|
|
|
|
for event_id in event_ids:
|
|
|
|
event = events.get(event_id)
|
|
|
|
if event is None:
|
|
|
|
hashes[event_id] = {}
|
|
|
|
else:
|
|
|
|
ref_alg, ref_hash_bytes = compute_event_reference_hash(event)
|
|
|
|
hashes[event_id] = {ref_alg: ref_hash_bytes}
|
2014-11-06 18:42:18 +00:00
|
|
|
|
2022-01-21 09:18:10 +00:00
|
|
|
return hashes
|
2014-11-06 18:42:18 +00:00
|
|
|
|
2020-09-01 12:39:04 +00:00
|
|
|
async def add_event_hashes(
|
2022-01-21 09:18:10 +00:00
|
|
|
self, event_ids: Collection[str]
|
2020-09-01 12:39:04 +00:00
|
|
|
) -> List[Tuple[str, Dict[str, str]]]:
|
|
|
|
"""
|
|
|
|
|
|
|
|
Args:
|
|
|
|
event_ids: The event IDs
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
A list of tuples of event ID and a mapping of algorithm to base-64 encoded hash.
|
|
|
|
"""
|
2020-08-07 16:17:17 +00:00
|
|
|
hashes = await self.get_event_reference_hashes(event_ids)
|
2021-11-11 17:04:44 +00:00
|
|
|
encoded_hashes = {
|
2019-04-03 09:07:29 +00:00
|
|
|
e_id: {k: encode_base64(v) for k, v in h.items() if k == "sha256"}
|
2016-05-31 14:32:32 +00:00
|
|
|
for e_id, h in hashes.items()
|
|
|
|
}
|
2014-12-04 11:27:59 +00:00
|
|
|
|
2021-11-11 17:04:44 +00:00
|
|
|
return list(encoded_hashes.items())
|
2014-12-04 11:27:59 +00:00
|
|
|
|
2018-03-01 14:16:02 +00:00
|
|
|
|
|
|
|
class SignatureStore(SignatureWorkerStore):
|
|
|
|
"""Persistence for event signatures and hashes"""
|