synapse-product/synapse/crypto/context_factory.py

136 lines
4.7 KiB
Python
Raw Normal View History

2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
# 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.
2018-06-26 14:41:05 -04:00
import logging
2018-07-29 13:47:08 -04:00
from zope.interface import implementer
from OpenSSL import SSL, crypto
2018-08-09 15:04:22 -04:00
from twisted.internet._sslverify import _defaultCurveName
from twisted.internet.abstract import isIPAddress, isIPv6Address
2018-06-26 14:41:05 -04:00
from twisted.internet.interfaces import IOpenSSLClientConnectionCreator
2018-07-29 13:47:08 -04:00
from twisted.internet.ssl import CertificateOptions, ContextFactory
2018-08-09 15:04:22 -04:00
from twisted.python.failure import Failure
logger = logging.getLogger(__name__)
2014-09-01 12:55:35 -04:00
2014-10-30 07:10:17 -04:00
2018-06-26 14:41:05 -04:00
class ServerContextFactory(ContextFactory):
2014-09-01 12:55:35 -04:00
"""Factory for PyOpenSSL SSL contexts that are used to handle incoming
connections."""
2014-09-01 12:55:35 -04:00
def __init__(self, config):
self._context = SSL.Context(SSL.SSLv23_METHOD)
self.configure_context(self._context, config)
@staticmethod
def configure_context(context, config):
2014-09-01 17:29:31 -04:00
try:
_ecCurve = crypto.get_elliptic_curve(_defaultCurveName)
context.set_tmp_ecdh(_ecCurve)
except Exception:
2015-07-08 13:53:41 -04:00
logger.exception("Failed to enable elliptic curve for TLS")
2014-09-01 12:55:35 -04:00
context.set_options(SSL.OP_NO_SSLv2 | SSL.OP_NO_SSLv3)
context.use_certificate_chain_file(config.tls_certificate_file)
context.use_privatekey(config.tls_private_key)
# https://hynek.me/articles/hardening-your-web-servers-ssl-ciphers/
context.set_cipher_list(
"ECDH+AESGCM:ECDH+CHACHA20:ECDH+AES256:ECDH+AES128:!aNULL:!SHA1"
)
2014-09-01 12:55:35 -04:00
def getContext(self):
return self._context
2018-06-24 16:38:43 -04:00
2018-08-09 15:04:22 -04:00
def _idnaBytes(text):
"""
Convert some text typed by a human into some ASCII bytes. This is a
copy of twisted.internet._idna._idnaBytes. For documentation, see the
twisted documentation.
"""
try:
import idna
except ImportError:
return text.encode("idna")
else:
return idna.encode(text)
def _tolerateErrors(wrapped):
"""
Wrap up an info_callback for pyOpenSSL so that if something goes wrong
the error is immediately logged and the connection is dropped if possible.
This is a copy of twisted.internet._sslverify._tolerateErrors. For
documentation, see the twisted documentation.
"""
def infoCallback(connection, where, ret):
try:
return wrapped(connection, where, ret)
except: # noqa: E722, taken from the twisted implementation
f = Failure()
logger.exception("Error during info_callback")
connection.get_app_data().failVerification(f)
return infoCallback
2018-06-26 14:41:05 -04:00
@implementer(IOpenSSLClientConnectionCreator)
class ClientTLSOptions(object):
"""
Client creator for TLS without certificate identity verification. This is a
copy of twisted.internet._sslverify.ClientTLSOptions with the identity
verification left out. For documentation, see the twisted documentation.
"""
2018-06-24 16:38:43 -04:00
2018-06-26 14:41:05 -04:00
def __init__(self, hostname, ctx):
self._ctx = ctx
if isIPAddress(hostname) or isIPv6Address(hostname):
self._hostnameBytes = hostname.encode('ascii')
self._sendSNI = False
else:
self._hostnameBytes = _idnaBytes(hostname)
self._sendSNI = True
ctx.set_info_callback(_tolerateErrors(self._identityVerifyingInfoCallback))
2018-06-24 16:38:43 -04:00
2018-06-26 14:41:05 -04:00
def clientConnectionForTLS(self, tlsProtocol):
context = self._ctx
connection = SSL.Connection(context, None)
connection.set_app_data(tlsProtocol)
return connection
2018-06-24 16:38:43 -04:00
2018-06-26 14:41:05 -04:00
def _identityVerifyingInfoCallback(self, connection, where, ret):
# Literal IPv4 and IPv6 addresses are not permitted
# as host names according to the RFCs
if where & SSL.SSL_CB_HANDSHAKE_START and self._sendSNI:
2018-06-26 14:41:05 -04:00
connection.set_tlsext_host_name(self._hostnameBytes)
2018-06-24 16:38:43 -04:00
class ClientTLSOptionsFactory(object):
"""Factory for Twisted ClientTLSOptions that are used to make connections
to remote servers for federation."""
def __init__(self, config):
2018-06-26 14:41:05 -04:00
# We don't use config options yet
self._options = CertificateOptions(verify=False)
2018-06-24 16:38:43 -04:00
def get_options(self, host):
# Use _makeContext so that we get a fresh OpenSSL CTX each time.
return ClientTLSOptions(host, self._options._makeContext())