From 2032fac6b1ca6fde22f767178fabb738542f26a2 Mon Sep 17 00:00:00 2001 From: link2xt Date: Tue, 22 Oct 2024 17:40:25 +0000 Subject: [PATCH] Deploy iroh relay --- .../staging-ipv4.testrun.org-default.zone | 1 + .../staging.testrun.org-default.zone | 1 + CHANGELOG.md | 3 + chatmaild/src/chatmaild/config.py | 7 ++- chatmaild/src/chatmaild/ini/chatmail.ini.f | 7 +++ cmdeploy/src/cmdeploy/__init__.py | 56 ++++++++++++++++++- cmdeploy/src/cmdeploy/cmdeploy.py | 8 ++- cmdeploy/src/cmdeploy/dns.py | 9 ++- cmdeploy/src/cmdeploy/iroh-relay.service | 12 ++++ cmdeploy/src/cmdeploy/iroh-relay.toml | 5 ++ cmdeploy/src/cmdeploy/nginx/nginx.conf.j2 | 12 ++++ cmdeploy/src/cmdeploy/remote/rdns.py | 7 ++- .../src/cmdeploy/tests/online/test_1_basic.py | 8 +-- cmdeploy/src/cmdeploy/tests/test_dns.py | 12 ++-- 14 files changed, 127 insertions(+), 21 deletions(-) create mode 100644 cmdeploy/src/cmdeploy/iroh-relay.service create mode 100644 cmdeploy/src/cmdeploy/iroh-relay.toml diff --git a/.github/workflows/staging-ipv4.testrun.org-default.zone b/.github/workflows/staging-ipv4.testrun.org-default.zone index 785b71aa..5c7df6d8 100644 --- a/.github/workflows/staging-ipv4.testrun.org-default.zone +++ b/.github/workflows/staging-ipv4.testrun.org-default.zone @@ -17,4 +17,5 @@ $TTL 300 ;; DNS records. @ IN A 37.27.95.249 mta-sts.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org. +iroh.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org. www.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org. diff --git a/.github/workflows/staging.testrun.org-default.zone b/.github/workflows/staging.testrun.org-default.zone index 444e4d86..311c95f5 100644 --- a/.github/workflows/staging.testrun.org-default.zone +++ b/.github/workflows/staging.testrun.org-default.zone @@ -17,5 +17,6 @@ $TTL 300 ;; DNS records. @ IN A 37.27.24.139 mta-sts.staging2.testrun.org. CNAME staging2.testrun.org. +iroh.staging2.testrun.org. CNAME staging2.testrun.org. www.staging2.testrun.org. CNAME staging2.testrun.org. diff --git a/CHANGELOG.md b/CHANGELOG.md index 071aa202..0ee6a4f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ ## untagged +- deploy `iroh-relay` + ([#434](https://github.com/deltachat/chatmail/pull/434)) + - increase `request_queue_size` for UNIX sockets to 1000. ([#437](https://github.com/deltachat/chatmail/pull/437)) diff --git a/chatmaild/src/chatmaild/config.py b/chatmaild/src/chatmaild/config.py index 53c83f94..b453389c 100644 --- a/chatmaild/src/chatmaild/config.py +++ b/chatmaild/src/chatmaild/config.py @@ -33,7 +33,12 @@ def __init__(self, inipath, params): self.mtail_address = params.get("mtail_address") self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true" self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true" - self.iroh_relay = params.get("iroh_relay") + if "iroh_relay" not in params: + self.iroh_relay = "https://iroh." + params["mail_domain"] + self.enable_iroh_relay = True + else: + self.iroh_relay = params["iroh_relay"].strip() + self.enable_iroh_relay = False self.privacy_postal = params.get("privacy_postal") self.privacy_mail = params.get("privacy_mail") self.privacy_pdo = params.get("privacy_pdo") diff --git a/chatmaild/src/chatmaild/ini/chatmail.ini.f b/chatmaild/src/chatmaild/ini/chatmail.ini.f index e8e8ef5d..bde5bf5b 100644 --- a/chatmaild/src/chatmaild/ini/chatmail.ini.f +++ b/chatmaild/src/chatmaild/ini/chatmail.ini.f @@ -55,6 +55,13 @@ # if set to "True" IPv6 is disabled disable_ipv6 = False +# Defaults to https://iroh.{{mail_domain}} and running `iroh-relay` on the chatmail +# service. +# If you set it to anything else, the service will be disabled +# and users will be directed to use the given iroh relay URL. +# Set it to empty string if you want users to use their default iroh relay. +# iroh_relay = + # Address on which `mtail` listens, # e.g. 127.0.0.1 or some private network # address like 192.168.10.1. diff --git a/cmdeploy/src/cmdeploy/__init__.py b/cmdeploy/src/cmdeploy/__init__.py index 283e268b..ce361858 100644 --- a/cmdeploy/src/cmdeploy/__init__.py +++ b/cmdeploy/src/cmdeploy/__init__.py @@ -10,7 +10,7 @@ from pathlib import Path from chatmaild.config import Config, read_config -from pyinfra import host +from pyinfra import host, facts from pyinfra.facts.files import File from pyinfra.facts.systemd import SystemdEnabled from pyinfra.operations import apt, files, pip, server, systemd @@ -479,6 +479,55 @@ def deploy_mtail(config): ) +def deploy_iroh_relay(config) -> None: + (url, sha256sum) = { + "x86_64": ("https://github.com/n0-computer/iroh/releases/download/v0.27.0/iroh-relay-v0.27.0-x86_64-unknown-linux-musl.tar.gz", "8af7f6d29d17476ce5c3053c3161db5793cb2ac49057d0bcaf689436cdccbeab"), + "aarch64": ("https://github.com/n0-computer/iroh/releases/download/v0.27.0/iroh-relay-v0.27.0-aarch64-unknown-linux-musl.tar.gz", "18039f0d39df78922a5055a0d4a5a8fa98a2a0e19b1eaa4c3fe6db73b8698697") + }[host.get_fact(facts.server.Arch)] + + server.shell( + name="Download iroh-relay", + commands=[ + f"(echo '{sha256sum} /usr/local/bin/iroh-relay' | sha256sum -c) || curl -L {url} | gunzip | tar -x -f - ./iroh-relay -O >/usr/local/bin/iroh-relay", + "chmod 755 /usr/local/bin/iroh-relay", + ], + ) + + need_restart = False + + systemd_unit = files.put( + name="Upload iroh-relay systemd unit", + src=importlib.resources.files(__package__).joinpath( + "iroh-relay.service" + ), + dest="/etc/systemd/system/iroh-relay.service", + user="root", + group="root", + mode="644", + ) + need_restart |= systemd_unit.changed + + iroh_config = files.put( + name=f"Upload iroh-relay config", + src=importlib.resources.files(__package__).joinpath( + "iroh-relay.toml" + ), + dest=f"/etc/iroh-relay.toml", + user="iroh", + group="iroh", + mode="600", + ) + need_restart |= iroh_config.changed + + systemd.service( + name="Start and enable iroh-relay", + service="iroh-relay.service", + running=True, + enabled=config.enable_iroh_relay, + restarted=need_restart, + ) + + def deploy_chatmail(config_path: Path, disable_mail: bool) -> None: """Deploy a chat-mail instance. @@ -508,6 +557,7 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None: system=True, ) server.user(name="Create echobot user", user="echobot", system=True) + server.user(name="Create iroh user", user="iroh", system=True) # Add our OBS repository for dovecot_no_delay files.put( @@ -556,9 +606,11 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None: enabled=True, ) + deploy_iroh_relay(config) + # Deploy acmetool to have TLS certificates. deploy_acmetool( - domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"], + domains=[mail_domain, f"mta-sts.{mail_domain}", f"iroh.{mail_domain}", f"www.{mail_domain}"], ) apt.packages( diff --git a/cmdeploy/src/cmdeploy/cmdeploy.py b/cmdeploy/src/cmdeploy/cmdeploy.py index cb744b37..9996b8ab 100644 --- a/cmdeploy/src/cmdeploy/cmdeploy.py +++ b/cmdeploy/src/cmdeploy/cmdeploy.py @@ -64,8 +64,9 @@ def run_cmd(args, out): """Deploy chatmail services on the remote server.""" sshexec = args.get_sshexec() - remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain) - if not dns.check_initial_remote_data(remote_data, print=out.red): + require_iroh = args.config.enable_iroh_relay + remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain, require_iroh) + if not dns.check_initial_remote_data(remote_data, require_iroh, print=out.red): return 1 env = os.environ.copy() @@ -103,7 +104,8 @@ def dns_cmd_options(parser): def dns_cmd(args, out): """Check DNS entries and optionally generate dns zone file.""" sshexec = args.get_sshexec() - remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain) + require_iroh = args.config.enable_iroh_relay + remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain, require_iroh) if not remote_data: return 1 diff --git a/cmdeploy/src/cmdeploy/dns.py b/cmdeploy/src/cmdeploy/dns.py index c672da33..b8e05f21 100644 --- a/cmdeploy/src/cmdeploy/dns.py +++ b/cmdeploy/src/cmdeploy/dns.py @@ -6,19 +6,22 @@ from . import remote -def get_initial_remote_data(sshexec, mail_domain): +def get_initial_remote_data(sshexec, mail_domain, iroh_enabled): return sshexec.logged( - call=remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=mail_domain) + call=remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=mail_domain, iroh_enabled=iroh_enabled) ) -def check_initial_remote_data(remote_data, print=print): +def check_initial_remote_data(remote_data, require_iroh, *, print=print): mail_domain = remote_data["mail_domain"] if not remote_data["A"] and not remote_data["AAAA"]: print(f"Missing A and/or AAAA DNS records for {mail_domain}!") elif remote_data["MTA_STS"] != f"{mail_domain}.": print("Missing MTA-STS CNAME record:") print(f"mta-sts.{mail_domain}. CNAME {mail_domain}.") + elif require_iroh and remote_data["IROH"] != f"{mail_domain}.": + print("Missing iroh CNAME record:") + print(f"iroh.{mail_domain}. CNAME {mail_domain}.") elif remote_data["WWW"] != f"{mail_domain}.": print("Missing www CNAME record:") print(f"www.{mail_domain}. CNAME {mail_domain}.") diff --git a/cmdeploy/src/cmdeploy/iroh-relay.service b/cmdeploy/src/cmdeploy/iroh-relay.service new file mode 100644 index 00000000..004e8518 --- /dev/null +++ b/cmdeploy/src/cmdeploy/iroh-relay.service @@ -0,0 +1,12 @@ +[Unit] +Description=Iroh relay + +[Service] +ExecStart=/usr/local/bin/iroh-relay --config-path /etc/iroh-relay.toml +Restart=on-failure +RestartSec=5s +User=iroh +Group=iroh + +[Install] +WantedBy=multi-user.target diff --git a/cmdeploy/src/cmdeploy/iroh-relay.toml b/cmdeploy/src/cmdeploy/iroh-relay.toml new file mode 100644 index 00000000..35b2f4ab --- /dev/null +++ b/cmdeploy/src/cmdeploy/iroh-relay.toml @@ -0,0 +1,5 @@ +enable_relay = true +http_bind_addr = "[::]:3340" +enable_stun = true +enable_metrics = false +metrics_bind_addr = "127.0.0.1:9092" diff --git a/cmdeploy/src/cmdeploy/nginx/nginx.conf.j2 b/cmdeploy/src/cmdeploy/nginx/nginx.conf.j2 index cb53a1b8..5797b4c0 100644 --- a/cmdeploy/src/cmdeploy/nginx/nginx.conf.j2 +++ b/cmdeploy/src/cmdeploy/nginx/nginx.conf.j2 @@ -108,4 +108,16 @@ http { return 301 $scheme://{{ config.domain_name }}$request_uri; access_log syslog:server=unix:/dev/log,facility=local7; } + + # Pass iroh. to iroh-relay service. + server { + listen 8443 ssl; + {% if not disable_ipv6 %} + listen [::]:8443 ssl; + {% endif %} + server_name iroh.{{ config.domain_name }}; + location / { + proxy_pass http://127.0.0.1:3340; + } + } } diff --git a/cmdeploy/src/cmdeploy/remote/rdns.py b/cmdeploy/src/cmdeploy/remote/rdns.py index 77093503..107d7d23 100644 --- a/cmdeploy/src/cmdeploy/remote/rdns.py +++ b/cmdeploy/src/cmdeploy/remote/rdns.py @@ -15,7 +15,7 @@ from .rshell import CalledProcessError, shell -def perform_initial_checks(mail_domain): +def perform_initial_checks(mail_domain, iroh_enabled): """Collecting initial DNS settings.""" assert mail_domain if not shell("dig", fail_ok=True): @@ -23,13 +23,14 @@ def perform_initial_checks(mail_domain): A = query_dns("A", mail_domain) AAAA = query_dns("AAAA", mail_domain) MTA_STS = query_dns("CNAME", f"mta-sts.{mail_domain}") + IROH = query_dns("CNAME", f"iroh.{mail_domain}") WWW = query_dns("CNAME", f"www.{mail_domain}") - res = dict(mail_domain=mail_domain, A=A, AAAA=AAAA, MTA_STS=MTA_STS, WWW=WWW) + res = dict(mail_domain=mail_domain, A=A, AAAA=AAAA, MTA_STS=MTA_STS, IROH=IROH, WWW=WWW) res["acme_account_url"] = shell("acmetool account-url", fail_ok=True) res["dkim_entry"] = get_dkim_entry(mail_domain, dkim_selector="opendkim") - if not MTA_STS or not WWW or (not A and not AAAA): + if not MTA_STS or (not IROH and not iroh_enabled) or not WWW or (not A and not AAAA): return res # parse out sts-id if exists, example: "v=STSv1; id=2090123" diff --git a/cmdeploy/src/cmdeploy/tests/online/test_1_basic.py b/cmdeploy/src/cmdeploy/tests/online/test_1_basic.py index f5f2c023..13424ef3 100644 --- a/cmdeploy/src/cmdeploy/tests/online/test_1_basic.py +++ b/cmdeploy/src/cmdeploy/tests/online/test_1_basic.py @@ -18,13 +18,13 @@ def test_ls(self, sshexec): def test_perform_initial(self, sshexec, maildomain): res = sshexec( - remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain) + remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain, iroh_enabled=True) ) assert res["A"] or res["AAAA"] def test_logged(self, sshexec, maildomain, capsys): sshexec.logged( - remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain) + remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain, iroh_enabled=True) ) out, err = capsys.readouterr() assert err.startswith("Collecting") @@ -33,7 +33,7 @@ def test_logged(self, sshexec, maildomain, capsys): sshexec.verbose = True sshexec.logged( - remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain) + remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain, iroh_enabled=True) ) out, err = capsys.readouterr() lines = err.split("\n") @@ -44,7 +44,7 @@ def test_exception(self, sshexec, capsys): try: sshexec.logged( remote.rdns.perform_initial_checks, - kwargs=dict(mail_domain=None), + kwargs=dict(mail_domain=None, iroh_enabled=True), ) except sshexec.FuncError as e: assert "rdns.py" in str(e) diff --git a/cmdeploy/src/cmdeploy/tests/test_dns.py b/cmdeploy/src/cmdeploy/tests/test_dns.py index fd11095f..a69a7f73 100644 --- a/cmdeploy/src/cmdeploy/tests/test_dns.py +++ b/cmdeploy/src/cmdeploy/tests/test_dns.py @@ -26,6 +26,7 @@ def mockdns(mockdns_base): "AAAA": {"some.domain": "fde5:cd7a:9e1c:3240:5a99:936f:cdac:53ae"}, "CNAME": { "mta-sts.some.domain": "some.domain.", + "iroh.some.domain": "some.domain.", "www.some.domain": "some.domain.", }, } @@ -35,30 +36,31 @@ def mockdns(mockdns_base): class TestPerformInitialChecks: def test_perform_initial_checks_ok1(self, mockdns): - remote_data = remote.rdns.perform_initial_checks("some.domain") + remote_data = remote.rdns.perform_initial_checks("some.domain", iroh_enabled=True) assert remote_data["A"] == mockdns["A"]["some.domain"] assert remote_data["AAAA"] == mockdns["AAAA"]["some.domain"] assert remote_data["MTA_STS"] == mockdns["CNAME"]["mta-sts.some.domain"] + assert remote_data["IROH"] == mockdns["CNAME"]["iroh.some.domain"] assert remote_data["WWW"] == mockdns["CNAME"]["www.some.domain"] @pytest.mark.parametrize("drop", ["A", "AAAA"]) def test_perform_initial_checks_with_one_of_A_AAAA(self, mockdns, drop): del mockdns[drop] - remote_data = remote.rdns.perform_initial_checks("some.domain") + remote_data = remote.rdns.perform_initial_checks("some.domain", iroh_enabled=True) assert not remote_data[drop] l = [] - res = check_initial_remote_data(remote_data, print=l.append) + res = check_initial_remote_data(remote_data, require_iroh=True, print=l.append) assert res assert not l def test_perform_initial_checks_no_mta_sts(self, mockdns): del mockdns["CNAME"]["mta-sts.some.domain"] - remote_data = remote.rdns.perform_initial_checks("some.domain") + remote_data = remote.rdns.perform_initial_checks("some.domain", iroh_enabled=True) assert not remote_data["MTA_STS"] l = [] - res = check_initial_remote_data(remote_data, print=l.append) + res = check_initial_remote_data(remote_data, require_iroh=True, print=l.append) assert not res assert len(l) == 2