MatrixSynapse/synapse/handlers/federation.py

771 lines
24 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2015-01-06 14:21:39 +01:00
# Copyright 2014, 2015 OpenMarket Ltd
2014-08-12 16:10: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.
2014-08-12 16:10:52 +02:00
"""Contains handlers for federation events."""
from ._base import BaseHandler
from synapse.events.utils import prune_event
from synapse.api.errors import (
AuthError, FederationError, SynapseError, StoreError,
)
2014-12-16 12:29:05 +01:00
from synapse.api.constants import EventTypes, Membership
2014-08-12 16:10:52 +02:00
from synapse.util.logutils import log_function
from synapse.util.async import run_on_reactor
2014-11-14 17:45:39 +01:00
from synapse.crypto.event_signing import (
compute_event_signature, check_event_content_hash,
add_hashes_and_signatures,
2014-11-14 17:45:39 +01:00
)
from synapse.types import UserID
2014-11-14 17:45:39 +01:00
from syutil.jsonutil import encode_canonical_json
2014-11-04 15:14:02 +01:00
from twisted.internet import defer
2014-08-12 16:10:52 +02:00
import logging
logger = logging.getLogger(__name__)
class FederationHandler(BaseHandler):
"""Handles events that originated from federation.
Responsible for:
a) handling received Pdus before handing them on as Events to the rest
of the home server (including auth and state conflict resoultion)
b) converting events that were produced by local clients that may need
to be sent to remote home servers.
c) doing the necessary dances to invite remote users and join remote
rooms.
"""
2014-08-12 16:10:52 +02:00
def __init__(self, hs):
super(FederationHandler, self).__init__(hs)
self.distributor.observe(
"user_joined_room",
self._on_user_joined
)
self.waiting_for_join_list = {}
2014-08-12 16:10:52 +02:00
self.store = hs.get_datastore()
self.replication_layer = hs.get_replication_layer()
self.state_handler = hs.get_state_handler()
# self.auth_handler = gs.get_auth_handler()
self.server_name = hs.hostname
2014-11-14 17:45:39 +01:00
self.keyring = hs.get_keyring()
self.lock_manager = hs.get_room_lock_manager()
self.replication_layer.set_handler(self)
# When joining a room we need to queue any events for that room up
self.room_queues = {}
@log_function
@defer.inlineCallbacks
def handle_new_event(self, event, destinations):
""" Takes in an event from the client to server side, that has already
been authed and handled by the state module, and sends it to any
remote home servers that may be interested.
Args:
event: The event to send
destinations: A list of destinations to send it to
Returns:
Deferred: Resolved when it has successfully been queued for
processing.
"""
yield run_on_reactor()
self.replication_layer.send_pdu(event, destinations)
@log_function
@defer.inlineCallbacks
def on_receive_pdu(self, origin, pdu, backfilled, state=None,
auth_chain=None):
""" Called by the ReplicationLayer when we have a new pdu. We need to
do auth checks and put it through the StateHandler.
"""
2014-11-14 22:25:02 +01:00
event = pdu
2014-09-15 16:18:51 +02:00
logger.debug("Got event: %s", event.event_id)
# If we are currently in the process of joining this room, then we
# queue up events for later processing.
if event.room_id in self.room_queues:
2014-11-27 15:46:33 +01:00
self.room_queues[event.room_id].append((pdu, origin))
return
logger.debug("Processing event: %s", event.event_id)
2014-11-14 17:45:39 +01:00
redacted_event = prune_event(event)
2014-11-14 22:25:02 +01:00
redacted_pdu_json = redacted_event.get_pdu_json()
2014-11-14 17:45:39 +01:00
try:
yield self.keyring.verify_json_for_server(
event.origin, redacted_pdu_json
)
except SynapseError as e:
2014-11-20 18:26:36 +01:00
logger.warn(
"Signature check failed for %s redacted to %s",
2014-11-14 22:25:02 +01:00
encode_canonical_json(pdu.get_pdu_json()),
2014-11-14 17:45:39 +01:00
encode_canonical_json(redacted_pdu_json),
)
raise FederationError(
"ERROR",
e.code,
e.msg,
affected=event.event_id,
)
2014-11-14 20:10:52 +01:00
if not check_event_content_hash(event):
2014-11-14 17:45:39 +01:00
logger.warn(
2014-11-14 20:10:52 +01:00
"Event content has been tampered, redacting %s, %s",
2014-12-11 18:01:27 +01:00
event.event_id, encode_canonical_json(event.get_dict())
2014-11-14 17:45:39 +01:00
)
event = redacted_event
logger.debug("Event: %s", event)
# FIXME (erikj): Awful hack to make the case where we are not currently
# in the room work
current_state = None
is_in_room = yield self.auth.check_host_in_room(
event.room_id,
self.server_name
)
2014-12-08 10:08:26 +01:00
if not is_in_room and not event.internal_metadata.outlier:
logger.debug("Got event for room we're not in.")
replication = self.replication_layer
if not state:
state, auth_chain = yield replication.get_state_for_room(
origin, context=event.room_id, event_id=event.event_id,
)
if not auth_chain:
auth_chain = yield replication.get_event_auth(
origin,
context=event.room_id,
event_id=event.event_id,
)
for e in auth_chain:
2014-12-08 10:08:26 +01:00
e.internal_metadata.outlier = True
try:
yield self._handle_new_event(e, fetch_auth_from=origin)
except:
logger.exception(
"Failed to handle auth event %s",
e.event_id,
)
current_state = state
if state:
for e in state:
logging.info("A :) %r", e)
2014-12-08 10:08:26 +01:00
e.internal_metadata.outlier = True
try:
yield self._handle_new_event(e)
except:
logger.exception(
"Failed to handle state event %s",
e.event_id,
)
2014-11-04 16:10:43 +01:00
try:
yield self._handle_new_event(
event,
state=state,
backfilled=backfilled,
current_state=current_state,
)
2014-11-04 16:10:43 +01:00
except AuthError as e:
raise FederationError(
"ERROR",
e.code,
e.msg,
affected=event.event_id,
)
2014-12-16 16:24:03 +01:00
# if we're receiving valid events from an origin,
# it's probably a good idea to mark it as not in retry-state
# for sending (although this is a bit of a leap)
retry_timings = yield self.store.get_destination_retry_timings(origin)
if (retry_timings and retry_timings.retry_last_ts):
self.store.set_destination_retry_timings(origin, 0, 0)
room = yield self.store.get_room(event.room_id)
2014-08-12 16:10:52 +02:00
if not room:
try:
yield self.store.store_room(
room_id=event.room_id,
room_creator_user_id="",
is_public=False,
)
except StoreError:
logger.exception("Failed to store room.")
2014-08-19 15:20:03 +02:00
if not backfilled:
extra_users = []
2014-12-16 12:29:05 +01:00
if event.type == EventTypes.Member:
target_user_id = event.state_key
target_user = UserID.from_string(target_user_id)
extra_users.append(target_user)
yield self.notifier.on_new_room_event(
event, extra_users=extra_users
)
2014-12-16 12:29:05 +01:00
if event.type == EventTypes.Member:
if event.membership == Membership.JOIN:
user = UserID.from_string(event.state_key)
yield self.distributor.fire(
"user_joined_room", user=user, room_id=event.room_id
)
2014-08-19 15:20:03 +02:00
@log_function
@defer.inlineCallbacks
def backfill(self, dest, room_id, limit):
""" Trigger a backfill request to `dest` for the given `room_id`
"""
extremities = yield self.store.get_oldest_events_in_room(room_id)
pdus = yield self.replication_layer.backfill(
dest,
room_id,
limit,
extremities=extremities,
)
events = []
for pdu in pdus:
2014-11-14 22:25:02 +01:00
event = pdu
# FIXME (erikj): Not sure this actually works :/
context = yield self.state_handler.compute_event_context(event)
2014-12-16 16:24:03 +01:00
events.append((event, context))
2014-12-08 10:08:26 +01:00
yield self.store.persist_event(
event,
context=context,
backfilled=True
)
defer.returnValue(events)
@defer.inlineCallbacks
def send_invite(self, target_host, event):
""" Sends the invite to the remote server for signing.
Invites must be signed by the invitee's server before distribution.
"""
pdu = yield self.replication_layer.send_invite(
destination=target_host,
room_id=event.room_id,
event_id=event.event_id,
2014-11-14 22:25:02 +01:00
pdu=event
)
2014-11-14 22:25:02 +01:00
defer.returnValue(pdu)
2014-11-07 16:35:53 +01:00
@defer.inlineCallbacks
def on_event_auth(self, event_id):
auth = yield self.store.get_auth_chain([event_id])
for event in auth:
event.signatures.update(
compute_event_signature(
event,
self.hs.hostname,
self.hs.config.signing_key[0]
)
)
2014-11-14 22:25:02 +01:00
defer.returnValue([e for e in auth])
2014-11-07 16:35:53 +01:00
@log_function
@defer.inlineCallbacks
def do_invite_join(self, target_host, room_id, joinee, content, snapshot):
""" Attempts to join the `joinee` to the room `room_id` via the
server `target_host`.
This first triggers a /make_join/ request that returns a partial
event that we can fill out and sign. This is then sent to the
remote server via /send_join/ which responds with the state at that
event and the auth_chains.
We suspend processing of any received events from this room until we
have finished processing the join.
"""
logger.debug("Joining %s to %s", joinee, room_id)
pdu = yield self.replication_layer.make_join(
target_host,
room_id,
joinee
)
logger.debug("Got response to make_join: %s", pdu)
2014-11-14 22:25:02 +01:00
event = pdu
# We should assert some things.
2014-12-16 12:29:05 +01:00
# FIXME: Do this in a nicer way
assert(event.type == EventTypes.Member)
assert(event.user_id == joinee)
assert(event.state_key == joinee)
assert(event.room_id == room_id)
2014-12-08 10:08:26 +01:00
event.internal_metadata.outlier = False
self.room_queues[room_id] = []
2014-12-08 18:50:56 +01:00
builder = self.event_builder_factory.new(
event.get_pdu_json()
)
handled_events = set()
try:
builder.event_id = self.event_builder_factory.create_event_id()
2014-12-08 18:50:56 +01:00
builder.origin = self.hs.hostname
builder.content = content
2014-09-03 20:13:41 +02:00
if not hasattr(event, "signatures"):
2014-12-08 18:50:56 +01:00
builder.signatures = {}
add_hashes_and_signatures(
2014-12-08 18:50:56 +01:00
builder,
self.hs.hostname,
self.hs.config.signing_key[0],
)
2014-12-08 18:50:56 +01:00
new_event = builder.build()
ret = yield self.replication_layer.send_join(
target_host,
2014-12-08 18:50:56 +01:00
new_event
)
state = ret["state"]
auth_chain = ret["auth_chain"]
auth_chain.sort(key=lambda e: e.depth)
handled_events.update([s.event_id for s in state])
handled_events.update([a.event_id for a in auth_chain])
handled_events.add(new_event.event_id)
logger.debug("do_invite_join auth_chain: %s", auth_chain)
logger.debug("do_invite_join state: %s", state)
2014-12-08 18:50:56 +01:00
logger.debug("do_invite_join event: %s", new_event)
try:
yield self.store.store_room(
room_id=room_id,
room_creator_user_id="",
is_public=False
)
except:
# FIXME
pass
for e in auth_chain:
2014-12-08 10:08:26 +01:00
e.internal_metadata.outlier = True
try:
yield self._handle_new_event(e)
except:
logger.exception(
"Failed to handle auth event %s",
e.event_id,
)
for e in state:
# FIXME: Auth these.
2014-12-08 10:08:26 +01:00
e.internal_metadata.outlier = True
try:
yield self._handle_new_event(
e, fetch_auth_from=target_host
)
except:
logger.exception(
"Failed to handle state event %s",
e.event_id,
)
yield self._handle_new_event(
2014-12-08 18:50:56 +01:00
new_event,
state=state,
current_state=state,
)
yield self.notifier.on_new_room_event(
2014-12-08 18:50:56 +01:00
new_event, extra_users=[joinee]
)
logger.debug("Finished joining %s to %s", joinee, room_id)
finally:
room_queue = self.room_queues[room_id]
del self.room_queues[room_id]
2014-11-27 15:46:33 +01:00
for p, origin in room_queue:
if p.event_id in handled_events:
continue
try:
2014-11-27 15:46:33 +01:00
self.on_receive_pdu(origin, p, backfilled=False)
except:
logger.exception("Couldn't handle pdu")
defer.returnValue(True)
@defer.inlineCallbacks
@log_function
def on_make_join_request(self, room_id, user_id):
""" We've received a /make_join/ request, so we create a partial
join event for the room and return that. We don *not* persist or
process it until the other server has signed it and sent it back.
"""
builder = self.event_builder_factory.new({
2014-12-16 12:29:05 +01:00
"type": EventTypes.Member,
"content": {"membership": Membership.JOIN},
"room_id": room_id,
"sender": user_id,
"state_key": user_id,
})
event, context = yield self._create_new_client_event(
builder=builder,
)
self.auth.check(event, auth_events=context.auth_events)
2014-11-14 22:25:02 +01:00
pdu = event
defer.returnValue(pdu)
@defer.inlineCallbacks
@log_function
def on_send_join_request(self, origin, pdu):
""" We have received a join event for a room. Fully process it and
respond with the current state and auth chains.
"""
2014-11-14 22:25:02 +01:00
event = pdu
logger.debug(
"on_send_join_request: Got event: %s, signatures: %s",
event.event_id,
event.signatures,
)
2014-12-08 10:08:26 +01:00
event.internal_metadata.outlier = False
2014-12-08 18:50:56 +01:00
context = yield self._handle_new_event(event)
logger.debug(
"on_send_join_request: After _handle_new_event: %s, sigs: %s",
event.event_id,
event.signatures,
)
extra_users = []
2014-12-16 12:29:05 +01:00
if event.type == EventTypes.Member:
target_user_id = event.state_key
target_user = UserID.from_string(target_user_id)
extra_users.append(target_user)
yield self.notifier.on_new_room_event(
event, extra_users=extra_users
)
2014-12-16 12:29:05 +01:00
if event.type == EventTypes.Member:
if event.content["membership"] == Membership.JOIN:
user = UserID.from_string(event.state_key)
yield self.distributor.fire(
"user_joined_room", user=user, room_id=event.room_id
)
2014-11-14 22:25:02 +01:00
new_pdu = event
destinations = set()
2014-12-08 18:50:56 +01:00
for k, s in context.current_state.items():
try:
2014-12-16 12:29:05 +01:00
if k[0] == EventTypes.Member:
if s.content["membership"] == Membership.JOIN:
destinations.add(
UserID.from_string(s.state_key).domain
)
except:
logger.warn(
"Failed to get destination from event %s", s.event_id
)
logger.debug(
"on_send_join_request: Sending event: %s, signatures: %s",
event.event_id,
event.signatures,
)
self.replication_layer.send_pdu(new_pdu, destinations)
state_ids = [e.event_id for e in context.current_state.values()]
auth_chain = yield self.store.get_auth_chain(set(
[event.event_id] + state_ids
))
defer.returnValue({
2014-12-08 18:50:56 +01:00
"state": context.current_state.values(),
2014-11-14 22:25:02 +01:00
"auth_chain": auth_chain,
})
@defer.inlineCallbacks
def on_invite_request(self, origin, pdu):
""" We've got an invite event. Process and persist it. Sign it.
Respond with the now signed event.
"""
2014-11-14 22:25:02 +01:00
event = pdu
event.internal_metadata.outlier = True
event.signatures.update(
compute_event_signature(
event,
self.hs.hostname,
self.hs.config.signing_key[0]
)
)
context = yield self.state_handler.compute_event_context(event)
yield self.store.persist_event(
event,
context=context,
backfilled=False,
)
target_user = UserID.from_string(event.state_key)
2014-11-10 12:15:02 +01:00
yield self.notifier.on_new_room_event(
event, extra_users=[target_user],
)
2014-11-14 22:25:02 +01:00
defer.returnValue(event)
@defer.inlineCallbacks
def get_state_for_pdu(self, origin, room_id, event_id):
yield run_on_reactor()
in_room = yield self.auth.check_host_in_room(room_id, origin)
if not in_room:
raise AuthError(403, "Host not in room.")
state_groups = yield self.store.get_state_groups(
[event_id]
)
if state_groups:
_, state = state_groups.items().pop()
results = {
(e.type, e.state_key): e for e in state
}
event = yield self.store.get_event(event_id)
if event and event.is_state():
# Get previous state
if "replaces_state" in event.unsigned:
prev_id = event.unsigned["replaces_state"]
if prev_id != event.event_id:
prev_event = yield self.store.get_event(prev_id)
results[(event.type, event.state_key)] = prev_event
else:
del results[(event.type, event.state_key)]
res = results.values()
for event in res:
event.signatures.update(
compute_event_signature(
event,
self.hs.hostname,
self.hs.config.signing_key[0]
)
)
defer.returnValue(res)
else:
defer.returnValue([])
@defer.inlineCallbacks
@log_function
def on_backfill_request(self, origin, room_id, pdu_list, limit):
in_room = yield self.auth.check_host_in_room(room_id, origin)
if not in_room:
raise AuthError(403, "Host not in room.")
events = yield self.store.get_backfill_events(
2015-01-07 17:18:12 +01:00
room_id,
pdu_list,
limit
)
2014-11-14 22:25:02 +01:00
defer.returnValue(events)
2014-10-31 11:47:34 +01:00
@defer.inlineCallbacks
@log_function
def get_persisted_pdu(self, origin, event_id, do_auth=True):
2014-10-31 11:47:34 +01:00
""" Get a PDU from the database with given origin and id.
Returns:
Deferred: Results in a `Pdu`.
"""
event = yield self.store.get_event(
event_id,
2014-10-31 11:47:34 +01:00
allow_none=True,
)
if event:
# FIXME: This is a temporary work around where we occasionally
# return events slightly differently than when they were
# originally signed
event.signatures.update(
compute_event_signature(
event,
self.hs.hostname,
self.hs.config.signing_key[0]
)
)
if do_auth:
in_room = yield self.auth.check_host_in_room(
event.room_id,
origin
)
if not in_room:
raise AuthError(403, "Host not in room.")
2014-11-14 22:25:02 +01:00
defer.returnValue(event)
2014-10-31 11:47:34 +01:00
else:
defer.returnValue(None)
@log_function
def get_min_depth_for_context(self, context):
return self.store.get_min_depth(context)
@log_function
def _on_user_joined(self, user, room_id):
2014-11-10 14:46:44 +01:00
waiters = self.waiting_for_join_list.get(
(user.to_string(), room_id),
[]
)
while waiters:
waiters.pop().callback(None)
@defer.inlineCallbacks
def _handle_new_event(self, event, state=None, backfilled=False,
current_state=None, fetch_auth_from=None):
logger.debug(
"_handle_new_event: Before annotate: %s, sigs: %s",
event.event_id, event.signatures,
)
context = yield self.state_handler.compute_event_context(
event, old_state=state
)
logger.debug(
"_handle_new_event: Before auth fetch: %s, sigs: %s",
event.event_id, event.signatures,
)
2014-12-10 13:00:05 +01:00
is_new_state = not event.internal_metadata.is_outlier()
2014-12-08 10:08:26 +01:00
known_ids = set(
[s.event_id for s in context.auth_events.values()]
)
2014-12-08 10:08:26 +01:00
for e_id, _ in event.auth_events:
if e_id not in known_ids:
e = yield self.store.get_event(e_id, allow_none=True)
if not e and fetch_auth_from is not None:
# Grab the auth_chain over federation if we are missing
# auth events.
auth_chain = yield self.replication_layer.get_event_auth(
fetch_auth_from, event.event_id, event.room_id
)
for auth_event in auth_chain:
yield self._handle_new_event(auth_event)
e = yield self.store.get_event(e_id, allow_none=True)
if not e:
2014-12-08 10:08:26 +01:00
# TODO: Do some conflict res to make sure that we're
# not the ones who are wrong.
logger.info(
"Rejecting %s as %s not in db or %s",
2014-12-08 10:08:26 +01:00
event.event_id, e_id, known_ids,
)
# FIXME: How does raising AuthError work with federation?
raise AuthError(403, "Cannot find auth event")
2014-12-08 10:08:26 +01:00
context.auth_events[(e.type, e.state_key)] = e
logger.debug(
"_handle_new_event: Before hack: %s, sigs: %s",
event.event_id, event.signatures,
)
2014-12-16 12:29:05 +01:00
if event.type == EventTypes.Member and not event.auth_events:
2014-12-08 10:08:26 +01:00
if len(event.prev_events) == 1:
c = yield self.store.get_event(event.prev_events[0][0])
2014-12-16 12:29:05 +01:00
if c.type == EventTypes.Create:
2014-12-08 10:08:26 +01:00
context.auth_events[(c.type, c.state_key)] = c
logger.debug(
"_handle_new_event: Before auth check: %s, sigs: %s",
event.event_id, event.signatures,
)
2014-12-08 10:08:26 +01:00
self.auth.check(event, auth_events=context.auth_events)
logger.debug(
"_handle_new_event: Before persist_event: %s, sigs: %s",
event.event_id, event.signatures,
)
yield self.store.persist_event(
event,
2014-12-08 18:50:56 +01:00
context=context,
backfilled=backfilled,
is_new_state=(is_new_state and not backfilled),
current_state=current_state,
)
2014-12-08 18:50:56 +01:00
logger.debug(
"_handle_new_event: After persist_event: %s, sigs: %s",
event.event_id, event.signatures,
)
2014-12-08 18:50:56 +01:00
defer.returnValue(context)