mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-27 12:29:23 -05:00
7615a8ced1
* Handle listening for ACME requests on IPv6 addresses the weird url-but-not-actually-a-url-string doesn't handle IPv6 addresses without extra quoting. Building a string which you are about to parse again seems like a weird choice. Let's just use listenTCP, which is consistent with what we do elsewhere. * Clean up the default ACME config make it look a bit more consistent with everything else, and tweak the defaults to listen on port 80. * newsfile
246 lines
10 KiB
Python
246 lines
10 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.
|
|
|
|
import logging
|
|
import os
|
|
import warnings
|
|
from datetime import datetime
|
|
from hashlib import sha256
|
|
|
|
from unpaddedbase64 import encode_base64
|
|
|
|
from OpenSSL import crypto
|
|
|
|
from synapse.config._base import Config
|
|
|
|
logger = logging.getLogger()
|
|
|
|
|
|
class TlsConfig(Config):
|
|
def read_config(self, config):
|
|
|
|
acme_config = config.get("acme", None)
|
|
if acme_config is None:
|
|
acme_config = {}
|
|
|
|
self.acme_enabled = acme_config.get("enabled", False)
|
|
self.acme_url = acme_config.get(
|
|
"url", "https://acme-v01.api.letsencrypt.org/directory"
|
|
)
|
|
self.acme_port = acme_config.get("port", 80)
|
|
self.acme_bind_addresses = acme_config.get("bind_addresses", ['::', '0.0.0.0'])
|
|
self.acme_reprovision_threshold = acme_config.get("reprovision_threshold", 30)
|
|
|
|
self.tls_certificate_file = self.abspath(config.get("tls_certificate_path"))
|
|
self.tls_private_key_file = self.abspath(config.get("tls_private_key_path"))
|
|
self._original_tls_fingerprints = config["tls_fingerprints"]
|
|
self.tls_fingerprints = list(self._original_tls_fingerprints)
|
|
self.no_tls = config.get("no_tls", False)
|
|
|
|
# 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"
|
|
)
|
|
|
|
self.tls_certificate = None
|
|
self.tls_private_key = None
|
|
|
|
def is_disk_cert_valid(self):
|
|
"""
|
|
Is the certificate we have on disk valid, and if so, for how long?
|
|
|
|
Returns:
|
|
int: Days remaining of certificate validity.
|
|
None: No certificate exists.
|
|
"""
|
|
if not os.path.exists(self.tls_certificate_file):
|
|
return None
|
|
|
|
try:
|
|
with open(self.tls_certificate_file, 'rb') as f:
|
|
cert_pem = f.read()
|
|
except Exception:
|
|
logger.exception("Failed to read existing certificate off disk!")
|
|
raise
|
|
|
|
try:
|
|
tls_certificate = crypto.load_certificate(crypto.FILETYPE_PEM, cert_pem)
|
|
except Exception:
|
|
logger.exception("Failed to parse existing certificate off disk!")
|
|
raise
|
|
|
|
# YYYYMMDDhhmmssZ -- in UTC
|
|
expires_on = datetime.strptime(
|
|
tls_certificate.get_notAfter().decode('ascii'), "%Y%m%d%H%M%SZ"
|
|
)
|
|
now = datetime.utcnow()
|
|
days_remaining = (expires_on - now).days
|
|
return days_remaining
|
|
|
|
def read_certificate_from_disk(self):
|
|
"""
|
|
Read the certificates from disk.
|
|
"""
|
|
self.tls_certificate = self.read_tls_certificate(self.tls_certificate_file)
|
|
|
|
# Check if it is self-signed, and issue a warning if so.
|
|
if self.tls_certificate.get_issuer() == self.tls_certificate.get_subject():
|
|
warnings.warn(
|
|
(
|
|
"Self-signed TLS certificates will not be accepted by Synapse 1.0. "
|
|
"Please either provide a valid certificate, or use Synapse's ACME "
|
|
"support to provision one."
|
|
)
|
|
)
|
|
|
|
if not self.no_tls:
|
|
self.tls_private_key = self.read_tls_private_key(self.tls_private_key_file)
|
|
|
|
self.tls_fingerprints = list(self._original_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})
|
|
|
|
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"
|
|
|
|
# this is to avoid the max line length. Sorrynotsorry
|
|
proxypassline = (
|
|
'ProxyPass /.well-known/acme-challenge '
|
|
'http://localhost:8009/.well-known/acme-challenge'
|
|
)
|
|
|
|
return (
|
|
"""\
|
|
# PEM-encoded X509 certificate for TLS.
|
|
# This certificate, as of Synapse 1.0, will need to be a valid and verifiable
|
|
# certificate, signed by a recognised Certificate Authority.
|
|
#
|
|
# See 'ACME support' below to enable auto-provisioning this certificate via
|
|
# Let's Encrypt.
|
|
#
|
|
tls_certificate_path: "%(tls_certificate_path)s"
|
|
|
|
# PEM-encoded private key for TLS
|
|
tls_private_key_path: "%(tls_private_key_path)s"
|
|
|
|
# ACME support: This will configure Synapse to request a valid TLS certificate
|
|
# for your configured `server_name` via Let's Encrypt.
|
|
#
|
|
# Note that provisioning a certificate in this way requires port 80 to be
|
|
# routed to Synapse so that it can complete the http-01 ACME challenge.
|
|
# By default, if you enable ACME support, Synapse will attempt to listen on
|
|
# port 80 for incoming http-01 challenges - however, this will likely fail
|
|
# with 'Permission denied' or a similar error.
|
|
#
|
|
# There are a couple of potential solutions to this:
|
|
#
|
|
# * If you already have an Apache, Nginx, or similar listening on port 80,
|
|
# you can configure Synapse to use an alternate port, and have your web
|
|
# server forward the requests. For example, assuming you set 'port: 8009'
|
|
# below, on Apache, you would write:
|
|
#
|
|
# %(proxypassline)s
|
|
#
|
|
# * Alternatively, you can use something like `authbind` to give Synapse
|
|
# permission to listen on port 80.
|
|
#
|
|
acme:
|
|
# ACME support is disabled by default. Uncomment the following line
|
|
# to enable it.
|
|
#
|
|
# enabled: true
|
|
|
|
# Endpoint to use to request certificates. If you only want to test,
|
|
# use Let's Encrypt's staging url:
|
|
# https://acme-staging.api.letsencrypt.org/directory
|
|
#
|
|
# url: https://acme-v01.api.letsencrypt.org/directory
|
|
|
|
# Port number to listen on for the HTTP-01 challenge. Change this if
|
|
# you are forwarding connections through Apache/Nginx/etc.
|
|
#
|
|
# port: 80
|
|
|
|
# Local addresses to listen on for incoming connections.
|
|
# Again, you may want to change this if you are forwarding connections
|
|
# through Apache/Nginx/etc.
|
|
#
|
|
# bind_addresses: ['::', '0.0.0.0']
|
|
|
|
# How many days remaining on a certificate before it is renewed.
|
|
#
|
|
# reprovision_threshold: 30
|
|
|
|
# If your server runs behind a reverse-proxy which terminates TLS connections
|
|
# (for both client and federation connections), it may be useful to disable
|
|
# All TLS support for incoming connections. Setting no_tls to False will
|
|
# do so (and avoid the need to give synapse a TLS private key).
|
|
#
|
|
# 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 the fingerprint of its own certificate
|
|
# to the list. So if federation traffic is handled 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.
|
|
#
|
|
# You can calculate a fingerprint from a given TLS listener via:
|
|
# openssl s_client -connect $host:$port < /dev/null 2> /dev/null |
|
|
# openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '='
|
|
# or by checking matrix.org/federationtester/api/report?server_name=$host
|
|
#
|
|
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)
|