forked-synapse/synapse/federation/federation_base.py

163 lines
4.8 KiB
Python
Raw Normal View History

2015-02-03 10:00:42 -05:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2015, 2016 OpenMarket Ltd
2015-02-03 10:00:42 -05: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.
from twisted.internet import defer
from synapse.events.utils import prune_event
2015-02-03 10:00:42 -05:00
from synapse.crypto.event_signing import check_event_content_hash
from synapse.api.errors import SynapseError
2015-05-12 08:14:29 -04:00
from synapse.util import unwrapFirstError
2016-08-23 10:23:39 -04:00
from synapse.util.logcontext import preserve_fn, preserve_context_over_deferred
2015-05-12 08:14:29 -04:00
2015-02-03 10:00:42 -05:00
import logging
logger = logging.getLogger(__name__)
class FederationBase(object):
def __init__(self, hs):
pass
2015-02-03 10:00:42 -05:00
@defer.inlineCallbacks
2015-06-26 04:52:24 -04:00
def _check_sigs_and_hash_and_fetch(self, origin, pdus, outlier=False,
include_none=False):
2015-02-03 10:00:42 -05:00
"""Takes a list of PDUs and checks the signatures and hashs of each
one. If a PDU fails its signature check then we check if we have it in
the database and if not then request if from the originating server of
that PDU.
If a PDU fails its content hash check then it is redacted.
The given list of PDUs are not modified, instead the function returns
a new list.
Args:
pdu (list)
outlier (bool)
Returns:
Deferred : A list of PDUs that have valid signatures and hashes.
"""
2015-06-26 04:52:24 -04:00
deferreds = self._check_sigs_and_hashes(pdus)
2015-02-12 13:35:36 -05:00
2015-06-26 04:52:24 -04:00
def callback(pdu):
return pdu
2015-02-12 13:35:36 -05:00
2015-06-26 04:52:24 -04:00
def errback(failure, pdu):
failure.trap(SynapseError)
return None
2015-02-03 10:00:42 -05:00
2015-06-26 04:52:24 -04:00
def try_local_db(res, pdu):
if not res:
2015-02-03 10:00:42 -05:00
# Check local db.
2015-06-26 04:52:24 -04:00
return self.store.get_event(
2015-02-03 10:00:42 -05:00
pdu.event_id,
allow_rejected=True,
allow_none=True,
2015-02-03 10:00:42 -05:00
)
2015-06-26 04:52:24 -04:00
return res
def try_remote(res, pdu):
if not res and pdu.origin != origin:
return self.get_pdu(
destinations=[pdu.origin],
event_id=pdu.event_id,
outlier=outlier,
timeout=10000,
).addErrback(lambda e: None)
return res
def warn(res, pdu):
if not res:
2015-02-12 14:29:43 -05:00
logger.warn(
"Failed to find copy of %s with valid signature",
pdu.event_id,
)
2015-06-26 04:52:24 -04:00
return res
for pdu, deferred in zip(pdus, deferreds):
deferred.addCallbacks(
callback, errback, errbackArgs=[pdu]
).addCallback(
try_local_db, pdu
).addCallback(
try_remote, pdu
).addCallback(
warn, pdu
)
2015-02-03 10:00:42 -05:00
2016-08-23 10:23:39 -04:00
valid_pdus = yield preserve_context_over_deferred(defer.gatherResults(
2015-06-26 04:52:24 -04:00
deferreds,
2015-02-12 13:35:36 -05:00
consumeErrors=True
2016-08-23 10:23:39 -04:00
)).addErrback(unwrapFirstError)
2015-02-12 13:35:36 -05:00
2015-06-26 04:52:24 -04:00
if include_none:
defer.returnValue(valid_pdus)
else:
defer.returnValue([p for p in valid_pdus if p])
2015-02-03 10:00:42 -05:00
def _check_sigs_and_hash(self, pdu):
2015-06-26 04:52:24 -04:00
return self._check_sigs_and_hashes([pdu])[0]
def _check_sigs_and_hashes(self, pdus):
"""Throws a SynapseError if a PDU does not have the correct
2015-02-03 10:00:42 -05:00
signatures.
Returns:
FrozenEvent: Either the given event or it redacted if it failed the
content hash check.
"""
2015-06-26 04:52:24 -04:00
redacted_pdus = [
prune_event(pdu)
for pdu in pdus
]
2016-08-23 10:23:39 -04:00
deferreds = preserve_fn(self.keyring.verify_json_objects_for_server)([
2015-06-26 04:52:24 -04:00
(p.origin, p.get_pdu_json())
for p in redacted_pdus
])
def callback(_, pdu, redacted):
if not check_event_content_hash(pdu):
logger.warn(
"Event content has been tampered, redacting %s: %s",
pdu.event_id, pdu.get_pdu_json()
)
return redacted
return pdu
def errback(failure, pdu):
failure.trap(SynapseError)
2015-02-03 10:00:42 -05:00
logger.warn(
2015-06-02 09:39:15 -04:00
"Signature check failed for %s",
pdu.event_id,
2015-02-03 10:00:42 -05:00
)
2015-06-26 04:52:24 -04:00
return failure
2015-02-03 10:00:42 -05:00
2015-06-26 04:52:24 -04:00
for deferred, pdu, redacted in zip(deferreds, pdus, redacted_pdus):
deferred.addCallbacks(
callback, errback,
callbackArgs=[pdu, redacted],
errbackArgs=[pdu],
2015-02-03 10:00:42 -05:00
)
2015-06-26 04:52:24 -04:00
return deferreds