Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

email_mirror: Listen on IPv6, and default to dual-stack.

Alex Vandiver2ecc49db3ab7
diff --git a/zerver/lib/email_mirror_server.py b/zerver/lib/email_mirror_server.py
index 763293f0194..c5b11461f4e 100644
--- a/zerver/lib/email_mirror_server.py
+++ b/zerver/lib/email_mirror_server.py
@@ -12,6 +12,7 @@ from collections.abc import Awaitable
from contextlib import suppress
from ssl import SSLContext, SSLError
from typing import Any
+from urllib.parse import SplitResult
from aiosmtpd.controller import UnthreadedController
from aiosmtpd.handlers import Message as MessageHandler
@@ -152,6 +153,22 @@ class ZulipMessageHandler(MessageHandler):
return "500 Server error"
+def parse_listen_address(listen: str) -> tuple[str, int]:
+ if listen.isdigit():
+ host, port = None, int(listen)
+ else:
+ r = SplitResult("", listen, "", "", "")
+ if r.port is None:
+ raise RuntimeError(f"{listen!r} does not have a valid port number.")
+ host, port = r.hostname, r.port
+ if host is None:
+ # With no address specified, bind the IPv6 wildcard address if
+ # IPv6 is available, since (with IPV6_V6ONLY disabled, as
+ # _create_server does) that accepts IPv4 connections as well.
+ host = "::" if socket.has_dualstack_ipv6() else "0.0.0.0" # noqa: S104
+ return host, port
+
+
class PermissionDroppingUnthreadedController(UnthreadedController): # nocoverage
@override
def __init__(
@@ -175,9 +192,20 @@ class PermissionDroppingUnthreadedController(UnthreadedController): # nocoverag
def _create_server(self) -> Awaitable[asyncio.AbstractServer]:
# Make the listen socket, then drop privileges before starting
# the server
- server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ family, type_, proto, _, sockaddr = socket.getaddrinfo(
+ self.hostname,
+ self.port,
+ type=socket.SOCK_STREAM,
+ flags=socket.AI_PASSIVE,
+ )[0]
+ server_socket = socket.socket(family, type_, proto)
server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
- server_socket.bind((self.hostname, self.port))
+ if family == socket.AF_INET6:
+ # Also accept IPv4 connections when binding the IPv6
+ # wildcard address; this has no effect when binding a
+ # specific address.
+ server_socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
+ server_socket.bind(sockaddr)
if os.geteuid() == 0:
assert self.user_id is not None
assert self.group_id is not None
@@ -205,7 +233,7 @@ class PermissionDroppingUnthreadedController(UnthreadedController): # nocoverag
def run_smtp_server(
user: str | None, group: str | None, host: str, port: int, tls_context: SSLContext | None
) -> None: # nocoverage
- logger.info("Listening on %s:%d", host, port)
+ logger.info("Listening on %s:%d", f"[{host}]" if ":" in host else host, port)
server = PermissionDroppingUnthreadedController(
user=user,
group=group,
diff --git a/zerver/management/commands/email_server.py b/zerver/management/commands/email_server.py
index 5f0b6f7cde0..20375b841af 100644
--- a/zerver/management/commands/email_server.py
+++ b/zerver/management/commands/email_server.py
@@ -1,12 +1,11 @@
import os
import ssl
from typing import Any
-from urllib.parse import SplitResult
from django.core.management.base import BaseCommand, CommandParser
from typing_extensions import override
-from zerver.lib.email_mirror_server import run_smtp_server
+from zerver.lib.email_mirror_server import parse_listen_address, run_smtp_server
class Command(BaseCommand):
@@ -15,7 +14,7 @@ class Command(BaseCommand):
@override
def add_arguments(self, parser: CommandParser) -> None:
parser.add_argument(
- "--listen", help="[Port, or address:port, to bind HTTP server to]", default="0.0.0.0:25"
+ "--listen", help="[Port, or address:port, to bind the SMTP server to]", default="25"
)
parser.add_argument(
"--user",
@@ -52,14 +51,7 @@ class Command(BaseCommand):
@override
def handle(self, *args: Any, **options: Any) -> None:
- listen = options["listen"]
- if listen.isdigit():
- host, port = "0.0.0.0", int(listen) # noqa: S104
- else:
- r = SplitResult("", listen, "", "", "")
- if r.port is None:
- raise RuntimeError(f"{listen!r} does not have a valid port number.")
- host, port = r.hostname or "0.0.0.0", r.port # noqa: S104
+ host, port = parse_listen_address(options["listen"])
if options["tls_cert"] and options["tls_key"]:
tls_context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
tls_context.load_cert_chain(options["tls_cert"], options["tls_key"])
diff --git a/zerver/tests/test_email_mirror.py b/zerver/tests/test_email_mirror.py
index e903c0ce873..cbc10564d24 100644
--- a/zerver/tests/test_email_mirror.py
+++ b/zerver/tests/test_email_mirror.py
@@ -45,7 +45,11 @@ from zerver.lib.email_mirror_helpers import (
get_channel_email_token,
get_email_gateway_message_string_from_address,
)
-from zerver.lib.email_mirror_server import ZulipMessageHandler, send_to_postmaster
+from zerver.lib.email_mirror_server import (
+ ZulipMessageHandler,
+ parse_listen_address,
+ send_to_postmaster,
+)
from zerver.lib.markdown.from_html import convert_html_to_markdown
from zerver.lib.message import truncate_topic
from zerver.lib.send_email import FromAddress
@@ -2168,6 +2172,23 @@ class TestEmailMirrorLogAndReport(ZulipTestCase):
class TestEmailMirrorServer(ZulipTestCase):
+ def test_parse_listen_address(self) -> None:
+ ipv4_wildcard = "0.0.0.0" # noqa: S104
+ with mock.patch("socket.has_dualstack_ipv6", return_value=True):
+ self.assertEqual(parse_listen_address("25"), ("::", 25))
+ self.assertEqual(parse_listen_address(":25"), ("::", 25))
+ with mock.patch("socket.has_dualstack_ipv6", return_value=False):
+ self.assertEqual(parse_listen_address("25"), (ipv4_wildcard, 25))
+ self.assertEqual(parse_listen_address(":25"), (ipv4_wildcard, 25))
+ self.assertEqual(parse_listen_address(f"{ipv4_wildcard}:25"), (ipv4_wildcard, 25))
+ self.assertEqual(parse_listen_address("[::]:2525"), ("::", 2525))
+ self.assertEqual(parse_listen_address("[2001:db8::1]:25"), ("2001:db8::1", 25))
+ self.assertEqual(parse_listen_address("mail.example.com:25"), ("mail.example.com", 25))
+ with self.assertRaisesRegex(
+ RuntimeError, "'mail.example.com' does not have a valid port number."
+ ):
+ parse_listen_address("mail.example.com")
+
def test_send_postmaster(self) -> None:
email = EmailMessage()
email.set_content("Hello postmaster!")