189 lines
7.9 KiB
Python
189 lines
7.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014-2016 OpenMarket 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.
|
|
|
|
from ._base import Config
|
|
|
|
from OpenSSL import crypto
|
|
import subprocess
|
|
import os
|
|
|
|
from hashlib import sha256
|
|
from unpaddedbase64 import encode_base64
|
|
|
|
GENERATE_DH_PARAMS = False
|
|
|
|
|
|
class TlsConfig(Config):
|
|
def read_config(self, config):
|
|
self.tls_certificate = self.read_tls_certificate(
|
|
config.get("tls_certificate_path")
|
|
)
|
|
self.tls_certificate_file = config.get("tls_certificate_path")
|
|
|
|
self.no_tls = config.get("no_tls", False)
|
|
|
|
if self.no_tls:
|
|
self.tls_private_key = None
|
|
else:
|
|
self.tls_private_key = self.read_tls_private_key(
|
|
config.get("tls_private_key_path")
|
|
)
|
|
|
|
self.tls_dh_params_path = self.check_file(
|
|
config.get("tls_dh_params_path"), "tls_dh_params"
|
|
)
|
|
|
|
self.tls_fingerprints = config["tls_fingerprints"]
|
|
|
|
# Check that our own certificate is included in the list of fingerprints
|
|
# and include it if it is not.
|
|
x509_certificate_bytes = crypto.dump_certificate(
|
|
crypto.FILETYPE_ASN1,
|
|
self.tls_certificate
|
|
)
|
|
sha256_fingerprint = encode_base64(sha256(x509_certificate_bytes).digest())
|
|
sha256_fingerprints = set(f["sha256"] for f in self.tls_fingerprints)
|
|
if sha256_fingerprint not in sha256_fingerprints:
|
|
self.tls_fingerprints.append({u"sha256": sha256_fingerprint})
|
|
|
|
# This config option applies to non-federation HTTP clients
|
|
# (e.g. for talking to recaptcha, identity servers, and such)
|
|
# It should never be used in production, and is intended for
|
|
# use only when running tests.
|
|
self.use_insecure_ssl_client_just_for_testing_do_not_use = config.get(
|
|
"use_insecure_ssl_client_just_for_testing_do_not_use"
|
|
)
|
|
|
|
def default_config(self, config_dir_path, server_name, **kwargs):
|
|
base_key_name = os.path.join(config_dir_path, server_name)
|
|
|
|
tls_certificate_path = base_key_name + ".tls.crt"
|
|
tls_private_key_path = base_key_name + ".tls.key"
|
|
tls_dh_params_path = base_key_name + ".tls.dh"
|
|
|
|
return """\
|
|
# PEM encoded X509 certificate for TLS.
|
|
# You can replace the self-signed certificate that synapse
|
|
# autogenerates on launch with your own SSL certificate + key pair
|
|
# if you like. Any required intermediary certificates can be
|
|
# appended after the primary certificate in hierarchical order.
|
|
tls_certificate_path: "%(tls_certificate_path)s"
|
|
|
|
# PEM encoded private key for TLS
|
|
tls_private_key_path: "%(tls_private_key_path)s"
|
|
|
|
# PEM dh parameters for ephemeral keys
|
|
tls_dh_params_path: "%(tls_dh_params_path)s"
|
|
|
|
# Don't bind to the https port
|
|
no_tls: False
|
|
|
|
# List of allowed TLS fingerprints for this server to publish along
|
|
# with the signing keys for this server. Other matrix servers that
|
|
# make HTTPS requests to this server will check that the TLS
|
|
# certificates returned by this server match one of the fingerprints.
|
|
#
|
|
# Synapse automatically adds its the fingerprint of its own certificate
|
|
# to the list. So if federation traffic is handle directly by synapse
|
|
# then no modification to the list is required.
|
|
#
|
|
# If synapse is run behind a load balancer that handles the TLS then it
|
|
# will be necessary to add the fingerprints of the certificates used by
|
|
# the loadbalancers to this list if they are different to the one
|
|
# synapse is using.
|
|
#
|
|
# Homeservers are permitted to cache the list of TLS fingerprints
|
|
# returned in the key responses up to the "valid_until_ts" returned in
|
|
# key. It may be necessary to publish the fingerprints of a new
|
|
# certificate and wait until the "valid_until_ts" of the previous key
|
|
# responses have passed before deploying it.
|
|
tls_fingerprints: []
|
|
# tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
|
|
""" % locals()
|
|
|
|
def read_tls_certificate(self, cert_path):
|
|
cert_pem = self.read_file(cert_path, "tls_certificate")
|
|
return crypto.load_certificate(crypto.FILETYPE_PEM, cert_pem)
|
|
|
|
def read_tls_private_key(self, private_key_path):
|
|
private_key_pem = self.read_file(private_key_path, "tls_private_key")
|
|
return crypto.load_privatekey(crypto.FILETYPE_PEM, private_key_pem)
|
|
|
|
def generate_files(self, config):
|
|
tls_certificate_path = config["tls_certificate_path"]
|
|
tls_private_key_path = config["tls_private_key_path"]
|
|
tls_dh_params_path = config["tls_dh_params_path"]
|
|
|
|
if not os.path.exists(tls_private_key_path):
|
|
with open(tls_private_key_path, "w") as private_key_file:
|
|
tls_private_key = crypto.PKey()
|
|
tls_private_key.generate_key(crypto.TYPE_RSA, 2048)
|
|
private_key_pem = crypto.dump_privatekey(
|
|
crypto.FILETYPE_PEM, tls_private_key
|
|
)
|
|
private_key_file.write(private_key_pem)
|
|
else:
|
|
with open(tls_private_key_path) as private_key_file:
|
|
private_key_pem = private_key_file.read()
|
|
tls_private_key = crypto.load_privatekey(
|
|
crypto.FILETYPE_PEM, private_key_pem
|
|
)
|
|
|
|
if not os.path.exists(tls_certificate_path):
|
|
with open(tls_certificate_path, "w") as certificate_file:
|
|
cert = crypto.X509()
|
|
subject = cert.get_subject()
|
|
subject.CN = config["server_name"]
|
|
|
|
cert.set_serial_number(1000)
|
|
cert.gmtime_adj_notBefore(0)
|
|
cert.gmtime_adj_notAfter(10 * 365 * 24 * 60 * 60)
|
|
cert.set_issuer(cert.get_subject())
|
|
cert.set_pubkey(tls_private_key)
|
|
|
|
cert.sign(tls_private_key, 'sha256')
|
|
|
|
cert_pem = crypto.dump_certificate(crypto.FILETYPE_PEM, cert)
|
|
|
|
certificate_file.write(cert_pem)
|
|
|
|
if not os.path.exists(tls_dh_params_path):
|
|
if GENERATE_DH_PARAMS:
|
|
subprocess.check_call([
|
|
"openssl", "dhparam",
|
|
"-outform", "PEM",
|
|
"-out", tls_dh_params_path,
|
|
"2048"
|
|
])
|
|
else:
|
|
with open(tls_dh_params_path, "w") as dh_params_file:
|
|
dh_params_file.write(
|
|
"2048-bit DH parameters taken from rfc3526\n"
|
|
"-----BEGIN DH PARAMETERS-----\n"
|
|
"MIIBCAKCAQEA///////////JD9qiIWjC"
|
|
"NMTGYouA3BzRKQJOCIpnzHQCC76mOxOb\n"
|
|
"IlFKCHmONATd75UZs806QxswKwpt8l8U"
|
|
"N0/hNW1tUcJF5IW1dmJefsb0TELppjft\n"
|
|
"awv/XLb0Brft7jhr+1qJn6WunyQRfEsf"
|
|
"5kkoZlHs5Fs9wgB8uKFjvwWY2kg2HFXT\n"
|
|
"mmkWP6j9JM9fg2VdI9yjrZYcYvNWIIVS"
|
|
"u57VKQdwlpZtZww1Tkq8mATxdGwIyhgh\n"
|
|
"fDKQXkYuNs474553LBgOhgObJ4Oi7Aei"
|
|
"j7XFXfBvTFLJ3ivL9pVYFxg5lUl86pVq\n"
|
|
"5RXSJhiY+gUQFXKOWoqsqmj/////////"
|
|
"/wIBAg==\n"
|
|
"-----END DH PARAMETERS-----\n"
|
|
)
|