mirror of
https://github.com/chatmail/relay.git
synced 2026-06-10 13:41:08 +00:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 48a64cc5c9 | |||
| a9dd9fe3e0 | |||
| aa846c3478 | |||
| 921080125f | |||
| d898f41064 | |||
| e9e012234b | |||
| bb40c5bb21 | |||
| a229f1bc45 | |||
| 4ba19b0031 | |||
| 5eab3a5a25 | |||
| 30729d9be0 | |||
| 4b04aae83b | |||
| 0eed92171c | |||
| a5b9a98baa | |||
| ab2d807084 | |||
| ce05b26c77 | |||
| 77ed93fb7a | |||
| 39d1ecaa03 | |||
| a266ffd060 | |||
| a47bb94143 | |||
| 43ae9fee5c |
@@ -20,9 +20,9 @@ concurrency:
|
|||||||
jobs:
|
jobs:
|
||||||
no-dns:
|
no-dns:
|
||||||
name: LXC deploy and test
|
name: LXC deploy and test
|
||||||
uses: chatmail/cmlxc/.github/workflows/lxc-test.yml@v0.14.6
|
uses: chatmail/cmlxc/.github/workflows/lxc-test.yml@main
|
||||||
with:
|
with:
|
||||||
cmlxc_version: v0.14.6
|
cmlxc_version: main
|
||||||
cmlxc_commands: |
|
cmlxc_commands: |
|
||||||
cmlxc init
|
cmlxc init
|
||||||
# single cmdeploy relay test
|
# single cmdeploy relay test
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ jobs:
|
|||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
- name: download filtermail
|
- name: download filtermail
|
||||||
run: curl -L https://github.com/chatmail/filtermail/releases/download/v0.6.6/filtermail-x86_64 -o /usr/local/bin/filtermail && chmod +x /usr/local/bin/filtermail
|
run: curl -L https://github.com/chatmail/filtermail/releases/download/v0.7.0/filtermail-x86_64 -o /usr/local/bin/filtermail && chmod +x /usr/local/bin/filtermail
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
run: pipx run tox
|
run: pipx run tox
|
||||||
@@ -57,9 +57,9 @@ jobs:
|
|||||||
|
|
||||||
lxc-test:
|
lxc-test:
|
||||||
name: LXC deploy and test
|
name: LXC deploy and test
|
||||||
uses: chatmail/cmlxc/.github/workflows/lxc-test.yml@v0.14.6
|
uses: chatmail/cmlxc/.github/workflows/lxc-test.yml@main
|
||||||
with:
|
with:
|
||||||
cmlxc_version: v0.14.6
|
cmlxc_version: main
|
||||||
cmlxc_commands: |
|
cmlxc_commands: |
|
||||||
cmlxc init
|
cmlxc init
|
||||||
# single cmdeploy relay test
|
# single cmdeploy relay test
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ name: Trigger Docker build
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
|
tags: ['[0-9]+.[0-9]+.[0-9]+']
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
permissions: {}
|
permissions: {}
|
||||||
|
|||||||
+43
-1
@@ -1,4 +1,46 @@
|
|||||||
# Changelog for chatmail deployment
|
# Changelog for chatmail deployment
|
||||||
|
|
||||||
|
## [1.11.0] - 2026-05-15
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
|
||||||
|
- [**breaking**] Drop passthrough_sender and passthrough_recipients chatmail.ini options to eliminate one more source of unencrypted messages
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Use filtermail for delivery to remote MTAs
|
||||||
|
- Expose metadata "maxsmtprecipients" value
|
||||||
|
- Support setup without domain, with only an IPv4 address (#963)
|
||||||
|
- *(doc/docker)* Introduce docker images in documentation
|
||||||
|
- DKIM-sign bounce messages (mainly "user does not exist")
|
||||||
|
- *(config)* Load default values from Config(), not chatmail.ini.f (#853)
|
||||||
|
- Make turn_socket_path configurable, and cleanup tests and turnserver code.
|
||||||
|
- Warn about any unused chatmail.ini parameter at the end of "cmdeploy run"
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Make www tests work with editable instead of just plain installs
|
||||||
|
- Use path with no leading slash for mxdeliv
|
||||||
|
- Increase filtermail-transport concurrency limit
|
||||||
|
- Fix #972 by increasing file descriptors for filtermail
|
||||||
|
- *(mtail)* Correct boot ordering and deploy restart logic
|
||||||
|
- *(cmdeploy)* Stop and disable unbound-resolvconf
|
||||||
|
- *(nginx)* Properly redirect www to mail_domain
|
||||||
|
- *(dns)* Query correct NS if MNAME server is hidden (#954)
|
||||||
|
- Legacy token metadata storage used list type, but if no new setmetadata happened, the user would not be notified at all.
|
||||||
|
- *(logging)* Log all http requests to syslog
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
- Document how to upgrade to new version (#965)
|
||||||
|
|
||||||
|
### Other
|
||||||
|
|
||||||
|
- *(deps)* Upgrade to filtermail v0.6.4
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Introduce automated change-tracking across deployers
|
||||||
|
|
||||||
## 1.10.0 2026-04-30
|
## 1.10.0 2026-04-30
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,8 @@ def read_config(inipath):
|
|||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
raw_domain = params["mail_domain"]
|
params = dict(params)
|
||||||
|
raw_domain = params.pop("mail_domain")
|
||||||
self.mail_domain_bare = raw_domain
|
self.mail_domain_bare = raw_domain
|
||||||
|
|
||||||
if is_valid_ipv4(raw_domain):
|
if is_valid_ipv4(raw_domain):
|
||||||
@@ -29,60 +30,59 @@ class Config:
|
|||||||
self.mail_domain = raw_domain
|
self.mail_domain = raw_domain
|
||||||
self.postfix_myhostname = raw_domain
|
self.postfix_myhostname = raw_domain
|
||||||
|
|
||||||
self.max_user_send_per_minute = int(params.get("max_user_send_per_minute", 60))
|
self.max_user_send_per_minute = int(params.pop("max_user_send_per_minute", 60))
|
||||||
self.max_user_send_burst_size = int(params.get("max_user_send_burst_size", 10))
|
self.max_user_send_burst_size = int(params.pop("max_user_send_burst_size", 10))
|
||||||
self.max_mailbox_size = params.get("max_mailbox_size", "500M")
|
self.max_mailbox_size = params.pop("max_mailbox_size", "500M")
|
||||||
self.max_message_size = int(params.get("max_message_size", 31457280))
|
self.max_message_size = int(params.pop("max_message_size", 31457280))
|
||||||
self.delete_mails_after = params.get("delete_mails_after", "20")
|
self.delete_mails_after = params.pop("delete_mails_after", "20")
|
||||||
self.delete_large_after = params.get("delete_large_after", "7")
|
self.delete_large_after = params.pop("delete_large_after", "7")
|
||||||
self.delete_inactive_users_after = int(
|
self.delete_inactive_users_after = int(
|
||||||
params.get("delete_inactive_users_after", 90)
|
params.pop("delete_inactive_users_after", 90)
|
||||||
)
|
)
|
||||||
self.username_min_length = int(params.get("username_min_length", 9))
|
self.username_min_length = int(params.pop("username_min_length", 9))
|
||||||
self.username_max_length = int(params.get("username_max_length", 9))
|
self.username_max_length = int(params.pop("username_max_length", 9))
|
||||||
self.password_min_length = int(params.get("password_min_length", 9))
|
self.password_min_length = int(params.pop("password_min_length", 9))
|
||||||
self.passthrough_senders = params.get("passthrough_senders", "").split()
|
self.www_folder = params.pop("www_folder", "")
|
||||||
self.passthrough_recipients = params.get("passthrough_recipients", "").split()
|
self.filtermail_smtp_port = int(params.pop("filtermail_smtp_port", "10080"))
|
||||||
self.www_folder = params.get("www_folder", "")
|
|
||||||
self.filtermail_smtp_port = int(params.get("filtermail_smtp_port", "10080"))
|
|
||||||
self.filtermail_smtp_port_incoming = int(
|
self.filtermail_smtp_port_incoming = int(
|
||||||
params.get("filtermail_smtp_port_incoming", "10081")
|
params.pop("filtermail_smtp_port_incoming", "10081")
|
||||||
)
|
)
|
||||||
self.filtermail_http_port_incoming = int(
|
self.filtermail_http_port_incoming = int(
|
||||||
params.get("filtermail_http_port_incoming", "10082")
|
params.pop("filtermail_http_port_incoming", "10082")
|
||||||
)
|
)
|
||||||
self.filtermail_lmtp_port_transport = int(
|
self.filtermail_lmtp_port_transport = int(
|
||||||
params.get("filtermail_lmtp_port_transport", "10083")
|
params.pop("filtermail_lmtp_port_transport", "10083")
|
||||||
)
|
)
|
||||||
self.postfix_reinject_port = int(params.get("postfix_reinject_port", "10025"))
|
self.postfix_reinject_port = int(params.pop("postfix_reinject_port", "10025"))
|
||||||
self.postfix_reinject_port_incoming = int(
|
self.postfix_reinject_port_incoming = int(
|
||||||
params.get("postfix_reinject_port_incoming", "10026")
|
params.pop("postfix_reinject_port_incoming", "10026")
|
||||||
)
|
)
|
||||||
self.mtail_address = params.get("mtail_address")
|
self.mtail_address = params.pop("mtail_address", None)
|
||||||
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
self.disable_ipv6 = params.pop("disable_ipv6", "false").lower() == "true"
|
||||||
self.acme_email = params.get("acme_email", "")
|
self.acme_email = params.pop("acme_email", "")
|
||||||
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
self.imap_rawlog = params.pop("imap_rawlog", "false").lower() == "true"
|
||||||
self.imap_compress = params.get("imap_compress", "false").lower() == "true"
|
self.imap_compress = params.pop("imap_compress", "false").lower() == "true"
|
||||||
self.turn_socket_path = params.get(
|
self.turn_socket_path = params.pop(
|
||||||
"turn_socket_path", "/run/chatmail-turn/turn.socket"
|
"turn_socket_path", "/run/chatmail-turn/turn.socket"
|
||||||
)
|
)
|
||||||
if "iroh_relay" not in params:
|
iroh_relay = params.pop("iroh_relay", None)
|
||||||
|
if iroh_relay is None:
|
||||||
self.iroh_relay = "https://" + raw_domain
|
self.iroh_relay = "https://" + raw_domain
|
||||||
self.enable_iroh_relay = True
|
self.enable_iroh_relay = True
|
||||||
else:
|
else:
|
||||||
self.iroh_relay = params["iroh_relay"].strip()
|
self.iroh_relay = iroh_relay.strip()
|
||||||
self.enable_iroh_relay = False
|
self.enable_iroh_relay = False
|
||||||
self.privacy_postal = params.get("privacy_postal")
|
self.privacy_postal = params.pop("privacy_postal", None)
|
||||||
self.privacy_mail = params.get("privacy_mail")
|
self.privacy_mail = params.pop("privacy_mail", None)
|
||||||
self.privacy_pdo = params.get("privacy_pdo")
|
self.privacy_pdo = params.pop("privacy_pdo", None)
|
||||||
self.privacy_supervisor = params.get("privacy_supervisor")
|
self.privacy_supervisor = params.pop("privacy_supervisor", None)
|
||||||
|
|
||||||
# TLS certificate management.
|
# TLS certificate management.
|
||||||
# If tls_external_cert_and_key is set, use externally managed certs.
|
# If tls_external_cert_and_key is set, use externally managed certs.
|
||||||
# Otherwise derived from the domain name:
|
# Otherwise derived from the domain name:
|
||||||
# - Domains starting with "_" use self-signed certificates
|
# - Domains starting with "_" use self-signed certificates
|
||||||
# - All other domains use ACME.
|
# - All other domains use ACME.
|
||||||
external = params.get("tls_external_cert_and_key", "").strip()
|
external = params.pop("tls_external_cert_and_key", "").strip()
|
||||||
|
|
||||||
if external:
|
if external:
|
||||||
parts = external.split()
|
parts = external.split()
|
||||||
@@ -103,11 +103,12 @@ class Config:
|
|||||||
self.tls_key_path = f"/var/lib/acme/live/{raw_domain}/privkey"
|
self.tls_key_path = f"/var/lib/acme/live/{raw_domain}/privkey"
|
||||||
|
|
||||||
# deprecated option
|
# deprecated option
|
||||||
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{raw_domain}")
|
mbdir = params.pop("mailboxes_dir", f"/home/vmail/mail/{raw_domain}")
|
||||||
self.mailboxes_dir = Path(mbdir.strip())
|
self.mailboxes_dir = Path(mbdir.strip())
|
||||||
|
|
||||||
# old unused option (except for first migration from sqlite to maildir store)
|
# old unused option (except for first migration from sqlite to maildir store)
|
||||||
self.passdb_path = Path(params.get("passdb_path", "/home/vmail/passdb.sqlite"))
|
self.passdb_path = Path(params.pop("passdb_path", "/home/vmail/passdb.sqlite"))
|
||||||
|
self._unused_keys = list(params)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def max_mailbox_size_mb(self):
|
def max_mailbox_size_mb(self):
|
||||||
|
|||||||
@@ -168,6 +168,16 @@ class Expiry:
|
|||||||
if mbox.last_login and mbox.last_login < cutoff_without_login:
|
if mbox.last_login and mbox.last_login < cutoff_without_login:
|
||||||
self.remove_mailbox(mbox.basedir)
|
self.remove_mailbox(mbox.basedir)
|
||||||
return
|
return
|
||||||
|
elif mbox.last_login is None:
|
||||||
|
try:
|
||||||
|
if not self.dry:
|
||||||
|
os.rmdir(mbox.basedir)
|
||||||
|
self.del_mboxes += 1
|
||||||
|
except OSError:
|
||||||
|
print_info(
|
||||||
|
f"Skipped deleting {mbox.basedir}, doesn't have last_login but isn't empty"
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
mboxname = os.path.basename(mbox.basedir)
|
mboxname = os.path.basename(mbox.basedir)
|
||||||
if self.verbose:
|
if self.verbose:
|
||||||
|
|||||||
@@ -42,13 +42,6 @@ mail_domain = {mail_domain}
|
|||||||
# minimum length a password must have
|
# minimum length a password must have
|
||||||
#password_min_length = 9
|
#password_min_length = 9
|
||||||
|
|
||||||
# list of chatmail addresses which can send outbound un-encrypted mail
|
|
||||||
#passthrough_senders =
|
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
|
||||||
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
|
||||||
#passthrough_recipients =
|
|
||||||
|
|
||||||
# Use externally managed TLS certificates instead of built-in acmetool.
|
# Use externally managed TLS certificates instead of built-in acmetool.
|
||||||
# Paths refer to files on the deployment server (not the build machine).
|
# Paths refer to files on the deployment server (not the build machine).
|
||||||
# Both files must already exist before running cmdeploy.
|
# Both files must already exist before running cmdeploy.
|
||||||
|
|||||||
@@ -125,6 +125,8 @@ class MetadataDictProxy(DictProxy):
|
|||||||
case "maxsmtprecipients":
|
case "maxsmtprecipients":
|
||||||
# postfix default (see "postconf smtpd_recipient_limit")
|
# postfix default (see "postconf smtpd_recipient_limit")
|
||||||
return "O1000\n"
|
return "O1000\n"
|
||||||
|
case "unixtimestamp":
|
||||||
|
return f"O{int(time.time())}\n"
|
||||||
|
|
||||||
logging.warning(f"lookup ignored: {parts!r}")
|
logging.warning(f"lookup ignored: {parts!r}")
|
||||||
return "N\n"
|
return "N\n"
|
||||||
|
|||||||
@@ -45,8 +45,12 @@ def test_read_config_basic_using_defaults(tmp_path, maildomain):
|
|||||||
assert example_config.username_min_length == 9
|
assert example_config.username_min_length == 9
|
||||||
assert example_config.username_max_length == 9
|
assert example_config.username_max_length == 9
|
||||||
assert example_config.password_min_length == 9
|
assert example_config.password_min_length == 9
|
||||||
assert example_config.passthrough_recipients == []
|
assert example_config._unused_keys == []
|
||||||
assert example_config.passthrough_senders == []
|
|
||||||
|
|
||||||
|
def test_config_unused_keys(make_config):
|
||||||
|
config = make_config("chat.example.org", {"passthrough_senders": "x@y.org"})
|
||||||
|
assert config._unused_keys == ["passthrough_senders"]
|
||||||
|
|
||||||
|
|
||||||
def test_config_userstate_paths(make_config, tmp_path):
|
def test_config_userstate_paths(make_config, tmp_path):
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import itertools
|
import itertools
|
||||||
import os
|
import os
|
||||||
import random
|
import random
|
||||||
|
import shutil
|
||||||
import time
|
import time
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from fnmatch import fnmatch
|
from fnmatch import fnmatch
|
||||||
@@ -9,6 +10,7 @@ from pathlib import Path
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from chatmaild.expire import (
|
from chatmaild.expire import (
|
||||||
|
Expiry,
|
||||||
FileEntry,
|
FileEntry,
|
||||||
MailboxStat,
|
MailboxStat,
|
||||||
expire_to_target,
|
expire_to_target,
|
||||||
@@ -104,6 +106,32 @@ def test_stats_mailbox(mbox1):
|
|||||||
assert mbox3.last_login is None
|
assert mbox3.last_login is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_mbox_without_password(mbox1, example_config, capsys):
|
||||||
|
password = Path(mbox1.basedir).joinpath("password")
|
||||||
|
os.remove(password)
|
||||||
|
mbox_rescan = MailboxStat(mbox1.basedir)
|
||||||
|
assert mbox_rescan.last_login is None
|
||||||
|
|
||||||
|
exp = Expiry(
|
||||||
|
example_config, dry=False, now=datetime.now().timestamp(), verbose=False
|
||||||
|
)
|
||||||
|
exp.process_mailbox_stat(mbox_rescan)
|
||||||
|
out, err = capsys.readouterr()
|
||||||
|
assert "doesn't have last_login but isn't empty" in err
|
||||||
|
assert os.path.isdir(mbox_rescan.basedir)
|
||||||
|
|
||||||
|
for entry in os.scandir(mbox_rescan.basedir):
|
||||||
|
if os.path.isdir(entry):
|
||||||
|
shutil.rmtree(entry)
|
||||||
|
else:
|
||||||
|
os.remove(entry)
|
||||||
|
|
||||||
|
exp.process_mailbox_stat(mbox_rescan)
|
||||||
|
out, err = capsys.readouterr()
|
||||||
|
assert "doesn't have last_login but isn't empty" not in err
|
||||||
|
assert not os.path.isdir(mbox_rescan.basedir)
|
||||||
|
|
||||||
|
|
||||||
def test_report_no_mailboxes(example_config):
|
def test_report_no_mailboxes(example_config):
|
||||||
args = (str(example_config._inipath),)
|
args = (str(example_config._inipath),)
|
||||||
report_main(args)
|
report_main(args)
|
||||||
|
|||||||
@@ -84,6 +84,15 @@ def run_cmd_options(parser):
|
|||||||
add_ssh_host_option(parser)
|
add_ssh_host_option(parser)
|
||||||
|
|
||||||
|
|
||||||
|
def _warn_unused_settings(unused_keys, out):
|
||||||
|
if unused_keys:
|
||||||
|
names = ", ".join(unused_keys)
|
||||||
|
out.red(
|
||||||
|
f"WARNING: chatmail.ini contains settings that have no effect: {names}\n"
|
||||||
|
"Please remove them from chatmail.ini."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
|
||||||
@@ -125,6 +134,7 @@ def run_cmd(args, out):
|
|||||||
out.green("Deploy completed.")
|
out.green("Deploy completed.")
|
||||||
else:
|
else:
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
out.green("Deploy completed, call `cmdeploy dns` next.")
|
||||||
|
_warn_unused_settings(args.config._unused_keys, out)
|
||||||
return 0
|
return 0
|
||||||
except subprocess.CalledProcessError:
|
except subprocess.CalledProcessError:
|
||||||
out.red("Deploy failed")
|
out.red("Deploy failed")
|
||||||
|
|||||||
@@ -171,16 +171,14 @@ class UnboundDeployer(Deployer):
|
|||||||
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
if self.config.disable_ipv6:
|
self.ensure_directory(
|
||||||
self.ensure_directory(
|
path="/etc/unbound/unbound.conf.d",
|
||||||
path="/etc/unbound/unbound.conf.d",
|
)
|
||||||
)
|
self.put_template(
|
||||||
self.put_template(
|
"unbound/unbound.conf.j2",
|
||||||
"unbound/unbound.conf.j2",
|
"/etc/unbound/unbound.conf.d/chatmail.conf",
|
||||||
"/etc/unbound/unbound.conf.d/chatmail.conf",
|
disable_ipv6=self.config.disable_ipv6,
|
||||||
)
|
)
|
||||||
else:
|
|
||||||
self.remove_file("/etc/unbound/unbound.conf.d/chatmail.conf")
|
|
||||||
|
|
||||||
def activate(self):
|
def activate(self):
|
||||||
server.shell(
|
server.shell(
|
||||||
@@ -514,6 +512,8 @@ def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -
|
|||||||
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
||||||
("filtermail", config.filtermail_smtp_port),
|
("filtermail", config.filtermail_smtp_port),
|
||||||
("filtermail", config.filtermail_smtp_port_incoming),
|
("filtermail", config.filtermail_smtp_port_incoming),
|
||||||
|
("filtermail", config.filtermail_http_port_incoming),
|
||||||
|
("filtermail", config.filtermail_lmtp_port_transport),
|
||||||
]
|
]
|
||||||
for service, port in port_services:
|
for service, port in port_services:
|
||||||
print(f"Checking if port {port} is available for {service}...")
|
print(f"Checking if port {port} is available for {service}...")
|
||||||
|
|||||||
@@ -20,10 +20,10 @@ class FiltermailDeployer(Deployer):
|
|||||||
return
|
return
|
||||||
|
|
||||||
arch = host.get_fact(facts.server.Arch)
|
arch = host.get_fact(facts.server.Arch)
|
||||||
url = f"https://github.com/chatmail/filtermail/releases/download/v0.6.6/filtermail-{arch}"
|
url = f"https://github.com/chatmail/filtermail/releases/download/v0.7.0/filtermail-{arch}"
|
||||||
sha256sum = {
|
sha256sum = {
|
||||||
"x86_64": "05c7e7ac244606c2eeb275f2d282ffdbc2403e0169f1cdd3110ffcebdb994a92",
|
"x86_64": "451f295a85b3b12dbb0f89e18ec319f742ee46dec218f20f7923bfb017a248bd",
|
||||||
"aarch64": "8cf8bbda4d907beca547b365cc7e6753532a74b1712492d0d2f3d2d8a553fb3d",
|
"aarch64": "6833061b2a2028264fdeb32f0a6123e1ff73de57dace125364016300b748452e",
|
||||||
}[arch]
|
}[arch]
|
||||||
self.download_executable(url, self.bin_path, sha256sum)
|
self.download_executable(url, self.bin_path, sha256sum)
|
||||||
|
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ ExecStart={{ bin_path }} {{ config_path }} transport
|
|||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=vmail
|
User=vmail
|
||||||
|
LimitNOFILE=524288
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
|
|||||||
@@ -1,5 +1,23 @@
|
|||||||
|
# List of headers for incoming messages
|
||||||
|
# that must be retained for functionality and compatibility reasons
|
||||||
/^From:/ DUNNO
|
/^From:/ DUNNO
|
||||||
/^Message-Id:/ DUNNO
|
/^Message-Id:/ DUNNO
|
||||||
/^Chat-Is-Post-Message:/ DUNNO
|
/^Chat-/ DUNNO
|
||||||
/^Content-Type:/ DUNNO
|
/^Content-Type:/ DUNNO
|
||||||
|
|
||||||
|
# For receiving clear-text messages (still supported in May 2026)
|
||||||
|
/^Subject:/ DUNNO
|
||||||
|
/^Date:/ DUNNO
|
||||||
|
/^To:/ DUNNO
|
||||||
|
/^CC:/ DUNNO
|
||||||
|
/^References:/ DUNNO
|
||||||
|
/^In-Reply-To:/ DUNNO
|
||||||
|
|
||||||
|
# Senders might support Autocrypt 1 but not RFC9788 (Header Protection)
|
||||||
|
/^Autocrypt:/ DUNNO
|
||||||
|
|
||||||
|
# SecureJoin V2 protocol headers (for backward compatibility)
|
||||||
|
/^Secure-Join/ DUNNO
|
||||||
|
|
||||||
|
# Ignore all other headers
|
||||||
/.*/ IGNORE
|
/.*/ IGNORE
|
||||||
|
|||||||
@@ -53,7 +53,8 @@ smtpd_tls_exclude_ciphers = aNULL, RC4, MD5, DES
|
|||||||
# See <https://www.postfix.org/FORWARD_SECRECY_README.html#server_fs>.
|
# See <https://www.postfix.org/FORWARD_SECRECY_README.html#server_fs>.
|
||||||
tls_preempt_cipherlist = yes
|
tls_preempt_cipherlist = yes
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
# Reject by default, override per smtpd in master.cf
|
||||||
|
smtpd_relay_restrictions = reject
|
||||||
myhostname = {{ config.postfix_myhostname }}
|
myhostname = {{ config.postfix_myhostname }}
|
||||||
alias_maps = hash:/etc/aliases
|
alias_maps = hash:/etc/aliases
|
||||||
alias_database = hash:/etc/aliases
|
alias_database = hash:/etc/aliases
|
||||||
@@ -101,9 +102,24 @@ smtpd_peername_lookup = no
|
|||||||
# so instead this is handled in filtermail.
|
# so instead this is handled in filtermail.
|
||||||
# We use LMTP instead SMTP so we can communicate per-recipient errors back to postfix.
|
# We use LMTP instead SMTP so we can communicate per-recipient errors back to postfix.
|
||||||
default_transport = lmtp-filtermail:inet:[127.0.0.1]:{{ config.filtermail_lmtp_port_transport }}
|
default_transport = lmtp-filtermail:inet:[127.0.0.1]:{{ config.filtermail_lmtp_port_transport }}
|
||||||
|
|
||||||
|
# All deliveries over lmtp-filtermail are treated
|
||||||
|
# as having the same destination [127.0.0.1],
|
||||||
|
# so it is not possible to limit per-destination concurrency here,
|
||||||
|
# it is a job for filtermail-transport.
|
||||||
|
# Total number of parallel deliveries is limited
|
||||||
|
# by "maxproc" column in /etc/postfix/master.cf for lmtp-filtermail.
|
||||||
|
# Settings below are to prevent Postfix queue manager
|
||||||
|
# from limiting the number of LMTP connections to filtermail-transport.
|
||||||
|
# Read <https://www.postfix.org/TUNING_README.html#rope> and
|
||||||
|
# <https://www.postfix.org/SCHEDULER_README.html> for the details
|
||||||
|
# of the Postfix algorithm that we effectively disable here.
|
||||||
lmtp-filtermail_initial_destination_concurrency=10000
|
lmtp-filtermail_initial_destination_concurrency=10000
|
||||||
lmtp-filtermail_destination_concurrency_limit=10000
|
lmtp-filtermail_destination_concurrency_limit=10000
|
||||||
|
|
||||||
|
# Do not try to deliver messages for more than 2 days.
|
||||||
|
maximal_queue_lifetime = 2d
|
||||||
|
|
||||||
{% if not config.ipv4_relay %}
|
{% if not config.ipv4_relay %}
|
||||||
# DKIM-sign locally generated mail (bounces, DSNs).
|
# DKIM-sign locally generated mail (bounces, DSNs).
|
||||||
# These bypass smtpd, so they need explicit milter configuration.
|
# These bypass smtpd, so they need explicit milter configuration.
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ smtp inet n - y - - smtpd
|
|||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
-o smtpd_tls_mandatory_protocols=>=TLSv1.2
|
-o smtpd_tls_mandatory_protocols=>=TLSv1.2
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port_incoming }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port_incoming }}
|
||||||
|
-o smtpd_relay_restrictions=reject_unauth_destination
|
||||||
submission inet n - y - 5000 smtpd
|
submission inet n - y - 5000 smtpd
|
||||||
-o syslog_name=postfix/submission
|
-o syslog_name=postfix/submission
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
@@ -81,12 +82,14 @@ filter unix - n n - - lmtp
|
|||||||
-o syslog_name=postfix/reinject
|
-o syslog_name=postfix/reinject
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o cleanup_service_name=authclean
|
-o cleanup_service_name=authclean
|
||||||
|
-o smtpd_relay_restrictions=permit_mynetworks,reject
|
||||||
{% if not config.ipv4_relay %} -o smtpd_milters=unix:opendkim/opendkim.sock
|
{% if not config.ipv4_relay %} -o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
# Local SMTP server for reinjecting incoming filtered mail
|
# Local SMTP server for reinjecting incoming filtered mail
|
||||||
127.0.0.1:{{ config.postfix_reinject_port_incoming }} inet n - n - 100 smtpd
|
127.0.0.1:{{ config.postfix_reinject_port_incoming }} inet n - n - 100 smtpd
|
||||||
-o syslog_name=postfix/reinject_incoming
|
-o syslog_name=postfix/reinject_incoming
|
||||||
|
-o smtpd_relay_restrictions=reject_unauth_destination
|
||||||
|
|
||||||
# Cleanup `Received` headers for authenticated mail
|
# Cleanup `Received` headers for authenticated mail
|
||||||
# to avoid leaking client IP.
|
# to avoid leaking client IP.
|
||||||
@@ -102,7 +105,15 @@ filter unix - n n - - lmtp
|
|||||||
authclean unix n - - - 0 cleanup
|
authclean unix n - - - 0 cleanup
|
||||||
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
||||||
|
|
||||||
lmtp-filtermail unix - - y - 10000 lmtp
|
# Reducing `maxproc` here may result in a head of line blocking
|
||||||
|
# when there are many messages sent to unreachable destinations
|
||||||
|
# at the same time.
|
||||||
|
# LMTP clients here talk to filtermail-transport.
|
||||||
|
# LMTP has no pipelining,
|
||||||
|
# so while filtermail-transport tries to deliver the message,
|
||||||
|
# possibly waiting for a long connection timeout
|
||||||
|
# or talking to a slow server, LMTP client cannot be reused.
|
||||||
|
lmtp-filtermail unix - - y - 500 lmtp
|
||||||
-o syslog_name=postfix/lmtp-filtermail
|
-o syslog_name=postfix/lmtp-filtermail
|
||||||
-o lmtp_header_checks=
|
-o lmtp_header_checks=
|
||||||
-o lmtp_tls_security_level=none
|
-o lmtp_tls_security_level=none
|
||||||
|
|||||||
@@ -232,6 +232,26 @@ def try_n_times(n, f):
|
|||||||
return f()
|
return f()
|
||||||
|
|
||||||
|
|
||||||
|
def test_rewrite_subject(cmsetup, maildata):
|
||||||
|
"""Test that subject gets replaced with [...]."""
|
||||||
|
user1, user2 = cmsetup.gen_users(2)
|
||||||
|
|
||||||
|
sent_msg = maildata(
|
||||||
|
"encrypted.eml",
|
||||||
|
from_addr=user1.addr,
|
||||||
|
to_addr=user2.addr,
|
||||||
|
subject="Unencrypted subject",
|
||||||
|
).as_string()
|
||||||
|
user1.smtp.sendmail(from_addr=user1.addr, to_addrs=[user2.addr], msg=sent_msg)
|
||||||
|
|
||||||
|
# The message may need some time to get delivered by postfix.
|
||||||
|
messages = try_n_times(5, user2.imap.fetch_all_messages)
|
||||||
|
assert len(messages) == 1
|
||||||
|
rcvd_msg = messages[0]
|
||||||
|
assert "Subject: [...]" not in sent_msg
|
||||||
|
assert "Subject: [...]" in rcvd_msg
|
||||||
|
assert "Subject: Unencrypted subject" in sent_msg
|
||||||
|
assert "Subject: Unencrypted subject" not in rcvd_msg
|
||||||
|
|
||||||
|
|
||||||
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
||||||
|
|||||||
@@ -349,9 +349,9 @@ class ChatmailACFactory:
|
|||||||
qr = (
|
qr = (
|
||||||
f"dclogin:{addr}"
|
f"dclogin:{addr}"
|
||||||
f"?p={password}&v=1"
|
f"?p={password}&v=1"
|
||||||
f"&ih={domain}&ip=993"
|
f"&ih={domain}&ip=993&is=ssl"
|
||||||
f"&sh={domain}&sp=465"
|
f"&sh={domain}&sp=465&ss=ssl"
|
||||||
f"&ic=3&ss=default"
|
f"&ic=3"
|
||||||
)
|
)
|
||||||
future = account.add_transport_from_qr.future(qr)
|
future = account.add_transport_from_qr.future(qr)
|
||||||
else:
|
else:
|
||||||
@@ -362,7 +362,7 @@ class ChatmailACFactory:
|
|||||||
|
|
||||||
# ensure messages stay in INBOX so that they can be
|
# ensure messages stay in INBOX so that they can be
|
||||||
# concurrently fetched via extra IMAP connections during tests
|
# concurrently fetched via extra IMAP connections during tests
|
||||||
account.set_config("delete_server_after", "10")
|
account.set_config("bcc_self", "1")
|
||||||
accounts.append(account)
|
accounts.append(account)
|
||||||
|
|
||||||
for future in futures:
|
for future in futures:
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
# Managed by cmdeploy: disable IPv6 in unbound.
|
# Managed by cmdeploy
|
||||||
server:
|
server:
|
||||||
|
{% if disable_ipv6 %}
|
||||||
interface: 127.0.0.1
|
interface: 127.0.0.1
|
||||||
do-ip6: no
|
do-ip6: no
|
||||||
|
{% endif %}
|
||||||
|
cache-max-negative-ttl: 0
|
||||||
|
|||||||
@@ -60,6 +60,7 @@ and run the following commands:
|
|||||||
::
|
::
|
||||||
|
|
||||||
git pull origin main --rebase --autostash
|
git pull origin main --rebase --autostash
|
||||||
|
scripts/initenv.sh
|
||||||
scripts/cmdeploy run
|
scripts/cmdeploy run
|
||||||
|
|
||||||
If you don't want the latest development version,
|
If you don't want the latest development version,
|
||||||
|
|||||||
+56
-15
@@ -156,6 +156,7 @@ Chatmail relay dependency diagram
|
|||||||
postfix --- |10083|filtermail-transport;
|
postfix --- |10083|filtermail-transport;
|
||||||
filtermail-outgoing --- |10025 reinject|postfix;
|
filtermail-outgoing --- |10025 reinject|postfix;
|
||||||
filtermail-incoming --- |10026 reinject|postfix;
|
filtermail-incoming --- |10026 reinject|postfix;
|
||||||
|
postfix --- |milter opendkim.sock|OpenDKIM
|
||||||
dovecot --- |doveauth.socket|doveauth;
|
dovecot --- |doveauth.socket|doveauth;
|
||||||
dovecot --- |message delivery|maildir["maildir
|
dovecot --- |message delivery|maildir["maildir
|
||||||
/home/vmail/.../user"];
|
/home/vmail/.../user"];
|
||||||
@@ -179,26 +180,66 @@ Chatmail relay dependency diagram
|
|||||||
style nginx-right fill:#f66;
|
style nginx-right fill:#f66;
|
||||||
style postfix fill:#f66;
|
style postfix fill:#f66;
|
||||||
style dovecot fill:#f66;
|
style dovecot fill:#f66;
|
||||||
|
style OpenDKIM fill:#f66;
|
||||||
style notification-proxy fill:#f66;
|
style notification-proxy fill:#f66;
|
||||||
|
|
||||||
Message between users on the same relay
|
Accepting and delivering mail
|
||||||
---------------------------------------
|
-----------------------------
|
||||||
|
|
||||||
.. mermaid::
|
.. mermaid::
|
||||||
:caption: This diagram shows the path a non-federated message takes.
|
:caption: This diagram shows all the paths a message can take.
|
||||||
|
|
||||||
graph LR;
|
flowchart LR
|
||||||
sender --> |465|smtps/smtpd;
|
subgraph chatmail relay
|
||||||
sender --> |587|submission/smtpd;
|
subgraph postfix
|
||||||
smtps/smtpd --> |10080|filtermail;
|
qmgr .-> lmtp-filtermail["lmtp/lmtp-filtermail (default_transport)"]
|
||||||
submission/smtpd --> |10080|filtermail;
|
qmgr .-> lmtp["lmtp (local_transport)"]
|
||||||
filtermail --> |10025|smtpd_reinject;
|
lmtp --> cleanup["cleanup (lmtp_header_cleanup)"]
|
||||||
smtpd_reinject --> cleanup;
|
bounce
|
||||||
cleanup --> qmgr;
|
smtpd-submission["smtpd/submission"]
|
||||||
qmgr --> smtpd_accepts_message;
|
smtpd-smtps["smtpd/smtps"]
|
||||||
qmgr --> |lmtp|dovecot;
|
smtpd-reinject-outgoing["smtpd/reinject-outgoing"] --> authclean["cleanup/authclean (submission_header_cleanup)"]
|
||||||
dovecot --> recipient;
|
authclean --> qmgr
|
||||||
dovecot --> sender's_other_devices;
|
smtpd-smtp["smtpd/smtp"]
|
||||||
|
smtpd-reinject-incoming["smtpd/reinject-incoming"] --> qmgr
|
||||||
|
end
|
||||||
|
lmtp-filtermail --LMTP inet:10083--> filtermail-transport
|
||||||
|
cleanup --LMTP unix:private/dovecot-lmtp --> dovecot
|
||||||
|
dovecot --> maildir
|
||||||
|
smtpd-submission --SMTP inet:10080--> filtermail-outgoing
|
||||||
|
smtpd-smtps --SMTP inet:10080--> filtermail-outgoing
|
||||||
|
filtermail-outgoing --SMTP inet:10025--> smtpd-reinject-outgoing
|
||||||
|
open-dkim["OpenDKIM (signing only)"] <--milter unix:opendkim/opendkim.sock--> smtpd-reinject-outgoing
|
||||||
|
bounce <--milter unix:opendkim/opendkim.sock--> open-dkim
|
||||||
|
bounce --> qmgr
|
||||||
|
nginx
|
||||||
|
smtpd-smtp -.SMTP inet:10081.-> filtermail-incoming
|
||||||
|
nginx -.HTTP inet:10082.-> filtermail-incoming
|
||||||
|
filtermail-incoming --SMTP inet:10026--> smtpd-reinject-incoming
|
||||||
|
end
|
||||||
|
filtermail-transport -.SMTP inet:25.-> mta1[Remote relay]
|
||||||
|
filtermail-transport -.HTTPS /mxdeliv.-> mta1
|
||||||
|
client[Client] -.SMTP inet:587.-> smtpd-submission
|
||||||
|
client -.SMTP inet:465.-> smtpd-smtps
|
||||||
|
client -.SMTP inet:443.-> nginx
|
||||||
|
nginx -.SMTP inet:465.-> smtpd-smtps
|
||||||
|
mta2[Remote relay] -.SMTP inet:25.-> smtpd-smtp
|
||||||
|
mta2 -.HTTPS /mxdeliv.-> nginx
|
||||||
|
style postfix fill:#363
|
||||||
|
style qmgr fill:#252
|
||||||
|
style authclean fill:#252
|
||||||
|
style cleanup fill:#252
|
||||||
|
style lmtp-filtermail fill:#252
|
||||||
|
style lmtp fill:#252
|
||||||
|
style bounce fill:#252
|
||||||
|
style smtpd-submission fill:#252
|
||||||
|
style smtpd-smtps fill:#252
|
||||||
|
style smtpd-reinject-outgoing fill:#252
|
||||||
|
style smtpd-reinject-incoming fill:#252
|
||||||
|
style smtpd-smtp fill:#252
|
||||||
|
style filtermail-outgoing fill:#225
|
||||||
|
style filtermail-incoming fill:#225
|
||||||
|
style filtermail-transport fill:#225
|
||||||
|
|
||||||
Operational details of a chatmail relay
|
Operational details of a chatmail relay
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user