2019-01-21 23:27:57 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2019 New Vector Ltd
|
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
import logging
|
|
|
|
|
2019-01-27 23:24:17 +00:00
|
|
|
import attr
|
2019-01-21 23:27:57 +00:00
|
|
|
from zope.interface import implementer
|
|
|
|
|
|
|
|
from twisted.internet import defer
|
|
|
|
from twisted.internet.endpoints import HostnameEndpoint, wrapClientTLS
|
|
|
|
from twisted.web.client import URI, Agent, HTTPConnectionPool
|
2019-01-25 12:38:16 +00:00
|
|
|
from twisted.web.http_headers import Headers
|
2019-01-21 23:27:57 +00:00
|
|
|
from twisted.web.iweb import IAgent
|
|
|
|
|
2019-01-22 17:42:26 +00:00
|
|
|
from synapse.http.federation.srv_resolver import SrvResolver, pick_server_from_list
|
2019-01-21 23:27:57 +00:00
|
|
|
from synapse.util.logcontext import make_deferred_yieldable
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
@implementer(IAgent)
|
|
|
|
class MatrixFederationAgent(object):
|
|
|
|
"""An Agent-like thing which provides a `request` method which will look up a matrix
|
|
|
|
server and send an HTTP request to it.
|
|
|
|
|
|
|
|
Doesn't implement any retries. (Those are done in MatrixFederationHttpClient.)
|
|
|
|
|
|
|
|
Args:
|
|
|
|
reactor (IReactor): twisted reactor to use for underlying requests
|
2019-01-22 17:42:26 +00:00
|
|
|
|
2019-01-21 23:27:57 +00:00
|
|
|
tls_client_options_factory (ClientTLSOptionsFactory|None):
|
|
|
|
factory to use for fetching client tls options, or none to disable TLS.
|
2019-01-22 17:42:26 +00:00
|
|
|
|
|
|
|
srv_resolver (SrvResolver|None):
|
|
|
|
SRVResolver impl to use for looking up SRV records. None to use a default
|
|
|
|
implementation.
|
2019-01-21 23:27:57 +00:00
|
|
|
"""
|
|
|
|
|
2019-01-22 17:42:26 +00:00
|
|
|
def __init__(
|
|
|
|
self, reactor, tls_client_options_factory, _srv_resolver=None,
|
|
|
|
):
|
2019-01-21 23:27:57 +00:00
|
|
|
self._reactor = reactor
|
|
|
|
self._tls_client_options_factory = tls_client_options_factory
|
2019-01-22 17:42:26 +00:00
|
|
|
if _srv_resolver is None:
|
|
|
|
_srv_resolver = SrvResolver()
|
|
|
|
self._srv_resolver = _srv_resolver
|
2019-01-21 23:27:57 +00:00
|
|
|
|
|
|
|
self._pool = HTTPConnectionPool(reactor)
|
|
|
|
self._pool.retryAutomatically = False
|
|
|
|
self._pool.maxPersistentPerHost = 5
|
|
|
|
self._pool.cachedConnectionTimeout = 2 * 60
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def request(self, method, uri, headers=None, bodyProducer=None):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
method (bytes): HTTP method: GET/POST/etc
|
|
|
|
|
|
|
|
uri (bytes): Absolute URI to be retrieved
|
|
|
|
|
|
|
|
headers (twisted.web.http_headers.Headers|None):
|
|
|
|
HTTP headers to send with the request, or None to
|
|
|
|
send no extra headers.
|
|
|
|
|
|
|
|
bodyProducer (twisted.web.iweb.IBodyProducer|None):
|
|
|
|
An object which can generate bytes to make up the
|
|
|
|
body of this request (for example, the properly encoded contents of
|
|
|
|
a file for a file upload). Or None if the request is to have
|
|
|
|
no body.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Deferred[twisted.web.iweb.IResponse]:
|
|
|
|
fires when the header of the response has been received (regardless of the
|
|
|
|
response status code). Fails if there is any problem which prevents that
|
|
|
|
response from being received (including problems that prevent the request
|
|
|
|
from being sent).
|
|
|
|
"""
|
2019-01-28 09:56:59 +00:00
|
|
|
parsed_uri = URI.fromBytes(uri, defaultPort=-1)
|
2019-01-27 23:24:17 +00:00
|
|
|
res = yield self._route_matrix_uri(parsed_uri)
|
2019-01-21 23:27:57 +00:00
|
|
|
|
2019-01-27 23:24:17 +00:00
|
|
|
# set up the TLS connection params
|
|
|
|
#
|
2019-01-21 23:27:57 +00:00
|
|
|
# XXX disabling TLS is really only supported here for the benefit of the
|
|
|
|
# unit tests. We should make the UTs cope with TLS rather than having to make
|
|
|
|
# the code support the unit tests.
|
|
|
|
if self._tls_client_options_factory is None:
|
|
|
|
tls_options = None
|
|
|
|
else:
|
2019-01-28 09:56:59 +00:00
|
|
|
tls_options = self._tls_client_options_factory.get_options(
|
2019-01-27 23:24:17 +00:00
|
|
|
res.tls_server_name.decode("ascii")
|
2019-01-28 09:56:59 +00:00
|
|
|
)
|
2019-01-21 23:27:57 +00:00
|
|
|
|
2019-01-25 12:38:16 +00:00
|
|
|
# make sure that the Host header is set correctly
|
|
|
|
if headers is None:
|
|
|
|
headers = Headers()
|
|
|
|
else:
|
|
|
|
headers = headers.copy()
|
|
|
|
|
|
|
|
if not headers.hasHeader(b'host'):
|
2019-01-27 23:24:17 +00:00
|
|
|
headers.addRawHeader(b'host', res.host_header)
|
2019-01-25 12:38:16 +00:00
|
|
|
|
2019-01-21 23:27:57 +00:00
|
|
|
class EndpointFactory(object):
|
|
|
|
@staticmethod
|
|
|
|
def endpointForURI(_uri):
|
2019-01-27 23:24:17 +00:00
|
|
|
logger.info("Connecting to %s:%s", res.target_host, res.target_port)
|
|
|
|
ep = HostnameEndpoint(self._reactor, res.target_host, res.target_port)
|
2019-01-21 23:27:57 +00:00
|
|
|
if tls_options is not None:
|
|
|
|
ep = wrapClientTLS(tls_options, ep)
|
|
|
|
return ep
|
|
|
|
|
|
|
|
agent = Agent.usingEndpointFactory(self._reactor, EndpointFactory(), self._pool)
|
|
|
|
res = yield make_deferred_yieldable(
|
|
|
|
agent.request(method, uri, headers, bodyProducer)
|
|
|
|
)
|
|
|
|
defer.returnValue(res)
|
2019-01-27 23:24:17 +00:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def _route_matrix_uri(self, parsed_uri):
|
|
|
|
"""Helper for `request`: determine the routing for a Matrix URI
|
|
|
|
|
|
|
|
Args:
|
|
|
|
parsed_uri (twisted.web.client.URI): uri to route. Note that it should be
|
|
|
|
parsed with URI.fromBytes(uri, defaultPort=-1) to set the `port` to -1
|
|
|
|
if there is no explicit port given.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Deferred[_RoutingResult]
|
|
|
|
"""
|
|
|
|
if parsed_uri.port != -1:
|
|
|
|
# there is an explicit port
|
|
|
|
defer.returnValue(_RoutingResult(
|
|
|
|
host_header=parsed_uri.netloc,
|
|
|
|
tls_server_name=parsed_uri.host,
|
|
|
|
target_host=parsed_uri.host,
|
|
|
|
target_port=parsed_uri.port,
|
|
|
|
))
|
|
|
|
|
|
|
|
# try a SRV lookup
|
|
|
|
service_name = b"_matrix._tcp.%s" % (parsed_uri.host,)
|
|
|
|
server_list = yield self._srv_resolver.resolve_service(service_name)
|
|
|
|
|
|
|
|
if not server_list:
|
|
|
|
target_host = parsed_uri.host
|
|
|
|
port = 8448
|
|
|
|
logger.debug(
|
|
|
|
"No SRV record for %s, using %s:%i",
|
|
|
|
parsed_uri.host.decode("ascii"), target_host.decode("ascii"), port,
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
target_host, port = pick_server_from_list(server_list)
|
|
|
|
logger.debug(
|
|
|
|
"Picked %s:%i from SRV records for %s",
|
|
|
|
target_host.decode("ascii"), port, parsed_uri.host.decode("ascii"),
|
|
|
|
)
|
|
|
|
|
|
|
|
defer.returnValue(_RoutingResult(
|
|
|
|
host_header=parsed_uri.netloc,
|
|
|
|
tls_server_name=parsed_uri.host,
|
|
|
|
target_host=target_host,
|
|
|
|
target_port=port,
|
|
|
|
))
|
|
|
|
|
|
|
|
|
|
|
|
@attr.s
|
|
|
|
class _RoutingResult(object):
|
|
|
|
host_header = attr.ib()
|
|
|
|
tls_server_name = attr.ib()
|
|
|
|
target_host = attr.ib()
|
|
|
|
target_port = attr.ib()
|