mirror of
https://github.com/chatmail/relay.git
synced 2026-05-12 00:54:37 +00:00
Compare commits
12 Commits
hpk/lxcdep
...
fix/multip
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1d8e44a948 | ||
|
|
447c0ee33d | ||
|
|
47c9586b67 | ||
|
|
e32816b477 | ||
|
|
0d3cde9850 | ||
|
|
c48a7d80dc | ||
|
|
93eb996a42 | ||
|
|
0148ecde8e | ||
|
|
3ad8e5a6ee | ||
|
|
a5dc1d886d | ||
|
|
0443965f63 | ||
|
|
ea52fde2d9 |
2
.github/workflows/ci.yaml
vendored
2
.github/workflows/ci.yaml
vendored
@@ -15,7 +15,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
- name: download filtermail
|
- name: download filtermail
|
||||||
run: curl -L https://github.com/chatmail/filtermail/releases/download/v0.6.0/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.2.0/filtermail-x86_64-musl -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
|
||||||
|
|||||||
28
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
28
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
@@ -71,34 +71,26 @@ jobs:
|
|||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
- name: setup dependencies
|
- run: |
|
||||||
run: |
|
cmdeploy init staging-ipv4.testrun.org
|
||||||
ssh root@staging-ipv4.testrun.org apt update
|
sed -i 's#disable_ipv6 = False#disable_ipv6 = True#' chatmail.ini
|
||||||
ssh root@staging-ipv4.testrun.org apt install -y git python3.11-venv python3-dev gcc
|
sed -i 's/#\s*mtail_address/mtail_address/' chatmail.ini
|
||||||
ssh root@staging-ipv4.testrun.org git clone https://github.com/chatmail/relay
|
|
||||||
ssh root@staging-ipv4.testrun.org "cd relay && git checkout " ${{ github.head_ref }}
|
|
||||||
ssh root@staging-ipv4.testrun.org "cd relay && scripts/initenv.sh"
|
|
||||||
|
|
||||||
- name: initialize config
|
- run: cmdeploy run --verbose --skip-dns-check
|
||||||
run: |
|
|
||||||
ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy init staging-ipv4.testrun.org"
|
|
||||||
ssh root@staging-ipv4.testrun.org "sed -i 's#disable_ipv6 = False#disable_ipv6 = True#' relay/chatmail.ini"
|
|
||||||
ssh root@staging-ipv4.testrun.org "sed -i 's/#\s*mtail_address/mtail_address/' relay/chatmail.ini"
|
|
||||||
|
|
||||||
- run: ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy run --verbose --skip-dns-check --ssh-host localhost"
|
|
||||||
|
|
||||||
- name: set DNS entries
|
- name: set DNS entries
|
||||||
run: |
|
run: |
|
||||||
ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy dns --zonefile staging-generated.zone --ssh-host localhost"
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
||||||
ssh root@staging-ipv4.testrun.org cat relay/staging-generated.zone >> .github/workflows/staging-ipv4.testrun.org-default.zone
|
cmdeploy dns --zonefile staging-generated.zone
|
||||||
|
cat staging-generated.zone >> .github/workflows/staging-ipv4.testrun.org-default.zone
|
||||||
cat .github/workflows/staging-ipv4.testrun.org-default.zone
|
cat .github/workflows/staging-ipv4.testrun.org-default.zone
|
||||||
scp .github/workflows/staging-ipv4.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging-ipv4.testrun.org.zone
|
scp .github/workflows/staging-ipv4.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging-ipv4.testrun.org.zone
|
||||||
ssh root@ns.testrun.org nsd-checkzone staging-ipv4.testrun.org /etc/nsd/staging-ipv4.testrun.org.zone
|
ssh root@ns.testrun.org nsd-checkzone staging-ipv4.testrun.org /etc/nsd/staging-ipv4.testrun.org.zone
|
||||||
ssh root@ns.testrun.org systemctl reload nsd
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
- name: cmdeploy test
|
- name: cmdeploy test
|
||||||
run: ssh root@staging-ipv4.testrun.org "cd relay && CHATMAIL_DOMAIN2=ci-chatmail.testrun.org scripts/cmdeploy test --slow --ssh-host localhost"
|
run: CHATMAIL_DOMAIN2=ci-chatmail.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
- name: cmdeploy dns
|
- name: cmdeploy dns
|
||||||
run: ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy dns -v --ssh-host localhost"
|
run: cmdeploy dns -v
|
||||||
|
|
||||||
|
|||||||
1
.github/workflows/test-and-deploy.yaml
vendored
1
.github/workflows/test-and-deploy.yaml
vendored
@@ -82,6 +82,7 @@ jobs:
|
|||||||
|
|
||||||
- name: set DNS entries
|
- name: set DNS entries
|
||||||
run: |
|
run: |
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new root@staging2.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
||||||
cmdeploy dns --zonefile staging-generated.zone --verbose
|
cmdeploy dns --zonefile staging-generated.zone --verbose
|
||||||
cat staging-generated.zone >> .github/workflows/staging.testrun.org-default.zone
|
cat staging-generated.zone >> .github/workflows/staging.testrun.org-default.zone
|
||||||
cat .github/workflows/staging.testrun.org-default.zone
|
cat .github/workflows/staging.testrun.org-default.zone
|
||||||
|
|||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -4,8 +4,7 @@ __pycache__/
|
|||||||
*$py.class
|
*$py.class
|
||||||
*.swp
|
*.swp
|
||||||
*qr-*.png
|
*qr-*.png
|
||||||
chatmail*.ini
|
chatmail.ini
|
||||||
lxconfigs/
|
|
||||||
|
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ where = ['src']
|
|||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
chatmail-metadata = "chatmaild.metadata:main"
|
chatmail-metadata = "chatmaild.metadata:main"
|
||||||
|
chatmail-metrics = "chatmaild.metrics:main"
|
||||||
chatmail-expire = "chatmaild.expire:main"
|
chatmail-expire = "chatmaild.expire:main"
|
||||||
chatmail-fsreport = "chatmaild.fsreport:main"
|
chatmail-fsreport = "chatmaild.fsreport:main"
|
||||||
lastlogin = "chatmaild.lastlogin:main"
|
lastlogin = "chatmaild.lastlogin:main"
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
import os
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import iniconfig
|
import iniconfig
|
||||||
@@ -44,8 +43,6 @@ class Config:
|
|||||||
)
|
)
|
||||||
self.mtail_address = params.get("mtail_address")
|
self.mtail_address = params.get("mtail_address")
|
||||||
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
||||||
self.addr_v4 = os.environ.get("CHATMAIL_ADDR_V4", "")
|
|
||||||
self.addr_v6 = os.environ.get("CHATMAIL_ADDR_V6", "")
|
|
||||||
self.acme_email = params.get("acme_email", "")
|
self.acme_email = params.get("acme_email", "")
|
||||||
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
||||||
self.imap_compress = params.get("imap_compress", "false").lower() == "true"
|
self.imap_compress = params.get("imap_compress", "false").lower() == "true"
|
||||||
@@ -60,31 +57,6 @@ class Config:
|
|||||||
self.privacy_pdo = params.get("privacy_pdo")
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
self.privacy_supervisor = params.get("privacy_supervisor")
|
self.privacy_supervisor = params.get("privacy_supervisor")
|
||||||
|
|
||||||
# TLS certificate management.
|
|
||||||
# If tls_external_cert_and_key is set, use externally managed certs.
|
|
||||||
# Otherwise derived from the domain name:
|
|
||||||
# - Domains starting with "_" use self-signed certificates
|
|
||||||
# - All other domains use ACME.
|
|
||||||
external = params.get("tls_external_cert_and_key", "").strip()
|
|
||||||
|
|
||||||
if external:
|
|
||||||
parts = external.split()
|
|
||||||
if len(parts) != 2:
|
|
||||||
raise ValueError(
|
|
||||||
"tls_external_cert_and_key must have two space-separated"
|
|
||||||
" paths: CERT_PATH KEY_PATH"
|
|
||||||
)
|
|
||||||
self.tls_cert_mode = "external"
|
|
||||||
self.tls_cert_path, self.tls_key_path = parts
|
|
||||||
elif self.mail_domain.startswith("_"):
|
|
||||||
self.tls_cert_mode = "self"
|
|
||||||
self.tls_cert_path = "/etc/ssl/certs/mailserver.pem"
|
|
||||||
self.tls_key_path = "/etc/ssl/private/mailserver.key"
|
|
||||||
else:
|
|
||||||
self.tls_cert_mode = "acme"
|
|
||||||
self.tls_cert_path = f"/var/lib/acme/live/{self.mail_domain}/fullchain"
|
|
||||||
self.tls_key_path = f"/var/lib/acme/live/{self.mail_domain}/privkey"
|
|
||||||
|
|
||||||
# deprecated option
|
# deprecated option
|
||||||
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
||||||
self.mailboxes_dir = Path(mbdir.strip())
|
self.mailboxes_dir = Path(mbdir.strip())
|
||||||
|
|||||||
@@ -13,20 +13,9 @@ to show storage summaries only for first 1000 mailboxes
|
|||||||
|
|
||||||
python -m chatmaild.fsreport /path/to/chatmail.ini --maxnum 1000
|
python -m chatmaild.fsreport /path/to/chatmail.ini --maxnum 1000
|
||||||
|
|
||||||
to write Prometheus textfile for node_exporter
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport --textfile /var/lib/prometheus/node-exporter/
|
|
||||||
|
|
||||||
writes to /var/lib/prometheus/node-exporter/fsreport.prom
|
|
||||||
|
|
||||||
to also write legacy metrics.py style output (default: /var/www/html/metrics):
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport --textfile /var/lib/prometheus/node-exporter/ --legacy-metrics
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import tempfile
|
|
||||||
from argparse import ArgumentParser
|
from argparse import ArgumentParser
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
@@ -59,19 +48,7 @@ class Report:
|
|||||||
self.num_ci_logins = self.num_all_logins = 0
|
self.num_ci_logins = self.num_all_logins = 0
|
||||||
self.login_buckets = {x: 0 for x in (1, 10, 30, 40, 80, 100, 150)}
|
self.login_buckets = {x: 0 for x in (1, 10, 30, 40, 80, 100, 150)}
|
||||||
|
|
||||||
KiB = 1024
|
self.message_buckets = {x: 0 for x in (0, 160000, 500000, 2000000)}
|
||||||
MiB = 1024 * KiB
|
|
||||||
self.message_size_thresholds = (
|
|
||||||
0,
|
|
||||||
100 * KiB,
|
|
||||||
MiB // 2,
|
|
||||||
1 * MiB,
|
|
||||||
2 * MiB,
|
|
||||||
5 * MiB,
|
|
||||||
10 * MiB,
|
|
||||||
)
|
|
||||||
self.message_buckets = {x: 0 for x in self.message_size_thresholds}
|
|
||||||
self.message_count_buckets = {x: 0 for x in self.message_size_thresholds}
|
|
||||||
|
|
||||||
def process_mailbox_stat(self, mailbox):
|
def process_mailbox_stat(self, mailbox):
|
||||||
# categorize login times
|
# categorize login times
|
||||||
@@ -94,7 +71,6 @@ class Report:
|
|||||||
if self.mdir and f"/{self.mdir}/" not in msg.path:
|
if self.mdir and f"/{self.mdir}/" not in msg.path:
|
||||||
continue
|
continue
|
||||||
self.message_buckets[size] += msg.size
|
self.message_buckets[size] += msg.size
|
||||||
self.message_count_buckets[size] += 1
|
|
||||||
|
|
||||||
self.size_messages += sum(entry.size for entry in mailbox.messages)
|
self.size_messages += sum(entry.size for entry in mailbox.messages)
|
||||||
self.size_extra += sum(entry.size for entry in mailbox.extrafiles)
|
self.size_extra += sum(entry.size for entry in mailbox.extrafiles)
|
||||||
@@ -117,10 +93,9 @@ class Report:
|
|||||||
|
|
||||||
pref = f"[{self.mdir}] " if self.mdir else ""
|
pref = f"[{self.mdir}] " if self.mdir else ""
|
||||||
for minsize, sumsize in self.message_buckets.items():
|
for minsize, sumsize in self.message_buckets.items():
|
||||||
count = self.message_count_buckets[minsize]
|
|
||||||
percent = (sumsize / all_messages * 100) if all_messages else 0
|
percent = (sumsize / all_messages * 100) if all_messages else 0
|
||||||
print(
|
print(
|
||||||
f"{pref}larger than {HSize(minsize)}: {HSize(sumsize)} ({percent:.2f}%), {count} msgs"
|
f"{pref}larger than {HSize(minsize)}: {HSize(sumsize)} ({percent:.2f}%)"
|
||||||
)
|
)
|
||||||
|
|
||||||
user_logins = self.num_all_logins - self.num_ci_logins
|
user_logins = self.num_all_logins - self.num_ci_logins
|
||||||
@@ -136,75 +111,6 @@ class Report:
|
|||||||
for days, active in self.login_buckets.items():
|
for days, active in self.login_buckets.items():
|
||||||
print(f"last {days:3} days: {HSize(active)} {p(active)}")
|
print(f"last {days:3} days: {HSize(active)} {p(active)}")
|
||||||
|
|
||||||
def _write_atomic(self, filepath, content):
|
|
||||||
"""Atomically write content to filepath via tmp+rename."""
|
|
||||||
dirpath = os.path.dirname(os.path.abspath(filepath))
|
|
||||||
fd, tmppath = tempfile.mkstemp(dir=dirpath, suffix=".tmp")
|
|
||||||
try:
|
|
||||||
with os.fdopen(fd, "w") as f:
|
|
||||||
f.write(content)
|
|
||||||
os.chmod(tmppath, 0o644)
|
|
||||||
os.rename(tmppath, filepath)
|
|
||||||
except BaseException:
|
|
||||||
try:
|
|
||||||
os.unlink(tmppath)
|
|
||||||
except OSError:
|
|
||||||
pass
|
|
||||||
raise
|
|
||||||
|
|
||||||
def dump_textfile(self, filepath):
|
|
||||||
"""Dump metrics in Prometheus exposition format."""
|
|
||||||
lines = []
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_storage_bytes Mailbox storage in bytes.")
|
|
||||||
lines.append("# TYPE chatmail_storage_bytes gauge")
|
|
||||||
lines.append(f'chatmail_storage_bytes{{kind="messages"}} {self.size_messages}')
|
|
||||||
lines.append(f'chatmail_storage_bytes{{kind="extra"}} {self.size_extra}')
|
|
||||||
total = self.size_extra + self.size_messages
|
|
||||||
lines.append(f'chatmail_storage_bytes{{kind="total"}} {total}')
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_messages_bytes Sum of msg bytes >= threshold.")
|
|
||||||
lines.append("# TYPE chatmail_messages_bytes gauge")
|
|
||||||
for minsize, sumsize in self.message_buckets.items():
|
|
||||||
lines.append(f'chatmail_messages_bytes{{min_size="{minsize}"}} {sumsize}')
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_messages_count Number of msgs >= size threshold.")
|
|
||||||
lines.append("# TYPE chatmail_messages_count gauge")
|
|
||||||
for minsize, count in self.message_count_buckets.items():
|
|
||||||
lines.append(f'chatmail_messages_count{{min_size="{minsize}"}} {count}')
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_accounts Number of accounts.")
|
|
||||||
lines.append("# TYPE chatmail_accounts gauge")
|
|
||||||
user_logins = self.num_all_logins - self.num_ci_logins
|
|
||||||
lines.append(f'chatmail_accounts{{kind="all"}} {self.num_all_logins}')
|
|
||||||
lines.append(f'chatmail_accounts{{kind="ci"}} {self.num_ci_logins}')
|
|
||||||
lines.append(f'chatmail_accounts{{kind="user"}} {user_logins}')
|
|
||||||
|
|
||||||
lines.append(
|
|
||||||
"# HELP chatmail_accounts_active Non-CI accounts active within N days."
|
|
||||||
)
|
|
||||||
lines.append("# TYPE chatmail_accounts_active gauge")
|
|
||||||
for days, active in self.login_buckets.items():
|
|
||||||
lines.append(f'chatmail_accounts_active{{days="{days}"}} {active}')
|
|
||||||
|
|
||||||
self._write_atomic(filepath, "\n".join(lines) + "\n")
|
|
||||||
|
|
||||||
def dump_compat_textfile(self, filepath):
|
|
||||||
"""Dump legacy metrics.py style metrics."""
|
|
||||||
user_logins = self.num_all_logins - self.num_ci_logins
|
|
||||||
lines = [
|
|
||||||
"# HELP total number of accounts",
|
|
||||||
"# TYPE accounts gauge",
|
|
||||||
f"accounts {self.num_all_logins}",
|
|
||||||
"# HELP number of CI accounts",
|
|
||||||
"# TYPE ci_accounts gauge",
|
|
||||||
f"ci_accounts {self.num_ci_logins}",
|
|
||||||
"# HELP number of non-CI accounts",
|
|
||||||
"# TYPE nonci_accounts gauge",
|
|
||||||
f"nonci_accounts {user_logins}",
|
|
||||||
]
|
|
||||||
self._write_atomic(filepath, "\n".join(lines) + "\n")
|
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
def main(args=None):
|
||||||
"""Report about filesystem storage usage of all mailboxes and messages"""
|
"""Report about filesystem storage usage of all mailboxes and messages"""
|
||||||
@@ -221,21 +127,19 @@ def main(args=None):
|
|||||||
"--days",
|
"--days",
|
||||||
default=0,
|
default=0,
|
||||||
action="store",
|
action="store",
|
||||||
help="assume date to be DAYS older than now",
|
help="assume date to be days older than now",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--min-login-age",
|
"--min-login-age",
|
||||||
default=0,
|
default=0,
|
||||||
metavar="DAYS",
|
|
||||||
dest="min_login_age",
|
dest="min_login_age",
|
||||||
action="store",
|
action="store",
|
||||||
help="only sum up message size if last login is at least DAYS days old",
|
help="only sum up message size if last login is at least min-login-age days old",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--mdir",
|
"--mdir",
|
||||||
metavar="{cur,new,tmp}",
|
|
||||||
action="store",
|
action="store",
|
||||||
help="only consider messages in specified Maildir subdirectory for summary",
|
help="only consider 'cur' or 'new' or 'tmp' messages for summary",
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
@@ -244,21 +148,6 @@ def main(args=None):
|
|||||||
action="store",
|
action="store",
|
||||||
help="maximum number of mailboxes to iterate on",
|
help="maximum number of mailboxes to iterate on",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
|
||||||
"--textfile",
|
|
||||||
metavar="PATH",
|
|
||||||
default=None,
|
|
||||||
help="write Prometheus textfile to PATH (directory or file); "
|
|
||||||
"if PATH is a directory, writes 'fsreport.prom' inside it",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--legacy-metrics",
|
|
||||||
metavar="FILENAME",
|
|
||||||
nargs="?",
|
|
||||||
const="/var/www/html/metrics",
|
|
||||||
default=None,
|
|
||||||
help="write legacy metrics.py textfile (default: /var/www/html/metrics)",
|
|
||||||
)
|
|
||||||
|
|
||||||
args = parser.parse_args(args)
|
args = parser.parse_args(args)
|
||||||
|
|
||||||
@@ -272,15 +161,7 @@ def main(args=None):
|
|||||||
rep = Report(now=now, min_login_age=int(args.min_login_age), mdir=args.mdir)
|
rep = Report(now=now, min_login_age=int(args.min_login_age), mdir=args.mdir)
|
||||||
for mbox in iter_mailboxes(str(config.mailboxes_dir), maxnum=maxnum):
|
for mbox in iter_mailboxes(str(config.mailboxes_dir), maxnum=maxnum):
|
||||||
rep.process_mailbox_stat(mbox)
|
rep.process_mailbox_stat(mbox)
|
||||||
if args.textfile:
|
rep.dump_summary()
|
||||||
path = args.textfile
|
|
||||||
if os.path.isdir(path):
|
|
||||||
path = os.path.join(path, "fsreport.prom")
|
|
||||||
rep.dump_textfile(path)
|
|
||||||
if args.legacy_metrics:
|
|
||||||
rep.dump_compat_textfile(args.legacy_metrics)
|
|
||||||
if not args.textfile and not args.legacy_metrics:
|
|
||||||
rep.dump_summary()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -48,13 +48,6 @@ passthrough_senders =
|
|||||||
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
||||||
passthrough_recipients =
|
passthrough_recipients =
|
||||||
|
|
||||||
# Use externally managed TLS certificates instead of built-in acmetool.
|
|
||||||
# Paths refer to files on the deployment server (not the build machine).
|
|
||||||
# Both files must already exist before running cmdeploy.
|
|
||||||
# Certificate renewal is your responsibility; changed files are
|
|
||||||
# picked up automatically by all relay services.
|
|
||||||
# tls_external_cert_and_key = /path/to/fullchain.pem /path/to/privkey.pem
|
|
||||||
|
|
||||||
# path to www directory - documented here: https://chatmail.at/doc/relay/getting_started.html#custom-web-pages
|
# path to www directory - documented here: https://chatmail.at/doc/relay/getting_started.html#custom-web-pages
|
||||||
#www_folder = www
|
#www_folder = www
|
||||||
|
|
||||||
|
|||||||
32
chatmaild/src/chatmaild/metrics.py
Normal file
32
chatmaild/src/chatmaild/metrics.py
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
def main(vmail_dir=None):
|
||||||
|
if vmail_dir is None:
|
||||||
|
vmail_dir = sys.argv[1]
|
||||||
|
|
||||||
|
accounts = 0
|
||||||
|
ci_accounts = 0
|
||||||
|
|
||||||
|
for path in Path(vmail_dir).iterdir():
|
||||||
|
if not path.joinpath("cur").is_dir():
|
||||||
|
continue
|
||||||
|
accounts += 1
|
||||||
|
if path.name[:3] in ("ci-", "ac_"):
|
||||||
|
ci_accounts += 1
|
||||||
|
|
||||||
|
print("# HELP total number of accounts")
|
||||||
|
print("# TYPE accounts gauge")
|
||||||
|
print(f"accounts {accounts}")
|
||||||
|
print("# HELP number of CI accounts")
|
||||||
|
print("# TYPE ci_accounts gauge")
|
||||||
|
print(f"ci_accounts {ci_accounts}")
|
||||||
|
print("# HELP number of non-CI accounts")
|
||||||
|
print("# TYPE nonci_accounts gauge")
|
||||||
|
print(f"nonci_accounts {accounts - ci_accounts}")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -5,7 +5,6 @@
|
|||||||
import json
|
import json
|
||||||
import secrets
|
import secrets
|
||||||
import string
|
import string
|
||||||
from urllib.parse import quote
|
|
||||||
|
|
||||||
from chatmaild.config import Config, read_config
|
from chatmaild.config import Config, read_config
|
||||||
|
|
||||||
@@ -25,26 +24,13 @@ def create_newemail_dict(config: Config):
|
|||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
||||||
|
|
||||||
|
|
||||||
def create_dclogin_url(email, password):
|
|
||||||
"""Build a dclogin: URL with credentials and self-signed cert acceptance.
|
|
||||||
|
|
||||||
Uses ic=3 (AcceptInvalidCertificates) so chatmail clients
|
|
||||||
can connect to servers with self-signed TLS certificates.
|
|
||||||
"""
|
|
||||||
return f"dclogin:{quote(email, safe='@')}?p={quote(password, safe='')}&v=1&ic=3"
|
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
config = read_config(CONFIG_PATH)
|
config = read_config(CONFIG_PATH)
|
||||||
creds = create_newemail_dict(config)
|
creds = create_newemail_dict(config)
|
||||||
|
|
||||||
result = dict(email=creds["email"], password=creds["password"])
|
|
||||||
if config.tls_cert_mode == "self":
|
|
||||||
result["dclogin_url"] = create_dclogin_url(creds["email"], creds["password"])
|
|
||||||
|
|
||||||
print("Content-Type: application/json")
|
print("Content-Type: application/json")
|
||||||
print("")
|
print("")
|
||||||
print(json.dumps(result))
|
print(json.dumps(creds))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -85,13 +85,13 @@ def mockout():
|
|||||||
captured_green = []
|
captured_green = []
|
||||||
captured_plain = []
|
captured_plain = []
|
||||||
|
|
||||||
def red(self, msg, **kw):
|
def red(self, msg):
|
||||||
self.captured_red.append(msg)
|
self.captured_red.append(msg)
|
||||||
|
|
||||||
def green(self, msg, **kw):
|
def green(self, msg):
|
||||||
self.captured_green.append(msg)
|
self.captured_green.append(msg)
|
||||||
|
|
||||||
def print(self, msg="", **kw):
|
def __call__(self, msg):
|
||||||
self.captured_plain.append(msg)
|
self.captured_plain.append(msg)
|
||||||
|
|
||||||
return MockOut()
|
return MockOut()
|
||||||
|
|||||||
@@ -73,51 +73,3 @@ def test_config_userstate_paths(make_config, tmp_path):
|
|||||||
def test_config_max_message_size(make_config, tmp_path):
|
def test_config_max_message_size(make_config, tmp_path):
|
||||||
config = make_config("something.testrun.org", dict(max_message_size="10000"))
|
config = make_config("something.testrun.org", dict(max_message_size="10000"))
|
||||||
assert config.max_message_size == 10000
|
assert config.max_message_size == 10000
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_default_acme(make_config):
|
|
||||||
config = make_config("chat.example.org")
|
|
||||||
assert config.tls_cert_mode == "acme"
|
|
||||||
assert config.tls_cert_path == "/var/lib/acme/live/chat.example.org/fullchain"
|
|
||||||
assert config.tls_key_path == "/var/lib/acme/live/chat.example.org/privkey"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_self(make_config):
|
|
||||||
config = make_config("_test.example.org")
|
|
||||||
assert config.tls_cert_mode == "self"
|
|
||||||
assert config.tls_cert_path == "/etc/ssl/certs/mailserver.pem"
|
|
||||||
assert config.tls_key_path == "/etc/ssl/private/mailserver.key"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_external(make_config):
|
|
||||||
config = make_config(
|
|
||||||
"chat.example.org",
|
|
||||||
{
|
|
||||||
"tls_external_cert_and_key": "/custom/fullchain.pem /custom/privkey.pem",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert config.tls_cert_mode == "external"
|
|
||||||
assert config.tls_cert_path == "/custom/fullchain.pem"
|
|
||||||
assert config.tls_key_path == "/custom/privkey.pem"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_external_overrides_underscore(make_config):
|
|
||||||
config = make_config(
|
|
||||||
"_test.example.org",
|
|
||||||
{
|
|
||||||
"tls_external_cert_and_key": "/certs/fullchain.pem /certs/privkey.pem",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert config.tls_cert_mode == "external"
|
|
||||||
assert config.tls_cert_path == "/certs/fullchain.pem"
|
|
||||||
assert config.tls_key_path == "/certs/privkey.pem"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_external_bad_format(make_config):
|
|
||||||
with pytest.raises(ValueError, match="two space-separated"):
|
|
||||||
make_config(
|
|
||||||
"chat.example.org",
|
|
||||||
{
|
|
||||||
"tls_external_cert_and_key": "/only/one/path.pem",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -1,15 +1,9 @@
|
|||||||
import shutil
|
|
||||||
import smtplib
|
import smtplib
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
pytestmark = pytest.mark.skipif(
|
|
||||||
shutil.which("filtermail") is None,
|
|
||||||
reason="filtermail binary not found",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def smtpserver():
|
def smtpserver():
|
||||||
@@ -47,8 +41,6 @@ def test_one_mail(
|
|||||||
make_config, make_popen, smtpserver, maildata, filtermail_mode, monkeypatch
|
make_config, make_popen, smtpserver, maildata, filtermail_mode, monkeypatch
|
||||||
):
|
):
|
||||||
monkeypatch.setenv("PYTHONUNBUFFERED", "1")
|
monkeypatch.setenv("PYTHONUNBUFFERED", "1")
|
||||||
# DKIM is tested by cmdeploy tests.
|
|
||||||
monkeypatch.setenv("FILTERMAIL_SKIP_DKIM", "1")
|
|
||||||
smtp_inject_port = 20025
|
smtp_inject_port = 20025
|
||||||
if filtermail_mode == "outgoing":
|
if filtermail_mode == "outgoing":
|
||||||
settings = dict(
|
settings = dict(
|
||||||
@@ -66,10 +58,6 @@ def test_one_mail(
|
|||||||
|
|
||||||
popen = make_popen(["filtermail", path, filtermail_mode])
|
popen = make_popen(["filtermail", path, filtermail_mode])
|
||||||
line = popen.stderr.readline().strip()
|
line = popen.stderr.readline().strip()
|
||||||
|
|
||||||
# skip a warning that FILTERMAIL_SKIP_DKIM shouldn't be used in prod
|
|
||||||
if b"DKIM verification DISABLED!" in line:
|
|
||||||
line = popen.stderr.readline().strip()
|
|
||||||
if b"loop" not in line:
|
if b"loop" not in line:
|
||||||
print(line.decode("ascii"), file=sys.stderr)
|
print(line.decode("ascii"), file=sys.stderr)
|
||||||
pytest.fail("starting filtermail failed")
|
pytest.fail("starting filtermail failed")
|
||||||
|
|||||||
24
chatmaild/src/chatmaild/tests/test_metrics.py
Normal file
24
chatmaild/src/chatmaild/tests/test_metrics.py
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
from chatmaild.metrics import main
|
||||||
|
|
||||||
|
|
||||||
|
def test_main(tmp_path, capsys):
|
||||||
|
paths = []
|
||||||
|
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
||||||
|
p = tmp_path.joinpath(x)
|
||||||
|
p.mkdir()
|
||||||
|
p.joinpath("cur").mkdir()
|
||||||
|
paths.append(p)
|
||||||
|
|
||||||
|
tmp_path.joinpath("nomailbox").mkdir()
|
||||||
|
|
||||||
|
main(tmp_path)
|
||||||
|
out, _ = capsys.readouterr()
|
||||||
|
d = {}
|
||||||
|
for line in out.split("\n"):
|
||||||
|
if line.strip() and not line.startswith("#"):
|
||||||
|
name, num = line.split()
|
||||||
|
d[name] = int(num)
|
||||||
|
|
||||||
|
assert d["accounts"] == 4
|
||||||
|
assert d["ci_accounts"] == 3
|
||||||
|
assert d["nonci_accounts"] == 1
|
||||||
@@ -1,11 +1,7 @@
|
|||||||
import json
|
import json
|
||||||
|
|
||||||
import chatmaild
|
import chatmaild
|
||||||
from chatmaild.newemail import (
|
from chatmaild.newemail import create_newemail_dict, print_new_account
|
||||||
create_dclogin_url,
|
|
||||||
create_newemail_dict,
|
|
||||||
print_new_account,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_create_newemail_dict(example_config):
|
def test_create_newemail_dict(example_config):
|
||||||
@@ -19,18 +15,6 @@ def test_create_newemail_dict(example_config):
|
|||||||
assert ac1["password"] != ac2["password"]
|
assert ac1["password"] != ac2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_create_dclogin_url():
|
|
||||||
url = create_dclogin_url("user@example.org", "p@ss w+rd")
|
|
||||||
assert url.startswith("dclogin:")
|
|
||||||
assert "v=1" in url
|
|
||||||
assert "ic=3" in url
|
|
||||||
|
|
||||||
assert "user@example.org" in url
|
|
||||||
# password special chars must be encoded
|
|
||||||
assert "p%40ss" in url
|
|
||||||
assert "w%2Brd" in url
|
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
||||||
print_new_account()
|
print_new_account()
|
||||||
@@ -41,20 +25,3 @@ def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_conf
|
|||||||
dic = json.loads(lines[2])
|
dic = json.loads(lines[2])
|
||||||
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
||||||
assert len(dic["password"]) >= 10
|
assert len(dic["password"]) >= 10
|
||||||
# default tls_cert=acme should not include dclogin_url
|
|
||||||
assert "dclogin_url" not in dic
|
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account_self_signed(capsys, monkeypatch, make_config):
|
|
||||||
config = make_config("_test.example.org")
|
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(config._inipath))
|
|
||||||
print_new_account()
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
lines = out.split("\n")
|
|
||||||
dic = json.loads(lines[2])
|
|
||||||
assert "dclogin_url" in dic
|
|
||||||
url = dic["dclogin_url"]
|
|
||||||
assert url.startswith("dclogin:")
|
|
||||||
assert "ic=3" in url
|
|
||||||
|
|
||||||
assert dic["email"].split("@")[0] in url
|
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ dependencies = [
|
|||||||
"pytest-xdist",
|
"pytest-xdist",
|
||||||
"execnet",
|
"execnet",
|
||||||
"imap_tools",
|
"imap_tools",
|
||||||
"deltachat-rpc-client",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ Description=acmetool HTTP redirector
|
|||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=notify
|
Type=notify
|
||||||
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon --bind=127.0.0.1:402
|
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
|
|
||||||
|
|||||||
@@ -1,38 +1,10 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
import io
|
import io
|
||||||
import os
|
import os
|
||||||
from contextlib import contextmanager
|
|
||||||
|
|
||||||
from pyinfra.operations import files, server, systemd
|
from pyinfra.operations import files, server, systemd
|
||||||
|
|
||||||
|
|
||||||
def has_systemd():
|
|
||||||
"""Returns False during Docker image builds or any other non-systemd environment."""
|
|
||||||
return os.path.isdir("/run/systemd/system")
|
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def blocked_service_startup():
|
|
||||||
"""Prevent services from auto-starting during package installation.
|
|
||||||
|
|
||||||
Installs a ``/usr/sbin/policy-rc.d`` that exits 101, blocking any
|
|
||||||
service from being started by the package manager. This avoids bind
|
|
||||||
conflicts and CPU/RAM spikes during initial setup. The file is removed
|
|
||||||
when the context exits.
|
|
||||||
"""
|
|
||||||
# For documentation about policy-rc.d, see:
|
|
||||||
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
|
|
||||||
files.put(
|
|
||||||
src=get_resource("policy-rc.d"),
|
|
||||||
dest="/usr/sbin/policy-rc.d",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
yield
|
|
||||||
files.file("/usr/sbin/policy-rc.d", present=False)
|
|
||||||
|
|
||||||
|
|
||||||
def get_resource(arg, pkg=__package__):
|
def get_resource(arg, pkg=__package__):
|
||||||
return importlib.resources.files(pkg).joinpath(arg)
|
return importlib.resources.files(pkg).joinpath(arg)
|
||||||
|
|
||||||
|
|||||||
30
cmdeploy/src/cmdeploy/chatmail.zone.j2
Normal file
30
cmdeploy/src/cmdeploy/chatmail.zone.j2
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
;
|
||||||
|
; Required DNS entries for chatmail servers
|
||||||
|
;
|
||||||
|
{% if A %}
|
||||||
|
{{ mail_domain }}. A {{ A }}
|
||||||
|
{% endif %}
|
||||||
|
{% if AAAA %}
|
||||||
|
{{ mail_domain }}. AAAA {{ AAAA }}
|
||||||
|
{% endif %}
|
||||||
|
{{ mail_domain }}. MX 10 {{ mail_domain }}.
|
||||||
|
_mta-sts.{{ mail_domain }}. TXT "v=STSv1; id={{ sts_id }}"
|
||||||
|
mta-sts.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
||||||
|
www.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
||||||
|
{{ dkim_entry }}
|
||||||
|
|
||||||
|
;
|
||||||
|
; Recommended DNS entries for interoperability and security-hardening
|
||||||
|
;
|
||||||
|
{{ mail_domain }}. TXT "v=spf1 a ~all"
|
||||||
|
_dmarc.{{ mail_domain }}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
||||||
|
|
||||||
|
{% if acme_account_url %}
|
||||||
|
{{ mail_domain }}. CAA 0 issue "letsencrypt.org;accounturi={{ acme_account_url }}"
|
||||||
|
{% endif %}
|
||||||
|
_adsp._domainkey.{{ mail_domain }}. TXT "dkim=discardable"
|
||||||
|
|
||||||
|
_submission._tcp.{{ mail_domain }}. SRV 0 1 587 {{ mail_domain }}.
|
||||||
|
_submissions._tcp.{{ mail_domain }}. SRV 0 1 465 {{ mail_domain }}.
|
||||||
|
_imap._tcp.{{ mail_domain }}. SRV 0 1 143 {{ mail_domain }}.
|
||||||
|
_imaps._tcp.{{ mail_domain }}. SRV 0 1 993 {{ mail_domain }}.
|
||||||
@@ -5,6 +5,7 @@ along with command line option and subcommand parsing.
|
|||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
import importlib.util
|
||||||
import os
|
import os
|
||||||
import pathlib
|
import pathlib
|
||||||
import shutil
|
import shutil
|
||||||
@@ -15,27 +16,10 @@ from pathlib import Path
|
|||||||
import pyinfra
|
import pyinfra
|
||||||
from chatmaild.config import read_config, write_initial_config
|
from chatmaild.config import read_config, write_initial_config
|
||||||
from packaging import version
|
from packaging import version
|
||||||
|
from termcolor import colored
|
||||||
|
|
||||||
from . import dns, remote
|
from . import dns, remote
|
||||||
from .lxc.cli import (
|
from .sshexec import LocalExec, SSHExec
|
||||||
lxc_start_cmd,
|
|
||||||
lxc_start_cmd_options,
|
|
||||||
lxc_status_cmd,
|
|
||||||
lxc_status_cmd_options,
|
|
||||||
lxc_stop_cmd,
|
|
||||||
lxc_stop_cmd_options,
|
|
||||||
lxc_test_cmd,
|
|
||||||
lxc_test_cmd_options,
|
|
||||||
)
|
|
||||||
from .lxc.incus import DNSConfigurationError
|
|
||||||
from .sshexec import (
|
|
||||||
LocalExec,
|
|
||||||
SSHExec,
|
|
||||||
resolve_host_from_ssh_config,
|
|
||||||
resolve_key_from_ssh_config,
|
|
||||||
)
|
|
||||||
from .util import Out
|
|
||||||
from .www import main as webdev_main
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# cmdeploy sub commands and options
|
# cmdeploy sub commands and options
|
||||||
@@ -99,21 +83,17 @@ def run_cmd_options(parser):
|
|||||||
help="disable checks nslookup for dns",
|
help="disable checks nslookup for dns",
|
||||||
)
|
)
|
||||||
add_ssh_host_option(parser)
|
add_ssh_host_option(parser)
|
||||||
add_ssh_config_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
||||||
sshexec = get_sshexec(ssh_host, ssh_config=args.ssh_config)
|
sshexec = get_sshexec(ssh_host)
|
||||||
require_iroh = args.config.enable_iroh_relay
|
require_iroh = args.config.enable_iroh_relay
|
||||||
strict_tls = args.config.tls_cert_mode == "acme"
|
|
||||||
if not args.dns_check_disabled:
|
if not args.dns_check_disabled:
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
||||||
if not dns.check_initial_remote_data(
|
if not dns.check_initial_remote_data(remote_data, print=out.red):
|
||||||
remote_data, strict_tls=strict_tls, print=out.red
|
|
||||||
):
|
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
env = os.environ.copy()
|
env = os.environ.copy()
|
||||||
@@ -121,31 +101,11 @@ def run_cmd(args, out):
|
|||||||
env["CHATMAIL_WEBSITE_ONLY"] = "True" if args.website_only else ""
|
env["CHATMAIL_WEBSITE_ONLY"] = "True" if args.website_only else ""
|
||||||
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
||||||
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
||||||
if not args.dns_check_disabled:
|
|
||||||
env["CHATMAIL_ADDR_V4"] = remote_data.get("A") or ""
|
|
||||||
env["CHATMAIL_ADDR_V6"] = remote_data.get("AAAA") or ""
|
|
||||||
env["DEBIAN_FRONTEND"] = "noninteractive"
|
|
||||||
env["TERM"] = "linux"
|
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("run.py").resolve()
|
deploy_path = importlib.resources.files(__package__).joinpath("run.py").resolve()
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
|
|
||||||
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
||||||
ssh_config = args.ssh_config
|
|
||||||
if ssh_config:
|
|
||||||
ssh_config = str(Path(ssh_config).resolve())
|
|
||||||
|
|
||||||
# Use pyinfra's native SSH data keys to configure the connection directly
|
|
||||||
# rather than relying on paramiko config parsing (see also sshexec.py)
|
|
||||||
ip = resolve_host_from_ssh_config(ssh_host, ssh_config)
|
|
||||||
key = resolve_key_from_ssh_config(ssh_host, ssh_config)
|
|
||||||
data_args = f"--data ssh_hostname={ip} --data ssh_known_hosts_file=/dev/null"
|
|
||||||
if key:
|
|
||||||
data_args += f" --data ssh_key={key}"
|
|
||||||
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y {data_args}"
|
|
||||||
if ssh_host in ["localhost", "@docker"]:
|
if ssh_host in ["localhost", "@docker"]:
|
||||||
if ssh_host == "@docker":
|
|
||||||
env["CHATMAIL_NOPORTCHECK"] = "True"
|
|
||||||
env["CHATMAIL_NOSYSCTL"] = "True"
|
|
||||||
cmd = f"{pyinf} @local {deploy_path} -y"
|
cmd = f"{pyinf} @local {deploy_path} -y"
|
||||||
|
|
||||||
if version.parse(pyinfra.__version__) < version.parse("3"):
|
if version.parse(pyinfra.__version__) < version.parse("3"):
|
||||||
@@ -153,19 +113,9 @@ def run_cmd(args, out):
|
|||||||
return 1
|
return 1
|
||||||
|
|
||||||
try:
|
try:
|
||||||
ret = out.shell(cmd, env=env)
|
out.check_call(cmd, env=env)
|
||||||
if ret:
|
|
||||||
out.red("Deploy failed")
|
|
||||||
return 1
|
|
||||||
if args.website_only:
|
if args.website_only:
|
||||||
out.green("Website deployment completed.")
|
out.green("Website deployment completed.")
|
||||||
elif (
|
|
||||||
not args.dns_check_disabled
|
|
||||||
and strict_tls
|
|
||||||
and not remote_data["acme_account_url"]
|
|
||||||
):
|
|
||||||
out.red("Deploy completed but letsencrypt not configured")
|
|
||||||
out.red("Run 'cmdeploy run' again")
|
|
||||||
else:
|
else:
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
out.green("Deploy completed, call `cmdeploy dns` next.")
|
||||||
return 0
|
return 0
|
||||||
@@ -180,23 +130,20 @@ def dns_cmd_options(parser):
|
|||||||
dest="zonefile",
|
dest="zonefile",
|
||||||
type=pathlib.Path,
|
type=pathlib.Path,
|
||||||
default=None,
|
default=None,
|
||||||
help="write DNS records in standard BIND format to the given file",
|
help="write out a zonefile",
|
||||||
)
|
)
|
||||||
add_ssh_host_option(parser)
|
add_ssh_host_option(parser)
|
||||||
add_ssh_config_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd(args, out):
|
def dns_cmd(args, out):
|
||||||
"""Check DNS entries and optionally generate dns zone file."""
|
"""Check DNS entries and optionally generate dns zone file."""
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
||||||
sshexec = get_sshexec(ssh_host, verbose=args.verbose, ssh_config=args.ssh_config)
|
sshexec = get_sshexec(ssh_host, verbose=args.verbose)
|
||||||
tls_cert_mode = args.config.tls_cert_mode
|
|
||||||
strict_tls = tls_cert_mode == "acme"
|
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
||||||
if not dns.check_initial_remote_data(remote_data, strict_tls=strict_tls):
|
if not remote_data:
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
if strict_tls and not remote_data["acme_account_url"]:
|
if not remote_data["acme_account_url"]:
|
||||||
out.red("could not get letsencrypt account url, please run 'cmdeploy run'")
|
out.red("could not get letsencrypt account url, please run 'cmdeploy run'")
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
@@ -204,7 +151,6 @@ def dns_cmd(args, out):
|
|||||||
out.red("could not determine dkim_entry, please run 'cmdeploy run'")
|
out.red("could not determine dkim_entry, please run 'cmdeploy run'")
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
remote_data["strict_tls"] = strict_tls
|
|
||||||
zonefile = dns.get_filled_zone_file(remote_data)
|
zonefile = dns.get_filled_zone_file(remote_data)
|
||||||
|
|
||||||
if args.zonefile:
|
if args.zonefile:
|
||||||
@@ -220,14 +166,13 @@ def dns_cmd(args, out):
|
|||||||
|
|
||||||
def status_cmd_options(parser):
|
def status_cmd_options(parser):
|
||||||
add_ssh_host_option(parser)
|
add_ssh_host_option(parser)
|
||||||
add_ssh_config_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
def status_cmd(args, out):
|
||||||
"""Display status for online chatmail instance."""
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
||||||
sshexec = get_sshexec(ssh_host, verbose=args.verbose, ssh_config=args.ssh_config)
|
sshexec = get_sshexec(ssh_host, verbose=args.verbose)
|
||||||
|
|
||||||
out.green(f"chatmail domain: {args.config.mail_domain}")
|
out.green(f"chatmail domain: {args.config.mail_domain}")
|
||||||
if args.config.privacy_mail:
|
if args.config.privacy_mail:
|
||||||
@@ -246,15 +191,17 @@ def test_cmd_options(parser):
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="also run slow tests",
|
help="also run slow tests",
|
||||||
)
|
)
|
||||||
add_ssh_host_option(parser)
|
|
||||||
add_ssh_config_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cmd(args, out):
|
def test_cmd(args, out):
|
||||||
"""Run local and online tests for chatmail deployment."""
|
"""Run local and online tests for chatmail deployment.
|
||||||
|
|
||||||
env = os.environ.copy()
|
This will automatically pip-install 'deltachat' if it's not available.
|
||||||
env["CHATMAIL_INI"] = str(args.inipath.resolve())
|
"""
|
||||||
|
|
||||||
|
x = importlib.util.find_spec("deltachat")
|
||||||
|
if x is None:
|
||||||
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
pytest_path = shutil.which("pytest")
|
pytest_path = shutil.which("pytest")
|
||||||
pytest_args = [
|
pytest_args = [
|
||||||
@@ -268,11 +215,7 @@ def test_cmd(args, out):
|
|||||||
]
|
]
|
||||||
if args.slow:
|
if args.slow:
|
||||||
pytest_args.append("--slow")
|
pytest_args.append("--slow")
|
||||||
if args.ssh_host:
|
ret = out.run_ret(pytest_args)
|
||||||
pytest_args.extend(["--ssh-host", args.ssh_host])
|
|
||||||
if args.ssh_config:
|
|
||||||
pytest_args.extend(["--ssh-config", str(Path(args.ssh_config).resolve())])
|
|
||||||
ret = out.shell(" ".join(pytest_args), env=env)
|
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
|
|
||||||
@@ -309,8 +252,8 @@ def fmt_cmd(args, out):
|
|||||||
format_args.extend(sources)
|
format_args.extend(sources)
|
||||||
check_args.extend(sources)
|
check_args.extend(sources)
|
||||||
|
|
||||||
out.shell(" ".join(format_args), quiet=not args.verbose)
|
out.check_call(" ".join(format_args), quiet=not args.verbose)
|
||||||
out.shell(" ".join(check_args), quiet=not args.verbose)
|
out.check_call(" ".join(check_args), quiet=not args.verbose)
|
||||||
|
|
||||||
|
|
||||||
def bench_cmd(args, out):
|
def bench_cmd(args, out):
|
||||||
@@ -323,7 +266,9 @@ def bench_cmd(args, out):
|
|||||||
|
|
||||||
def webdev_cmd(args, out):
|
def webdev_cmd(args, out):
|
||||||
"""Run local web development loop for static web pages."""
|
"""Run local web development loop for static web pages."""
|
||||||
webdev_main()
|
from .www import main
|
||||||
|
|
||||||
|
main()
|
||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
@@ -331,6 +276,32 @@ def webdev_cmd(args, out):
|
|||||||
#
|
#
|
||||||
|
|
||||||
|
|
||||||
|
class Out:
|
||||||
|
"""Convenience output printer providing coloring."""
|
||||||
|
|
||||||
|
def red(self, msg, file=sys.stderr):
|
||||||
|
print(colored(msg, "red"), file=file)
|
||||||
|
|
||||||
|
def green(self, msg, file=sys.stderr):
|
||||||
|
print(colored(msg, "green"), file=file)
|
||||||
|
|
||||||
|
def __call__(self, msg, red=False, green=False, file=sys.stdout):
|
||||||
|
color = "red" if red else ("green" if green else None)
|
||||||
|
print(colored(msg, color), file=file)
|
||||||
|
|
||||||
|
def check_call(self, arg, env=None, quiet=False):
|
||||||
|
if not quiet:
|
||||||
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
|
return subprocess.check_call(arg, shell=True, env=env)
|
||||||
|
|
||||||
|
def run_ret(self, args, env=None, quiet=False):
|
||||||
|
if not quiet:
|
||||||
|
cmdstring = " ".join(args)
|
||||||
|
self(f"[$ {cmdstring}]", file=sys.stderr)
|
||||||
|
proc = subprocess.run(args, env=env, check=False)
|
||||||
|
return proc.returncode
|
||||||
|
|
||||||
|
|
||||||
def add_ssh_host_option(parser):
|
def add_ssh_host_option(parser):
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--ssh-host",
|
"--ssh-host",
|
||||||
@@ -340,45 +311,34 @@ def add_ssh_host_option(parser):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def add_ssh_config_option(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--ssh-config",
|
|
||||||
dest="ssh_config",
|
|
||||||
type=Path,
|
|
||||||
default=None,
|
|
||||||
help="Path to an SSH config file (e.g. lxconfigs/ssh-config).",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def add_config_option(parser):
|
def add_config_option(parser):
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--config",
|
"--config",
|
||||||
dest="inipath",
|
dest="inipath",
|
||||||
action="store",
|
action="store",
|
||||||
default=Path(os.environ.get("CHATMAIL_INI", "chatmail.ini")),
|
default=Path("chatmail.ini"),
|
||||||
type=Path,
|
type=Path,
|
||||||
help="path to the chatmail.ini file",
|
help="path to the chatmail.ini file",
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--verbose",
|
||||||
|
"-v",
|
||||||
|
dest="verbose",
|
||||||
|
action="store_true",
|
||||||
|
default=False,
|
||||||
|
help="provide verbose logging",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def add_subcommand(subparsers, func, add_config=True):
|
def add_subcommand(subparsers, func):
|
||||||
name = func.__name__
|
name = func.__name__
|
||||||
assert name.endswith("_cmd")
|
assert name.endswith("_cmd")
|
||||||
name = name[:-4].replace("_", "-")
|
name = name[:-4]
|
||||||
doc = func.__doc__.strip()
|
doc = func.__doc__.strip()
|
||||||
help = doc.split("\n")[0].strip(".")
|
help = doc.split("\n")[0].strip(".")
|
||||||
p = subparsers.add_parser(name, description=doc, help=help)
|
p = subparsers.add_parser(name, description=doc, help=help)
|
||||||
p.set_defaults(func=func)
|
p.set_defaults(func=func)
|
||||||
if add_config:
|
add_config_option(p)
|
||||||
add_config_option(p)
|
|
||||||
p.add_argument(
|
|
||||||
"-v",
|
|
||||||
"--verbose",
|
|
||||||
dest="verbose",
|
|
||||||
action="count",
|
|
||||||
default=0,
|
|
||||||
help="increase verbosity (can be repeated: -v, -vv)",
|
|
||||||
)
|
|
||||||
return p
|
return p
|
||||||
|
|
||||||
|
|
||||||
@@ -387,60 +347,45 @@ Setup your chatmail server configuration and
|
|||||||
deploy it via SSH to your remote location.
|
deploy it via SSH to your remote location.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# Explicit subcommand registry: (cmd_func, options_func_or_None, needs_config).
|
|
||||||
# LXC commands don't need a chatmail.ini (no config); all others do.
|
|
||||||
SUBCOMMANDS = [
|
|
||||||
(init_cmd, init_cmd_options, True),
|
|
||||||
(run_cmd, run_cmd_options, True),
|
|
||||||
(dns_cmd, dns_cmd_options, True),
|
|
||||||
(status_cmd, status_cmd_options, True),
|
|
||||||
(test_cmd, test_cmd_options, True),
|
|
||||||
(fmt_cmd, fmt_cmd_options, True),
|
|
||||||
(bench_cmd, None, True),
|
|
||||||
(webdev_cmd, None, True),
|
|
||||||
(lxc_start_cmd, lxc_start_cmd_options, False),
|
|
||||||
(lxc_stop_cmd, lxc_stop_cmd_options, False),
|
|
||||||
(lxc_status_cmd, lxc_status_cmd_options, False),
|
|
||||||
(lxc_test_cmd, lxc_test_cmd_options, False),
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def get_parser():
|
def get_parser():
|
||||||
"""Return an ArgumentParser for the 'cmdeploy' CLI"""
|
"""Return an ArgumentParser for the 'cmdeploy' CLI"""
|
||||||
|
|
||||||
parser = argparse.ArgumentParser(description=description.strip())
|
parser = argparse.ArgumentParser(description=description.strip())
|
||||||
parser.set_defaults(func=None, inipath=None)
|
|
||||||
subparsers = parser.add_subparsers(title="subcommands")
|
subparsers = parser.add_subparsers(title="subcommands")
|
||||||
|
|
||||||
for func, addopts, needs_config in SUBCOMMANDS:
|
# find all subcommands in the module namespace
|
||||||
subparser = add_subcommand(subparsers, func, add_config=needs_config)
|
glob = globals()
|
||||||
if addopts is not None:
|
for name, func in glob.items():
|
||||||
addopts(subparser)
|
if name.endswith("_cmd"):
|
||||||
|
subparser = add_subcommand(subparsers, func)
|
||||||
|
addopts = glob.get(name + "_options")
|
||||||
|
if addopts is not None:
|
||||||
|
addopts(subparser)
|
||||||
|
|
||||||
return parser
|
return parser
|
||||||
|
|
||||||
|
|
||||||
def get_sshexec(ssh_host: str, verbose=True, ssh_config=None):
|
def get_sshexec(ssh_host: str, verbose=True):
|
||||||
if ssh_host in ["localhost", "@local"]:
|
if ssh_host in ["localhost", "@local"]:
|
||||||
return LocalExec(verbose, docker=False)
|
return LocalExec(verbose, docker=False)
|
||||||
elif ssh_host == "@docker":
|
elif ssh_host == "@docker":
|
||||||
return LocalExec(verbose, docker=True)
|
return LocalExec(verbose, docker=True)
|
||||||
if verbose:
|
if verbose:
|
||||||
print(f"[ssh] login to {ssh_host}")
|
print(f"[ssh] login to {ssh_host}")
|
||||||
return SSHExec(ssh_host, verbose=verbose, ssh_config=ssh_config)
|
return SSHExec(ssh_host, verbose=verbose)
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
def main(args=None):
|
||||||
"""Provide main entry point for 'cmdeploy' CLI invocation."""
|
"""Provide main entry point for 'cmdeploy' CLI invocation."""
|
||||||
parser = get_parser()
|
parser = get_parser()
|
||||||
args = parser.parse_args(args=args)
|
args = parser.parse_args(args=args)
|
||||||
if args.func is None:
|
if not hasattr(args, "func"):
|
||||||
return parser.parse_args(["-h"])
|
return parser.parse_args(["-h"])
|
||||||
|
|
||||||
out = Out(verbosity=args.verbose)
|
out = Out()
|
||||||
kwargs = {}
|
kwargs = {}
|
||||||
|
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
||||||
if args.inipath is not None and args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
|
||||||
if not args.inipath.exists():
|
if not args.inipath.exists():
|
||||||
out.red(f"expecting {args.inipath} to exist, run init first?")
|
out.red(f"expecting {args.inipath} to exist, run init first?")
|
||||||
raise SystemExit(1)
|
raise SystemExit(1)
|
||||||
@@ -455,9 +400,6 @@ def main(args=None):
|
|||||||
if res is None:
|
if res is None:
|
||||||
res = 0
|
res = 0
|
||||||
return res
|
return res
|
||||||
except DNSConfigurationError as exc:
|
|
||||||
out.red(str(exc))
|
|
||||||
return 1
|
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
out.red("KeyboardInterrupt")
|
out.red("KeyboardInterrupt")
|
||||||
sys.exit(130)
|
sys.exit(130)
|
||||||
|
|||||||
@@ -2,46 +2,41 @@
|
|||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
from io import BytesIO, StringIO
|
from io import StringIO
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
from pyinfra import facts, host, logger
|
from pyinfra import facts, host, logger
|
||||||
from pyinfra.api import FactBase
|
from pyinfra.api import FactBase
|
||||||
from pyinfra.facts import hardware
|
|
||||||
from pyinfra.facts.files import Sha256File
|
from pyinfra.facts.files import Sha256File
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from pyinfra.operations import apt, files, pip, server, systemd
|
from pyinfra.operations import apt, files, pip, server, systemd
|
||||||
|
|
||||||
|
from cmdeploy.cmdeploy import Out
|
||||||
|
|
||||||
from .acmetool import AcmetoolDeployer
|
from .acmetool import AcmetoolDeployer
|
||||||
from .basedeploy import (
|
from .basedeploy import (
|
||||||
Deployer,
|
Deployer,
|
||||||
Deployment,
|
Deployment,
|
||||||
activate_remote_units,
|
activate_remote_units,
|
||||||
blocked_service_startup,
|
|
||||||
configure_remote_units,
|
configure_remote_units,
|
||||||
get_resource,
|
get_resource,
|
||||||
has_systemd,
|
|
||||||
)
|
)
|
||||||
from .dovecot.deployer import DovecotDeployer
|
from .dovecot.deployer import DovecotDeployer
|
||||||
from .external.deployer import ExternalTlsDeployer
|
|
||||||
from .filtermail.deployer import FiltermailDeployer
|
from .filtermail.deployer import FiltermailDeployer
|
||||||
from .mtail.deployer import MtailDeployer
|
from .mtail.deployer import MtailDeployer
|
||||||
from .nginx.deployer import NginxDeployer
|
from .nginx.deployer import NginxDeployer
|
||||||
from .opendkim.deployer import OpendkimDeployer
|
from .opendkim.deployer import OpendkimDeployer
|
||||||
from .postfix.deployer import PostfixDeployer
|
from .postfix.deployer import PostfixDeployer
|
||||||
from .selfsigned.deployer import SelfSignedTlsDeployer
|
|
||||||
from .util import Out, get_version_string
|
|
||||||
from .www import build_webpages, find_merge_conflict, get_paths
|
from .www import build_webpages, find_merge_conflict, get_paths
|
||||||
|
|
||||||
|
|
||||||
class Port(FactBase):
|
class Port(FactBase):
|
||||||
"""
|
"""
|
||||||
Returns the process occupying a port.
|
Returns the process occuping a port.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def command(self, port: int) -> str:
|
def command(self, port: int) -> str:
|
||||||
@@ -69,8 +64,6 @@ def _build_chatmaild(dist_dir) -> None:
|
|||||||
|
|
||||||
|
|
||||||
def remove_legacy_artifacts():
|
def remove_legacy_artifacts():
|
||||||
if not has_systemd():
|
|
||||||
return
|
|
||||||
# disable legacy doveauth-dictproxy.service
|
# disable legacy doveauth-dictproxy.service
|
||||||
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
||||||
systemd.service(
|
systemd.service(
|
||||||
@@ -123,6 +116,7 @@ def _install_remote_venv_with_chatmaild() -> None:
|
|||||||
|
|
||||||
def _configure_remote_venv_with_chatmaild(config) -> None:
|
def _configure_remote_venv_with_chatmaild(config) -> None:
|
||||||
remote_base_dir = "/usr/local/lib/chatmaild"
|
remote_base_dir = "/usr/local/lib/chatmaild"
|
||||||
|
remote_venv_dir = f"{remote_base_dir}/venv"
|
||||||
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
||||||
root_owned = dict(user="root", group="root", mode="644")
|
root_owned = dict(user="root", group="root", mode="644")
|
||||||
|
|
||||||
@@ -133,13 +127,16 @@ def _configure_remote_venv_with_chatmaild(config) -> None:
|
|||||||
**root_owned,
|
**root_owned,
|
||||||
)
|
)
|
||||||
|
|
||||||
files.file(
|
files.template(
|
||||||
path="/etc/cron.d/chatmail-metrics",
|
src=get_resource("metrics.cron.j2"),
|
||||||
present=False,
|
dest="/etc/cron.d/chatmail-metrics",
|
||||||
)
|
user="root",
|
||||||
files.file(
|
group="root",
|
||||||
path="/var/www/html/metrics",
|
mode="644",
|
||||||
present=False,
|
config={
|
||||||
|
"mailboxes_dir": config.mailboxes_dir,
|
||||||
|
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -149,16 +146,33 @@ class UnboundDeployer(Deployer):
|
|||||||
self.need_restart = False
|
self.need_restart = False
|
||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
# Run local DNS resolver `unbound`. `resolvconf` takes care of
|
# Run local DNS resolver `unbound`.
|
||||||
# setting up /etc/resolv.conf to use 127.0.0.1 as the resolver.
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
|
# to use 127.0.0.1 as the resolver.
|
||||||
|
|
||||||
# On an IPv4-only system, if unbound is started but not configured,
|
#
|
||||||
# it causes subsequent steps to fail to resolve hosts.
|
# On an IPv4-only system, if unbound is started but not
|
||||||
with blocked_service_startup():
|
# configured, it causes subsequent steps to fail to resolve hosts.
|
||||||
apt.packages(
|
# Here, we use policy-rc.d to prevent unbound from starting up
|
||||||
name="Install unbound",
|
# on initial install. Later, we will configure it and start it.
|
||||||
packages=["unbound", "unbound-anchor", "dnsutils"],
|
#
|
||||||
)
|
# For documentation about policy-rc.d, see:
|
||||||
|
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
|
||||||
|
#
|
||||||
|
files.put(
|
||||||
|
src=get_resource("policy-rc.d"),
|
||||||
|
dest="/usr/sbin/policy-rc.d",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="755",
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install unbound",
|
||||||
|
packages=["unbound", "unbound-anchor", "dnsutils"],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.file("/usr/sbin/policy-rc.d", present=False)
|
||||||
|
|
||||||
def configure(self):
|
def configure(self):
|
||||||
server.shell(
|
server.shell(
|
||||||
@@ -254,14 +268,8 @@ class WebsiteDeployer(Deployer):
|
|||||||
logger.warning("Web page build failed, skipping website deployment")
|
logger.warning("Web page build failed, skipping website deployment")
|
||||||
return
|
return
|
||||||
# if it is not a hugo page, upload it as is
|
# if it is not a hugo page, upload it as is
|
||||||
# pyinfra files.rsync (experimental) causes problems with ssh-config configuration
|
files.rsync(
|
||||||
# the stable files.sync should do
|
f"{www_path}/", "/var/www/html", flags=["-avz", "--chown=www-data"]
|
||||||
files.sync(
|
|
||||||
src=str(www_path),
|
|
||||||
dest="/var/www/html",
|
|
||||||
user="www-data",
|
|
||||||
group="www-data",
|
|
||||||
delete=True,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -293,7 +301,7 @@ class LegacyRemoveDeployer(Deployer):
|
|||||||
present=False,
|
present=False,
|
||||||
)
|
)
|
||||||
# remove echobot if it is still running
|
# remove echobot if it is still running
|
||||||
if has_systemd() and host.get_fact(SystemdEnabled).get("echobot.service"):
|
if host.get_fact(SystemdEnabled).get("echobot.service"):
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Disable echobot.service",
|
name="Disable echobot.service",
|
||||||
service="echobot.service",
|
service="echobot.service",
|
||||||
@@ -325,12 +333,12 @@ class TurnDeployer(Deployer):
|
|||||||
def install(self):
|
def install(self):
|
||||||
(url, sha256sum) = {
|
(url, sha256sum) = {
|
||||||
"x86_64": (
|
"x86_64": (
|
||||||
"https://github.com/chatmail/chatmail-turn/releases/download/v0.4/chatmail-turn-x86_64-linux",
|
"https://github.com/chatmail/chatmail-turn/releases/download/v0.3/chatmail-turn-x86_64-linux",
|
||||||
"1ec1f5c50122165e858a5a91bcba9037a28aa8cb8b64b8db570aa457c6141a8a",
|
"841e527c15fdc2940b0469e206188ea8f0af48533be12ecb8098520f813d41e4",
|
||||||
),
|
),
|
||||||
"aarch64": (
|
"aarch64": (
|
||||||
"https://github.com/chatmail/chatmail-turn/releases/download/v0.4/chatmail-turn-aarch64-linux",
|
"https://github.com/chatmail/chatmail-turn/releases/download/v0.3/chatmail-turn-aarch64-linux",
|
||||||
"0fb3e792419494e21ecad536464929dba706bb2c88884ed8f1788141d26fc756",
|
"a5fc2d06d937b56a34e098d2cd72a82d3e89967518d159bf246dc69b65e81b42",
|
||||||
),
|
),
|
||||||
}[host.get_fact(facts.server.Arch)]
|
}[host.get_fact(facts.server.Arch)]
|
||||||
|
|
||||||
@@ -463,19 +471,10 @@ class ChatmailDeployer(Deployer):
|
|||||||
("iroh", None, None),
|
("iroh", None, None),
|
||||||
]
|
]
|
||||||
|
|
||||||
def __init__(self, config):
|
def __init__(self, mail_domain):
|
||||||
self.config = config
|
self.mail_domain = mail_domain
|
||||||
self.mail_domain = config.mail_domain
|
|
||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
files.put(
|
|
||||||
name="Disable installing recommended packages globally",
|
|
||||||
src=BytesIO(b'APT::Install-Recommends "false";\n'),
|
|
||||||
dest="/etc/apt/apt.conf.d/00InstallRecommends",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
||||||
|
|
||||||
@@ -494,17 +493,6 @@ class ChatmailDeployer(Deployer):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def configure(self):
|
def configure(self):
|
||||||
# Ensure the per-domain mailbox directory exists before
|
|
||||||
# chatmail-metadata starts (it crashes without it).
|
|
||||||
files.directory(
|
|
||||||
name="Ensure vmail mailbox directory exists",
|
|
||||||
path=f"/home/vmail/mail/{self.mail_domain}",
|
|
||||||
user="vmail",
|
|
||||||
group="vmail",
|
|
||||||
mode="700",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
# This file is used by auth proxy.
|
# This file is used by auth proxy.
|
||||||
# https://wiki.debian.org/EtcMailName
|
# https://wiki.debian.org/EtcMailName
|
||||||
server.shell(
|
server.shell(
|
||||||
@@ -514,15 +502,6 @@ class ChatmailDeployer(Deployer):
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
files.directory(
|
|
||||||
name=f"Ensure mailboxes directory {self.config.mailboxes_dir} exists",
|
|
||||||
path=str(self.config.mailboxes_dir),
|
|
||||||
user="vmail",
|
|
||||||
group="vmail",
|
|
||||||
mode="700",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class FcgiwrapDeployer(Deployer):
|
class FcgiwrapDeployer(Deployer):
|
||||||
def install(self):
|
def install(self):
|
||||||
@@ -542,28 +521,22 @@ class FcgiwrapDeployer(Deployer):
|
|||||||
|
|
||||||
class GithashDeployer(Deployer):
|
class GithashDeployer(Deployer):
|
||||||
def activate(self):
|
def activate(self):
|
||||||
|
try:
|
||||||
|
git_hash = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode()
|
||||||
|
except Exception:
|
||||||
|
git_hash = "unknown\n"
|
||||||
|
try:
|
||||||
|
git_diff = subprocess.check_output(["git", "diff"]).decode()
|
||||||
|
except Exception:
|
||||||
|
git_diff = ""
|
||||||
files.put(
|
files.put(
|
||||||
name="Upload chatmail relay git commit hash",
|
name="Upload chatmail relay git commit hash",
|
||||||
src=StringIO(get_version_string()),
|
src=StringIO(git_hash + git_diff),
|
||||||
dest="/etc/chatmail-version",
|
dest="/etc/chatmail-version",
|
||||||
mode="700",
|
mode="700",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def get_tls_deployer(config, mail_domain):
|
|
||||||
"""Select the appropriate TLS deployer based on config."""
|
|
||||||
tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"]
|
|
||||||
|
|
||||||
if config.tls_cert_mode == "acme":
|
|
||||||
return AcmetoolDeployer(config.acme_email, tls_domains)
|
|
||||||
elif config.tls_cert_mode == "self":
|
|
||||||
return SelfSignedTlsDeployer(mail_domain)
|
|
||||||
elif config.tls_cert_mode == "external":
|
|
||||||
return ExternalTlsDeployer(config.tls_cert_path, config.tls_key_path)
|
|
||||||
else:
|
|
||||||
raise ValueError(f"Unknown tls_cert_mode: {config.tls_cert_mode}")
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -> None:
|
def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -> None:
|
||||||
"""Deploy a chat-mail instance.
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
@@ -587,68 +560,45 @@ def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -
|
|||||||
line="\nnameserver 9.9.9.9",
|
line="\nnameserver 9.9.9.9",
|
||||||
)
|
)
|
||||||
|
|
||||||
# Check if mtail_address interface is available (if configured)
|
port_services = [
|
||||||
if config.mtail_address and config.mtail_address not in (
|
(["master", "smtpd"], 25),
|
||||||
"127.0.0.1",
|
("unbound", 53),
|
||||||
"::1",
|
("acmetool", 80),
|
||||||
"localhost",
|
(["imap-login", "dovecot"], 143),
|
||||||
):
|
("nginx", 443),
|
||||||
ipv4_addrs = host.get_fact(hardware.Ipv4Addrs)
|
(["master", "smtpd"], 465),
|
||||||
all_addresses = [addr for addrs in ipv4_addrs.values() for addr in addrs]
|
(["master", "smtpd"], 587),
|
||||||
if config.mtail_address not in all_addresses:
|
(["imap-login", "dovecot"], 993),
|
||||||
Out().red(
|
("iroh-relay", 3340),
|
||||||
f"Deploy failed: mtail_address {config.mtail_address} is not available (VPN up?).\n"
|
("mtail", 3903),
|
||||||
)
|
("dovecot-stats", 3904),
|
||||||
exit(1)
|
("nginx", 8443),
|
||||||
|
(["master", "smtpd"], config.postfix_reinject_port),
|
||||||
|
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
||||||
|
("filtermail", config.filtermail_smtp_port),
|
||||||
|
("filtermail", config.filtermail_smtp_port_incoming),
|
||||||
|
]
|
||||||
|
for service, port in port_services:
|
||||||
|
print(f"Checking if port {port} is available for {service}...")
|
||||||
|
running_service = host.get_fact(Port, port=port)
|
||||||
|
if running_service:
|
||||||
|
if running_service not in service:
|
||||||
|
Out().red(
|
||||||
|
f"Deploy failed: port {port} is occupied by: {running_service}"
|
||||||
|
)
|
||||||
|
exit(1)
|
||||||
|
|
||||||
if not os.environ.get("CHATMAIL_NOPORTCHECK"):
|
tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"]
|
||||||
port_services = [
|
|
||||||
(["master", "smtpd"], 25),
|
|
||||||
("unbound", 53),
|
|
||||||
]
|
|
||||||
if config.tls_cert_mode == "acme":
|
|
||||||
port_services.append(("acmetool", 402))
|
|
||||||
port_services += [
|
|
||||||
(["imap-login", "dovecot"], 143),
|
|
||||||
# acmetool previously listened on port 80,
|
|
||||||
# so don't complain during upgrade that moved it to port 402
|
|
||||||
# and gave the port to nginx.
|
|
||||||
(["acmetool", "nginx"], 80),
|
|
||||||
("nginx", 443),
|
|
||||||
(["master", "smtpd"], 465),
|
|
||||||
(["master", "smtpd"], 587),
|
|
||||||
(["imap-login", "dovecot"], 993),
|
|
||||||
("iroh-relay", 3340),
|
|
||||||
("mtail", 3903),
|
|
||||||
("stats", 3904),
|
|
||||||
("nginx", 8443),
|
|
||||||
(["master", "smtpd"], config.postfix_reinject_port),
|
|
||||||
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
|
||||||
("filtermail", config.filtermail_smtp_port),
|
|
||||||
("filtermail", config.filtermail_smtp_port_incoming),
|
|
||||||
]
|
|
||||||
for service, port in port_services:
|
|
||||||
print(f"Checking if port {port} is available for {service}...")
|
|
||||||
running_service = host.get_fact(Port, port=port)
|
|
||||||
services = [service] if isinstance(service, str) else service
|
|
||||||
if running_service:
|
|
||||||
if running_service not in services:
|
|
||||||
Out().red(
|
|
||||||
f"Deploy failed: port {port} is occupied by: {running_service}"
|
|
||||||
)
|
|
||||||
exit(1)
|
|
||||||
|
|
||||||
tls_deployer = get_tls_deployer(config, mail_domain)
|
|
||||||
|
|
||||||
all_deployers = [
|
all_deployers = [
|
||||||
ChatmailDeployer(config),
|
ChatmailDeployer(mail_domain),
|
||||||
LegacyRemoveDeployer(),
|
LegacyRemoveDeployer(),
|
||||||
FiltermailDeployer(),
|
FiltermailDeployer(),
|
||||||
JournaldDeployer(),
|
JournaldDeployer(),
|
||||||
UnboundDeployer(config),
|
UnboundDeployer(config),
|
||||||
TurnDeployer(mail_domain),
|
TurnDeployer(mail_domain),
|
||||||
IrohDeployer(config.enable_iroh_relay),
|
IrohDeployer(config.enable_iroh_relay),
|
||||||
tls_deployer,
|
AcmetoolDeployer(config.acme_email, tls_domains),
|
||||||
WebsiteDeployer(config),
|
WebsiteDeployer(config),
|
||||||
ChatmailVenvDeployer(config),
|
ChatmailVenvDeployer(config),
|
||||||
MtastsDeployer(),
|
MtastsDeployer(),
|
||||||
|
|||||||
@@ -1,40 +1,25 @@
|
|||||||
import datetime
|
import datetime
|
||||||
|
import importlib
|
||||||
|
|
||||||
|
from jinja2 import Template
|
||||||
|
|
||||||
from . import remote
|
from . import remote
|
||||||
|
|
||||||
|
|
||||||
def parse_zone_records(text):
|
|
||||||
"""Yield ``(name, ttl, rtype, rdata)`` from standard BIND-format text.
|
|
||||||
|
|
||||||
Skips comment lines (starting with ``;``) and blank lines.
|
|
||||||
Each record line must have the format ``name TTL IN type rdata``.
|
|
||||||
"""
|
|
||||||
for raw_line in text.splitlines():
|
|
||||||
line = raw_line.strip()
|
|
||||||
if not line or line.startswith(";"):
|
|
||||||
continue
|
|
||||||
try:
|
|
||||||
name, ttl, _in, rtype, rdata = line.split(None, 4)
|
|
||||||
except ValueError:
|
|
||||||
raise ValueError(f"Bad zone record line: {line!r}") from None
|
|
||||||
name = name.rstrip(".")
|
|
||||||
yield name, ttl, rtype.upper(), rdata
|
|
||||||
|
|
||||||
|
|
||||||
def get_initial_remote_data(sshexec, mail_domain):
|
def get_initial_remote_data(sshexec, mail_domain):
|
||||||
return sshexec.logged(
|
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)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def check_initial_remote_data(remote_data, *, strict_tls=True, print=print):
|
def check_initial_remote_data(remote_data, *, print=print):
|
||||||
mail_domain = remote_data["mail_domain"]
|
mail_domain = remote_data["mail_domain"]
|
||||||
if not remote_data["A"] and not remote_data["AAAA"]:
|
if not remote_data["A"] and not remote_data["AAAA"]:
|
||||||
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
||||||
elif strict_tls and remote_data["MTA_STS"] != f"{mail_domain}.":
|
elif remote_data["MTA_STS"] != f"{mail_domain}.":
|
||||||
print("Missing MTA-STS CNAME record:")
|
print("Missing MTA-STS CNAME record:")
|
||||||
print(f"mta-sts.{mail_domain}. CNAME {mail_domain}.")
|
print(f"mta-sts.{mail_domain}. CNAME {mail_domain}.")
|
||||||
elif strict_tls and remote_data["WWW"] != f"{mail_domain}.":
|
elif remote_data["WWW"] != f"{mail_domain}.":
|
||||||
print("Missing www CNAME record:")
|
print("Missing www CNAME record:")
|
||||||
print(f"www.{mail_domain}. CNAME {mail_domain}.")
|
print(f"www.{mail_domain}. CNAME {mail_domain}.")
|
||||||
else:
|
else:
|
||||||
@@ -46,36 +31,13 @@ def get_filled_zone_file(remote_data):
|
|||||||
if not sts_id:
|
if not sts_id:
|
||||||
remote_data["sts_id"] = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
remote_data["sts_id"] = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
||||||
|
|
||||||
d = remote_data["mail_domain"]
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.j2")
|
||||||
lines = ["; Required DNS entries"]
|
content = template.read_text()
|
||||||
if remote_data.get("A"):
|
zonefile = Template(content).render(**remote_data)
|
||||||
lines.append(f"{d}. 3600 IN A {remote_data['A']}")
|
lines = [x.strip() for x in zonefile.split("\n") if x.strip()]
|
||||||
if remote_data.get("AAAA"):
|
|
||||||
lines.append(f"{d}. 3600 IN AAAA {remote_data['AAAA']}")
|
|
||||||
lines.append(f"{d}. 3600 IN MX 10 {d}.")
|
|
||||||
if remote_data.get("strict_tls"):
|
|
||||||
lines.append(
|
|
||||||
f'_mta-sts.{d}. 3600 IN TXT "v=STSv1; id={remote_data["sts_id"]}"'
|
|
||||||
)
|
|
||||||
lines.append(f"mta-sts.{d}. 3600 IN CNAME {d}.")
|
|
||||||
lines.append(f"www.{d}. 3600 IN CNAME {d}.")
|
|
||||||
lines.append(remote_data["dkim_entry"])
|
|
||||||
lines.append("")
|
lines.append("")
|
||||||
lines.append("; Recommended DNS entries")
|
zonefile = "\n".join(lines)
|
||||||
lines.append(f'{d}. 3600 IN TXT "v=spf1 a ~all"')
|
return zonefile
|
||||||
lines.append(f'_dmarc.{d}. 3600 IN TXT "v=DMARC1;p=reject;adkim=s;aspf=s"')
|
|
||||||
if remote_data.get("acme_account_url"):
|
|
||||||
lines.append(
|
|
||||||
f"{d}. 3600 IN CAA 0 issue"
|
|
||||||
f' "letsencrypt.org;accounturi={remote_data["acme_account_url"]}"'
|
|
||||||
)
|
|
||||||
lines.append(f'_adsp._domainkey.{d}. 3600 IN TXT "dkim=discardable"')
|
|
||||||
lines.append(f"_submission._tcp.{d}. 3600 IN SRV 0 1 587 {d}.")
|
|
||||||
lines.append(f"_submissions._tcp.{d}. 3600 IN SRV 0 1 465 {d}.")
|
|
||||||
lines.append(f"_imap._tcp.{d}. 3600 IN SRV 0 1 143 {d}.")
|
|
||||||
lines.append(f"_imaps._tcp.{d}. 3600 IN SRV 0 1 993 {d}.")
|
|
||||||
lines.append("")
|
|
||||||
return "\n".join(lines)
|
|
||||||
|
|
||||||
|
|
||||||
def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
||||||
@@ -91,19 +53,18 @@ def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
|||||||
if required_diff:
|
if required_diff:
|
||||||
out.red("Please set required DNS entries at your DNS provider:\n")
|
out.red("Please set required DNS entries at your DNS provider:\n")
|
||||||
for line in required_diff:
|
for line in required_diff:
|
||||||
out.print(line)
|
out(line)
|
||||||
out.print()
|
out("")
|
||||||
returncode = 1
|
returncode = 1
|
||||||
if remote_data.get("dkim_entry") in required_diff:
|
if remote_data.get("dkim_entry") in required_diff:
|
||||||
out.print(
|
out(
|
||||||
"If the DKIM entry above does not work with your DNS provider,"
|
"If the DKIM entry above does not work with your DNS provider, you can try this one:\n"
|
||||||
" you can try this one:\n"
|
|
||||||
)
|
)
|
||||||
out.print(remote_data.get("web_dkim_entry") + "\n")
|
out(remote_data.get("web_dkim_entry") + "\n")
|
||||||
if recommended_diff:
|
if recommended_diff:
|
||||||
out.print("WARNING: these recommended DNS entries are not set:\n")
|
out("WARNING: these recommended DNS entries are not set:\n")
|
||||||
for line in recommended_diff:
|
for line in recommended_diff:
|
||||||
out.print(line)
|
out(line)
|
||||||
|
|
||||||
if not (recommended_diff or required_diff):
|
if not (recommended_diff or required_diff):
|
||||||
out.green("Great! All your DNS entries are verified and correct.")
|
out.green("Great! All your DNS entries are verified and correct.")
|
||||||
|
|||||||
@@ -1,18 +1,14 @@
|
|||||||
import urllib.request
|
|
||||||
|
|
||||||
from chatmaild.config import Config
|
from chatmaild.config import Config
|
||||||
from pyinfra import host
|
from pyinfra import host
|
||||||
from pyinfra.facts.server import Arch, Command, Sysctl
|
from pyinfra.facts.server import Arch, Sysctl
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
from pyinfra.operations import apt, files, server, systemd
|
||||||
|
|
||||||
from cmdeploy.basedeploy import (
|
from cmdeploy.basedeploy import (
|
||||||
Deployer,
|
Deployer,
|
||||||
activate_remote_units,
|
activate_remote_units,
|
||||||
blocked_service_startup,
|
|
||||||
configure_remote_units,
|
configure_remote_units,
|
||||||
get_resource,
|
get_resource,
|
||||||
has_systemd,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -26,10 +22,7 @@ class DovecotDeployer(Deployer):
|
|||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
arch = host.get_fact(Arch)
|
arch = host.get_fact(Arch)
|
||||||
if has_systemd() and "dovecot.service" in host.get_fact(SystemdEnabled):
|
if not "dovecot.service" in host.get_fact(SystemdEnabled):
|
||||||
return # already installed and running
|
|
||||||
|
|
||||||
with blocked_service_startup():
|
|
||||||
_install_dovecot_package("core", arch)
|
_install_dovecot_package("core", arch)
|
||||||
_install_dovecot_package("imapd", arch)
|
_install_dovecot_package("imapd", arch)
|
||||||
_install_dovecot_package("lmtpd", arch)
|
_install_dovecot_package("lmtpd", arch)
|
||||||
@@ -56,21 +49,10 @@ class DovecotDeployer(Deployer):
|
|||||||
self.need_restart = False
|
self.need_restart = False
|
||||||
|
|
||||||
|
|
||||||
def _pick_url(primary, fallback):
|
|
||||||
try:
|
|
||||||
req = urllib.request.Request(primary, method="HEAD")
|
|
||||||
urllib.request.urlopen(req, timeout=10)
|
|
||||||
return primary
|
|
||||||
except Exception:
|
|
||||||
return fallback
|
|
||||||
|
|
||||||
|
|
||||||
def _install_dovecot_package(package: str, arch: str):
|
def _install_dovecot_package(package: str, arch: str):
|
||||||
arch = "amd64" if arch == "x86_64" else arch
|
arch = "amd64" if arch == "x86_64" else arch
|
||||||
arch = "arm64" if arch == "aarch64" else arch
|
arch = "arm64" if arch == "aarch64" else arch
|
||||||
primary_url = f"https://download.delta.chat/dovecot/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
url = f"https://download.delta.chat/dovecot/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
||||||
fallback_url = f"https://github.com/chatmail/dovecot/releases/download/upstream%2F2.3.21%2Bdfsg1/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
|
||||||
url = _pick_url(primary_url, fallback_url)
|
|
||||||
deb_filename = "/root/" + url.split("/")[-1]
|
deb_filename = "/root/" + url.split("/")[-1]
|
||||||
|
|
||||||
match (package, arch):
|
match (package, arch):
|
||||||
@@ -136,18 +118,11 @@ def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
|
|||||||
|
|
||||||
# as per https://doc.dovecot.org/2.3/configuration_manual/os/
|
# as per https://doc.dovecot.org/2.3/configuration_manual/os/
|
||||||
# it is recommended to set the following inotify limits
|
# it is recommended to set the following inotify limits
|
||||||
can_modify = host.get_fact(Command, "systemd-detect-virt -c || true") == "none"
|
|
||||||
for name in ("max_user_instances", "max_user_watches"):
|
for name in ("max_user_instances", "max_user_watches"):
|
||||||
key = f"fs.inotify.{name}"
|
key = f"fs.inotify.{name}"
|
||||||
value = host.get_fact(Sysctl)[key]
|
if host.get_fact(Sysctl)[key] > 65535:
|
||||||
if value > 65534:
|
# Skip updating limits if already sufficient
|
||||||
continue
|
# (enables running in incus containers where sysctl readonly)
|
||||||
if not can_modify:
|
|
||||||
print(
|
|
||||||
"\n!!!! refusing to attempt sysctl setting in shared-kernel containers\n"
|
|
||||||
f"!!!! dovecot: sysctl {key!r}={value}, should be >65534 for production setups\n"
|
|
||||||
"!!!!"
|
|
||||||
)
|
|
||||||
continue
|
continue
|
||||||
server.sysctl(
|
server.sysctl(
|
||||||
name=f"Change {key}",
|
name=f"Change {key}",
|
||||||
|
|||||||
@@ -228,8 +228,8 @@ service anvil {
|
|||||||
}
|
}
|
||||||
|
|
||||||
ssl = required
|
ssl = required
|
||||||
ssl_cert = <{{ config.tls_cert_path }}
|
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
ssl_key = <{{ config.tls_key_path }}
|
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
ssl_min_protocol = TLSv1.3
|
ssl_min_protocol = TLSv1.3
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
|
|||||||
67
cmdeploy/src/cmdeploy/external/deployer.py
vendored
67
cmdeploy/src/cmdeploy/external/deployer.py
vendored
@@ -1,67 +0,0 @@
|
|||||||
import io
|
|
||||||
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.files import File
|
|
||||||
from pyinfra.operations import files, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import Deployer, get_resource
|
|
||||||
|
|
||||||
|
|
||||||
class ExternalTlsDeployer(Deployer):
|
|
||||||
"""Expects TLS certificates to be managed on the server.
|
|
||||||
|
|
||||||
Validates that the configured certificate and key files
|
|
||||||
exist on the remote host. Installs a systemd path unit
|
|
||||||
that watches the certificate file and automatically
|
|
||||||
restarts/reloads affected services when it changes.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, cert_path, key_path):
|
|
||||||
self.cert_path = cert_path
|
|
||||||
self.key_path = key_path
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
# Verify cert and key exist on the remote host using pyinfra facts.
|
|
||||||
for path in (self.cert_path, self.key_path):
|
|
||||||
info = host.get_fact(File, path=path)
|
|
||||||
if info is None:
|
|
||||||
raise Exception(f"External TLS file not found on server: {path}")
|
|
||||||
|
|
||||||
# Deploy the .path unit (templated with the cert path).
|
|
||||||
# pkg=__package__ is required here because the resource files
|
|
||||||
# live in cmdeploy.external, not the default cmdeploy package.
|
|
||||||
source = get_resource("tls-cert-reload.path.f", pkg=__package__)
|
|
||||||
content = source.read_text().format(cert_path=self.cert_path).encode()
|
|
||||||
|
|
||||||
path_unit = files.put(
|
|
||||||
name="Upload tls-cert-reload.path",
|
|
||||||
src=io.BytesIO(content),
|
|
||||||
dest="/etc/systemd/system/tls-cert-reload.path",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
service_unit = files.put(
|
|
||||||
name="Upload tls-cert-reload.service",
|
|
||||||
src=get_resource("tls-cert-reload.service", pkg=__package__),
|
|
||||||
dest="/etc/systemd/system/tls-cert-reload.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
if path_unit.changed or service_unit.changed:
|
|
||||||
self.need_restart = True
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Enable tls-cert-reload path watcher",
|
|
||||||
service="tls-cert-reload.path",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
daemon_reload=self.need_restart,
|
|
||||||
)
|
|
||||||
# No explicit reload needed here: dovecot/nginx read the cert
|
|
||||||
# on startup, and the .path watcher handles live changes.
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Watch the TLS certificate file for changes.
|
|
||||||
# When the cert is updated (e.g. renewed by an external process),
|
|
||||||
# this triggers tls-cert-reload.service to reload the affected services.
|
|
||||||
#
|
|
||||||
# NOTE: changes to the certificates are not detected if they cross bind-mount boundaries.
|
|
||||||
# After cert renewal, you must then trigger the reload explicitly:
|
|
||||||
# systemctl start tls-cert-reload.service
|
|
||||||
[Unit]
|
|
||||||
Description=Watch TLS certificate for changes
|
|
||||||
|
|
||||||
[Path]
|
|
||||||
PathChanged={cert_path}
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Reload services that cache the TLS certificate.
|
|
||||||
#
|
|
||||||
# dovecot: caches the cert at startup; reload re-reads SSL certs
|
|
||||||
# without dropping existing connections.
|
|
||||||
# nginx: caches the cert at startup; reload gracefully picks up
|
|
||||||
# the new cert for new connections.
|
|
||||||
# postfix: reads the cert fresh on each TLS handshake,
|
|
||||||
# does NOT need a reload/restart.
|
|
||||||
[Unit]
|
|
||||||
Description=Reload TLS services after certificate change
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=oneshot
|
|
||||||
ExecStart=/bin/systemctl try-reload-or-restart dovecot
|
|
||||||
ExecStart=/bin/systemctl try-reload-or-restart nginx
|
|
||||||
@@ -14,10 +14,10 @@ class FiltermailDeployer(Deployer):
|
|||||||
|
|
||||||
def install(self):
|
def install(self):
|
||||||
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.0/filtermail-{arch}"
|
url = f"https://github.com/chatmail/filtermail/releases/download/v0.2.0/filtermail-{arch}-musl"
|
||||||
sha256sum = {
|
sha256sum = {
|
||||||
"x86_64": "3fd8b18282252c75a5bbfa603d8c1b65f6563e5e920bddf3e64e451b7cdb43ce",
|
"x86_64": "1e5bbb646582cb16740c6dfbbca39edba492b78cc96ec9fa2528c612bb504edd",
|
||||||
"aarch64": "2bd191de205f7fd60158dd8e3516ab7e3efb14627696f3d7dc186bdcd9e10a43",
|
"aarch64": "3564fba8605f8f9adfeefff3f4580533205da043f47c5968d0d10db17e50f44e",
|
||||||
}[arch]
|
}[arch]
|
||||||
self.need_restart |= files.download(
|
self.need_restart |= files.download(
|
||||||
name="Download filtermail",
|
name="Download filtermail",
|
||||||
|
|||||||
@@ -1,475 +0,0 @@
|
|||||||
"""lxc-start/stop/status/test subcommands for testing with local containers."""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import time
|
|
||||||
|
|
||||||
from ..util import get_git_hash, get_version_string, shell
|
|
||||||
from .incus import RELAY_IMAGE_ALIAS, Incus, RelayContainer
|
|
||||||
|
|
||||||
RELAY_NAMES = ("test0", "test1")
|
|
||||||
|
|
||||||
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
# lxc-start
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_start_cmd_options(parser):
|
|
||||||
_add_name_args(
|
|
||||||
parser,
|
|
||||||
help_text="User relay name(s) to create (default: test0).",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--ipv4-only",
|
|
||||||
dest="ipv4_only",
|
|
||||||
action="store_true",
|
|
||||||
help="Create an IPv4-only container.",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--run",
|
|
||||||
action="store_true",
|
|
||||||
help="Run 'cmdeploy run' on each container after starting it.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_start_cmd(args, out):
|
|
||||||
"""Create/Ensure and start LXC relay and DNS containers."""
|
|
||||||
|
|
||||||
with out.section("Preparing container setup"):
|
|
||||||
_lxc_start_cmd(args, out)
|
|
||||||
|
|
||||||
|
|
||||||
def _lxc_start_cmd(args, out):
|
|
||||||
ix = Incus(out)
|
|
||||||
sub = out.new_prefixed_out()
|
|
||||||
out.green("Ensuring base image ...")
|
|
||||||
ix.ensure_base_image()
|
|
||||||
out.green("Ensuring DNS container (ns-localchat) ...")
|
|
||||||
dns_ct = ix.get_dns_container()
|
|
||||||
dns_ct.ensure()
|
|
||||||
sub.print(f"DNS container IP: {dns_ct.ipv4}")
|
|
||||||
|
|
||||||
names = args.names if args.names else RELAY_NAMES
|
|
||||||
relays = list(ix.get_container(n) for n in names)
|
|
||||||
for ct in relays:
|
|
||||||
out.green(f"Ensuring container {ct.name!r} ({ct.domain}) ...")
|
|
||||||
ct.ensure()
|
|
||||||
ip = ct.ipv4
|
|
||||||
|
|
||||||
sub.print("Configuring container hostname ...")
|
|
||||||
ct.configure_hosts(ip)
|
|
||||||
|
|
||||||
sub.print(f"Writing {ct.ini.name} ...")
|
|
||||||
ct.write_ini(disable_ipv6=args.ipv4_only)
|
|
||||||
sub.print(f"Config: {ct.ini}")
|
|
||||||
if args.ipv4_only:
|
|
||||||
ct.disable_ipv6()
|
|
||||||
ipv6 = None
|
|
||||||
else:
|
|
||||||
output = ct.bash(
|
|
||||||
"ip -6 addr show scope global -deprecated"
|
|
||||||
" | grep -oP '(?<=inet6 )[^/]+'",
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
ipv6 = output.strip() if output else None
|
|
||||||
sub.print(f"{_format_addrs(ip, ipv6)}")
|
|
||||||
|
|
||||||
sub.green(f"Container {ct.name!r} ready: {ct.domain} -> {ip}")
|
|
||||||
out.print()
|
|
||||||
|
|
||||||
# Reset DNS zones only for the containers we just started
|
|
||||||
started_cnames = {ct.name for ct in relays}
|
|
||||||
managed = ix.list_managed()
|
|
||||||
started = [c for c in managed if c["name"] in started_cnames]
|
|
||||||
|
|
||||||
if started:
|
|
||||||
out.print(
|
|
||||||
f"Resetting DNS zones for {len(started)} domain(s) (A + AAAA records) ..."
|
|
||||||
)
|
|
||||||
dns_ct.reset_dns_records(dns_ct.ipv4, started)
|
|
||||||
|
|
||||||
for ct in relays:
|
|
||||||
if ct.name in started_cnames:
|
|
||||||
sub.print(f"Configuring DNS in {ct.name} ...")
|
|
||||||
ct.configure_dns(dns_ct.ipv4)
|
|
||||||
|
|
||||||
# Generate the unified SSH config
|
|
||||||
out.green("Writing ssh-config ...")
|
|
||||||
ssh_cfg = ix.write_ssh_config()
|
|
||||||
sub.print(f"{ssh_cfg}")
|
|
||||||
|
|
||||||
# Verify SSH via the generated config
|
|
||||||
for ct in relays:
|
|
||||||
sub.print(f"Verifying SSH to {ct.name} via ssh-config ...")
|
|
||||||
if ct.verify_ssh(ssh_cfg):
|
|
||||||
sub.print(f"SSH OK: ssh -F lxconfigs/ssh-config {ct.domain}")
|
|
||||||
else:
|
|
||||||
sub.red(f"WARNING: SSH verification failed for {ct.name}")
|
|
||||||
|
|
||||||
# Print integration suggestions
|
|
||||||
ssh_cfg = ix.ssh_config_path
|
|
||||||
if not ix.check_ssh_include():
|
|
||||||
sub.green(
|
|
||||||
"\n(Optional) To use containers from any SSH client, add to ~/.ssh/config:"
|
|
||||||
)
|
|
||||||
sub.green(f" Include {ssh_cfg}")
|
|
||||||
|
|
||||||
# Optionally run cmdeploy run + dns on each relay
|
|
||||||
if args.run:
|
|
||||||
for ct in relays:
|
|
||||||
with out.section(f"cmdeploy run: {ct.sname} ({ct.domain})"):
|
|
||||||
ret = _run_cmdeploy("run", ct, ix, out, extra=["--skip-dns-check"])
|
|
||||||
if ret:
|
|
||||||
out.red(f"Deploy to {ct.sname} failed (exit {ret})")
|
|
||||||
return ret
|
|
||||||
|
|
||||||
with out.section("loading DNS zones"):
|
|
||||||
for ct in relays:
|
|
||||||
ret = _run_cmdeploy(
|
|
||||||
"dns", ct, ix, out,
|
|
||||||
extra=["--zonefile", str(ct.zone)],
|
|
||||||
)
|
|
||||||
if ret:
|
|
||||||
out.red(f"DNS for {ct.sname} failed (exit {ret})")
|
|
||||||
return ret
|
|
||||||
if ct.zone.exists():
|
|
||||||
dns_ct.set_dns_records(ct.zone.read_text())
|
|
||||||
out.print(f"Restarting filtermail-incoming on {ct.name}")
|
|
||||||
ct.bash("systemctl restart filtermail-incoming")
|
|
||||||
|
|
||||||
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
# lxc-stop
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_stop_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--destroy",
|
|
||||||
action="store_true",
|
|
||||||
help="Delete containers and their config files after stopping.",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--destroy-all",
|
|
||||||
dest="destroy_all",
|
|
||||||
action="store_true",
|
|
||||||
help="Like --destroy, but also remove the ns-localchat DNS container.",
|
|
||||||
)
|
|
||||||
_add_name_args(
|
|
||||||
parser,
|
|
||||||
help_text="Container name(s) to stop (default: test0 + test1).",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_stop_cmd(args, out):
|
|
||||||
"""Stop (and optionally destroy) local LXC relay containers."""
|
|
||||||
ix = Incus(out)
|
|
||||||
names = args.names or RELAY_NAMES
|
|
||||||
destroy = args.destroy or args.destroy_all
|
|
||||||
|
|
||||||
for ct in map(ix.get_container, names):
|
|
||||||
if destroy:
|
|
||||||
out.green(f"Destroying container {ct.name!r} ...")
|
|
||||||
ct.destroy()
|
|
||||||
else:
|
|
||||||
out.green(f"Stopping container {ct.name!r} ...")
|
|
||||||
ct.stop(force=True)
|
|
||||||
|
|
||||||
if args.destroy_all:
|
|
||||||
dns_ct = ix.get_dns_container()
|
|
||||||
out.green(f"Destroying DNS container {dns_ct.name!r} ...")
|
|
||||||
dns_ct.destroy()
|
|
||||||
ix.delete_images()
|
|
||||||
|
|
||||||
if destroy:
|
|
||||||
ix.write_ssh_config()
|
|
||||||
out.green("LXC containers destroyed.")
|
|
||||||
else:
|
|
||||||
out.green("LXC containers stopped.")
|
|
||||||
|
|
||||||
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
# lxc-test
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_test_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--one",
|
|
||||||
action="store_true",
|
|
||||||
help="Only deploy and test against test0 (skip test1).",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_test_cmd(args, out):
|
|
||||||
"""Run full LXC pipeline: start, deploy, DNS, zone files, and tests.
|
|
||||||
|
|
||||||
All commands run directly on the host using
|
|
||||||
``--ssh-config lxconfigs/ssh-config`` for SSH access.
|
|
||||||
"""
|
|
||||||
ix = Incus(out)
|
|
||||||
t_total = time.time()
|
|
||||||
relay_names = list(RELAY_NAMES)
|
|
||||||
if args.one:
|
|
||||||
relay_names = relay_names[:1]
|
|
||||||
|
|
||||||
local_hash = get_git_hash()
|
|
||||||
|
|
||||||
# Per-relay: start, deploy, then snapshot the first relay as a
|
|
||||||
# reusable image so the second relay launches pre-deployed.
|
|
||||||
ipv4_only_flags = {RELAY_NAMES[0]: False, RELAY_NAMES[1]: True}
|
|
||||||
|
|
||||||
for ct in map(ix.get_container, relay_names):
|
|
||||||
name = ct.sname
|
|
||||||
ipv4_only = ipv4_only_flags.get(name, False)
|
|
||||||
v_flag = " -" + "v" * out.verbosity if out.verbosity > 0 else ""
|
|
||||||
start_cmd = f"cmdeploy lxc-start{v_flag} {name}"
|
|
||||||
if ipv4_only:
|
|
||||||
start_cmd += " --ipv4-only"
|
|
||||||
with out.section(f"cmdeploy lxc-start: {name}"):
|
|
||||||
ret = out.shell(start_cmd, cwd=str(ix.project_root))
|
|
||||||
if ret:
|
|
||||||
return ret
|
|
||||||
|
|
||||||
status = _deploy_status(ct, local_hash, ix)
|
|
||||||
with out.section(f"cmdeploy run: {name}"):
|
|
||||||
if "IN-SYNC" in status:
|
|
||||||
out.print(f"{name} is {status}, skipping")
|
|
||||||
else:
|
|
||||||
ret = _run_cmdeploy("run", ct, ix, out, extra=["--skip-dns-check"])
|
|
||||||
if ret:
|
|
||||||
out.red(f"Deploy to {name} failed (exit {ret})")
|
|
||||||
return ret
|
|
||||||
|
|
||||||
# Snapshot the first relay so subsequent ones launch pre-deployed
|
|
||||||
if not ix.find_image([RELAY_IMAGE_ALIAS]):
|
|
||||||
with out.section("lxc-test: caching relay image"):
|
|
||||||
ct.publish_as_relay_image()
|
|
||||||
|
|
||||||
for ct in map(ix.get_container, relay_names):
|
|
||||||
with out.section(f"cmdeploy dns: {ct.sname} ({ct.domain})"):
|
|
||||||
ret = _run_cmdeploy("dns", ct, ix, out, extra=["--zonefile", str(ct.zone)])
|
|
||||||
if ret:
|
|
||||||
out.red(f"DNS for {ct.sname} failed (exit {ret})")
|
|
||||||
return ret
|
|
||||||
|
|
||||||
with out.section(f"lxc-test: loading DNS zones {' & '.join(relay_names)}"):
|
|
||||||
dns_ct = ix.get_dns_container()
|
|
||||||
for ct in map(ix.get_container, relay_names):
|
|
||||||
if ct.zone.exists():
|
|
||||||
zone_data = ct.zone.read_text()
|
|
||||||
out.print(f"Loading {ct.zone} into PowerDNS ...")
|
|
||||||
dns_ct.set_dns_records(zone_data)
|
|
||||||
|
|
||||||
# Restart filtermail so its in-process DNS cache
|
|
||||||
# does not hold stale negative DKIM responses
|
|
||||||
# from before the zones were loaded.
|
|
||||||
for ct in map(ix.get_container, relay_names):
|
|
||||||
out.print(f"Restarting filtermail-incoming on {ct.name} ...")
|
|
||||||
ct.bash("systemctl restart filtermail-incoming")
|
|
||||||
|
|
||||||
with out.section("cmdeploy test"):
|
|
||||||
first = ix.get_container(relay_names[0])
|
|
||||||
env = None
|
|
||||||
if len(relay_names) > 1:
|
|
||||||
env = os.environ.copy()
|
|
||||||
env["CHATMAIL_DOMAIN2"] = ix.get_container(relay_names[1]).domain
|
|
||||||
ret = _run_cmdeploy("test", first, ix, out, **({"env": env} if env else {}))
|
|
||||||
if ret:
|
|
||||||
out.red(f"Tests failed (exit {ret})")
|
|
||||||
return ret
|
|
||||||
|
|
||||||
elapsed = time.time() - t_total
|
|
||||||
out.section_line(f"lxc-test complete ({elapsed:.1f}s)")
|
|
||||||
if out.section_timings:
|
|
||||||
out.print("Section timings:")
|
|
||||||
for name, secs in out.section_timings:
|
|
||||||
out.print(f" {name:.<50s} {secs:5.1f}s")
|
|
||||||
out.print(f" {'total':.<50s} {elapsed:5.1f}s")
|
|
||||||
out.section_timings.clear()
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
# lxc-status
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_status_cmd_options(parser):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def lxc_status_cmd(args, out):
|
|
||||||
"""Show status of local LXC chatmail containers."""
|
|
||||||
ix = Incus(out)
|
|
||||||
containers = ix.list_managed()
|
|
||||||
if not containers:
|
|
||||||
out.red("No LXC containers found. Run 'cmdeploy lxc-start' first.")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
local_hash = get_git_hash()
|
|
||||||
|
|
||||||
# Get storage pool path for display
|
|
||||||
storage_path = None
|
|
||||||
data = ix.run_json(["storage", "show", "default"], check=False)
|
|
||||||
if data:
|
|
||||||
storage_path = data.get("config", {}).get("source")
|
|
||||||
msg = "Container status"
|
|
||||||
if storage_path:
|
|
||||||
msg += f": {storage_path}"
|
|
||||||
out.section_line(msg)
|
|
||||||
|
|
||||||
dns_ip = None
|
|
||||||
for c in containers:
|
|
||||||
_print_container_status(out, c, ix, local_hash)
|
|
||||||
if c["name"] == ix.get_dns_container().name:
|
|
||||||
dns_ip = c["ip"]
|
|
||||||
|
|
||||||
out.section_line("Host ssh and DNS configuration")
|
|
||||||
_print_ssh_status(out, ix)
|
|
||||||
_print_dns_forwarding_status(out, dns_ip)
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
def _print_container_status(out, c, ix, local_hash):
|
|
||||||
"""Print name/status, domain/IPs, and RAM for one container."""
|
|
||||||
cname = c["name"]
|
|
||||||
is_running = c.get("status") == "Running"
|
|
||||||
ct = ix.get_container(cname)
|
|
||||||
|
|
||||||
# First line: name + running/STOPPED + deploy status
|
|
||||||
if not is_running:
|
|
||||||
tag = "STOPPED"
|
|
||||||
elif not isinstance(ct, RelayContainer):
|
|
||||||
tag = "running"
|
|
||||||
else:
|
|
||||||
tag = f"running {_deploy_status(ct, local_hash, ix)}"
|
|
||||||
out.print(f"{cname:20s} {tag}")
|
|
||||||
|
|
||||||
# Second line: domain, IPv4, IPv6
|
|
||||||
domain = c.get("domain", "")
|
|
||||||
ip = c.get("ip") or "?"
|
|
||||||
ipv6 = c.get("ipv6")
|
|
||||||
out.print(f"{domain:20s} {_format_addrs(ip, ipv6)}")
|
|
||||||
|
|
||||||
# Third line: RAM (RSS), config
|
|
||||||
detail_out = out.new_prefixed_out(" " * 21)
|
|
||||||
try:
|
|
||||||
used, total = ct.rss_mib()
|
|
||||||
except Exception:
|
|
||||||
ram_str = "RSS ?"
|
|
||||||
else:
|
|
||||||
ram_str = f"RSS {used}/{total} MiB ({used * 100 // total}%)"
|
|
||||||
|
|
||||||
if isinstance(ct, RelayContainer):
|
|
||||||
detail = f"{ram_str}, config: {os.path.relpath(ct.ini)}"
|
|
||||||
else:
|
|
||||||
detail = ram_str
|
|
||||||
|
|
||||||
detail_out.print(detail)
|
|
||||||
out.print()
|
|
||||||
|
|
||||||
|
|
||||||
def _print_ssh_status(out, ix):
|
|
||||||
"""Print SSH integration status."""
|
|
||||||
ssh_cfg = ix.ssh_config_path
|
|
||||||
if ix.check_ssh_include():
|
|
||||||
out.green("SSH: ~/.ssh/config includes lxconfigs/ssh-config ✓")
|
|
||||||
else:
|
|
||||||
out.red("SSH: ~/.ssh/config does NOT include lxconfigs/ssh-config")
|
|
||||||
sub = out.new_prefixed_out()
|
|
||||||
sub.print("Add to ~/.ssh/config:")
|
|
||||||
sub.print(f" Include {ssh_cfg}")
|
|
||||||
|
|
||||||
|
|
||||||
def _print_dns_forwarding_status(out, dns_ip):
|
|
||||||
"""Print host DNS forwarding status for .localchat."""
|
|
||||||
sub = out.new_prefixed_out()
|
|
||||||
if not dns_ip:
|
|
||||||
out.red("DNS: ns-localchat container not found")
|
|
||||||
return
|
|
||||||
try:
|
|
||||||
rv = shell("resolvectl status incusbr0")
|
|
||||||
dns_ok = dns_ip in rv.stdout and "localchat" in rv.stdout
|
|
||||||
except Exception:
|
|
||||||
dns_ok = None
|
|
||||||
if dns_ok is True:
|
|
||||||
out.green(f"DNS: .localchat forwarding to {dns_ip} ✓")
|
|
||||||
elif dns_ok is False:
|
|
||||||
out.red("DNS: .localchat forwarding NOT configured")
|
|
||||||
sub.print("Run:")
|
|
||||||
sub.print(f" sudo resolvectl dns incusbr0 {dns_ip}")
|
|
||||||
sub.print(" sudo resolvectl domain incusbr0 ~localchat")
|
|
||||||
else:
|
|
||||||
sub.print("DNS: .localchat forwarding status UNKNOWN")
|
|
||||||
|
|
||||||
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
# Internal helpers
|
|
||||||
# -------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
def _format_addrs(ip, ipv6=None):
|
|
||||||
parts = [f"IPv4 {ip}"]
|
|
||||||
if ipv6:
|
|
||||||
parts.append(f"IPv6 {ipv6}")
|
|
||||||
return ", ".join(parts)
|
|
||||||
|
|
||||||
|
|
||||||
def _deploy_status(ct, local_hash, ix):
|
|
||||||
"""Return a human-readable deploy status string.
|
|
||||||
|
|
||||||
Compares the full deployed version (hash + diff) against
|
|
||||||
the local state built by :func:`~cmdeploy.util.get_version_string`.
|
|
||||||
"""
|
|
||||||
deployed = ct.deployed_version()
|
|
||||||
if deployed is None:
|
|
||||||
return "NOT DEPLOYED"
|
|
||||||
|
|
||||||
# A container launched from the relay image has the same
|
|
||||||
# git hash but a different domain — always redeploy.
|
|
||||||
deployed_domain = ct.deployed_domain()
|
|
||||||
if deployed_domain and deployed_domain != ct.domain:
|
|
||||||
return f"DOMAIN-MISMATCH (deployed: {deployed_domain})"
|
|
||||||
|
|
||||||
deployed_lines = deployed.splitlines()
|
|
||||||
deployed_hash = deployed_lines[0] if deployed_lines else ""
|
|
||||||
short = deployed_hash[:12]
|
|
||||||
|
|
||||||
if not local_hash:
|
|
||||||
return f"UNKNOWN (deployed: {short})"
|
|
||||||
|
|
||||||
local_short = local_hash[:12]
|
|
||||||
if deployed_hash != local_hash:
|
|
||||||
return f"STALE (deployed: {short}, local: {local_short})"
|
|
||||||
|
|
||||||
# Hash matches — check for uncommitted diffs
|
|
||||||
local_version = get_version_string()
|
|
||||||
if deployed != local_version:
|
|
||||||
return f"DIRTY ({local_short}, undeployed changes)"
|
|
||||||
|
|
||||||
return f"IN-SYNC ({short})"
|
|
||||||
|
|
||||||
|
|
||||||
def _add_name_args(parser, help_text):
|
|
||||||
parser.add_argument("names", nargs="*", metavar="NAME", help=help_text)
|
|
||||||
|
|
||||||
|
|
||||||
def _run_cmdeploy(subcmd, ct, ix, out, extra=None, **kwargs):
|
|
||||||
"""Run ``cmdeploy <subcmd>`` with standard --config/--ssh flags.
|
|
||||||
|
|
||||||
*ct* is a Container (uses ``ct.ini`` and ``ct.domain``).
|
|
||||||
Returns the subprocess exit code.
|
|
||||||
"""
|
|
||||||
extra_str = " ".join(extra) if extra else ""
|
|
||||||
v_flag = " -" + "v" * out.verbosity if out.verbosity > 0 else ""
|
|
||||||
cmd = f"""
|
|
||||||
cmdeploy {subcmd}{v_flag}
|
|
||||||
--config {ct.ini}
|
|
||||||
--ssh-config {ix.ssh_config_path}
|
|
||||||
--ssh-host {ct.domain}
|
|
||||||
{extra_str}
|
|
||||||
"""
|
|
||||||
if "cwd" not in kwargs:
|
|
||||||
kwargs["cwd"] = str(ix.project_root)
|
|
||||||
return out.shell(cmd, **kwargs)
|
|
||||||
@@ -1,768 +0,0 @@
|
|||||||
"""Core Incus operations for local chatmail LXC containers."""
|
|
||||||
|
|
||||||
import json
|
|
||||||
import subprocess
|
|
||||||
import textwrap
|
|
||||||
import time
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from ..util import shell
|
|
||||||
|
|
||||||
LABEL_KEY = "user.localchat-managed"
|
|
||||||
SSH_KEY_NAME = "id_localchat"
|
|
||||||
DOMAIN_SUFFIX = ".localchat"
|
|
||||||
UPSTREAM_IMAGE = "images:debian/12"
|
|
||||||
BASE_IMAGE_ALIAS = "localchat-base"
|
|
||||||
BASE_SETUP_NAME = "localchat-base-setup"
|
|
||||||
RELAY_IMAGE_ALIAS = "localchat-relay"
|
|
||||||
|
|
||||||
DNS_CONTAINER_NAME = "ns-localchat"
|
|
||||||
DNS_DOMAIN = "ns.localchat"
|
|
||||||
|
|
||||||
|
|
||||||
class DNSConfigurationError(Exception):
|
|
||||||
"""Raised when the DNS container is not reachable or not answering."""
|
|
||||||
|
|
||||||
|
|
||||||
def _extract_ip(net_data, family="inet"):
|
|
||||||
"""Extract the first global-scope IP of *family* from network state data.
|
|
||||||
|
|
||||||
*net_data* is the ``state.network`` dict from ``incus list --format=json``.
|
|
||||||
*family* is ``"inet"`` for IPv4 or ``"inet6"`` for IPv6.
|
|
||||||
Returns the address string, or None.
|
|
||||||
"""
|
|
||||||
for iface_name, iface in net_data.items():
|
|
||||||
if iface_name == "lo":
|
|
||||||
continue
|
|
||||||
for addr in iface.get("addresses", []):
|
|
||||||
if addr["family"] == family and addr["scope"] == "global":
|
|
||||||
return addr["address"]
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
class Incus:
|
|
||||||
"""Gateway for all Incus container operations.
|
|
||||||
|
|
||||||
Instantiated once per CLI command and passed around so that
|
|
||||||
all modules share a single entry point for Incus interactions.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, out):
|
|
||||||
self.out = out
|
|
||||||
self.project_root = Path(__file__).resolve().parent.parent.parent.parent.parent
|
|
||||||
self.lxconfigs_dir = self.project_root / "lxconfigs"
|
|
||||||
self.lxconfigs_dir.mkdir(exist_ok=True)
|
|
||||||
self.ssh_key_path = self.lxconfigs_dir / SSH_KEY_NAME
|
|
||||||
if not self.ssh_key_path.exists():
|
|
||||||
shell(
|
|
||||||
f"ssh-keygen -t ed25519 -f {self.ssh_key_path} -N '' -C localchat",
|
|
||||||
check=True,
|
|
||||||
)
|
|
||||||
self.ssh_config_path = self.lxconfigs_dir / "ssh-config"
|
|
||||||
|
|
||||||
def write_ssh_config(self):
|
|
||||||
"""Write ``lxconfigs/ssh-config`` mapping all containers to their IPs.
|
|
||||||
|
|
||||||
Each Host block maps the container name, the domain name, and the
|
|
||||||
short relay name (e.g. ``_test0``) to the container's IP, using the
|
|
||||||
shared localchat SSH key. Returns the path to the file.
|
|
||||||
"""
|
|
||||||
containers = self.list_managed()
|
|
||||||
key_path = self.ssh_key_path
|
|
||||||
lines = ["# Auto-generated by cmdeploy lxc-start — do not edit\n"]
|
|
||||||
for c in containers:
|
|
||||||
hosts = [c["name"]]
|
|
||||||
domain = c.get("domain", "")
|
|
||||||
if domain and domain != c["name"]:
|
|
||||||
hosts.append(domain)
|
|
||||||
short = domain.split(".")[0]
|
|
||||||
if short and short not in hosts:
|
|
||||||
hosts.append(short)
|
|
||||||
lines.append(f"\nHost {' '.join(hosts)}\n")
|
|
||||||
lines.append(f" Hostname {c['ip']}\n")
|
|
||||||
lines.append(" User root\n")
|
|
||||||
lines.append(f" IdentityFile {key_path}\n")
|
|
||||||
lines.append(" IdentitiesOnly yes\n")
|
|
||||||
lines.append(" StrictHostKeyChecking accept-new\n")
|
|
||||||
lines.append(" UserKnownHostsFile /dev/null\n")
|
|
||||||
lines.append(" LogLevel ERROR\n")
|
|
||||||
path = self.ssh_config_path
|
|
||||||
path.write_text("".join(lines))
|
|
||||||
return path
|
|
||||||
|
|
||||||
def check_ssh_include(self):
|
|
||||||
"""Check if the user's ~/.ssh/config already includes our ssh-config."""
|
|
||||||
user_ssh_config = Path.home() / ".ssh" / "config"
|
|
||||||
if not user_ssh_config.exists():
|
|
||||||
return False
|
|
||||||
lines = user_ssh_config.read_text().splitlines()
|
|
||||||
target = f"include {self.ssh_config_path}".lower()
|
|
||||||
return any(line.strip().lower() == target for line in lines)
|
|
||||||
|
|
||||||
def get_host_nameservers(self):
|
|
||||||
"""Return upstream nameservers found on the host."""
|
|
||||||
ns = []
|
|
||||||
for path in ["/run/systemd/resolve/resolv.conf", "/etc/resolv.conf"]:
|
|
||||||
p = Path(path)
|
|
||||||
if p.exists():
|
|
||||||
for line in p.read_text().splitlines():
|
|
||||||
if line.strip().startswith("nameserver "):
|
|
||||||
addr = line.split()[1]
|
|
||||||
if addr not in ("127.0.0.1", "127.0.0.53", "::1"):
|
|
||||||
if addr not in ns:
|
|
||||||
ns.append(addr)
|
|
||||||
if ns:
|
|
||||||
break
|
|
||||||
return ns
|
|
||||||
|
|
||||||
def run(self, args, check=True, capture=True, input=None):
|
|
||||||
"""Run an incus command.
|
|
||||||
|
|
||||||
When *capture* is True and *verbosity* >= 1, output is streamed
|
|
||||||
to the terminal line-by-line while also being captured for
|
|
||||||
later return via result.stdout.
|
|
||||||
"""
|
|
||||||
cmd = ["incus", "--quiet"] + list(args)
|
|
||||||
sub = self.out.new_prefixed_out(" ")
|
|
||||||
|
|
||||||
if not capture:
|
|
||||||
# Simple case: let subprocess handle streams (no capture)
|
|
||||||
if self.out.verbosity >= 1:
|
|
||||||
sub.print(f"$ {' '.join(cmd)}")
|
|
||||||
return subprocess.run(
|
|
||||||
cmd, text=True, input=input, check=check, stdout=None, stderr=None
|
|
||||||
)
|
|
||||||
|
|
||||||
# Capture case: we may need to stream while capturing
|
|
||||||
if sub.verbosity >= 1:
|
|
||||||
cmd_lines = " ".join(cmd).splitlines()
|
|
||||||
sub.print(f"$ {cmd_lines.pop(0)}")
|
|
||||||
if sub.verbosity >= 2:
|
|
||||||
for line in cmd_lines:
|
|
||||||
sub.print(f" {line}")
|
|
||||||
|
|
||||||
proc = subprocess.Popen(
|
|
||||||
cmd,
|
|
||||||
text=True,
|
|
||||||
stdin=subprocess.PIPE if input else subprocess.DEVNULL,
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
stderr=subprocess.PIPE,
|
|
||||||
)
|
|
||||||
|
|
||||||
stdout_lines = []
|
|
||||||
if input:
|
|
||||||
proc.stdin.write(input)
|
|
||||||
proc.stdin.close()
|
|
||||||
|
|
||||||
for line in proc.stdout:
|
|
||||||
stdout_lines.append(line)
|
|
||||||
if sub.verbosity >= 2:
|
|
||||||
sub.print(f" > {line.rstrip()}")
|
|
||||||
|
|
||||||
stderr = proc.stderr.read()
|
|
||||||
ret = proc.wait()
|
|
||||||
stdout = "".join(stdout_lines)
|
|
||||||
if check and ret != 0:
|
|
||||||
full_output = stdout + stderr
|
|
||||||
for line in full_output.splitlines():
|
|
||||||
if sub.verbosity < 1: # and we haven't printed it yet
|
|
||||||
sub.red(line)
|
|
||||||
raise subprocess.CalledProcessError(ret, cmd, output=stdout, stderr=stderr)
|
|
||||||
|
|
||||||
return subprocess.CompletedProcess(cmd, ret, stdout=stdout, stderr=stderr)
|
|
||||||
|
|
||||||
def run_json(self, args, check=True):
|
|
||||||
"""Run an incus command with ``--format=json``.
|
|
||||||
|
|
||||||
Returns the parsed JSON on success.
|
|
||||||
When *check* is True raises ``subprocess.CalledProcessError``
|
|
||||||
on non-zero exit; when False returns *None* instead.
|
|
||||||
"""
|
|
||||||
result = self.run(
|
|
||||||
list(args) + ["--format=json"],
|
|
||||||
check=check,
|
|
||||||
)
|
|
||||||
if result.returncode != 0:
|
|
||||||
return None
|
|
||||||
return json.loads(result.stdout)
|
|
||||||
|
|
||||||
def run_output(self, args, check=True):
|
|
||||||
"""Run an incus command and return its stripped stdout.
|
|
||||||
|
|
||||||
When *check* is False, returns *None* on non-zero exit
|
|
||||||
instead of raising.
|
|
||||||
"""
|
|
||||||
result = self.run(args, check=check)
|
|
||||||
if result.returncode != 0:
|
|
||||||
return None
|
|
||||||
return result.stdout.strip()
|
|
||||||
|
|
||||||
def find_image(self, aliases):
|
|
||||||
"""Return the first alias from *aliases* that exists, else None."""
|
|
||||||
images = self.run_json(["image", "list"], check=False) or []
|
|
||||||
existing = {a.get("name") for img in images for a in img.get("aliases", [])}
|
|
||||||
for alias in aliases:
|
|
||||||
if alias in existing:
|
|
||||||
return alias
|
|
||||||
return None
|
|
||||||
|
|
||||||
def delete_images(self):
|
|
||||||
"""Delete the cached base and relay images."""
|
|
||||||
for alias in (RELAY_IMAGE_ALIAS, BASE_IMAGE_ALIAS):
|
|
||||||
self.run(["image", "delete", alias], check=False) # ok if absent
|
|
||||||
|
|
||||||
def list_managed(self):
|
|
||||||
"""Return list of dicts with name, ip, ipv6, domain, status, memory_usage."""
|
|
||||||
containers = []
|
|
||||||
for ct in self.run_json(["list"]):
|
|
||||||
config = ct.get("config", {})
|
|
||||||
if config.get(LABEL_KEY) != "true":
|
|
||||||
continue
|
|
||||||
name = ct["name"]
|
|
||||||
state = ct.get("state", {})
|
|
||||||
net = state.get("network") or {}
|
|
||||||
containers.append(
|
|
||||||
{
|
|
||||||
"name": name,
|
|
||||||
"ip": _extract_ip(net, "inet"),
|
|
||||||
"ipv6": _extract_ip(net, "inet6"),
|
|
||||||
"domain": config.get(
|
|
||||||
"user.localchat-domain", f"{name}{DOMAIN_SUFFIX}"
|
|
||||||
),
|
|
||||||
"status": ct.get("status", "Unknown"),
|
|
||||||
"memory_usage": state.get("memory", {}).get("usage", 0),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return containers
|
|
||||||
|
|
||||||
def ensure_base_image(self):
|
|
||||||
"""Build and cache a base image with openssh and the SSH key.
|
|
||||||
|
|
||||||
The image is published as a local incus image with alias
|
|
||||||
'localchat-base'. Subsequent container launches use this
|
|
||||||
image instead of the upstream Debian 12, skipping the
|
|
||||||
slow apt-get install step.
|
|
||||||
Returns the image alias.
|
|
||||||
"""
|
|
||||||
if self.find_image([BASE_IMAGE_ALIAS]):
|
|
||||||
self.out.print(f" Base image '{BASE_IMAGE_ALIAS}' already cached.")
|
|
||||||
return BASE_IMAGE_ALIAS
|
|
||||||
|
|
||||||
self.out.print(" Building base image (one-time setup) ...")
|
|
||||||
|
|
||||||
self.run(["delete", BASE_SETUP_NAME, "--force"], check=False)
|
|
||||||
self.run(["image", "delete", BASE_IMAGE_ALIAS], check=False)
|
|
||||||
self.run(["launch", UPSTREAM_IMAGE, BASE_SETUP_NAME])
|
|
||||||
|
|
||||||
ct = Container(self, BASE_SETUP_NAME)
|
|
||||||
ct.wait_ready()
|
|
||||||
|
|
||||||
key_path = self.ssh_key_path
|
|
||||||
pub_key = key_path.with_suffix(".pub").read_text().strip()
|
|
||||||
host_ns = self.get_host_nameservers()
|
|
||||||
ns_lines = "\n".join(f"nameserver {n}" for n in host_ns)
|
|
||||||
ct.bash(f"""
|
|
||||||
printf '{ns_lines}\n' > /etc/resolv.conf
|
|
||||||
apt-get -o DPkg::Lock::Timeout=60 update
|
|
||||||
DEBIAN_FRONTEND=noninteractive apt-get install -y openssh-server python3
|
|
||||||
systemctl enable ssh
|
|
||||||
apt-get clean
|
|
||||||
mkdir -p /root/.ssh
|
|
||||||
chmod 700 /root/.ssh
|
|
||||||
echo '{pub_key}' > /root/.ssh/authorized_keys
|
|
||||||
chmod 600 /root/.ssh/authorized_keys
|
|
||||||
""")
|
|
||||||
|
|
||||||
self.run(["stop", BASE_SETUP_NAME])
|
|
||||||
self.run(["publish", BASE_SETUP_NAME, f"--alias={BASE_IMAGE_ALIAS}"])
|
|
||||||
self.run(["delete", BASE_SETUP_NAME, "--force"])
|
|
||||||
self.out.print(f" Base image '{BASE_IMAGE_ALIAS}' ready.")
|
|
||||||
return BASE_IMAGE_ALIAS
|
|
||||||
|
|
||||||
def get_container(self, name):
|
|
||||||
"""Return a container handle for the given name.
|
|
||||||
|
|
||||||
Accepts both short relay names (``test0``) and full Incus
|
|
||||||
container names (``test0-localchat``). Returns
|
|
||||||
``DNSContainer`` for the DNS container and
|
|
||||||
``RelayContainer`` for everything else.
|
|
||||||
"""
|
|
||||||
if name == DNS_CONTAINER_NAME:
|
|
||||||
return DNSContainer(self)
|
|
||||||
return RelayContainer(self, name.removesuffix("-localchat"))
|
|
||||||
|
|
||||||
def get_dns_container(self):
|
|
||||||
"""Return a DNSContainer handle."""
|
|
||||||
return DNSContainer(self)
|
|
||||||
|
|
||||||
|
|
||||||
class Container:
|
|
||||||
"""The base container handle wraps all interactions with incus."""
|
|
||||||
|
|
||||||
def __init__(self, incus, name, domain=None):
|
|
||||||
self.incus = incus
|
|
||||||
self.out = incus.out
|
|
||||||
self.name = name
|
|
||||||
self.domain = domain or f"{name}{DOMAIN_SUFFIX}"
|
|
||||||
self.ipv4 = None
|
|
||||||
self.ipv6 = None
|
|
||||||
|
|
||||||
def bash(self, script, check=True):
|
|
||||||
"""Returns stdout from executing ``bash -ec <script>`` inside this container.
|
|
||||||
|
|
||||||
*script* is dedented and stripped so callers can use triple-quoted strings.
|
|
||||||
When *check* is False, returns *None* on non-zero exit instead of raising.
|
|
||||||
"""
|
|
||||||
script = textwrap.dedent(script).strip()
|
|
||||||
cmd = ["exec", self.name, "--", "bash", "-ec", script]
|
|
||||||
return self.incus.run_output(cmd, check=check)
|
|
||||||
|
|
||||||
def run_cmd(self, *args, check=True):
|
|
||||||
"""Return stdout from running a command directly in the container (no shell).
|
|
||||||
|
|
||||||
When *check* is False, returns *None* on non-zero exit instead of raising.
|
|
||||||
"""
|
|
||||||
return self.incus.run_output(
|
|
||||||
["exec", self.name, "--", *args],
|
|
||||||
check=check,
|
|
||||||
)
|
|
||||||
|
|
||||||
def start(self):
|
|
||||||
self.incus.run(["start", self.name])
|
|
||||||
|
|
||||||
def stop(self, force=False):
|
|
||||||
cmd = ["stop", self.name]
|
|
||||||
if force:
|
|
||||||
cmd.append("--force")
|
|
||||||
self.incus.run(cmd, check=False)
|
|
||||||
|
|
||||||
def launch(self):
|
|
||||||
"""Launch from the best available image, return the alias used."""
|
|
||||||
image = self.incus.find_image([RELAY_IMAGE_ALIAS, BASE_IMAGE_ALIAS])
|
|
||||||
if not image:
|
|
||||||
raise RuntimeError(
|
|
||||||
f"No base image '{BASE_IMAGE_ALIAS}' found. "
|
|
||||||
"Call ensure_base_image() before launching containers."
|
|
||||||
)
|
|
||||||
self.out.print(f" Launching from '{image}' image ...")
|
|
||||||
cfg = []
|
|
||||||
cfg += ("-c", f"{LABEL_KEY}=true")
|
|
||||||
cfg += ("-c", f"user.localchat-domain={self.domain}")
|
|
||||||
self.incus.run(["launch", image, self.name, *cfg])
|
|
||||||
return image
|
|
||||||
|
|
||||||
def ensure(self):
|
|
||||||
"""Create/start this container from the cached base image.
|
|
||||||
|
|
||||||
On first call, builds the base image (~30s).
|
|
||||||
Subsequent containers launch in ~2s from the cached image.
|
|
||||||
Returns ``self`` for chaining.
|
|
||||||
"""
|
|
||||||
data = self.incus.run_json(["list", self.name], check=False) or []
|
|
||||||
|
|
||||||
existing = [c for c in data if c["name"] == self.name]
|
|
||||||
if existing:
|
|
||||||
if existing[0]["status"] != "Running":
|
|
||||||
self.start()
|
|
||||||
else:
|
|
||||||
self.launch()
|
|
||||||
self.wait_ready()
|
|
||||||
return self
|
|
||||||
|
|
||||||
def destroy(self):
|
|
||||||
"""Stop, delete, and clean up config files."""
|
|
||||||
self.stop(force=True)
|
|
||||||
self.incus.run(["delete", self.name, "--force"], check=False)
|
|
||||||
|
|
||||||
def push_file_content(self, dest_path, content):
|
|
||||||
"""Write *content* to *dest_path* inside the container.
|
|
||||||
|
|
||||||
*content* is dedented and stripped so callers can use
|
|
||||||
indented triple-quoted strings.
|
|
||||||
"""
|
|
||||||
content = textwrap.dedent(content).strip() + "\n"
|
|
||||||
self.incus.run(
|
|
||||||
["file", "push", "-", f"{self.name}{dest_path}"],
|
|
||||||
input=content,
|
|
||||||
)
|
|
||||||
self.bash(f"chmod 644 {dest_path}")
|
|
||||||
|
|
||||||
def wait_ready(self, timeout=60):
|
|
||||||
"""Wait until the container is running with an IPv4 address.
|
|
||||||
|
|
||||||
Sets ``self.ipv4`` and ``self.ipv6`` (may be *None*),
|
|
||||||
or raises ``TimeoutError``.
|
|
||||||
"""
|
|
||||||
deadline = time.time() + timeout
|
|
||||||
while time.time() < deadline:
|
|
||||||
data = self.incus.run_json(
|
|
||||||
["list", self.name],
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
if data and data[0].get("status") == "Running":
|
|
||||||
net = data[0].get("state", {}).get("network", {})
|
|
||||||
self.ipv4 = _extract_ip(net, "inet")
|
|
||||||
self.ipv6 = _extract_ip(net, "inet6")
|
|
||||||
if self.ipv4:
|
|
||||||
return
|
|
||||||
time.sleep(1)
|
|
||||||
raise TimeoutError(
|
|
||||||
f"Container {self.name!r} did not become ready within {timeout}s"
|
|
||||||
)
|
|
||||||
|
|
||||||
def rss_mib(self):
|
|
||||||
"""Return ``(used, total)`` memory from container (or None if unobtainable)."""
|
|
||||||
output = self.bash("free -m", check=False)
|
|
||||||
if output:
|
|
||||||
for line in output.splitlines():
|
|
||||||
if line.startswith("Mem:"):
|
|
||||||
parts = line.split()
|
|
||||||
return int(parts[2]), int(parts[1])
|
|
||||||
|
|
||||||
|
|
||||||
class RelayContainer(Container):
|
|
||||||
"""Container handle for a chatmail relay.
|
|
||||||
|
|
||||||
Accepts the short relay name (e.g. ``test0``) and derives
|
|
||||||
the Incus container name and mail domain automatically.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, incus, name):
|
|
||||||
super().__init__(
|
|
||||||
incus,
|
|
||||||
f"{name}-localchat",
|
|
||||||
domain=f"_{name}{DOMAIN_SUFFIX}",
|
|
||||||
)
|
|
||||||
self.sname = name
|
|
||||||
self.ini = incus.lxconfigs_dir / f"chatmail-{name}.ini"
|
|
||||||
self.zone = incus.lxconfigs_dir / f"{name}.zone"
|
|
||||||
|
|
||||||
def launch(self):
|
|
||||||
"""Launch (from a potentially cached image) and clear inherited chatmail-version."""
|
|
||||||
image = super().launch()
|
|
||||||
self.bash("rm -f /etc/chatmail-version")
|
|
||||||
return image
|
|
||||||
|
|
||||||
def destroy(self):
|
|
||||||
"""Stop, delete, and clean up config files."""
|
|
||||||
super().destroy()
|
|
||||||
if self.ini.exists():
|
|
||||||
self.ini.unlink()
|
|
||||||
|
|
||||||
def disable_ipv6(self):
|
|
||||||
"""Disable IPv6 inside the container via sysctl."""
|
|
||||||
# incus provides net.* virtualization for LXC containers so that
|
|
||||||
# these sysctls only affect the container's network namespace.
|
|
||||||
self.bash("""
|
|
||||||
sysctl -w net.ipv6.conf.all.disable_ipv6=1
|
|
||||||
sysctl -w net.ipv6.conf.default.disable_ipv6=1
|
|
||||||
""")
|
|
||||||
self.push_file_content(
|
|
||||||
"/etc/sysctl.d/99-disable-ipv6.conf",
|
|
||||||
"""
|
|
||||||
net.ipv6.conf.all.disable_ipv6=1
|
|
||||||
net.ipv6.conf.default.disable_ipv6=1
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure_hosts(self, ip):
|
|
||||||
"""Set hostname and /etc/hosts inside the container."""
|
|
||||||
self.bash(f"""
|
|
||||||
echo '{self.name}' > /etc/hostname
|
|
||||||
hostname {self.name}
|
|
||||||
sed -i '/ {self.domain}$/d' /etc/hosts
|
|
||||||
echo '{ip} {self.name} {self.domain}' >> /etc/hosts
|
|
||||||
""")
|
|
||||||
|
|
||||||
def publish_as_relay_image(self):
|
|
||||||
"""Publish this container as a reusable relay image.
|
|
||||||
|
|
||||||
Stops the container, 'publishes' it as 'localchat-relay', then restarts it.
|
|
||||||
"""
|
|
||||||
if self.incus.find_image([RELAY_IMAGE_ALIAS]):
|
|
||||||
return
|
|
||||||
self.out.print(
|
|
||||||
f" Locally caching {self.name!r} as '{RELAY_IMAGE_ALIAS}' image ..."
|
|
||||||
)
|
|
||||||
self.incus.run(
|
|
||||||
["publish", self.name, f"--alias={RELAY_IMAGE_ALIAS}", "--force"]
|
|
||||||
)
|
|
||||||
self.wait_ready()
|
|
||||||
self.out.print(f" Relay image '{RELAY_IMAGE_ALIAS}' ready.")
|
|
||||||
|
|
||||||
def deployed_version(self):
|
|
||||||
"""Read /etc/chatmail-version, or None if absent."""
|
|
||||||
return self.bash("cat /etc/chatmail-version", check=False)
|
|
||||||
|
|
||||||
def deployed_domain(self):
|
|
||||||
"""Read the domain deployed on the container (postfix myhostname)."""
|
|
||||||
return self.bash(
|
|
||||||
"postconf -h myhostname 2>/dev/null",
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
def verify_ssh(self, ssh_config):
|
|
||||||
"""Verify SSH connectivity to this container."""
|
|
||||||
cmd = f"ssh -F {ssh_config} -o ConnectTimeout=60 root@{self.domain} hostname"
|
|
||||||
return shell(cmd, timeout=60).returncode == 0
|
|
||||||
|
|
||||||
def configure_dns(self, dns_ip):
|
|
||||||
"""Point this container's resolver at *dns_ip* and verify DNS is reachable."""
|
|
||||||
self.bash(f"""
|
|
||||||
systemctl disable --now systemd-resolved 2>/dev/null || true
|
|
||||||
rm -f /etc/resolv.conf
|
|
||||||
printf 'nameserver {dns_ip}\\n' >/etc/resolv.conf
|
|
||||||
mkdir -p /etc/unbound/unbound.conf.d
|
|
||||||
""")
|
|
||||||
self.push_file_content(
|
|
||||||
"/etc/unbound/unbound.conf.d/localchat-forward.conf",
|
|
||||||
f"""
|
|
||||||
server:
|
|
||||||
domain-insecure: "localchat"
|
|
||||||
|
|
||||||
forward-zone:
|
|
||||||
name: "localchat"
|
|
||||||
forward-addr: {dns_ip}
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
self.bash("systemctl restart unbound 2>/dev/null || true")
|
|
||||||
self._wait_dns_reachable(dns_ip)
|
|
||||||
|
|
||||||
def _wait_dns_reachable(self, dns_ip, timeout=10):
|
|
||||||
"""Poll until *dns_ip* answers a DNS query from this container."""
|
|
||||||
if self.bash("which dig", check=False) is None:
|
|
||||||
self.bash(
|
|
||||||
"DEBIAN_FRONTEND=noninteractive "
|
|
||||||
"apt-get install -y dnsutils 2>/dev/null || true"
|
|
||||||
)
|
|
||||||
deadline = time.time() + timeout
|
|
||||||
while time.time() < deadline:
|
|
||||||
result = self.bash(
|
|
||||||
f"dig @{dns_ip} . SOA +short +time=1 +tries=1",
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
if result and result.strip():
|
|
||||||
return
|
|
||||||
time.sleep(0.5)
|
|
||||||
raise DNSConfigurationError(
|
|
||||||
f"DNS at {dns_ip} not reachable from {self.name} after {timeout}s"
|
|
||||||
)
|
|
||||||
|
|
||||||
def write_ini(self, disable_ipv6=False):
|
|
||||||
"""Generate a chatmail.ini config file in lxconfigs/."""
|
|
||||||
from chatmaild.config import write_initial_config
|
|
||||||
|
|
||||||
overrides = {
|
|
||||||
"max_user_send_per_minute": 600,
|
|
||||||
"max_user_send_burst_size": 100,
|
|
||||||
"mtail_address": "127.0.0.1",
|
|
||||||
}
|
|
||||||
if disable_ipv6:
|
|
||||||
overrides["disable_ipv6"] = "True"
|
|
||||||
write_initial_config(self.ini, self.domain, overrides)
|
|
||||||
return self.ini
|
|
||||||
|
|
||||||
|
|
||||||
class DNSContainer(Container):
|
|
||||||
"""Container handle for the PowerDNS name server.
|
|
||||||
|
|
||||||
Manages the authoritative and recursive DNS services required for
|
|
||||||
name resolution in the local testing environment.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, incus):
|
|
||||||
super().__init__(incus, DNS_CONTAINER_NAME, domain=DNS_DOMAIN)
|
|
||||||
|
|
||||||
def pdnsutil(self, *args, check=True):
|
|
||||||
"""Run ``pdnsutil <args>`` inside the DNS container."""
|
|
||||||
return self.run_cmd("pdnsutil", *args, check=check)
|
|
||||||
|
|
||||||
def replace_rrset(self, zone, name, rtype, ttl, rdata):
|
|
||||||
"""Shortcut for ``pdnsutil replace-rrset``."""
|
|
||||||
self.pdnsutil("replace-rrset", zone, name, rtype, ttl, rdata)
|
|
||||||
|
|
||||||
def restart_services(self):
|
|
||||||
"""Restart pdns and pdns-recursor, then wait until DNS is answering."""
|
|
||||||
self.bash("""
|
|
||||||
systemctl restart pdns
|
|
||||||
systemctl restart pdns-recursor || true
|
|
||||||
""")
|
|
||||||
self._wait_dns_ready()
|
|
||||||
|
|
||||||
def _wait_dns_ready(self, timeout=60):
|
|
||||||
"""Poll until the recursor answers a query on port 53."""
|
|
||||||
deadline = time.time() + timeout
|
|
||||||
while time.time() < deadline:
|
|
||||||
result = self.bash(
|
|
||||||
"dig @127.0.0.1 . SOA +short +time=1 +tries=1",
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
if result and result.strip():
|
|
||||||
return
|
|
||||||
time.sleep(0.5)
|
|
||||||
raise DNSConfigurationError(f"DNS recursor not answering after {timeout}s")
|
|
||||||
|
|
||||||
def ensure(self):
|
|
||||||
"""Create the DNS container with PowerDNS if needed.
|
|
||||||
|
|
||||||
Calls ``super().ensure()`` to create/start the container
|
|
||||||
and set up SSH, then installs PowerDNS and configures
|
|
||||||
the Incus bridge to use this container as DNS.
|
|
||||||
"""
|
|
||||||
super().ensure()
|
|
||||||
self._install_powerdns()
|
|
||||||
self.incus.run(
|
|
||||||
["network", "set", "incusbr0", "dns.mode=none"],
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
self.incus.run(
|
|
||||||
["network", "set", "incusbr0", f"raw.dnsmasq=dhcp-option=6,{self.ipv4}"],
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
def destroy(self):
|
|
||||||
"""Stop, delete, and reset bridge DNS config."""
|
|
||||||
super().destroy()
|
|
||||||
self.incus.run(["network", "unset", "incusbr0", "dns.mode"], check=False)
|
|
||||||
self.incus.run(["network", "unset", "incusbr0", "raw.dnsmasq"], check=False)
|
|
||||||
|
|
||||||
def _install_powerdns(self):
|
|
||||||
"""Install and configure PowerDNS if not already present."""
|
|
||||||
if self.run_cmd("which", "pdns_server", check=False) is not None:
|
|
||||||
return
|
|
||||||
|
|
||||||
host_ns = self.incus.get_host_nameservers()
|
|
||||||
ns_lines = "\n".join(f"nameserver {n}" for n in host_ns)
|
|
||||||
|
|
||||||
self.bash(f"""
|
|
||||||
systemctl disable --now systemd-resolved 2>/dev/null || true
|
|
||||||
rm -f /etc/resolv.conf
|
|
||||||
printf '{ns_lines}\n' > /etc/resolv.conf
|
|
||||||
|
|
||||||
# Block automatic service startup during package installation
|
|
||||||
printf '#!/bin/sh\\nexit 101\\n' > /usr/sbin/policy-rc.d
|
|
||||||
chmod +x /usr/sbin/policy-rc.d
|
|
||||||
|
|
||||||
apt-get -o DPkg::Lock::Timeout=60 update
|
|
||||||
DEBIAN_FRONTEND=noninteractive apt-get install -y \
|
|
||||||
pdns-server pdns-backend-sqlite3 sqlite3 pdns-recursor dnsutils
|
|
||||||
|
|
||||||
# Remove the startup block
|
|
||||||
rm /usr/sbin/policy-rc.d
|
|
||||||
|
|
||||||
systemctl stop pdns pdns-recursor || true
|
|
||||||
mkdir -p /var/lib/powerdns
|
|
||||||
sqlite3 /var/lib/powerdns/pdns.sqlite3 \
|
|
||||||
</usr/share/doc/pdns-backend-sqlite3/schema.sqlite3.sql
|
|
||||||
chown -R pdns:pdns /var/lib/powerdns
|
|
||||||
""")
|
|
||||||
|
|
||||||
self.push_file_content(
|
|
||||||
"/etc/powerdns/pdns.conf",
|
|
||||||
"""
|
|
||||||
launch=gsqlite3
|
|
||||||
gsqlite3-database=/var/lib/powerdns/pdns.sqlite3
|
|
||||||
local-address=127.0.0.1
|
|
||||||
local-port=5353
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
|
|
||||||
self.push_file_content(
|
|
||||||
"/etc/powerdns/recursor.conf",
|
|
||||||
"""
|
|
||||||
local-address=0.0.0.0
|
|
||||||
local-port=53
|
|
||||||
forward-zones=localchat=127.0.0.1:5353
|
|
||||||
allow-from=0.0.0.0/0
|
|
||||||
dont-query=
|
|
||||||
dnssec=off
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
|
|
||||||
self.bash("""
|
|
||||||
systemctl start pdns
|
|
||||||
systemctl start pdns-recursor
|
|
||||||
echo 'nameserver 127.0.0.1' > /etc/resolv.conf
|
|
||||||
""")
|
|
||||||
self._wait_dns_ready()
|
|
||||||
|
|
||||||
def reset_dns_records(self, dns_ip, domains):
|
|
||||||
"""Create DNS zones with initial A records via pdnsutil.
|
|
||||||
|
|
||||||
Only sets SOA, NS, and A records as the minimal set
|
|
||||||
needed for SSH connectivity. Full records (MX, TXT, SRV,
|
|
||||||
CNAME, DKIM) are added later by ``cmdeploy dns``.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
dns_ip: IP of the DNS container
|
|
||||||
domains: list of dicts with 'name', 'domain', 'ip'
|
|
||||||
"""
|
|
||||||
for d in domains:
|
|
||||||
domain = d["domain"]
|
|
||||||
ip = d["ip"]
|
|
||||||
self.out.print(f" {domain} -> {ip}")
|
|
||||||
|
|
||||||
# Delete and recreate zone fresh (removes stale records)
|
|
||||||
self.pdnsutil("delete-zone", domain, check=False)
|
|
||||||
self.pdnsutil("create-zone", domain, f"ns.{domain}")
|
|
||||||
|
|
||||||
serial = str(int(time.time()))
|
|
||||||
soa = f"ns.{domain} hostmaster.{domain} {serial} 3600 900 604800 300"
|
|
||||||
self.replace_rrset(domain, ".", "SOA", "3600", soa)
|
|
||||||
self.replace_rrset(domain, ".", "NS", "3600", f"ns.{domain}.")
|
|
||||||
self.replace_rrset(domain, ".", "A", "3600", ip)
|
|
||||||
self.replace_rrset(domain, "ns", "A", "3600", dns_ip)
|
|
||||||
|
|
||||||
# AAAA (domain -> container IPv6, if available)
|
|
||||||
ipv6 = d.get("ipv6")
|
|
||||||
if ipv6:
|
|
||||||
self.replace_rrset(domain, ".", "AAAA", "3600", ipv6)
|
|
||||||
self.out.print(f" zone reset: SOA, NS, A, AAAA ({ip}, {ipv6})")
|
|
||||||
else:
|
|
||||||
# Remove any stale AAAA record
|
|
||||||
self.pdnsutil("delete-rrset", domain, ".", "AAAA", check=False)
|
|
||||||
self.out.print(f" zone reset: SOA, NS, A ({ip}, IPv4-only)")
|
|
||||||
|
|
||||||
self.restart_services()
|
|
||||||
|
|
||||||
def set_dns_records(self, text):
|
|
||||||
"""Add or overwrite DNS records from standard BIND format.
|
|
||||||
|
|
||||||
Uses ``cmdeploy.dns.parse_zone_records`` to parse.
|
|
||||||
Zones are created automatically from the record names.
|
|
||||||
"""
|
|
||||||
from ..dns import parse_zone_records
|
|
||||||
|
|
||||||
zones_seen = set()
|
|
||||||
|
|
||||||
for name, ttl, rtype, rdata in parse_zone_records(text):
|
|
||||||
# Derive zone from name: find top-level .localchat domain
|
|
||||||
name_parts = name.split(".")
|
|
||||||
zone = name # fallback
|
|
||||||
for i in range(len(name_parts) - 1):
|
|
||||||
if name_parts[i + 1 :] == ["localchat"]:
|
|
||||||
zone = ".".join(name_parts[i:])
|
|
||||||
break
|
|
||||||
|
|
||||||
# Create zone if first time seeing it
|
|
||||||
if zone not in zones_seen:
|
|
||||||
self.pdnsutil(
|
|
||||||
"create-zone",
|
|
||||||
zone,
|
|
||||||
f"ns.{zone}",
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
zones_seen.add(zone)
|
|
||||||
|
|
||||||
# Figure out the record name relative to zone
|
|
||||||
if name == zone:
|
|
||||||
relative = "."
|
|
||||||
elif name.endswith(f".{zone}"):
|
|
||||||
relative = name[: -(len(zone) + 1)]
|
|
||||||
else:
|
|
||||||
relative = name
|
|
||||||
|
|
||||||
self.replace_rrset(zone, relative, rtype, ttl, rdata)
|
|
||||||
|
|
||||||
if zones_seen:
|
|
||||||
self.restart_services()
|
|
||||||
1
cmdeploy/src/cmdeploy/metrics.cron.j2
Normal file
1
cmdeploy/src/cmdeploy/metrics.cron.j2
Normal file
@@ -0,0 +1 @@
|
|||||||
|
*/5 * * * * root {{ config.execpath }} {{ config.mailboxes_dir }} >/var/www/html/metrics
|
||||||
@@ -1,47 +1,47 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
<clientConfig version="1.1">
|
<clientConfig version="1.1">
|
||||||
<emailProvider id="{{ config.mail_domain }}">
|
<emailProvider id="{{ config.domain_name }}">
|
||||||
<domain>{{ config.mail_domain }}</domain>
|
<domain>{{ config.domain_name }}</domain>
|
||||||
<displayName>{{ config.mail_domain }} chatmail</displayName>
|
<displayName>{{ config.domain_name }} chatmail</displayName>
|
||||||
<displayShortName>{{ config.mail_domain }}</displayShortName>
|
<displayShortName>{{ config.domain_name }}</displayShortName>
|
||||||
<incomingServer type="imap">
|
<incomingServer type="imap">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>993</port>
|
<port>993</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</incomingServer>
|
</incomingServer>
|
||||||
<incomingServer type="imap">
|
<incomingServer type="imap">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>143</port>
|
<port>143</port>
|
||||||
<socketType>STARTTLS</socketType>
|
<socketType>STARTTLS</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</incomingServer>
|
</incomingServer>
|
||||||
<incomingServer type="imap">
|
<incomingServer type="imap">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>443</port>
|
<port>443</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</incomingServer>
|
</incomingServer>
|
||||||
<outgoingServer type="smtp">
|
<outgoingServer type="smtp">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>465</port>
|
<port>465</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</outgoingServer>
|
</outgoingServer>
|
||||||
<outgoingServer type="smtp">
|
<outgoingServer type="smtp">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>587</port>
|
<port>587</port>
|
||||||
<socketType>STARTTLS</socketType>
|
<socketType>STARTTLS</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</outgoingServer>
|
</outgoingServer>
|
||||||
<outgoingServer type="smtp">
|
<outgoingServer type="smtp">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>443</port>
|
<port>443</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config={"domain_name": config.mail_domain},
|
||||||
disable_ipv6=config.disable_ipv6,
|
disable_ipv6=config.disable_ipv6,
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
@@ -81,7 +81,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config={"domain_name": config.mail_domain},
|
||||||
)
|
)
|
||||||
need_restart |= autoconfig.changed
|
need_restart |= autoconfig.changed
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config={"domain_name": config.mail_domain},
|
||||||
)
|
)
|
||||||
need_restart |= mta_sts_config.changed
|
need_restart |= mta_sts_config.changed
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
version: STSv1
|
version: STSv1
|
||||||
mode: enforce
|
mode: enforce
|
||||||
mx: {{ config.mail_domain }}
|
mx: {{ config.domain_name }}
|
||||||
max_age: 2419200
|
max_age: 2419200
|
||||||
|
|||||||
@@ -42,9 +42,6 @@ stream {
|
|||||||
}
|
}
|
||||||
|
|
||||||
http {
|
http {
|
||||||
{% if config.tls_cert_mode == "self" %}
|
|
||||||
limit_req_zone $binary_remote_addr zone=newaccount:10m rate=2r/s;
|
|
||||||
{% endif %}
|
|
||||||
sendfile on;
|
sendfile on;
|
||||||
tcp_nopush on;
|
tcp_nopush on;
|
||||||
|
|
||||||
@@ -56,8 +53,8 @@ http {
|
|||||||
|
|
||||||
ssl_protocols TLSv1.2 TLSv1.3;
|
ssl_protocols TLSv1.2 TLSv1.3;
|
||||||
ssl_prefer_server_ciphers on;
|
ssl_prefer_server_ciphers on;
|
||||||
ssl_certificate {{ config.tls_cert_path }};
|
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
||||||
ssl_certificate_key {{ config.tls_key_path }};
|
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
||||||
|
|
||||||
gzip on;
|
gzip on;
|
||||||
|
|
||||||
@@ -69,7 +66,7 @@ http {
|
|||||||
|
|
||||||
index index.html index.htm;
|
index index.html index.htm;
|
||||||
|
|
||||||
server_name {{ config.mail_domain }} www.{{ config.mail_domain }} mta-sts.{{ config.mail_domain }};
|
server_name {{ config.domain_name }} www.{{ config.domain_name }} mta-sts.{{ config.domain_name }};
|
||||||
|
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
access_log syslog:server=unix:/dev/log,facility=local7;
|
||||||
|
|
||||||
@@ -79,16 +76,16 @@ http {
|
|||||||
try_files $uri $uri/ =404;
|
try_files $uri $uri/ =404;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
location /metrics {
|
||||||
|
default_type text/plain;
|
||||||
|
}
|
||||||
|
|
||||||
location /new {
|
location /new {
|
||||||
{% if config.tls_cert_mode != "self" %}
|
|
||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
# Redirect to Delta Chat,
|
# Redirect to Delta Chat,
|
||||||
# which will in turn do a POST request.
|
# which will in turn do a POST request.
|
||||||
return 301 dcaccount:https://{{ config.mail_domain }}/new;
|
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
||||||
}
|
}
|
||||||
{% else %}
|
|
||||||
limit_req zone=newaccount burst=5 nodelay;
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
include /etc/nginx/fastcgi_params;
|
include /etc/nginx/fastcgi_params;
|
||||||
@@ -102,11 +99,9 @@ http {
|
|||||||
#
|
#
|
||||||
# Redirects are only for browsers.
|
# Redirects are only for browsers.
|
||||||
location /cgi-bin/newemail.py {
|
location /cgi-bin/newemail.py {
|
||||||
{% if config.tls_cert_mode != "self" %}
|
|
||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
return 301 dcaccount:https://{{ config.mail_domain }}/new;
|
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
||||||
}
|
}
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
include /etc/nginx/fastcgi_params;
|
include /etc/nginx/fastcgi_params;
|
||||||
@@ -137,29 +132,8 @@ http {
|
|||||||
# Redirect www. to non-www
|
# Redirect www. to non-www
|
||||||
server {
|
server {
|
||||||
listen 127.0.0.1:8443 ssl;
|
listen 127.0.0.1:8443 ssl;
|
||||||
server_name www.{{ config.mail_domain }};
|
server_name www.{{ config.domain_name }};
|
||||||
return 301 $scheme://{{ config.mail_domain }}$request_uri;
|
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
access_log syslog:server=unix:/dev/log,facility=local7;
|
||||||
}
|
}
|
||||||
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
{% if not disable_ipv6 %}
|
|
||||||
listen [::]:80;
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if config.tls_cert_mode == "acme" %}
|
|
||||||
location /.well-known/acme-challenge/ {
|
|
||||||
proxy_pass http://acmetool;
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
return 301 https://$host$request_uri;
|
|
||||||
}
|
|
||||||
|
|
||||||
{% if config.tls_cert_mode == "acme" %}
|
|
||||||
upstream acmetool {
|
|
||||||
server 127.0.0.1:402;
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,15 +37,21 @@ class OpendkimDeployer(Deployer):
|
|||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
screen_script = files.file(
|
screen_script = files.put(
|
||||||
path="/etc/opendkim/screen.lua",
|
src=get_resource("opendkim/screen.lua"),
|
||||||
present=False,
|
dest="/etc/opendkim/screen.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
)
|
)
|
||||||
need_restart |= screen_script.changed
|
need_restart |= screen_script.changed
|
||||||
|
|
||||||
final_script = files.file(
|
final_script = files.put(
|
||||||
path="/etc/opendkim/final.lua",
|
src=get_resource("opendkim/final.lua"),
|
||||||
present=False,
|
dest="/etc/opendkim/final.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
)
|
)
|
||||||
need_restart |= final_script.changed
|
need_restart |= final_script.changed
|
||||||
|
|
||||||
@@ -103,13 +109,6 @@ class OpendkimDeployer(Deployer):
|
|||||||
)
|
)
|
||||||
need_restart |= service_file.changed
|
need_restart |= service_file.changed
|
||||||
|
|
||||||
files.file(
|
|
||||||
name="chown opendkim: /etc/dkimkeys/opendkim.private",
|
|
||||||
path="/etc/dkimkeys/opendkim.private",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
)
|
|
||||||
|
|
||||||
self.need_restart = need_restart
|
self.need_restart = need_restart
|
||||||
|
|
||||||
def activate(self):
|
def activate(self):
|
||||||
|
|||||||
42
cmdeploy/src/cmdeploy/opendkim/final.lua
Normal file
42
cmdeploy/src/cmdeploy/opendkim/final.lua
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
mtaname = odkim.get_mtasymbol(ctx, "{daemon_name}")
|
||||||
|
if mtaname == "ORIGINATING" then
|
||||||
|
-- Outgoing message will be signed,
|
||||||
|
-- no need to look for signatures.
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
nsigs = odkim.get_sigcount(ctx)
|
||||||
|
if nsigs == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
local valid = false
|
||||||
|
local error_msg = "No valid DKIM signature found."
|
||||||
|
for i = 1, nsigs do
|
||||||
|
sig = odkim.get_sighandle(ctx, i - 1)
|
||||||
|
sigres = odkim.sig_result(sig)
|
||||||
|
|
||||||
|
-- All signatures that do not correspond to From:
|
||||||
|
-- were ignored in screen.lua and return sigres -1.
|
||||||
|
--
|
||||||
|
-- Any valid signature that was not ignored like this
|
||||||
|
-- means the message is acceptable.
|
||||||
|
if sigres == 0 then
|
||||||
|
valid = true
|
||||||
|
else
|
||||||
|
error_msg = "DKIM signature is invalid, error code " .. tostring(sigres) .. ", search https://github.com/trusteddomainproject/OpenDKIM/blob/master/libopendkim/dkim.h#L108"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
if valid then
|
||||||
|
-- Strip all DKIM-Signature headers after successful validation
|
||||||
|
-- Delete in reverse order to avoid index shifting.
|
||||||
|
for i = nsigs, 1, -1 do
|
||||||
|
odkim.del_header(ctx, "DKIM-Signature", i)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
odkim.set_reply(ctx, "554", "5.7.1", error_msg)
|
||||||
|
odkim.set_result(ctx, SMFIS_REJECT)
|
||||||
|
end
|
||||||
|
|
||||||
|
return nil
|
||||||
@@ -45,6 +45,12 @@ SignHeaders *,+autocrypt,+content-type
|
|||||||
# Default is empty.
|
# Default is empty.
|
||||||
OversignHeaders from,reply-to,subject,date,to,cc,resent-date,resent-from,resent-sender,resent-to,resent-cc,in-reply-to,references,list-id,list-help,list-unsubscribe,list-subscribe,list-post,list-owner,list-archive,autocrypt
|
OversignHeaders from,reply-to,subject,date,to,cc,resent-date,resent-from,resent-sender,resent-to,resent-cc,in-reply-to,references,list-id,list-help,list-unsubscribe,list-subscribe,list-post,list-owner,list-archive,autocrypt
|
||||||
|
|
||||||
|
# Script to ignore signatures that do not correspond to the From: domain.
|
||||||
|
ScreenPolicyScript /etc/opendkim/screen.lua
|
||||||
|
|
||||||
|
# Script to reject mails without a valid DKIM signature.
|
||||||
|
FinalPolicyScript /etc/opendkim/final.lua
|
||||||
|
|
||||||
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
||||||
# using a local socket with MTAs that access the socket as a non-privileged
|
# using a local socket with MTAs that access the socket as a non-privileged
|
||||||
# user (for example, Postfix). You may need to add user "postfix" to group
|
# user (for example, Postfix). You may need to add user "postfix" to group
|
||||||
|
|||||||
21
cmdeploy/src/cmdeploy/opendkim/screen.lua
Normal file
21
cmdeploy/src/cmdeploy/opendkim/screen.lua
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
-- Ignore signatures that do not correspond to the From: domain.
|
||||||
|
|
||||||
|
from_domain = odkim.get_fromdomain(ctx)
|
||||||
|
if from_domain == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
n = odkim.get_sigcount(ctx)
|
||||||
|
if n == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
for i = 1, n do
|
||||||
|
sig = odkim.get_sighandle(ctx, i - 1)
|
||||||
|
sig_domain = odkim.sig_getdomain(sig)
|
||||||
|
if from_domain ~= sig_domain then
|
||||||
|
odkim.sig_ignore(sig)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return nil
|
||||||
@@ -61,20 +61,6 @@ class PostfixDeployer(Deployer):
|
|||||||
)
|
)
|
||||||
need_restart |= lmtp_header_cleanup.changed
|
need_restart |= lmtp_header_cleanup.changed
|
||||||
|
|
||||||
tls_policy_map = files.put(
|
|
||||||
name="Upload SMTP TLS Policy that accepts self-signed certificates for IP-only hosts",
|
|
||||||
src=get_resource("postfix/smtp_tls_policy_map"),
|
|
||||||
dest="/etc/postfix/smtp_tls_policy_map",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= tls_policy_map.changed
|
|
||||||
if tls_policy_map.changed:
|
|
||||||
server.shell(
|
|
||||||
commands=["postmap /etc/postfix/smtp_tls_policy_map"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Login map that 1:1 maps email address to login.
|
# Login map that 1:1 maps email address to login.
|
||||||
login_map = files.put(
|
login_map = files.put(
|
||||||
src=get_resource("postfix/login_map"),
|
src=get_resource("postfix/login_map"),
|
||||||
|
|||||||
@@ -1,3 +1,2 @@
|
|||||||
/^DKIM-Signature:/ IGNORE
|
/^DKIM-Signature:/ IGNORE
|
||||||
/^Authentication-Results:/ IGNORE
|
/^Authentication-Results:/ IGNORE
|
||||||
/^Received:/ IGNORE
|
|
||||||
|
|||||||
@@ -15,17 +15,17 @@ readme_directory = no
|
|||||||
compatibility_level = 3.6
|
compatibility_level = 3.6
|
||||||
|
|
||||||
# TLS parameters
|
# TLS parameters
|
||||||
smtpd_tls_cert_file={{ config.tls_cert_path }}
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
smtpd_tls_key_file={{ config.tls_key_path }}
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
smtpd_tls_security_level=may
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
smtp_tls_security_level={{ "verify" if config.tls_cert_mode == "acme" else "encrypt" }}
|
smtp_tls_security_level=verify
|
||||||
# Send SNI extension when connecting to other servers.
|
# Send SNI extension when connecting to other servers.
|
||||||
# <https://www.postfix.org/postconf.5.html#smtp_tls_servername>
|
# <https://www.postfix.org/postconf.5.html#smtp_tls_servername>
|
||||||
smtp_tls_servername = hostname
|
smtp_tls_servername = hostname
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
smtp_tls_policy_maps = regexp:/etc/postfix/smtp_tls_policy_map
|
smtp_tls_policy_maps = inline:{nauta.cu=may}
|
||||||
smtp_tls_protocols = >=TLSv1.2
|
smtp_tls_protocols = >=TLSv1.2
|
||||||
smtp_tls_mandatory_protocols = >=TLSv1.2
|
smtp_tls_mandatory_protocols = >=TLSv1.2
|
||||||
|
|
||||||
@@ -69,15 +69,6 @@ mynetworks = 127.0.0.0/8
|
|||||||
{% else %}
|
{% else %}
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% if config.addr_v4 %}
|
|
||||||
smtp_bind_address = {{ config.addr_v4 }}
|
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v6 %}
|
|
||||||
smtp_bind_address6 = {{ config.addr_v6 }}
|
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v4 or config.addr_v6 %}
|
|
||||||
smtp_bind_address_enforce = yes
|
|
||||||
{% endif %}
|
|
||||||
mailbox_size_limit = 0
|
mailbox_size_limit = 0
|
||||||
message_size_limit = {{config.max_message_size}}
|
message_size_limit = {{config.max_message_size}}
|
||||||
recipient_delimiter = +
|
recipient_delimiter = +
|
||||||
|
|||||||
@@ -86,6 +86,7 @@ filter unix - n n - - lmtp
|
|||||||
# 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_milters=unix:opendkim/opendkim.sock
|
||||||
|
|
||||||
# Cleanup `Received` headers for authenticated mail
|
# Cleanup `Received` headers for authenticated mail
|
||||||
# to avoid leaking client IP.
|
# to avoid leaking client IP.
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
/^\[[^]]+\]$/ encrypt
|
|
||||||
/^_/ encrypt
|
|
||||||
/^nauta\.cu$/ may
|
|
||||||
@@ -58,8 +58,8 @@ def get_dkim_entry(mail_domain, pre_command, dkim_selector):
|
|||||||
dkim_value = '" "'.join(re.findall(".{1,255}", dkim_value_raw))
|
dkim_value = '" "'.join(re.findall(".{1,255}", dkim_value_raw))
|
||||||
web_dkim_value = "".join(re.findall(".{1,255}", dkim_value_raw))
|
web_dkim_value = "".join(re.findall(".{1,255}", dkim_value_raw))
|
||||||
return (
|
return (
|
||||||
f'{dkim_selector}._domainkey.{mail_domain}. 3600 IN TXT "{dkim_value}"',
|
f'{dkim_selector}._domainkey.{mail_domain}. TXT "{dkim_value}"',
|
||||||
f'{dkim_selector}._domainkey.{mail_domain}. 3600 IN TXT "{web_dkim_value}"',
|
f'{dkim_selector}._domainkey.{mail_domain}. TXT "{web_dkim_value}"',
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -94,11 +94,9 @@ def check_zonefile(zonefile, verbose=True):
|
|||||||
if not zf_line.strip() or zf_line.startswith(";"):
|
if not zf_line.strip() or zf_line.startswith(";"):
|
||||||
continue
|
continue
|
||||||
print(f"dns-checking {zf_line!r}") if verbose else log_progress("")
|
print(f"dns-checking {zf_line!r}") if verbose else log_progress("")
|
||||||
parts = zf_line.split(None, 4)
|
zf_domain, zf_typ, zf_value = zf_line.split(maxsplit=2)
|
||||||
zf_domain = parts[0].rstrip(".")
|
zf_domain = zf_domain.rstrip(".")
|
||||||
# parts[1]=TTL, parts[2]=IN, parts[3]=type, parts[4]=rdata
|
zf_value = zf_value.strip()
|
||||||
zf_typ = parts[3]
|
|
||||||
zf_value = parts[4].strip()
|
|
||||||
query_value = query_dns(zf_typ, zf_domain)
|
query_value = query_dns(zf_typ, zf_domain)
|
||||||
if zf_value != query_value:
|
if zf_value != query_value:
|
||||||
assert zf_typ in ("A", "AAAA", "CNAME", "CAA", "SRV", "MX", "TXT"), zf_line
|
assert zf_typ in ("A", "AAAA", "CNAME", "CAA", "SRV", "MX", "TXT"), zf_line
|
||||||
|
|||||||
@@ -1,68 +0,0 @@
|
|||||||
import shlex
|
|
||||||
|
|
||||||
from pyinfra.operations import apt, server
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import Deployer
|
|
||||||
|
|
||||||
|
|
||||||
def openssl_selfsigned_args(domain, cert_path, key_path, days=36500):
|
|
||||||
"""Return the openssl argument list for a self-signed certificate.
|
|
||||||
|
|
||||||
The certificate uses an EC P-256 key with SAN entries for *domain*,
|
|
||||||
``www.<domain>`` and ``mta-sts.<domain>``.
|
|
||||||
"""
|
|
||||||
return [
|
|
||||||
"openssl",
|
|
||||||
"req",
|
|
||||||
"-x509",
|
|
||||||
"-newkey",
|
|
||||||
"ec",
|
|
||||||
"-pkeyopt",
|
|
||||||
"ec_paramgen_curve:P-256",
|
|
||||||
"-noenc",
|
|
||||||
"-days",
|
|
||||||
str(days),
|
|
||||||
"-keyout",
|
|
||||||
str(key_path),
|
|
||||||
"-out",
|
|
||||||
str(cert_path),
|
|
||||||
"-subj",
|
|
||||||
f"/CN={domain}",
|
|
||||||
# Mark as end-entity cert so it cannot be used as a CA to sign others.
|
|
||||||
"-addext",
|
|
||||||
"basicConstraints=critical,CA:FALSE",
|
|
||||||
"-addext",
|
|
||||||
"extendedKeyUsage=serverAuth,clientAuth",
|
|
||||||
"-addext",
|
|
||||||
f"subjectAltName=DNS:{domain},DNS:www.{domain},DNS:mta-sts.{domain}",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class SelfSignedTlsDeployer(Deployer):
|
|
||||||
"""Generates a self-signed TLS certificate for all chatmail endpoints."""
|
|
||||||
|
|
||||||
def __init__(self, mail_domain):
|
|
||||||
self.mail_domain = mail_domain
|
|
||||||
self.cert_path = "/etc/ssl/certs/mailserver.pem"
|
|
||||||
self.key_path = "/etc/ssl/private/mailserver.key"
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
apt.packages(
|
|
||||||
name="Install openssl",
|
|
||||||
packages=["openssl"],
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
args = openssl_selfsigned_args(
|
|
||||||
self.mail_domain,
|
|
||||||
self.cert_path,
|
|
||||||
self.key_path,
|
|
||||||
)
|
|
||||||
cmd = shlex.join(args)
|
|
||||||
server.shell(
|
|
||||||
name="Generate self-signed TLS certificate if not present",
|
|
||||||
commands=[f"[ -f {self.cert_path} ] || {cmd}"],
|
|
||||||
)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
pass
|
|
||||||
@@ -5,5 +5,5 @@ After=network.target
|
|||||||
[Service]
|
[Service]
|
||||||
Type=oneshot
|
Type=oneshot
|
||||||
User=vmail
|
User=vmail
|
||||||
ExecStart=/usr/local/lib/chatmaild/venv/bin/chatmail-fsreport /usr/local/lib/chatmaild/chatmail.ini
|
ExecStart=/usr/local/lib/chatmaild/venv/bin/chatmail-fsreport /usr/local/lib/chatmaild/chatmail.ini
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Description=Chatmail dict proxy for IMAP METADATA
|
|||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} /run/chatmail-metadata/metadata.socket {config_path}
|
ExecStart={execpath} /run/chatmail-metadata/metadata.socket {config_path}
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=5
|
RestartSec=30
|
||||||
User=vmail
|
User=vmail
|
||||||
RuntimeDirectory=chatmail-metadata
|
RuntimeDirectory=chatmail-metadata
|
||||||
UMask=0077
|
UMask=0077
|
||||||
|
|||||||
@@ -49,13 +49,8 @@ class SSHExec:
|
|||||||
RemoteError = execnet.RemoteError
|
RemoteError = execnet.RemoteError
|
||||||
FuncError = FuncError
|
FuncError = FuncError
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, host, verbose=False, python="python3", timeout=60):
|
||||||
self, host, verbose=False, python="python3", timeout=60, ssh_config=None
|
self.gateway = execnet.makegateway(f"ssh=root@{host}//python={python}")
|
||||||
):
|
|
||||||
spec = f"ssh=root@{host}//python={python}"
|
|
||||||
if ssh_config:
|
|
||||||
spec += f"//ssh_config={ssh_config}"
|
|
||||||
self.gateway = execnet.makegateway(spec)
|
|
||||||
self._remote_cmdloop_channel = bootstrap_remote(self.gateway, remote)
|
self._remote_cmdloop_channel = bootstrap_remote(self.gateway, remote)
|
||||||
self.timeout = timeout
|
self.timeout = timeout
|
||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
@@ -90,74 +85,16 @@ class SSHExec:
|
|||||||
|
|
||||||
|
|
||||||
class LocalExec:
|
class LocalExec:
|
||||||
FuncError = FuncError
|
|
||||||
|
|
||||||
def __init__(self, verbose=False, docker=False):
|
def __init__(self, verbose=False, docker=False):
|
||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
self.docker = docker
|
self.docker = docker
|
||||||
|
|
||||||
def __call__(self, call, kwargs=None, log_callback=None):
|
|
||||||
if kwargs is None:
|
|
||||||
kwargs = {}
|
|
||||||
return call(**kwargs)
|
|
||||||
|
|
||||||
def logged(self, call, kwargs: dict):
|
def logged(self, call, kwargs: dict):
|
||||||
title = call.__doc__
|
|
||||||
if not title:
|
|
||||||
title = call.__name__
|
|
||||||
where = "locally"
|
where = "locally"
|
||||||
if self.docker:
|
if self.docker:
|
||||||
if call == remote.rdns.perform_initial_checks:
|
if call == remote.rdns.perform_initial_checks:
|
||||||
kwargs["pre_command"] = "docker exec chatmail "
|
kwargs["pre_command"] = "docker exec chatmail "
|
||||||
where = "in docker"
|
where = "in docker"
|
||||||
if self.verbose:
|
if self.verbose:
|
||||||
print_stderr(f"Running {where}: {title}(**{kwargs})")
|
print(f"Running {where}: {call.__name__}(**{kwargs})")
|
||||||
return self(call, kwargs, log_callback=print_stderr)
|
return call(**kwargs)
|
||||||
else:
|
|
||||||
print_stderr(title, end="")
|
|
||||||
res = self(call, kwargs, log_callback=remote.rshell.log_progress)
|
|
||||||
print_stderr()
|
|
||||||
return res
|
|
||||||
|
|
||||||
|
|
||||||
# pyinfra exposes a ``ssh_config_file`` data key that *should* let
|
|
||||||
# paramiko parse an SSH config file directly. In practice it silently
|
|
||||||
# fails to connect (zero hosts / zero operations), so we resolve the
|
|
||||||
# hostname and identity-file ourselves and pass them via
|
|
||||||
# ``--data ssh_hostname`` / ``--data ssh_key`` instead.
|
|
||||||
# Execnet uses ssh natively (and not paramiko) and doesn't have this problem.
|
|
||||||
|
|
||||||
|
|
||||||
def _get_from_ssh_config(host, ssh_config_path, key):
|
|
||||||
"""Internal helper to parse a value for a specific key from ssh-config."""
|
|
||||||
current_hosts = []
|
|
||||||
found_value = None
|
|
||||||
with open(ssh_config_path) as f:
|
|
||||||
for raw_line in f:
|
|
||||||
line = raw_line.strip()
|
|
||||||
if not line or line.startswith("#"):
|
|
||||||
continue
|
|
||||||
parts = line.split(None, 1)
|
|
||||||
if not parts:
|
|
||||||
continue
|
|
||||||
directive = parts[0].lower()
|
|
||||||
if directive == "host":
|
|
||||||
if host in current_hosts and found_value:
|
|
||||||
return found_value
|
|
||||||
current_hosts = parts[1].split()
|
|
||||||
found_value = None
|
|
||||||
elif directive == key.lower():
|
|
||||||
found_value = parts[1]
|
|
||||||
if host in current_hosts and found_value:
|
|
||||||
return found_value
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_host_from_ssh_config(host, ssh_config_path):
|
|
||||||
"""Resolve a host alias to its IP from an ssh-config file."""
|
|
||||||
return _get_from_ssh_config(host, ssh_config_path, "Hostname") or host
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_key_from_ssh_config(host, ssh_config_path):
|
|
||||||
"""Resolve a host alias to its IdentityFile from an ssh-config file."""
|
|
||||||
return _get_from_ssh_config(host, ssh_config_path, "IdentityFile")
|
|
||||||
|
|||||||
@@ -1,18 +1,17 @@
|
|||||||
; Required DNS entries
|
; Required DNS entries for chatmail servers
|
||||||
zftest.testrun.org. 3600 IN A 135.181.204.127
|
zftest.testrun.org. A 135.181.204.127
|
||||||
zftest.testrun.org. 3600 IN AAAA 2a01:4f9:c012:52f4::1
|
zftest.testrun.org. AAAA 2a01:4f9:c012:52f4::1
|
||||||
zftest.testrun.org. 3600 IN MX 10 zftest.testrun.org.
|
zftest.testrun.org. MX 10 zftest.testrun.org.
|
||||||
_mta-sts.zftest.testrun.org. 3600 IN TXT "v=STSv1; id=202403211706"
|
_mta-sts.zftest.testrun.org. TXT "v=STSv1; id=202403211706"
|
||||||
mta-sts.zftest.testrun.org. 3600 IN CNAME zftest.testrun.org.
|
mta-sts.zftest.testrun.org. CNAME zftest.testrun.org.
|
||||||
www.zftest.testrun.org. 3600 IN CNAME zftest.testrun.org.
|
www.zftest.testrun.org. CNAME zftest.testrun.org.
|
||||||
opendkim._domainkey.zftest.testrun.org. 3600 IN TXT "v=DKIM1;k=rsa;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoYt82CVUyz2ouaqjX2kB+5J80knAyoOU3MGU5aWppmwUwwTvj/oSTSpkc5JMtVTRmKKr8NUDWAL1Yw7dfGqqPHdHfwwjS3BIvDzYx+hzgtz62RnfNgV+/2MAoNpfX7cAFIHdRzEHNtwugc3RDLquqPoupAE3Y2YRw2T5zG5fILh4vwIcJZL5Uq6B92j8wwJqOex" "33n+vm1NKQ9rxo/UsHAmZlJzpooXcG/4igTBxJyJlamVSRR6N7Nul1v//YJb7J6v2o0iPHW6uE0StzKaPPNC2IVosSRFbD9H2oqppltptFSNPlI0E+t0JBWHem6YK7xcugiO3ImMCaaU8g6Jt/wIDAQAB;s=email;t=s"
|
opendkim._domainkey.zftest.testrun.org. TXT "v=DKIM1;k=rsa;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoYt82CVUyz2ouaqjX2kB+5J80knAyoOU3MGU5aWppmwUwwTvj/oSTSpkc5JMtVTRmKKr8NUDWAL1Yw7dfGqqPHdHfwwjS3BIvDzYx+hzgtz62RnfNgV+/2MAoNpfX7cAFIHdRzEHNtwugc3RDLquqPoupAE3Y2YRw2T5zG5fILh4vwIcJZL5Uq6B92j8wwJqOex" "33n+vm1NKQ9rxo/UsHAmZlJzpooXcG/4igTBxJyJlamVSRR6N7Nul1v//YJb7J6v2o0iPHW6uE0StzKaPPNC2IVosSRFbD9H2oqppltptFSNPlI0E+t0JBWHem6YK7xcugiO3ImMCaaU8g6Jt/wIDAQAB;s=email;t=s"
|
||||||
|
|
||||||
; Recommended DNS entries
|
; Recommended DNS entries
|
||||||
zftest.testrun.org. 3600 IN TXT "v=spf1 a ~all"
|
_submission._tcp.zftest.testrun.org. SRV 0 1 587 zftest.testrun.org.
|
||||||
_dmarc.zftest.testrun.org. 3600 IN TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
_submissions._tcp.zftest.testrun.org. SRV 0 1 465 zftest.testrun.org.
|
||||||
zftest.testrun.org. 3600 IN CAA 0 issue "letsencrypt.org;accounturi=https://acme-v02.api.letsencrypt.org/acme/acct/1371472956"
|
_imap._tcp.zftest.testrun.org. SRV 0 1 143 zftest.testrun.org.
|
||||||
_adsp._domainkey.zftest.testrun.org. 3600 IN TXT "dkim=discardable"
|
_imaps._tcp.zftest.testrun.org. SRV 0 1 993 zftest.testrun.org.
|
||||||
_submission._tcp.zftest.testrun.org. 3600 IN SRV 0 1 587 zftest.testrun.org.
|
zftest.testrun.org. CAA 0 issue "letsencrypt.org;accounturi=https://acme-v02.api.letsencrypt.org/acme/acct/1371472956"
|
||||||
_submissions._tcp.zftest.testrun.org. 3600 IN SRV 0 1 465 zftest.testrun.org.
|
zftest.testrun.org. TXT "v=spf1 a:zftest.testrun.org ~all"
|
||||||
_imap._tcp.zftest.testrun.org. 3600 IN SRV 0 1 143 zftest.testrun.org.
|
_dmarc.zftest.testrun.org. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
||||||
_imaps._tcp.zftest.testrun.org. 3600 IN SRV 0 1 993 zftest.testrun.org.
|
_adsp._domainkey.zftest.testrun.org. TXT "dkim=discardable"
|
||||||
|
|||||||
@@ -41,9 +41,9 @@ class TestDC:
|
|||||||
|
|
||||||
def dc_ping_pong():
|
def dc_ping_pong():
|
||||||
chat.send_text("ping")
|
chat.send_text("ping")
|
||||||
msg = ac2.wait_for_incoming_msg()
|
msg = ac2._evtracker.wait_next_incoming_message()
|
||||||
msg.get_snapshot().chat.send_text("pong")
|
msg.chat.send_text("pong")
|
||||||
ac1.wait_for_incoming_msg()
|
ac1._evtracker.wait_next_incoming_message()
|
||||||
|
|
||||||
benchmark(dc_ping_pong, 5)
|
benchmark(dc_ping_pong, 5)
|
||||||
|
|
||||||
@@ -55,6 +55,6 @@ class TestDC:
|
|||||||
for i in range(10):
|
for i in range(10):
|
||||||
chat.send_text(f"hello {i}")
|
chat.send_text(f"hello {i}")
|
||||||
for i in range(10):
|
for i in range(10):
|
||||||
ac2.wait_for_incoming_msg()
|
ac2._evtracker.wait_next_incoming_message()
|
||||||
|
|
||||||
benchmark(dc_send_10_receive_10, 5, cooldown="auto")
|
benchmark(dc_send_10_receive_10, 5)
|
||||||
|
|||||||
@@ -89,9 +89,7 @@ def test_concurrent_logins_same_account(
|
|||||||
assert login_results.get()
|
assert login_results.get()
|
||||||
|
|
||||||
|
|
||||||
def test_no_vrfy(cmfactory, chatmail_config):
|
def test_no_vrfy(chatmail_config):
|
||||||
ac = cmfactory.get_online_account()
|
|
||||||
addr = ac.get_config("addr")
|
|
||||||
domain = chatmail_config.mail_domain
|
domain = chatmail_config.mail_domain
|
||||||
|
|
||||||
s = smtplib.SMTP(domain)
|
s = smtplib.SMTP(domain)
|
||||||
@@ -100,7 +98,7 @@ def test_no_vrfy(cmfactory, chatmail_config):
|
|||||||
s.putcmd("vrfy", f"wrongaddress@{chatmail_config.mail_domain}")
|
s.putcmd("vrfy", f"wrongaddress@{chatmail_config.mail_domain}")
|
||||||
result = s.getreply()
|
result = s.getreply()
|
||||||
print(result)
|
print(result)
|
||||||
s.putcmd("vrfy", addr)
|
s.putcmd("vrfy", f"echo@{chatmail_config.mail_domain}")
|
||||||
result2 = s.getreply()
|
result2 = s.getreply()
|
||||||
print(result2)
|
print(result2)
|
||||||
assert result[0] == result2[0] == 252
|
assert result[0] == result2[0] == 252
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
import pytest
|
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from cmdeploy.genqr import gen_qr_png_data
|
from cmdeploy.genqr import gen_qr_png_data
|
||||||
@@ -9,36 +8,18 @@ def test_gen_qr_png_data(maildomain):
|
|||||||
assert data
|
assert data
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.filterwarnings("ignore::urllib3.exceptions.InsecureRequestWarning")
|
|
||||||
def test_fastcgi_working(maildomain, chatmail_config):
|
def test_fastcgi_working(maildomain, chatmail_config):
|
||||||
url = f"https://{maildomain}/new"
|
url = f"https://{maildomain}/new"
|
||||||
print(url)
|
print(url)
|
||||||
verify = chatmail_config.tls_cert_mode == "acme"
|
res = requests.post(url)
|
||||||
res = requests.post(url, verify=verify)
|
|
||||||
assert maildomain in res.json().get("email")
|
assert maildomain in res.json().get("email")
|
||||||
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.filterwarnings("ignore::urllib3.exceptions.InsecureRequestWarning")
|
def test_newemail_configure(maildomain, rpc):
|
||||||
def test_newemail_configure(maildomain, maildomain_ip, rpc, chatmail_config):
|
|
||||||
"""Test configuring accounts by scanning a QR code works."""
|
"""Test configuring accounts by scanning a QR code works."""
|
||||||
url = f"DCACCOUNT:https://{maildomain}/new"
|
url = f"DCACCOUNT:https://{maildomain}/new"
|
||||||
for i in range(3):
|
for i in range(3):
|
||||||
account_id = rpc.add_account()
|
account_id = rpc.add_account()
|
||||||
if chatmail_config.tls_cert_mode == "self":
|
rpc.set_config_from_qr(account_id, url)
|
||||||
# deltachat core's rustls rejects self-signed HTTPS certs during
|
rpc.configure(account_id)
|
||||||
# set_config_from_qr, so fetch credentials via requests instead
|
|
||||||
res = requests.post(f"https://{maildomain}/new", verify=False)
|
|
||||||
data = res.json()
|
|
||||||
rpc.add_or_update_transport(
|
|
||||||
account_id,
|
|
||||||
{
|
|
||||||
"addr": data["email"],
|
|
||||||
"password": data["password"],
|
|
||||||
"imapServer": maildomain_ip,
|
|
||||||
"smtpServer": maildomain_ip,
|
|
||||||
"certificateChecks": "acceptInvalidCertificates",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
rpc.add_transport_from_qr(account_id, url)
|
|
||||||
|
|||||||
@@ -7,14 +7,13 @@ import time
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from cmdeploy import remote
|
from cmdeploy import remote
|
||||||
from cmdeploy.cmdeploy import get_sshexec
|
from cmdeploy.sshexec import SSHExec
|
||||||
|
|
||||||
|
|
||||||
class TestSSHExecutor:
|
class TestSSHExecutor:
|
||||||
@pytest.fixture(scope="class")
|
@pytest.fixture(scope="class")
|
||||||
def sshexec(self, sshdomain, pytestconfig):
|
def sshexec(self, sshdomain):
|
||||||
ssh_config = pytestconfig.getoption("ssh_config")
|
return SSHExec(sshdomain)
|
||||||
return get_sshexec(sshdomain, ssh_config=ssh_config)
|
|
||||||
|
|
||||||
def test_ls(self, sshexec):
|
def test_ls(self, sshexec):
|
||||||
out = sshexec(call=remote.rdns.shell, kwargs=dict(command="ls"))
|
out = sshexec(call=remote.rdns.shell, kwargs=dict(command="ls"))
|
||||||
@@ -28,7 +27,6 @@ class TestSSHExecutor:
|
|||||||
assert res["A"] or res["AAAA"]
|
assert res["A"] or res["AAAA"]
|
||||||
|
|
||||||
def test_logged(self, sshexec, maildomain, capsys):
|
def test_logged(self, sshexec, maildomain, capsys):
|
||||||
sshexec.verbose = False
|
|
||||||
sshexec.logged(
|
sshexec.logged(
|
||||||
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
||||||
)
|
)
|
||||||
@@ -54,8 +52,6 @@ class TestSSHExecutor:
|
|||||||
remote.rdns.perform_initial_checks,
|
remote.rdns.perform_initial_checks,
|
||||||
kwargs=dict(mail_domain=None),
|
kwargs=dict(mail_domain=None),
|
||||||
)
|
)
|
||||||
except AssertionError:
|
|
||||||
pass
|
|
||||||
except sshexec.FuncError as e:
|
except sshexec.FuncError as e:
|
||||||
assert "rdns.py" in str(e)
|
assert "rdns.py" in str(e)
|
||||||
assert "AssertionError" in str(e)
|
assert "AssertionError" in str(e)
|
||||||
@@ -87,8 +83,10 @@ def test_remote(remote, imap_or_smtp):
|
|||||||
|
|
||||||
|
|
||||||
def test_use_two_chatmailservers(cmfactory, maildomain2):
|
def test_use_two_chatmailservers(cmfactory, maildomain2):
|
||||||
ac1 = cmfactory.get_online_account()
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
ac2 = cmfactory.get_online_account(domain=maildomain2)
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
cmfactory.get_accepted_chat(ac1, ac2)
|
cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
domain1 = ac1.get_config("addr").split("@")[1]
|
domain1 = ac1.get_config("addr").split("@")[1]
|
||||||
domain2 = ac2.get_config("addr").split("@")[1]
|
domain2 = ac2.get_config("addr").split("@")[1]
|
||||||
@@ -133,10 +131,11 @@ def test_authenticated_from(cmsetup, maildata):
|
|||||||
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
||||||
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
||||||
domain = cmsetup.maildomain
|
domain = cmsetup.maildomain
|
||||||
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
sock.settimeout(10)
|
||||||
try:
|
try:
|
||||||
sock = socket.create_connection((domain, 25), timeout=10)
|
sock.connect((domain, 25))
|
||||||
sock.close()
|
except socket.timeout:
|
||||||
except (socket.timeout, OSError):
|
|
||||||
pytest.skip(f"port 25 not reachable for {domain}")
|
pytest.skip(f"port 25 not reachable for {domain}")
|
||||||
|
|
||||||
recipient = cmsetup.gen_users(1)[0]
|
recipient = cmsetup.gen_users(1)[0]
|
||||||
@@ -147,7 +146,7 @@ def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
|||||||
conn.starttls()
|
conn.starttls()
|
||||||
|
|
||||||
with conn as s:
|
with conn as s:
|
||||||
with pytest.raises(smtplib.SMTPDataError, match="No DKIM signature found"):
|
with pytest.raises(smtplib.SMTPDataError, match="No valid DKIM signature"):
|
||||||
s.sendmail(from_addr=from_addr, to_addrs=recipient.addr, msg=msg)
|
s.sendmail(from_addr=from_addr, to_addrs=recipient.addr, msg=msg)
|
||||||
|
|
||||||
|
|
||||||
@@ -219,7 +218,7 @@ def test_expunged(remote, chatmail_config):
|
|||||||
]
|
]
|
||||||
outdated_days = int(chatmail_config.delete_large_after) + 1
|
outdated_days = int(chatmail_config.delete_large_after) + 1
|
||||||
find_cmds.append(
|
find_cmds.append(
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/cur/*' -mtime +{outdated_days} -size +200k -type f"
|
"find {chatmail_config.mailboxes_dir} -path '*/cur/*' -mtime +{outdated_days} -size +200k -type f"
|
||||||
)
|
)
|
||||||
for cmd in find_cmds:
|
for cmd in find_cmds:
|
||||||
for line in remote.iter_output(cmd):
|
for line in remote.iter_output(cmd):
|
||||||
|
|||||||
@@ -6,17 +6,16 @@ import imap_tools
|
|||||||
import pytest
|
import pytest
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from cmdeploy.cmdeploy import get_sshexec
|
|
||||||
from cmdeploy.remote import rshell
|
from cmdeploy.remote import rshell
|
||||||
|
from cmdeploy.sshexec import SSHExec
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def imap_mailbox(cmfactory, ssl_context):
|
def imap_mailbox(cmfactory):
|
||||||
(ac1,) = cmfactory.get_online_accounts(1)
|
(ac1,) = cmfactory.get_online_accounts(1)
|
||||||
user = ac1.get_config("addr")
|
user = ac1.get_config("addr")
|
||||||
password = ac1.get_config("mail_pw")
|
password = ac1.get_config("mail_pw")
|
||||||
host = user.split("@")[1]
|
mailbox = imap_tools.MailBox(user.split("@")[1])
|
||||||
mailbox = imap_tools.MailBox(host, ssl_context=ssl_context)
|
|
||||||
mailbox.login(user, password)
|
mailbox.login(user, password)
|
||||||
mailbox.dc_ac = ac1
|
mailbox.dc_ac = ac1
|
||||||
return mailbox
|
return mailbox
|
||||||
@@ -27,7 +26,6 @@ class TestMetadataTokens:
|
|||||||
|
|
||||||
def test_set_get_metadata(self, imap_mailbox):
|
def test_set_get_metadata(self, imap_mailbox):
|
||||||
"set and get metadata token for an account"
|
"set and get metadata token for an account"
|
||||||
time.sleep(5) # make sure Metadata service had a chance to restart
|
|
||||||
client = imap_mailbox.client
|
client = imap_mailbox.client
|
||||||
client.send(b'a01 SETMETADATA INBOX (/private/devicetoken "1111" )\n')
|
client.send(b'a01 SETMETADATA INBOX (/private/devicetoken "1111" )\n')
|
||||||
res = client.readline()
|
res = client.readline()
|
||||||
@@ -63,11 +61,11 @@ class TestEndToEndDeltaChat:
|
|||||||
chat.send_text("message0")
|
chat.send_text("message0")
|
||||||
|
|
||||||
lp.sec("wait for ac2 to receive message")
|
lp.sec("wait for ac2 to receive message")
|
||||||
msg2 = ac2.wait_for_incoming_msg()
|
msg2 = ac2._evtracker.wait_next_incoming_message()
|
||||||
assert msg2.get_snapshot().text == "message0"
|
assert msg2.text == "message0"
|
||||||
|
|
||||||
def test_exceed_quota(
|
def test_exceed_quota(
|
||||||
self, cmfactory, lp, tmpdir, remote, chatmail_config, sshdomain, pytestconfig
|
self, cmfactory, lp, tmpdir, remote, chatmail_config, sshdomain
|
||||||
):
|
):
|
||||||
"""This is a very slow test as it needs to upload >100MB of mail data
|
"""This is a very slow test as it needs to upload >100MB of mail data
|
||||||
before quota is exceeded, and thus depends on the speed of the upload.
|
before quota is exceeded, and thus depends on the speed of the upload.
|
||||||
@@ -92,43 +90,45 @@ class TestEndToEndDeltaChat:
|
|||||||
lp.sec(f"filling remote inbox for {user}")
|
lp.sec(f"filling remote inbox for {user}")
|
||||||
fn = f"7743102289.M843172P2484002.c20,S={quota},W=2398:2,"
|
fn = f"7743102289.M843172P2484002.c20,S={quota},W=2398:2,"
|
||||||
path = chatmail_config.mailboxes_dir.joinpath(user, "cur", fn)
|
path = chatmail_config.mailboxes_dir.joinpath(user, "cur", fn)
|
||||||
sshexec = get_sshexec(
|
sshexec = SSHExec(sshdomain)
|
||||||
sshdomain, ssh_config=pytestconfig.getoption("ssh_config")
|
|
||||||
)
|
|
||||||
sshexec(call=rshell.write_numbytes, kwargs=dict(path=str(path), num=120))
|
sshexec(call=rshell.write_numbytes, kwargs=dict(path=str(path), num=120))
|
||||||
res = sshexec(call=rshell.dovecot_recalc_quota, kwargs=dict(user=user))
|
res = sshexec(call=rshell.dovecot_recalc_quota, kwargs=dict(user=user))
|
||||||
assert res["percent"] >= 100
|
assert res["percent"] >= 100
|
||||||
|
|
||||||
lp.sec("ac2: check quota is triggered")
|
lp.sec("ac2: check quota is triggered")
|
||||||
|
|
||||||
def send_hello():
|
starting = True
|
||||||
chat.send_text("hello")
|
for line in remote.iter_output("journalctl -n0 -f -u dovecot"):
|
||||||
|
if starting:
|
||||||
for line in remote.iter_output(
|
chat.send_text("hello")
|
||||||
"journalctl -n1 -f -u dovecot", ready=send_hello
|
starting = False
|
||||||
):
|
|
||||||
if user not in line:
|
if user not in line:
|
||||||
|
# print(line)
|
||||||
continue
|
continue
|
||||||
if "quota exceeded" in line:
|
if "quota exceeded" in line:
|
||||||
return
|
return
|
||||||
|
|
||||||
def test_securejoin(self, cmfactory, lp, maildomain2):
|
def test_securejoin(self, cmfactory, lp, maildomain2):
|
||||||
ac1 = cmfactory.get_online_account()
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
ac2 = cmfactory.get_online_account(domain=maildomain2)
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
|
|
||||||
lp.sec("ac1: create QR code and let ac2 scan it, starting the securejoin")
|
lp.sec("ac1: create QR code and let ac2 scan it, starting the securejoin")
|
||||||
qr = ac1.get_qr_code()
|
qr = ac1.get_setup_contact_qr()
|
||||||
|
|
||||||
lp.sec("ac2: start QR-code based setup contact protocol")
|
lp.sec("ac2: start QR-code based setup contact protocol")
|
||||||
ch = ac2.secure_join(qr)
|
ch = ac2.qr_setup_contact(qr)
|
||||||
assert ch.id >= 10
|
assert ch.id >= 10
|
||||||
ac1.wait_for_securejoin_inviter_success()
|
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
||||||
|
|
||||||
def test_dkim_header_stripped(self, cmfactory, maildomain2, lp, imap_mailbox):
|
def test_dkim_header_stripped(self, cmfactory, maildomain2, lp, imap_mailbox):
|
||||||
"""Test that if a DC address receives a message, it has no
|
"""Test that if a DC address receives a message, it has no
|
||||||
DKIM-Signature and Authentication-Results headers."""
|
DKIM-Signature and Authentication-Results headers."""
|
||||||
ac1 = cmfactory.get_online_account()
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
ac2 = cmfactory.get_online_account(domain=maildomain2)
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
chat = cmfactory.get_accepted_chat(ac1, imap_mailbox.dc_ac)
|
chat = cmfactory.get_accepted_chat(ac1, imap_mailbox.dc_ac)
|
||||||
chat.send_text("message0")
|
chat.send_text("message0")
|
||||||
chat2 = cmfactory.get_accepted_chat(ac2, imap_mailbox.dc_ac)
|
chat2 = cmfactory.get_accepted_chat(ac2, imap_mailbox.dc_ac)
|
||||||
@@ -145,32 +145,33 @@ class TestEndToEndDeltaChat:
|
|||||||
assert "dkim-signature" not in msg.headers
|
assert "dkim-signature" not in msg.headers
|
||||||
|
|
||||||
def test_read_receipts_between_instances(self, cmfactory, lp, maildomain2):
|
def test_read_receipts_between_instances(self, cmfactory, lp, maildomain2):
|
||||||
ac1 = cmfactory.get_online_account()
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
ac2 = cmfactory.get_online_account(domain=maildomain2)
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
|
|
||||||
lp.sec("setup encrypted comms between ac1 and ac2 on different instances")
|
lp.sec("setup encrypted comms between ac1 and ac2 on different instances")
|
||||||
qr = ac1.get_qr_code()
|
qr = ac1.get_setup_contact_qr()
|
||||||
ch = ac2.secure_join(qr)
|
ch = ac2.qr_setup_contact(qr)
|
||||||
assert ch.id >= 10
|
assert ch.id >= 10
|
||||||
ac1.wait_for_securejoin_inviter_success()
|
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
||||||
|
|
||||||
lp.sec("ac1 sends a message and ac2 marks it as seen")
|
lp.sec("ac1 sends a message and ac2 marks it as seen")
|
||||||
chat = ac1.create_chat(ac2)
|
chat = ac1.create_chat(ac2)
|
||||||
msg = chat.send_text("hi")
|
msg = chat.send_text("hi")
|
||||||
m = ac2.wait_for_incoming_msg()
|
m = ac2._evtracker.wait_next_incoming_message()
|
||||||
m.mark_seen()
|
m.mark_seen()
|
||||||
# we can only indirectly wait for mark-seen to cause an smtp-error
|
# we can only indirectly wait for mark-seen to cause an smtp-error
|
||||||
lp.sec("try to wait for markseen to complete and check error states")
|
lp.sec("try to wait for markseen to complete and check error states")
|
||||||
deadline = time.time() + 3.1
|
deadline = time.time() + 3.1
|
||||||
while time.time() < deadline:
|
while time.time() < deadline:
|
||||||
m_snap = m.get_snapshot()
|
msgs = m.chat.get_messages()
|
||||||
msgs = m_snap.chat.get_messages()
|
|
||||||
for msg in msgs:
|
for msg in msgs:
|
||||||
assert "error" not in m.get_info()
|
assert "error" not in m.get_message_info()
|
||||||
time.sleep(1)
|
time.sleep(1)
|
||||||
|
|
||||||
|
|
||||||
def test_hide_senders_ip_address(cmfactory, ssl_context):
|
def test_hide_senders_ip_address(cmfactory):
|
||||||
public_ip = requests.get("http://icanhazip.com").content.decode().strip()
|
public_ip = requests.get("http://icanhazip.com").content.decode().strip()
|
||||||
assert ipaddress.ip_address(public_ip)
|
assert ipaddress.ip_address(public_ip)
|
||||||
|
|
||||||
@@ -178,12 +179,7 @@ def test_hide_senders_ip_address(cmfactory, ssl_context):
|
|||||||
chat = cmfactory.get_accepted_chat(user1, user2)
|
chat = cmfactory.get_accepted_chat(user1, user2)
|
||||||
|
|
||||||
chat.send_text("testing submission header cleanup")
|
chat.send_text("testing submission header cleanup")
|
||||||
user2.wait_for_incoming_msg()
|
user2._evtracker.wait_next_incoming_message()
|
||||||
addr = user2.get_config("addr")
|
user2.direct_imap.select_folder("Inbox")
|
||||||
host = addr.split("@")[1]
|
msg = user2.direct_imap.get_all_messages()[0]
|
||||||
pw = user2.get_config("mail_pw")
|
assert public_ip not in msg.obj.as_string()
|
||||||
mailbox = imap_tools.MailBox(host, ssl_context=ssl_context)
|
|
||||||
mailbox.login(addr, pw)
|
|
||||||
msgs = list(mailbox.fetch(mark_seen=False))
|
|
||||||
assert msgs, "expected at least one message"
|
|
||||||
assert public_ip not in msgs[0].obj.as_string()
|
|
||||||
|
|||||||
@@ -3,16 +3,9 @@ import os
|
|||||||
from cmdeploy.cmdeploy import main
|
from cmdeploy.cmdeploy import main
|
||||||
|
|
||||||
|
|
||||||
def test_status_cmd(chatmail_config, capsys, request, pytestconfig):
|
def test_status_cmd(chatmail_config, capsys, request):
|
||||||
os.chdir(request.config.invocation_params.dir)
|
os.chdir(request.config.invocation_params.dir)
|
||||||
command = ["status"]
|
assert main(["status"]) == 0
|
||||||
ssh_host = pytestconfig.getoption("ssh_host")
|
|
||||||
if ssh_host:
|
|
||||||
command.extend(["--ssh-host", ssh_host])
|
|
||||||
ssh_config = pytestconfig.getoption("ssh_config")
|
|
||||||
if ssh_config:
|
|
||||||
command.extend(["--ssh-config", ssh_config])
|
|
||||||
assert main(command) == 0
|
|
||||||
status_out = capsys.readouterr()
|
status_out = capsys.readouterr()
|
||||||
print(status_out.out)
|
print(status_out.out)
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,9 @@
|
|||||||
import imaplib
|
import imaplib
|
||||||
|
import io
|
||||||
import itertools
|
import itertools
|
||||||
import os
|
import os
|
||||||
import random
|
import random
|
||||||
import re
|
|
||||||
import smtplib
|
import smtplib
|
||||||
import socket
|
|
||||||
import ssl
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import time
|
import time
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -20,76 +18,6 @@ def pytest_addoption(parser):
|
|||||||
parser.addoption(
|
parser.addoption(
|
||||||
"--slow", action="store_true", default=False, help="also run slow tests"
|
"--slow", action="store_true", default=False, help="also run slow tests"
|
||||||
)
|
)
|
||||||
parser.addoption(
|
|
||||||
"--ssh-host",
|
|
||||||
dest="ssh_host",
|
|
||||||
default=None,
|
|
||||||
help="SSH host (overrides mail_domain for SSH operations).",
|
|
||||||
)
|
|
||||||
parser.addoption(
|
|
||||||
"--ssh-config",
|
|
||||||
dest="ssh_config",
|
|
||||||
default=None,
|
|
||||||
help="Path to an SSH config file (e.g. lxconfigs/ssh-config).",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _parse_ssh_config_hosts(path):
|
|
||||||
"""Parse an OpenSSH config file and return a dict of hostname -> IP."""
|
|
||||||
mapping = {}
|
|
||||||
current_names = []
|
|
||||||
for ln in Path(path).read_text().splitlines():
|
|
||||||
line = ln.strip()
|
|
||||||
m = re.match(r"^Host\s+(.+)", line)
|
|
||||||
if m:
|
|
||||||
current_names = m.group(1).split()
|
|
||||||
continue
|
|
||||||
m = re.match(r"^Hostname\s+(\S+)", line)
|
|
||||||
if m and current_names:
|
|
||||||
ip = m.group(1)
|
|
||||||
for name in current_names:
|
|
||||||
mapping[name] = ip
|
|
||||||
current_names = []
|
|
||||||
return mapping
|
|
||||||
|
|
||||||
|
|
||||||
_original_getaddrinfo = socket.getaddrinfo
|
|
||||||
|
|
||||||
|
|
||||||
def _make_patched_getaddrinfo(host_map):
|
|
||||||
"""Return a getaddrinfo that resolves hosts in host_map to their IPs."""
|
|
||||||
|
|
||||||
def patched_getaddrinfo(host, port, family=0, type=0, proto=0, flags=0):
|
|
||||||
if host in host_map:
|
|
||||||
ip = host_map[host]
|
|
||||||
return _original_getaddrinfo(ip, port, family, type, proto, flags)
|
|
||||||
return _original_getaddrinfo(host, port, family, type, proto, flags)
|
|
||||||
|
|
||||||
return patched_getaddrinfo
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True, scope="session")
|
|
||||||
def _setup_localchat_dns(pytestconfig):
|
|
||||||
"""Monkey-patch socket.getaddrinfo to resolve .localchat via ssh-config."""
|
|
||||||
ssh_config = pytestconfig.getoption("ssh_config")
|
|
||||||
if not ssh_config or not Path(ssh_config).exists():
|
|
||||||
yield {}
|
|
||||||
return
|
|
||||||
host_map = _parse_ssh_config_hosts(ssh_config)
|
|
||||||
if not host_map:
|
|
||||||
yield {}
|
|
||||||
return
|
|
||||||
socket.getaddrinfo = _make_patched_getaddrinfo(host_map)
|
|
||||||
try:
|
|
||||||
yield host_map
|
|
||||||
finally:
|
|
||||||
socket.getaddrinfo = _original_getaddrinfo
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def ssh_config_host_map(_setup_localchat_dns):
|
|
||||||
"""Return the host-name → IP map parsed from ssh-config."""
|
|
||||||
return _setup_localchat_dns
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_configure(config):
|
def pytest_configure(config):
|
||||||
@@ -106,29 +34,17 @@ def pytest_runtest_setup(item):
|
|||||||
pytest.skip("skipping slow test, use --slow to run")
|
pytest.skip("skipping slow test, use --slow to run")
|
||||||
|
|
||||||
|
|
||||||
def _get_chatmail_config():
|
@pytest.fixture(scope="session")
|
||||||
ini = os.environ.get("CHATMAIL_INI")
|
def chatmail_config(pytestconfig):
|
||||||
if ini:
|
current = basedir = Path().resolve()
|
||||||
path = Path(ini).resolve()
|
|
||||||
if path.exists():
|
|
||||||
return read_config(path), path
|
|
||||||
current = Path().resolve()
|
|
||||||
while 1:
|
while 1:
|
||||||
path = current.joinpath("chatmail.ini").resolve()
|
path = current.joinpath("chatmail.ini").resolve()
|
||||||
if path.exists():
|
if path.exists():
|
||||||
return read_config(path), path
|
return read_config(path)
|
||||||
if current == current.parent:
|
if current == current.parent:
|
||||||
break
|
break
|
||||||
current = current.parent
|
current = current.parent
|
||||||
return None, None
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def chatmail_config(pytestconfig):
|
|
||||||
config, path = _get_chatmail_config()
|
|
||||||
if config:
|
|
||||||
return config
|
|
||||||
basedir = Path().resolve()
|
|
||||||
pytest.skip(f"no chatmail.ini file found in {basedir} or parent dirs")
|
pytest.skip(f"no chatmail.ini file found in {basedir} or parent dirs")
|
||||||
|
|
||||||
|
|
||||||
@@ -138,14 +54,8 @@ def maildomain(chatmail_config):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
@pytest.fixture(scope="session")
|
||||||
def sshdomain(maildomain, pytestconfig):
|
def sshdomain(maildomain):
|
||||||
return pytestconfig.getoption("ssh_host") or maildomain
|
return os.environ.get("CHATMAIL_SSH", maildomain)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def maildomain_ip(maildomain, ssh_config_host_map):
|
|
||||||
"""Return the IP for maildomain from ssh-config, or maildomain itself."""
|
|
||||||
return ssh_config_host_map.get(maildomain, maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -162,17 +72,10 @@ def sshdomain2(maildomain2):
|
|||||||
|
|
||||||
|
|
||||||
def pytest_report_header():
|
def pytest_report_header():
|
||||||
config, path = _get_chatmail_config()
|
domain = os.environ.get("CHATMAIL_DOMAIN")
|
||||||
domain2 = os.environ.get("CHATMAIL_DOMAIN2", "NOT SET")
|
if domain:
|
||||||
domain = config.mail_domain if config else "NOT SET"
|
text = f"chatmail test instance: {domain}"
|
||||||
path = path if path else "NOT SET"
|
return ["-" * len(text), text, "-" * len(text)]
|
||||||
|
|
||||||
lines = [
|
|
||||||
f"chatmail.ini {domain} location: {path}",
|
|
||||||
f"chatmail2: {domain2}",
|
|
||||||
]
|
|
||||||
sep = "-" * max(map(len, lines))
|
|
||||||
return [sep, *lines, sep]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -187,22 +90,15 @@ def cm_data(request):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def benchmark(request, chatmail_config):
|
def benchmark(request):
|
||||||
def bench(func, num, name=None, reportfunc=None, cooldown=0.0):
|
def bench(func, num, name=None, reportfunc=None):
|
||||||
if name is None:
|
if name is None:
|
||||||
name = func.__name__
|
name = func.__name__
|
||||||
if cooldown == "auto":
|
|
||||||
per_minute = max(chatmail_config.max_user_send_per_minute, 1)
|
|
||||||
cooldown = chatmail_config.max_user_send_burst_size * 60 / per_minute
|
|
||||||
|
|
||||||
durations = []
|
durations = []
|
||||||
for i in range(num):
|
for i in range(num):
|
||||||
now = time.time()
|
now = time.time()
|
||||||
func()
|
func()
|
||||||
durations.append(time.time() - now)
|
durations.append(time.time() - now)
|
||||||
if cooldown > 0 and i + 1 < num:
|
|
||||||
# Keep post-run cooldown out of measured benchmark duration.
|
|
||||||
time.sleep(cooldown)
|
|
||||||
durations.sort()
|
durations.sort()
|
||||||
request.config._benchresults[name] = (reportfunc, durations)
|
request.config._benchresults[name] = (reportfunc, durations)
|
||||||
|
|
||||||
@@ -248,25 +144,15 @@ def pytest_terminal_summary(terminalreporter):
|
|||||||
tr.write_line(line)
|
tr.write_line(line)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
@pytest.fixture
|
||||||
def ssl_context(chatmail_config):
|
def imap(maildomain):
|
||||||
if chatmail_config.tls_cert_mode == "self":
|
return ImapConn(maildomain)
|
||||||
ctx = ssl.create_default_context()
|
|
||||||
ctx.check_hostname = False
|
|
||||||
ctx.verify_mode = ssl.CERT_NONE
|
|
||||||
return ctx
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def imap(maildomain, ssl_context):
|
def make_imap_connection(maildomain):
|
||||||
return ImapConn(maildomain, ssl_context=ssl_context)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def make_imap_connection(maildomain, ssl_context):
|
|
||||||
def make_imap_connection():
|
def make_imap_connection():
|
||||||
conn = ImapConn(maildomain, ssl_context=ssl_context)
|
conn = ImapConn(maildomain)
|
||||||
conn.connect()
|
conn.connect()
|
||||||
return conn
|
return conn
|
||||||
|
|
||||||
@@ -278,13 +164,12 @@ class ImapConn:
|
|||||||
logcmd = "journalctl -f -u dovecot"
|
logcmd = "journalctl -f -u dovecot"
|
||||||
name = "dovecot"
|
name = "dovecot"
|
||||||
|
|
||||||
def __init__(self, host, ssl_context=None):
|
def __init__(self, host):
|
||||||
self.host = host
|
self.host = host
|
||||||
self.ssl_context = ssl_context
|
|
||||||
|
|
||||||
def connect(self):
|
def connect(self):
|
||||||
print(f"imap-connect {self.host}")
|
print(f"imap-connect {self.host}")
|
||||||
self.conn = imaplib.IMAP4_SSL(self.host, ssl_context=self.ssl_context)
|
self.conn = imaplib.IMAP4_SSL(self.host)
|
||||||
|
|
||||||
def login(self, user, password):
|
def login(self, user, password):
|
||||||
print(f"imap-login {user!r} {password!r}")
|
print(f"imap-login {user!r} {password!r}")
|
||||||
@@ -310,14 +195,14 @@ class ImapConn:
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def smtp(maildomain, ssl_context):
|
def smtp(maildomain):
|
||||||
return SmtpConn(maildomain, ssl_context=ssl_context)
|
return SmtpConn(maildomain)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def make_smtp_connection(maildomain, ssl_context):
|
def make_smtp_connection(maildomain):
|
||||||
def make_smtp_connection():
|
def make_smtp_connection():
|
||||||
conn = SmtpConn(maildomain, ssl_context=ssl_context)
|
conn = SmtpConn(maildomain)
|
||||||
conn.connect()
|
conn.connect()
|
||||||
return conn
|
return conn
|
||||||
|
|
||||||
@@ -329,14 +214,12 @@ class SmtpConn:
|
|||||||
logcmd = "journalctl -f -t postfix/smtpd -t postfix/smtp -t postfix/lmtp"
|
logcmd = "journalctl -f -t postfix/smtpd -t postfix/smtp -t postfix/lmtp"
|
||||||
name = "postfix"
|
name = "postfix"
|
||||||
|
|
||||||
def __init__(self, host, ssl_context=None):
|
def __init__(self, host):
|
||||||
self.host = host
|
self.host = host
|
||||||
self.ssl_context = ssl_context
|
|
||||||
|
|
||||||
def connect(self):
|
def connect(self):
|
||||||
print(f"smtp-connect {self.host}")
|
print(f"smtp-connect {self.host}")
|
||||||
context = self.ssl_context or ssl.create_default_context()
|
self.conn = smtplib.SMTP_SSL(self.host)
|
||||||
self.conn = smtplib.SMTP_SSL(self.host, context=context)
|
|
||||||
|
|
||||||
def login(self, user, password):
|
def login(self, user, password):
|
||||||
print(f"smtp-login {user!r} {password!r}")
|
print(f"smtp-login {user!r} {password!r}")
|
||||||
@@ -379,161 +262,92 @@ def gencreds(chatmail_config):
|
|||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Delta Chat RPC-based test support
|
# Delta Chat testplugin re-use
|
||||||
# use the cmfactory fixture to get chatmail instance accounts
|
# use the cmfactory fixture to get chatmail instance accounts
|
||||||
#
|
#
|
||||||
|
|
||||||
from deltachat_rpc_client import DeltaChat, Rpc
|
|
||||||
|
|
||||||
|
class ChatmailTestProcess:
|
||||||
|
"""Provider for chatmail instance accounts as used by deltachat.testplugin.acfactory"""
|
||||||
|
|
||||||
class ChatmailACFactory:
|
def __init__(self, pytestconfig, maildomain, gencreds):
|
||||||
"""RPC-based account factory for chatmail testing."""
|
self.pytestconfig = pytestconfig
|
||||||
|
self.maildomain = maildomain
|
||||||
def __init__(
|
assert "." in self.maildomain, maildomain
|
||||||
self,
|
|
||||||
rpc,
|
|
||||||
maildomain,
|
|
||||||
maildomain_ip,
|
|
||||||
gencreds,
|
|
||||||
chatmail_config,
|
|
||||||
ssh_config_host_map,
|
|
||||||
):
|
|
||||||
self.dc = DeltaChat(rpc)
|
|
||||||
self.rpc = rpc
|
|
||||||
self._maildomain = maildomain
|
|
||||||
self._maildomain_ip = maildomain_ip
|
|
||||||
self.gencreds = gencreds
|
self.gencreds = gencreds
|
||||||
self.chatmail_config = chatmail_config
|
self._addr2files = {}
|
||||||
self._ssh_config_host_map = ssh_config_host_map
|
|
||||||
|
|
||||||
def _make_transport(self, domain):
|
def get_liveconfig_producer(self):
|
||||||
"""Build a transport config dict for the given domain."""
|
while 1:
|
||||||
addr, password = self.gencreds(domain)
|
user, password = self.gencreds(self.maildomain)
|
||||||
transport = {
|
config = {
|
||||||
"addr": addr,
|
"addr": user,
|
||||||
"password": password,
|
"mail_pw": password,
|
||||||
}
|
}
|
||||||
# To support running against local relays without host DNS resolution
|
# speed up account configuration
|
||||||
# we attempt resolving the domain via ssh-config
|
config["mail_server"] = self.maildomain
|
||||||
# because otherwise core fails to find the address
|
config["send_server"] = self.maildomain
|
||||||
server = self._ssh_config_host_map.get(domain)
|
yield config
|
||||||
if server is not None:
|
|
||||||
transport.update({"imapServer": server, "smtpServer": server})
|
|
||||||
if self.chatmail_config.tls_cert_mode == "self":
|
|
||||||
transport["certificateChecks"] = "acceptInvalidCertificates"
|
|
||||||
return transport
|
|
||||||
|
|
||||||
def get_online_account(self, domain=None):
|
def cache_maybe_retrieve_configured_db_files(self, cache_addr, db_target_path):
|
||||||
"""Create, configure and bring online a single account."""
|
pass
|
||||||
return self.get_online_accounts(1, domain)[0]
|
|
||||||
|
|
||||||
def get_online_accounts(self, num, domain=None):
|
def cache_maybe_store_configured_db_files(self, acc):
|
||||||
"""Create multiple online accounts in parallel."""
|
pass
|
||||||
domain = domain or self._maildomain
|
|
||||||
futures = []
|
|
||||||
accounts = []
|
|
||||||
for _ in range(num):
|
|
||||||
account = self.dc.add_account()
|
|
||||||
future = account.add_or_update_transport.future(
|
|
||||||
self._make_transport(domain)
|
|
||||||
)
|
|
||||||
futures.append(future)
|
|
||||||
|
|
||||||
# ensure messages stay in INBOX so that they can be
|
|
||||||
# concurrently fetched via extra IMAP connections during tests
|
|
||||||
account.set_config("delete_server_after", "10")
|
|
||||||
accounts.append(account)
|
|
||||||
|
|
||||||
for future in futures:
|
|
||||||
future()
|
|
||||||
|
|
||||||
for account in accounts:
|
|
||||||
account.bring_online()
|
|
||||||
return accounts
|
|
||||||
|
|
||||||
def get_accepted_chat(self, ac1, ac2):
|
|
||||||
"""Create a 1:1 chat between ac1 and ac2 accepted on both sides."""
|
|
||||||
ac2.create_chat(ac1)
|
|
||||||
return ac1.create_chat(ac2)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def rpc(tmp_path_factory):
|
|
||||||
"""Start a deltachat-rpc-server process for the test session."""
|
|
||||||
|
|
||||||
# NB: accounts_dir must NOT already exist as directory --
|
|
||||||
# core-rust only creates accounts.toml if the dir doesn't exist yet.
|
|
||||||
accounts_dir = str(tmp_path_factory.mktemp("dc") / "accounts")
|
|
||||||
rpc = Rpc(accounts_dir=accounts_dir)
|
|
||||||
rpc.start()
|
|
||||||
yield rpc
|
|
||||||
rpc.close()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def cmfactory(
|
def cmfactory(request, gencreds, tmpdir, maildomain):
|
||||||
rpc, gencreds, maildomain, maildomain_ip, chatmail_config, ssh_config_host_map
|
# cloned from deltachat.testplugin.amfactory
|
||||||
):
|
pytest.importorskip("deltachat")
|
||||||
"""Return a ChatmailACFactory for creating online Delta Chat accounts."""
|
from deltachat.testplugin import ACFactory
|
||||||
return ChatmailACFactory(
|
|
||||||
rpc=rpc,
|
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
||||||
maildomain=maildomain,
|
|
||||||
maildomain_ip=maildomain_ip,
|
class Data:
|
||||||
gencreds=gencreds,
|
def read_path(self, path):
|
||||||
chatmail_config=chatmail_config,
|
return
|
||||||
ssh_config_host_map=ssh_config_host_map,
|
|
||||||
)
|
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=Data())
|
||||||
|
|
||||||
|
# nb. a bit hacky
|
||||||
|
# would probably be better if deltachat's test machinery grows native support
|
||||||
|
def switch_maildomain(maildomain2):
|
||||||
|
am.testprocess.maildomain = maildomain2
|
||||||
|
|
||||||
|
am.switch_maildomain = switch_maildomain
|
||||||
|
|
||||||
|
yield am
|
||||||
|
if hasattr(request.node, "rep_call") and request.node.rep_call.failed:
|
||||||
|
if testproc.pytestconfig.getoption("--extra-info"):
|
||||||
|
logfile = io.StringIO()
|
||||||
|
am.dump_imap_summary(logfile=logfile)
|
||||||
|
print(logfile.getvalue())
|
||||||
|
# request.node.add_report_section("call", "imap-server-state", s)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def remote(sshdomain, pytestconfig):
|
def remote(sshdomain):
|
||||||
r = Remote(sshdomain, ssh_config=pytestconfig.getoption("ssh_config"))
|
return Remote(sshdomain)
|
||||||
yield r
|
|
||||||
r.close()
|
|
||||||
|
|
||||||
|
|
||||||
class Remote:
|
class Remote:
|
||||||
def __init__(self, sshdomain, ssh_config=None):
|
def __init__(self, sshdomain):
|
||||||
self.sshdomain = sshdomain
|
self.sshdomain = sshdomain
|
||||||
self.ssh_config = ssh_config
|
|
||||||
self._procs = []
|
|
||||||
|
|
||||||
def iter_output(self, logcmd="", ready=None):
|
def iter_output(self, logcmd=""):
|
||||||
getjournal = "journalctl -f" if not logcmd else logcmd
|
getjournal = "journalctl -f" if not logcmd else logcmd
|
||||||
print(self.sshdomain)
|
self.popen = subprocess.Popen(
|
||||||
match self.sshdomain:
|
["ssh", f"root@{self.sshdomain}", getjournal],
|
||||||
case "@local":
|
|
||||||
command = []
|
|
||||||
case "localhost":
|
|
||||||
command = []
|
|
||||||
case _:
|
|
||||||
command = ["ssh"]
|
|
||||||
if self.ssh_config:
|
|
||||||
command.extend(["-F", self.ssh_config])
|
|
||||||
command.append(f"root@{self.sshdomain}")
|
|
||||||
[command.append(arg) for arg in getjournal.split()]
|
|
||||||
popen = subprocess.Popen(
|
|
||||||
command,
|
|
||||||
stdin=subprocess.DEVNULL,
|
|
||||||
stdout=subprocess.PIPE,
|
stdout=subprocess.PIPE,
|
||||||
stderr=subprocess.DEVNULL,
|
|
||||||
)
|
)
|
||||||
self._procs.append(popen)
|
|
||||||
while 1:
|
while 1:
|
||||||
line = popen.stdout.readline()
|
line = self.popen.stdout.readline()
|
||||||
res = line.decode().strip().lower()
|
res = line.decode().strip().lower()
|
||||||
if not res:
|
if res:
|
||||||
|
yield res
|
||||||
|
else:
|
||||||
break
|
break
|
||||||
if ready is not None:
|
|
||||||
ready()
|
|
||||||
ready = None
|
|
||||||
yield res
|
|
||||||
|
|
||||||
def close(self):
|
|
||||||
while self._procs:
|
|
||||||
proc = self._procs.pop()
|
|
||||||
proc.kill()
|
|
||||||
proc.wait()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -549,40 +363,38 @@ def lp(request):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def cmsetup(maildomain, gencreds, ssl_context):
|
def cmsetup(maildomain, gencreds):
|
||||||
return CMSetup(maildomain, gencreds, ssl_context)
|
return CMSetup(maildomain, gencreds)
|
||||||
|
|
||||||
|
|
||||||
class CMSetup:
|
class CMSetup:
|
||||||
def __init__(self, maildomain, gencreds, ssl_context):
|
def __init__(self, maildomain, gencreds):
|
||||||
self.maildomain = maildomain
|
self.maildomain = maildomain
|
||||||
self.gencreds = gencreds
|
self.gencreds = gencreds
|
||||||
self.ssl_context = ssl_context
|
|
||||||
|
|
||||||
def gen_users(self, num):
|
def gen_users(self, num):
|
||||||
print(f"Creating {num} online users")
|
print(f"Creating {num} online users")
|
||||||
users = []
|
users = []
|
||||||
for i in range(num):
|
for i in range(num):
|
||||||
addr, password = self.gencreds()
|
addr, password = self.gencreds()
|
||||||
user = CMUser(self.maildomain, addr, password, self.ssl_context)
|
user = CMUser(self.maildomain, addr, password)
|
||||||
assert user.smtp
|
assert user.smtp
|
||||||
users.append(user)
|
users.append(user)
|
||||||
return users
|
return users
|
||||||
|
|
||||||
|
|
||||||
class CMUser:
|
class CMUser:
|
||||||
def __init__(self, maildomain, addr, password, ssl_context=None):
|
def __init__(self, maildomain, addr, password):
|
||||||
self.maildomain = maildomain
|
self.maildomain = maildomain
|
||||||
self.addr = addr
|
self.addr = addr
|
||||||
self.password = password
|
self.password = password
|
||||||
self.ssl_context = ssl_context
|
|
||||||
self._smtp = None
|
self._smtp = None
|
||||||
self._imap = None
|
self._imap = None
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def smtp(self):
|
def smtp(self):
|
||||||
if not self._smtp:
|
if not self._smtp:
|
||||||
handle = SmtpConn(self.maildomain, ssl_context=self.ssl_context)
|
handle = SmtpConn(self.maildomain)
|
||||||
handle.connect()
|
handle.connect()
|
||||||
handle.login(self.addr, self.password)
|
handle.login(self.addr, self.password)
|
||||||
self._smtp = handle
|
self._smtp = handle
|
||||||
@@ -591,7 +403,7 @@ class CMUser:
|
|||||||
@property
|
@property
|
||||||
def imap(self):
|
def imap(self):
|
||||||
if not self._imap:
|
if not self._imap:
|
||||||
imap = ImapConn(self.maildomain, ssl_context=self.ssl_context)
|
imap = ImapConn(self.maildomain)
|
||||||
imap.connect()
|
imap.connect()
|
||||||
imap.login(self.addr, self.password)
|
imap.login(self.addr, self.password)
|
||||||
self._imap = imap
|
self._imap = imap
|
||||||
|
|||||||
@@ -23,10 +23,7 @@ class TestCmdline:
|
|||||||
run = parser.parse_args(["run"])
|
run = parser.parse_args(["run"])
|
||||||
assert init and run
|
assert init and run
|
||||||
|
|
||||||
def test_init_not_overwrite(self, tmp_path, capsys, monkeypatch):
|
def test_init_not_overwrite(self, capsys):
|
||||||
monkeypatch.delenv("CHATMAIL_INI", raising=False)
|
|
||||||
monkeypatch.chdir(tmp_path)
|
|
||||||
|
|
||||||
assert main(["init", "chat.example.org"]) == 0
|
assert main(["init", "chat.example.org"]) == 0
|
||||||
capsys.readouterr()
|
capsys.readouterr()
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ from copy import deepcopy
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from cmdeploy import remote
|
from cmdeploy import remote
|
||||||
from cmdeploy.dns import check_full_zone, check_initial_remote_data, parse_zone_records
|
from cmdeploy.dns import check_full_zone, check_initial_remote_data
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -114,44 +114,19 @@ class TestPerformInitialChecks:
|
|||||||
assert not res
|
assert not res
|
||||||
assert len(l) == 2
|
assert len(l) == 2
|
||||||
|
|
||||||
def test_perform_initial_checks_no_mta_sts_self_signed(self, mockdns):
|
|
||||||
del mockdns["CNAME"]["mta-sts.some.domain"]
|
|
||||||
remote_data = remote.rdns.perform_initial_checks("some.domain")
|
|
||||||
assert not remote_data["MTA_STS"]
|
|
||||||
|
|
||||||
l = []
|
|
||||||
res = check_initial_remote_data(remote_data, strict_tls=False, print=l.append)
|
|
||||||
assert res
|
|
||||||
assert not l
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_zone_records():
|
|
||||||
text = """
|
|
||||||
; This is a comment
|
|
||||||
some.domain. 3600 IN A 1.1.1.1
|
|
||||||
|
|
||||||
; Another comment
|
|
||||||
www.some.domain. 3600 IN CNAME some.domain.
|
|
||||||
"""
|
|
||||||
records = list(parse_zone_records(text))
|
|
||||||
assert records == [
|
|
||||||
("some.domain", "3600", "A", "1.1.1.1"),
|
|
||||||
("www.some.domain", "3600", "CNAME", "some.domain."),
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_zone_records_invalid_line():
|
|
||||||
text = "invalid line"
|
|
||||||
with pytest.raises(ValueError, match="Bad zone record line"):
|
|
||||||
list(parse_zone_records(text))
|
|
||||||
|
|
||||||
|
|
||||||
def parse_zonefile_into_dict(zonefile, mockdns_base, only_required=False):
|
def parse_zonefile_into_dict(zonefile, mockdns_base, only_required=False):
|
||||||
if only_required:
|
for zf_line in zonefile.split("\n"):
|
||||||
# Only take records before the "; Recommended" section
|
if zf_line.startswith("#"):
|
||||||
zonefile = zonefile.split("; Recommended")[0]
|
if "Recommended" in zf_line and only_required:
|
||||||
for name, ttl, rtype, rdata in parse_zone_records(zonefile):
|
return
|
||||||
mockdns_base.setdefault(rtype, {})[name] = rdata
|
continue
|
||||||
|
if not zf_line.strip():
|
||||||
|
continue
|
||||||
|
zf_domain, zf_typ, zf_value = zf_line.split(maxsplit=2)
|
||||||
|
zf_domain = zf_domain.rstrip(".")
|
||||||
|
zf_value = zf_value.strip()
|
||||||
|
mockdns_base.setdefault(zf_typ, {})[zf_domain] = zf_value
|
||||||
|
|
||||||
|
|
||||||
class MockSSHExec:
|
class MockSSHExec:
|
||||||
|
|||||||
@@ -1,78 +0,0 @@
|
|||||||
"""Functional tests for tls_external_cert_and_key option."""
|
|
||||||
|
|
||||||
import json
|
|
||||||
|
|
||||||
import chatmaild.newemail
|
|
||||||
import pytest
|
|
||||||
from chatmaild.config import read_config, write_initial_config
|
|
||||||
|
|
||||||
|
|
||||||
def make_external_config(tmp_path, cert_key=None):
|
|
||||||
inipath = tmp_path / "chatmail.ini"
|
|
||||||
overrides = {}
|
|
||||||
if cert_key is not None:
|
|
||||||
overrides["tls_external_cert_and_key"] = cert_key
|
|
||||||
write_initial_config(inipath, "chat.example.org", overrides=overrides)
|
|
||||||
return inipath
|
|
||||||
|
|
||||||
|
|
||||||
def test_external_tls_config_reads_paths(tmp_path):
|
|
||||||
inipath = make_external_config(
|
|
||||||
tmp_path,
|
|
||||||
cert_key=(
|
|
||||||
"/etc/letsencrypt/live/chat.example.org/fullchain.pem"
|
|
||||||
" /etc/letsencrypt/live/chat.example.org/privkey.pem"
|
|
||||||
),
|
|
||||||
)
|
|
||||||
config = read_config(inipath)
|
|
||||||
assert config.tls_cert_mode == "external"
|
|
||||||
assert (
|
|
||||||
config.tls_cert_path == "/etc/letsencrypt/live/chat.example.org/fullchain.pem"
|
|
||||||
)
|
|
||||||
assert config.tls_key_path == "/etc/letsencrypt/live/chat.example.org/privkey.pem"
|
|
||||||
|
|
||||||
|
|
||||||
def test_external_tls_missing_option_uses_acme(tmp_path):
|
|
||||||
config = read_config(make_external_config(tmp_path))
|
|
||||||
assert config.tls_cert_mode == "acme"
|
|
||||||
|
|
||||||
|
|
||||||
def test_external_tls_bad_format_raises(tmp_path):
|
|
||||||
inipath = make_external_config(tmp_path, cert_key="/only/one/path.pem")
|
|
||||||
with pytest.raises(ValueError, match="two space-separated"):
|
|
||||||
read_config(inipath)
|
|
||||||
|
|
||||||
|
|
||||||
def test_external_tls_three_paths_raises(tmp_path):
|
|
||||||
inipath = make_external_config(tmp_path, cert_key="/a /b /c")
|
|
||||||
with pytest.raises(ValueError, match="two space-separated"):
|
|
||||||
read_config(inipath)
|
|
||||||
|
|
||||||
|
|
||||||
def test_external_tls_no_dclogin_url(tmp_path, capsys, monkeypatch):
|
|
||||||
inipath = make_external_config(
|
|
||||||
tmp_path, cert_key="/certs/fullchain.pem /certs/privkey.pem"
|
|
||||||
)
|
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(inipath))
|
|
||||||
chatmaild.newemail.print_new_account()
|
|
||||||
out, _ = capsys.readouterr()
|
|
||||||
lines = out.split("\n")
|
|
||||||
dic = json.loads(lines[2])
|
|
||||||
assert "dclogin_url" not in dic
|
|
||||||
|
|
||||||
|
|
||||||
def test_external_tls_selects_correct_deployer(tmp_path):
|
|
||||||
from cmdeploy.deployers import get_tls_deployer
|
|
||||||
from cmdeploy.external.deployer import ExternalTlsDeployer
|
|
||||||
from cmdeploy.selfsigned.deployer import SelfSignedTlsDeployer
|
|
||||||
|
|
||||||
inipath = make_external_config(
|
|
||||||
tmp_path, cert_key="/certs/fullchain.pem /certs/privkey.pem"
|
|
||||||
)
|
|
||||||
config = read_config(inipath)
|
|
||||||
deployer = get_tls_deployer(config, "chat.example.org")
|
|
||||||
|
|
||||||
assert isinstance(deployer, ExternalTlsDeployer)
|
|
||||||
assert not isinstance(deployer, SelfSignedTlsDeployer)
|
|
||||||
assert deployer.cert_path == "/certs/fullchain.pem"
|
|
||||||
assert deployer.key_path == "/certs/privkey.pem"
|
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
"""Tests for cmdeploy lxc-* subcommands."""
|
|
||||||
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from cmdeploy.lxc import cli
|
|
||||||
from cmdeploy.lxc.incus import Incus
|
|
||||||
from cmdeploy.util import Out
|
|
||||||
|
|
||||||
pytestmark = pytest.mark.skipif(
|
|
||||||
not shutil.which("incus"),
|
|
||||||
reason="incus not installed",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Fixtures
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def ix():
|
|
||||||
out = Out()
|
|
||||||
return Incus(out)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def lxc_setup():
|
|
||||||
out = Out()
|
|
||||||
ix = Incus(out)
|
|
||||||
ix.get_dns_container().ensure()
|
|
||||||
return ix.list_managed()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def relay_container(lxc_setup):
|
|
||||||
test_names = {f"{n}-localchat" for n in cli.RELAY_NAMES}
|
|
||||||
relays = [c for c in lxc_setup if c["name"] in test_names and c.get("ip")]
|
|
||||||
if not relays:
|
|
||||||
pytest.skip("no test relay containers running")
|
|
||||||
return relays[0]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def cmdeploy():
|
|
||||||
def run(*args):
|
|
||||||
return subprocess.run(
|
|
||||||
[sys.executable, "-m", "cmdeploy.cmdeploy", *args],
|
|
||||||
capture_output=True,
|
|
||||||
text=True,
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
return run
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Tests
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"subcmd, expected, absent",
|
|
||||||
[
|
|
||||||
(None, ["lxc-start", "lxc-stop", "lxc-test", "lxc-status"], ["lxc-destroy"]),
|
|
||||||
("lxc-start", ["--ipv4-only", "--run"], ["--config"]),
|
|
||||||
("lxc-stop", ["--destroy", "--destroy-all"], ["--config"]),
|
|
||||||
("lxc-test", ["--one"], ["--config"]),
|
|
||||||
("lxc-status", [], ["--config"]),
|
|
||||||
("run", ["--ssh-config"], ["--lxc"]),
|
|
||||||
("dns", ["--ssh-config"], []),
|
|
||||||
("test", ["--ssh-config"], []),
|
|
||||||
("status", ["--ssh-config"], []),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_help_options(cmdeploy, subcmd, expected, absent):
|
|
||||||
args = [subcmd, "--help"] if subcmd else ["--help"]
|
|
||||||
result = cmdeploy(*args)
|
|
||||||
output = result.stdout + result.stderr
|
|
||||||
assert result.returncode == 0
|
|
||||||
for flag in expected:
|
|
||||||
assert flag in output
|
|
||||||
for flag in absent:
|
|
||||||
assert flag not in output
|
|
||||||
|
|
||||||
|
|
||||||
class TestSSHConfig:
|
|
||||||
def test_lxconfigs(self, ix, lxc_setup):
|
|
||||||
d = ix.lxconfigs_dir
|
|
||||||
assert d.name == "lxconfigs"
|
|
||||||
assert d.exists()
|
|
||||||
path = ix.ssh_config_path
|
|
||||||
assert path.name == "ssh-config"
|
|
||||||
assert path.parent.name == "lxconfigs"
|
|
||||||
|
|
||||||
def test_write_ssh_config(self, ix, lxc_setup):
|
|
||||||
path = ix.write_ssh_config()
|
|
||||||
assert path.exists()
|
|
||||||
text = path.read_text()
|
|
||||||
|
|
||||||
for c in lxc_setup:
|
|
||||||
if c.get("ip"):
|
|
||||||
assert c["name"] in text
|
|
||||||
assert f"Hostname {c['ip']}" in text
|
|
||||||
|
|
||||||
assert "User root" in text
|
|
||||||
assert "IdentityFile" in text
|
|
||||||
assert "StrictHostKeyChecking accept-new" in text
|
|
||||||
|
|
||||||
|
|
||||||
def test_dns(ix, relay_container):
|
|
||||||
def dig(qname, qtype):
|
|
||||||
ct = ix.get_dns_container()
|
|
||||||
return ct.bash(f"dig @127.0.0.1 {qname} {qtype} +short").strip()
|
|
||||||
|
|
||||||
domain = relay_container["domain"]
|
|
||||||
assert dig(domain, "A") == relay_container["ip"]
|
|
||||||
assert domain in dig(domain, "MX")
|
|
||||||
assert "587" in dig(f"_submission._tcp.{domain}", "SRV")
|
|
||||||
|
|
||||||
|
|
||||||
class TestLxcStatus:
|
|
||||||
def test_cli_lxc_status_help(self, cmdeploy):
|
|
||||||
result = cmdeploy("lxc-status", "--help")
|
|
||||||
assert result.returncode == 0
|
|
||||||
assert "status" in result.stdout.lower()
|
|
||||||
|
|
||||||
def test_shows_containers(self, lxc_setup, capsys):
|
|
||||||
class QuietOut(Out):
|
|
||||||
def red(self, msg, **kw):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def green(self, msg, **kw):
|
|
||||||
pass
|
|
||||||
|
|
||||||
ret = cli.lxc_status_cmd(None, QuietOut())
|
|
||||||
assert ret == 0
|
|
||||||
captured = capsys.readouterr().out
|
|
||||||
assert "ns-localchat" in captured
|
|
||||||
assert "running" in captured
|
|
||||||
|
|
||||||
def test_deploy_freshness(self, ix, monkeypatch):
|
|
||||||
ct = ix.get_container("x")
|
|
||||||
|
|
||||||
monkeypatch.setattr(
|
|
||||||
"cmdeploy.lxc.incus.RelayContainer.deployed_version",
|
|
||||||
lambda _self: "abc123def456",
|
|
||||||
)
|
|
||||||
monkeypatch.setattr(
|
|
||||||
"cmdeploy.lxc.incus.RelayContainer.deployed_domain",
|
|
||||||
lambda _self: ct.domain,
|
|
||||||
)
|
|
||||||
monkeypatch.setattr(
|
|
||||||
"cmdeploy.lxc.cli.get_version_string",
|
|
||||||
lambda: "abc123def456",
|
|
||||||
)
|
|
||||||
assert "IN-SYNC" in cli._deploy_status(ct, "abc123def456", ix)
|
|
||||||
assert "STALE" in cli._deploy_status(ct, "other_hash_here", ix)
|
|
||||||
|
|
||||||
# Hash matches but local has uncommitted changes
|
|
||||||
monkeypatch.setattr(
|
|
||||||
"cmdeploy.lxc.cli.get_version_string",
|
|
||||||
lambda: "abc123def456\ndiff --git a/foo",
|
|
||||||
)
|
|
||||||
assert "DIRTY" in cli._deploy_status(ct, "abc123def456", ix)
|
|
||||||
|
|
||||||
monkeypatch.setattr(
|
|
||||||
"cmdeploy.lxc.incus.RelayContainer.deployed_version",
|
|
||||||
lambda _self: None,
|
|
||||||
)
|
|
||||||
assert "NOT DEPLOYED" in cli._deploy_status(ct, "abc123", ix)
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
import sys
|
|
||||||
|
|
||||||
from cmdeploy.util import Out, collapse, get_git_hash, get_version_string, shell
|
|
||||||
|
|
||||||
|
|
||||||
class TestOut:
|
|
||||||
def test_prefix_default(self, capsys):
|
|
||||||
out = Out()
|
|
||||||
out.print("hello")
|
|
||||||
assert capsys.readouterr().out == "hello\n"
|
|
||||||
|
|
||||||
def test_prefix_custom(self, capsys):
|
|
||||||
out = Out(prefix=">> ")
|
|
||||||
out.print("hello")
|
|
||||||
assert capsys.readouterr().out == ">> hello\n"
|
|
||||||
|
|
||||||
def test_prefix_print_file(self):
|
|
||||||
import io
|
|
||||||
|
|
||||||
buf = io.StringIO()
|
|
||||||
out = Out(prefix=":: ")
|
|
||||||
out.print("msg", file=buf)
|
|
||||||
assert ":: msg" in buf.getvalue()
|
|
||||||
|
|
||||||
def test_new_prefixed_out(self, capsys):
|
|
||||||
parent = Out(prefix="A")
|
|
||||||
child = parent.new_prefixed_out("B")
|
|
||||||
child.print("x")
|
|
||||||
assert capsys.readouterr().out == "ABx\n"
|
|
||||||
# shares section_timings
|
|
||||||
assert child.section_timings is parent.section_timings
|
|
||||||
|
|
||||||
def test_section_no_auto_indent(self, capsys):
|
|
||||||
out = Out(prefix="")
|
|
||||||
with out.section("test"):
|
|
||||||
out.print("inside")
|
|
||||||
captured = capsys.readouterr().out
|
|
||||||
# "inside" should NOT be indented by section()
|
|
||||||
lines = captured.strip().splitlines()
|
|
||||||
inside_line = [l for l in lines if "inside" in l][0]
|
|
||||||
assert inside_line == "inside"
|
|
||||||
|
|
||||||
def test_section_records_timing(self):
|
|
||||||
out = Out()
|
|
||||||
with out.section("s1"):
|
|
||||||
pass
|
|
||||||
assert len(out.section_timings) == 1
|
|
||||||
assert out.section_timings[0][0] == "s1"
|
|
||||||
|
|
||||||
def test_shell_failure_shows_output(self):
|
|
||||||
"""When a shell command fails, its output and exit code are shown."""
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
result = subprocess.run(
|
|
||||||
[
|
|
||||||
sys.executable,
|
|
||||||
"-c",
|
|
||||||
"from cmdeploy.util import Out; Out(prefix='').shell("
|
|
||||||
"\"echo 'boom on stderr' >&2; exit 42\")",
|
|
||||||
],
|
|
||||||
capture_output=True,
|
|
||||||
text=True,
|
|
||||||
check=False,
|
|
||||||
)
|
|
||||||
# the command's stderr is merged into stdout by Popen
|
|
||||||
assert "boom on stderr" in result.stdout
|
|
||||||
# Out.red() prints the failure notice to stderr
|
|
||||||
assert "exit code 42" in result.stderr
|
|
||||||
|
|
||||||
|
|
||||||
def test_collapse():
|
|
||||||
text = """
|
|
||||||
line 1
|
|
||||||
line 2
|
|
||||||
"""
|
|
||||||
assert collapse(text) == "line 1 line 2"
|
|
||||||
assert collapse(" single line ") == "single line"
|
|
||||||
|
|
||||||
|
|
||||||
def test_git_helpers_no_git(tmp_path):
|
|
||||||
# Not a git repo
|
|
||||||
assert get_git_hash(root=tmp_path) is None
|
|
||||||
assert get_version_string(root=tmp_path) == "unknown"
|
|
||||||
|
|
||||||
|
|
||||||
def test_git_helpers_empty_repo(tmp_path):
|
|
||||||
shell("git init", cwd=tmp_path, check=True)
|
|
||||||
# No commits yet
|
|
||||||
assert get_git_hash(root=tmp_path) is None
|
|
||||||
assert get_version_string(root=tmp_path) == "unknown"
|
|
||||||
|
|
||||||
|
|
||||||
def test_git_helpers_with_commits_and_diffs(tmp_path):
|
|
||||||
shell("git init", cwd=tmp_path, check=True)
|
|
||||||
shell("git config user.email you@example.com", cwd=tmp_path, check=True)
|
|
||||||
shell("git config user.name 'Your Name'", cwd=tmp_path, check=True)
|
|
||||||
|
|
||||||
# First commit
|
|
||||||
path = tmp_path / "file.txt"
|
|
||||||
path.write_text("content")
|
|
||||||
shell("git add file.txt", cwd=tmp_path, check=True)
|
|
||||||
shell("git commit -m initial", cwd=tmp_path, check=True)
|
|
||||||
|
|
||||||
git_hash = get_git_hash(root=tmp_path)
|
|
||||||
assert len(git_hash) >= 7 # usually 40, but git is git
|
|
||||||
assert get_version_string(root=tmp_path) == git_hash
|
|
||||||
|
|
||||||
# Create a diff
|
|
||||||
path.write_text("new content")
|
|
||||||
v = get_version_string(root=tmp_path)
|
|
||||||
assert v.startswith(git_hash + "\n")
|
|
||||||
assert "new content" in v
|
|
||||||
assert not v.endswith("\n")
|
|
||||||
|
|
||||||
# Commit again -> no diff
|
|
||||||
shell("git add file.txt", cwd=tmp_path, check=True)
|
|
||||||
shell("git commit -m second", cwd=tmp_path, check=True)
|
|
||||||
new_hash = get_git_hash(root=tmp_path)
|
|
||||||
assert new_hash != git_hash
|
|
||||||
assert get_version_string(root=tmp_path) == new_hash
|
|
||||||
@@ -1,169 +0,0 @@
|
|||||||
"""Shared utility functions for cmdeploy."""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
import textwrap
|
|
||||||
import time
|
|
||||||
from contextlib import contextmanager
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from termcolor import colored
|
|
||||||
|
|
||||||
|
|
||||||
class Out:
|
|
||||||
"""Convenience output printer providing coloring and section formatting."""
|
|
||||||
|
|
||||||
def __init__(self, prefix="", verbosity=0):
|
|
||||||
self.section_timings = []
|
|
||||||
self.prefix = prefix
|
|
||||||
self.sepchar = "\u2501"
|
|
||||||
self.verbosity = verbosity
|
|
||||||
env_width = os.environ.get("_CMDEPLOY_WIDTH")
|
|
||||||
if env_width:
|
|
||||||
self.section_width = int(env_width)
|
|
||||||
else:
|
|
||||||
self.section_width = shutil.get_terminal_size((80, 24)).columns
|
|
||||||
|
|
||||||
def new_prefixed_out(self, newprefix=" "):
|
|
||||||
"""Return a new Out with an extended prefix,
|
|
||||||
sharing section_timings with the parent.
|
|
||||||
"""
|
|
||||||
out = Out(
|
|
||||||
prefix=self.prefix + newprefix,
|
|
||||||
verbosity=self.verbosity,
|
|
||||||
)
|
|
||||||
out.section_timings = self.section_timings
|
|
||||||
return out
|
|
||||||
|
|
||||||
def red(self, msg, file=sys.stderr):
|
|
||||||
print(colored(self.prefix + msg, "red"), file=file, flush=True)
|
|
||||||
|
|
||||||
def green(self, msg, file=sys.stderr):
|
|
||||||
print(colored(self.prefix + msg, "green"), file=file, flush=True)
|
|
||||||
|
|
||||||
def print(self, msg="", **kwargs):
|
|
||||||
"""Print to stdout with automatic flush."""
|
|
||||||
if msg:
|
|
||||||
msg = self.prefix + msg
|
|
||||||
print(msg, flush=True, **kwargs)
|
|
||||||
|
|
||||||
def _format_header(self, title):
|
|
||||||
"""Return a formatted section header string."""
|
|
||||||
width = self.section_width - len(self.prefix)
|
|
||||||
bar = self.sepchar * (width - len(title) - 5)
|
|
||||||
return f"{self.sepchar * 3} {title} {bar}"
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def section(self, title):
|
|
||||||
"""Context manager that prints a section header and records elapsed time."""
|
|
||||||
self.green(self._format_header(title))
|
|
||||||
t0 = time.time()
|
|
||||||
yield
|
|
||||||
elapsed = time.time() - t0
|
|
||||||
self.section_timings.append((title, elapsed))
|
|
||||||
|
|
||||||
def section_line(self, title):
|
|
||||||
"""Print a section header without timing."""
|
|
||||||
self.green(self._format_header(title))
|
|
||||||
|
|
||||||
def shell(self, cmd, quiet=False, **kwargs):
|
|
||||||
"""Print *cmd*, run it, and re-print its output with the current prefix.
|
|
||||||
|
|
||||||
*cmd* is passed through :func:`collapse`, so callers
|
|
||||||
can use triple-quoted f-strings freely.
|
|
||||||
Stdout and stderr are merged, read line-by-line,
|
|
||||||
and each line is printed with ``self.prefix`` prepended.
|
|
||||||
When the command exits non-zero, a red error line is printed.
|
|
||||||
"""
|
|
||||||
cmd = collapse(cmd)
|
|
||||||
if not quiet:
|
|
||||||
self.print(f"$ {cmd}")
|
|
||||||
indent = self.prefix + " "
|
|
||||||
env = kwargs.pop("env", None)
|
|
||||||
if env is None:
|
|
||||||
env = os.environ.copy()
|
|
||||||
env["_CMDEPLOY_WIDTH"] = str(self.section_width - len(indent))
|
|
||||||
proc = subprocess.Popen(
|
|
||||||
cmd,
|
|
||||||
shell=True,
|
|
||||||
text=True,
|
|
||||||
stdin=subprocess.DEVNULL,
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
stderr=subprocess.STDOUT,
|
|
||||||
env=env,
|
|
||||||
**kwargs,
|
|
||||||
)
|
|
||||||
for line in proc.stdout:
|
|
||||||
sys.stdout.write(indent + line)
|
|
||||||
sys.stdout.flush()
|
|
||||||
ret = proc.wait()
|
|
||||||
if ret:
|
|
||||||
self.red(f"command failed with exit code {ret}: {cmd}")
|
|
||||||
return ret
|
|
||||||
|
|
||||||
|
|
||||||
def _project_root():
|
|
||||||
"""Return the project root directory."""
|
|
||||||
return Path(__file__).resolve().parent.parent.parent.parent
|
|
||||||
|
|
||||||
|
|
||||||
def collapse(text):
|
|
||||||
"""Dedent, join lines, and strip a (triple-quoted) string.
|
|
||||||
|
|
||||||
Handy for writing shell commands across multiple lines::
|
|
||||||
|
|
||||||
cmd = collapse(f\"""
|
|
||||||
cmdeploy run
|
|
||||||
--config {ct.ini}
|
|
||||||
--ssh-host {ct.domain}
|
|
||||||
\""")
|
|
||||||
"""
|
|
||||||
return textwrap.dedent(text).replace("\n", " ").strip()
|
|
||||||
|
|
||||||
|
|
||||||
def shell(cmd, check=False, **kwargs):
|
|
||||||
"""Run a shell command string with sensible defaults.
|
|
||||||
|
|
||||||
*cmd* is passed through :func:`collapse` first, so callers
|
|
||||||
can use triple-quoted f-strings freely.
|
|
||||||
Captures stdout/stderr by default; pass ``capture_output=False``
|
|
||||||
to stream output to the terminal instead.
|
|
||||||
"""
|
|
||||||
if "capture_output" not in kwargs and "stdout" not in kwargs:
|
|
||||||
kwargs["capture_output"] = True
|
|
||||||
kwargs.setdefault("stdin", subprocess.DEVNULL)
|
|
||||||
return subprocess.run(collapse(cmd), shell=True, text=True, check=check, **kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
def get_git_hash(root=None):
|
|
||||||
"""Return the local HEAD commit hash, or None."""
|
|
||||||
if root is None:
|
|
||||||
root = _project_root()
|
|
||||||
result = shell(
|
|
||||||
"git rev-parse HEAD",
|
|
||||||
cwd=str(root),
|
|
||||||
)
|
|
||||||
if result.returncode == 0:
|
|
||||||
return result.stdout.strip()
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def get_version_string(root=None):
|
|
||||||
"""Return ``git_hash\\ngit_diff`` for the local working tree.
|
|
||||||
|
|
||||||
Used by :class:`~cmdeploy.deployers.GithashDeployer` to write
|
|
||||||
``/etc/chatmail-version`` and by ``lxc-status`` to compare
|
|
||||||
the deployed state against the local checkout.
|
|
||||||
"""
|
|
||||||
if root is None:
|
|
||||||
root = _project_root()
|
|
||||||
git_hash = get_git_hash(root=root) or "unknown"
|
|
||||||
try:
|
|
||||||
git_diff = shell("git diff", cwd=str(root)).stdout.strip()
|
|
||||||
except Exception:
|
|
||||||
git_diff = ""
|
|
||||||
if git_diff:
|
|
||||||
return f"{git_hash}\n{git_diff}"
|
|
||||||
return git_hash
|
|
||||||
@@ -15,7 +15,7 @@ author = 'chatmail collective'
|
|||||||
|
|
||||||
extensions = [
|
extensions = [
|
||||||
#'sphinx.ext.autodoc',
|
#'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.viewcode',
|
#'sphinx.ext.viewdoc',
|
||||||
'sphinxcontrib.mermaid',
|
'sphinxcontrib.mermaid',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
@@ -47,14 +47,6 @@ steps. Please substitute it with your own domain.
|
|||||||
www.chat.example.org. 3600 IN CNAME chat.example.org.
|
www.chat.example.org. 3600 IN CNAME chat.example.org.
|
||||||
mta-sts.chat.example.org. 3600 IN CNAME chat.example.org.
|
mta-sts.chat.example.org. 3600 IN CNAME chat.example.org.
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
For experimental deployments using self-signed certificates,
|
|
||||||
use a domain name starting with ``_``
|
|
||||||
(e.g. ``_chat.example.org``).
|
|
||||||
The ``mta-sts`` CNAME and ``_mta-sts`` TXT records
|
|
||||||
are not needed for such domains.
|
|
||||||
|
|
||||||
2. On your local PC, clone the repository and bootstrap the Python
|
2. On your local PC, clone the repository and bootstrap the Python
|
||||||
virtualenv.
|
virtualenv.
|
||||||
|
|
||||||
@@ -71,16 +63,6 @@ steps. Please substitute it with your own domain.
|
|||||||
|
|
||||||
scripts/cmdeploy init chat.example.org # <-- use your domain
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
|
|
||||||
To use self-signed TLS certificates
|
|
||||||
instead of Let's Encrypt,
|
|
||||||
use a domain name starting with ``_``
|
|
||||||
(e.g. ``scripts/cmdeploy init _chat.example.org``).
|
|
||||||
Domains starting with ``_`` cannot obtain WebPKI certificates,
|
|
||||||
so self-signed mode is derived automatically.
|
|
||||||
This is useful for private or test deployments.
|
|
||||||
See the :doc:`overview`
|
|
||||||
for details on certificate provisioning.
|
|
||||||
|
|
||||||
4. Verify that SSH root login to the deployment server server works:
|
4. Verify that SSH root login to the deployment server server works:
|
||||||
|
|
||||||
::
|
::
|
||||||
@@ -187,55 +169,6 @@ creating addresses, login with ssh to the deployment machine and run:
|
|||||||
Chatmail address creation will be denied while this file is present.
|
Chatmail address creation will be denied while this file is present.
|
||||||
|
|
||||||
|
|
||||||
Running a relay with self-signed certificates
|
|
||||||
----------------------------------------------
|
|
||||||
|
|
||||||
Use a domain name starting with ``_`` (e.g. ``_chat.example.org``)
|
|
||||||
to run a relay with self-signed certificates.
|
|
||||||
Domains starting with ``_`` cannot obtain WebPKI certificates
|
|
||||||
so the relay automatically uses self-signed certificates
|
|
||||||
and all other relays will accept connections from it
|
|
||||||
without requiring certificate verification.
|
|
||||||
This is useful for experimental setups and testing.
|
|
||||||
|
|
||||||
.. _external-tls:
|
|
||||||
|
|
||||||
Running a relay with externally managed certificates
|
|
||||||
-----------------------------------------------------
|
|
||||||
|
|
||||||
If you already have a TLS certificate manager
|
|
||||||
(e.g. Traefik, certbot, or another ACME client)
|
|
||||||
running on the deployment server,
|
|
||||||
you can configure the relay to use those certificates
|
|
||||||
instead of the built-in ``acmetool``.
|
|
||||||
|
|
||||||
Set the following in ``chatmail.ini``::
|
|
||||||
|
|
||||||
tls_external_cert_and_key = /path/to/fullchain.pem /path/to/privkey.pem
|
|
||||||
|
|
||||||
The paths must point to certificate and key files
|
|
||||||
on the deployment server.
|
|
||||||
During ``cmdeploy run``, these paths are written into
|
|
||||||
the Postfix, Dovecot, and Nginx configurations.
|
|
||||||
No certificate files are transferred from the build machine —
|
|
||||||
they must already exist on the server,
|
|
||||||
managed by your external certificate tool.
|
|
||||||
|
|
||||||
The deploy will verify that both files exist on the server.
|
|
||||||
``acmetool`` is **not** installed or run in this mode.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
You are responsible for certificate renewal.
|
|
||||||
When the certificate file changes on disk,
|
|
||||||
all relay services pick up the new certificate automatically
|
|
||||||
via a systemd path watcher installed during deploy.
|
|
||||||
The watcher uses inotify, which does not cross bind-mount boundaries.
|
|
||||||
If you use such a setup, you must trigger the reload explicitly after renewal::
|
|
||||||
|
|
||||||
systemctl start tls-cert-reload.service
|
|
||||||
|
|
||||||
|
|
||||||
Migrating to a new build machine
|
Migrating to a new build machine
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,5 @@ Contributions and feedback welcome through the https://github.com/chatmail/relay
|
|||||||
proxy
|
proxy
|
||||||
migrate
|
migrate
|
||||||
overview
|
overview
|
||||||
lxc
|
|
||||||
related
|
related
|
||||||
faq
|
faq
|
||||||
|
|||||||
@@ -1,271 +0,0 @@
|
|||||||
Local testing with LXC/Incus
|
|
||||||
============================
|
|
||||||
|
|
||||||
The ``cmdeploy`` tool includes support for running
|
|
||||||
chatmail relays inside local
|
|
||||||
`Incus <https://linuxcontainers.org/incus/>`_ LXC containers.
|
|
||||||
This is meant for development, testing, and CI
|
|
||||||
without requiring a remote server.
|
|
||||||
LXC system containers are lightweight virtual machines
|
|
||||||
that share the host's kernel but run their own init system,
|
|
||||||
package manager, and network stack,
|
|
||||||
so the cmdeploy deployment scripts work pretty much
|
|
||||||
as they would on a real Debian server or cloud VPS.
|
|
||||||
|
|
||||||
Prerequisites
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Install `Incus <https://linuxcontainers.org/incus/>`_
|
|
||||||
(LXC container manager).
|
|
||||||
See the `official installation guide
|
|
||||||
<https://linuxcontainers.org/incus/docs/main/installing/>`_
|
|
||||||
for full details.
|
|
||||||
|
|
||||||
After installing incus, initialise and grant yourself access::
|
|
||||||
|
|
||||||
sudo incus admin init --minimal
|
|
||||||
sudo usermod -aG incus-admin $USER
|
|
||||||
|
|
||||||
|
|
||||||
.. caution::
|
|
||||||
|
|
||||||
Adding yourself to ``incus-admin`` grants effective root access
|
|
||||||
to the host: any member can mount host directories into a container
|
|
||||||
and manipulate them as root.
|
|
||||||
This is fine for local testing of your own relay branches,
|
|
||||||
but do **not** use it for production setups
|
|
||||||
or for testing untrusted relay branches from others.
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
|
|
||||||
You **must now log out and back in** (or run ``newgrp incus-admin``)
|
|
||||||
after adding yourself to the group.
|
|
||||||
Without this, all ``cmdeploy lxc-*`` commands
|
|
||||||
will fail with permission errors.
|
|
||||||
|
|
||||||
Verify the installation works by running ``incus list``,
|
|
||||||
which should print an empty table without errors.
|
|
||||||
|
|
||||||
|
|
||||||
Quick start
|
|
||||||
-----------
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
cd relay
|
|
||||||
scripts/initenv.sh # bootstrap venv
|
|
||||||
source venv/bin/activate # activate venv
|
|
||||||
cmdeploy lxc-test # create containers, deploy, test
|
|
||||||
|
|
||||||
The ``lxc-test`` command provides an automated way
|
|
||||||
to run the full deployment and test pipeline.
|
|
||||||
It executes several ``cmdeploy`` subcommands in sequential steps.
|
|
||||||
If a step fails, you can copy-paste the printed command
|
|
||||||
and run it manually to debug.
|
|
||||||
No host DNS delegation or ``~/.ssh/config`` changes are needed
|
|
||||||
because ``lxc-test`` passes the required SSH and DNS options directly.
|
|
||||||
|
|
||||||
|
|
||||||
CLI reference
|
|
||||||
--------------
|
|
||||||
|
|
||||||
``lxc-start [--ipv4-only] [--run] [NAME ...]``
|
|
||||||
Create and start containers.
|
|
||||||
Without arguments, creates ``test0-localchat`` and ``ns-localchat`` (DNS).
|
|
||||||
Pass one or more ``NAME`` arguments to create user relay containers instead
|
|
||||||
(e.g. ``cmdeploy lxc-start myrelay``).
|
|
||||||
Use ``--ipv4-only`` to set ``disable_ipv6 = True`` in the generated ``chatmail.ini``,
|
|
||||||
producing an IPv4-only relay.
|
|
||||||
Use ``--run`` to automatically run ``cmdeploy run`` on each container after starting it.
|
|
||||||
Generates ``lxconfigs/ssh-config``.
|
|
||||||
It reuses existing containers and resets DNS zones to minimal records.
|
|
||||||
|
|
||||||
``lxc-stop [--destroy] [--destroy-all] [NAME ...]``
|
|
||||||
Stop relay containers.
|
|
||||||
Without arguments, stops ``test0-localchat`` and ``test1-localchat``.
|
|
||||||
Pass ``NAME`` to stop specific containers.
|
|
||||||
Use ``--destroy`` to also delete the containers and their config files.
|
|
||||||
Use ``--destroy-all`` to additionally destroy
|
|
||||||
the ``ns-localchat`` DNS container **and** remove
|
|
||||||
the cached ``localchat-base`` and ``localchat-relay``
|
|
||||||
images, giving a fully clean slate for the next ``lxc-test``.
|
|
||||||
User containers are **never** destroyed unless named explicitly.
|
|
||||||
|
|
||||||
``lxc-test [--one]``
|
|
||||||
By default creates, deploys, and tests both ``test0`` and ``test1``
|
|
||||||
for dual-domain federation testing (sets ``CHATMAIL_DOMAIN2=_test1.localchat``).
|
|
||||||
test0 runs dual-stack (IPv4 + IPv6) while test1 runs IPv4-only (``disable_ipv6 = True``).
|
|
||||||
Pass ``--one`` to only deploy and test against ``test0``
|
|
||||||
(skips ``test1``, does not set ``CHATMAIL_DOMAIN2``).
|
|
||||||
|
|
||||||
``lxc-status``
|
|
||||||
Show live status of all LXC containers (including the DNS container),
|
|
||||||
deploy freshness (comparing ``/etc/chatmail-version``
|
|
||||||
against local ``git rev-parse HEAD`` and ``git diff``),
|
|
||||||
SSH config inclusion, and host DNS forwarding for ``.localchat``.
|
|
||||||
Reports **IN-SYNC**, **DIRTY** (hash matches but uncommitted changes exist),
|
|
||||||
**STALE** (different commit), or **NOT DEPLOYED**.
|
|
||||||
|
|
||||||
|
|
||||||
Container types
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
**Test relay containers** (``test0-localchat``, ``test1-localchat``)
|
|
||||||
Created automatically by ``lxc-test``.
|
|
||||||
**test0** has IPv4 and IPv6 configured,
|
|
||||||
**test1** is IPv4-only (``disable_ipv6 = True``).
|
|
||||||
|
|
||||||
**User relay containers** (``<name>-localchat``)
|
|
||||||
Created by ``cmdeploy lxc-start <name>``
|
|
||||||
where ``<name>`` does not start with ``test``.
|
|
||||||
These are personal development instances,
|
|
||||||
never touched by ``lxc-stop --destroy`` unless named explicitly.
|
|
||||||
|
|
||||||
**DNS container** (``ns-localchat``)
|
|
||||||
Singleton container running PowerDNS.
|
|
||||||
Created automatically when any relay is started.
|
|
||||||
|
|
||||||
|
|
||||||
.. _lxc-ssh-config:
|
|
||||||
|
|
||||||
SSH configuration
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
``cmdeploy lxc-start`` generates ``lxconfigs/ssh-config``,
|
|
||||||
a standard OpenSSH config file mapping every container name,
|
|
||||||
its domain, and a short alias to the container's IP address::
|
|
||||||
|
|
||||||
Host test0-localchat _test0.localchat _test0
|
|
||||||
Hostname 10.204.0.42
|
|
||||||
User root
|
|
||||||
IdentityFile /path/to/relay/lxconfigs/id_localchat
|
|
||||||
IdentitiesOnly yes
|
|
||||||
StrictHostKeyChecking accept-new
|
|
||||||
UserKnownHostsFile /dev/null
|
|
||||||
LogLevel ERROR
|
|
||||||
|
|
||||||
All ``cmdeploy`` commands (``run``, ``dns``, ``status``, ``test``)
|
|
||||||
accept ``--ssh-config lxconfigs/ssh-config`` to use this file.
|
|
||||||
``lxc-test`` passes it automatically.
|
|
||||||
|
|
||||||
**Using containers from the host shell:**
|
|
||||||
|
|
||||||
To make ``ssh _test0`` work from any terminal, add one line to ``~/.ssh/config``::
|
|
||||||
|
|
||||||
Include /absolute/path/to/relay/lxconfigs/ssh-config
|
|
||||||
|
|
||||||
|
|
||||||
.. _lxc-dns-setup:
|
|
||||||
.. _localchat-tld:
|
|
||||||
|
|
||||||
``.localchat`` DNS and name resolution
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
All LXC-managed chatmail domains use the ``.localchat`` pseudo-TLD
|
|
||||||
(e.g. ``_test0.localchat``, ``_test1.localchat``),
|
|
||||||
a non-delegated suffix that exists only within the local PowerDNS infrastructure.
|
|
||||||
A dedicated DNS container (``ns-localchat``)
|
|
||||||
is created so that local test relays interact
|
|
||||||
with DNS similar to a regular public Internet setup.
|
|
||||||
On first start, ``cmdeploy lxc-start`` creates this container
|
|
||||||
running two `PowerDNS <https://www.powerdns.com/>`_ services:
|
|
||||||
|
|
||||||
* **pdns-server** (authoritative) serves ``.localchat``
|
|
||||||
zones from a local SQLite database.
|
|
||||||
|
|
||||||
* **pdns-recursor** (recursive) listens on the Incus
|
|
||||||
bridge so all containers can use it.
|
|
||||||
Forwards ``.localchat`` queries to the local
|
|
||||||
authoritative server and resolves everything else recursively.
|
|
||||||
|
|
||||||
After the DNS container is up, ``lxc-start`` configures the Incus bridge
|
|
||||||
to advertise its IP via DHCP and disables Incus's own DNS.
|
|
||||||
DNS records are then created in two phases matching the "cmdeploy run" deployment flow:
|
|
||||||
|
|
||||||
1. **``lxc-start``** resets each relay zone to
|
|
||||||
**SOA, NS, and A** records (plus **AAAA** for dual-stack containers).
|
|
||||||
If host DNS resolution is configured, users can
|
|
||||||
afterwards run ``cmdeploy run --config lxconfigs/chatmail-test0.ini
|
|
||||||
--ssh-config lxconfigs/ssh-config --ssh-host _test0.localchat``.
|
|
||||||
LXC subcommands do not depend on host DNS resolution
|
|
||||||
and resolve addresses via ``lxconfigs/ssh-config``.
|
|
||||||
|
|
||||||
2. **``cmdeploy dns --zonefile``** generates a standard
|
|
||||||
BIND-format zone file (MX, TXT/SPF, TXT/DMARC,
|
|
||||||
TXT/MTA-STS, SRV, CNAME, DKIM) and loads it
|
|
||||||
into PowerDNS.
|
|
||||||
|
|
||||||
This two-phase approach prevents premature configuration of mail records
|
|
||||||
before the relay is actually deployed and running.
|
|
||||||
Once ``cmdeploy run`` deploys `Unbound <https://nlnetlabs.nl/projects/unbound/>`_
|
|
||||||
inside a relay container, Unbound has a configuration plugin snippet
|
|
||||||
that forwards all ``.localchat`` queries to the PowerDNS recursor,
|
|
||||||
and lets all other queries go through normal recursive resolution.
|
|
||||||
|
|
||||||
|
|
||||||
State outside the repository
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
All generated configuration by lxc subcommands live in ``lxconfigs/``
|
|
||||||
(git-ignored), including the SSH key pair (``id_localchat``),
|
|
||||||
per-container ``chatmail-*.ini`` files, zone files, and ``ssh-config``.
|
|
||||||
|
|
||||||
The only state *outside* the repository is the Incus containers and images themselves
|
|
||||||
(managed via the ``incus`` CLI, labelled with ``user.localchat-managed=true``).
|
|
||||||
The Incus image store retains the following snapshot images:
|
|
||||||
|
|
||||||
* ``localchat-base``: Debian 12 with openssh-server and Python (built on first run)
|
|
||||||
|
|
||||||
* ``localchat-relay``: fully deployed relay snapshot,
|
|
||||||
cached after the first successful ``cmdeploy run``.
|
|
||||||
Subsequent relay containers launch from this image
|
|
||||||
so the deploy step is mostly no-ops (roughly 3× faster than a fresh deploy).
|
|
||||||
|
|
||||||
|
|
||||||
.. _lxc-tls:
|
|
||||||
|
|
||||||
TLS handling and underscore domains
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
Container domains start with ``_`` (e.g. ``_test0.localchat``).
|
|
||||||
As described in :doc:`getting_started` ("Running a relay with self-signed certificates"),
|
|
||||||
underscore domains automatically use self-signed TLS
|
|
||||||
and ``smtp_tls_security_level = encrypt``.
|
|
||||||
This permits cross-relay federation between LXC containers
|
|
||||||
without any external certificate authority.
|
|
||||||
Delta Chat clients connecting to these relays
|
|
||||||
must be configured with
|
|
||||||
``certificateChecks = acceptInvalidCertificates``
|
|
||||||
(the test fixtures handle this automatically).
|
|
||||||
`PR #7926 on chatmail-core <https://github.com/chatmail/core/pull/7926>`_
|
|
||||||
is meant to make this special setting unnecessary for chatmail clients
|
|
||||||
that are connecting to underscore domains.
|
|
||||||
|
|
||||||
|
|
||||||
Known limitations
|
|
||||||
------------------
|
|
||||||
|
|
||||||
The LXC environment differs from a production
|
|
||||||
deployment in several ways:
|
|
||||||
|
|
||||||
**No ACME / Let's Encrypt**:
|
|
||||||
Self-signed TLS only (see :ref:`lxc-tls`);
|
|
||||||
ACME code paths are never exercised locally.
|
|
||||||
|
|
||||||
**No inbound connections from the internet**:
|
|
||||||
Containers sit on a private Incus bridge and are not port-forwarded.
|
|
||||||
Only the host and other containers on the same bridge can reach them.
|
|
||||||
|
|
||||||
**Local federation only**:
|
|
||||||
Cross-relay mail delivery (e.g. test0 → test1) works between containers on the same host,
|
|
||||||
but these relays are invisible to any external mail server.
|
|
||||||
|
|
||||||
**DNS is local only**:
|
|
||||||
The ``.localchat`` pseudo-TLD is not resolvable from the wider internet
|
|
||||||
(see :ref:`lxc-dns-setup`).
|
|
||||||
|
|
||||||
**IPv6 is ULA-only**:
|
|
||||||
Containers receive IPv6 addresses from the ``fd42:...`` ULA range on the Incus bridge.
|
|
||||||
These are not globally routable, but are sufficient for testing IPv6 service binding
|
|
||||||
(Postfix, Dovecot, Nginx) and DNS AAAA records inside the local environment.
|
|
||||||
test1 runs with ``disable_ipv6 = True`` to exercise the IPv4-only deployment path.
|
|
||||||
@@ -109,6 +109,10 @@ short overview of ``chatmaild`` services:
|
|||||||
is contacted by Dovecot when a user logs in and stores the date of
|
is contacted by Dovecot when a user logs in and stores the date of
|
||||||
the login.
|
the login.
|
||||||
|
|
||||||
|
- `metrics <https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/metrics.py>`_
|
||||||
|
collects some metrics and displays them at
|
||||||
|
``https://example.org/metrics``.
|
||||||
|
|
||||||
``www/``
|
``www/``
|
||||||
~~~~~~~~~
|
~~~~~~~~~
|
||||||
|
|
||||||
@@ -138,9 +142,11 @@ Chatmail relay dependency diagram
|
|||||||
nginx-internal --- autoconfig.xml;
|
nginx-internal --- autoconfig.xml;
|
||||||
certs-nginx[("`TLS certs
|
certs-nginx[("`TLS certs
|
||||||
/var/lib/acme`")] --> nginx-internal;
|
/var/lib/acme`")] --> nginx-internal;
|
||||||
|
systemd-timer --- chatmail-metrics;
|
||||||
systemd-timer --- acmetool;
|
systemd-timer --- acmetool;
|
||||||
systemd-timer --- chatmail-expire-daily;
|
systemd-timer --- chatmail-expire-daily;
|
||||||
systemd-timer --- chatmail-fsreport-daily;
|
systemd-timer --- chatmail-fsreport-daily;
|
||||||
|
chatmail-metrics --- website;
|
||||||
acmetool --> certs[("`TLS certs
|
acmetool --> certs[("`TLS certs
|
||||||
/var/lib/acme`")];
|
/var/lib/acme`")];
|
||||||
nginx-external --- |993|dovecot;
|
nginx-external --- |993|dovecot;
|
||||||
@@ -291,7 +297,8 @@ TLS requirements
|
|||||||
|
|
||||||
Postfix is configured to require valid TLS by setting
|
Postfix is configured to require valid TLS by setting
|
||||||
`smtp_tls_security_level <https://www.postfix.org/postconf.5.html#smtp_tls_security_level>`_
|
`smtp_tls_security_level <https://www.postfix.org/postconf.5.html#smtp_tls_security_level>`_
|
||||||
to ``verify``.
|
to ``verify``. If emails don’t arrive at your chatmail relay server, the
|
||||||
|
problem is likely that your relay does not have a valid TLS certificate.
|
||||||
|
|
||||||
You can test it by resolving ``MX`` records of your relay domain and
|
You can test it by resolving ``MX`` records of your relay domain and
|
||||||
then connecting to MX relays (e.g ``mx.example.org``) with
|
then connecting to MX relays (e.g ``mx.example.org``) with
|
||||||
@@ -302,11 +309,6 @@ When providing a TLS certificate to your chatmail relay server, make
|
|||||||
sure to provide the full certificate chain and not just the last
|
sure to provide the full certificate chain and not just the last
|
||||||
certificate.
|
certificate.
|
||||||
|
|
||||||
If you use an external certificate manager (e.g. Traefik or certbot),
|
|
||||||
set ``tls_external_cert_and_key`` in ``chatmail.ini``
|
|
||||||
to provide the certificate and key paths.
|
|
||||||
See :ref:`external-tls` for details.
|
|
||||||
|
|
||||||
If you are running an Exim server and don’t see incoming connections
|
If you are running an Exim server and don’t see incoming connections
|
||||||
from a chatmail relay server in the logs, make sure ``smtp_no_mail`` log
|
from a chatmail relay server in the logs, make sure ``smtp_no_mail`` log
|
||||||
item is enabled in the config with ``log_selector = +smtp_no_mail``. By
|
item is enabled in the config with ``log_selector = +smtp_no_mail``. By
|
||||||
@@ -315,14 +317,6 @@ default Exim does not log sessions that are closed before sending the
|
|||||||
by Postfix, so you might think that connection is not established while
|
by Postfix, so you might think that connection is not established while
|
||||||
actually it is a problem with your TLS certificate.
|
actually it is a problem with your TLS certificate.
|
||||||
|
|
||||||
If emails don’t arrive at your chatmail relay server, the
|
|
||||||
problem is likely that your relay does not have a valid TLS certificate.
|
|
||||||
|
|
||||||
Note that connections to relays with underscore-prefixed test domains
|
|
||||||
(e.g. ``_chat.example.org``) use ``encrypt`` tls security level,
|
|
||||||
because such domains cannot obtain valid Let's Encrypt certificates
|
|
||||||
and run with self-signed certificates.
|
|
||||||
|
|
||||||
|
|
||||||
.. _dovecot: https://dovecot.org
|
.. _dovecot: https://dovecot.org
|
||||||
.. _postfix: https://www.postfix.org
|
.. _postfix: https://www.postfix.org
|
||||||
|
|||||||
@@ -14,8 +14,8 @@ We know of three work-in-progress alternative implementation efforts:
|
|||||||
it to support all of the features and configuration settings required
|
it to support all of the features and configuration settings required
|
||||||
to operate as a chatmail relay.
|
to operate as a chatmail relay.
|
||||||
|
|
||||||
- `Madmail <https://github.com/themadorg/madmail>`_: an
|
- `Madmail <https://github.com/omidz4t/madmail>`_: an
|
||||||
experimental fork of `Maddy Mail Server <https://maddy.email/>`_, modified
|
experimental fork of Maddy Mail Server <https://maddy.email/>`_ optimized
|
||||||
for chatmail deployments. It provides a single binary solution
|
for chatmail deployments. It provides a single binary solution
|
||||||
for running a chatmail relay.
|
for running a chatmail relay.
|
||||||
|
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
/* dclogin profile generator for self-signed chatmail relays.
|
|
||||||
* Fetches credentials from /new and generates a dclogin: QR code.
|
|
||||||
* Requires qrcode-svg.min.js to be loaded first.
|
|
||||||
*/
|
|
||||||
(function () {
|
|
||||||
function generateProfile() {
|
|
||||||
fetch('/new')
|
|
||||||
.then(function (r) { return r.json(); })
|
|
||||||
.then(function (data) {
|
|
||||||
var url = data.dclogin_url;
|
|
||||||
var link = document.getElementById('dclogin-link');
|
|
||||||
link.href = url;
|
|
||||||
var qrLink = document.getElementById('qr-link');
|
|
||||||
qrLink.href = url;
|
|
||||||
var qrCode = document.getElementById('qr-code');
|
|
||||||
var qr = new QRCode({ content: url, width: 300, height: 300, padding: 1, join: true });
|
|
||||||
qrCode.innerHTML = qr.svg();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
generateProfile();
|
|
||||||
})();
|
|
||||||
@@ -11,18 +11,6 @@ for Delta Chat users. For details how it avoids storing personal information
|
|||||||
please see our [privacy policy](privacy.html).
|
please see our [privacy policy](privacy.html).
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if config.tls_cert_mode == "self" %}
|
|
||||||
<a class="cta-button" id="dclogin-link" href="#">Get a {{config.mail_domain}} chat profile</a>
|
|
||||||
|
|
||||||
If you are viewing this page on a different device
|
|
||||||
without a Delta Chat app,
|
|
||||||
you can also **scan this QR code** with Delta Chat:
|
|
||||||
|
|
||||||
<a id="qr-link" href="#"><div id="qr-code"></div></a>
|
|
||||||
|
|
||||||
<script src="qrcode-svg.min.js"></script>
|
|
||||||
<script src="dclogin.js"></script>
|
|
||||||
{% else %}
|
|
||||||
<a class="cta-button" href="DCACCOUNT:https://{{ config.mail_domain }}/new">Get a {{config.mail_domain}} chat profile</a>
|
<a class="cta-button" href="DCACCOUNT:https://{{ config.mail_domain }}/new">Get a {{config.mail_domain}} chat profile</a>
|
||||||
|
|
||||||
If you are viewing this page on a different device
|
If you are viewing this page on a different device
|
||||||
@@ -31,7 +19,6 @@ you can also **scan this QR code** with Delta Chat:
|
|||||||
|
|
||||||
<a href="DCACCOUNT:https://{{ config.mail_domain }}/new">
|
<a href="DCACCOUNT:https://{{ config.mail_domain }}/new">
|
||||||
<img width=300 style="float: none;" src="qr-chatmail-invite-{{config.mail_domain}}.png" /></a>
|
<img width=300 style="float: none;" src="qr-chatmail-invite-{{config.mail_domain}}.png" /></a>
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
🐣 **Choose** your Avatar and Name
|
🐣 **Choose** your Avatar and Name
|
||||||
|
|
||||||
|
|||||||
9
www/src/qrcode-svg.min.js
vendored
9
www/src/qrcode-svg.min.js
vendored
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user