Allow binds to both :: and 0.0.0.0

Binding on 0.0.0.0 when :: is specified in the bind_addresses is now allowed.
This causes a warning explaining the behaviour.
Configuration changed to match.

See #2232

Signed-off-by: Silke Hofstra <silke@slxh.eu>
This commit is contained in:
Silke Hofstra 2017-09-02 17:26:40 +02:00 committed by Silke
parent 3e59143ba8
commit 37d1a90025
2 changed files with 61 additions and 42 deletions

View file

@ -58,6 +58,7 @@ from twisted.internet import defer, reactor
from twisted.web.resource import EncodingResourceWrapper, Resource from twisted.web.resource import EncodingResourceWrapper, Resource
from twisted.web.server import GzipEncoderFactory from twisted.web.server import GzipEncoderFactory
from twisted.web.static import File from twisted.web.static import File
from twisted.internet import error
logger = logging.getLogger("synapse.app.homeserver") logger = logging.getLogger("synapse.app.homeserver")
@ -131,29 +132,36 @@ class SynapseHomeServer(HomeServer):
if tls: if tls:
for address in bind_addresses: for address in bind_addresses:
reactor.listenSSL( try:
port, reactor.listenSSL(
SynapseSite( port,
"synapse.access.https.%s" % (site_tag,), SynapseSite(
site_tag, "synapse.access.https.%s" % (site_tag,),
listener_config, site_tag,
root_resource, listener_config,
), root_resource,
self.tls_server_context_factory, ),
interface=address self.tls_server_context_factory,
) interface=address
)
except error.CannotListenError as e:
check_bind_error(e, address, bind_addresses)
else: else:
for address in bind_addresses: for address in bind_addresses:
reactor.listenTCP( try:
port, reactor.listenTCP(
SynapseSite( port,
"synapse.access.http.%s" % (site_tag,), SynapseSite(
site_tag, "synapse.access.http.%s" % (site_tag,),
listener_config, site_tag,
root_resource, listener_config,
), root_resource,
interface=address ),
) interface=address
)
except error.CannotListenError as e:
check_bind_error(e, address, bind_addresses)
logger.info("Synapse now listening on port %d", port) logger.info("Synapse now listening on port %d", port)
def _configure_named_resource(self, name, compress=False): def _configure_named_resource(self, name, compress=False):
@ -232,25 +240,31 @@ class SynapseHomeServer(HomeServer):
bind_addresses = listener["bind_addresses"] bind_addresses = listener["bind_addresses"]
for address in bind_addresses: for address in bind_addresses:
reactor.listenTCP( try:
listener["port"], reactor.listenTCP(
manhole( listener["port"],
username="matrix", manhole(
password="rabbithole", username="matrix",
globals={"hs": self}, password="rabbithole",
), globals={"hs": self},
interface=address ),
) interface=address
)
except error.CannotListenError as e:
check_bind_error(e, address, bind_addresses)
elif listener["type"] == "replication": elif listener["type"] == "replication":
bind_addresses = listener["bind_addresses"] bind_addresses = listener["bind_addresses"]
for address in bind_addresses: for address in bind_addresses:
factory = ReplicationStreamProtocolFactory(self) try:
server_listener = reactor.listenTCP( factory = ReplicationStreamProtocolFactory(self)
listener["port"], factory, interface=address server_listener = reactor.listenTCP(
) listener["port"], factory, interface=address
reactor.addSystemEventTrigger( )
"before", "shutdown", server_listener.stopListening, reactor.addSystemEventTrigger(
) "before", "shutdown", server_listener.stopListening,
)
except error.CannotListenError as e:
check_bind_error(e, address, bind_addresses)
else: else:
logger.warn("Unrecognized listener type: %s", listener["type"]) logger.warn("Unrecognized listener type: %s", listener["type"])
@ -284,6 +298,13 @@ class SynapseHomeServer(HomeServer):
return db_conn return db_conn
def check_bind_error(e, address, bind_addresses):
if address == '0.0.0.0' and '::' in bind_addresses:
logger.warn('Failed to listen on 0.0.0.0, continuing because listening on [::]')
else:
raise e
def setup(config_options): def setup(config_options):
""" """
Args: Args:

View file

@ -220,14 +220,12 @@ class ServerConfig(Config):
port: %(bind_port)s port: %(bind_port)s
# Local addresses to listen on. # Local addresses to listen on.
# On Linux and Mac OS, this will listen on all IPv4 and IPv6 # On Linux and Mac OS, `::` will listen on all IPv4 and IPv6
# addresses by default. For most other OSes, this will only listen # addresses by default. For most other OSes, this will only listen
# on IPv6. # on IPv6.
bind_addresses: bind_addresses:
- '::' - '::'
# For systems other than Linux or Mac OS, uncomment the next line - '0.0.0.0'
# to also listen on IPv4.
#- '0.0.0.0'
# This is a 'http' listener, allows us to specify 'resources'. # This is a 'http' listener, allows us to specify 'resources'.
type: http type: http
@ -265,7 +263,7 @@ class ServerConfig(Config):
# For when matrix traffic passes through loadbalancer that unwraps TLS. # For when matrix traffic passes through loadbalancer that unwraps TLS.
- port: %(unsecure_port)s - port: %(unsecure_port)s
tls: false tls: false
bind_addresses: ['::'] bind_addresses: ['::', '0.0.0.0']
type: http type: http
x_forwarded: false x_forwarded: false