mirror of
https://github.com/chatmail/relay.git
synced 2026-05-14 09:54:38 +00:00
Compare commits
1 Commits
hetzner-po
...
fix-metada
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
84e731034a |
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.5.2/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.5.1/filtermail-x86_64 -o /usr/local/bin/filtermail && chmod +x /usr/local/bin/filtermail
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
run: pipx run tox
|
run: pipx run tox
|
||||||
|
|||||||
@@ -89,6 +89,7 @@ jobs:
|
|||||||
|
|
||||||
- name: set DNS entries
|
- name: set DNS entries
|
||||||
run: |
|
run: |
|
||||||
|
ssh root@staging-ipv4.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
||||||
ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy dns --zonefile staging-generated.zone --ssh-host localhost"
|
ssh root@staging-ipv4.testrun.org "cd relay && scripts/cmdeploy dns --zonefile staging-generated.zone --ssh-host localhost"
|
||||||
ssh root@staging-ipv4.testrun.org cat relay/staging-generated.zone >> .github/workflows/staging-ipv4.testrun.org-default.zone
|
ssh root@staging-ipv4.testrun.org cat relay/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
|
||||||
|
|||||||
90
.github/workflows/test-and-deploy.yaml
vendored
90
.github/workflows/test-and-deploy.yaml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: deploy on allocated VPS and run tests
|
name: deploy on staging2.testrun.org, and run tests
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
@@ -12,27 +12,87 @@ on:
|
|||||||
- 'LICENSE'
|
- 'LICENSE'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
deploy-and-test:
|
deploy:
|
||||||
name: deploy on allocated VPS, and run tests
|
name: deploy on staging2.testrun.org, and run tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 15
|
timeout-minutes: 30
|
||||||
|
environment:
|
||||||
|
name: staging2.testrun.org
|
||||||
|
url: https://staging2.testrun.org/
|
||||||
|
concurrency: staging2.testrun.org
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
|
||||||
repository: chatmail/hetzner-relay
|
|
||||||
path: hetzner-relay
|
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
path: relay
|
|
||||||
|
|
||||||
- name: prepare SSH
|
- name: prepare SSH
|
||||||
run: |
|
run: |
|
||||||
mkdir ~/.ssh
|
mkdir ~/.ssh
|
||||||
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/staging.testrun.org
|
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
||||||
chmod 600 ~/.ssh/staging.testrun.org
|
chmod 600 ~/.ssh/id_ed25519
|
||||||
|
ssh-keyscan staging2.testrun.org > ~/.ssh/known_hosts
|
||||||
|
# save previous acme & dkim state
|
||||||
|
rsync -avz root@staging2.testrun.org:/var/lib/acme . || true
|
||||||
|
rsync -avz root@staging2.testrun.org:/etc/dkimkeys . || true
|
||||||
|
# store previous acme & dkim state on ns.testrun.org, if it contains useful certs
|
||||||
|
if [ -f dkimkeys/opendkim.private ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" dkimkeys root@ns.testrun.org:/tmp/ || true; fi
|
||||||
|
if [ "$(ls -A acme/certs)" ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" acme root@ns.testrun.org:/tmp/ || true; fi
|
||||||
|
# make sure CAA record isn't set
|
||||||
|
scp -o StrictHostKeyChecking=accept-new .github/workflows/staging.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org sed -i '/CAA/d' /etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org nsd-checkzone staging2.testrun.org /etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
- run: pip install hetzner-relay/
|
- name: rebuild staging2.testrun.org to have a clean VPS
|
||||||
|
run: |
|
||||||
|
curl -X POST \
|
||||||
|
-H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"image":"debian-12"}' \
|
||||||
|
"https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_SERVER_ID }}/actions/rebuild"
|
||||||
|
|
||||||
- run: python3 hetzner-relay/main.py -i ~/.ssh/staging.testrun.org --dns --test --rebuild --run-id $GITHUB_RUN_ID --domain2 ci-chatmail.testrun.org --hetzner-api-token ${{ secrets.HETZNER_API_TOKEN }} relay/
|
- run: scripts/initenv.sh
|
||||||
|
|
||||||
|
- name: append venv/bin to PATH
|
||||||
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
|
- name: upload TLS cert after rebuilding
|
||||||
|
run: |
|
||||||
|
echo " --- wait until staging2.testrun.org VPS is rebuilt --- "
|
||||||
|
rm ~/.ssh/known_hosts
|
||||||
|
while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org id -u ; do sleep 1 ; done
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org id -u
|
||||||
|
# download acme & dkim state from ns.testrun.org
|
||||||
|
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme acme-restore || true
|
||||||
|
rsync -avz root@ns.testrun.org:/tmp/dkimkeys dkimkeys-restore || true
|
||||||
|
# restore acme & dkim state to staging2.testrun.org
|
||||||
|
rsync -avz acme-restore/acme root@staging2.testrun.org:/var/lib/ || true
|
||||||
|
rsync -avz dkimkeys-restore/dkimkeys root@staging2.testrun.org:/etc/ || true
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
|
- name: add hpk42 key to staging server
|
||||||
|
run: ssh root@staging2.testrun.org 'curl -s https://github.com/hpk42.keys >> .ssh/authorized_keys'
|
||||||
|
|
||||||
|
- name: run deploy-chatmail offline tests
|
||||||
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
- run: |
|
||||||
|
cmdeploy init staging2.testrun.org
|
||||||
|
sed -i 's/#\s*mtail_address/mtail_address/' chatmail.ini
|
||||||
|
|
||||||
|
- run: cmdeploy run --verbose --skip-dns-check
|
||||||
|
|
||||||
|
- name: set DNS entries
|
||||||
|
run: |
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new root@staging2.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
||||||
|
cmdeploy dns --zonefile staging-generated.zone --verbose
|
||||||
|
cat staging-generated.zone >> .github/workflows/staging.testrun.org-default.zone
|
||||||
|
cat .github/workflows/staging.testrun.org-default.zone
|
||||||
|
scp .github/workflows/staging.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org nsd-checkzone staging2.testrun.org /etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
|
- name: cmdeploy test
|
||||||
|
run: CHATMAIL_DOMAIN2=ci-chatmail.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
|
- name: cmdeploy dns
|
||||||
|
run: cmdeploy dns -v
|
||||||
|
|
||||||
|
|||||||
@@ -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,11 +1,8 @@
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import re
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
import filelock
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import crypt_r
|
import crypt_r
|
||||||
except ImportError:
|
except ImportError:
|
||||||
@@ -16,7 +13,6 @@ from .dictproxy import DictProxy
|
|||||||
from .migrate_db import migrate_from_db_to_maildir
|
from .migrate_db import migrate_from_db_to_maildir
|
||||||
|
|
||||||
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
||||||
VALID_LOCALPART_RE = re.compile(r"^[a-z0-9._-]+$")
|
|
||||||
|
|
||||||
|
|
||||||
def encrypt_password(password: str):
|
def encrypt_password(password: str):
|
||||||
@@ -56,10 +52,6 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
if not VALID_LOCALPART_RE.match(localpart):
|
|
||||||
logging.warning("localpart %r contains invalid characters", localpart)
|
|
||||||
return False
|
|
||||||
|
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
@@ -148,13 +140,8 @@ class AuthDictProxy(DictProxy):
|
|||||||
if not is_allowed_to_create(self.config, addr, cleartext_password):
|
if not is_allowed_to_create(self.config, addr, cleartext_password):
|
||||||
return
|
return
|
||||||
|
|
||||||
lock = filelock.FileLock(str(user.password_path) + ".lock", timeout=5)
|
user.set_password(encrypt_password(cleartext_password))
|
||||||
with lock:
|
print(f"Created address: {addr}", file=sys.stderr)
|
||||||
userdata = user.get_userdb_dict()
|
|
||||||
if userdata:
|
|
||||||
return userdata
|
|
||||||
user.set_password(encrypt_password(cleartext_password))
|
|
||||||
print(f"Created address: {addr}", file=sys.stderr)
|
|
||||||
return user.get_userdb_dict()
|
return user.get_userdb_dict()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -91,10 +68,9 @@ class Report:
|
|||||||
for size in self.message_buckets:
|
for size in self.message_buckets:
|
||||||
for msg in mailbox.messages:
|
for msg in mailbox.messages:
|
||||||
if msg.size >= size:
|
if msg.size >= size:
|
||||||
if self.mdir and f"/{self.mdir}/" not in msg.path:
|
if self.mdir and not msg.relpath.startswith(self.mdir):
|
||||||
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__":
|
||||||
|
|||||||
@@ -101,11 +101,7 @@ class MetadataDictProxy(DictProxy):
|
|||||||
# Handle `GETMETADATA "" /shared/vendor/deltachat/irohrelay`
|
# Handle `GETMETADATA "" /shared/vendor/deltachat/irohrelay`
|
||||||
return f"O{self.iroh_relay}\n"
|
return f"O{self.iroh_relay}\n"
|
||||||
elif keyname == "vendor/vendor.dovecot/pvt/server/vendor/deltachat/turn":
|
elif keyname == "vendor/vendor.dovecot/pvt/server/vendor/deltachat/turn":
|
||||||
try:
|
res = turn_credentials()
|
||||||
res = turn_credentials()
|
|
||||||
except Exception:
|
|
||||||
logging.exception("failed to get TURN credentials")
|
|
||||||
return "N\n"
|
|
||||||
port = 3478
|
port = 3478
|
||||||
return f"O{self.turn_hostname}:{port}:{res}\n"
|
return f"O{self.turn_hostname}:{port}:{res}\n"
|
||||||
|
|
||||||
|
|||||||
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()
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
"""CGI script for creating new accounts."""
|
"""CGI script for creating new accounts."""
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
import random
|
||||||
import secrets
|
import secrets
|
||||||
import string
|
import string
|
||||||
from urllib.parse import quote
|
from urllib.parse import quote
|
||||||
@@ -15,9 +16,7 @@ ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
|||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(config: Config):
|
def create_newemail_dict(config: Config):
|
||||||
user = "".join(
|
user = "".join(random.choices(ALPHANUMERIC, k=config.username_max_length))
|
||||||
secrets.choice(ALPHANUMERIC) for _ in range(config.username_max_length)
|
|
||||||
)
|
|
||||||
password = "".join(
|
password = "".join(
|
||||||
secrets.choice(ALPHANUMERIC_PUNCT)
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
for _ in range(config.password_min_length + 3)
|
for _ in range(config.password_min_length + 3)
|
||||||
|
|||||||
@@ -120,60 +120,6 @@ def test_handle_dovecot_protocol_iterate(gencreds, example_config):
|
|||||||
assert not lines[2]
|
assert not lines[2]
|
||||||
|
|
||||||
|
|
||||||
def test_invalid_localpart_characters(make_config):
|
|
||||||
"""Test that is_allowed_to_create rejects localparts with invalid characters."""
|
|
||||||
config = make_config("chat.example.org", {"username_min_length": "3"})
|
|
||||||
password = "zequ0Aimuchoodaechik"
|
|
||||||
domain = config.mail_domain
|
|
||||||
|
|
||||||
# valid localparts
|
|
||||||
assert is_allowed_to_create(config, f"abc123@{domain}", password)
|
|
||||||
assert is_allowed_to_create(config, f"a.b-c_d@{domain}", password)
|
|
||||||
|
|
||||||
# uppercase rejected
|
|
||||||
assert not is_allowed_to_create(config, f"Abc123@{domain}", password)
|
|
||||||
assert not is_allowed_to_create(config, f"ABCDEFG@{domain}", password)
|
|
||||||
|
|
||||||
# spaces and special chars rejected
|
|
||||||
assert not is_allowed_to_create(config, f"a b cde@{domain}", password)
|
|
||||||
assert not is_allowed_to_create(config, f"abc+def@{domain}", password)
|
|
||||||
assert not is_allowed_to_create(config, f"abc!def@{domain}", password)
|
|
||||||
assert not is_allowed_to_create(config, f"ab@cdef@{domain}", password)
|
|
||||||
assert not is_allowed_to_create(config, f"abc/def@{domain}", password)
|
|
||||||
assert not is_allowed_to_create(config, f"abc\\def@{domain}", password)
|
|
||||||
|
|
||||||
|
|
||||||
def test_concurrent_creation_same_account(dictproxy):
|
|
||||||
"""Test that concurrent creation of the same account doesn't corrupt password."""
|
|
||||||
addr = "racetest1@chat.example.org"
|
|
||||||
password = "zequ0Aimuchoodaechik"
|
|
||||||
num_threads = 10
|
|
||||||
results = queue.Queue()
|
|
||||||
|
|
||||||
def create():
|
|
||||||
try:
|
|
||||||
res = dictproxy.lookup_passdb(addr, password)
|
|
||||||
results.put(("ok", res))
|
|
||||||
except Exception:
|
|
||||||
results.put(("err", traceback.format_exc()))
|
|
||||||
|
|
||||||
threads = [threading.Thread(target=create, daemon=True) for _ in range(num_threads)]
|
|
||||||
for t in threads:
|
|
||||||
t.start()
|
|
||||||
for t in threads:
|
|
||||||
t.join(timeout=10)
|
|
||||||
|
|
||||||
passwords_seen = set()
|
|
||||||
for _ in range(num_threads):
|
|
||||||
status, res = results.get()
|
|
||||||
if status == "err":
|
|
||||||
pytest.fail(f"concurrent creation failed\n{res}")
|
|
||||||
passwords_seen.add(res["password"])
|
|
||||||
|
|
||||||
# all threads must see the same password hash
|
|
||||||
assert len(passwords_seen) == 1
|
|
||||||
|
|
||||||
|
|
||||||
def test_50_concurrent_lookups_different_accounts(gencreds, dictproxy):
|
def test_50_concurrent_lookups_different_accounts(gencreds, dictproxy):
|
||||||
num_threads = 50
|
num_threads = 50
|
||||||
req_per_thread = 5
|
req_per_thread = 5
|
||||||
|
|||||||
@@ -112,43 +112,6 @@ def test_report(mbox1, example_config):
|
|||||||
report_main(args)
|
report_main(args)
|
||||||
|
|
||||||
|
|
||||||
def test_report_mdir_filters_by_path(mbox1, example_config):
|
|
||||||
"""Test that Report with mdir='cur' only counts messages in cur/ subdirectory."""
|
|
||||||
from chatmaild.fsreport import Report
|
|
||||||
|
|
||||||
now = datetime.utcnow().timestamp()
|
|
||||||
|
|
||||||
# Set password mtime to old enough so min_login_age check passes
|
|
||||||
password = Path(mbox1.basedir).joinpath("password")
|
|
||||||
old_time = now - 86400 * 10 # 10 days ago
|
|
||||||
os.utime(password, (old_time, old_time))
|
|
||||||
|
|
||||||
# Reload mailbox with updated mtime
|
|
||||||
from chatmaild.expire import MailboxStat
|
|
||||||
|
|
||||||
mbox = MailboxStat(mbox1.basedir)
|
|
||||||
|
|
||||||
# Report without mdir — should count all messages
|
|
||||||
rep_all = Report(now=now, min_login_age=1, mdir=None)
|
|
||||||
rep_all.process_mailbox_stat(mbox)
|
|
||||||
total_all = rep_all.message_buckets[0]
|
|
||||||
|
|
||||||
# Report with mdir='cur' — should only count cur/ messages
|
|
||||||
rep_cur = Report(now=now, min_login_age=1, mdir="cur")
|
|
||||||
rep_cur.process_mailbox_stat(mbox)
|
|
||||||
total_cur = rep_cur.message_buckets[0]
|
|
||||||
|
|
||||||
# Report with mdir='new' — should only count new/ messages
|
|
||||||
rep_new = Report(now=now, min_login_age=1, mdir="new")
|
|
||||||
rep_new.process_mailbox_stat(mbox)
|
|
||||||
total_new = rep_new.message_buckets[0]
|
|
||||||
|
|
||||||
# cur has 500-byte msg, new has 600-byte msg (from fill_mbox)
|
|
||||||
assert total_cur == 500
|
|
||||||
assert total_new == 600
|
|
||||||
assert total_all == 500 + 600
|
|
||||||
|
|
||||||
|
|
||||||
def test_expiry_cli_basic(example_config, mbox1):
|
def test_expiry_cli_basic(example_config, mbox1):
|
||||||
args = (str(example_config._inipath),)
|
args = (str(example_config._inipath),)
|
||||||
expiry_main(args)
|
expiry_main(args)
|
||||||
|
|||||||
@@ -314,51 +314,6 @@ def test_persistent_queue_items(tmp_path, testaddr, token):
|
|||||||
assert not queue_item < item2 and not item2 < queue_item
|
assert not queue_item < item2 and not item2 < queue_item
|
||||||
|
|
||||||
|
|
||||||
def test_turn_credentials_exception_returns_N(notifier, metadata, monkeypatch):
|
|
||||||
"""Test that turn_credentials() failure returns N\\n instead of crashing."""
|
|
||||||
import chatmaild.metadata
|
|
||||||
|
|
||||||
dictproxy = MetadataDictProxy(
|
|
||||||
notifier=notifier,
|
|
||||||
metadata=metadata,
|
|
||||||
turn_hostname="turn.example.org",
|
|
||||||
)
|
|
||||||
|
|
||||||
def mock_turn_credentials():
|
|
||||||
raise ConnectionRefusedError("socket not available")
|
|
||||||
|
|
||||||
monkeypatch.setattr(chatmaild.metadata, "turn_credentials", mock_turn_credentials)
|
|
||||||
|
|
||||||
transactions = {}
|
|
||||||
res = dictproxy.handle_dovecot_request(
|
|
||||||
"Lshared/0123/vendor/vendor.dovecot/pvt/server/vendor/deltachat/turn"
|
|
||||||
"\tuser@example.org",
|
|
||||||
transactions,
|
|
||||||
)
|
|
||||||
assert res == "N\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_turn_credentials_success(notifier, metadata, monkeypatch):
|
|
||||||
"""Test that valid turn_credentials() returns TURN URI."""
|
|
||||||
import chatmaild.metadata
|
|
||||||
|
|
||||||
dictproxy = MetadataDictProxy(
|
|
||||||
notifier=notifier,
|
|
||||||
metadata=metadata,
|
|
||||||
turn_hostname="turn.example.org",
|
|
||||||
)
|
|
||||||
|
|
||||||
monkeypatch.setattr(chatmaild.metadata, "turn_credentials", lambda: "user:pass")
|
|
||||||
|
|
||||||
transactions = {}
|
|
||||||
res = dictproxy.handle_dovecot_request(
|
|
||||||
"Lshared/0123/vendor/vendor.dovecot/pvt/server/vendor/deltachat/turn"
|
|
||||||
"\tuser@example.org",
|
|
||||||
transactions,
|
|
||||||
)
|
|
||||||
assert res == "Oturn.example.org:3478:user:pass\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_iroh_relay(dictproxy):
|
def test_iroh_relay(dictproxy):
|
||||||
rfile = io.BytesIO(
|
rfile = io.BytesIO(
|
||||||
b"\n".join(
|
b"\n".join(
|
||||||
|
|||||||
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,73 +0,0 @@
|
|||||||
import socket
|
|
||||||
import threading
|
|
||||||
import time
|
|
||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from chatmaild.turnserver import turn_credentials
|
|
||||||
|
|
||||||
SOCKET_PATH = "/run/chatmail-turn/turn.socket"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def turn_socket(tmp_path):
|
|
||||||
"""Create a real Unix socket server at a temp path."""
|
|
||||||
sock_path = str(tmp_path / "turn.socket")
|
|
||||||
server = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
|
||||||
server.bind(sock_path)
|
|
||||||
server.listen(1)
|
|
||||||
yield sock_path, server
|
|
||||||
server.close()
|
|
||||||
|
|
||||||
|
|
||||||
def _call_turn_credentials(sock_path):
|
|
||||||
"""Call turn_credentials but connect to sock_path instead of hardcoded path."""
|
|
||||||
original_connect = socket.socket.connect
|
|
||||||
|
|
||||||
def patched_connect(self, address):
|
|
||||||
if address == SOCKET_PATH:
|
|
||||||
address = sock_path
|
|
||||||
return original_connect(self, address)
|
|
||||||
|
|
||||||
with patch.object(socket.socket, "connect", patched_connect):
|
|
||||||
return turn_credentials()
|
|
||||||
|
|
||||||
|
|
||||||
def test_turn_credentials_timeout(turn_socket):
|
|
||||||
"""Server accepts but never responds — must raise socket.timeout."""
|
|
||||||
sock_path, server = turn_socket
|
|
||||||
|
|
||||||
def accept_and_hang():
|
|
||||||
conn, _ = server.accept()
|
|
||||||
time.sleep(30)
|
|
||||||
conn.close()
|
|
||||||
|
|
||||||
t = threading.Thread(target=accept_and_hang, daemon=True)
|
|
||||||
t.start()
|
|
||||||
|
|
||||||
with pytest.raises(socket.timeout):
|
|
||||||
_call_turn_credentials(sock_path)
|
|
||||||
|
|
||||||
|
|
||||||
def test_turn_credentials_connection_refused(tmp_path):
|
|
||||||
"""Socket file doesn't exist — must raise ConnectionRefusedError or FileNotFoundError."""
|
|
||||||
missing = str(tmp_path / "nonexistent.socket")
|
|
||||||
with pytest.raises((ConnectionRefusedError, FileNotFoundError)):
|
|
||||||
_call_turn_credentials(missing)
|
|
||||||
|
|
||||||
|
|
||||||
def test_turn_credentials_success(turn_socket):
|
|
||||||
"""Server responds with credentials — must return stripped string."""
|
|
||||||
sock_path, server = turn_socket
|
|
||||||
|
|
||||||
def respond():
|
|
||||||
conn, _ = server.accept()
|
|
||||||
conn.sendall(b"testuser:testpass\n")
|
|
||||||
conn.close()
|
|
||||||
|
|
||||||
t = threading.Thread(target=respond, daemon=True)
|
|
||||||
t.start()
|
|
||||||
|
|
||||||
result = _call_turn_credentials(sock_path)
|
|
||||||
assert result == "testuser:testpass"
|
|
||||||
@@ -4,7 +4,6 @@ import socket
|
|||||||
|
|
||||||
def turn_credentials() -> str:
|
def turn_credentials() -> str:
|
||||||
with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as client_socket:
|
with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as client_socket:
|
||||||
client_socket.settimeout(5)
|
|
||||||
client_socket.connect("/run/chatmail-turn/turn.socket")
|
client_socket.connect("/run/chatmail-turn/turn.socket")
|
||||||
with client_socket.makefile("rb") as file:
|
with client_socket.makefile("rb") as file:
|
||||||
return file.readline().decode("utf-8").strip()
|
return file.readline().decode("utf-8").strip()
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ class AcmetoolDeployer(Deployer):
|
|||||||
)
|
)
|
||||||
files.template(
|
files.template(
|
||||||
src=importlib.resources.files(__package__).joinpath("desired.yaml.j2"),
|
src=importlib.resources.files(__package__).joinpath("desired.yaml.j2"),
|
||||||
dest=f"/var/lib/acme/desired/{self.domains[0]}", # 0 is mailhost TLD
|
dest=f"/var/lib/acme/desired/{self.domains[0]}", # 0 is mailhost TLD
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
|
|||||||
@@ -119,18 +119,24 @@ def run_cmd(args, out):
|
|||||||
return 1
|
return 1
|
||||||
|
|
||||||
try:
|
try:
|
||||||
out.check_call(cmd, env=env)
|
retcode = out.check_call(cmd, env=env)
|
||||||
if args.website_only:
|
if args.website_only:
|
||||||
out.green("Website deployment completed.")
|
if retcode == 0:
|
||||||
|
out.green("Website deployment completed.")
|
||||||
|
else:
|
||||||
|
out.red("Website deployment failed.")
|
||||||
|
elif retcode == 0:
|
||||||
|
out.green("Deploy completed, call `cmdeploy dns` next.")
|
||||||
elif not args.dns_check_disabled and strict_tls and not remote_data["acme_account_url"]:
|
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("Deploy completed but letsencrypt not configured")
|
||||||
out.red("Run 'cmdeploy run' again")
|
out.red("Run 'cmdeploy run' again")
|
||||||
|
retcode = 0
|
||||||
else:
|
else:
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
out.red("Deploy failed")
|
||||||
return 0
|
|
||||||
except subprocess.CalledProcessError:
|
except subprocess.CalledProcessError:
|
||||||
out.red("Deploy failed")
|
out.red("Deploy failed")
|
||||||
return 1
|
retcode = 1
|
||||||
|
return retcode
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd_options(parser):
|
def dns_cmd_options(parser):
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ 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
|
||||||
@@ -123,6 +123,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 +134,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",
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -267,9 +271,6 @@ class WebsiteDeployer(Deployer):
|
|||||||
# if www_folder is a hugo page, build it
|
# if www_folder is a hugo page, build it
|
||||||
if build_dir:
|
if build_dir:
|
||||||
www_path = build_webpages(src_dir, build_dir, self.config)
|
www_path = build_webpages(src_dir, build_dir, self.config)
|
||||||
if www_path is None:
|
|
||||||
logger.warning("Web page build failed, skipping website deployment")
|
|
||||||
return
|
|
||||||
# if it is not a hugo page, upload it as is
|
# if it is not a hugo page, upload it as is
|
||||||
files.rsync(
|
files.rsync(
|
||||||
f"{www_path}/", "/var/www/html", flags=["-avz", "--chown=www-data"]
|
f"{www_path}/", "/var/www/html", flags=["-avz", "--chown=www-data"]
|
||||||
@@ -478,14 +479,6 @@ class ChatmailDeployer(Deployer):
|
|||||||
self.mail_domain = mail_domain
|
self.mail_domain = 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)
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import os
|
import os
|
||||||
import urllib.request
|
|
||||||
|
|
||||||
from chatmaild.config import Config
|
from chatmaild.config import Config
|
||||||
from pyinfra import host
|
from pyinfra import host
|
||||||
@@ -42,9 +41,7 @@ class DovecotDeployer(Deployer):
|
|||||||
restart = False if self.disable_mail else self.need_restart
|
restart = False if self.disable_mail else self.need_restart
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Disable dovecot for now"
|
name="Disable dovecot for now" if self.disable_mail else "Start and enable Dovecot",
|
||||||
if self.disable_mail
|
|
||||||
else "Start and enable Dovecot",
|
|
||||||
service="dovecot.service",
|
service="dovecot.service",
|
||||||
running=False if self.disable_mail else True,
|
running=False if self.disable_mail else True,
|
||||||
enabled=False if self.disable_mail else True,
|
enabled=False if self.disable_mail else True,
|
||||||
@@ -54,21 +51,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):
|
||||||
|
|||||||
@@ -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.5.2/filtermail-{arch}"
|
url = f"https://github.com/chatmail/filtermail/releases/download/v0.5.1/filtermail-{arch}"
|
||||||
sha256sum = {
|
sha256sum = {
|
||||||
"x86_64": "ce24ca0075aa445510291d775fb3aea8f4411818c7b885ae51a0fe18c5f789ce",
|
"x86_64": "adce2ddb461c5fd744df699f3b0b3c33b6d52413c641f18695b93826e5e0d234",
|
||||||
"aarch64": "c5d783eefa5332db3d97a0e6a23917d72849e3eb45da3d16ce908a9b4e5a797d",
|
"aarch64": "b51cf4248c6c443308f21b1811da1cc919b98b719a2138f4b60940ea093a5422",
|
||||||
}[arch]
|
}[arch]
|
||||||
self.need_restart |= files.download(
|
self.need_restart |= files.download(
|
||||||
name="Download filtermail",
|
name="Download filtermail",
|
||||||
|
|||||||
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
|
||||||
@@ -54,7 +54,7 @@ http {
|
|||||||
include /etc/nginx/mime.types;
|
include /etc/nginx/mime.types;
|
||||||
default_type application/octet-stream;
|
default_type application/octet-stream;
|
||||||
|
|
||||||
ssl_protocols TLSv1.2 TLSv1.3;
|
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
||||||
ssl_prefer_server_ciphers on;
|
ssl_prefer_server_ciphers on;
|
||||||
ssl_certificate {{ config.tls_cert_path }};
|
ssl_certificate {{ config.tls_cert_path }};
|
||||||
ssl_certificate_key {{ config.tls_key_path }};
|
ssl_certificate_key {{ config.tls_key_path }};
|
||||||
@@ -79,6 +79,10 @@ 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 config.tls_cert_mode != "self" %}
|
||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
|
|||||||
@@ -103,13 +103,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):
|
||||||
|
|||||||
@@ -97,9 +97,7 @@ class PostfixDeployer(Deployer):
|
|||||||
server.shell(
|
server.shell(
|
||||||
name="Validate postfix configuration",
|
name="Validate postfix configuration",
|
||||||
# Extract stderr and quit with error if non-zero
|
# Extract stderr and quit with error if non-zero
|
||||||
commands=[
|
commands=["""bash -c 'w=$(postconf 2>&1 >/dev/null); [[ -z "$w" ]] || { echo "$w"; false; }'"""],
|
||||||
"""bash -c 'w=$(postconf 2>&1 >/dev/null); [[ -z "$w" ]] || { echo "$w"; false; }'"""
|
|
||||||
],
|
|
||||||
)
|
)
|
||||||
self.need_restart = need_restart
|
self.need_restart = need_restart
|
||||||
|
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ def get_dkim_entry(mail_domain, pre_command, dkim_selector):
|
|||||||
print=log_progress,
|
print=log_progress,
|
||||||
)
|
)
|
||||||
except CalledProcessError:
|
except CalledProcessError:
|
||||||
return None, None
|
return
|
||||||
dkim_value_raw = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
dkim_value_raw = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
||||||
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))
|
||||||
|
|||||||
@@ -40,5 +40,5 @@ def dovecot_recalc_quota(user):
|
|||||||
#
|
#
|
||||||
for line in output.split("\n"):
|
for line in output.split("\n"):
|
||||||
parts = line.split()
|
parts = line.split()
|
||||||
if len(parts) >= 6 and parts[2] == "STORAGE":
|
if parts[2] == "STORAGE":
|
||||||
return dict(value=int(parts[3]), limit=int(parts[4]), percent=int(parts[5]))
|
return dict(value=int(parts[3]), limit=int(parts[4]), percent=int(parts[5]))
|
||||||
|
|||||||
@@ -60,29 +60,6 @@ def mockdns(request, mockdns_base, mockdns_expected):
|
|||||||
return mockdns_base
|
return mockdns_base
|
||||||
|
|
||||||
|
|
||||||
class TestGetDkimEntry:
|
|
||||||
def test_dkim_entry_returns_tuple_on_success(self, mockdns):
|
|
||||||
entry, web_entry = remote.rdns.get_dkim_entry(
|
|
||||||
"some.domain", "", dkim_selector="opendkim"
|
|
||||||
)
|
|
||||||
# May return None,None if openssl not available, but should never crash
|
|
||||||
if entry is not None:
|
|
||||||
assert "opendkim._domainkey.some.domain" in entry
|
|
||||||
assert "opendkim._domainkey.some.domain" in web_entry
|
|
||||||
|
|
||||||
def test_dkim_entry_returns_none_tuple_on_error(self, monkeypatch):
|
|
||||||
"""CalledProcessError must return (None, None), not bare None."""
|
|
||||||
from subprocess import CalledProcessError
|
|
||||||
|
|
||||||
def failing_shell(command, fail_ok=False, print=print):
|
|
||||||
raise CalledProcessError(1, command)
|
|
||||||
|
|
||||||
monkeypatch.setattr(remote.rdns, "shell", failing_shell)
|
|
||||||
result = remote.rdns.get_dkim_entry("some.domain", "", dkim_selector="opendkim")
|
|
||||||
assert result == (None, None)
|
|
||||||
assert result[0] is None and result[1] is None
|
|
||||||
|
|
||||||
|
|
||||||
class TestPerformInitialChecks:
|
class TestPerformInitialChecks:
|
||||||
def test_perform_initial_checks_ok1(self, mockdns, mockdns_expected):
|
def test_perform_initial_checks_ok1(self, mockdns, mockdns_expected):
|
||||||
remote_data = remote.rdns.perform_initial_checks("some.domain")
|
remote_data = remote.rdns.perform_initial_checks("some.domain")
|
||||||
|
|||||||
@@ -1,68 +0,0 @@
|
|||||||
from unittest.mock import patch
|
|
||||||
|
|
||||||
from cmdeploy.remote.rshell import dovecot_recalc_quota
|
|
||||||
|
|
||||||
|
|
||||||
def test_dovecot_recalc_quota_normal_output():
|
|
||||||
"""Normal doveadm output returns parsed dict."""
|
|
||||||
normal_output = (
|
|
||||||
"Quota name Type Value Limit %\n"
|
|
||||||
"User quota STORAGE 5 102400 0\n"
|
|
||||||
"User quota MESSAGE 2 - 0\n"
|
|
||||||
)
|
|
||||||
|
|
||||||
with patch("cmdeploy.remote.rshell.shell", return_value=normal_output):
|
|
||||||
result = dovecot_recalc_quota("user@example.org")
|
|
||||||
|
|
||||||
# shell is called twice (recalc + get), patch returns same for both
|
|
||||||
assert result == {"value": 5, "limit": 102400, "percent": 0}
|
|
||||||
|
|
||||||
|
|
||||||
def test_dovecot_recalc_quota_empty_output():
|
|
||||||
"""Empty doveadm output (trailing newline) must not IndexError."""
|
|
||||||
call_count = [0]
|
|
||||||
|
|
||||||
def mock_shell(cmd):
|
|
||||||
call_count[0] += 1
|
|
||||||
if "recalc" in cmd:
|
|
||||||
return ""
|
|
||||||
# quota get returns only empty lines
|
|
||||||
return "\n\n"
|
|
||||||
|
|
||||||
with patch("cmdeploy.remote.rshell.shell", side_effect=mock_shell):
|
|
||||||
result = dovecot_recalc_quota("user@example.org")
|
|
||||||
|
|
||||||
assert result is None
|
|
||||||
|
|
||||||
|
|
||||||
def test_dovecot_recalc_quota_malformed_output():
|
|
||||||
"""Malformed output with too few columns must not crash."""
|
|
||||||
call_count = [0]
|
|
||||||
|
|
||||||
def mock_shell(cmd):
|
|
||||||
call_count[0] += 1
|
|
||||||
if "recalc" in cmd:
|
|
||||||
return ""
|
|
||||||
# partial line, fewer than 6 parts
|
|
||||||
return "Quota name\nUser quota STORAGE\n"
|
|
||||||
|
|
||||||
with patch("cmdeploy.remote.rshell.shell", side_effect=mock_shell):
|
|
||||||
result = dovecot_recalc_quota("user@example.org")
|
|
||||||
|
|
||||||
assert result is None
|
|
||||||
|
|
||||||
|
|
||||||
def test_dovecot_recalc_quota_header_only():
|
|
||||||
"""Only header line, no data rows."""
|
|
||||||
call_count = [0]
|
|
||||||
|
|
||||||
def mock_shell(cmd):
|
|
||||||
call_count[0] += 1
|
|
||||||
if "recalc" in cmd:
|
|
||||||
return ""
|
|
||||||
return "Quota name Type Value Limit %\n"
|
|
||||||
|
|
||||||
with patch("cmdeploy.remote.rshell.shell", side_effect=mock_shell):
|
|
||||||
result = dovecot_recalc_quota("user@example.org")
|
|
||||||
|
|
||||||
assert result is None
|
|
||||||
@@ -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;
|
||||||
|
|||||||
Reference in New Issue
Block a user