mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 16:34:39 +00:00
Compare commits
40 Commits
link2xt/mx
...
draft-init
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
805d743e9e | ||
|
|
b0d5ee084e | ||
|
|
56c7853e5b | ||
|
|
071d708a89 | ||
|
|
c7c7ed8ff2 | ||
|
|
0aa0ef8a74 | ||
|
|
0662e3a8b1 | ||
|
|
6c453f93a1 | ||
|
|
54f29f6bae | ||
|
|
ad8fee76cd | ||
|
|
528cd3da25 | ||
|
|
5734e00625 | ||
|
|
947e1d6f89 | ||
|
|
33423459fe | ||
|
|
c70b72a21a | ||
|
|
33352f4694 | ||
|
|
59083ad16a | ||
|
|
11518c2ef4 | ||
|
|
a0cdfe6126 | ||
|
|
c25eefccc4 | ||
|
|
8b878e38cf | ||
|
|
9e1e6d3c69 | ||
|
|
a1c817d758 | ||
|
|
ccc552f852 | ||
|
|
73768256f6 | ||
|
|
34f7b3c0d3 | ||
|
|
e2828f4103 | ||
|
|
df515bea41 | ||
|
|
5614f03611 | ||
|
|
70443545d7 | ||
|
|
10ef842061 | ||
|
|
98f92cd9b6 | ||
|
|
fe99b97386 | ||
|
|
542decf798 | ||
|
|
2e7f8483b3 | ||
|
|
5c58e625f0 | ||
|
|
009f549619 | ||
|
|
99d36235fe | ||
|
|
b52a8c969f | ||
|
|
8520a9d8f2 |
4
.github/CODE_OF_CONDUCT.md
vendored
4
.github/CODE_OF_CONDUCT.md
vendored
@@ -1,4 +0,0 @@
|
|||||||
|
|
||||||
Please refer to
|
|
||||||
[Delta Chat community standards and practices](https://delta.chat/en/community-standards)
|
|
||||||
which also apply for all chatmail developments.
|
|
||||||
9
.github/workflows/ci.yaml
vendored
9
.github/workflows/ci.yaml
vendored
@@ -9,7 +9,7 @@ jobs:
|
|||||||
name: isolated chatmaild tests
|
name: isolated chatmaild tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
@@ -19,7 +19,7 @@ jobs:
|
|||||||
name: deploy-chatmail tests
|
name: deploy-chatmail tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: initenv
|
- name: initenv
|
||||||
run: scripts/initenv.sh
|
run: scripts/initenv.sh
|
||||||
@@ -31,7 +31,10 @@ jobs:
|
|||||||
run: cmdeploy fmt -v
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest tests
|
||||||
|
|
||||||
|
- name: initialize with chatmail domain
|
||||||
|
run: cmdeploy init chat.example.org
|
||||||
|
|
||||||
# all other cmdeploy commands require a staging server
|
# all other cmdeploy commands require a staging server
|
||||||
# see https://github.com/deltachat/chatmail/issues/100
|
# see https://github.com/deltachat/chatmail/issues/100
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
;; Zone file for staging-ipv4.testrun.org
|
|
||||||
|
|
||||||
$ORIGIN staging-ipv4.testrun.org.
|
|
||||||
$TTL 300
|
|
||||||
|
|
||||||
@ IN SOA ns.testrun.org. root.nine.testrun.org (
|
|
||||||
2023010101 ; Serial
|
|
||||||
7200 ; Refresh
|
|
||||||
3600 ; Retry
|
|
||||||
1209600 ; Expire
|
|
||||||
3600 ; Negative response caching TTL
|
|
||||||
)
|
|
||||||
|
|
||||||
;; Nameservers.
|
|
||||||
@ IN NS ns.testrun.org.
|
|
||||||
|
|
||||||
;; DNS records.
|
|
||||||
@ IN A 37.27.95.249
|
|
||||||
mta-sts.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
|
||||||
iroh.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
|
||||||
www.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
|
||||||
mx.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
;; Zone file for staging2.testrun.org
|
|
||||||
|
|
||||||
$ORIGIN staging2.testrun.org.
|
|
||||||
$TTL 300
|
|
||||||
|
|
||||||
@ IN SOA ns.testrun.org. root.nine.testrun.org (
|
|
||||||
2023010101 ; Serial
|
|
||||||
7200 ; Refresh
|
|
||||||
3600 ; Retry
|
|
||||||
1209600 ; Expire
|
|
||||||
3600 ; Negative response caching TTL
|
|
||||||
)
|
|
||||||
|
|
||||||
;; Nameservers.
|
|
||||||
@ IN NS ns.testrun.org.
|
|
||||||
|
|
||||||
;; DNS records.
|
|
||||||
@ IN A 37.27.24.139
|
|
||||||
mta-sts.staging2.testrun.org. CNAME staging2.testrun.org.
|
|
||||||
iroh.staging2.testrun.org. CNAME staging2.testrun.org.
|
|
||||||
www.staging2.testrun.org. CNAME staging2.testrun.org.
|
|
||||||
mx.staging2.testrun.org. CNAME staging2.testrun.org.
|
|
||||||
|
|
||||||
100
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
100
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
@@ -1,100 +0,0 @@
|
|||||||
name: deploy on staging-ipv4.testrun.org, and run tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
|
||||||
- 'scripts/**'
|
|
||||||
- '**/README.md'
|
|
||||||
- 'CHANGELOG.md'
|
|
||||||
- 'LICENSE'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
name: deploy on staging-ipv4.testrun.org, and run tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 30
|
|
||||||
concurrency:
|
|
||||||
group: ci-ipv4-${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: ${{ !contains(github.ref, '$GITHUB_REF') }}
|
|
||||||
steps:
|
|
||||||
- uses: jsok/serialize-workflow-action@v1
|
|
||||||
with:
|
|
||||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: prepare SSH
|
|
||||||
run: |
|
|
||||||
mkdir ~/.ssh
|
|
||||||
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
|
||||||
chmod 600 ~/.ssh/id_ed25519
|
|
||||||
ssh-keyscan staging-ipv4.testrun.org > ~/.ssh/known_hosts
|
|
||||||
# save previous acme & dkim state
|
|
||||||
rsync -avz root@staging-ipv4.testrun.org:/var/lib/acme acme-ipv4 || true
|
|
||||||
rsync -avz root@staging-ipv4.testrun.org:/etc/dkimkeys dkimkeys-ipv4 || true
|
|
||||||
# store previous acme & dkim state on ns.testrun.org, if it contains useful certs
|
|
||||||
if [ -f dkimkeys-ipv4/dkimkeys/opendkim.private ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" dkimkeys-ipv4 root@ns.testrun.org:/tmp/ || true; fi
|
|
||||||
if [ "$(ls -A acme-ipv4/acme/certs)" ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" acme-ipv4 root@ns.testrun.org:/tmp/ || true; fi
|
|
||||||
# make sure CAA record isn't set
|
|
||||||
scp .github/workflows/staging-ipv4.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging-ipv4.testrun.org.zone
|
|
||||||
ssh -o StrictHostKeyChecking=accept-new root@ns.testrun.org sed -i '/CAA/d' /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
|
|
||||||
|
|
||||||
- name: rebuild staging-ipv4.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: 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 staging-ipv4.testrun.org VPS is rebuilt --- "
|
|
||||||
rm ~/.ssh/known_hosts
|
|
||||||
while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org id -u ; do sleep 1 ; done
|
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.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-ipv4 acme-restore || true
|
|
||||||
rsync -avz root@ns.testrun.org:/tmp/dkimkeys-ipv4 dkimkeys-restore || true
|
|
||||||
# restore acme & dkim state to staging2.testrun.org
|
|
||||||
rsync -avz acme-restore/acme-ipv4/acme root@staging-ipv4.testrun.org:/var/lib/ || true
|
|
||||||
rsync -avz dkimkeys-restore/dkimkeys-ipv4/dkimkeys root@staging-ipv4.testrun.org:/etc/ || true
|
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
|
||||||
|
|
||||||
- name: run formatting checks
|
|
||||||
run: cmdeploy fmt -v
|
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
|
||||||
run: pytest --pyargs cmdeploy
|
|
||||||
|
|
||||||
- run: |
|
|
||||||
cmdeploy init staging-ipv4.testrun.org
|
|
||||||
sed -i 's#disable_ipv6 = False#disable_ipv6 = True#' chatmail.ini
|
|
||||||
|
|
||||||
- run: cmdeploy run
|
|
||||||
|
|
||||||
- name: set DNS entries
|
|
||||||
run: |
|
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
|
||||||
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
|
|
||||||
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 systemctl reload nsd
|
|
||||||
|
|
||||||
- name: cmdeploy test
|
|
||||||
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
|
||||||
|
|
||||||
- name: cmdeploy dns
|
|
||||||
run: cmdeploy dns -v
|
|
||||||
|
|
||||||
98
.github/workflows/test-and-deploy.yaml
vendored
98
.github/workflows/test-and-deploy.yaml
vendored
@@ -1,98 +0,0 @@
|
|||||||
name: deploy on staging2.testrun.org, and run tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
|
||||||
- 'scripts/**'
|
|
||||||
- '**/README.md'
|
|
||||||
- 'CHANGELOG.md'
|
|
||||||
- 'LICENSE'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
name: deploy on staging2.testrun.org, and run tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 30
|
|
||||||
concurrency:
|
|
||||||
group: ci-${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: ${{ !contains(github.ref, '$GITHUB_REF') }}
|
|
||||||
steps:
|
|
||||||
- uses: jsok/serialize-workflow-action@v1
|
|
||||||
with:
|
|
||||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: prepare SSH
|
|
||||||
run: |
|
|
||||||
mkdir ~/.ssh
|
|
||||||
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
|
||||||
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
|
|
||||||
|
|
||||||
- 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: 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: run formatting checks
|
|
||||||
run: cmdeploy fmt -v
|
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
|
||||||
run: pytest --pyargs cmdeploy
|
|
||||||
|
|
||||||
- run: cmdeploy init staging2.testrun.org
|
|
||||||
|
|
||||||
- run: cmdeploy run --verbose
|
|
||||||
|
|
||||||
- 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=nine.testrun.org cmdeploy test --slow
|
|
||||||
|
|
||||||
- name: cmdeploy dns
|
|
||||||
run: cmdeploy dns -v
|
|
||||||
|
|
||||||
254
CHANGELOG.md
254
CHANGELOG.md
@@ -1,254 +0,0 @@
|
|||||||
# Changelog for chatmail deployment
|
|
||||||
|
|
||||||
## untagged
|
|
||||||
|
|
||||||
- deploy `iroh-relay` and also update "realtime relay services" in privacy policy.
|
|
||||||
([#434](https://github.com/deltachat/chatmail/pull/434))
|
|
||||||
([#451](https://github.com/deltachat/chatmail/pull/451))
|
|
||||||
|
|
||||||
- add guide to migrate chatmail to a new server
|
|
||||||
([#429](https://github.com/deltachat/chatmail/pull/429))
|
|
||||||
|
|
||||||
- disable anvil authentication penalty
|
|
||||||
([#414](https://github.com/deltachat/chatmail/pull/444)
|
|
||||||
|
|
||||||
- increase `request_queue_size` for UNIX sockets to 1000.
|
|
||||||
([#437](https://github.com/deltachat/chatmail/pull/437))
|
|
||||||
|
|
||||||
- add argument to `cmdeploy run` for specifying
|
|
||||||
a different SSH host than `mail_domain`
|
|
||||||
([#439](https://github.com/deltachat/chatmail/pull/439))
|
|
||||||
|
|
||||||
- query autoritative nameserver to bypass DNS cache
|
|
||||||
([#424](https://github.com/deltachat/chatmail/pull/424))
|
|
||||||
|
|
||||||
- add mtail support (new optional `mtail_address` ini value)
|
|
||||||
This defines the address on which [`mtail`](https://google.github.io/mtail/)
|
|
||||||
exposes its metrics collected from the logs.
|
|
||||||
If you want to collect the metrics with Prometheus,
|
|
||||||
setup a private network (e.g. WireGuard interface)
|
|
||||||
and assign an IP address from this network to the host.
|
|
||||||
If you do not plan to collect metrics,
|
|
||||||
keep this setting unset.
|
|
||||||
([#388](https://github.com/deltachat/chatmail/pull/388))
|
|
||||||
|
|
||||||
- fix checking for required DNS records
|
|
||||||
([#412](https://github.com/deltachat/chatmail/pull/412))
|
|
||||||
|
|
||||||
- add support for specifying whole domains for recipient passthrough list
|
|
||||||
([#408](https://github.com/deltachat/chatmail/pull/408))
|
|
||||||
|
|
||||||
- add a paragraph about "account deletion" to info page
|
|
||||||
([#405](https://github.com/deltachat/chatmail/pull/405))
|
|
||||||
|
|
||||||
- avoid nginx listening on ipv6 if v6 is dsiabled
|
|
||||||
([#402](https://github.com/deltachat/chatmail/pull/402))
|
|
||||||
|
|
||||||
- refactor ssh-based execution to allow organizing remote functions in
|
|
||||||
modules.
|
|
||||||
([#396](https://github.com/deltachat/chatmail/pull/396))
|
|
||||||
|
|
||||||
- trigger "apt upgrade" during "cmdeploy run"
|
|
||||||
([#398](https://github.com/deltachat/chatmail/pull/398))
|
|
||||||
|
|
||||||
- drop hispanilandia passthrough address
|
|
||||||
([#401](https://github.com/deltachat/chatmail/pull/401))
|
|
||||||
|
|
||||||
- set CAA record flags to 0
|
|
||||||
|
|
||||||
- add IMAP capabilities instead of overwriting them
|
|
||||||
([#413](https://github.com/deltachat/chatmail/pull/413))
|
|
||||||
|
|
||||||
- fix OpenPGP payload check
|
|
||||||
([#435](https://github.com/deltachat/chatmail/pull/435))
|
|
||||||
|
|
||||||
- fix Dovecot quota_max_mail_size to use max_message_size config value
|
|
||||||
([#438](https://github.com/deltachat/chatmail/pull/438))
|
|
||||||
|
|
||||||
- Move MX record to its own subdomain
|
|
||||||
([#403](https://github.com/deltachat/chatmail/pull/403))
|
|
||||||
|
|
||||||
## 1.4.1 2024-07-31
|
|
||||||
|
|
||||||
- fix metadata dictproxy which would confuse transactions
|
|
||||||
resulting in missed notifications and other issues.
|
|
||||||
([#393](https://github.com/deltachat/chatmail/pull/393))
|
|
||||||
([#394](https://github.com/deltachat/chatmail/pull/394))
|
|
||||||
|
|
||||||
- add optional "imap_rawlog" config option. If true,
|
|
||||||
.in/.out files are created in user home dirs
|
|
||||||
containing the imap protocol messages.
|
|
||||||
([#389](https://github.com/deltachat/chatmail/pull/389))
|
|
||||||
|
|
||||||
## 1.4.0 2024-07-28
|
|
||||||
|
|
||||||
- Add `disable_ipv6` config option to chatmail.ini.
|
|
||||||
Required if the server doesn't have IPv6 connectivity.
|
|
||||||
([#312](https://github.com/deltachat/chatmail/pull/312))
|
|
||||||
|
|
||||||
- allow current K9/Thunderbird-mail releases to send encrypted messages
|
|
||||||
outside by accepting their localized "encrypted subject" strings.
|
|
||||||
([#370](https://github.com/deltachat/chatmail/pull/370))
|
|
||||||
|
|
||||||
- Migrate and remove sqlite database in favor of password/lastlogin tracking
|
|
||||||
in a user's maildir.
|
|
||||||
([#379](https://github.com/deltachat/chatmail/pull/379))
|
|
||||||
|
|
||||||
- Require pyinfra V3 installed on the client side,
|
|
||||||
run `./scripts/initenv.sh` to upgrade locally.
|
|
||||||
([#378](https://github.com/deltachat/chatmail/pull/378))
|
|
||||||
|
|
||||||
- don't hardcode "/home/vmail" paths but rather set them
|
|
||||||
once in the config object and use it everywhere else,
|
|
||||||
thereby also improving testability.
|
|
||||||
([#351](https://github.com/deltachat/chatmail/pull/351))
|
|
||||||
temporarily introduced obligatory "passdb_path" and "mailboxes_dir"
|
|
||||||
settings but they were removed/obsoleted in
|
|
||||||
([#380](https://github.com/deltachat/chatmail/pull/380))
|
|
||||||
|
|
||||||
- BREAKING: new required chatmail.ini value 'delete_inactive_users_after = 100'
|
|
||||||
which removes users from database and mails after 100 days without any login.
|
|
||||||
([#350](https://github.com/deltachat/chatmail/pull/350))
|
|
||||||
|
|
||||||
- Refine DNS checking to distinguish between "required" and "recommended" settings
|
|
||||||
([#372](https://github.com/deltachat/chatmail/pull/372))
|
|
||||||
|
|
||||||
- reload nginx in the acmetool cronjob
|
|
||||||
([#360](https://github.com/deltachat/chatmail/pull/360))
|
|
||||||
|
|
||||||
- remove checking of reverse-DNS PTR records. Chatmail-servers don't
|
|
||||||
depend on it and even in the wider e-mail system it's not common anymore.
|
|
||||||
If it's an issue, a chatmail operator can still care to properly set reverse DNS.
|
|
||||||
([#348](https://github.com/deltachat/chatmail/pull/348))
|
|
||||||
|
|
||||||
- Make DNS-checking faster and more interactive, run it fully during "cmdeploy run",
|
|
||||||
also introducing a generic mechanism for rapid remote ssh-based python function execution.
|
|
||||||
([#346](https://github.com/deltachat/chatmail/pull/346))
|
|
||||||
|
|
||||||
- Don't fix file owner ship of /home/vmail
|
|
||||||
([#345](https://github.com/deltachat/chatmail/pull/345))
|
|
||||||
|
|
||||||
- Support iterating over all users with doveadm commands
|
|
||||||
([#344](https://github.com/deltachat/chatmail/pull/344))
|
|
||||||
|
|
||||||
- Test and fix for attempts to create inadmissible accounts
|
|
||||||
([#333](https://github.com/deltachat/chatmail/pull/321))
|
|
||||||
|
|
||||||
- check that OpenPGP has only PKESK, SKESK and SEIPD packets
|
|
||||||
([#323](https://github.com/deltachat/chatmail/pull/323),
|
|
||||||
[#324](https://github.com/deltachat/chatmail/pull/324))
|
|
||||||
|
|
||||||
- improve filtermail checks for encrypted messages and drop support for unencrypted MDNs
|
|
||||||
([#320](https://github.com/deltachat/chatmail/pull/320))
|
|
||||||
|
|
||||||
- replace `bash` with `/bin/sh`
|
|
||||||
([#334](https://github.com/deltachat/chatmail/pull/334))
|
|
||||||
|
|
||||||
- Increase number of logged in IMAP sessions to 50000
|
|
||||||
([#335](https://github.com/deltachat/chatmail/pull/335))
|
|
||||||
|
|
||||||
- filtermail: do not allow ASCII armor without actual payload
|
|
||||||
([#325](https://github.com/deltachat/chatmail/pull/325))
|
|
||||||
|
|
||||||
- Remove sieve to enable hardlink deduplication in LMTP
|
|
||||||
([#343](https://github.com/deltachat/chatmail/pull/343))
|
|
||||||
|
|
||||||
- dovecot: enable gzip compression on disk
|
|
||||||
([#341](https://github.com/deltachat/chatmail/pull/341))
|
|
||||||
|
|
||||||
- DKIM-sign Content-Type and oversign all signed headers
|
|
||||||
([#296](https://github.com/deltachat/chatmail/pull/296))
|
|
||||||
|
|
||||||
- Add nonci_accounts metric
|
|
||||||
([#347](https://github.com/deltachat/chatmail/pull/347))
|
|
||||||
|
|
||||||
- doveauth: log when a new account is created
|
|
||||||
([#349](https://github.com/deltachat/chatmail/pull/349))
|
|
||||||
|
|
||||||
- Multiplex HTTPS, IMAP and SMTP on port 443
|
|
||||||
([#357](https://github.com/deltachat/chatmail/pull/357))
|
|
||||||
|
|
||||||
## 1.3.0 - 2024-06-06
|
|
||||||
|
|
||||||
- don't check necessary DNS records on cmdeploy init anymore
|
|
||||||
([#316](https://github.com/deltachat/chatmail/pull/316))
|
|
||||||
|
|
||||||
- ensure cron and acl are installed
|
|
||||||
([#293](https://github.com/deltachat/chatmail/pull/293),
|
|
||||||
[#310](https://github.com/deltachat/chatmail/pull/310))
|
|
||||||
|
|
||||||
- change default for delete_mails_after from 40 to 20 days
|
|
||||||
([#300](https://github.com/deltachat/chatmail/pull/300))
|
|
||||||
|
|
||||||
- save journald logs only to memory and save nginx logs to journald instead of file
|
|
||||||
([#299](https://github.com/deltachat/chatmail/pull/299))
|
|
||||||
|
|
||||||
- fix writing of multiple obs repositories in `/etc/apt/sources.list`
|
|
||||||
([#290](https://github.com/deltachat/chatmail/pull/290))
|
|
||||||
|
|
||||||
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
|
||||||
([#284](https://github.com/deltachat/chatmail/pull/284))
|
|
||||||
|
|
||||||
- Emit "XCHATMAIL" capability from IMAP server
|
|
||||||
([#278](https://github.com/deltachat/chatmail/pull/278))
|
|
||||||
|
|
||||||
- Move echobot `into /var/lib/echobot`
|
|
||||||
([#281](https://github.com/deltachat/chatmail/pull/281))
|
|
||||||
|
|
||||||
- Accept Let's Encrypt's new Terms of Services
|
|
||||||
([#275](https://github.com/deltachat/chatmail/pull/276))
|
|
||||||
|
|
||||||
- Reload Dovecot and Postfix when TLS certificate updates
|
|
||||||
([#271](https://github.com/deltachat/chatmail/pull/271))
|
|
||||||
|
|
||||||
- Use forked version of dovecot without hardcoded delays
|
|
||||||
([#270](https://github.com/deltachat/chatmail/pull/270))
|
|
||||||
|
|
||||||
## 1.2.0 - 2024-04-04
|
|
||||||
|
|
||||||
- Install dig on the server to resolve DNS records
|
|
||||||
([#267](https://github.com/deltachat/chatmail/pull/267))
|
|
||||||
|
|
||||||
- preserve notification order and exponentially backoff with
|
|
||||||
retries for tokens where we didn't get a successful return
|
|
||||||
([#265](https://github.com/deltachat/chatmail/pull/263))
|
|
||||||
|
|
||||||
- Run chatmail-metadata and doveauth as vmail
|
|
||||||
([#261](https://github.com/deltachat/chatmail/pull/261))
|
|
||||||
|
|
||||||
- Apply systemd restrictions to echobot
|
|
||||||
([#259](https://github.com/deltachat/chatmail/pull/259))
|
|
||||||
|
|
||||||
- re-enable running the CI in pull requests, but not concurrently
|
|
||||||
([#258](https://github.com/deltachat/chatmail/pull/258))
|
|
||||||
|
|
||||||
|
|
||||||
## 1.1.0 - 2024-03-28
|
|
||||||
|
|
||||||
### The changelog starts to record changes from March 15th, 2024
|
|
||||||
|
|
||||||
- Move systemd unit templates to cmdeploy package
|
|
||||||
([#255](https://github.com/deltachat/chatmail/pull/255))
|
|
||||||
|
|
||||||
- Persist push tokens and support multiple device per address
|
|
||||||
([#254](https://github.com/deltachat/chatmail/pull/254))
|
|
||||||
|
|
||||||
- Avoid warning for regular doveauth protocol's hello message.
|
|
||||||
([#250](https://github.com/deltachat/chatmail/pull/250))
|
|
||||||
|
|
||||||
- Fix various tests to pass again with "cmdeploy test".
|
|
||||||
([#245](https://github.com/deltachat/chatmail/pull/245),
|
|
||||||
[#242](https://github.com/deltachat/chatmail/pull/242)
|
|
||||||
|
|
||||||
- Ensure lets-encrypt certificates are reloaded after renewal
|
|
||||||
([#244]) https://github.com/deltachat/chatmail/pull/244
|
|
||||||
|
|
||||||
- Persist tokens to avoid iOS users loosing push-notifications when the
|
|
||||||
chatmail metadata service is restarted (happens regularly during deploys)
|
|
||||||
([#238](https://github.com/deltachat/chatmail/pull/239)
|
|
||||||
|
|
||||||
- Fix failing sieve-script compile errors on incoming messages
|
|
||||||
([#237](https://github.com/deltachat/chatmail/pull/239)
|
|
||||||
|
|
||||||
- Fix quota reporting after expunging of old mails
|
|
||||||
([#233](https://github.com/deltachat/chatmail/pull/239)
|
|
||||||
21
LICENSE
21
LICENSE
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2023, chatmail and delta chat teams
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
|
||||||
the Software without restriction, including without limitation the rights to
|
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
||||||
of the Software, and to permit persons to whom the Software is furnished to do
|
|
||||||
so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
444
README.md
444
README.md
@@ -15,426 +15,146 @@ after which the initially specified password is required for using them.
|
|||||||
|
|
||||||
## Deploying your own chatmail server
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
To deploy chatmail on your own server, you must have set-up ssh authentication and need to use an ed25519 key, due to an [upstream bug in paramiko](https://github.com/paramiko/paramiko/issues/2191). You also need to add your private key to the local ssh-agent, because you can't type in your password during deployment.
|
We subsequently use `CHATMAIL_DOMAIN` as a placeholder for your fully qualified
|
||||||
|
DNS domain name (FQDN), for example `chat.example.org`.
|
||||||
|
|
||||||
We use `chat.example.org` as the chatmail domain in the following steps.
|
1. Setup DNS `A` and `AAAA` records for your `CHATMAIL_DOMAIN`.
|
||||||
Please substitute it with your own domain.
|
Verify that DNS is set and SSH root login works:
|
||||||
|
|
||||||
1. Install the `cmdeploy` command in a virtualenv
|
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/deltachat/chatmail
|
ssh root@CHATMAIL_DOMAIN
|
||||||
cd chatmail
|
|
||||||
scripts/initenv.sh
|
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create chatmail configuration file `chatmail.ini`:
|
2. Install the `cmdeploy` command in a virtualenv
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy init chat.example.org # <-- use your domain
|
source scripts/initenv.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Point your domain to the server's IP address,
|
3. Create chatmail configuration file `chatmail.ini`:
|
||||||
if you haven't done so already.
|
|
||||||
Verify that SSH root login works:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
ssh root@chat.example.org # <-- use your domain
|
cmdeploy init CHATMAIL_DOMAIN
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Deploy to the remote chatmail server:
|
4. Deploy to the remote chatmail server:
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy run
|
cmdeploy run
|
||||||
```
|
```
|
||||||
This script will check that you have all necessary DNS records.
|
|
||||||
If DNS records are missing, it will recommend
|
|
||||||
which you should configure at your DNS provider
|
|
||||||
(it can take some time until they are public).
|
|
||||||
|
|
||||||
### Other helpful commands:
|
5. To output a DNS zone file from which you can transfer DNS records
|
||||||
|
to your DNS provider:
|
||||||
|
|
||||||
To check the status of your remotely running chatmail service:
|
```
|
||||||
|
cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
```
|
6. To check status of your remotely running chatmail service:
|
||||||
scripts/cmdeploy status
|
|
||||||
|
```
|
||||||
|
cmdeploy status
|
||||||
|
```
|
||||||
|
|
||||||
|
7. To test your chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
cmdeploy test
|
||||||
|
```
|
||||||
|
|
||||||
|
8. To benchmark your chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
cmdeploy bench
|
||||||
|
```
|
||||||
|
|
||||||
|
### Refining the web pages
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
cmdeploy webdev
|
||||||
```
|
```
|
||||||
|
|
||||||
To display and check all recommended DNS records:
|
This starts a local live development cycle for chatmail Web pages:
|
||||||
|
|
||||||
```
|
- uses the `www/src/page-layout.html` file for producing static
|
||||||
scripts/cmdeploy dns
|
HTML pages from `www/src/*.md` files
|
||||||
```
|
|
||||||
|
|
||||||
To test whether your chatmail service is working correctly:
|
- continously builds the web presence reading files from `www/src` directory
|
||||||
|
and generating html files and copying assets to the `www/build` directory.
|
||||||
|
|
||||||
```
|
- Starts a browser window automatically where you can "refresh" as needed.
|
||||||
scripts/cmdeploy test
|
|
||||||
```
|
|
||||||
|
|
||||||
To measure the performance of your chatmail service:
|
|
||||||
|
|
||||||
```
|
### Home page and getting started for users
|
||||||
scripts/cmdeploy bench
|
|
||||||
```
|
|
||||||
|
|
||||||
## Overview of this repository
|
`cmdeploy run` sets up mail services,
|
||||||
|
and also creates default static Web pages and deploys them:
|
||||||
|
|
||||||
This repository has four directories:
|
- a default `index.html` along with a QR code that users can click to
|
||||||
|
|
||||||
- [cmdeploy](https://github.com/deltachat/chatmail/tree/main/cmdeploy)
|
|
||||||
is a collection of configuration files
|
|
||||||
and a [pyinfra](https://pyinfra.com)-based deployment script.
|
|
||||||
|
|
||||||
- [chatmaild](https://github.com/deltachat/chatmail/tree/main/chatmaild)
|
|
||||||
is a python package containing several small services
|
|
||||||
which handle authentication,
|
|
||||||
trigger push notifications on new messages,
|
|
||||||
ensure that outbound mails are encrypted,
|
|
||||||
delete inactive users,
|
|
||||||
and some other minor things.
|
|
||||||
chatmaild can also be installed as a stand-alone python package.
|
|
||||||
|
|
||||||
- [www](https://github.com/deltachat/chatmail/tree/main/www)
|
|
||||||
contains the html, css, and markdown files
|
|
||||||
which make up a chatmail server's web page.
|
|
||||||
Edit them before deploying to make your chatmail server stand out.
|
|
||||||
|
|
||||||
- [scripts](https://github.com/deltachat/chatmail/tree/main/scripts)
|
|
||||||
offers two convenience tools for beginners;
|
|
||||||
`initenv.sh` installs the necessary dependencies to a local virtual environment,
|
|
||||||
and the `scripts/cmdeploy` script enables you
|
|
||||||
to run the `cmdeploy` command line tool in the local virtual environment.
|
|
||||||
|
|
||||||
### cmdeploy
|
|
||||||
|
|
||||||
The `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
|
||||||
helps with setting up and managing the chatmail service.
|
|
||||||
`cmdeploy init` creates the `chatmail.ini` config file.
|
|
||||||
`cmdeploy run` uses a [pyinfra](https://pyinfra.com/)-based [script](`cmdeploy/src/cmdeploy/__init__.py`)
|
|
||||||
to automatically install or upgrade all chatmail components on a server,
|
|
||||||
according to the `chatmail.ini` config.
|
|
||||||
|
|
||||||
The components of chatmail are:
|
|
||||||
|
|
||||||
- [postfix smtp server](https://www.postfix.org) accepts sent messages (both from your users and from other servers)
|
|
||||||
|
|
||||||
- [dovecot imap server](https://www.dovecot.org) stores messages for your users until they download them
|
|
||||||
|
|
||||||
- [nginx](https://nginx.org/) shows the web page with your privacy policy and additional information
|
|
||||||
|
|
||||||
- [acmetool](https://hlandau.github.io/acmetool/) manages TLS certificates for dovecot, postfix, and nginx
|
|
||||||
|
|
||||||
- [opendkim](http://www.opendkim.org/) for signing messages with DKIM and rejecting inbound messages without DKIM
|
|
||||||
|
|
||||||
- [mtail](https://google.github.io/mtail/) for collecting anonymized metrics in case you have monitoring
|
|
||||||
|
|
||||||
- and the chatmaild services, explained in the next section:
|
|
||||||
|
|
||||||
### chatmaild
|
|
||||||
|
|
||||||
chatmaild offers several commands
|
|
||||||
which differentiate a *chatmail* server from a classic mail server.
|
|
||||||
If you deploy them with cmdeploy,
|
|
||||||
they are run by systemd services in the background.
|
|
||||||
A short overview:
|
|
||||||
|
|
||||||
- [`doveauth`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/doveauth.py) implements
|
|
||||||
create-on-login account creation semantics and is used
|
|
||||||
by Dovecot during login authentication and by Postfix
|
|
||||||
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
|
||||||
to authenticate users
|
|
||||||
to send mails for them.
|
|
||||||
|
|
||||||
- [`filtermail`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/filtermail.py) prevents
|
|
||||||
unencrypted e-mail from leaving the chatmail service
|
|
||||||
and is integrated into postfix's outbound mail pipelines.
|
|
||||||
|
|
||||||
- [`chatmail-metadata`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a
|
|
||||||
[dovecot lua script](https://github.com/deltachat/chatmail/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua)
|
|
||||||
to store user-specific server-side config.
|
|
||||||
On new messages,
|
|
||||||
it [passes the user's push notification token](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/notifier.py)
|
|
||||||
to [notifications.delta.chat](https://delta.chat/help#instant-delivery)
|
|
||||||
so the push notifications on the user's phone can be triggered
|
|
||||||
by Apple/Google.
|
|
||||||
|
|
||||||
- [`delete_inactive_users`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/delete_inactive_users.py)
|
|
||||||
deletes users if they have not logged in for a very long time.
|
|
||||||
The timeframe can be configured in `chatmail.ini`.
|
|
||||||
|
|
||||||
- [`lastlogin`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/lastlogin.py)
|
|
||||||
is contacted by dovecot when a user logs in
|
|
||||||
and stores the date of the login.
|
|
||||||
|
|
||||||
- [`echobot`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/echo.py)
|
|
||||||
is a small bot for test purposes.
|
|
||||||
It simply echoes back messages from users.
|
|
||||||
|
|
||||||
- [`chatmail-metrics`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metrics.py)
|
|
||||||
collects some metrics and displays them at `https://example.org/metrics`.
|
|
||||||
|
|
||||||
### Home page and getting started for users
|
|
||||||
|
|
||||||
`cmdeploy run` also creates default static Web pages and deploys them
|
|
||||||
to a nginx web server with:
|
|
||||||
|
|
||||||
- a default `index.html` along with a QR code that users can click to
|
|
||||||
create accounts on your chatmail provider,
|
create accounts on your chatmail provider,
|
||||||
|
|
||||||
- a default `info.html` that is linked from the home page,
|
- a default `info.html` that is linked from the home page,
|
||||||
|
|
||||||
- a default `policy.html` that is linked from the home page.
|
- a default `policy.html` that is linked from the home page.
|
||||||
|
|
||||||
All `.html` files are generated
|
All `.html` files are generated
|
||||||
by the according markdown `.md` file in the `www/src` directory.
|
by the according markdown `.md` file in the `www/src` directory.
|
||||||
|
|
||||||
|
|
||||||
### Refining the web pages
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy webdev
|
|
||||||
```
|
|
||||||
|
|
||||||
This starts a local live development cycle for chatmail Web pages:
|
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing static
|
|
||||||
HTML pages from `www/src/*.md` files
|
|
||||||
|
|
||||||
- continously builds the web presence reading files from `www/src` directory
|
|
||||||
and generating html files and copying assets to the `www/build` directory.
|
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
|
||||||
|
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
|
||||||
|
|
||||||
If you need to stop account creation,
|
|
||||||
e.g. because some script is wildly creating accounts,
|
|
||||||
login to the server with ssh and run:
|
|
||||||
|
|
||||||
```
|
|
||||||
touch /etc/chatmail-nocreate
|
|
||||||
```
|
|
||||||
|
|
||||||
While this file is present, account creation will be blocked.
|
|
||||||
|
|
||||||
### Ports
|
### Ports
|
||||||
|
|
||||||
[Postfix](http://www.postfix.org/) listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
||||||
[Dovecot](https://www.dovecot.org/) listens on ports 143 (imap) and 993 (imaps).
|
Dovecot listens on ports 143(imap) and 993 (imaps).
|
||||||
[nginx](https://www.nginx.com/) listens on port 8443 (https-alt) and 443 (https).
|
|
||||||
Port 443 multiplexes HTTPS, IMAP and SMTP using ALPN to redirect connections to ports 8443, 465 or 993.
|
|
||||||
[acmetool](https://hlandau.github.io/acmetool/) listens on port 80 (http).
|
|
||||||
|
|
||||||
Delta Chat apps will, however, discover all ports and configurations
|
Delta Chat will, however, discover all ports and configurations
|
||||||
automatically by reading the [autoconfig XML file](https://www.ietf.org/archive/id/draft-bucksch-autoconfig-00.html) from the chatmail service.
|
automatically by reading the `autoconfig.xml` file from the chatmail instance.
|
||||||
|
|
||||||
## Email authentication
|
|
||||||
|
|
||||||
chatmail servers rely on [DKIM](https://www.rfc-editor.org/rfc/rfc6376)
|
## Emergency Commands to disable automatic account creation
|
||||||
to authenticate incoming emails.
|
|
||||||
Incoming emails must have a valid DKIM signature with
|
|
||||||
Signing Domain Identifier (SDID, `d=` parameter in the DKIM-Signature header)
|
|
||||||
equal to the `From:` header domain.
|
|
||||||
This property is checked by OpenDKIM screen policy script
|
|
||||||
before validating the signatures.
|
|
||||||
This correpsonds to strict [DMARC](https://www.rfc-editor.org/rfc/rfc7489) alignment (`adkim=s`),
|
|
||||||
but chatmail does not rely on DMARC and does not consult the sender policy published in DMARC records.
|
|
||||||
Other legacy authentication mechanisms such as [iprev](https://www.rfc-editor.org/rfc/rfc8601#section-2.7.3)
|
|
||||||
and [SPF](https://www.rfc-editor.org/rfc/rfc7208) are also not taken into account.
|
|
||||||
If there is no valid DKIM signature on the incoming email,
|
|
||||||
the sender receives a "5.7.1 No valid DKIM signature found" error.
|
|
||||||
|
|
||||||
Outgoing emails must be sent over authenticated connection
|
If you need to stop account creation,
|
||||||
with envelope MAIL FROM (return path) corresponding to the login.
|
e.g. because some script is wildly creating accounts, run:
|
||||||
This is ensured by Postfix which maps login username
|
|
||||||
to MAIL FROM with
|
|
||||||
[`smtpd_sender_login_maps`](https://www.postfix.org/postconf.5.html#smtpd_sender_login_maps)
|
|
||||||
and rejects incorrectly authenticated emails with [`reject_sender_login_mismatch`](reject_sender_login_mismatch) policy.
|
|
||||||
`From:` header must correspond to envelope MAIL FROM,
|
|
||||||
this is ensured by `filtermail` proxy.
|
|
||||||
|
|
||||||
## Migrating chatmail server to a new host
|
touch /etc/chatmail-nocreate
|
||||||
|
|
||||||
If you want to migrate chatmail from an old machine
|
While this file is present, account creation will be blocked.
|
||||||
to a new machine,
|
|
||||||
you can use these steps.
|
|
||||||
They were tested with a linux laptop;
|
|
||||||
you might need to adjust some of the steps to your environment.
|
|
||||||
|
|
||||||
Let's assume that your `mail_domain` is `mail.example.org`,
|
|
||||||
all involved machines run Debian 12,
|
|
||||||
your old server's IP address is `13.37.13.37`,
|
|
||||||
and your new server's IP address is `13.12.23.42`.
|
|
||||||
|
|
||||||
During the guide, you might get a warning about changed SSH Host keys;
|
## Running tests and benchmarks (offline and online)
|
||||||
in this case, just run `ssh-keygen -R "mail.example.org"` as recommended
|
|
||||||
to make sure you can connect with SSH.
|
|
||||||
|
|
||||||
1. First, copy `/var/lib/acme` to the new server with
|
1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows
|
||||||
`ssh root@13.37.13.37 tar c /var/lib/acme | ssh root@13.12.23.42 tar x -C /var/lib/`.
|
to login to the chatmail instance server.
|
||||||
This transfers your TLS certificate.
|
|
||||||
|
|
||||||
2. You should also copy `/etc/dkimkeys` to the new server with
|
2. To run local and online tests:
|
||||||
`ssh root@13.37.13.37 tar c /etc/dkimkeys | ssh root@13.12.23.42 tar x -C /etc/`
|
|
||||||
so the DKIM DNS record stays correct.
|
|
||||||
|
|
||||||
3. On the new server, run `chown root: -R /var/lib/acme` and `chown root: -R /etc/dkimkeys` to make sure the permissions are correct.
|
scripts/test.sh
|
||||||
|
|
||||||
4. Run `cmdeploy run --disable-mail --ssh-host 13.12.23.42` to install chatmail on the new machine.
|
3. To run benchmarks against your chatmail instance:
|
||||||
postfix and dovecot are disabled for now,
|
|
||||||
we will enable them later.
|
|
||||||
|
|
||||||
5. Now, point DNS to the new IP addresses.
|
scripts/bench.sh
|
||||||
|
|
||||||
You can already remove the old IP addresses from DNS.
|
|
||||||
Existing Delta Chat users will still be able to connect
|
|
||||||
to the old server, send and receive messages,
|
|
||||||
but new users will fail to create new profiles
|
|
||||||
with your chatmail server.
|
|
||||||
|
|
||||||
If other servers try to deliver messages to your new server they will fail,
|
## Development Background for chatmail instances
|
||||||
but normally email servers will retry delivering messages
|
|
||||||
for at least a week, so messages will not be lost.
|
|
||||||
|
|
||||||
6. Now you can run `cmdeploy run --disable-mail --ssh-host 13.37.13.37` to disable your old server.
|
This repository drives the development of "chatmail instances",
|
||||||
|
comprised of minimal setups of
|
||||||
|
|
||||||
Now your users will notice the migration
|
- [postfix smtp server](https://www.postfix.org)
|
||||||
and will not be able to send or receive messages
|
- [dovecot imap server](https://www.dovecot.org)
|
||||||
until the migration is completed.
|
|
||||||
|
|
||||||
7. After everything is stopped,
|
as well as two custom services that are integrated with these two:
|
||||||
you can copy the `/home/vmail/mail` directory to the new server.
|
|
||||||
It includes all user data, messages, password hashes, etc.
|
|
||||||
|
|
||||||
Just run: `ssh root@13.37.13.37 tar c /home/vmail/mail | ssh root@13.12.23.42 tar x -C /home/vmail/`
|
- `chatmaild/src/chatmaild/doveauth.py` implements
|
||||||
|
create-on-login account creation semantics and is used
|
||||||
|
by Dovecot during login authentication and by Postfix
|
||||||
|
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
||||||
|
to authenticate users
|
||||||
|
to send mails for them.
|
||||||
|
|
||||||
After this, your new server has all the necessary files to start operating :)
|
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
||||||
|
unencrypted e-mail from leaving the chatmail instance
|
||||||
|
and is integrated into postfix's outbound mail pipelines.
|
||||||
|
|
||||||
8. To be sure the permissions are still fine,
|
|
||||||
run `chown vmail: -R /home/vmail` on the new server.
|
|
||||||
|
|
||||||
9. Finally, you can run `cmdeploy run` to turn on chatmail on the new server.
|
|
||||||
Your users can continue using the chatmail server,
|
|
||||||
and messages which were sent after step 6. should arrive now.
|
|
||||||
Voilà!
|
|
||||||
|
|
||||||
## Setting up a reverse proxy
|
|
||||||
|
|
||||||
A chatmail server does not depend on the client IP address
|
|
||||||
for its operation, so it can be run behind a reverse proxy.
|
|
||||||
This will not even affect incoming mail authentication
|
|
||||||
as DKIM only checks the cryptographic signature
|
|
||||||
of the message and does not use the IP address as the input.
|
|
||||||
|
|
||||||
For example, you may want to self-host your chatmail server
|
|
||||||
and only use hosted VPS to provide a public IP address
|
|
||||||
for client connections and incoming mail.
|
|
||||||
You can connect chatmail server to VPS
|
|
||||||
using a tunnel protocol
|
|
||||||
such as [WireGuard](https://www.wireguard.com/)
|
|
||||||
and setup a reverse proxy on a VPS
|
|
||||||
to forward connections to the chatmail server
|
|
||||||
over the tunnel.
|
|
||||||
You can also setup multiple reverse proxies
|
|
||||||
for your chatmail server in different networks
|
|
||||||
to ensure your server is reachable even when
|
|
||||||
one of the IPs becomes inaccessible due to
|
|
||||||
hosting or routing problems.
|
|
||||||
|
|
||||||
Note that your server still needs
|
|
||||||
to be able to make outgoing connections on port 25
|
|
||||||
to send messages outside.
|
|
||||||
|
|
||||||
To setup a reverse proxy
|
|
||||||
(or rather Destination NAT, DNAT)
|
|
||||||
for your chatmail server,
|
|
||||||
put the following configuration in `/etc/nftables.conf`:
|
|
||||||
```
|
|
||||||
#!/usr/sbin/nft -f
|
|
||||||
|
|
||||||
flush ruleset
|
|
||||||
|
|
||||||
define wan = eth0
|
|
||||||
|
|
||||||
# Which ports to proxy.
|
|
||||||
#
|
|
||||||
# Note that SSH is not proxied
|
|
||||||
# so it is possible to log into the proxy server
|
|
||||||
# and not the original one.
|
|
||||||
define ports = { smtp, http, https, imap, imaps, submission, submissions }
|
|
||||||
|
|
||||||
# The host we want to proxy to.
|
|
||||||
define ipv4_address = AAA.BBB.CCC.DDD
|
|
||||||
define ipv6_address = [XXX::1]
|
|
||||||
|
|
||||||
table ip nat {
|
|
||||||
chain prerouting {
|
|
||||||
type nat hook prerouting priority dstnat; policy accept;
|
|
||||||
iif $wan tcp dport $ports dnat to $ipv4_address
|
|
||||||
}
|
|
||||||
|
|
||||||
chain postrouting {
|
|
||||||
type nat hook postrouting priority 0;
|
|
||||||
|
|
||||||
oifname $wan masquerade
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
table ip6 nat {
|
|
||||||
chain prerouting {
|
|
||||||
type nat hook prerouting priority dstnat; policy accept;
|
|
||||||
iif $wan tcp dport $ports dnat to $ipv6_address
|
|
||||||
}
|
|
||||||
|
|
||||||
chain postrouting {
|
|
||||||
type nat hook postrouting priority 0;
|
|
||||||
|
|
||||||
oifname $wan masquerade
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
table inet filter {
|
|
||||||
chain input {
|
|
||||||
type filter hook input priority filter; policy drop;
|
|
||||||
|
|
||||||
# Accept ICMP.
|
|
||||||
# It is especially important to accept ICMPv6 ND messages,
|
|
||||||
# otherwise IPv6 connectivity breaks.
|
|
||||||
icmp type { echo-request } accept
|
|
||||||
icmpv6 type { echo-request, nd-neighbor-solicit, nd-router-advert, nd-neighbor-advert } accept
|
|
||||||
|
|
||||||
# Allow incoming SSH connections.
|
|
||||||
tcp dport { ssh } accept
|
|
||||||
|
|
||||||
ct state established accept
|
|
||||||
}
|
|
||||||
chain forward {
|
|
||||||
type filter hook forward priority filter; policy drop;
|
|
||||||
|
|
||||||
ct state established accept
|
|
||||||
ip daddr $ipv4_address counter accept
|
|
||||||
ip6 daddr $ipv6_address counter accept
|
|
||||||
}
|
|
||||||
chain output {
|
|
||||||
type filter hook output priority filter;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Run `systemctl enable nftables.service`
|
|
||||||
to ensure configuration is reloaded when the proxy server reboots.
|
|
||||||
|
|
||||||
Uncomment in `/etc/sysctl.conf` the following two lines:
|
|
||||||
|
|
||||||
```
|
|
||||||
net.ipv4.ip_forward=1
|
|
||||||
net.ipv6.conf.all.forwarding=1
|
|
||||||
```
|
|
||||||
|
|
||||||
Then reboot the server or do `sysctl -p` and `nft -f /etc/nftables.conf`.
|
|
||||||
|
|
||||||
Once proxy server is set up,
|
|
||||||
you can add its IP address to the DNS.
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
include src/chatmaild/*.f
|
||||||
include src/chatmaild/ini/*.ini.f
|
include src/chatmaild/ini/*.ini.f
|
||||||
include src/chatmaild/ini/*.ini
|
include src/chatmaild/ini/*.ini
|
||||||
include src/chatmaild/tests/mail-data/*
|
include src/chatmaild/tests/mail-data/*
|
||||||
|
|||||||
@@ -8,10 +8,6 @@ version = "0.2"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
"iniconfig",
|
||||||
"deltachat-rpc-server",
|
|
||||||
"deltachat-rpc-client",
|
|
||||||
"filelock",
|
|
||||||
"requests",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -22,12 +18,7 @@ where = ['src']
|
|||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
chatmail-metadata = "chatmaild.metadata:main"
|
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
echobot = "chatmaild.echo:main"
|
|
||||||
chatmail-metrics = "chatmaild.metrics:main"
|
|
||||||
delete_inactive_users = "chatmaild.delete_inactive_users:main"
|
|
||||||
lastlogin = "chatmaild.lastlogin:main"
|
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
@@ -38,16 +29,6 @@ log_format = "%(asctime)s %(levelname)s %(message)s"
|
|||||||
log_date_format = "%Y-%m-%d %H:%M:%S"
|
log_date_format = "%Y-%m-%d %H:%M:%S"
|
||||||
log_level = "INFO"
|
log_level = "INFO"
|
||||||
|
|
||||||
[tool.ruff]
|
|
||||||
lint.select = [
|
|
||||||
"F", # Pyflakes
|
|
||||||
"I", # isort
|
|
||||||
|
|
||||||
"PLC", # Pylint Convention
|
|
||||||
"PLE", # Pylint Error
|
|
||||||
"PLW", # Pylint Warning
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.tox]
|
[tool.tox]
|
||||||
legacy_tox_ini = """
|
legacy_tox_ini = """
|
||||||
[tox]
|
[tox]
|
||||||
@@ -59,9 +40,10 @@ skipdist = True
|
|||||||
skip_install = True
|
skip_install = True
|
||||||
deps =
|
deps =
|
||||||
ruff
|
ruff
|
||||||
|
black
|
||||||
commands =
|
commands =
|
||||||
ruff format --quiet --diff src/
|
black --quiet --check --diff src/
|
||||||
ruff check src/
|
ruff src/
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
deps = pytest
|
deps = pytest
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
|
|
||||||
|
|||||||
@@ -1,59 +0,0 @@
|
|||||||
"""Generated from deltachat, draft-ietf-lamps-header-protection, and
|
|
||||||
encrypted_subject localizations in
|
|
||||||
https://github.com/thunderbird/thunderbird-android/
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
common_encrypted_subjects = {
|
|
||||||
"...",
|
|
||||||
"[...]",
|
|
||||||
"암호화된 메시지",
|
|
||||||
"Ĉifrita mesaĝo",
|
|
||||||
"Courriel chiffré",
|
|
||||||
"Dulrituð skilaboð",
|
|
||||||
"Encrypted Message",
|
|
||||||
"Fersifere berjocht",
|
|
||||||
"Kemennadenn enrineget",
|
|
||||||
"Krüptitud kiri",
|
|
||||||
"Krypterat meddelande",
|
|
||||||
"Krypteret besked",
|
|
||||||
"Kryptert melding",
|
|
||||||
"Mensagem criptografada",
|
|
||||||
"Mensagem encriptada",
|
|
||||||
"Mensaje cifrado",
|
|
||||||
"Mensaxe cifrada",
|
|
||||||
"Mesaj Criptat",
|
|
||||||
"Mesazh i Fshehtëzuar",
|
|
||||||
"Messaggio criptato",
|
|
||||||
"Messaghju cifratu",
|
|
||||||
"Missatge encriptat",
|
|
||||||
"Neges wedi'i Hamgryptio",
|
|
||||||
"Pesan terenkripsi",
|
|
||||||
"Salattu viesti",
|
|
||||||
"Şifreli İleti",
|
|
||||||
"Šifrēta ziņa",
|
|
||||||
"Šifrirana poruka",
|
|
||||||
"Šifrirano sporočilo",
|
|
||||||
"Šifruotas laiškas",
|
|
||||||
"Tin nhắn được mã hóa",
|
|
||||||
"Titkosított üzenet",
|
|
||||||
"Verschlüsselte Nachricht",
|
|
||||||
"Versleuteld bericht",
|
|
||||||
"Zašifrovaná zpráva",
|
|
||||||
"Zaszyfrowana wiadomość",
|
|
||||||
"Zifratu mezua",
|
|
||||||
"Κρυπτογραφημένο μήνυμα",
|
|
||||||
"Зашифроване повідомлення",
|
|
||||||
"Зашифрованное сообщение",
|
|
||||||
"Зашыфраваны ліст",
|
|
||||||
"Криптирано съобщение",
|
|
||||||
"Шифрована порука",
|
|
||||||
"დაშიფრული წერილი",
|
|
||||||
"הודעה מוצפנת",
|
|
||||||
"پیام رمزنگاریشده",
|
|
||||||
"رسالة مشفّرة",
|
|
||||||
"എൻക്രിപ്റ്റുചെയ്ത സന്ദേശം",
|
|
||||||
"加密邮件",
|
|
||||||
"已加密的訊息",
|
|
||||||
"暗号化されたメッセージ",
|
|
||||||
}
|
|
||||||
@@ -1,100 +1,34 @@
|
|||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import iniconfig
|
import iniconfig
|
||||||
|
|
||||||
from chatmaild.user import User
|
|
||||||
|
|
||||||
echobot_password_path = Path("/run/echobot/password")
|
|
||||||
|
|
||||||
|
|
||||||
def read_config(inipath):
|
def read_config(inipath):
|
||||||
assert Path(inipath).exists(), inipath
|
|
||||||
cfg = iniconfig.IniConfig(inipath)
|
cfg = iniconfig.IniConfig(inipath)
|
||||||
params = cfg.sections["params"]
|
return Config(inipath, params=cfg.sections["params"])
|
||||||
return Config(inipath, params=params)
|
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
self.mail_domain = params["mail_domain"]
|
self.mailname = self.mail_domain = params["mailname"]
|
||||||
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
||||||
self.max_mailbox_size = params["max_mailbox_size"]
|
|
||||||
self.max_message_size = int(params.get("max_message_size", "31457280"))
|
|
||||||
self.delete_mails_after = params["delete_mails_after"]
|
|
||||||
self.delete_inactive_users_after = int(params["delete_inactive_users_after"])
|
|
||||||
self.username_min_length = int(params["username_min_length"])
|
|
||||||
self.username_max_length = int(params["username_max_length"])
|
|
||||||
self.password_min_length = int(params["password_min_length"])
|
|
||||||
self.passthrough_senders = params["passthrough_senders"].split()
|
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].split()
|
|
||||||
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
||||||
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
||||||
self.mtail_address = params.get("mtail_address")
|
self.passthrough_recipients = params["passthrough_recipients"].split()
|
||||||
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
|
||||||
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
|
||||||
if "iroh_relay" not in params:
|
|
||||||
self.iroh_relay = "https://" + params["mail_domain"]
|
|
||||||
self.enable_iroh_relay = True
|
|
||||||
else:
|
|
||||||
self.iroh_relay = params["iroh_relay"].strip()
|
|
||||||
self.enable_iroh_relay = False
|
|
||||||
self.privacy_postal = params.get("privacy_postal")
|
self.privacy_postal = params.get("privacy_postal")
|
||||||
self.privacy_mail = params.get("privacy_mail")
|
self.privacy_mail = params.get("privacy_mail")
|
||||||
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")
|
||||||
|
|
||||||
# deprecated option
|
|
||||||
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
|
||||||
self.mailboxes_dir = Path(mbdir.strip())
|
|
||||||
|
|
||||||
# old unused option (except for first migration from sqlite to maildir store)
|
|
||||||
self.passdb_path = Path(params.get("passdb_path", "/home/vmail/passdb.sqlite"))
|
|
||||||
|
|
||||||
def _getbytefile(self):
|
def _getbytefile(self):
|
||||||
return open(self._inipath, "rb")
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
def get_user(self, addr):
|
|
||||||
if not addr or "@" not in addr or "/" in addr:
|
|
||||||
raise ValueError(f"invalid address {addr!r}")
|
|
||||||
|
|
||||||
maildir = self.mailboxes_dir.joinpath(addr)
|
def write_initial_config(inipath, mailname):
|
||||||
if addr.startswith("echo@"):
|
|
||||||
password_path = echobot_password_path
|
|
||||||
else:
|
|
||||||
password_path = maildir.joinpath("password")
|
|
||||||
|
|
||||||
return User(maildir, addr, password_path, uid="vmail", gid="vmail")
|
|
||||||
|
|
||||||
|
|
||||||
def write_initial_config(inipath, mail_domain, overrides):
|
|
||||||
"""Write out default config file, using the specified config value overrides."""
|
|
||||||
from importlib.resources import files
|
from importlib.resources import files
|
||||||
|
|
||||||
inidir = files(__package__).joinpath("ini")
|
inidir = files(__package__).joinpath("ini")
|
||||||
source_inipath = inidir.joinpath("chatmail.ini.f")
|
content = inidir.joinpath("chatmail.ini.f").read_text().format(mailname=mailname)
|
||||||
content = source_inipath.read_text().format(mail_domain=mail_domain)
|
if mailname.endswith(".testrun.org"):
|
||||||
|
|
||||||
# apply config overrides
|
|
||||||
new_lines = []
|
|
||||||
extra = overrides.copy()
|
|
||||||
for line in content.split("\n"):
|
|
||||||
new_line = line.strip()
|
|
||||||
if new_line and new_line[0] not in "#[":
|
|
||||||
name, value = map(str.strip, new_line.split("=", maxsplit=1))
|
|
||||||
value = extra.pop(name, value)
|
|
||||||
new_line = f"{name} = {value}"
|
|
||||||
new_lines.append(new_line)
|
|
||||||
|
|
||||||
for name, value in extra.items():
|
|
||||||
new_line = f"{name} = {value}"
|
|
||||||
new_lines.append(new_line)
|
|
||||||
|
|
||||||
content = "\n".join(new_lines)
|
|
||||||
|
|
||||||
# apply testrun privacy overrides
|
|
||||||
|
|
||||||
if mail_domain.endswith(".testrun.org"):
|
|
||||||
override_inipath = inidir.joinpath("override-testrun.ini")
|
override_inipath = inidir.joinpath("override-testrun.ini")
|
||||||
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
||||||
lines = []
|
lines = []
|
||||||
|
|||||||
133
chatmaild/src/chatmaild/database.py
Normal file
133
chatmaild/src/chatmaild/database.py
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
import sqlite3
|
||||||
|
import contextlib
|
||||||
|
import time
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
class DBError(Exception):
|
||||||
|
"""error during an operation on the database."""
|
||||||
|
|
||||||
|
|
||||||
|
class Connection:
|
||||||
|
def __init__(self, sqlconn, write):
|
||||||
|
self._sqlconn = sqlconn
|
||||||
|
self._write = write
|
||||||
|
|
||||||
|
def close(self):
|
||||||
|
self._sqlconn.close()
|
||||||
|
|
||||||
|
def commit(self):
|
||||||
|
self._sqlconn.commit()
|
||||||
|
|
||||||
|
def rollback(self):
|
||||||
|
self._sqlconn.rollback()
|
||||||
|
|
||||||
|
def execute(self, query, params=()):
|
||||||
|
cur = self.cursor()
|
||||||
|
try:
|
||||||
|
cur.execute(query, params)
|
||||||
|
except sqlite3.IntegrityError as e:
|
||||||
|
raise DBError(e)
|
||||||
|
return cur
|
||||||
|
|
||||||
|
def cursor(self):
|
||||||
|
return self._sqlconn.cursor()
|
||||||
|
|
||||||
|
def get_user(self, addr: str) -> {}:
|
||||||
|
"""Get a row from the users table."""
|
||||||
|
q = "SELECT addr, password, last_login from users WHERE addr = ?"
|
||||||
|
row = self._sqlconn.execute(q, (addr,)).fetchone()
|
||||||
|
result = {}
|
||||||
|
if row:
|
||||||
|
result = dict(
|
||||||
|
user=row[0],
|
||||||
|
password=row[1],
|
||||||
|
last_login=row[2],
|
||||||
|
)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
class Database:
|
||||||
|
def __init__(self, path: str):
|
||||||
|
self.path = Path(path)
|
||||||
|
self.ensure_tables()
|
||||||
|
|
||||||
|
def _get_connection(
|
||||||
|
self, write=False, transaction=False, closing=False
|
||||||
|
) -> Connection:
|
||||||
|
# we let the database serialize all writers at connection time
|
||||||
|
# to play it very safe (we don't have massive amounts of writes).
|
||||||
|
mode = "ro"
|
||||||
|
if write:
|
||||||
|
mode = "rw"
|
||||||
|
if not self.path.exists():
|
||||||
|
mode = "rwc"
|
||||||
|
uri = "file:%s?mode=%s" % (self.path, mode)
|
||||||
|
sqlconn = sqlite3.connect(
|
||||||
|
uri,
|
||||||
|
timeout=60,
|
||||||
|
isolation_level=None if transaction else "DEFERRED",
|
||||||
|
uri=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Enable Write-Ahead Logging to avoid readers blocking writers and vice versa.
|
||||||
|
if write:
|
||||||
|
sqlconn.execute("PRAGMA journal_mode=wal")
|
||||||
|
|
||||||
|
if transaction:
|
||||||
|
start_time = time.time()
|
||||||
|
while 1:
|
||||||
|
try:
|
||||||
|
sqlconn.execute("begin immediate")
|
||||||
|
break
|
||||||
|
except sqlite3.OperationalError:
|
||||||
|
# another thread may be writing, give it a chance to finish
|
||||||
|
time.sleep(0.1)
|
||||||
|
if time.time() - start_time > 5:
|
||||||
|
# if it takes this long, something is wrong
|
||||||
|
raise
|
||||||
|
conn = Connection(sqlconn, write=write)
|
||||||
|
if closing:
|
||||||
|
conn = contextlib.closing(conn)
|
||||||
|
return conn
|
||||||
|
|
||||||
|
@contextlib.contextmanager
|
||||||
|
def write_transaction(self):
|
||||||
|
conn = self._get_connection(closing=False, write=True, transaction=True)
|
||||||
|
try:
|
||||||
|
yield conn
|
||||||
|
except Exception:
|
||||||
|
conn.rollback()
|
||||||
|
conn.close()
|
||||||
|
raise
|
||||||
|
else:
|
||||||
|
conn.commit()
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def read_connection(self, closing=True) -> Connection:
|
||||||
|
return self._get_connection(closing=closing, write=False)
|
||||||
|
|
||||||
|
def get_schema_version(self) -> int:
|
||||||
|
with self.read_connection() as conn:
|
||||||
|
dbversion = conn.execute("PRAGMA user_version").fetchone()[0]
|
||||||
|
return dbversion
|
||||||
|
|
||||||
|
CURRENT_DBVERSION = 1
|
||||||
|
|
||||||
|
def ensure_tables(self):
|
||||||
|
with self.write_transaction() as conn:
|
||||||
|
if self.get_schema_version() > 1:
|
||||||
|
raise DBError(
|
||||||
|
"version is %s; downgrading schema is not supported"
|
||||||
|
% (self.get_schema_version(),)
|
||||||
|
)
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS users (
|
||||||
|
addr TEXT PRIMARY KEY,
|
||||||
|
password TEXT,
|
||||||
|
last_login INTEGER
|
||||||
|
)
|
||||||
|
""",
|
||||||
|
)
|
||||||
|
conn.execute("PRAGMA user_version=%s" % (self.CURRENT_DBVERSION,))
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
"""
|
|
||||||
Remove inactive users
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
import sys
|
|
||||||
import time
|
|
||||||
|
|
||||||
from .config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def delete_inactive_users(config):
|
|
||||||
cutoff_date = time.time() - config.delete_inactive_users_after * 86400
|
|
||||||
for addr in os.listdir(config.mailboxes_dir):
|
|
||||||
try:
|
|
||||||
user = config.get_user(addr)
|
|
||||||
except ValueError:
|
|
||||||
continue
|
|
||||||
|
|
||||||
read_timestamp = user.get_last_login_timestamp()
|
|
||||||
if read_timestamp and read_timestamp < cutoff_date:
|
|
||||||
path = config.mailboxes_dir.joinpath(addr)
|
|
||||||
assert path == user.maildir
|
|
||||||
shutil.rmtree(path, ignore_errors=True)
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
(cfgpath,) = sys.argv[1:]
|
|
||||||
config = read_config(cfgpath)
|
|
||||||
delete_inactive_users(config)
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
import logging
|
|
||||||
import os
|
|
||||||
from socketserver import StreamRequestHandler, ThreadingUnixStreamServer
|
|
||||||
|
|
||||||
|
|
||||||
class DictProxy:
|
|
||||||
def loop_forever(self, rfile, wfile):
|
|
||||||
# Transaction storage is local to each handler loop.
|
|
||||||
# Dovecot reuses transaction IDs across connections,
|
|
||||||
# starting transaction with the name `1`
|
|
||||||
# on two different connections to the same proxy sometimes.
|
|
||||||
transactions = {}
|
|
||||||
|
|
||||||
while True:
|
|
||||||
msg = rfile.readline().strip().decode()
|
|
||||||
if not msg:
|
|
||||||
break
|
|
||||||
|
|
||||||
res = self.handle_dovecot_request(msg, transactions)
|
|
||||||
if res:
|
|
||||||
wfile.write(res.encode("ascii"))
|
|
||||||
wfile.flush()
|
|
||||||
|
|
||||||
def handle_dovecot_request(self, msg, transactions):
|
|
||||||
# see https://doc.dovecot.org/developer_manual/design/dict_protocol/#dovecot-dict-protocol
|
|
||||||
short_command = msg[0]
|
|
||||||
parts = msg[1:].split("\t")
|
|
||||||
|
|
||||||
if short_command == "L":
|
|
||||||
return self.handle_lookup(parts)
|
|
||||||
elif short_command == "I":
|
|
||||||
return self.handle_iterate(parts)
|
|
||||||
elif short_command == "H":
|
|
||||||
return # no version checking
|
|
||||||
|
|
||||||
if short_command not in ("BSC"):
|
|
||||||
logging.warning(f"unknown dictproxy request: {msg!r}")
|
|
||||||
return
|
|
||||||
|
|
||||||
transaction_id = parts[0]
|
|
||||||
|
|
||||||
if short_command == "B":
|
|
||||||
return self.handle_begin_transaction(transaction_id, parts, transactions)
|
|
||||||
elif short_command == "C":
|
|
||||||
return self.handle_commit_transaction(transaction_id, parts, transactions)
|
|
||||||
elif short_command == "S":
|
|
||||||
addr = transactions[transaction_id]["addr"]
|
|
||||||
if not self.handle_set(addr, parts):
|
|
||||||
transactions[transaction_id]["res"] = "F\n"
|
|
||||||
logging.error(f"dictproxy-set failed for {addr!r}: {msg!r}")
|
|
||||||
|
|
||||||
def handle_lookup(self, parts):
|
|
||||||
logging.warning(f"lookup ignored: {parts!r}")
|
|
||||||
return "N\n"
|
|
||||||
|
|
||||||
def handle_iterate(self, parts):
|
|
||||||
# Empty line means ITER_FINISHED.
|
|
||||||
# If we don't return empty line Dovecot will timeout.
|
|
||||||
return "\n"
|
|
||||||
|
|
||||||
def handle_begin_transaction(self, transaction_id, parts, transactions):
|
|
||||||
addr = parts[1]
|
|
||||||
transactions[transaction_id] = dict(addr=addr, res="O\n")
|
|
||||||
|
|
||||||
def handle_set(self, addr, parts):
|
|
||||||
# For documentation on key structure see
|
|
||||||
# https://github.com/dovecot/core/blob/main/src/lib-storage/mailbox-attribute.h
|
|
||||||
return False
|
|
||||||
|
|
||||||
def handle_commit_transaction(self, transaction_id, parts, transactions):
|
|
||||||
# return whatever "set" command(s) set as result.
|
|
||||||
return transactions.pop(transaction_id)["res"]
|
|
||||||
|
|
||||||
def serve_forever_from_socket(self, socket):
|
|
||||||
dictproxy = self
|
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
|
||||||
def handle(self):
|
|
||||||
try:
|
|
||||||
dictproxy.loop_forever(self.rfile, self.wfile)
|
|
||||||
except Exception:
|
|
||||||
logging.exception("Exception in the handler")
|
|
||||||
raise
|
|
||||||
|
|
||||||
try:
|
|
||||||
os.unlink(socket)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
with CustomThreadingUnixStreamServer(socket, Handler) as server:
|
|
||||||
try:
|
|
||||||
server.serve_forever()
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class CustomThreadingUnixStreamServer(ThreadingUnixStreamServer):
|
|
||||||
request_queue_size = 1000
|
|
||||||
@@ -1,12 +1,17 @@
|
|||||||
import crypt
|
|
||||||
import json
|
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import time
|
||||||
import sys
|
import sys
|
||||||
|
import json
|
||||||
|
import crypt
|
||||||
|
from socketserver import (
|
||||||
|
UnixStreamServer,
|
||||||
|
StreamRequestHandler,
|
||||||
|
ThreadingMixIn,
|
||||||
|
)
|
||||||
|
import pwd
|
||||||
|
|
||||||
from .config import Config, read_config
|
from .database import Database
|
||||||
from .dictproxy import DictProxy
|
|
||||||
from .migrate_db import migrate_from_db_to_maildir
|
|
||||||
|
|
||||||
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
||||||
|
|
||||||
@@ -17,17 +22,14 @@ def encrypt_password(password: str):
|
|||||||
return "{SHA512-CRYPT}" + passhash
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
def is_allowed_to_create(user, cleartext_password) -> bool:
|
||||||
"""Return True if user and password are admissable."""
|
"""Return True if user and password are admissable."""
|
||||||
if os.path.exists(NOCREATE_FILE):
|
if os.path.exists(NOCREATE_FILE):
|
||||||
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
if len(cleartext_password) < config.password_min_length:
|
if len(cleartext_password) < 9:
|
||||||
logging.warning(
|
logging.warning("Password needs to be at least 9 characters long")
|
||||||
"Password needs to be at least %s characters long",
|
|
||||||
config.password_min_length,
|
|
||||||
)
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
parts = user.split("@")
|
parts = user.split("@")
|
||||||
@@ -36,121 +38,119 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
return False
|
return False
|
||||||
localpart, domain = parts
|
localpart, domain = parts
|
||||||
|
|
||||||
if localpart == "echo":
|
if domain == "nine.testrun.org":
|
||||||
# echobot account should not be created in the database
|
# nine.testrun.org policy, username has to be exactly nine chars
|
||||||
return False
|
if len(localpart) != 9:
|
||||||
|
logging.warning(f"localpart {localpart!r} has not exactly nine chars")
|
||||||
if (
|
return False
|
||||||
len(localpart) > config.username_max_length
|
|
||||||
or len(localpart) < config.username_min_length
|
|
||||||
):
|
|
||||||
logging.warning(
|
|
||||||
"localpart %s has to be between %s and %s chars long",
|
|
||||||
localpart,
|
|
||||||
config.username_min_length,
|
|
||||||
config.username_max_length,
|
|
||||||
)
|
|
||||||
return False
|
|
||||||
|
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
def split_and_unescape(s):
|
def get_user_data(db, user):
|
||||||
"""Split strings using double quote as a separator and backslash as escape character
|
with db.read_connection() as conn:
|
||||||
into parts."""
|
result = conn.get_user(user)
|
||||||
|
if result:
|
||||||
out = ""
|
result["uid"] = "vmail"
|
||||||
i = 0
|
result["gid"] = "vmail"
|
||||||
while i < len(s):
|
return result
|
||||||
c = s[i]
|
|
||||||
if c == "\\":
|
|
||||||
# Skip escape character.
|
|
||||||
i += 1
|
|
||||||
|
|
||||||
# This will raise IndexError if there is no character
|
|
||||||
# after escape character. This is expected
|
|
||||||
# as this is an invalid input.
|
|
||||||
out += s[i]
|
|
||||||
elif c == '"':
|
|
||||||
# Separator
|
|
||||||
yield out
|
|
||||||
out = ""
|
|
||||||
else:
|
|
||||||
out += c
|
|
||||||
i += 1
|
|
||||||
yield out
|
|
||||||
|
|
||||||
|
|
||||||
class AuthDictProxy(DictProxy):
|
def lookup_userdb(db, user):
|
||||||
def __init__(self, config):
|
return get_user_data(db, user)
|
||||||
super().__init__()
|
|
||||||
self.config = config
|
|
||||||
|
|
||||||
def handle_lookup(self, parts):
|
|
||||||
# Dovecot <2.3.17 has only one part,
|
|
||||||
# do not attempt to read any other parts for compatibility.
|
|
||||||
keyname = parts[0]
|
|
||||||
|
|
||||||
namespace, type, args = keyname.split("/", 2)
|
def lookup_passdb(db, user, cleartext_password):
|
||||||
args = list(split_and_unescape(args))
|
with db.write_transaction() as conn:
|
||||||
|
userdata = conn.get_user(user)
|
||||||
|
if userdata:
|
||||||
|
# Update last login time.
|
||||||
|
conn.execute(
|
||||||
|
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
||||||
|
)
|
||||||
|
|
||||||
config = self.config
|
userdata["uid"] = "vmail"
|
||||||
|
userdata["gid"] = "vmail"
|
||||||
|
return userdata
|
||||||
|
if not is_allowed_to_create(user, cleartext_password):
|
||||||
|
return
|
||||||
|
|
||||||
|
encrypted_password = encrypt_password(cleartext_password)
|
||||||
|
q = """INSERT INTO users (addr, password, last_login)
|
||||||
|
VALUES (?, ?, ?)"""
|
||||||
|
conn.execute(q, (user, encrypted_password, int(time.time())))
|
||||||
|
return dict(
|
||||||
|
home=f"/home/vmail/{user}",
|
||||||
|
uid="vmail",
|
||||||
|
gid="vmail",
|
||||||
|
password=encrypted_password,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def handle_dovecot_request(msg, db, mail_domain):
|
||||||
|
short_command = msg[0]
|
||||||
|
if short_command == "L": # LOOKUP
|
||||||
|
parts = msg[1:].split("\t")
|
||||||
|
keyname, user = parts[:2]
|
||||||
|
namespace, type, *args = keyname.split("/")
|
||||||
reply_command = "F"
|
reply_command = "F"
|
||||||
res = ""
|
res = ""
|
||||||
if namespace == "shared":
|
if namespace == "shared":
|
||||||
if type == "userdb":
|
if type == "userdb":
|
||||||
user = args[0]
|
if user.endswith(f"@{mail_domain}"):
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
res = lookup_userdb(db, user)
|
||||||
res = self.lookup_userdb(user)
|
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
reply_command = "N"
|
reply_command = "N"
|
||||||
elif type == "passdb":
|
elif type == "passdb":
|
||||||
user = args[1]
|
if user.endswith(f"@{mail_domain}"):
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
res = lookup_passdb(db, user, cleartext_password=args[0])
|
||||||
res = self.lookup_passdb(user, cleartext_password=args[0])
|
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
reply_command = "N"
|
reply_command = "N"
|
||||||
json_res = json.dumps(res) if res else ""
|
json_res = json.dumps(res) if res else ""
|
||||||
return f"{reply_command}{json_res}\n"
|
return f"{reply_command}{json_res}\n"
|
||||||
|
return None
|
||||||
|
|
||||||
def handle_iterate(self, parts):
|
|
||||||
# example: I0\t0\tshared/userdb/
|
|
||||||
if parts[2] == "shared/userdb/":
|
|
||||||
result = "".join(
|
|
||||||
f"Oshared/userdb/{user}\t\n" for user in self.iter_userdb()
|
|
||||||
)
|
|
||||||
return f"{result}\n"
|
|
||||||
|
|
||||||
def iter_userdb(self) -> list:
|
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
||||||
"""Get a list of all user addresses."""
|
request_queue_size = 100
|
||||||
return [x for x in os.listdir(self.config.mailboxes_dir) if "@" in x]
|
|
||||||
|
|
||||||
def lookup_userdb(self, addr):
|
|
||||||
return self.config.get_user(addr).get_userdb_dict()
|
|
||||||
|
|
||||||
def lookup_passdb(self, addr, cleartext_password):
|
|
||||||
user = self.config.get_user(addr)
|
|
||||||
userdata = user.get_userdb_dict()
|
|
||||||
if userdata:
|
|
||||||
return userdata
|
|
||||||
if not is_allowed_to_create(self.config, addr, cleartext_password):
|
|
||||||
return
|
|
||||||
|
|
||||||
user.set_password(encrypt_password(cleartext_password))
|
|
||||||
print(f"Created address: {addr}", file=sys.stderr)
|
|
||||||
return user.get_userdb_dict()
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
socket, cfgpath = sys.argv[1:]
|
socket = sys.argv[1]
|
||||||
config = read_config(cfgpath)
|
passwd_entry = pwd.getpwnam(sys.argv[2])
|
||||||
|
db = Database(sys.argv[3])
|
||||||
|
with open("/etc/mailname", "r") as fp:
|
||||||
|
mail_domain = fp.read().strip()
|
||||||
|
|
||||||
migrate_from_db_to_maildir(config)
|
class Handler(StreamRequestHandler):
|
||||||
|
def handle(self):
|
||||||
|
try:
|
||||||
|
while True:
|
||||||
|
msg = self.rfile.readline().strip().decode()
|
||||||
|
if not msg:
|
||||||
|
break
|
||||||
|
res = handle_dovecot_request(msg, db, mail_domain)
|
||||||
|
if res:
|
||||||
|
self.wfile.write(res.encode("ascii"))
|
||||||
|
self.wfile.flush()
|
||||||
|
else:
|
||||||
|
logging.warn("request had no answer: %r", msg)
|
||||||
|
except Exception:
|
||||||
|
logging.exception("Exception in the handler")
|
||||||
|
raise
|
||||||
|
|
||||||
dictproxy = AuthDictProxy(config=config)
|
try:
|
||||||
|
os.unlink(socket)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
dictproxy.serve_forever_from_socket(socket)
|
with ThreadedUnixStreamServer(socket, Handler) as server:
|
||||||
|
os.chown(socket, uid=passwd_entry.pw_uid, gid=passwd_entry.pw_gid)
|
||||||
|
try:
|
||||||
|
server.serve_forever()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
pass
|
||||||
|
|||||||
@@ -2,11 +2,9 @@
|
|||||||
Description=Chatmail dict authentication proxy for dovecot
|
Description=Chatmail dict authentication proxy for dovecot
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} /run/doveauth/doveauth.socket {config_path}
|
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=vmail
|
|
||||||
RuntimeDirectory=doveauth
|
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Advanced echo bot example.
|
|
||||||
|
|
||||||
it will echo back any message that has non-empty text and also supports the /help command.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
|
||||||
|
|
||||||
from chatmaild.config import echobot_password_path, read_config
|
|
||||||
from chatmaild.doveauth import encrypt_password
|
|
||||||
from chatmaild.newemail import create_newemail_dict
|
|
||||||
|
|
||||||
hooks = events.HookCollection()
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.RawEvent)
|
|
||||||
def log_event(event):
|
|
||||||
if event.kind == EventType.INFO:
|
|
||||||
logging.info(event.msg)
|
|
||||||
elif event.kind == EventType.WARNING:
|
|
||||||
logging.warning(event.msg)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.RawEvent(EventType.ERROR))
|
|
||||||
def log_error(event):
|
|
||||||
logging.error("%s", event.msg)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.MemberListChanged)
|
|
||||||
def on_memberlist_changed(event):
|
|
||||||
logging.info(
|
|
||||||
"member %s was %s", event.member, "added" if event.member_added else "removed"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.GroupImageChanged)
|
|
||||||
def on_group_image_changed(event):
|
|
||||||
logging.info("group image %s", "deleted" if event.image_deleted else "changed")
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.GroupNameChanged)
|
|
||||||
def on_group_name_changed(event):
|
|
||||||
logging.info(f"group name changed, old name: {event.old_name}")
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.NewMessage(func=lambda e: not e.command))
|
|
||||||
def echo(event):
|
|
||||||
snapshot = event.message_snapshot
|
|
||||||
if snapshot.is_info:
|
|
||||||
# Ignore info messages
|
|
||||||
return
|
|
||||||
if snapshot.text or snapshot.file:
|
|
||||||
snapshot.chat.send_message(text=snapshot.text, file=snapshot.file)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.NewMessage(command="/help"))
|
|
||||||
def help_command(event):
|
|
||||||
snapshot = event.message_snapshot
|
|
||||||
snapshot.chat.send_text("Send me any message and I will echo it back")
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
logging.basicConfig(level=logging.INFO)
|
|
||||||
path = os.environ.get("PATH")
|
|
||||||
venv_path = sys.argv[0].strip("echobot")
|
|
||||||
os.environ["PATH"] = path + ":" + venv_path
|
|
||||||
with Rpc() as rpc:
|
|
||||||
deltachat = DeltaChat(rpc)
|
|
||||||
system_info = deltachat.get_system_info()
|
|
||||||
logging.info(f"Running deltachat core {system_info.deltachat_core_version}")
|
|
||||||
|
|
||||||
accounts = deltachat.get_all_accounts()
|
|
||||||
account = accounts[0] if accounts else deltachat.add_account()
|
|
||||||
|
|
||||||
bot = Bot(account, hooks)
|
|
||||||
|
|
||||||
config = read_config(sys.argv[1])
|
|
||||||
addr = "echo@" + config.mail_domain
|
|
||||||
|
|
||||||
# Create password file
|
|
||||||
if bot.is_configured():
|
|
||||||
password = bot.account.get_config("mail_pw")
|
|
||||||
else:
|
|
||||||
password = create_newemail_dict(config)["password"]
|
|
||||||
|
|
||||||
echobot_password_path.write_text(encrypt_password(password))
|
|
||||||
# Give the user which doveauth runs as access to the password file.
|
|
||||||
subprocess.check_call(
|
|
||||||
["/usr/bin/setfacl", "-m", "user:vmail:r", echobot_password_path],
|
|
||||||
)
|
|
||||||
|
|
||||||
if not bot.is_configured():
|
|
||||||
bot.configure(addr, password)
|
|
||||||
|
|
||||||
bot.run_forever()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
import json
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
from contextlib import contextmanager
|
|
||||||
from random import randint
|
|
||||||
|
|
||||||
import filelock
|
|
||||||
|
|
||||||
|
|
||||||
class FileDict:
|
|
||||||
"""Concurrency-safe multi-reader/single-writer persistent dict."""
|
|
||||||
|
|
||||||
def __init__(self, path):
|
|
||||||
self.path = path
|
|
||||||
self.lock_path = path.with_name(path.name + ".lock")
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def modify(self):
|
|
||||||
# the OS will release the lock if the process dies,
|
|
||||||
# and the contextmanager will otherwise guarantee release
|
|
||||||
with filelock.FileLock(self.lock_path):
|
|
||||||
data = self.read()
|
|
||||||
yield data
|
|
||||||
write_path = self.path.with_name(self.path.name + ".tmp")
|
|
||||||
with write_path.open("w") as f:
|
|
||||||
json.dump(data, f)
|
|
||||||
os.rename(write_path, self.path)
|
|
||||||
|
|
||||||
def read(self):
|
|
||||||
try:
|
|
||||||
with self.path.open("r") as f:
|
|
||||||
return json.load(f)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return {}
|
|
||||||
except Exception:
|
|
||||||
logging.warning(f"corrupt serialization state at: {self.path!r}")
|
|
||||||
return {}
|
|
||||||
|
|
||||||
|
|
||||||
def write_bytes_atomic(path, content):
|
|
||||||
rint = randint(0, 10000000)
|
|
||||||
tmp = path.with_name(path.name + f".tmp-{rint}")
|
|
||||||
tmp.write_bytes(content)
|
|
||||||
os.rename(tmp, path)
|
|
||||||
@@ -1,156 +1,73 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
import asyncio
|
import asyncio
|
||||||
import base64
|
|
||||||
import binascii
|
|
||||||
import logging
|
import logging
|
||||||
import sys
|
|
||||||
import time
|
import time
|
||||||
from email import policy
|
import sys
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
|
from email import policy
|
||||||
from email.utils import parseaddr
|
from email.utils import parseaddr
|
||||||
from smtplib import SMTP as SMTPClient
|
|
||||||
|
|
||||||
from aiosmtpd.controller import Controller
|
from aiosmtpd.controller import Controller
|
||||||
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
from .common_encrypted_subjects import common_encrypted_subjects
|
|
||||||
from .config import read_config
|
from .config import read_config
|
||||||
|
|
||||||
|
|
||||||
def check_openpgp_payload(payload: bytes):
|
|
||||||
"""Checks the OpenPGP payload.
|
|
||||||
|
|
||||||
OpenPGP payload must consist only of PKESK and SKESK packets
|
|
||||||
terminated by a single SEIPD packet.
|
|
||||||
|
|
||||||
Returns True if OpenPGP payload is correct,
|
|
||||||
False otherwise.
|
|
||||||
|
|
||||||
May raise IndexError while trying to read OpenPGP packet header
|
|
||||||
if it is truncated.
|
|
||||||
"""
|
|
||||||
i = 0
|
|
||||||
while i < len(payload):
|
|
||||||
# Only OpenPGP format is allowed.
|
|
||||||
if payload[i] & 0xC0 != 0xC0:
|
|
||||||
return False
|
|
||||||
|
|
||||||
packet_type_id = payload[i] & 0x3F
|
|
||||||
i += 1
|
|
||||||
if payload[i] < 192:
|
|
||||||
# One-octet length.
|
|
||||||
body_len = payload[i]
|
|
||||||
i += 1
|
|
||||||
elif payload[i] < 224:
|
|
||||||
# Two-octet length.
|
|
||||||
body_len = ((payload[i] - 192) << 8) + payload[i + 1] + 192
|
|
||||||
i += 2
|
|
||||||
elif payload[i] == 255:
|
|
||||||
# Five-octet length.
|
|
||||||
body_len = (
|
|
||||||
(payload[i + 1] << 24)
|
|
||||||
| (payload[i + 2] << 16)
|
|
||||||
| (payload[i + 3] << 8)
|
|
||||||
| payload[i + 4]
|
|
||||||
)
|
|
||||||
i += 5
|
|
||||||
else:
|
|
||||||
# Partial body length is not allowed.
|
|
||||||
return False
|
|
||||||
|
|
||||||
i += body_len
|
|
||||||
|
|
||||||
if i == len(payload):
|
|
||||||
# Last packet should be
|
|
||||||
# Symmetrically Encrypted and Integrity Protected Data Packet (SEIPD)
|
|
||||||
#
|
|
||||||
# This is the only place where this function may return `True`.
|
|
||||||
return packet_type_id == 18
|
|
||||||
elif packet_type_id not in [1, 3]:
|
|
||||||
# All packets except the last one must be either
|
|
||||||
# Public-Key Encrypted Session Key Packet (PKESK)
|
|
||||||
# or
|
|
||||||
# Symmetric-Key Encrypted Session Key Packet (SKESK)
|
|
||||||
return False
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def check_armored_payload(payload: str):
|
|
||||||
prefix = "-----BEGIN PGP MESSAGE-----\r\n\r\n"
|
|
||||||
if not payload.startswith(prefix):
|
|
||||||
return False
|
|
||||||
payload = payload.removeprefix(prefix)
|
|
||||||
|
|
||||||
suffix = "-----END PGP MESSAGE-----\r\n\r\n"
|
|
||||||
if not payload.endswith(suffix):
|
|
||||||
return False
|
|
||||||
payload = payload.removesuffix(suffix)
|
|
||||||
|
|
||||||
# Remove CRC24.
|
|
||||||
payload = payload.rpartition("=")[0]
|
|
||||||
|
|
||||||
try:
|
|
||||||
payload = base64.b64decode(payload)
|
|
||||||
except binascii.Error:
|
|
||||||
return False
|
|
||||||
|
|
||||||
try:
|
|
||||||
return check_openpgp_payload(payload)
|
|
||||||
except IndexError:
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def check_encrypted(message):
|
def check_encrypted(message):
|
||||||
"""Check that the message is an OpenPGP-encrypted message.
|
"""Check that the message is an OpenPGP-encrypted message."""
|
||||||
|
|
||||||
MIME structure of the message must correspond to <https://www.rfc-editor.org/rfc/rfc3156>.
|
|
||||||
"""
|
|
||||||
if not message.is_multipart():
|
if not message.is_multipart():
|
||||||
return False
|
return False
|
||||||
if message.get("subject") not in common_encrypted_subjects:
|
if message.get("subject") != "...":
|
||||||
return False
|
return False
|
||||||
if message.get_content_type() != "multipart/encrypted":
|
if message.get_content_type() != "multipart/encrypted":
|
||||||
return False
|
return False
|
||||||
parts_count = 0
|
parts_count = 0
|
||||||
for part in message.iter_parts():
|
for part in message.iter_parts():
|
||||||
# We explicitly check Content-Type of each part later,
|
|
||||||
# but this is to be absolutely sure `get_payload()` returns string and not list.
|
|
||||||
if part.is_multipart():
|
|
||||||
return False
|
|
||||||
|
|
||||||
if parts_count == 0:
|
if parts_count == 0:
|
||||||
if part.get_content_type() != "application/pgp-encrypted":
|
if part.get_content_type() != "application/pgp-encrypted":
|
||||||
return False
|
return False
|
||||||
|
|
||||||
payload = part.get_payload()
|
|
||||||
if payload.strip() != "Version: 1":
|
|
||||||
return False
|
|
||||||
elif parts_count == 1:
|
elif parts_count == 1:
|
||||||
if part.get_content_type() != "application/octet-stream":
|
if part.get_content_type() != "application/octet-stream":
|
||||||
return False
|
return False
|
||||||
|
|
||||||
if not check_armored_payload(part.get_payload()):
|
|
||||||
return False
|
|
||||||
else:
|
else:
|
||||||
return False
|
return False
|
||||||
parts_count += 1
|
parts_count += 1
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def check_mdn(message, envelope):
|
||||||
|
if len(envelope.rcpt_tos) != 1:
|
||||||
|
return False
|
||||||
|
|
||||||
|
for name in ["auto-submitted", "chat-version"]:
|
||||||
|
if not message.get(name):
|
||||||
|
return False
|
||||||
|
|
||||||
|
if message.get_content_type() != "multipart/report":
|
||||||
|
return False
|
||||||
|
|
||||||
|
body = message.get_body()
|
||||||
|
if body.get_content_type() != "text/plain":
|
||||||
|
return False
|
||||||
|
|
||||||
|
if list(body.iter_attachments()) or list(body.iter_parts()):
|
||||||
|
return False
|
||||||
|
|
||||||
|
# even with all mime-structural checks an attacker
|
||||||
|
# could try to abuse the subject or body to contain links or other
|
||||||
|
# annoyance -- we skip on checking subject/body for now as Delta Chat
|
||||||
|
# should evolve to create E2E-encrypted read receipts anyway.
|
||||||
|
# and then MDNs are just encrypted mail and can pass the border
|
||||||
|
# to other instances.
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
async def asyncmain_beforequeue(config):
|
async def asyncmain_beforequeue(config):
|
||||||
port = config.filtermail_smtp_port
|
port = config.filtermail_smtp_port
|
||||||
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
||||||
|
|
||||||
|
|
||||||
def recipient_matches_passthrough(recipient, passthrough_recipients):
|
|
||||||
for addr in passthrough_recipients:
|
|
||||||
if recipient == addr:
|
|
||||||
return True
|
|
||||||
if addr[0] == "@" and recipient.endswith(addr):
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
class BeforeQueueHandler:
|
class BeforeQueueHandler:
|
||||||
def __init__(self, config):
|
def __init__(self, config):
|
||||||
self.config = config
|
self.config = config
|
||||||
@@ -187,34 +104,20 @@ class BeforeQueueHandler:
|
|||||||
mail_encrypted = check_encrypted(message)
|
mail_encrypted = check_encrypted(message)
|
||||||
|
|
||||||
_, from_addr = parseaddr(message.get("from").strip())
|
_, from_addr = parseaddr(message.get("from").strip())
|
||||||
envelope_from_domain = from_addr.split("@").pop()
|
|
||||||
|
|
||||||
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
||||||
if envelope.mail_from.lower() != from_addr.lower():
|
if envelope.mail_from.lower() != from_addr.lower():
|
||||||
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
||||||
|
|
||||||
if mail_encrypted:
|
if not mail_encrypted and check_mdn(message, envelope):
|
||||||
print("Filtering encrypted mail.", file=sys.stderr)
|
|
||||||
else:
|
|
||||||
print("Filtering unencrypted mail.", file=sys.stderr)
|
|
||||||
|
|
||||||
if envelope.mail_from in self.config.passthrough_senders:
|
|
||||||
return
|
return
|
||||||
|
|
||||||
passthrough_recipients = self.config.passthrough_recipients
|
passthrough_recipients = self.config.passthrough_recipients
|
||||||
|
envelope_from_domain = from_addr.split("@").pop()
|
||||||
is_securejoin = message.get("secure-join") in [
|
|
||||||
"vc-request",
|
|
||||||
"vg-request",
|
|
||||||
]
|
|
||||||
if is_securejoin:
|
|
||||||
return
|
|
||||||
|
|
||||||
for recipient in envelope.rcpt_tos:
|
for recipient in envelope.rcpt_tos:
|
||||||
if envelope.mail_from == recipient:
|
if envelope.mail_from == recipient:
|
||||||
# Always allow sending emails to self.
|
# Always allow sending emails to self.
|
||||||
continue
|
continue
|
||||||
if recipient_matches_passthrough(recipient, passthrough_recipients):
|
if recipient in passthrough_recipients:
|
||||||
continue
|
continue
|
||||||
res = recipient.split("@")
|
res = recipient.split("@")
|
||||||
if len(res) != 2:
|
if len(res) != 2:
|
||||||
@@ -223,8 +126,12 @@ class BeforeQueueHandler:
|
|||||||
|
|
||||||
is_outgoing = recipient_domain != envelope_from_domain
|
is_outgoing = recipient_domain != envelope_from_domain
|
||||||
if is_outgoing and not mail_encrypted:
|
if is_outgoing and not mail_encrypted:
|
||||||
print("Rejected unencrypted mail.", file=sys.stderr)
|
is_securejoin = message.get("secure-join") in [
|
||||||
return f"500 Invalid unencrypted mail to <{recipient}>"
|
"vc-request",
|
||||||
|
"vg-request",
|
||||||
|
]
|
||||||
|
if not is_securejoin:
|
||||||
|
return f"500 Invalid unencrypted mail to <{recipient}>"
|
||||||
|
|
||||||
|
|
||||||
class SendRateLimiter:
|
class SendRateLimiter:
|
||||||
|
|||||||
@@ -1,11 +1,10 @@
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=Chatmail Postfix before queue filter
|
Description=Chatmail Postfix BeforeQeue filter
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} {config_path}
|
ExecStart={execpath} {config_path}
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=filtermail
|
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
@@ -1,50 +1,17 @@
|
|||||||
[params]
|
[params]
|
||||||
|
|
||||||
# mail domain (MUST be set to fully qualified chat mail domain)
|
# mail domain (MUST be set to fully qualified chat mail domain)
|
||||||
mail_domain = {mail_domain}
|
mailname = {mailname}
|
||||||
|
|
||||||
#
|
#
|
||||||
# If you only do private test deploys, you don't need to modify any settings below
|
# If you only do private test deploys, you don't need to modify any settings below
|
||||||
#
|
#
|
||||||
|
|
||||||
#
|
|
||||||
# Restrictions on user addresses
|
|
||||||
#
|
|
||||||
|
|
||||||
# how many mails a user can send out per minute
|
# how many mails a user can send out per minute
|
||||||
max_user_send_per_minute = 60
|
max_user_send_per_minute = 60
|
||||||
|
|
||||||
# maximum mailbox size of a chatmail address
|
|
||||||
max_mailbox_size = 100M
|
|
||||||
|
|
||||||
# maximum message size for an e-mail in bytes
|
|
||||||
max_message_size = 31457280
|
|
||||||
|
|
||||||
# days after which mails are unconditionally deleted
|
|
||||||
delete_mails_after = 20
|
|
||||||
|
|
||||||
# days after which users without a successful login are deleted (database and mails)
|
|
||||||
delete_inactive_users_after = 90
|
|
||||||
|
|
||||||
# minimum length a username must have
|
|
||||||
username_min_length = 9
|
|
||||||
|
|
||||||
# maximum length a username can have
|
|
||||||
username_max_length = 9
|
|
||||||
|
|
||||||
# minimum length a password must have
|
|
||||||
password_min_length = 9
|
|
||||||
|
|
||||||
# list of chatmail addresses which can send outbound un-encrypted mail
|
|
||||||
passthrough_senders =
|
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
passthrough_recipients =
|
||||||
passthrough_recipients = xstore@testrun.org
|
|
||||||
|
|
||||||
#
|
|
||||||
# Deployment Details
|
|
||||||
#
|
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
# where the filtermail SMTP service listens
|
||||||
filtermail_smtp_port = 10080
|
filtermail_smtp_port = 10080
|
||||||
@@ -52,47 +19,6 @@ filtermail_smtp_port = 10080
|
|||||||
# postfix accepts on the localhost reinject SMTP port
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
postfix_reinject_port = 10025
|
postfix_reinject_port = 10025
|
||||||
|
|
||||||
# if set to "True" IPv6 is disabled
|
|
||||||
disable_ipv6 = False
|
|
||||||
|
|
||||||
# Defaults to https://iroh.{{mail_domain}} and running `iroh-relay` on the chatmail
|
|
||||||
# service.
|
|
||||||
# If you set it to anything else, the service will be disabled
|
|
||||||
# and users will be directed to use the given iroh relay URL.
|
|
||||||
# Set it to empty string if you want users to use their default iroh relay.
|
|
||||||
# iroh_relay =
|
|
||||||
|
|
||||||
# Address on which `mtail` listens,
|
|
||||||
# e.g. 127.0.0.1 or some private network
|
|
||||||
# address like 192.168.10.1.
|
|
||||||
# You can point Prometheus
|
|
||||||
# or some other OpenMetrics-compatible
|
|
||||||
# collector to
|
|
||||||
# http://{{mtail_address}}:3903/metrics
|
|
||||||
# and display collected metrics with Grafana.
|
|
||||||
#
|
|
||||||
# WARNING: do not expose this service
|
|
||||||
# to the public IP address.
|
|
||||||
#
|
|
||||||
# `mtail is not running if the setting is not set.
|
|
||||||
|
|
||||||
# mtail_address = 127.0.0.1
|
|
||||||
|
|
||||||
#
|
|
||||||
# Debugging options
|
|
||||||
#
|
|
||||||
|
|
||||||
# set to True if you want to track imap protocol execution
|
|
||||||
# in per-maildir ".in/.out" files.
|
|
||||||
# Note that you need to manually cleanup these files
|
|
||||||
# so use this option with caution on production servers.
|
|
||||||
imap_rawlog = false
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Privacy Policy
|
|
||||||
#
|
|
||||||
|
|
||||||
# postal address of privacy contact
|
# postal address of privacy contact
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
|
|
||||||
@@ -104,3 +30,4 @@ privacy_pdo =
|
|||||||
|
|
||||||
# postal address of the privacy supervisor
|
# postal address of the privacy supervisor
|
||||||
privacy_supervisor =
|
privacy_supervisor =
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
|
|
||||||
[privacy]
|
[privacy]
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org xstore@testrun.org
|
passthrough_recipients = privacy@testrun.org
|
||||||
|
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
|
|||||||
@@ -1,31 +0,0 @@
|
|||||||
import sys
|
|
||||||
|
|
||||||
from .config import read_config
|
|
||||||
from .dictproxy import DictProxy
|
|
||||||
|
|
||||||
|
|
||||||
class LastLoginDictProxy(DictProxy):
|
|
||||||
def __init__(self, config):
|
|
||||||
super().__init__()
|
|
||||||
self.config = config
|
|
||||||
|
|
||||||
def handle_set(self, addr, parts):
|
|
||||||
keyname = parts[1].split("/")
|
|
||||||
value = parts[2] if len(parts) > 2 else ""
|
|
||||||
if keyname[0] == "shared" and keyname[1] == "last-login":
|
|
||||||
if addr.startswith("echo@"):
|
|
||||||
return True
|
|
||||||
addr = keyname[2]
|
|
||||||
timestamp = int(value)
|
|
||||||
user = self.config.get_user(addr)
|
|
||||||
user.set_last_login_timestamp(timestamp)
|
|
||||||
return True
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
socket, config_path = sys.argv[1:]
|
|
||||||
config = read_config(config_path)
|
|
||||||
dictproxy = LastLoginDictProxy(config=config)
|
|
||||||
dictproxy.serve_forever_from_socket(socket)
|
|
||||||
@@ -1,101 +0,0 @@
|
|||||||
import logging
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from .config import read_config
|
|
||||||
from .dictproxy import DictProxy
|
|
||||||
from .filedict import FileDict
|
|
||||||
from .notifier import Notifier
|
|
||||||
|
|
||||||
|
|
||||||
class Metadata:
|
|
||||||
# each SETMETADATA on this key appends to a list of unique device tokens
|
|
||||||
# which only ever get removed if the upstream indicates the token is invalid
|
|
||||||
DEVICETOKEN_KEY = "devicetoken"
|
|
||||||
|
|
||||||
def __init__(self, vmail_dir):
|
|
||||||
self.vmail_dir = vmail_dir
|
|
||||||
|
|
||||||
def get_metadata_dict(self, addr):
|
|
||||||
return FileDict(self.vmail_dir / addr / "metadata.json")
|
|
||||||
|
|
||||||
def add_token_to_addr(self, addr, token):
|
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
|
||||||
tokens = data.setdefault(self.DEVICETOKEN_KEY, [])
|
|
||||||
if token not in tokens:
|
|
||||||
tokens.append(token)
|
|
||||||
|
|
||||||
def remove_token_from_addr(self, addr, token):
|
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
|
||||||
tokens = data.get(self.DEVICETOKEN_KEY, [])
|
|
||||||
if token in tokens:
|
|
||||||
tokens.remove(token)
|
|
||||||
|
|
||||||
def get_tokens_for_addr(self, addr):
|
|
||||||
mdict = self.get_metadata_dict(addr).read()
|
|
||||||
return mdict.get(self.DEVICETOKEN_KEY, [])
|
|
||||||
|
|
||||||
|
|
||||||
class MetadataDictProxy(DictProxy):
|
|
||||||
def __init__(self, notifier, metadata, iroh_relay=None):
|
|
||||||
super().__init__()
|
|
||||||
self.notifier = notifier
|
|
||||||
self.metadata = metadata
|
|
||||||
self.iroh_relay = iroh_relay
|
|
||||||
|
|
||||||
def handle_lookup(self, parts):
|
|
||||||
# Lpriv/43f5f508a7ea0366dff30200c15250e3/devicetoken\tlkj123poi@c2.testrun.org
|
|
||||||
keyparts = parts[0].split("/", 2)
|
|
||||||
if keyparts[0] == "priv":
|
|
||||||
keyname = keyparts[2]
|
|
||||||
addr = parts[1]
|
|
||||||
if keyname == self.metadata.DEVICETOKEN_KEY:
|
|
||||||
res = " ".join(self.metadata.get_tokens_for_addr(addr))
|
|
||||||
return f"O{res}\n"
|
|
||||||
elif keyparts[0] == "shared":
|
|
||||||
keyname = keyparts[2]
|
|
||||||
if (
|
|
||||||
keyname == "vendor/vendor.dovecot/pvt/server/vendor/deltachat/irohrelay"
|
|
||||||
and self.iroh_relay
|
|
||||||
):
|
|
||||||
# Handle `GETMETADATA "" /shared/vendor/deltachat/irohrelay`
|
|
||||||
return f"O{self.iroh_relay}\n"
|
|
||||||
logging.warning(f"lookup ignored: {parts!r}")
|
|
||||||
return "N\n"
|
|
||||||
|
|
||||||
def handle_set(self, addr, parts):
|
|
||||||
# For documentation on key structure see
|
|
||||||
# https://github.com/dovecot/core/blob/main/src/lib-storage/mailbox-attribute.h
|
|
||||||
keyname = parts[1].split("/")
|
|
||||||
value = parts[2] if len(parts) > 2 else ""
|
|
||||||
if keyname[0] == "priv" and keyname[2] == self.metadata.DEVICETOKEN_KEY:
|
|
||||||
self.metadata.add_token_to_addr(addr, value)
|
|
||||||
return True
|
|
||||||
elif keyname[0] == "priv" and keyname[2] == "messagenew":
|
|
||||||
self.notifier.new_message_for_addr(addr, self.metadata)
|
|
||||||
return True
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
socket, config_path = sys.argv[1:]
|
|
||||||
|
|
||||||
config = read_config(config_path)
|
|
||||||
iroh_relay = config.iroh_relay
|
|
||||||
|
|
||||||
vmail_dir = config.mailboxes_dir
|
|
||||||
if not vmail_dir.exists():
|
|
||||||
logging.error("vmail dir does not exist: %r", vmail_dir)
|
|
||||||
return 1
|
|
||||||
|
|
||||||
queue_dir = vmail_dir / "pending_notifications"
|
|
||||||
queue_dir.mkdir(exist_ok=True)
|
|
||||||
metadata = Metadata(vmail_dir)
|
|
||||||
notifier = Notifier(queue_dir)
|
|
||||||
notifier.start_notification_threads(metadata.remove_token_from_addr)
|
|
||||||
|
|
||||||
dictproxy = MetadataDictProxy(
|
|
||||||
notifier=notifier, metadata=metadata, iroh_relay=iroh_relay
|
|
||||||
)
|
|
||||||
|
|
||||||
dictproxy.serve_forever_from_socket(socket)
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
#!/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():
|
|
||||||
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()
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
"""
|
|
||||||
migration code from old sqlite databases into per-maildir "password" files
|
|
||||||
where mtime reflects and is updated to be the "last-login" time.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
import sqlite3
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def get_all_rows(path):
|
|
||||||
assert path.exists()
|
|
||||||
uri = f"file:{path}?mode=ro"
|
|
||||||
sqlconn = sqlite3.connect(uri, timeout=60, isolation_level="DEFERRED", uri=True)
|
|
||||||
cur = sqlconn.cursor()
|
|
||||||
cur.execute("SELECT * from users")
|
|
||||||
rows = cur.fetchall()
|
|
||||||
sqlconn.close()
|
|
||||||
return rows
|
|
||||||
|
|
||||||
|
|
||||||
def migrate_from_db_to_maildir(config, chunking=10000):
|
|
||||||
path = config.passdb_path
|
|
||||||
if not path.exists():
|
|
||||||
return
|
|
||||||
|
|
||||||
all_rows = get_all_rows(path)
|
|
||||||
|
|
||||||
# don't transfer special/CI accounts
|
|
||||||
rows = [row for row in all_rows if row[0][:3] not in ("ci-", "ac_")]
|
|
||||||
|
|
||||||
logging.info(f"ignoring {len(all_rows)-len(rows)} CI accounts")
|
|
||||||
logging.info(f"migrating {len(rows)} sqlite database passwords to user dirs")
|
|
||||||
|
|
||||||
for i, row in enumerate(rows):
|
|
||||||
addr = row[0]
|
|
||||||
enc_password = row[1]
|
|
||||||
user = config.get_user(addr)
|
|
||||||
user.set_password(enc_password)
|
|
||||||
|
|
||||||
if len(row) == 3 and row[2]:
|
|
||||||
timestamp = int(row[2])
|
|
||||||
user.set_last_login_timestamp(timestamp)
|
|
||||||
|
|
||||||
if i > 0 and i % chunking == 0:
|
|
||||||
logging.info(f"migration-progress: {i} passwords transferred")
|
|
||||||
|
|
||||||
logging.info("migration: all passwords migrated")
|
|
||||||
oldpath = config.passdb_path.with_suffix(config.passdb_path.suffix + ".old")
|
|
||||||
os.rename(config.passdb_path, oldpath)
|
|
||||||
for path in config.passdb_path.parent.iterdir():
|
|
||||||
if path.name.startswith(config.passdb_path.name + "-"):
|
|
||||||
path.unlink()
|
|
||||||
logging.info(f"migration: moved database to {oldpath!r}")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
config = read_config(sys.argv[1])
|
|
||||||
logging.basicConfig(level=logging.INFO)
|
|
||||||
migrate_from_db_to_maildir(config)
|
|
||||||
@@ -1,31 +1,23 @@
|
|||||||
#!/usr/local/lib/chatmaild/venv/bin/python3
|
#!/usr/bin/python3
|
||||||
|
|
||||||
"""CGI script for creating new accounts."""
|
""" CGI script for creating new accounts. """
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import random
|
import random
|
||||||
import secrets
|
|
||||||
import string
|
|
||||||
|
|
||||||
from chatmaild.config import Config, read_config
|
mailname_path = "/etc/mailname"
|
||||||
|
|
||||||
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
|
||||||
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
|
||||||
ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
|
||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(config: Config):
|
def create_newemail_dict(domain):
|
||||||
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
password = "".join(
|
user = "".join(random.choices(alphanumeric, k=9))
|
||||||
secrets.choice(ALPHANUMERIC_PUNCT)
|
password = "".join(random.choices(alphanumeric, k=12))
|
||||||
for _ in range(config.password_min_length + 3)
|
return dict(email=f"{user}@{domain}", password=f"{password}")
|
||||||
)
|
|
||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
config = read_config(CONFIG_PATH)
|
domain = open(mailname_path).read().strip()
|
||||||
creds = create_newemail_dict(config)
|
creds = create_newemail_dict(domain=domain)
|
||||||
|
|
||||||
print("Content-Type: application/json")
|
print("Content-Type: application/json")
|
||||||
print("")
|
print("")
|
||||||
|
|||||||
@@ -1,166 +0,0 @@
|
|||||||
"""
|
|
||||||
This modules provides notification machinery for transmitting device tokens to
|
|
||||||
a central notification server which in turn contacts a phone provider's notification server
|
|
||||||
to trigger Delta Chat apps to retrieve messages and provide instant notifications to users.
|
|
||||||
|
|
||||||
The Notifier class arranges the queuing of tokens in separate PriorityQueues
|
|
||||||
from which NotifyThreads take and transmit them via HTTPS
|
|
||||||
to the `notifications.delta.chat` service.
|
|
||||||
The current lack of proper HTTP/2-support in Python leads us
|
|
||||||
to use multiple threads and connections to the Rust-implemented `notifications.delta.chat`
|
|
||||||
which itself uses HTTP/2 and thus only a single connection to phone-notification providers.
|
|
||||||
|
|
||||||
If a token fails to cause a successful notification
|
|
||||||
it is moved to a retry-number specific PriorityQueue
|
|
||||||
which handles all tokens that failed a particular number of times
|
|
||||||
and which are scheduled for retry using exponential back-off timing.
|
|
||||||
If a token notification would be scheduled more than DROP_DEADLINE seconds
|
|
||||||
after its first attempt, it is dropped with a log error.
|
|
||||||
|
|
||||||
Note that tokens are completely opaque to the notification machinery here
|
|
||||||
and will in the future be encrypted foreclosing all ability to distinguish
|
|
||||||
which device token ultimately goes to which phone-provider notification service,
|
|
||||||
or to understand the relation of "device tokens" and chatmail addresses.
|
|
||||||
The meaning and format of tokens is basically a matter of Delta-Chat Core and
|
|
||||||
the `notification.delta.chat` service.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import logging
|
|
||||||
import math
|
|
||||||
import os
|
|
||||||
import time
|
|
||||||
from dataclasses import dataclass
|
|
||||||
from pathlib import Path
|
|
||||||
from queue import PriorityQueue
|
|
||||||
from threading import Thread
|
|
||||||
from uuid import uuid4
|
|
||||||
|
|
||||||
import requests
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class PersistentQueueItem:
|
|
||||||
path: Path
|
|
||||||
addr: str
|
|
||||||
start_ts: int
|
|
||||||
token: str
|
|
||||||
|
|
||||||
def delete(self):
|
|
||||||
self.path.unlink(missing_ok=True)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def create(cls, queue_dir, addr, start_ts, token):
|
|
||||||
queue_id = uuid4().hex
|
|
||||||
start_ts = int(start_ts)
|
|
||||||
path = queue_dir.joinpath(queue_id)
|
|
||||||
tmp_path = path.with_name(path.name + ".tmp")
|
|
||||||
tmp_path.write_text(f"{addr}\n{start_ts}\n{token}")
|
|
||||||
os.rename(tmp_path, path)
|
|
||||||
return cls(path, addr, start_ts, token)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def read_from_path(cls, path):
|
|
||||||
addr, start_ts, token = path.read_text().split("\n", maxsplit=2)
|
|
||||||
return cls(path, addr, int(start_ts), token)
|
|
||||||
|
|
||||||
def __lt__(self, other):
|
|
||||||
return self.start_ts < other.start_ts
|
|
||||||
|
|
||||||
|
|
||||||
class Notifier:
|
|
||||||
URL = "https://notifications.delta.chat/notify"
|
|
||||||
CONNECTION_TIMEOUT = 60.0 # seconds until http-request is given up
|
|
||||||
BASE_DELAY = 8.0 # base seconds for exponential back-off delay
|
|
||||||
DROP_DEADLINE = 5 * 60 * 60 # drop notifications after 5 hours
|
|
||||||
|
|
||||||
def __init__(self, queue_dir):
|
|
||||||
self.queue_dir = queue_dir
|
|
||||||
max_tries = int(math.log(self.DROP_DEADLINE, self.BASE_DELAY)) + 1
|
|
||||||
self.retry_queues = [PriorityQueue() for _ in range(max_tries)]
|
|
||||||
|
|
||||||
def compute_delay(self, retry_num):
|
|
||||||
return 0 if retry_num == 0 else pow(self.BASE_DELAY, retry_num)
|
|
||||||
|
|
||||||
def new_message_for_addr(self, addr, metadata):
|
|
||||||
start_ts = int(time.time())
|
|
||||||
for token in metadata.get_tokens_for_addr(addr):
|
|
||||||
queue_item = PersistentQueueItem.create(
|
|
||||||
self.queue_dir, addr, start_ts, token
|
|
||||||
)
|
|
||||||
self.queue_for_retry(queue_item)
|
|
||||||
|
|
||||||
def requeue_persistent_queue_items(self):
|
|
||||||
for queue_path in self.queue_dir.iterdir():
|
|
||||||
if queue_path.name.endswith(".tmp"):
|
|
||||||
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
|
||||||
queue_path.unlink()
|
|
||||||
continue
|
|
||||||
queue_item = PersistentQueueItem.read_from_path(queue_path)
|
|
||||||
self.queue_for_retry(queue_item)
|
|
||||||
|
|
||||||
def queue_for_retry(self, queue_item, retry_num=0):
|
|
||||||
delay = self.compute_delay(retry_num)
|
|
||||||
when = int(time.time()) + delay
|
|
||||||
deadline = queue_item.start_ts + self.DROP_DEADLINE
|
|
||||||
if retry_num >= len(self.retry_queues) or when > deadline:
|
|
||||||
queue_item.delete()
|
|
||||||
logging.error(f"notification exceeded deadline: {queue_item.token!r}")
|
|
||||||
return
|
|
||||||
|
|
||||||
self.retry_queues[retry_num].put((when, queue_item))
|
|
||||||
|
|
||||||
def start_notification_threads(self, remove_token_from_addr):
|
|
||||||
self.requeue_persistent_queue_items()
|
|
||||||
threads = {}
|
|
||||||
for retry_num in range(len(self.retry_queues)):
|
|
||||||
# use 4 threads for first-try tokens and less for subsequent tries
|
|
||||||
num_threads = 4 if retry_num == 0 else 2
|
|
||||||
threads[retry_num] = []
|
|
||||||
for _ in range(num_threads):
|
|
||||||
thread = NotifyThread(self, retry_num, remove_token_from_addr)
|
|
||||||
threads[retry_num].append(thread)
|
|
||||||
thread.start()
|
|
||||||
return threads
|
|
||||||
|
|
||||||
|
|
||||||
class NotifyThread(Thread):
|
|
||||||
def __init__(self, notifier, retry_num, remove_token_from_addr):
|
|
||||||
super().__init__(daemon=True)
|
|
||||||
self.notifier = notifier
|
|
||||||
self.retry_num = retry_num
|
|
||||||
self.remove_token_from_addr = remove_token_from_addr
|
|
||||||
|
|
||||||
def stop(self):
|
|
||||||
self.notifier.retry_queues[self.retry_num].put((None, None))
|
|
||||||
|
|
||||||
def run(self):
|
|
||||||
requests_session = requests.Session()
|
|
||||||
while self.retry_one(requests_session):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def retry_one(self, requests_session, sleep=time.sleep):
|
|
||||||
when, queue_item = self.notifier.retry_queues[self.retry_num].get()
|
|
||||||
if when is None:
|
|
||||||
return False
|
|
||||||
wait_time = when - int(time.time())
|
|
||||||
if wait_time > 0:
|
|
||||||
sleep(wait_time)
|
|
||||||
self.perform_request_to_notification_server(requests_session, queue_item)
|
|
||||||
return True
|
|
||||||
|
|
||||||
def perform_request_to_notification_server(self, requests_session, queue_item):
|
|
||||||
timeout = self.notifier.CONNECTION_TIMEOUT
|
|
||||||
token = queue_item.token
|
|
||||||
try:
|
|
||||||
res = requests_session.post(self.notifier.URL, data=token, timeout=timeout)
|
|
||||||
except requests.exceptions.RequestException as e:
|
|
||||||
res = e
|
|
||||||
else:
|
|
||||||
if res.status_code in (200, 410):
|
|
||||||
if res.status_code == 410:
|
|
||||||
self.remove_token_from_addr(queue_item.addr, token)
|
|
||||||
queue_item.delete()
|
|
||||||
return
|
|
||||||
|
|
||||||
logging.warning(f"Notification request failed: {res!r}")
|
|
||||||
self.notifier.queue_for_retry(queue_item, retry_num=self.retry_num + 1)
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
From: {from_addr}
|
From: {from_addr}
|
||||||
To: {to_addr}
|
To: {to_addr}
|
||||||
Subject: {subject}
|
Subject: ...
|
||||||
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
||||||
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
||||||
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
From: {from_addr}
|
|
||||||
To: {to_addr}
|
|
||||||
Subject: ...
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
|
||||||
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
|
||||||
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
|
||||||
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
|
||||||
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
|
||||||
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
|
||||||
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
|
||||||
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
|
||||||
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
|
||||||
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
|
||||||
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
|
||||||
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
|
||||||
Content-Description: PGP/MIME version identification
|
|
||||||
Content-Type: application/pgp-encrypted
|
|
||||||
|
|
||||||
Version: 1
|
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
|
||||||
Content-Description: OpenPGP encrypted message
|
|
||||||
Content-Disposition: inline; filename="encrypted.asc";
|
|
||||||
Content-Type: application/octet-stream; name="encrypted.asc"
|
|
||||||
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
|
||||||
|
|
||||||
yxJiAAAAAABIZWxsbyB3b3JsZCE=
|
|
||||||
=1I/B
|
|
||||||
-----END PGP MESSAGE-----
|
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -7,7 +7,7 @@ Date: Sun, 15 Oct 2023 16:41:44 +0000
|
|||||||
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
Chat-Version: 1.0
|
Chat-Version: 1.0
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;
|
||||||
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
||||||
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
||||||
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
||||||
@@ -20,4 +20,4 @@ Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
|||||||
|
|
||||||
Hi!
|
Hi!
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,13 +1,11 @@
|
|||||||
|
import random
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import itertools
|
import itertools
|
||||||
import os
|
|
||||||
import random
|
|
||||||
from email import policy
|
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
from pathlib import Path
|
from email import policy
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
|
from chatmaild.database import Database
|
||||||
from chatmaild.config import read_config, write_initial_config
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
|
||||||
|
|
||||||
@@ -15,12 +13,8 @@ from chatmaild.config import read_config, write_initial_config
|
|||||||
def make_config(tmp_path):
|
def make_config(tmp_path):
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
|
||||||
def make_conf(mail_domain, settings=None):
|
def make_conf(mailname):
|
||||||
basedir = tmp_path.joinpath(f"vmail/{mail_domain}")
|
write_initial_config(inipath, mailname=mailname)
|
||||||
basedir.mkdir(parents=True, exist_ok=True)
|
|
||||||
overrides = settings.copy() if settings else {}
|
|
||||||
overrides["mailboxes_dir"] = str(basedir)
|
|
||||||
write_initial_config(inipath, mail_domain, overrides=overrides)
|
|
||||||
return read_config(inipath)
|
return read_config(inipath)
|
||||||
|
|
||||||
return make_conf
|
return make_conf
|
||||||
@@ -33,12 +27,7 @@ def example_config(make_config):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain(example_config):
|
def maildomain(example_config):
|
||||||
return example_config.mail_domain
|
return example_config.mailname
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def testaddr(maildomain):
|
|
||||||
return f"user.name@{maildomain}"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -59,40 +48,21 @@ def gencreds(maildomain):
|
|||||||
return lambda domain=None: next(gen(domain))
|
return lambda domain=None: next(gen(domain))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def db(tmpdir):
|
||||||
|
db_path = tmpdir / "passdb.sqlite"
|
||||||
|
print("database path:", db_path)
|
||||||
|
return Database(db_path)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildata(request):
|
def maildata(request):
|
||||||
try:
|
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
||||||
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
|
||||||
except TypeError:
|
|
||||||
# in python3.9 or lower, the above doesn't work, so we get datadir this way:
|
|
||||||
datadir = Path(os.getcwd()).joinpath("chatmaild/src/chatmaild/tests/mail-data")
|
|
||||||
|
|
||||||
assert datadir.exists(), datadir
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
def maildata(name, from_addr, to_addr, subject="..."):
|
def maildata(name, from_addr, to_addr):
|
||||||
# Using `.read_bytes().decode()` instead of `.read_text()` to preserve newlines.
|
data = datadir.joinpath(name).read_text()
|
||||||
data = datadir.joinpath(name).read_bytes().decode()
|
text = data.format(from_addr=from_addr, to_addr=to_addr)
|
||||||
|
|
||||||
text = data.format(from_addr=from_addr, to_addr=to_addr, subject=subject)
|
|
||||||
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
||||||
|
|
||||||
return maildata
|
return maildata
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def mockout():
|
|
||||||
class MockOut:
|
|
||||||
captured_red = []
|
|
||||||
captured_green = []
|
|
||||||
captured_plain = []
|
|
||||||
|
|
||||||
def red(self, msg):
|
|
||||||
self.captured_red.append(msg)
|
|
||||||
|
|
||||||
def green(self, msg):
|
|
||||||
self.captured_green.append(msg)
|
|
||||||
|
|
||||||
def __call__(self, msg):
|
|
||||||
self.captured_plain.append(msg)
|
|
||||||
|
|
||||||
return MockOut()
|
|
||||||
|
|||||||
@@ -1,23 +1,22 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_basic(example_config):
|
def test_read_config_basic(make_config):
|
||||||
assert example_config.mail_domain == "chat.example.org"
|
config = make_config("chat.example.org")
|
||||||
assert not example_config.privacy_supervisor and not example_config.privacy_mail
|
assert config.mailname == "chat.example.org"
|
||||||
assert not example_config.privacy_pdo and not example_config.privacy_postal
|
assert not config.privacy_supervisor and not config.privacy_mail
|
||||||
|
assert not config.privacy_pdo and not config.privacy_postal
|
||||||
|
|
||||||
inipath = example_config._inipath
|
inipath = config._inipath
|
||||||
inipath.write_text(inipath.read_text().replace("60", "37"))
|
inipath.write_text(inipath.read_text().replace("60", "37"))
|
||||||
example_config = read_config(inipath)
|
config = read_config(inipath)
|
||||||
assert example_config.max_user_send_per_minute == 37
|
assert config.max_user_send_per_minute == 37
|
||||||
assert example_config.mail_domain == "chat.example.org"
|
assert config.mailname == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_testrun(make_config):
|
def test_read_config_testrun(make_config):
|
||||||
config = make_config("something.testrun.org")
|
config = make_config("something.testrun.org")
|
||||||
assert config.mail_domain == "something.testrun.org"
|
assert config.mailname == "something.testrun.org"
|
||||||
assert len(config.privacy_postal.split("\n")) > 1
|
assert len(config.privacy_postal.split("\n")) > 1
|
||||||
assert len(config.privacy_supervisor.split("\n")) > 1
|
assert len(config.privacy_supervisor.split("\n")) > 1
|
||||||
assert len(config.privacy_pdo.split("\n")) > 1
|
assert len(config.privacy_pdo.split("\n")) > 1
|
||||||
@@ -25,42 +24,4 @@ def test_read_config_testrun(make_config):
|
|||||||
assert config.filtermail_smtp_port == 10080
|
assert config.filtermail_smtp_port == 10080
|
||||||
assert config.postfix_reinject_port == 10025
|
assert config.postfix_reinject_port == 10025
|
||||||
assert config.max_user_send_per_minute == 60
|
assert config.max_user_send_per_minute == 60
|
||||||
assert config.max_mailbox_size == "100M"
|
assert config.passthrough_recipients
|
||||||
assert config.delete_mails_after == "20"
|
|
||||||
assert config.username_min_length == 9
|
|
||||||
assert config.username_max_length == 9
|
|
||||||
assert config.password_min_length == 9
|
|
||||||
assert "privacy@testrun.org" in config.passthrough_recipients
|
|
||||||
assert config.passthrough_senders == []
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_userstate_paths(make_config, tmp_path):
|
|
||||||
config = make_config("something.testrun.org")
|
|
||||||
mailboxes_dir = config.mailboxes_dir
|
|
||||||
passdb_path = config.passdb_path
|
|
||||||
assert mailboxes_dir.name == "something.testrun.org"
|
|
||||||
assert str(passdb_path) == "/home/vmail/passdb.sqlite"
|
|
||||||
assert config.mail_domain == "something.testrun.org"
|
|
||||||
path = config.get_user("user1@something.testrun.org").maildir
|
|
||||||
assert not path.exists()
|
|
||||||
assert path == mailboxes_dir.joinpath("user1@something.testrun.org")
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
config.get_user("")
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
config.get_user(None)
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
config.get_user("../some@something.testrun.org").maildir
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
config.get_user("..").maildir
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
config.get_user(".")
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_max_message_size(make_config, tmp_path):
|
|
||||||
config = make_config("something.testrun.org", dict(max_message_size="10000"))
|
|
||||||
assert config.max_message_size == 10000
|
|
||||||
|
|||||||
@@ -1,59 +0,0 @@
|
|||||||
import time
|
|
||||||
|
|
||||||
from chatmaild.delete_inactive_users import delete_inactive_users
|
|
||||||
from chatmaild.doveauth import AuthDictProxy
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_timestamps(example_config):
|
|
||||||
testaddr = "someuser@chat.example.org"
|
|
||||||
user = example_config.get_user(testaddr)
|
|
||||||
|
|
||||||
# password file needs to be set because it's mtime tracks last-login time
|
|
||||||
user.set_password("1l2k3j1l2k3j123")
|
|
||||||
for i in range(10):
|
|
||||||
user.set_last_login_timestamp(86400 * 4 + i)
|
|
||||||
assert user.get_last_login_timestamp() == 86400 * 4
|
|
||||||
|
|
||||||
|
|
||||||
def test_delete_inactive_users(example_config):
|
|
||||||
new = time.time()
|
|
||||||
old = new - (example_config.delete_inactive_users_after * 86400) - 1
|
|
||||||
dictproxy = AuthDictProxy(example_config)
|
|
||||||
|
|
||||||
def create_user(addr, last_login):
|
|
||||||
dictproxy.lookup_passdb(addr, "q9mr3faue")
|
|
||||||
user = example_config.get_user(addr)
|
|
||||||
user.maildir.joinpath("cur").mkdir()
|
|
||||||
user.maildir.joinpath("cur", "something").mkdir()
|
|
||||||
user.set_last_login_timestamp(timestamp=last_login)
|
|
||||||
|
|
||||||
# create some stale and some new accounts
|
|
||||||
to_remove = []
|
|
||||||
for i in range(150):
|
|
||||||
addr = f"oldold{i:03}@chat.example.org"
|
|
||||||
create_user(addr, last_login=old)
|
|
||||||
to_remove.append(addr)
|
|
||||||
|
|
||||||
remain = []
|
|
||||||
for i in range(5):
|
|
||||||
addr = f"newnew{i:03}@chat.example.org"
|
|
||||||
create_user(addr, last_login=new)
|
|
||||||
remain.append(addr)
|
|
||||||
|
|
||||||
# check pre and post-conditions for delete_inactive_users()
|
|
||||||
|
|
||||||
for addr in to_remove:
|
|
||||||
assert example_config.get_user(addr).maildir.exists()
|
|
||||||
|
|
||||||
delete_inactive_users(example_config)
|
|
||||||
|
|
||||||
for p in example_config.mailboxes_dir.iterdir():
|
|
||||||
assert not p.name.startswith("old")
|
|
||||||
|
|
||||||
for addr in to_remove:
|
|
||||||
assert not example_config.get_user(addr).maildir.exists()
|
|
||||||
|
|
||||||
for addr in remain:
|
|
||||||
userdir = example_config.get_user(addr).maildir
|
|
||||||
assert userdir.exists()
|
|
||||||
assert userdir.joinpath("password").read_text()
|
|
||||||
@@ -1,135 +1,74 @@
|
|||||||
import io
|
|
||||||
import json
|
import json
|
||||||
import queue
|
import pytest
|
||||||
import threading
|
import threading
|
||||||
|
import queue
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
import chatmaild.doveauth
|
import chatmaild.doveauth
|
||||||
from chatmaild.doveauth import (
|
from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_request
|
||||||
AuthDictProxy,
|
from chatmaild.database import DBError
|
||||||
is_allowed_to_create,
|
|
||||||
)
|
|
||||||
from chatmaild.newemail import create_newemail_dict
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
def test_basic(db):
|
||||||
def dictproxy(example_config):
|
lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u")
|
||||||
return AuthDictProxy(config=example_config)
|
data = get_user_data(db, "link2xt@c1.testrun.org")
|
||||||
|
|
||||||
|
|
||||||
def test_basic(dictproxy, gencreds):
|
|
||||||
addr, password = gencreds()
|
|
||||||
dictproxy.lookup_passdb(addr, password)
|
|
||||||
data = dictproxy.lookup_userdb(addr)
|
|
||||||
assert data
|
assert data
|
||||||
data2 = dictproxy.lookup_passdb(addr, password)
|
data2 = lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u")
|
||||||
assert data == data2
|
assert data == data2
|
||||||
|
|
||||||
|
|
||||||
def test_iterate_addresses(dictproxy):
|
def test_dont_overwrite_password_on_wrong_login(db):
|
||||||
addresses = []
|
|
||||||
|
|
||||||
for i in range(10):
|
|
||||||
addresses.append(f"asdf1234{i}@chat.example.org")
|
|
||||||
dictproxy.lookup_passdb(addresses[-1], "q9mr3faue")
|
|
||||||
|
|
||||||
res = dictproxy.iter_userdb()
|
|
||||||
assert set(res) == set(addresses)
|
|
||||||
|
|
||||||
|
|
||||||
def test_invalid_username_length(example_config):
|
|
||||||
config = example_config
|
|
||||||
config.username_min_length = 6
|
|
||||||
config.username_max_length = 10
|
|
||||||
password = create_newemail_dict(config)["password"]
|
|
||||||
assert not is_allowed_to_create(config, f"a1234@{config.mail_domain}", password)
|
|
||||||
assert is_allowed_to_create(config, f"012345@{config.mail_domain}", password)
|
|
||||||
assert is_allowed_to_create(config, f"0123456@{config.mail_domain}", password)
|
|
||||||
assert is_allowed_to_create(config, f"0123456789@{config.mail_domain}", password)
|
|
||||||
assert not is_allowed_to_create(
|
|
||||||
config, f"0123456789x@{config.mail_domain}", password
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_dont_overwrite_password_on_wrong_login(dictproxy):
|
|
||||||
"""Test that logging in with a different password doesn't create a new user"""
|
"""Test that logging in with a different password doesn't create a new user"""
|
||||||
res = dictproxy.lookup_passdb(
|
res = lookup_passdb(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983")
|
||||||
"newuser12@chat.example.org", "kajdlkajsldk12l3kj1983"
|
|
||||||
)
|
|
||||||
assert res["password"]
|
assert res["password"]
|
||||||
res2 = dictproxy.lookup_passdb("newuser12@chat.example.org", "kajdslqwe")
|
res2 = lookup_passdb(db, "newuser1@something.org", "kajdlqweqwe")
|
||||||
# this function always returns a password hash, which is actually compared by dovecot.
|
# this function always returns a password hash, which is actually compared by dovecot.
|
||||||
assert res["password"] == res2["password"]
|
assert res["password"] == res2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_nocreate_file(monkeypatch, tmpdir, dictproxy):
|
def test_nocreate_file(db, monkeypatch, tmpdir):
|
||||||
p = tmpdir.join("nocreate")
|
p = tmpdir.join("nocreate")
|
||||||
p.write("")
|
p.write("")
|
||||||
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
||||||
dictproxy.lookup_passdb("newuser12@chat.example.org", "zequ0Aimuchoodaechik")
|
lookup_passdb(db, "newuser1@something.org", "zequ0Aimuchoodaechik")
|
||||||
assert not dictproxy.lookup_userdb("newuser12@chat.example.org")
|
assert not get_user_data(db, "newuser1@something.org")
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request(dictproxy):
|
def test_db_version(db):
|
||||||
transactions = {}
|
assert db.get_schema_version() == 1
|
||||||
# Test that password can contain ", ', \ and /
|
|
||||||
|
|
||||||
|
def test_too_high_db_version(db):
|
||||||
|
with db.write_transaction() as conn:
|
||||||
|
conn.execute("PRAGMA user_version=%s;" % (999,))
|
||||||
|
with pytest.raises(DBError):
|
||||||
|
db.ensure_tables()
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_request(db):
|
||||||
msg = (
|
msg = (
|
||||||
'Lshared/passdb/laksjdlaksjdlak\\\\sjdlk\\"12j\\\'3l1/k2j3123"'
|
"Lshared/passdb/laksjdlaksjdlaksjdlk12j3l1k2j3123/"
|
||||||
"some42123@chat.example.org\tsome42123@chat.example.org"
|
"some42@c3.testrun.org\tsome42@c3.testrun.org"
|
||||||
)
|
)
|
||||||
res = dictproxy.handle_dovecot_request(msg, transactions)
|
res = handle_dovecot_request(msg, db, "c3.testrun.org")
|
||||||
assert res
|
assert res
|
||||||
assert res[0] == "O" and res.endswith("\n")
|
assert res[0] == "O" and res.endswith("\n")
|
||||||
userdata = json.loads(res[1:].strip())
|
userdata = json.loads(res[1:].strip())
|
||||||
assert userdata["home"].endswith("chat.example.org/some42123@chat.example.org")
|
assert userdata["home"] == "/home/vmail/some42@c3.testrun.org"
|
||||||
assert userdata["uid"] == userdata["gid"] == "vmail"
|
assert userdata["uid"] == userdata["gid"] == "vmail"
|
||||||
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_hello_is_skipped(example_config, caplog):
|
def test_50_concurrent_lookups_different_accounts(db, gencreds):
|
||||||
dictproxy = AuthDictProxy(config=example_config)
|
|
||||||
rfile = io.BytesIO(b"H3\t2\t0\t\tauth\n")
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert wfile.getvalue() == b""
|
|
||||||
assert not caplog.messages
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_user_not_exists(example_config):
|
|
||||||
dictproxy = AuthDictProxy(config=example_config)
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"H3\t2\t0\t\tauth\nLshared/userdb/foobar@chat.example.org\tfoobar@chat.example.org\n"
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert wfile.getvalue() == b"N\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_iterate(gencreds, example_config):
|
|
||||||
dictproxy = AuthDictProxy(config=example_config)
|
|
||||||
dictproxy.lookup_passdb("asdf00000@chat.example.org", "q9mr3faue")
|
|
||||||
dictproxy.lookup_passdb("asdf11111@chat.example.org", "q9mr3faue")
|
|
||||||
rfile = io.BytesIO(b"H3\t2\t0\t\tauth\nI0\t0\tshared/userdb/")
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
lines = wfile.getvalue().decode("ascii").split("\n")
|
|
||||||
assert "Oshared/userdb/asdf00000@chat.example.org\t" in lines
|
|
||||||
assert "Oshared/userdb/asdf11111@chat.example.org\t" in lines
|
|
||||||
assert not lines[2]
|
|
||||||
|
|
||||||
|
|
||||||
def test_50_concurrent_lookups_different_accounts(gencreds, dictproxy):
|
|
||||||
num_threads = 50
|
num_threads = 50
|
||||||
req_per_thread = 5
|
req_per_thread = 5
|
||||||
results = queue.Queue()
|
results = queue.Queue()
|
||||||
|
|
||||||
def lookup():
|
def lookup(db):
|
||||||
for i in range(req_per_thread):
|
for i in range(req_per_thread):
|
||||||
addr, password = gencreds()
|
addr, password = gencreds()
|
||||||
try:
|
try:
|
||||||
dictproxy.lookup_passdb(addr, password)
|
lookup_passdb(db, addr, password)
|
||||||
except Exception:
|
except Exception:
|
||||||
results.put(traceback.format_exc())
|
results.put(traceback.format_exc())
|
||||||
else:
|
else:
|
||||||
@@ -137,7 +76,7 @@ def test_50_concurrent_lookups_different_accounts(gencreds, dictproxy):
|
|||||||
|
|
||||||
threads = []
|
threads = []
|
||||||
for i in range(num_threads):
|
for i in range(num_threads):
|
||||||
thread = threading.Thread(target=lookup, daemon=True)
|
thread = threading.Thread(target=lookup, args=(db,), daemon=True)
|
||||||
threads.append(thread)
|
threads.append(thread)
|
||||||
|
|
||||||
print(f"created {num_threads} threads, starting them and waiting for results")
|
print(f"created {num_threads} threads, starting them and waiting for results")
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
import threading
|
|
||||||
|
|
||||||
from chatmaild.filedict import FileDict, write_bytes_atomic
|
|
||||||
|
|
||||||
|
|
||||||
def test_basic(tmp_path):
|
|
||||||
fdict = FileDict(tmp_path.joinpath("metadata"))
|
|
||||||
assert fdict.read() == {}
|
|
||||||
with fdict.modify() as d:
|
|
||||||
d["devicetoken"] = [1, 2, 3]
|
|
||||||
d["456"] = 4.2
|
|
||||||
new = fdict.read()
|
|
||||||
assert new["devicetoken"] == [1, 2, 3]
|
|
||||||
assert new["456"] == 4.2
|
|
||||||
|
|
||||||
|
|
||||||
def test_bad_marshal_file(tmp_path, caplog):
|
|
||||||
fdict1 = FileDict(tmp_path.joinpath("metadata"))
|
|
||||||
fdict1.path.write_bytes(b"l12k3l12k3l")
|
|
||||||
assert fdict1.read() == {}
|
|
||||||
assert "corrupt" in caplog.records[0].msg
|
|
||||||
|
|
||||||
|
|
||||||
def test_write_bytes_atomic_concurrent(tmp_path):
|
|
||||||
p = tmp_path.joinpath("somefile.ext")
|
|
||||||
write_bytes_atomic(p, b"hello")
|
|
||||||
|
|
||||||
threads = []
|
|
||||||
for i in range(30):
|
|
||||||
content = f"hello{i}".encode("ascii")
|
|
||||||
t = threading.Thread(target=lambda: write_bytes_atomic(p, content))
|
|
||||||
t.start()
|
|
||||||
threads.append(t)
|
|
||||||
|
|
||||||
for t in threads:
|
|
||||||
t.join()
|
|
||||||
|
|
||||||
assert p.read_text().strip() != "hello"
|
|
||||||
assert len(list(p.parent.iterdir())) == 1
|
|
||||||
@@ -1,13 +1,12 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from chatmaild.filtermail import (
|
from chatmaild.filtermail import (
|
||||||
|
check_encrypted,
|
||||||
BeforeQueueHandler,
|
BeforeQueueHandler,
|
||||||
SendRateLimiter,
|
SendRateLimiter,
|
||||||
check_armored_payload,
|
check_mdn,
|
||||||
check_encrypted,
|
|
||||||
common_encrypted_subjects,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain():
|
def maildomain():
|
||||||
@@ -56,33 +55,42 @@ def test_filtermail_no_encryption_detection(maildata):
|
|||||||
|
|
||||||
|
|
||||||
def test_filtermail_encryption_detection(maildata):
|
def test_filtermail_encryption_detection(maildata):
|
||||||
for subject in common_encrypted_subjects:
|
msg = maildata("encrypted.eml", from_addr="1@example.org", to_addr="2@example.org")
|
||||||
msg = maildata(
|
assert check_encrypted(msg)
|
||||||
"encrypted.eml",
|
|
||||||
from_addr="1@example.org",
|
|
||||||
to_addr="2@example.org",
|
|
||||||
subject=subject,
|
|
||||||
)
|
|
||||||
assert check_encrypted(msg)
|
|
||||||
|
|
||||||
# if the subject is not a known encrypted subject value, it is not considered ac-encrypted
|
# if the subject is not "..." it is not considered ac-encrypted
|
||||||
msg.replace_header("Subject", "Click this link")
|
msg.replace_header("Subject", "Click this link")
|
||||||
assert not check_encrypted(msg)
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_no_literal_packets(maildata):
|
def test_filtermail_is_mdn(maildata, gencreds, handler):
|
||||||
"""Test that literal OpenPGP packet is not considered an encrypted mail."""
|
|
||||||
msg = maildata("literal.eml", from_addr="1@example.org", to_addr="2@example.org")
|
|
||||||
assert not check_encrypted(msg)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_unencrypted_mdn(maildata, gencreds):
|
|
||||||
"""Unencrypted MDNs should not pass."""
|
|
||||||
from_addr = gencreds()[0]
|
from_addr = gencreds()[0]
|
||||||
to_addr = gencreds()[0] + ".other"
|
to_addr = gencreds()[0] + ".other"
|
||||||
msg = maildata("mdn.eml", from_addr=from_addr, to_addr=to_addr)
|
msg = maildata("mdn.eml", from_addr, to_addr)
|
||||||
|
|
||||||
assert not check_encrypted(msg)
|
class env:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
assert check_mdn(msg, env)
|
||||||
|
print(msg.as_string())
|
||||||
|
|
||||||
|
assert not handler.check_DATA(env)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_to_multiple_recipients_no_mdn(maildata, gencreds):
|
||||||
|
from_addr = gencreds()[0]
|
||||||
|
to_addr = gencreds()[0] + ".other"
|
||||||
|
thirdaddr = gencreds()[0]
|
||||||
|
msg = maildata("mdn.eml", from_addr, to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr, thirdaddr]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
assert not check_mdn(msg, env)
|
||||||
|
|
||||||
|
|
||||||
def test_send_rate_limiter():
|
def test_send_rate_limiter():
|
||||||
@@ -103,7 +111,7 @@ def test_excempt_privacy(maildata, gencreds, handler):
|
|||||||
handler.config.passthrough_recipients = [to_addr]
|
handler.config.passthrough_recipients = [to_addr]
|
||||||
false_to = "privacy@something.org"
|
false_to = "privacy@something.org"
|
||||||
|
|
||||||
msg = maildata("plain.eml", from_addr=from_addr, to_addr=to_addr)
|
msg = maildata("plain.eml", from_addr, to_addr)
|
||||||
|
|
||||||
class env:
|
class env:
|
||||||
mail_from = from_addr
|
mail_from = from_addr
|
||||||
@@ -119,99 +127,3 @@ def test_excempt_privacy(maildata, gencreds, handler):
|
|||||||
content = msg.as_bytes()
|
content = msg.as_bytes()
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
assert "500" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
def test_passthrough_domains(maildata, gencreds, handler):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = "privacy@x.y.z"
|
|
||||||
handler.config.passthrough_recipients = ["@x.y.z"]
|
|
||||||
false_to = "something@x.y"
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", from_addr=from_addr, to_addr=to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
# assert that None/no error is returned
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
class env2:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr, false_to]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
|
||||||
|
|
||||||
|
|
||||||
def test_passthrough_senders(gencreds, handler, maildata):
|
|
||||||
acc1 = gencreds()[0]
|
|
||||||
to_addr = "recipient@something.org"
|
|
||||||
handler.config.passthrough_senders = [acc1]
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", from_addr=acc1, to_addr=to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = acc1
|
|
||||||
rcpt_tos = to_addr
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
# assert that None/no error is returned
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_check_armored_payload():
|
|
||||||
payload = """-----BEGIN PGP MESSAGE-----\r
|
|
||||||
\r
|
|
||||||
wU4DSqFx0d1yqAoSAQdAYkX/ZN/Az4B0k7X47zKyWrXxlDEdS3WOy0Yf2+GJTFgg\r
|
|
||||||
Zk5ql0mLG8Ze+ZifCS0XMO4otlemSyJ0K1ZPdFMGzUDBTgNqzkFabxXoXRIBB0AM\r
|
|
||||||
755wlX41X6Ay3KhnwBq7yEqSykVH6F3x11iHPKraLCAGZoaS8bKKNy/zg5slda1X\r
|
|
||||||
pt14b4aC1VwtSnYhcRRELNLD/wE2TFif+g7poMmFY50VyMPLYjVP96Z5QCT4+z4H\r
|
|
||||||
Ikh/pRRN8S3JNMrRJHc6prooSJmLcx47Y5un7VFy390MsJ+LiUJuQMDdYWRAinfs\r
|
|
||||||
Ebm89Ezjm7F03qbFPXE0X4ZNzVXS/eKO0uhJQdiov/vmbn41rNtHmNpqjaO0vi5+\r
|
|
||||||
sS9tR7yDUrIXiCUCN78eBLVioxtktsPZm5cDORbQWzv+7nmCEz9/JowCUcBVdCGn\r
|
|
||||||
1ofOaH82JCAX/cRx08pLaDNj6iolVBsi56Dd+2bGxJOZOG2AMcEyz0pXY0dOAJCD\r
|
|
||||||
iUThcQeGIdRnU3j8UBcnIEsjLu2+C+rrwMZQESMWKnJ0rnqTk0pK5kXScr6F/L0L\r
|
|
||||||
UE49ccIexNm3xZvYr5drszr6wz3Tv5fdue87P4etBt90gF/Vzknck+g1LLlkzZkp\r
|
|
||||||
d8dI0k2tOSPjUbDPnSy1x+X73WGpPZmj0kWT+RGvq0nH6UkJj3AQTG2qf1T8jK+3\r
|
|
||||||
rTp3LR9vDkMwDjX4R8SA9c0wdnUzzr79OYQC9lTnzcx+fM6BBmgQ2GrS33jaFLp7\r
|
|
||||||
L6/DFpCl5zhnPjM/2dKvMkw/Kd6XS/vjwsO405FQdjSDiQEEAZA+ZvAfcjdccbbU\r
|
|
||||||
yCO+x0QNdeBsufDVnh3xvzuWy4CICdTQT4s1AWRPCzjOj+SGmx5WqCLWfsd8Ma0+\r
|
|
||||||
w/C7SfTYu1FDQILLM+llpq1M/9GPley4QZ8JQjo262AyPXsPF/OW48uuZz0Db1xT\r
|
|
||||||
Yh4iHBztj4VSdy7l2+IyaIf7cnL4EEBFxv/MwmVDXvDlxyvfAfIsd3D9SvJESzKZ\r
|
|
||||||
VWDYwaocgeCN+ojKu1p885lu1EfRbX3fr3YO02K5/c2JYDkc0Py0W3wUP/J1XUax\r
|
|
||||||
pbKpzwlkxEgtmzsGqsOfMJqBV3TNDrOA2uBsa+uBqP5MGYLZ49S/4v/bW9I01Cr1\r
|
|
||||||
D2ZkV510Y1Vgo66WlP8mRqOTyt/5WRhPD+MxXdk67BNN/PmO6tMlVoJDuk+XwWPR\r
|
|
||||||
t2TvNaND/yabT9eYI55Og4fzKD6RIjouUX8DvKLkm+7aXxVs2uuLQ3Jco3O82z55\r
|
|
||||||
dbShU1jYsrw9oouXUz06MHPbkdhNbF/2hfhZ2qA31sNeovJw65iUv7sDKX3LVWgJ\r
|
|
||||||
10jlywcDwqlU8CO7WC9lGixYTbnOkYZpXCGEl8e6Jbs79l42YFo4ogYpFK1NXFhV\r
|
|
||||||
kOXRmDf/wmfj+c/ld3L2PkvwlgofhCudOQknZbo3ub1gjiTn7L+lMGHIj/3suMIl\r
|
|
||||||
ID4EUxAXScIM1ZEz2fjtW5jATlqYcLjLTbf/olw6HFyPNH+9IssqXeZNKnGwPUB9\r
|
|
||||||
3lTXsg0tpzl+x7F/2WjEw1DSNhjC0KnHt1vEYNMkUGDGFdN9y3ERLqX/FIgiASUb\r
|
|
||||||
bTvAVupnAK3raBezGmhrs6LsQtLS9P0VvQiLU3uDhMqw8Z4SISLpcD+NnVBHzQqm\r
|
|
||||||
6W5Qn/8xsCL6av18yUVTi2G3igt3QCNoYx9evt2ZcIkNoyyagUVjfZe5GHXh8Dnz\r
|
|
||||||
GaBXW/hg3HlXLRGaQu4RYCzBMJILcO25OhZOg6jbkCLiEexQlm2e9krB5cXR49Al\r
|
|
||||||
UN4fiB0KR9JyG2ayUdNJVkXZSZLnHyRgiaadlpUo16LVvw==\r
|
|
||||||
=b5Kp\r
|
|
||||||
-----END PGP MESSAGE-----\r
|
|
||||||
\r
|
|
||||||
"""
|
|
||||||
|
|
||||||
assert check_armored_payload(payload) == True
|
|
||||||
|
|
||||||
payload = """-----BEGIN PGP MESSAGE-----\r
|
|
||||||
\r
|
|
||||||
HELLOWORLD
|
|
||||||
-----END PGP MESSAGE-----\r
|
|
||||||
\r
|
|
||||||
"""
|
|
||||||
assert check_armored_payload(payload) == False
|
|
||||||
|
|
||||||
payload = """-----BEGIN PGP MESSAGE-----\r
|
|
||||||
\r
|
|
||||||
=njUN
|
|
||||||
-----END PGP MESSAGE-----\r
|
|
||||||
\r
|
|
||||||
"""
|
|
||||||
assert check_armored_payload(payload) == False
|
|
||||||
|
|||||||
@@ -1,64 +0,0 @@
|
|||||||
import time
|
|
||||||
|
|
||||||
from chatmaild.doveauth import AuthDictProxy
|
|
||||||
from chatmaild.lastlogin import (
|
|
||||||
LastLoginDictProxy,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request_last_login(testaddr, example_config):
|
|
||||||
dictproxy = LastLoginDictProxy(config=example_config)
|
|
||||||
|
|
||||||
authproxy = AuthDictProxy(config=example_config)
|
|
||||||
authproxy.lookup_passdb(testaddr, "1l2k3j1l2k3jl123")
|
|
||||||
|
|
||||||
dictproxy_transactions = {}
|
|
||||||
|
|
||||||
# Begin transaction
|
|
||||||
tx = "1111"
|
|
||||||
msg = f"B{tx}\t{testaddr}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, dictproxy_transactions)
|
|
||||||
assert not res
|
|
||||||
assert dictproxy_transactions == {tx: dict(addr=testaddr, res="O\n")}
|
|
||||||
|
|
||||||
# set last-login info for user
|
|
||||||
user = dictproxy.config.get_user(testaddr)
|
|
||||||
timestamp = int(time.time())
|
|
||||||
msg = f"S{tx}\tshared/last-login/{testaddr}\t{timestamp}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, dictproxy_transactions)
|
|
||||||
assert not res
|
|
||||||
assert len(dictproxy_transactions) == 1
|
|
||||||
read_timestamp = user.get_last_login_timestamp()
|
|
||||||
assert read_timestamp == timestamp // 86400 * 86400
|
|
||||||
|
|
||||||
# finish transaction
|
|
||||||
msg = f"C{tx}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, dictproxy_transactions)
|
|
||||||
assert res == "O\n"
|
|
||||||
assert len(dictproxy_transactions) == 0
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request_last_login_echobot(example_config):
|
|
||||||
dictproxy = LastLoginDictProxy(config=example_config)
|
|
||||||
|
|
||||||
authproxy = AuthDictProxy(config=example_config)
|
|
||||||
testaddr = f"echo@{example_config.mail_domain}"
|
|
||||||
authproxy.lookup_passdb(testaddr, "ignore")
|
|
||||||
user = dictproxy.config.get_user(testaddr)
|
|
||||||
|
|
||||||
transactions = {}
|
|
||||||
|
|
||||||
# set last-login info for user
|
|
||||||
tx = "1111"
|
|
||||||
msg = f"B{tx}\t{testaddr}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, transactions)
|
|
||||||
assert not res
|
|
||||||
assert transactions == {tx: dict(addr=testaddr, res="O\n")}
|
|
||||||
|
|
||||||
timestamp = int(time.time())
|
|
||||||
msg = f"S{tx}\tshared/last-login/{testaddr}\t{timestamp}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, transactions)
|
|
||||||
assert not res
|
|
||||||
assert len(transactions) == 1
|
|
||||||
read_timestamp = user.get_last_login_timestamp()
|
|
||||||
assert read_timestamp is None
|
|
||||||
@@ -1,313 +0,0 @@
|
|||||||
import io
|
|
||||||
import time
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
import requests
|
|
||||||
|
|
||||||
from chatmaild.metadata import (
|
|
||||||
Metadata,
|
|
||||||
MetadataDictProxy,
|
|
||||||
)
|
|
||||||
from chatmaild.notifier import (
|
|
||||||
Notifier,
|
|
||||||
NotifyThread,
|
|
||||||
PersistentQueueItem,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def notifier(metadata):
|
|
||||||
queue_dir = metadata.vmail_dir.joinpath("pending_notifications")
|
|
||||||
queue_dir.mkdir()
|
|
||||||
return Notifier(queue_dir)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def metadata(tmp_path):
|
|
||||||
vmail_dir = tmp_path.joinpath("vmaildir")
|
|
||||||
vmail_dir.mkdir()
|
|
||||||
return Metadata(vmail_dir)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def dictproxy(notifier, metadata):
|
|
||||||
return MetadataDictProxy(notifier=notifier, metadata=metadata)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def testaddr2():
|
|
||||||
return "user2@example.org"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def token():
|
|
||||||
return "01234"
|
|
||||||
|
|
||||||
|
|
||||||
def get_mocked_requests(statuslist):
|
|
||||||
class ReqMock:
|
|
||||||
requests = []
|
|
||||||
|
|
||||||
def post(self, url, data, timeout):
|
|
||||||
self.requests.append((url, data, timeout))
|
|
||||||
res = statuslist.pop(0)
|
|
||||||
if isinstance(res, Exception):
|
|
||||||
raise res
|
|
||||||
|
|
||||||
class Result:
|
|
||||||
status_code = res
|
|
||||||
|
|
||||||
return Result()
|
|
||||||
|
|
||||||
return ReqMock()
|
|
||||||
|
|
||||||
|
|
||||||
def test_metadata_persistence(tmp_path, testaddr, testaddr2):
|
|
||||||
metadata1 = Metadata(tmp_path)
|
|
||||||
metadata2 = Metadata(tmp_path)
|
|
||||||
assert not metadata1.get_tokens_for_addr(testaddr)
|
|
||||||
assert not metadata2.get_tokens_for_addr(testaddr)
|
|
||||||
|
|
||||||
metadata1.add_token_to_addr(testaddr, "01234")
|
|
||||||
metadata1.add_token_to_addr(testaddr2, "456")
|
|
||||||
assert metadata2.get_tokens_for_addr(testaddr) == ["01234"]
|
|
||||||
assert metadata2.get_tokens_for_addr(testaddr2) == ["456"]
|
|
||||||
metadata2.remove_token_from_addr(testaddr, "01234")
|
|
||||||
assert not metadata1.get_tokens_for_addr(testaddr)
|
|
||||||
assert metadata1.get_tokens_for_addr(testaddr2) == ["456"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_remove_nonexisting(metadata, tmp_path, testaddr):
|
|
||||||
metadata.add_token_to_addr(testaddr, "123")
|
|
||||||
metadata.remove_token_from_addr(testaddr, "1l23k1l2k3")
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["123"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_notifier_remove_without_set(metadata, testaddr):
|
|
||||||
metadata.remove_token_from_addr(testaddr, "123")
|
|
||||||
assert not metadata.get_tokens_for_addr(testaddr)
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request_lookup_fails(dictproxy, testaddr):
|
|
||||||
transactions = {}
|
|
||||||
res = dictproxy.handle_dovecot_request(
|
|
||||||
f"Lpriv/123/chatmail\t{testaddr}", transactions
|
|
||||||
)
|
|
||||||
assert res == "N\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request_happy_path(dictproxy, testaddr, token):
|
|
||||||
metadata = dictproxy.metadata
|
|
||||||
transactions = {}
|
|
||||||
notifier = dictproxy.notifier
|
|
||||||
|
|
||||||
# set device token in a transaction
|
|
||||||
tx = "1111"
|
|
||||||
msg = f"B{tx}\t{testaddr}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, transactions)
|
|
||||||
assert not res and not metadata.get_tokens_for_addr(testaddr)
|
|
||||||
assert transactions == {tx: dict(addr=testaddr, res="O\n")}
|
|
||||||
|
|
||||||
msg = f"S{tx}\tpriv/guid00/devicetoken\t{token}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, transactions)
|
|
||||||
assert not res
|
|
||||||
assert len(transactions) == 1
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == [token]
|
|
||||||
|
|
||||||
msg = f"C{tx}"
|
|
||||||
res = dictproxy.handle_dovecot_request(msg, transactions)
|
|
||||||
assert res == "O\n"
|
|
||||||
assert len(transactions) == 0
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == [token]
|
|
||||||
|
|
||||||
# trigger notification for incoming message
|
|
||||||
tx2 = "2222"
|
|
||||||
assert dictproxy.handle_dovecot_request(f"B{tx2}\t{testaddr}", transactions) is None
|
|
||||||
msg = f"S{tx2}\tpriv/guid00/messagenew"
|
|
||||||
assert dictproxy.handle_dovecot_request(msg, transactions) is None
|
|
||||||
queue_item = notifier.retry_queues[0].get()[1]
|
|
||||||
assert queue_item.token == token
|
|
||||||
assert dictproxy.handle_dovecot_request(f"C{tx2}", transactions) == "O\n"
|
|
||||||
assert not transactions
|
|
||||||
assert queue_item.path.exists()
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_set_devicetoken(dictproxy):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"HELLO",
|
|
||||||
b"Btx00\tuser@example.org",
|
|
||||||
b"Stx00\tpriv/guid00/devicetoken\t01234",
|
|
||||||
b"Ctx00",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert wfile.getvalue() == b"O\n"
|
|
||||||
assert dictproxy.metadata.get_tokens_for_addr("user@example.org") == ["01234"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_set_get_devicetoken(dictproxy):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"HELLO",
|
|
||||||
b"Btx00\tuser@example.org",
|
|
||||||
b"Stx00\tpriv/guid00/devicetoken\t01234",
|
|
||||||
b"Ctx00",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert dictproxy.metadata.get_tokens_for_addr("user@example.org") == ["01234"]
|
|
||||||
assert wfile.getvalue() == b"O\n"
|
|
||||||
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join([b"HELLO", b"Lpriv/0123/devicetoken\tuser@example.org"])
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert wfile.getvalue() == b"O01234\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_iterate(dictproxy):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"H",
|
|
||||||
b"I9\t0\tpriv/5cbe730f146fea6535be0d003dd4fc98/\tci-2dzsrs@nine.testrun.org",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert wfile.getvalue() == b"\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_notifier_thread_deletes_persistent_file(metadata, notifier, testaddr):
|
|
||||||
reqmock = get_mocked_requests([200])
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
url, data, timeout = reqmock.requests[0]
|
|
||||||
assert data == "01234"
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["01234"]
|
|
||||||
notifier.requeue_persistent_queue_items()
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("status", [requests.exceptions.RequestException(), 404, 500])
|
|
||||||
def test_notifier_thread_connection_failures(
|
|
||||||
metadata, notifier, testaddr, status, caplog
|
|
||||||
):
|
|
||||||
"""test that tokens keep getting retried until they are given up."""
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
notifier.NOTIFICATION_RETRY_DELAY = 5
|
|
||||||
max_tries = len(notifier.retry_queues)
|
|
||||||
for i in range(max_tries):
|
|
||||||
caplog.clear()
|
|
||||||
reqmock = get_mocked_requests([status])
|
|
||||||
sleep_calls = []
|
|
||||||
NotifyThread(notifier, i, None).retry_one(reqmock, sleep=sleep_calls.append)
|
|
||||||
assert notifier.retry_queues[i].qsize() == 0
|
|
||||||
assert "request failed" in caplog.records[0].msg
|
|
||||||
if i > 0:
|
|
||||||
assert len(sleep_calls) == 1
|
|
||||||
if i + 1 < max_tries:
|
|
||||||
assert notifier.retry_queues[i + 1].qsize() == 1
|
|
||||||
assert len(caplog.records) == 1
|
|
||||||
else:
|
|
||||||
assert len(caplog.records) == 2
|
|
||||||
assert "deadline" in caplog.records[1].msg
|
|
||||||
notifier.requeue_persistent_queue_items()
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
|
|
||||||
|
|
||||||
def test_requeue_removes_tmp_files(notifier, metadata, testaddr, caplog):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
p = notifier.queue_dir.joinpath("1203981203.tmp")
|
|
||||||
p.touch()
|
|
||||||
notifier2 = notifier.__class__(notifier.queue_dir)
|
|
||||||
notifier2.requeue_persistent_queue_items()
|
|
||||||
assert "spurious" in caplog.records[0].msg
|
|
||||||
assert not p.exists()
|
|
||||||
assert notifier2.retry_queues[0].qsize() == 1
|
|
||||||
when, queue_item = notifier2.retry_queues[0].get()
|
|
||||||
assert when <= int(time.time())
|
|
||||||
assert queue_item.addr == testaddr
|
|
||||||
|
|
||||||
|
|
||||||
def test_start_and_stop_notification_threads(notifier, testaddr):
|
|
||||||
threads = notifier.start_notification_threads(None)
|
|
||||||
for retry_num, threadlist in threads.items():
|
|
||||||
for t in threadlist:
|
|
||||||
t.stop()
|
|
||||||
t.join()
|
|
||||||
|
|
||||||
|
|
||||||
def test_multi_device_notifier(metadata, notifier, testaddr):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
metadata.add_token_to_addr(testaddr, "56789")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
reqmock = get_mocked_requests([200, 200])
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
assert notifier.retry_queues[1].qsize() == 0
|
|
||||||
url, data, timeout = reqmock.requests[0]
|
|
||||||
assert data == "01234"
|
|
||||||
url, data, timeout = reqmock.requests[1]
|
|
||||||
assert data == "56789"
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["01234", "56789"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_notifier_thread_run_gone_removes_token(metadata, notifier, testaddr):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
metadata.add_token_to_addr(testaddr, "45678")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
|
|
||||||
reqmock = get_mocked_requests([410, 200])
|
|
||||||
NotifyThread(notifier, 0, metadata.remove_token_from_addr).retry_one(reqmock)
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
url, data, timeout = reqmock.requests[0]
|
|
||||||
assert data == "01234"
|
|
||||||
url, data, timeout = reqmock.requests[1]
|
|
||||||
assert data == "45678"
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["45678"]
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
assert notifier.retry_queues[1].qsize() == 0
|
|
||||||
|
|
||||||
|
|
||||||
def test_persistent_queue_items(tmp_path, testaddr, token):
|
|
||||||
queue_item = PersistentQueueItem.create(tmp_path, testaddr, 432, token)
|
|
||||||
assert queue_item.addr == testaddr
|
|
||||||
assert queue_item.start_ts == 432
|
|
||||||
assert queue_item.token == token
|
|
||||||
item2 = PersistentQueueItem.read_from_path(queue_item.path)
|
|
||||||
assert item2.addr == testaddr
|
|
||||||
assert item2.start_ts == 432
|
|
||||||
assert item2.token == token
|
|
||||||
assert item2 == queue_item
|
|
||||||
item2.delete()
|
|
||||||
assert not item2.path.exists()
|
|
||||||
assert not queue_item < item2 and not item2 < queue_item
|
|
||||||
|
|
||||||
|
|
||||||
def test_iroh_relay(dictproxy):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"H",
|
|
||||||
b"Lshared/0123/vendor/vendor.dovecot/pvt/server/vendor/deltachat/irohrelay\tuser@example.org",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
dictproxy.iroh_relay = "https://example.org/"
|
|
||||||
dictproxy.loop_forever(rfile, wfile)
|
|
||||||
assert wfile.getvalue() == b"Ohttps://example.org/\n"
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
from chatmaild.metrics import main
|
|
||||||
|
|
||||||
|
|
||||||
def test_main(tmp_path, capsys):
|
|
||||||
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
|
||||||
tmp_path.joinpath(x).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,67 +0,0 @@
|
|||||||
import sqlite3
|
|
||||||
|
|
||||||
from chatmaild.migrate_db import migrate_from_db_to_maildir
|
|
||||||
|
|
||||||
|
|
||||||
def test_migration_not_exists(tmp_path, example_config):
|
|
||||||
example_config.passdb_path = tmp_path.joinpath("sqlite")
|
|
||||||
|
|
||||||
|
|
||||||
def test_migration(tmp_path, example_config, caplog):
|
|
||||||
passdb_path = tmp_path.joinpath("passdb.sqlite")
|
|
||||||
uri = f"file:{passdb_path}?mode=rwc"
|
|
||||||
sqlconn = sqlite3.connect(uri, timeout=60, uri=True)
|
|
||||||
sqlconn.execute(
|
|
||||||
"""
|
|
||||||
CREATE TABLE users (
|
|
||||||
addr TEXT PRIMARY KEY,
|
|
||||||
password TEXT,
|
|
||||||
last_login INTEGER
|
|
||||||
)
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
all = {}
|
|
||||||
|
|
||||||
for i in range(500):
|
|
||||||
values = (f"somsom{i:03}@example.org", f"passwo{i:03}", i * 86400)
|
|
||||||
sqlconn.execute(
|
|
||||||
"""
|
|
||||||
INSERT INTO users (addr, password, last_login)
|
|
||||||
VALUES (?, ?, ?)""",
|
|
||||||
values,
|
|
||||||
)
|
|
||||||
all[values[0]] = values[1:]
|
|
||||||
|
|
||||||
for i in range(500):
|
|
||||||
values = (f"pompom{i:03}@example.org", f"wopass{i:03}", "")
|
|
||||||
sqlconn.execute(
|
|
||||||
"""
|
|
||||||
INSERT INTO users (addr, password, last_login)
|
|
||||||
VALUES (?, ?, ?)""",
|
|
||||||
values,
|
|
||||||
)
|
|
||||||
all[values[0]] = values[1:]
|
|
||||||
|
|
||||||
sqlconn.commit()
|
|
||||||
sqlconn.close()
|
|
||||||
|
|
||||||
assert passdb_path.stat().st_size > 10000
|
|
||||||
|
|
||||||
example_config.passdb_path = passdb_path
|
|
||||||
|
|
||||||
assert not caplog.records
|
|
||||||
|
|
||||||
migrate_from_db_to_maildir(example_config, chunking=500)
|
|
||||||
assert len(caplog.records) > 3
|
|
||||||
|
|
||||||
for path in example_config.mailboxes_dir.iterdir():
|
|
||||||
if "@" not in path.name:
|
|
||||||
continue
|
|
||||||
password, last_login = all.pop(path.name)
|
|
||||||
user = example_config.get_user(path.name)
|
|
||||||
if last_login:
|
|
||||||
assert user.get_last_login_timestamp() == last_login
|
|
||||||
assert password == user.get_userdb_dict()["password"]
|
|
||||||
|
|
||||||
assert not all
|
|
||||||
assert not example_config.passdb_path.exists()
|
|
||||||
@@ -4,24 +4,26 @@ import chatmaild
|
|||||||
from chatmaild.newemail import create_newemail_dict, print_new_account
|
from chatmaild.newemail import create_newemail_dict, print_new_account
|
||||||
|
|
||||||
|
|
||||||
def test_create_newemail_dict(example_config):
|
def test_create_newemail_dict():
|
||||||
ac1 = create_newemail_dict(example_config)
|
ac1 = create_newemail_dict(domain="example.org")
|
||||||
assert "@" in ac1["email"]
|
assert "@" in ac1["email"]
|
||||||
assert len(ac1["password"]) >= 10
|
assert len(ac1["password"]) >= 10
|
||||||
|
|
||||||
ac2 = create_newemail_dict(example_config)
|
ac2 = create_newemail_dict(domain="example.org")
|
||||||
|
|
||||||
assert ac1["email"] != ac2["email"]
|
assert ac1["email"] != ac2["email"]
|
||||||
assert ac1["password"] != ac2["password"]
|
assert ac1["password"] != ac2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir):
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
p = tmpdir.join("mailname")
|
||||||
|
p.write(maildomain)
|
||||||
|
monkeypatch.setattr(chatmaild.newemail, "mailname_path", str(p))
|
||||||
print_new_account()
|
print_new_account()
|
||||||
out, err = capsys.readouterr()
|
out, err = capsys.readouterr()
|
||||||
lines = out.split("\n")
|
lines = out.split("\n")
|
||||||
assert lines[0] == "Content-Type: application/json"
|
assert lines[0] == "Content-Type: application/json"
|
||||||
assert not lines[1]
|
assert not lines[1]
|
||||||
dic = json.loads(lines[2])
|
dic = json.loads(lines[2])
|
||||||
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
assert dic["email"].endswith(f"@{maildomain}")
|
||||||
assert len(dic["password"]) >= 10
|
assert len(dic["password"]) >= 10
|
||||||
|
|||||||
@@ -1,42 +0,0 @@
|
|||||||
def test_login_timestamp(testaddr, example_config):
|
|
||||||
user = example_config.get_user(testaddr)
|
|
||||||
user.set_password("someeqkjwelkqwjleqwe")
|
|
||||||
user.set_last_login_timestamp(100000)
|
|
||||||
assert user.get_last_login_timestamp() == 86400
|
|
||||||
|
|
||||||
user.set_last_login_timestamp(200000)
|
|
||||||
assert user.get_last_login_timestamp() == 86400 * 2
|
|
||||||
|
|
||||||
|
|
||||||
def test_get_user_dict_not_set(testaddr, example_config, caplog):
|
|
||||||
user = example_config.get_user(testaddr)
|
|
||||||
assert not caplog.records
|
|
||||||
assert user.get_userdb_dict() == {}
|
|
||||||
assert len(caplog.records) == 0
|
|
||||||
|
|
||||||
user.set_password("")
|
|
||||||
assert user.get_userdb_dict() == {}
|
|
||||||
assert len(caplog.records) == 1
|
|
||||||
|
|
||||||
|
|
||||||
def test_get_user_dict(make_config, tmp_path):
|
|
||||||
config = make_config("something.testrun.org")
|
|
||||||
addr = "user1@something.org"
|
|
||||||
user = config.get_user(addr)
|
|
||||||
enc_password = "l1k2j31lk2j3l1k23j123"
|
|
||||||
user.set_password(enc_password)
|
|
||||||
data = user.get_userdb_dict()
|
|
||||||
assert addr in str(data["home"])
|
|
||||||
assert data["uid"] == "vmail"
|
|
||||||
assert data["gid"] == "vmail"
|
|
||||||
assert data["password"] == enc_password
|
|
||||||
|
|
||||||
|
|
||||||
def test_no_mailboxes_dir(testaddr, example_config, tmp_path):
|
|
||||||
p = tmp_path.joinpath("a", "mailboxes")
|
|
||||||
example_config.mailboxes_dir = p
|
|
||||||
|
|
||||||
user = example_config.get_user(testaddr)
|
|
||||||
user.set_password("someeqkjwelkqwjleqwe")
|
|
||||||
user.set_last_login_timestamp(100000)
|
|
||||||
assert user.get_last_login_timestamp() == 86400
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
import logging
|
|
||||||
import os
|
|
||||||
|
|
||||||
from chatmaild.filedict import write_bytes_atomic
|
|
||||||
|
|
||||||
|
|
||||||
def get_daytimestamp(timestamp) -> int:
|
|
||||||
return int(timestamp) // 86400 * 86400
|
|
||||||
|
|
||||||
|
|
||||||
class User:
|
|
||||||
def __init__(self, maildir, addr, password_path, uid, gid):
|
|
||||||
self.maildir = maildir
|
|
||||||
self.addr = addr
|
|
||||||
self.password_path = password_path
|
|
||||||
self.uid = uid
|
|
||||||
self.gid = gid
|
|
||||||
|
|
||||||
@property
|
|
||||||
def can_track(self):
|
|
||||||
return "@" in self.addr and not self.addr.startswith("echo@")
|
|
||||||
|
|
||||||
def get_userdb_dict(self):
|
|
||||||
"""Return a non-empty dovecot 'userdb' style dict
|
|
||||||
if the user has an existing non-empty password"""
|
|
||||||
try:
|
|
||||||
pw = self.password_path.read_text()
|
|
||||||
except FileNotFoundError:
|
|
||||||
return {}
|
|
||||||
|
|
||||||
if not pw:
|
|
||||||
logging.error(f"password is empty for: {self.addr}")
|
|
||||||
return {}
|
|
||||||
|
|
||||||
home = str(self.maildir)
|
|
||||||
return dict(addr=self.addr, home=home, uid=self.uid, gid=self.gid, password=pw)
|
|
||||||
|
|
||||||
def set_password(self, enc_password):
|
|
||||||
"""Set the specified password for this user.
|
|
||||||
|
|
||||||
This method can be called concurrently
|
|
||||||
but there is no guarantee which of the password-set calls will win.
|
|
||||||
"""
|
|
||||||
self.maildir.mkdir(exist_ok=True, parents=True)
|
|
||||||
password = enc_password.encode("ascii")
|
|
||||||
|
|
||||||
try:
|
|
||||||
write_bytes_atomic(self.password_path, password)
|
|
||||||
except PermissionError:
|
|
||||||
if not self.addr.startswith("echo@"):
|
|
||||||
logging.error(f"could not write password for: {self.addr}")
|
|
||||||
raise
|
|
||||||
|
|
||||||
def set_last_login_timestamp(self, timestamp):
|
|
||||||
"""Track login time with daily granularity
|
|
||||||
to minimize touching files and to minimize metadata leakage."""
|
|
||||||
if not self.can_track:
|
|
||||||
return
|
|
||||||
try:
|
|
||||||
mtime = int(os.stat(self.password_path).st_mtime)
|
|
||||||
except FileNotFoundError:
|
|
||||||
logging.error(f"Can not get last login timestamp for {self.addr}")
|
|
||||||
return
|
|
||||||
|
|
||||||
timestamp = get_daytimestamp(timestamp)
|
|
||||||
if mtime != timestamp:
|
|
||||||
os.utime(self.password_path, (timestamp, timestamp))
|
|
||||||
|
|
||||||
def get_last_login_timestamp(self):
|
|
||||||
if self.can_track:
|
|
||||||
try:
|
|
||||||
return int(self.password_path.stat().st_mtime)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.systemd import SystemdStatus
|
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_acmetool(email="", domains=[]):
|
|
||||||
"""Deploy acmetool."""
|
|
||||||
apt.packages(
|
|
||||||
name="Install acmetool",
|
|
||||||
packages=["acmetool"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("acmetool.cron").open("rb"),
|
|
||||||
dest="/etc/cron.d/acmetool",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("acmetool.hook").open("rb"),
|
|
||||||
dest="/usr/lib/acme/hooks/nginx",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="744",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("response-file.yaml.j2"),
|
|
||||||
dest="/var/lib/acme/conf/responses",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
email=email,
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
|
||||||
dest="/var/lib/acme/conf/target",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
service_file = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"acmetool-redirector.service"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/acmetool-redirector.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
if host.get_fact(SystemdStatus).get("nginx.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Stop nginx service to free port 80",
|
|
||||||
service="nginx",
|
|
||||||
running=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Setup acmetool-redirector service",
|
|
||||||
service="acmetool-redirector.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=service_file.changed,
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name=f"Request certificate for: { ', '.join(domains) }",
|
|
||||||
commands=[f"acmetool want --xlog.severity=debug { ' '.join(domains)}"],
|
|
||||||
)
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=acmetool HTTP redirector
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=notify
|
|
||||||
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
SHELL=/bin/sh
|
|
||||||
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin
|
|
||||||
MAILTO=root
|
|
||||||
20 16 * * * root /usr/bin/acmetool --batch reconcile && systemctl reload dovecot && systemctl reload postfix && systemctl reload nginx
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
"acme-enter-email": "{{ email }}"
|
|
||||||
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.4-April-3-2024.pdf": true
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
;
|
|
||||||
; Required DNS entries for chatmail servers
|
|
||||||
;
|
|
||||||
{% if A %}
|
|
||||||
{{ mail_domain }}. A {{ A }}
|
|
||||||
{% endif %}
|
|
||||||
{% if AAAA %}
|
|
||||||
{{ mail_domain }}. AAAA {{ AAAA }}
|
|
||||||
{% endif %}
|
|
||||||
{{ mail_domain }}. MX 10 mx.{{ 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 }}.
|
|
||||||
mx.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
|
||||||
{{ dkim_entry }}
|
|
||||||
|
|
||||||
;
|
|
||||||
; Recommended DNS entries for interoperability and security-hardening
|
|
||||||
;
|
|
||||||
{{ mail_domain }}. TXT "v=spf1 a:{{ mail_domain }} ~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 }}.
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
import os
|
|
||||||
|
|
||||||
import pyinfra
|
|
||||||
|
|
||||||
from cmdeploy import deploy_chatmail
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
config_path = os.getenv(
|
|
||||||
"CHATMAIL_INI",
|
|
||||||
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
|
||||||
)
|
|
||||||
disable_mail = bool(os.environ.get('CHATMAIL_DISABLE_MAIL'))
|
|
||||||
|
|
||||||
deploy_chatmail(config_path, disable_mail)
|
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
|
||||||
main()
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
import datetime
|
|
||||||
import importlib
|
|
||||||
|
|
||||||
from jinja2 import Template
|
|
||||||
|
|
||||||
from . import remote
|
|
||||||
|
|
||||||
|
|
||||||
def get_initial_remote_data(sshexec, mail_domain):
|
|
||||||
return sshexec.logged(
|
|
||||||
call=remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=mail_domain)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def check_initial_remote_data(remote_data, *, print=print):
|
|
||||||
mail_domain = remote_data["mail_domain"]
|
|
||||||
if not remote_data["A"] and not remote_data["AAAA"]:
|
|
||||||
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
|
||||||
elif remote_data["MTA_STS"] != f"{mail_domain}.":
|
|
||||||
print("Missing MTA-STS CNAME record:")
|
|
||||||
print(f"mta-sts.{mail_domain}. CNAME {mail_domain}.")
|
|
||||||
elif remote_data["WWW"] != f"{mail_domain}.":
|
|
||||||
print("Missing www CNAME record:")
|
|
||||||
print(f"www.{mail_domain}. CNAME {mail_domain}.")
|
|
||||||
else:
|
|
||||||
return remote_data
|
|
||||||
|
|
||||||
|
|
||||||
def get_filled_zone_file(remote_data):
|
|
||||||
sts_id = remote_data.get("sts_id")
|
|
||||||
if not sts_id:
|
|
||||||
sts_id = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
|
||||||
|
|
||||||
template = importlib.resources.files(__package__).joinpath("chatmail.zone.j2")
|
|
||||||
content = template.read_text()
|
|
||||||
zonefile = Template(content).render(**remote_data)
|
|
||||||
lines = [x.strip() for x in zonefile.split("\n") if x.strip()]
|
|
||||||
lines.append("")
|
|
||||||
zonefile = "\n".join(lines)
|
|
||||||
return zonefile
|
|
||||||
|
|
||||||
|
|
||||||
def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
|
||||||
"""Check existing DNS records, optionally write them to zone file
|
|
||||||
and return (exitcode, remote_data) tuple."""
|
|
||||||
|
|
||||||
required_diff, recommended_diff = sshexec.logged(
|
|
||||||
remote.rdns.check_zonefile,
|
|
||||||
kwargs=dict(zonefile=zonefile, mail_domain=remote_data["mail_domain"]),
|
|
||||||
)
|
|
||||||
|
|
||||||
if required_diff:
|
|
||||||
out.red("Please set required DNS entries at your DNS provider:\n")
|
|
||||||
for line in required_diff:
|
|
||||||
out(line)
|
|
||||||
return 1
|
|
||||||
elif recommended_diff:
|
|
||||||
out("WARNING: these recommended DNS entries are not set:\n")
|
|
||||||
for line in recommended_diff:
|
|
||||||
out(line)
|
|
||||||
return 0
|
|
||||||
|
|
||||||
out.green("Great! All your DNS entries are verified and correct.")
|
|
||||||
return 0
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
uri = proxy:/run/doveauth/doveauth.socket:auth
|
|
||||||
iterate_disable = no
|
|
||||||
iterate_prefix = userdb/
|
|
||||||
|
|
||||||
default_pass_scheme = plain
|
|
||||||
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
|
||||||
# See <https://doc.dovecot.org/configuration_manual/config_file/config_variables/#modifiers>
|
|
||||||
# for documentation.
|
|
||||||
#
|
|
||||||
# We escape user-provided input and use double quote as a separator.
|
|
||||||
password_key = passdb/%Ew"%Eu
|
|
||||||
user_key = userdb/%Eu
|
|
||||||
@@ -1,234 +0,0 @@
|
|||||||
## Dovecot configuration file
|
|
||||||
|
|
||||||
{% if disable_ipv6 %}
|
|
||||||
listen = *
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
protocols = imap lmtp
|
|
||||||
|
|
||||||
auth_mechanisms = plain
|
|
||||||
|
|
||||||
{% if debug == true %}
|
|
||||||
auth_verbose = yes
|
|
||||||
auth_debug = yes
|
|
||||||
auth_debug_passwords = yes
|
|
||||||
auth_verbose_passwords = plain
|
|
||||||
auth_cache_size = 100M
|
|
||||||
mail_debug = yes
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
# Prevent warnings similar to:
|
|
||||||
# config: Warning: service auth { client_limit=1000 } is lower than required under max. load (10200). Counted for protocol services with service_count != 1: service lmtp { process_limit=100 } + service imap-urlauth-login { process_limit=100 } + service imap-login { process_limit=10000 }
|
|
||||||
# config: Warning: service anvil { client_limit=1000 } is lower than required under max. load (10103). Counted with: service imap-urlauth-login { process_limit=100 } + service imap-login { process_limit=10000 } + service auth { process_limit=1 }
|
|
||||||
# master: Warning: service(stats): client_limit (1000) reached, client connections are being dropped
|
|
||||||
default_client_limit = 20000
|
|
||||||
|
|
||||||
# Increase number of logged in IMAP connections.
|
|
||||||
# Each connection is handled by a separate `imap` process.
|
|
||||||
# `imap` process should have `client_limit=1` as described in
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/service_configuration/#service-limits>
|
|
||||||
# so each logged in IMAP session will need its own `imap` process.
|
|
||||||
#
|
|
||||||
# If this limit is reached,
|
|
||||||
# users will fail to LOGIN as `imap-login` process
|
|
||||||
# will accept them logging in but fail to transfer logged in
|
|
||||||
# connection to `imap` process until someone logs out and
|
|
||||||
# the following warning will be logged:
|
|
||||||
# Warning: service(imap): process_limit (1024) reached, client connections are being dropped
|
|
||||||
service imap {
|
|
||||||
process_limit = 50000
|
|
||||||
}
|
|
||||||
|
|
||||||
mail_server_admin = mailto:root@{{ config.mail_domain }}
|
|
||||||
mail_server_comment = Chatmail server
|
|
||||||
|
|
||||||
# `zlib` enables compressing messages stored in the maildir.
|
|
||||||
# See
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/zlib_plugin/>
|
|
||||||
# for documentation.
|
|
||||||
#
|
|
||||||
# quota plugin documentation:
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/quota_plugin/>
|
|
||||||
mail_plugins = zlib quota
|
|
||||||
|
|
||||||
imap_capability = +XDELTAPUSH XCHATMAIL
|
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
|
||||||
passdb {
|
|
||||||
driver = dict
|
|
||||||
args = /etc/dovecot/auth.conf
|
|
||||||
}
|
|
||||||
userdb {
|
|
||||||
driver = dict
|
|
||||||
args = /etc/dovecot/auth.conf
|
|
||||||
}
|
|
||||||
##
|
|
||||||
## Mailbox locations and namespaces
|
|
||||||
##
|
|
||||||
|
|
||||||
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
|
||||||
mail_location = maildir:{{ config.mailboxes_dir }}/%u
|
|
||||||
|
|
||||||
namespace inbox {
|
|
||||||
inbox = yes
|
|
||||||
|
|
||||||
mailbox Drafts {
|
|
||||||
special_use = \Drafts
|
|
||||||
}
|
|
||||||
mailbox Junk {
|
|
||||||
special_use = \Junk
|
|
||||||
}
|
|
||||||
mailbox Trash {
|
|
||||||
special_use = \Trash
|
|
||||||
}
|
|
||||||
|
|
||||||
# For \Sent mailboxes there are two widely used names. We'll mark both of
|
|
||||||
# them as \Sent. User typically deletes one of them if duplicates are created.
|
|
||||||
mailbox Sent {
|
|
||||||
special_use = \Sent
|
|
||||||
}
|
|
||||||
mailbox "Sent Messages" {
|
|
||||||
special_use = \Sent
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
mail_uid = vmail
|
|
||||||
mail_gid = vmail
|
|
||||||
mail_privileged_group = vmail
|
|
||||||
|
|
||||||
##
|
|
||||||
## Mail processes
|
|
||||||
##
|
|
||||||
|
|
||||||
# Pass all IMAP METADATA requests to the server implementing Dovecot's dict protocol.
|
|
||||||
mail_attribute_dict = proxy:/run/chatmail-metadata/metadata.socket:metadata
|
|
||||||
|
|
||||||
# `imap_zlib` enables IMAP COMPRESS (RFC 4978).
|
|
||||||
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
|
||||||
protocol imap {
|
|
||||||
mail_plugins = $mail_plugins imap_zlib imap_quota last_login
|
|
||||||
imap_metadata = yes
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
last_login_dict = proxy:/run/chatmail-lastlogin/lastlogin.socket:lastlogin
|
|
||||||
#last_login_key = last-login/%u # default
|
|
||||||
last_login_precision = s
|
|
||||||
}
|
|
||||||
|
|
||||||
protocol lmtp {
|
|
||||||
# notify plugin is a dependency of push_notification plugin:
|
|
||||||
# <https://doc.dovecot.org/settings/plugin/notify-plugin/>
|
|
||||||
#
|
|
||||||
# push_notification plugin documentation:
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/push_notification/>
|
|
||||||
#
|
|
||||||
# mail_lua and push_notification_lua are needed for Lua push notification handler.
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/push_notification/#configuration>
|
|
||||||
mail_plugins = $mail_plugins mail_lua notify push_notification push_notification_lua
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
zlib_save = gz
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
imap_compress_deflate_level = 6
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
# for now we define static quota-rules for all users
|
|
||||||
quota = maildir:User quota
|
|
||||||
quota_rule = *:storage={{ config.max_mailbox_size }}
|
|
||||||
quota_max_mail_size={{ config.max_message_size }}
|
|
||||||
quota_grace = 0
|
|
||||||
# quota_over_flag_value = TRUE
|
|
||||||
}
|
|
||||||
|
|
||||||
# push_notification configuration
|
|
||||||
plugin {
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/push_notification/#lua-lua>
|
|
||||||
push_notification_driver = lua:file=/etc/dovecot/push_notification.lua
|
|
||||||
}
|
|
||||||
|
|
||||||
service lmtp {
|
|
||||||
user=vmail
|
|
||||||
|
|
||||||
unix_listener /var/spool/postfix/private/dovecot-lmtp {
|
|
||||||
group = postfix
|
|
||||||
mode = 0600
|
|
||||||
user = postfix
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
service auth {
|
|
||||||
unix_listener /var/spool/postfix/private/auth {
|
|
||||||
mode = 0660
|
|
||||||
user = postfix
|
|
||||||
group = postfix
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
service auth-worker {
|
|
||||||
# Default is root.
|
|
||||||
# Drop privileges we don't need.
|
|
||||||
user = vmail
|
|
||||||
}
|
|
||||||
|
|
||||||
service imap-login {
|
|
||||||
# High-security mode.
|
|
||||||
# Each process serves a single connection and exits afterwards.
|
|
||||||
# This is the default, but we set it explicitly to be sure.
|
|
||||||
# See <https://doc.dovecot.org/admin_manual/login_processes/#high-security-mode> for details.
|
|
||||||
service_count = 1
|
|
||||||
|
|
||||||
# Inrease the number of simultaneous connections.
|
|
||||||
#
|
|
||||||
# As of Dovecot 2.3.19.1 the default is 100 processes.
|
|
||||||
# Combined with `service_count = 1` it means only 100 connections
|
|
||||||
# can be handled simultaneously.
|
|
||||||
process_limit = 10000
|
|
||||||
|
|
||||||
# Avoid startup latency for new connections.
|
|
||||||
process_min_avail = 10
|
|
||||||
}
|
|
||||||
|
|
||||||
service anvil {
|
|
||||||
# We are disabling anvil penalty on failed login attempts
|
|
||||||
# because it can only detect brute forcing by IP address
|
|
||||||
# not by username. As the correct IP address is not handed
|
|
||||||
# to dovecot anyway, it is more of hindrance than of use.
|
|
||||||
# See <https://www.dovecot.org/list/dovecot/2012-May/135485.html> for details.
|
|
||||||
unix_listener anvil-auth-penalty {
|
|
||||||
mode = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
ssl = required
|
|
||||||
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
|
||||||
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
|
||||||
ssl_min_protocol = TLSv1.2
|
|
||||||
ssl_prefer_server_ciphers = yes
|
|
||||||
|
|
||||||
|
|
||||||
{% if config.imap_rawlog %}
|
|
||||||
service postlogin {
|
|
||||||
executable = script-login -d rawlog
|
|
||||||
unix_listener postlogin {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
service imap {
|
|
||||||
executable = imap postlogin
|
|
||||||
}
|
|
||||||
|
|
||||||
protocol imap {
|
|
||||||
#rawlog_dir = /tmp/rawlog/%u
|
|
||||||
# Put .in and .out imap protocol logging files into per-user homedir
|
|
||||||
# You can use a command like this to combine into one protocol stream:
|
|
||||||
# sort -sn <(sed 's/ / C: /' *.in) <(sed 's/ / S: /' cat *.out)
|
|
||||||
|
|
||||||
rawlog_dir = %h
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
# or in any IMAP subfolder
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/.*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
# even if they are unseen
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/.*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
# or only temporary (but then they shouldn't be around after {{ config.delete_mails_after }} days anyway).
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/.*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
3 0 * * * vmail find {{ config.mailboxes_dir }} -name 'maildirsize' -type f -delete
|
|
||||||
4 0 * * * vmail /usr/local/lib/chatmaild/venv/bin/delete_inactive_users /usr/local/lib/chatmaild/chatmail.ini
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
function dovecot_lua_notify_begin_txn(user)
|
|
||||||
return user
|
|
||||||
end
|
|
||||||
|
|
||||||
function contains(v, needle)
|
|
||||||
for _, keyword in ipairs(v) do
|
|
||||||
if keyword == needle then
|
|
||||||
return true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
return false
|
|
||||||
end
|
|
||||||
|
|
||||||
function dovecot_lua_notify_event_message_new(user, event)
|
|
||||||
local mbox = user:mailbox(event.mailbox)
|
|
||||||
mbox:sync()
|
|
||||||
|
|
||||||
if user.username ~= event.from_address then
|
|
||||||
-- Incoming message
|
|
||||||
-- Notify METADATA server about new message.
|
|
||||||
mbox:metadata_set("/private/messagenew", "")
|
|
||||||
end
|
|
||||||
|
|
||||||
mbox:free()
|
|
||||||
end
|
|
||||||
|
|
||||||
function dovecot_lua_notify_end_txn(ctx, success)
|
|
||||||
end
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Iroh relay
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart=/usr/local/bin/iroh-relay --config-path /etc/iroh-relay.toml
|
|
||||||
Restart=on-failure
|
|
||||||
RestartSec=5s
|
|
||||||
User=iroh
|
|
||||||
Group=iroh
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
enable_relay = true
|
|
||||||
http_bind_addr = "[::]:3340"
|
|
||||||
enable_stun = true
|
|
||||||
enable_metrics = false
|
|
||||||
metrics_bind_addr = "127.0.0.1:9092"
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
*/5 * * * * root {{ config.execpath }} {{ config.mailboxes_dir }} >/var/www/html/metrics
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
counter delivered_mail
|
|
||||||
/saved mail to INBOX$/ {
|
|
||||||
delivered_mail++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter quota_exceeded
|
|
||||||
/Quota exceeded \(mailbox for user is full\)$/ {
|
|
||||||
quota_exceeded++
|
|
||||||
}
|
|
||||||
|
|
||||||
# Essentially the number of outgoing messages.
|
|
||||||
counter dkim_signed
|
|
||||||
/DKIM-Signature field added/ {
|
|
||||||
dkim_signed++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter created_accounts
|
|
||||||
counter created_ci_accounts
|
|
||||||
counter created_nonci_accounts
|
|
||||||
|
|
||||||
/: Created address: (?P<addr>.*)$/ {
|
|
||||||
created_accounts++
|
|
||||||
|
|
||||||
$addr =~ /ci-/ {
|
|
||||||
created_ci_accounts++
|
|
||||||
} else {
|
|
||||||
created_nonci_accounts++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
counter postfix_timeouts
|
|
||||||
/timeout after DATA/ {
|
|
||||||
postfix_timeouts++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter postfix_noqueue
|
|
||||||
/postfix\/.*NOQUEUE/ {
|
|
||||||
postfix_noqueue++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter warning_count
|
|
||||||
/warning/ {
|
|
||||||
warning_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
counter filtered_mail_count
|
|
||||||
|
|
||||||
counter encrypted_mail_count
|
|
||||||
/Filtering encrypted mail\./ {
|
|
||||||
encrypted_mail_count++
|
|
||||||
filtered_mail_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter unencrypted_mail_count
|
|
||||||
/Filtering unencrypted mail\./ {
|
|
||||||
unencrypted_mail_count++
|
|
||||||
filtered_mail_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter rejected_unencrypted_mail_count
|
|
||||||
/Rejected unencrypted mail\./ {
|
|
||||||
rejected_unencrypted_mail_count++
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=mtail
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
ExecStart=/bin/sh -c "journalctl -f -o short-iso -n 0 | /usr/bin/mtail --address={{ address }} --port={{ port }} --progs /etc/mtail --logtostderr --logs -"
|
|
||||||
Restart=on-failure
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
load_module modules/ngx_stream_module.so;
|
|
||||||
|
|
||||||
user www-data;
|
|
||||||
worker_processes auto;
|
|
||||||
pid /run/nginx.pid;
|
|
||||||
error_log syslog:server=unix:/dev/log,facility=local3;
|
|
||||||
|
|
||||||
events {
|
|
||||||
worker_connections 768;
|
|
||||||
# multi_accept on;
|
|
||||||
}
|
|
||||||
|
|
||||||
stream {
|
|
||||||
map $ssl_preread_alpn_protocols $proxy {
|
|
||||||
default 127.0.0.1:8443;
|
|
||||||
~\bsmtp\b 127.0.0.1:465;
|
|
||||||
~\bimap\b 127.0.0.1:993;
|
|
||||||
}
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 443;
|
|
||||||
{% if not disable_ipv6 %}
|
|
||||||
listen [::]:443;
|
|
||||||
{% endif %}
|
|
||||||
proxy_pass $proxy;
|
|
||||||
ssl_preread on;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
http {
|
|
||||||
sendfile on;
|
|
||||||
tcp_nopush on;
|
|
||||||
|
|
||||||
# Do not emit nginx version on error pages.
|
|
||||||
server_tokens off;
|
|
||||||
|
|
||||||
include /etc/nginx/mime.types;
|
|
||||||
default_type application/octet-stream;
|
|
||||||
|
|
||||||
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
|
||||||
ssl_prefer_server_ciphers on;
|
|
||||||
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
|
||||||
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
|
||||||
|
|
||||||
gzip on;
|
|
||||||
|
|
||||||
server {
|
|
||||||
|
|
||||||
listen 8443 ssl default_server;
|
|
||||||
{% if not disable_ipv6 %}
|
|
||||||
listen [::]:8443 ssl default_server;
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
root /var/www/html;
|
|
||||||
|
|
||||||
index index.html index.htm;
|
|
||||||
|
|
||||||
server_name _;
|
|
||||||
|
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
# First attempt to serve request as file, then
|
|
||||||
# as directory, then fall back to displaying a 404.
|
|
||||||
try_files $uri $uri/ =404;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /metrics {
|
|
||||||
default_type text/plain;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /new {
|
|
||||||
if ($request_method = GET) {
|
|
||||||
# Redirect to Delta Chat,
|
|
||||||
# which will in turn do a POST request.
|
|
||||||
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
|
||||||
}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
|
||||||
include /etc/nginx/fastcgi_params;
|
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Old URL for compatibility with e.g. printed QR codes.
|
|
||||||
#
|
|
||||||
# Copy-paste instead of redirect to /new
|
|
||||||
# because Delta Chat core does not follow redirects.
|
|
||||||
#
|
|
||||||
# Redirects are only for browsers.
|
|
||||||
location /cgi-bin/newemail.py {
|
|
||||||
if ($request_method = GET) {
|
|
||||||
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
|
||||||
}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
|
||||||
include /etc/nginx/fastcgi_params;
|
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Proxy to iroh-relay service.
|
|
||||||
location /relay {
|
|
||||||
proxy_pass http://127.0.0.1:3340;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
|
|
||||||
# Upgrade header is normally set to "iroh derp http" or "websocket".
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Connection "upgrade";
|
|
||||||
}
|
|
||||||
|
|
||||||
location /relay/probe {
|
|
||||||
proxy_pass http://127.0.0.1:3340;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /generate_204 {
|
|
||||||
proxy_pass http://127.0.0.1:3340;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# Redirect www. to non-www
|
|
||||||
server {
|
|
||||||
listen 8443 ssl;
|
|
||||||
{% if not disable_ipv6 %}
|
|
||||||
listen [::]:8443 ssl;
|
|
||||||
{% endif %}
|
|
||||||
server_name www.{{ config.domain_name }};
|
|
||||||
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
@@ -1 +0,0 @@
|
|||||||
{{ config.opendkim_selector }}._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/{{ config.opendkim_selector }}.private
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
if odkim.internal_ip(ctx) == 1 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
|
|
||||||
|
|
||||||
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
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
odkim.set_reply(ctx, "554", "5.7.1", "No valid DKIM signature found")
|
|
||||||
odkim.set_result(ctx, SMFIS_REJECT)
|
|
||||||
return nil
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
-- 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
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
/^(.*)$/ ${1}
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
myorigin = {{ config.mail_domain }}
|
|
||||||
|
|
||||||
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
|
||||||
biff = no
|
|
||||||
|
|
||||||
# appending .domain is the MUA's job.
|
|
||||||
append_dot_mydomain = no
|
|
||||||
|
|
||||||
# Uncomment the next line to generate "delayed mail" warnings
|
|
||||||
#delay_warning_time = 4h
|
|
||||||
|
|
||||||
readme_directory = no
|
|
||||||
|
|
||||||
# See http://www.postfix.org/COMPATIBILITY_README.html
|
|
||||||
compatibility_level = 3.6
|
|
||||||
|
|
||||||
# TLS parameters
|
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
|
||||||
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
|
||||||
smtpd_tls_security_level=may
|
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
|
||||||
smtp_tls_security_level=may
|
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
|
||||||
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
|
||||||
smtpd_tls_protocols = >=TLSv1.2
|
|
||||||
|
|
||||||
# Disable anonymous cipher suites
|
|
||||||
# and known insecure algorithms.
|
|
||||||
#
|
|
||||||
# Disabling anonymous ciphers
|
|
||||||
# does not generally improve security
|
|
||||||
# because clients that want to verify certificate
|
|
||||||
# will not select them anyway,
|
|
||||||
# but makes cipher suite list shorter and security scanners happy.
|
|
||||||
# See <https://www.postfix.org/TLS_README.html> for discussion.
|
|
||||||
#
|
|
||||||
# Only ancient insecure ciphers should be disabled here
|
|
||||||
# as MTA clients that do not support more secure cipher
|
|
||||||
# likely do not support MTA-STS either and will
|
|
||||||
# otherwise fall back to using plaintext connection.
|
|
||||||
smtpd_tls_exclude_ciphers = aNULL, RC4, MD5, DES
|
|
||||||
|
|
||||||
# Override client's preference order.
|
|
||||||
# <https://www.postfix.org/postconf.5.html#tls_preempt_cipherlist>
|
|
||||||
#
|
|
||||||
# This is mostly to ensure cipher suites with forward secrecy
|
|
||||||
# are preferred over non cipher suites without forward secrecy.
|
|
||||||
# See <https://www.postfix.org/FORWARD_SECRECY_README.html#server_fs>.
|
|
||||||
tls_preempt_cipherlist = yes
|
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
|
||||||
myhostname = {{ config.mail_domain }}
|
|
||||||
alias_maps = hash:/etc/aliases
|
|
||||||
alias_database = hash:/etc/aliases
|
|
||||||
|
|
||||||
# Postfix does not deliver mail for any domain by itself.
|
|
||||||
# Primary domain is listed in `virtual_mailbox_domains` instead
|
|
||||||
# and handed over to Dovecot.
|
|
||||||
mydestination =
|
|
||||||
|
|
||||||
relayhost =
|
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
|
||||||
mailbox_size_limit = 0
|
|
||||||
message_size_limit = {{config.max_message_size}}
|
|
||||||
recipient_delimiter = +
|
|
||||||
inet_interfaces = all
|
|
||||||
{% if disable_ipv6 %}
|
|
||||||
inet_protocols = ipv4
|
|
||||||
{% else %}
|
|
||||||
inet_protocols = all
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
|
||||||
virtual_mailbox_domains = {{ config.mail_domain }}
|
|
||||||
|
|
||||||
mua_client_restrictions = permit_sasl_authenticated, reject
|
|
||||||
mua_sender_restrictions = reject_sender_login_mismatch, permit_sasl_authenticated, reject
|
|
||||||
mua_helo_restrictions = permit_mynetworks, reject_invalid_helo_hostname, reject_non_fqdn_helo_hostname, permit
|
|
||||||
|
|
||||||
# 1:1 map MAIL FROM to SASL login name.
|
|
||||||
smtpd_sender_login_maps = regexp:/etc/postfix/login_map
|
|
||||||
|
|
||||||
# Do not lookup SMTP client hostnames to reduce delays
|
|
||||||
# and avoid unnecessary DNS requests.
|
|
||||||
smtpd_peername_lookup = no
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
/^Received:/ IGNORE
|
|
||||||
/^X-Originating-IP:/ IGNORE
|
|
||||||
/^X-Mailer:/ IGNORE
|
|
||||||
/^User-Agent:/ IGNORE
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
"""
|
|
||||||
|
|
||||||
The 'cmdeploy.remote' sub package contains modules with remotely executing functions.
|
|
||||||
|
|
||||||
Its "_sshexec_bootstrap" module is executed remotely through `SSHExec`
|
|
||||||
and its main() loop there stays connected via a command channel,
|
|
||||||
ready to receive function invocations ("command") and return results.
|
|
||||||
"""
|
|
||||||
|
|
||||||
from . import rdns, rshell
|
|
||||||
|
|
||||||
__all__ = ["rdns", "rshell"]
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
import builtins
|
|
||||||
import importlib
|
|
||||||
import traceback
|
|
||||||
|
|
||||||
## Function Execution server
|
|
||||||
|
|
||||||
|
|
||||||
def _run_loop(cmd_channel):
|
|
||||||
while cmd := cmd_channel.receive():
|
|
||||||
cmd_channel.send(_handle_one_request(cmd))
|
|
||||||
|
|
||||||
|
|
||||||
def _handle_one_request(cmd):
|
|
||||||
pymod_path, func_name, kwargs = cmd
|
|
||||||
try:
|
|
||||||
mod = importlib.import_module(pymod_path)
|
|
||||||
func = getattr(mod, func_name)
|
|
||||||
res = func(**kwargs)
|
|
||||||
return ("finish", res)
|
|
||||||
except:
|
|
||||||
data = traceback.format_exc()
|
|
||||||
return ("error", data)
|
|
||||||
|
|
||||||
|
|
||||||
def main(channel):
|
|
||||||
# enable simple "print" logging
|
|
||||||
|
|
||||||
builtins.print = lambda x="": channel.send(("log", x))
|
|
||||||
|
|
||||||
_run_loop(channel)
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
"""
|
|
||||||
Pure python functions which execute remotely in a system Python interpreter.
|
|
||||||
|
|
||||||
All functions of this module
|
|
||||||
|
|
||||||
- need to get and and return Python builtin data types only,
|
|
||||||
|
|
||||||
- can only use standard library dependencies,
|
|
||||||
|
|
||||||
- can freely call each other.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import re
|
|
||||||
|
|
||||||
from .rshell import CalledProcessError, shell
|
|
||||||
|
|
||||||
|
|
||||||
def perform_initial_checks(mail_domain):
|
|
||||||
"""Collecting initial DNS settings."""
|
|
||||||
assert mail_domain
|
|
||||||
if not shell("dig", fail_ok=True):
|
|
||||||
shell("apt-get install -y dnsutils")
|
|
||||||
A = query_dns("A", mail_domain)
|
|
||||||
AAAA = query_dns("AAAA", mail_domain)
|
|
||||||
MTA_STS = query_dns("CNAME", f"mta-sts.{mail_domain}")
|
|
||||||
WWW = query_dns("CNAME", f"www.{mail_domain}")
|
|
||||||
|
|
||||||
res = dict(mail_domain=mail_domain, A=A, AAAA=AAAA, MTA_STS=MTA_STS, WWW=WWW)
|
|
||||||
res["acme_account_url"] = shell("acmetool account-url", fail_ok=True)
|
|
||||||
res["dkim_entry"] = get_dkim_entry(mail_domain, dkim_selector="opendkim")
|
|
||||||
|
|
||||||
if not MTA_STS or not WWW or (not A and not AAAA):
|
|
||||||
return res
|
|
||||||
|
|
||||||
# parse out sts-id if exists, example: "v=STSv1; id=2090123"
|
|
||||||
parts = query_dns("TXT", f"_mta-sts.{mail_domain}").split("id=")
|
|
||||||
res["sts_id"] = parts[1].rstrip('"') if len(parts) == 2 else ""
|
|
||||||
return res
|
|
||||||
|
|
||||||
|
|
||||||
def get_dkim_entry(mail_domain, dkim_selector):
|
|
||||||
try:
|
|
||||||
dkim_pubkey = shell(
|
|
||||||
f"openssl rsa -in /etc/dkimkeys/{dkim_selector}.private "
|
|
||||||
"-pubout 2>/dev/null | awk '/-/{next}{printf(\"%s\",$0)}'"
|
|
||||||
)
|
|
||||||
except CalledProcessError:
|
|
||||||
return
|
|
||||||
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))
|
|
||||||
return f'{dkim_selector}._domainkey.{mail_domain}. TXT "{dkim_value}"'
|
|
||||||
|
|
||||||
|
|
||||||
def query_dns(typ, domain):
|
|
||||||
# Get autoritative nameserver from the SOA record.
|
|
||||||
soa_answers = [
|
|
||||||
x.split()
|
|
||||||
for x in shell(f"dig -r -q {domain} -t SOA +noall +authority +answer").split(
|
|
||||||
"\n"
|
|
||||||
)
|
|
||||||
]
|
|
||||||
soa = [a for a in soa_answers if len(a) >= 3 and a[3] == "SOA"]
|
|
||||||
if not soa:
|
|
||||||
return
|
|
||||||
ns = soa[0][4]
|
|
||||||
|
|
||||||
# Query authoritative nameserver directly to bypass DNS cache.
|
|
||||||
res = shell(f"dig @{ns} -r -q {domain} -t {typ} +short")
|
|
||||||
if res:
|
|
||||||
return res.split("\n")[0]
|
|
||||||
return ""
|
|
||||||
|
|
||||||
|
|
||||||
def check_zonefile(zonefile, mail_domain):
|
|
||||||
"""Check expected zone file entries."""
|
|
||||||
required = True
|
|
||||||
required_diff = []
|
|
||||||
recommended_diff = []
|
|
||||||
|
|
||||||
for zf_line in zonefile.splitlines():
|
|
||||||
if "; Recommended" in zf_line:
|
|
||||||
required = False
|
|
||||||
continue
|
|
||||||
if not zf_line.strip() or zf_line.startswith(";"):
|
|
||||||
continue
|
|
||||||
print(f"dns-checking {zf_line!r}")
|
|
||||||
zf_domain, zf_typ, zf_value = zf_line.split(maxsplit=2)
|
|
||||||
zf_domain = zf_domain.rstrip(".")
|
|
||||||
zf_value = zf_value.strip()
|
|
||||||
query_value = query_dns(zf_typ, zf_domain)
|
|
||||||
if zf_value != query_value:
|
|
||||||
assert zf_typ in ("A", "AAAA", "CNAME", "CAA", "SRV", "MX", "TXT"), zf_line
|
|
||||||
if required:
|
|
||||||
required_diff.append(zf_line)
|
|
||||||
else:
|
|
||||||
recommended_diff.append(zf_line)
|
|
||||||
|
|
||||||
return required_diff, recommended_diff
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
from subprocess import CalledProcessError, check_output
|
|
||||||
|
|
||||||
|
|
||||||
def shell(command, fail_ok=False):
|
|
||||||
print(f"$ {command}")
|
|
||||||
try:
|
|
||||||
return check_output(command, shell=True).decode().rstrip()
|
|
||||||
except CalledProcessError:
|
|
||||||
if not fail_ok:
|
|
||||||
raise
|
|
||||||
return ""
|
|
||||||
|
|
||||||
|
|
||||||
def get_systemd_running():
|
|
||||||
lines = shell("systemctl --type=service --state=running").split("\n")
|
|
||||||
return [line for line in lines if line.startswith(" ")]
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail dict proxy for IMAP METADATA
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} /run/chatmail-metadata/metadata.socket {config_path}
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
User=vmail
|
|
||||||
RuntimeDirectory=chatmail-metadata
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail echo bot for testing it works
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} {config_path}
|
|
||||||
Environment="PATH={remote_venv_dir}:$PATH"
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
User=echobot
|
|
||||||
Group=echobot
|
|
||||||
|
|
||||||
# Create /var/lib/echobot
|
|
||||||
StateDirectory=echobot
|
|
||||||
|
|
||||||
# Create /run/echobot
|
|
||||||
#
|
|
||||||
# echobot stores /run/echobot/password
|
|
||||||
# with a password there, which doveauth then reads.
|
|
||||||
RuntimeDirectory=echobot
|
|
||||||
|
|
||||||
WorkingDirectory=/var/lib/echobot
|
|
||||||
|
|
||||||
# Apply security restrictions suggested by
|
|
||||||
# systemd-analyze security echobot.service
|
|
||||||
CapabilityBoundingSet=
|
|
||||||
LockPersonality=true
|
|
||||||
MemoryDenyWriteExecute=true
|
|
||||||
NoNewPrivileges=true
|
|
||||||
PrivateDevices=true
|
|
||||||
PrivateMounts=true
|
|
||||||
PrivateTmp=true
|
|
||||||
|
|
||||||
# We need to know about doveauth user to give it access to /run/echobot/password
|
|
||||||
PrivateUsers=false
|
|
||||||
|
|
||||||
ProtectClock=true
|
|
||||||
ProtectControlGroups=true
|
|
||||||
ProtectHostname=true
|
|
||||||
ProtectKernelLogs=true
|
|
||||||
ProtectKernelModules=true
|
|
||||||
ProtectKernelTunables=true
|
|
||||||
ProtectProc=noaccess
|
|
||||||
|
|
||||||
# Should be "strict", but we currently write /accounts folder in a protected path
|
|
||||||
ProtectSystem=full
|
|
||||||
|
|
||||||
RemoveIPC=true
|
|
||||||
RestrictAddressFamilies=AF_INET AF_INET6
|
|
||||||
RestrictNamespaces=true
|
|
||||||
RestrictRealtime=true
|
|
||||||
RestrictSUIDSGID=true
|
|
||||||
SystemCallArchitectures=native
|
|
||||||
SystemCallFilter=~@clock
|
|
||||||
SystemCallFilter=~@cpu-emulation
|
|
||||||
SystemCallFilter=~@debug
|
|
||||||
SystemCallFilter=~@module
|
|
||||||
SystemCallFilter=~@mount
|
|
||||||
SystemCallFilter=~@obsolete
|
|
||||||
SystemCallFilter=~@raw-io
|
|
||||||
SystemCallFilter=~@reboot
|
|
||||||
SystemCallFilter=~@resources
|
|
||||||
SystemCallFilter=~@swap
|
|
||||||
UMask=0077
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Dict proxy for last-login tracking
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} /run/chatmail-lastlogin/lastlogin.socket {config_path}
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
User=vmail
|
|
||||||
RuntimeDirectory=chatmail-lastlogin
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
import inspect
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
from queue import Queue
|
|
||||||
|
|
||||||
import execnet
|
|
||||||
|
|
||||||
from . import remote
|
|
||||||
|
|
||||||
|
|
||||||
class FuncError(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def bootstrap_remote(gateway, remote=remote):
|
|
||||||
"""Return a command channel which can execute remote functions."""
|
|
||||||
source_init_path = inspect.getfile(remote)
|
|
||||||
basedir = os.path.dirname(source_init_path)
|
|
||||||
name = os.path.basename(basedir)
|
|
||||||
|
|
||||||
# rsync sourcedir to remote host
|
|
||||||
remote_pkg_path = f"/root/from-cmdeploy/{name}"
|
|
||||||
q = Queue()
|
|
||||||
finish = lambda: q.put(None)
|
|
||||||
rsync = execnet.RSync(sourcedir=basedir, verbose=False)
|
|
||||||
rsync.add_target(gateway, remote_pkg_path, finishedcallback=finish, delete=True)
|
|
||||||
rsync.send()
|
|
||||||
q.get()
|
|
||||||
|
|
||||||
# start sshexec bootstrap and return its command channel
|
|
||||||
remote_sys_path = os.path.dirname(remote_pkg_path)
|
|
||||||
channel = gateway.remote_exec(
|
|
||||||
f"""
|
|
||||||
import sys
|
|
||||||
sys.path.insert(0, {remote_sys_path!r})
|
|
||||||
from remote._sshexec_bootstrap import main
|
|
||||||
main(channel)
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
return channel
|
|
||||||
|
|
||||||
|
|
||||||
def print_stderr(item="", end="\n"):
|
|
||||||
print(item, file=sys.stderr, end=end)
|
|
||||||
|
|
||||||
|
|
||||||
class SSHExec:
|
|
||||||
RemoteError = execnet.RemoteError
|
|
||||||
FuncError = FuncError
|
|
||||||
|
|
||||||
def __init__(self, host, verbose=False, python="python3", timeout=60):
|
|
||||||
self.gateway = execnet.makegateway(f"ssh=root@{host}//python={python}")
|
|
||||||
self._remote_cmdloop_channel = bootstrap_remote(self.gateway, remote)
|
|
||||||
self.timeout = timeout
|
|
||||||
self.verbose = verbose
|
|
||||||
|
|
||||||
def __call__(self, call, kwargs=None, log_callback=None):
|
|
||||||
if kwargs is None:
|
|
||||||
kwargs = {}
|
|
||||||
assert call.__module__.startswith("cmdeploy.remote")
|
|
||||||
modname = call.__module__.replace("cmdeploy.", "")
|
|
||||||
self._remote_cmdloop_channel.send((modname, call.__name__, kwargs))
|
|
||||||
while 1:
|
|
||||||
code, data = self._remote_cmdloop_channel.receive(timeout=self.timeout)
|
|
||||||
if log_callback is not None and code == "log":
|
|
||||||
log_callback(data)
|
|
||||||
elif code == "finish":
|
|
||||||
return data
|
|
||||||
elif code == "error":
|
|
||||||
raise self.FuncError(data)
|
|
||||||
|
|
||||||
def logged(self, call, kwargs):
|
|
||||||
def log_progress(data):
|
|
||||||
sys.stderr.write(".")
|
|
||||||
sys.stderr.flush()
|
|
||||||
|
|
||||||
title = call.__doc__
|
|
||||||
if not title:
|
|
||||||
title = call.__name__
|
|
||||||
if self.verbose:
|
|
||||||
print_stderr("[ssh] " + title)
|
|
||||||
return self(call, kwargs, log_callback=print_stderr)
|
|
||||||
else:
|
|
||||||
print_stderr(title, end="")
|
|
||||||
res = self(call, kwargs, log_callback=log_progress)
|
|
||||||
print_stderr()
|
|
||||||
return res
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
; Required DNS entries for chatmail servers
|
|
||||||
zftest.testrun.org. A 135.181.204.127
|
|
||||||
zftest.testrun.org. AAAA 2a01:4f9:c012:52f4::1
|
|
||||||
zftest.testrun.org. MX 10 zftest.testrun.org.
|
|
||||||
_mta-sts.zftest.testrun.org. TXT "v=STSv1; id=202403211706"
|
|
||||||
mta-sts.zftest.testrun.org. CNAME zftest.testrun.org.
|
|
||||||
www.zftest.testrun.org. CNAME zftest.testrun.org.
|
|
||||||
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
|
|
||||||
_submission._tcp.zftest.testrun.org. SRV 0 1 587 zftest.testrun.org.
|
|
||||||
_submissions._tcp.zftest.testrun.org. SRV 0 1 465 zftest.testrun.org.
|
|
||||||
_imap._tcp.zftest.testrun.org. SRV 0 1 143 zftest.testrun.org.
|
|
||||||
_imaps._tcp.zftest.testrun.org. SRV 0 1 993 zftest.testrun.org.
|
|
||||||
zftest.testrun.org. CAA 0 issue "letsencrypt.org;accounturi=https://acme-v02.api.letsencrypt.org/acme/acct/1371472956"
|
|
||||||
zftest.testrun.org. TXT "v=spf1 a:zftest.testrun.org ~all"
|
|
||||||
_dmarc.zftest.testrun.org. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
|
||||||
_adsp._domainkey.zftest.testrun.org. TXT "dkim=discardable"
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
import requests
|
|
||||||
|
|
||||||
from cmdeploy.genqr import gen_qr_png_data
|
|
||||||
|
|
||||||
|
|
||||||
def test_gen_qr_png_data(maildomain):
|
|
||||||
data = gen_qr_png_data(maildomain)
|
|
||||||
assert data
|
|
||||||
|
|
||||||
|
|
||||||
def test_fastcgi_working(maildomain, chatmail_config):
|
|
||||||
url = f"https://{maildomain}/new"
|
|
||||||
print(url)
|
|
||||||
res = requests.post(url)
|
|
||||||
assert maildomain in res.json().get("email")
|
|
||||||
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
|
||||||
|
|
||||||
|
|
||||||
def test_newemail_configure(maildomain, rpc):
|
|
||||||
"""Test configuring accounts by scanning a QR code works."""
|
|
||||||
url = f"DCACCOUNT:https://{maildomain}/new"
|
|
||||||
for i in range(3):
|
|
||||||
account_id = rpc.add_account()
|
|
||||||
rpc.set_config_from_qr(account_id, url)
|
|
||||||
rpc.configure(account_id)
|
|
||||||
@@ -1,152 +0,0 @@
|
|||||||
import smtplib
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from cmdeploy import remote
|
|
||||||
from cmdeploy.sshexec import SSHExec
|
|
||||||
|
|
||||||
|
|
||||||
class TestSSHExecutor:
|
|
||||||
@pytest.fixture(scope="class")
|
|
||||||
def sshexec(self, sshdomain):
|
|
||||||
return SSHExec(sshdomain)
|
|
||||||
|
|
||||||
def test_ls(self, sshexec):
|
|
||||||
out = sshexec(call=remote.rdns.shell, kwargs=dict(command="ls"))
|
|
||||||
out2 = sshexec(call=remote.rdns.shell, kwargs=dict(command="ls"))
|
|
||||||
assert out == out2
|
|
||||||
|
|
||||||
def test_perform_initial(self, sshexec, maildomain):
|
|
||||||
res = sshexec(
|
|
||||||
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
|
||||||
)
|
|
||||||
assert res["A"] or res["AAAA"]
|
|
||||||
|
|
||||||
def test_logged(self, sshexec, maildomain, capsys):
|
|
||||||
sshexec.logged(
|
|
||||||
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
|
||||||
)
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
assert err.startswith("Collecting")
|
|
||||||
assert err.endswith("....\n")
|
|
||||||
assert err.count("\n") == 1
|
|
||||||
|
|
||||||
sshexec.verbose = True
|
|
||||||
sshexec.logged(
|
|
||||||
remote.rdns.perform_initial_checks, kwargs=dict(mail_domain=maildomain)
|
|
||||||
)
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
lines = err.split("\n")
|
|
||||||
assert len(lines) > 4
|
|
||||||
assert remote.rdns.perform_initial_checks.__doc__ in lines[0]
|
|
||||||
|
|
||||||
def test_exception(self, sshexec, capsys):
|
|
||||||
try:
|
|
||||||
sshexec.logged(
|
|
||||||
remote.rdns.perform_initial_checks,
|
|
||||||
kwargs=dict(mail_domain=None),
|
|
||||||
)
|
|
||||||
except sshexec.FuncError as e:
|
|
||||||
assert "rdns.py" in str(e)
|
|
||||||
assert "AssertionError" in str(e)
|
|
||||||
else:
|
|
||||||
pytest.fail("didn't raise exception")
|
|
||||||
|
|
||||||
|
|
||||||
def test_remote(remote, imap_or_smtp):
|
|
||||||
lineproducer = remote.iter_output(imap_or_smtp.logcmd)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
assert imap_or_smtp.name in next(lineproducer)
|
|
||||||
|
|
||||||
|
|
||||||
def test_use_two_chatmailservers(cmfactory, maildomain2):
|
|
||||||
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.switch_maildomain(maildomain2)
|
|
||||||
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.bring_accounts_online()
|
|
||||||
cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
domain1 = ac1.get_config("addr").split("@")[1]
|
|
||||||
domain2 = ac2.get_config("addr").split("@")[1]
|
|
||||||
assert domain1 != domain2
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("forgeaddr", ["internal", "someone@example.org"])
|
|
||||||
def test_reject_forged_from(cmsetup, maildata, gencreds, lp, forgeaddr):
|
|
||||||
user1, user3 = cmsetup.gen_users(2)
|
|
||||||
|
|
||||||
lp.sec("send encrypted message with forged from")
|
|
||||||
print("envelope_from", user1.addr)
|
|
||||||
if forgeaddr == "internal":
|
|
||||||
addr_to_forge = cmsetup.gen_users(1)[0].addr
|
|
||||||
else:
|
|
||||||
addr_to_forge = "someone@example.org"
|
|
||||||
|
|
||||||
print("message to inject:")
|
|
||||||
msg = maildata("encrypted.eml", from_addr=addr_to_forge, to_addr=user3.addr)
|
|
||||||
msg = msg.as_string()
|
|
||||||
for line in msg.split("\n")[:4]:
|
|
||||||
print(f" {line}")
|
|
||||||
|
|
||||||
lp.sec("Send forged mail and check remote postfix lmtp processing result")
|
|
||||||
with pytest.raises(smtplib.SMTPException) as e:
|
|
||||||
user1.smtp.sendmail(from_addr=user1.addr, to_addrs=[user3.addr], msg=msg)
|
|
||||||
assert "500" in str(e.value)
|
|
||||||
|
|
||||||
|
|
||||||
def test_authenticated_from(cmsetup, maildata):
|
|
||||||
"""Test that envelope FROM must be the same as login."""
|
|
||||||
user1, user2, user3 = cmsetup.gen_users(3)
|
|
||||||
|
|
||||||
msg = maildata("encrypted.eml", from_addr=user2.addr, to_addr=user3.addr)
|
|
||||||
with pytest.raises(smtplib.SMTPException) as e:
|
|
||||||
user1.smtp.sendmail(
|
|
||||||
from_addr=user2.addr, to_addrs=[user3.addr], msg=msg.as_string()
|
|
||||||
)
|
|
||||||
assert e.value.recipients[user3.addr][0] == 553
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
|
||||||
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
|
||||||
"""Test that emails with missing or wrong DMARC, DKIM, and SPF entries are rejected."""
|
|
||||||
recipient = cmsetup.gen_users(1)[0]
|
|
||||||
msg = maildata("plain.eml", from_addr=from_addr, to_addr=recipient.addr).as_string()
|
|
||||||
with smtplib.SMTP(cmsetup.maildomain, 25) as s:
|
|
||||||
with pytest.raises(smtplib.SMTPDataError, match="No valid DKIM signature"):
|
|
||||||
s.sendmail(from_addr=from_addr, to_addrs=recipient.addr, msg=msg)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.slow
|
|
||||||
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
|
||||||
"""Test that the per-account send-mail limit is exceeded."""
|
|
||||||
user1, user2 = cmsetup.gen_users(2)
|
|
||||||
mail = maildata(
|
|
||||||
"encrypted.eml", from_addr=user1.addr, to_addr=user2.addr
|
|
||||||
).as_string()
|
|
||||||
for i in range(chatmail_config.max_user_send_per_minute + 5):
|
|
||||||
print("Sending mail", str(i))
|
|
||||||
try:
|
|
||||||
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
|
||||||
except smtplib.SMTPException as e:
|
|
||||||
if i < chatmail_config.max_user_send_per_minute:
|
|
||||||
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
|
||||||
outcome = e.recipients[user2.addr]
|
|
||||||
assert outcome[0] == 450
|
|
||||||
assert b"4.7.1: Too much mail from" in outcome[1]
|
|
||||||
return
|
|
||||||
pytest.fail("Rate limit was not exceeded")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.slow
|
|
||||||
def test_expunged(remote, chatmail_config):
|
|
||||||
outdated_days = int(chatmail_config.delete_mails_after) + 1
|
|
||||||
find_cmds = [
|
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/cur/*' -mtime +{outdated_days} -type f",
|
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/.*/cur/*' -mtime +{outdated_days} -type f",
|
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/new/*' -mtime +{outdated_days} -type f",
|
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/.*/new/*' -mtime +{outdated_days} -type f",
|
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/tmp/*' -mtime +{outdated_days} -type f",
|
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/.*/tmp/*' -mtime +{outdated_days} -type f",
|
|
||||||
]
|
|
||||||
for cmd in find_cmds:
|
|
||||||
for line in remote.iter_output(cmd):
|
|
||||||
assert not line
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
import os
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from cmdeploy.cmdeploy import get_parser, main
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
|
||||||
def _chdir(tmp_path):
|
|
||||||
old = os.getcwd()
|
|
||||||
os.chdir(tmp_path)
|
|
||||||
yield
|
|
||||||
os.chdir(old)
|
|
||||||
|
|
||||||
|
|
||||||
class TestCmdline:
|
|
||||||
def test_parser(self, capsys):
|
|
||||||
parser = get_parser()
|
|
||||||
parser.parse_args([])
|
|
||||||
init = parser.parse_args(["init", "chat.example.org"])
|
|
||||||
run = parser.parse_args(["run"])
|
|
||||||
assert init and run
|
|
||||||
|
|
||||||
def test_init_not_overwrite(self, capsys):
|
|
||||||
assert main(["init", "chat.example.org"]) == 0
|
|
||||||
capsys.readouterr()
|
|
||||||
assert main(["init", "chat.example.org"]) == 1
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
assert "path exists" in out.lower()
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from cmdeploy import remote
|
|
||||||
from cmdeploy.dns import check_full_zone, check_initial_remote_data
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def mockdns_base(monkeypatch):
|
|
||||||
qdict = {}
|
|
||||||
|
|
||||||
def query_dns(typ, domain):
|
|
||||||
try:
|
|
||||||
return qdict[typ][domain]
|
|
||||||
except KeyError:
|
|
||||||
return ""
|
|
||||||
|
|
||||||
monkeypatch.setattr(remote.rdns, query_dns.__name__, query_dns)
|
|
||||||
return qdict
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def mockdns(mockdns_base):
|
|
||||||
mockdns_base.update(
|
|
||||||
{
|
|
||||||
"A": {"some.domain": "1.1.1.1"},
|
|
||||||
"AAAA": {"some.domain": "fde5:cd7a:9e1c:3240:5a99:936f:cdac:53ae"},
|
|
||||||
"CNAME": {
|
|
||||||
"mta-sts.some.domain": "some.domain.",
|
|
||||||
"www.some.domain": "some.domain.",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return mockdns_base
|
|
||||||
|
|
||||||
|
|
||||||
class TestPerformInitialChecks:
|
|
||||||
def test_perform_initial_checks_ok1(self, mockdns):
|
|
||||||
remote_data = remote.rdns.perform_initial_checks("some.domain")
|
|
||||||
assert remote_data["A"] == mockdns["A"]["some.domain"]
|
|
||||||
assert remote_data["AAAA"] == mockdns["AAAA"]["some.domain"]
|
|
||||||
assert remote_data["MTA_STS"] == mockdns["CNAME"]["mta-sts.some.domain"]
|
|
||||||
assert remote_data["WWW"] == mockdns["CNAME"]["www.some.domain"]
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("drop", ["A", "AAAA"])
|
|
||||||
def test_perform_initial_checks_with_one_of_A_AAAA(self, mockdns, drop):
|
|
||||||
del mockdns[drop]
|
|
||||||
remote_data = remote.rdns.perform_initial_checks("some.domain")
|
|
||||||
assert not remote_data[drop]
|
|
||||||
|
|
||||||
l = []
|
|
||||||
res = check_initial_remote_data(remote_data, print=l.append)
|
|
||||||
assert res
|
|
||||||
assert not l
|
|
||||||
|
|
||||||
def test_perform_initial_checks_no_mta_sts(self, mockdns):
|
|
||||||
del mockdns["CNAME"]["mta-sts.some.domain"]
|
|
||||||
remote_data = remote.rdns.perform_initial_checks("some.domain")
|
|
||||||
assert not remote_data["MTA_STS"]
|
|
||||||
|
|
||||||
l = []
|
|
||||||
res = check_initial_remote_data(remote_data, print=l.append)
|
|
||||||
assert not res
|
|
||||||
assert len(l) == 2
|
|
||||||
|
|
||||||
|
|
||||||
def parse_zonefile_into_dict(zonefile, mockdns_base, only_required=False):
|
|
||||||
for zf_line in zonefile.split("\n"):
|
|
||||||
if zf_line.startswith("#"):
|
|
||||||
if "Recommended" in zf_line and only_required:
|
|
||||||
return
|
|
||||||
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:
|
|
||||||
def logged(self, func, kwargs):
|
|
||||||
return func(**kwargs)
|
|
||||||
|
|
||||||
def call(self, func, kwargs):
|
|
||||||
return func(**kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class TestZonefileChecks:
|
|
||||||
def test_check_zonefile_all_ok(self, cm_data, mockdns_base):
|
|
||||||
zonefile = cm_data.get("zftest.zone")
|
|
||||||
parse_zonefile_into_dict(zonefile, mockdns_base)
|
|
||||||
required_diff, recommended_diff = remote.rdns.check_zonefile(
|
|
||||||
zonefile, "some.domain"
|
|
||||||
)
|
|
||||||
assert not required_diff and not recommended_diff
|
|
||||||
|
|
||||||
def test_check_zonefile_recommended_not_set(self, cm_data, mockdns_base):
|
|
||||||
zonefile = cm_data.get("zftest.zone")
|
|
||||||
zonefile_mocked = zonefile.split("; Recommended")[0]
|
|
||||||
parse_zonefile_into_dict(zonefile_mocked, mockdns_base)
|
|
||||||
required_diff, recommended_diff = remote.rdns.check_zonefile(
|
|
||||||
zonefile, "some.domain"
|
|
||||||
)
|
|
||||||
assert not required_diff
|
|
||||||
assert len(recommended_diff) == 8
|
|
||||||
|
|
||||||
def test_check_zonefile_output_required_fine(self, cm_data, mockdns_base, mockout):
|
|
||||||
zonefile = cm_data.get("zftest.zone")
|
|
||||||
zonefile_mocked = zonefile.split("; Recommended")[0]
|
|
||||||
parse_zonefile_into_dict(zonefile_mocked, mockdns_base, only_required=True)
|
|
||||||
mssh = MockSSHExec()
|
|
||||||
mockdns_base["mail_domain"] = "some.domain"
|
|
||||||
res = check_full_zone(mssh, mockdns_base, out=mockout, zonefile=zonefile)
|
|
||||||
assert res == 0
|
|
||||||
assert "WARNING" in mockout.captured_plain[0]
|
|
||||||
assert len(mockout.captured_plain) == 9
|
|
||||||
|
|
||||||
def test_check_zonefile_output_full(self, cm_data, mockdns_base, mockout):
|
|
||||||
zonefile = cm_data.get("zftest.zone")
|
|
||||||
parse_zonefile_into_dict(zonefile, mockdns_base)
|
|
||||||
mssh = MockSSHExec()
|
|
||||||
mockdns_base["mail_domain"] = "some.domain"
|
|
||||||
res = check_full_zone(mssh, mockdns_base, out=mockout, zonefile=zonefile)
|
|
||||||
assert res == 0
|
|
||||||
assert not mockout.captured_red
|
|
||||||
assert "correct" in mockout.captured_green[0]
|
|
||||||
assert not mockout.captured_red
|
|
||||||
@@ -3,10 +3,10 @@ requires = ["setuptools>=68"]
|
|||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "cmdeploy"
|
name = "deploy-chatmail"
|
||||||
version = "0.2"
|
version = "0.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"pyinfra>=3",
|
"pyinfra",
|
||||||
"pillow",
|
"pillow",
|
||||||
"qrcode",
|
"qrcode",
|
||||||
"markdown",
|
"markdown",
|
||||||
@@ -16,28 +16,16 @@ dependencies = [
|
|||||||
"build",
|
"build",
|
||||||
"tox",
|
"tox",
|
||||||
"ruff",
|
"ruff",
|
||||||
|
"black",
|
||||||
"pytest",
|
"pytest",
|
||||||
"pytest-xdist",
|
"pytest-xdist",
|
||||||
"execnet",
|
|
||||||
"imap_tools",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
cmdeploy = "cmdeploy.cmdeploy:main"
|
cmdeploy = "deploy_chatmail.cmdeploy:main"
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
"cmdeploy.testplugin" = "cmdeploy.tests.plugin"
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "-v -ra --strict-markers"
|
addopts = "-v -ra --strict-markers"
|
||||||
|
|
||||||
[tool.ruff]
|
|
||||||
lint.select = [
|
|
||||||
"F", # Pyflakes
|
|
||||||
"I", # isort
|
|
||||||
|
|
||||||
"PLC", # Pylint Convention
|
|
||||||
"PLE", # Pylint Error
|
|
||||||
"PLW", # Pylint Warning
|
|
||||||
]
|
|
||||||
@@ -1,22 +1,21 @@
|
|||||||
"""
|
"""
|
||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import importlib.resources
|
|
||||||
import io
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import sys
|
import sys
|
||||||
|
import importlib.resources
|
||||||
|
import subprocess
|
||||||
|
import shutil
|
||||||
|
import io
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from chatmaild.config import Config, read_config
|
from pyinfra import host
|
||||||
from pyinfra import host, facts
|
from pyinfra.operations import apt, files, server, systemd, pip
|
||||||
from pyinfra.facts.files import File
|
from pyinfra.facts.files import File
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from pyinfra.operations import apt, files, pip, server, systemd
|
|
||||||
|
|
||||||
from .acmetool import deploy_acmetool
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
|
from chatmaild.config import read_config, Config
|
||||||
|
|
||||||
|
|
||||||
def _build_chatmaild(dist_dir) -> None:
|
def _build_chatmaild(dist_dir) -> None:
|
||||||
dist_dir = Path(dist_dir).resolve()
|
dist_dir = Path(dist_dir).resolve()
|
||||||
@@ -85,35 +84,16 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"),
|
|
||||||
dest="/etc/cron.d/chatmail-metrics",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={
|
|
||||||
"mailboxes_dir": config.mailboxes_dir,
|
|
||||||
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
# install systemd units
|
# install systemd units
|
||||||
for fn in (
|
for fn in (
|
||||||
"doveauth",
|
"doveauth",
|
||||||
"filtermail",
|
"filtermail",
|
||||||
"echobot",
|
|
||||||
"chatmail-metadata",
|
|
||||||
"lastlogin",
|
|
||||||
):
|
):
|
||||||
params = dict(
|
params = dict(
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
config_path=remote_chatmail_inipath,
|
config_path=remote_chatmail_inipath,
|
||||||
remote_venv_dir=remote_venv_dir,
|
|
||||||
mail_domain=config.mail_domain,
|
|
||||||
)
|
|
||||||
source_path = importlib.resources.files(__package__).joinpath(
|
|
||||||
"service", f"{fn}.service.f"
|
|
||||||
)
|
)
|
||||||
|
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
||||||
content = source_path.read_text().format(**params).encode()
|
content = source_path.read_text().format(**params).encode()
|
||||||
|
|
||||||
files.put(
|
files.put(
|
||||||
@@ -132,7 +112,7 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
||||||
"""Configures OpenDKIM"""
|
"""Configures OpenDKIM"""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -146,24 +126,6 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
screen_script = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/screen.lua"),
|
|
||||||
dest="/etc/opendkim/screen.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= screen_script.changed
|
|
||||||
|
|
||||||
final_script = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/final.lua"),
|
|
||||||
dest="/etc/opendkim/final.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= final_script.changed
|
|
||||||
|
|
||||||
files.directory(
|
files.directory(
|
||||||
name="Add opendkim directory to /etc",
|
name="Add opendkim directory to /etc",
|
||||||
path="/etc/opendkim",
|
path="/etc/opendkim",
|
||||||
@@ -192,6 +154,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
)
|
)
|
||||||
need_restart |= signing_table.changed
|
need_restart |= signing_table.changed
|
||||||
|
|
||||||
files.directory(
|
files.directory(
|
||||||
name="Add opendkim socket directory to /var/spool/postfix",
|
name="Add opendkim socket directory to /var/spool/postfix",
|
||||||
path="/var/spool/postfix/opendkim",
|
path="/var/spool/postfix/opendkim",
|
||||||
@@ -201,11 +164,6 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
present=True,
|
present=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="apt install opendkim opendkim-tools",
|
|
||||||
packages=["opendkim", "opendkim-tools"],
|
|
||||||
)
|
|
||||||
|
|
||||||
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
||||||
server.shell(
|
server.shell(
|
||||||
name="Generate OpenDKIM domain keys",
|
name="Generate OpenDKIM domain keys",
|
||||||
@@ -237,7 +195,7 @@ def _install_mta_sts_daemon() -> bool:
|
|||||||
server.shell(
|
server.shell(
|
||||||
name="install postfix-mta-sts-resolver with pip",
|
name="install postfix-mta-sts-resolver with pip",
|
||||||
commands=[
|
commands=[
|
||||||
"python3 -m virtualenv /usr/local/lib/postfix-mta-sts-resolver",
|
"python3 -m venv /usr/local/lib/postfix-mta-sts-resolver",
|
||||||
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
@@ -268,7 +226,6 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config=config,
|
||||||
disable_ipv6=config.disable_ipv6,
|
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
@@ -283,31 +240,10 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= master_config.changed
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
header_cleanup = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"postfix/submission_header_cleanup"
|
|
||||||
),
|
|
||||||
dest="/etc/postfix/submission_header_cleanup",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= header_cleanup.changed
|
|
||||||
|
|
||||||
# Login map that 1:1 maps email address to login.
|
|
||||||
login_map = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("postfix/login_map"),
|
|
||||||
dest="/etc/postfix/login_map",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= login_map.changed
|
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
||||||
"""Configures Dovecot IMAP server."""
|
"""Configures Dovecot IMAP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -317,9 +253,8 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config={"hostname": mail_server},
|
||||||
debug=debug,
|
debug=debug,
|
||||||
disable_ipv6=config.disable_ipv6,
|
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
auth_config = files.put(
|
auth_config = files.put(
|
||||||
@@ -330,24 +265,15 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
need_restart |= auth_config.changed
|
need_restart |= auth_config.changed
|
||||||
lua_push_notification_script = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"dovecot/push_notification.lua"
|
|
||||||
),
|
|
||||||
dest="/etc/dovecot/push_notification.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= lua_push_notification_script.changed
|
|
||||||
|
|
||||||
files.template(
|
files.put(
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
src=importlib.resources.files(__package__)
|
||||||
|
.joinpath("dovecot/expunge.cron")
|
||||||
|
.open("rb"),
|
||||||
dest="/etc/cron.d/expunge",
|
dest="/etc/cron.d/expunge",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# as per https://doc.dovecot.org/configuration_manual/os/
|
# as per https://doc.dovecot.org/configuration_manual/os/
|
||||||
@@ -364,7 +290,7 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
||||||
"""Configures nginx HTTP server."""
|
"""Configures nginx HTTP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -374,8 +300,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config={"domain_name": config.mail_domain},
|
config={"domain_name": domain},
|
||||||
disable_ipv6=config.disable_ipv6,
|
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
@@ -385,7 +310,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config={"domain_name": config.mail_domain},
|
config={"domain_name": domain},
|
||||||
)
|
)
|
||||||
need_restart |= autoconfig.changed
|
need_restart |= autoconfig.changed
|
||||||
|
|
||||||
@@ -395,7 +320,7 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config={"domain_name": config.mail_domain},
|
config={"domain_name": domain},
|
||||||
)
|
)
|
||||||
need_restart |= mta_sts_config.changed
|
need_restart |= mta_sts_config.changed
|
||||||
|
|
||||||
@@ -421,216 +346,41 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _remove_rspamd() -> None:
|
|
||||||
"""Remove rspamd"""
|
|
||||||
apt.packages(name="Remove rspamd", packages="rspamd", present=False)
|
|
||||||
|
|
||||||
|
|
||||||
def check_config(config):
|
def check_config(config):
|
||||||
mail_domain = config.mail_domain
|
mailname = config.mailname
|
||||||
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
if mailname != "testrun.org" and not mailname.endswith(".testrun.org"):
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
for key in config.__dict__:
|
for value in config.__dict__.values():
|
||||||
value = config.__dict__[key]
|
if any(x in value for x in blocked_words):
|
||||||
if key.startswith("privacy") and any(
|
|
||||||
x in str(value) for x in blocked_words
|
|
||||||
):
|
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
)
|
)
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def deploy_mtail(config):
|
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
||||||
apt.packages(
|
|
||||||
name="Install mtail",
|
|
||||||
packages=["mtail"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`.
|
|
||||||
# This allows to read from journalctl instead of log files.
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("mtail/mtail.service.j2"),
|
|
||||||
dest="/etc/systemd/system/mtail.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
address=config.mtail_address or "127.0.0.1",
|
|
||||||
port=3903,
|
|
||||||
)
|
|
||||||
|
|
||||||
mtail_conf = files.put(
|
|
||||||
name="Mtail configuration",
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"mtail/delivered_mail.mtail"
|
|
||||||
),
|
|
||||||
dest="/etc/mtail/delivered_mail.mtail",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable mtail",
|
|
||||||
service="mtail.service",
|
|
||||||
running=bool(config.mtail_address),
|
|
||||||
enabled=bool(config.mtail_address),
|
|
||||||
restarted=mtail_conf.changed,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_iroh_relay(config) -> None:
|
|
||||||
(url, sha256sum) = {
|
|
||||||
"x86_64": (
|
|
||||||
"https://github.com/n0-computer/iroh/releases/download/v0.28.1/iroh-relay-v0.28.1-x86_64-unknown-linux-musl.tar.gz",
|
|
||||||
"2ffacf7c0622c26b67a5895ee8e07388769599f60e5f52a3bd40a3258db89b2c",
|
|
||||||
),
|
|
||||||
"aarch64": (
|
|
||||||
"https://github.com/n0-computer/iroh/releases/download/v0.28.1/iroh-relay-v0.28.1-aarch64-unknown-linux-musl.tar.gz",
|
|
||||||
"b915037bcc1ff1110cc9fcb5de4a17c00ff576fd2f568cd339b3b2d54c420dc4",
|
|
||||||
),
|
|
||||||
}[host.get_fact(facts.server.Arch)]
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install curl",
|
|
||||||
packages=["curl"],
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name="Download iroh-relay",
|
|
||||||
commands=[
|
|
||||||
f"(echo '{sha256sum} /usr/local/bin/iroh-relay' | sha256sum -c) || (curl -L {url} | gunzip | tar -x -f - ./iroh-relay -O >/usr/local/bin/iroh-relay.new && mv /usr/local/bin/iroh-relay.new /usr/local/bin/iroh-relay)",
|
|
||||||
"chmod 755 /usr/local/bin/iroh-relay",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
systemd_unit = files.put(
|
|
||||||
name="Upload iroh-relay systemd unit",
|
|
||||||
src=importlib.resources.files(__package__).joinpath("iroh-relay.service"),
|
|
||||||
dest="/etc/systemd/system/iroh-relay.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= systemd_unit.changed
|
|
||||||
|
|
||||||
iroh_config = files.put(
|
|
||||||
name=f"Upload iroh-relay config",
|
|
||||||
src=importlib.resources.files(__package__).joinpath("iroh-relay.toml"),
|
|
||||||
dest=f"/etc/iroh-relay.toml",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= iroh_config.changed
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable iroh-relay",
|
|
||||||
service="iroh-relay.service",
|
|
||||||
running=True,
|
|
||||||
enabled=config.enable_iroh_relay,
|
|
||||||
restarted=need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|
||||||
"""Deploy a chat-mail instance.
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
:param config_path: path to chatmail.ini
|
:param mail_domain: domain part of your future email addresses
|
||||||
:param disable_mail: whether to disable postfix & dovecot
|
:param mail_server: the DNS name under which your mail server is reachable
|
||||||
|
:param dkim_selector:
|
||||||
"""
|
"""
|
||||||
config = read_config(config_path)
|
|
||||||
check_config(config)
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
|
|
||||||
from .www import build_webpages
|
from .www import build_webpages
|
||||||
|
|
||||||
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
server.user(name="Create filtermail user", user="filtermail", system=True)
|
|
||||||
server.group(name="Create opendkim group", group="opendkim", system=True)
|
server.group(name="Create opendkim group", group="opendkim", system=True)
|
||||||
server.user(
|
|
||||||
name="Create opendkim user",
|
|
||||||
user="opendkim",
|
|
||||||
groups=["opendkim"],
|
|
||||||
system=True,
|
|
||||||
)
|
|
||||||
server.user(
|
server.user(
|
||||||
name="Add postfix user to opendkim group for socket access",
|
name="Add postfix user to opendkim group for socket access",
|
||||||
user="postfix",
|
user="postfix",
|
||||||
groups=["opendkim"],
|
groups=["opendkim"],
|
||||||
system=True,
|
system=True,
|
||||||
)
|
)
|
||||||
server.user(name="Create echobot user", user="echobot", system=True)
|
|
||||||
server.user(name="Create iroh user", user="iroh", system=True)
|
|
||||||
|
|
||||||
# Add our OBS repository for dovecot_no_delay
|
|
||||||
files.put(
|
|
||||||
name="Add Deltachat OBS GPG key to apt keyring",
|
|
||||||
src=importlib.resources.files(__package__).joinpath("obs-home-deltachat.gpg"),
|
|
||||||
dest="/etc/apt/keyrings/obs-home-deltachat.gpg",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.line(
|
|
||||||
name="Add DeltaChat OBS home repository to sources.list",
|
|
||||||
path="/etc/apt/sources.list",
|
|
||||||
line="deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./",
|
|
||||||
escape_regex_characters=True,
|
|
||||||
ensure_newline=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
|
||||||
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install rsync",
|
|
||||||
packages=["rsync"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Run local DNS resolver `unbound`.
|
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
|
||||||
# to use 127.0.0.1 as the resolver.
|
|
||||||
apt.packages(
|
|
||||||
name="Install unbound",
|
|
||||||
packages=["unbound", "unbound-anchor", "dnsutils"],
|
|
||||||
)
|
|
||||||
server.shell(
|
|
||||||
name="Generate root keys for validating DNSSEC",
|
|
||||||
commands=[
|
|
||||||
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
|
||||||
"systemctl reset-failed unbound.service",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable unbound",
|
|
||||||
service="unbound.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
deploy_iroh_relay(config)
|
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
# Deploy acmetool to have TLS certificates.
|
||||||
tls_domains = [
|
deploy_acmetool(nginx_hook=True, domains=[mail_server, f"mta-sts.{mail_server}"])
|
||||||
mail_domain,
|
|
||||||
f"mta-sts.{mail_domain}",
|
|
||||||
f"www.{mail_domain}",
|
|
||||||
f"mx.{mail_domain}",
|
|
||||||
]
|
|
||||||
deploy_acmetool(
|
|
||||||
domains=tls_domains,
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
# required for setfacl for echobot
|
|
||||||
name="Install acl",
|
|
||||||
packages="acl",
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Postfix",
|
name="Install Postfix",
|
||||||
@@ -642,9 +392,17 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install OpenDKIM",
|
||||||
|
packages=[
|
||||||
|
"opendkim",
|
||||||
|
"opendkim-tools",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install nginx",
|
name="Install nginx",
|
||||||
packages=["nginx", "libnginx-mod-stream"],
|
packages=["nginx"],
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
@@ -652,7 +410,11 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
packages=["fcgiwrap"],
|
packages=["fcgiwrap"],
|
||||||
)
|
)
|
||||||
|
|
||||||
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
pkg_root = importlib.resources.files(__package__)
|
||||||
|
chatmail_ini = pkg_root.joinpath("../../../chatmail.ini").resolve()
|
||||||
|
config = read_config(chatmail_ini)
|
||||||
|
check_config(config)
|
||||||
|
www_path = pkg_root.joinpath("../../../www").resolve()
|
||||||
|
|
||||||
build_dir = www_path.joinpath("build")
|
build_dir = www_path.joinpath("build")
|
||||||
src_dir = www_path.joinpath("src")
|
src_dir = www_path.joinpath("src")
|
||||||
@@ -661,13 +423,11 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
|
|
||||||
_install_remote_venv_with_chatmaild(config)
|
_install_remote_venv_with_chatmaild(config)
|
||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
||||||
postfix_need_restart = _configure_postfix(config, debug=debug)
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
|
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
||||||
mta_sts_need_restart = _install_mta_sts_daemon()
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
nginx_need_restart = _configure_nginx(config)
|
nginx_need_restart = _configure_nginx(mail_domain)
|
||||||
|
|
||||||
_remove_rspamd()
|
|
||||||
opendkim_need_restart = _configure_opendkim(mail_domain, "opendkim")
|
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable OpenDKIM",
|
name="Start and enable OpenDKIM",
|
||||||
@@ -686,23 +446,20 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
restarted=mta_sts_need_restart,
|
restarted=mta_sts_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Dovecot should be started before Postfix
|
|
||||||
# because it creates authentication socket
|
|
||||||
# required by Postfix.
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="disable dovecot for now" if disable_mail else "Start and enable Dovecot",
|
name="Start and enable Postfix",
|
||||||
service="dovecot.service",
|
service="postfix.service",
|
||||||
running=False if disable_mail else True,
|
running=True,
|
||||||
enabled=False if disable_mail else True,
|
enabled=True,
|
||||||
restarted=dovecot_need_restart if not disable_mail else False,
|
restarted=postfix_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="disable postfix for now" if disable_mail else "Start and enable Postfix",
|
name="Start and enable Dovecot",
|
||||||
service="postfix.service",
|
service="dovecot.service",
|
||||||
running=False if disable_mail else True,
|
running=True,
|
||||||
enabled=False if disable_mail else True,
|
enabled=True,
|
||||||
restarted=postfix_need_restart if not disable_mail else False,
|
restarted=dovecot_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
@@ -733,12 +490,5 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
service="systemd-journald.service",
|
service="systemd-journald.service",
|
||||||
running=True,
|
running=True,
|
||||||
enabled=True,
|
enabled=True,
|
||||||
restarted=journald_conf.changed,
|
restarted=journald_conf,
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Ensure cron is installed",
|
|
||||||
packages=["cron"],
|
|
||||||
)
|
|
||||||
|
|
||||||
deploy_mtail(config)
|
|
||||||
52
deploy-chatmail/src/deploy_chatmail/acmetool/__init__.py
Normal file
52
deploy-chatmail/src/deploy_chatmail/acmetool/__init__.py
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import importlib.resources
|
||||||
|
|
||||||
|
from pyinfra.operations import apt, files, server
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
||||||
|
"""Deploy acmetool."""
|
||||||
|
apt.packages(
|
||||||
|
name="Install acmetool",
|
||||||
|
packages=["acmetool"],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("acmetool.cron").open("rb"),
|
||||||
|
dest="/etc/cron.d/acmetool",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
|
if nginx_hook:
|
||||||
|
files.put(
|
||||||
|
src=importlib.resources.files(__package__)
|
||||||
|
.joinpath("acmetool.hook")
|
||||||
|
.open("rb"),
|
||||||
|
dest="/usr/lib/acme/hooks/nginx",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="744",
|
||||||
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("response-file.yaml.j2"),
|
||||||
|
dest="/var/lib/acme/conf/responses",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
email=email,
|
||||||
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
||||||
|
dest="/var/lib/acme/conf/target",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
|
commands=[f"acmetool want { ' '.join(domains)}"],
|
||||||
|
)
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
SHELL=/bin/sh
|
||||||
|
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin
|
||||||
|
MAILTO=root
|
||||||
|
20 16 * * * root /usr/bin/acmetool --batch reconcile
|
||||||
@@ -3,5 +3,3 @@ set -e
|
|||||||
EVENT_NAME="$1"
|
EVENT_NAME="$1"
|
||||||
[ "$EVENT_NAME" = "live-updated" ] || exit 42
|
[ "$EVENT_NAME" = "live-updated" ] || exit 42
|
||||||
systemctl restart nginx.service
|
systemctl restart nginx.service
|
||||||
systemctl reload dovecot.service
|
|
||||||
systemctl reload postfix.service
|
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
"acme-enter-email": "{{ email }}"
|
||||||
|
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.3-September-21-2022.pdf": true
|
||||||
12
deploy-chatmail/src/deploy_chatmail/chatmail.zone.f
Normal file
12
deploy-chatmail/src/deploy_chatmail/chatmail.zone.f
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
{chatmail_domain}. MX 10 {chatmail_domain}.
|
||||||
|
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
||||||
|
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
||||||
|
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
||||||
|
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
||||||
|
{chatmail_domain}. IN CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
||||||
|
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
||||||
|
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;adkim=r;aspf=r"
|
||||||
|
_mta-sts.{chatmail_domain}. IN TXT "v=STSv1; id={sts_id}"
|
||||||
|
mta-sts.{chatmail_domain}. IN CNAME {chatmail_domain}.
|
||||||
|
_smtp._tls.{chatmail_domain}. IN TXT "v=TLSRPTv1;rua=mailto:{email}"
|
||||||
|
{dkim_entry}
|
||||||
@@ -2,24 +2,20 @@
|
|||||||
Provides the `cmdeploy` entry point function,
|
Provides the `cmdeploy` entry point function,
|
||||||
along with command line option and subcommand parsing.
|
along with command line option and subcommand parsing.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
import datetime
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import importlib.util
|
import importlib.util
|
||||||
import os
|
import os
|
||||||
import pathlib
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import sys
|
import sys
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import pyinfra
|
|
||||||
from chatmaild.config import read_config, write_initial_config
|
|
||||||
from packaging import version
|
|
||||||
from termcolor import colored
|
|
||||||
|
|
||||||
from . import dns, remote
|
from termcolor import colored
|
||||||
from .sshexec import SSHExec
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# cmdeploy sub commands and options
|
# cmdeploy sub commands and options
|
||||||
@@ -36,13 +32,11 @@ def init_cmd_options(parser):
|
|||||||
|
|
||||||
def init_cmd(args, out):
|
def init_cmd(args, out):
|
||||||
"""Initialize chatmail config file."""
|
"""Initialize chatmail config file."""
|
||||||
mail_domain = args.chatmail_domain
|
|
||||||
if args.inipath.exists():
|
if args.inipath.exists():
|
||||||
print(f"Path exists, not modifying: {args.inipath}")
|
out.red(f"Path exists, not modifying: {args.inipath}")
|
||||||
return 1
|
raise SystemExit(1)
|
||||||
else:
|
write_initial_config(args.inipath, args.chatmail_domain)
|
||||||
write_initial_config(args.inipath, mail_domain, overrides={})
|
out.green(f"created config file for {args.chatmail_domain} in {args.inipath}")
|
||||||
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd_options(parser):
|
def run_cmd_options(parser):
|
||||||
@@ -52,112 +46,68 @@ def run_cmd_options(parser):
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="don't actually modify the server",
|
help="don't actually modify the server",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
|
||||||
"--disable-mail",
|
|
||||||
dest="disable_mail",
|
|
||||||
action="store_true",
|
|
||||||
help="install/upgrade the server, but disable postfix & dovecot for now"
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--ssh-host",
|
|
||||||
dest="ssh_host",
|
|
||||||
help="specify an SSH host to deploy to; uses mail_domain from chatmail.ini by default"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
|
||||||
sshexec = args.get_sshexec()
|
|
||||||
require_iroh = args.config.enable_iroh_relay
|
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
|
||||||
if not dns.check_initial_remote_data(remote_data, print=out.red):
|
|
||||||
return 1
|
|
||||||
|
|
||||||
env = os.environ.copy()
|
env = os.environ.copy()
|
||||||
env["CHATMAIL_INI"] = args.inipath
|
env["CHATMAIL_DOMAIN"] = args.config.mailname
|
||||||
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
deploypy = "deploy-chatmail/src/deploy_chatmail/deploy.py"
|
||||||
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
ssh_host = args.config.mail_domain if not args.ssh_host else args.ssh_host
|
cmd = f"{pyinf} --ssh-user root {args.config.mailname} {deploypy}"
|
||||||
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
out.check_call(cmd, env=env)
|
||||||
if version.parse(pyinfra.__version__) < version.parse("3"):
|
|
||||||
out.red("Please re-run scripts/initenv.sh to update pyinfra to version 3.")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
retcode = out.check_call(cmd, env=env)
|
|
||||||
if retcode == 0:
|
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
|
||||||
elif not remote_data["acme_account_url"]:
|
|
||||||
out.red("Deploy completed but letsencrypt not configured")
|
|
||||||
out.red("Run 'cmdeploy run' again")
|
|
||||||
retcode = 0
|
|
||||||
else:
|
|
||||||
out.red("Deploy failed")
|
|
||||||
return retcode
|
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--zonefile",
|
|
||||||
dest="zonefile",
|
|
||||||
type=pathlib.Path,
|
|
||||||
default=None,
|
|
||||||
help="write out a zonefile",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd(args, out):
|
def dns_cmd(args, out):
|
||||||
"""Check DNS entries and optionally generate dns zone file."""
|
"""Generate dns zone file."""
|
||||||
sshexec = args.get_sshexec()
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
ssh = f"ssh root@{args.config.mailname}"
|
||||||
if not remote_data:
|
|
||||||
return 1
|
|
||||||
|
|
||||||
if not remote_data["acme_account_url"]:
|
def read_dkim_entries(entry):
|
||||||
out.red("could not get letsencrypt account url, please run 'cmdeploy run'")
|
lines = []
|
||||||
return 1
|
for line in entry.split("\n"):
|
||||||
|
if line.startswith(";") or not line.strip():
|
||||||
|
continue
|
||||||
|
line = line.replace("\t", " ")
|
||||||
|
lines.append(line)
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
if not remote_data["dkim_entry"]:
|
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
||||||
out.red("could not determine dkim_entry, please run 'cmdeploy run'")
|
dkim_entry = read_dkim_entries(out.shell_output(f"{ssh} -- opendkim-genzone -F"))
|
||||||
return 1
|
|
||||||
|
|
||||||
zonefile = dns.get_filled_zone_file(remote_data)
|
out(
|
||||||
|
f"[writing {args.config.mailname} zone data (using space as separator) to stdout output]",
|
||||||
if args.zonefile:
|
green=True,
|
||||||
args.zonefile.write_text(zonefile)
|
)
|
||||||
out.green(f"DNS records successfully written to: {args.zonefile}")
|
print(
|
||||||
return 0
|
template.read_text()
|
||||||
|
.format(
|
||||||
retcode = dns.check_full_zone(
|
acme_account_url=acme_account_url,
|
||||||
sshexec, remote_data=remote_data, zonefile=zonefile, out=out
|
email=f"root@{args.config.mailname}",
|
||||||
|
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
||||||
|
chatmail_domain=args.config.mailname,
|
||||||
|
dkim_entry=dkim_entry,
|
||||||
|
)
|
||||||
|
.strip()
|
||||||
)
|
)
|
||||||
return retcode
|
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
def status_cmd(args, out):
|
||||||
"""Display status for online chatmail instance."""
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
sshexec = args.get_sshexec()
|
ssh = f"ssh root@{args.config.mailname}"
|
||||||
|
|
||||||
out.green(f"chatmail domain: {args.config.mail_domain}")
|
out.green(f"chatmail domain: {args.config.mailname}")
|
||||||
if args.config.privacy_mail:
|
if args.config.privacy_mail:
|
||||||
out.green("privacy settings: present")
|
out.green("privacy settings: present")
|
||||||
else:
|
else:
|
||||||
out.red("no privacy settings")
|
out.red("no privacy settings")
|
||||||
|
|
||||||
for line in sshexec(remote.rshell.get_systemd_running):
|
s1 = "systemctl --type=service --state=running"
|
||||||
print(line)
|
for line in out.shell_output(f"{ssh} -- {s1}").split("\n"):
|
||||||
|
if line.startswith(" "):
|
||||||
|
print(line)
|
||||||
def test_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--slow",
|
|
||||||
dest="slow",
|
|
||||||
action="store_true",
|
|
||||||
help="also run slow tests",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cmd(args, out):
|
def test_cmd(args, out):
|
||||||
@@ -171,22 +121,21 @@ def test_cmd(args, out):
|
|||||||
out.check_call(f"{sys.executable} -m pip install deltachat")
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
pytest_path = shutil.which("pytest")
|
pytest_path = shutil.which("pytest")
|
||||||
pytest_args = [
|
ret = out.run_ret(
|
||||||
pytest_path,
|
[pytest_path, "tests/", "-n4", "-rs", "-x", "-vrx", "--durations=5"]
|
||||||
"cmdeploy/src/",
|
)
|
||||||
"-n4",
|
|
||||||
"-rs",
|
|
||||||
"-x",
|
|
||||||
"-v",
|
|
||||||
"--durations=5",
|
|
||||||
]
|
|
||||||
if args.slow:
|
|
||||||
pytest_args.append("--slow")
|
|
||||||
ret = out.run_ret(pytest_args)
|
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
|
|
||||||
def fmt_cmd_options(parser):
|
def fmt_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--verbose",
|
||||||
|
"-v",
|
||||||
|
dest="verbose",
|
||||||
|
action="store_true",
|
||||||
|
help="provide information on invocations",
|
||||||
|
)
|
||||||
|
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--check",
|
"--check",
|
||||||
"-c",
|
"-c",
|
||||||
@@ -196,34 +145,38 @@ def fmt_cmd_options(parser):
|
|||||||
|
|
||||||
|
|
||||||
def fmt_cmd(args, out):
|
def fmt_cmd(args, out):
|
||||||
"""Run formattting fixes on all chatmail source code."""
|
"""Run formattting fixes (fuff and black) on all chatmail source code."""
|
||||||
|
|
||||||
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
chatmaild = importlib.resources.files("chatmaild")
|
||||||
format_args = [shutil.which("ruff"), "format"]
|
deploy_chatmail = importlib.resources.files("deploy_chatmail")
|
||||||
check_args = [shutil.which("ruff"), "check"]
|
tests = deploy_chatmail.joinpath("../../../tests")
|
||||||
|
sources = list(str(x) for x in [chatmaild, deploy_chatmail, tests])
|
||||||
|
|
||||||
|
black_args = [shutil.which("black")]
|
||||||
|
ruff_args = [shutil.which("ruff")]
|
||||||
|
|
||||||
if args.check:
|
if args.check:
|
||||||
format_args.append("--diff")
|
black_args.append("--check")
|
||||||
else:
|
else:
|
||||||
check_args.append("--fix")
|
ruff_args.append("--fix")
|
||||||
|
|
||||||
if not args.verbose:
|
if not args.verbose:
|
||||||
check_args.append("--quiet")
|
black_args.append("-q")
|
||||||
format_args.append("--quiet")
|
ruff_args.append("-q")
|
||||||
|
|
||||||
format_args.extend(sources)
|
black_args.extend(sources)
|
||||||
check_args.extend(sources)
|
ruff_args.extend(sources)
|
||||||
|
|
||||||
out.check_call(" ".join(format_args), quiet=not args.verbose)
|
out.check_call(" ".join(black_args), quiet=not args.verbose)
|
||||||
out.check_call(" ".join(check_args), quiet=not args.verbose)
|
out.check_call(" ".join(ruff_args), quiet=not args.verbose)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
def bench_cmd(args, out):
|
def bench_cmd(args, out):
|
||||||
"""Run benchmarks against an online chatmail instance."""
|
"""Run benchmarks against an online chatmail instance."""
|
||||||
args = ["pytest", "--pyargs", "cmdeploy.tests.online.benchmark", "-vrx"]
|
pytest_path = shutil.which("pytest")
|
||||||
cmdstring = " ".join(args)
|
benchmark = "tests/online/benchmark.py"
|
||||||
out.green(f"[$ {cmdstring}]")
|
subprocess.check_call([pytest_path, benchmark, "-vrx"])
|
||||||
subprocess.check_call(args)
|
|
||||||
|
|
||||||
|
|
||||||
def webdev_cmd(args, out):
|
def webdev_cmd(args, out):
|
||||||
@@ -251,6 +204,10 @@ class Out:
|
|||||||
color = "red" if red else ("green" if green else None)
|
color = "red" if red else ("green" if green else None)
|
||||||
print(colored(msg, color), file=file)
|
print(colored(msg, color), file=file)
|
||||||
|
|
||||||
|
def shell_output(self, arg):
|
||||||
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
|
return subprocess.check_output(arg, shell=True).decode()
|
||||||
|
|
||||||
def check_call(self, arg, env=None, quiet=False):
|
def check_call(self, arg, env=None, quiet=False):
|
||||||
if not quiet:
|
if not quiet:
|
||||||
self(f"[$ {arg}]", file=sys.stderr)
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
@@ -260,7 +217,7 @@ class Out:
|
|||||||
if not quiet:
|
if not quiet:
|
||||||
cmdstring = " ".join(args)
|
cmdstring = " ".join(args)
|
||||||
self(f"[$ {cmdstring}]", file=sys.stderr)
|
self(f"[$ {cmdstring}]", file=sys.stderr)
|
||||||
proc = subprocess.run(args, env=env, check=False)
|
proc = subprocess.run(args, env=env)
|
||||||
return proc.returncode
|
return proc.returncode
|
||||||
|
|
||||||
|
|
||||||
@@ -273,14 +230,6 @@ def add_config_option(parser):
|
|||||||
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):
|
def add_subcommand(subparsers, func):
|
||||||
@@ -320,18 +269,11 @@ def get_parser():
|
|||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
def main(args=None):
|
||||||
"""Provide main entry point for 'cmdeploy' CLI invocation."""
|
"""Provide main entry point for 'xdcget' CLI invocation."""
|
||||||
parser = get_parser()
|
parser = get_parser()
|
||||||
args = parser.parse_args(args=args)
|
args = parser.parse_args(args=args)
|
||||||
if not hasattr(args, "func"):
|
if not hasattr(args, "func"):
|
||||||
return parser.parse_args(["-h"])
|
return parser.parse_args(["-h"])
|
||||||
|
|
||||||
def get_sshexec():
|
|
||||||
print(f"[ssh] login to {args.config.mail_domain}")
|
|
||||||
return SSHExec(args.config.mail_domain, verbose=args.verbose)
|
|
||||||
|
|
||||||
args.get_sshexec = get_sshexec
|
|
||||||
|
|
||||||
out = Out()
|
out = Out()
|
||||||
kwargs = {}
|
kwargs = {}
|
||||||
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
||||||
@@ -349,6 +291,7 @@ def main(args=None):
|
|||||||
if res is None:
|
if res is None:
|
||||||
res = 0
|
res = 0
|
||||||
return res
|
return res
|
||||||
|
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
out.red("KeyboardInterrupt")
|
out.red("KeyboardInterrupt")
|
||||||
sys.exit(130)
|
sys.exit(130)
|
||||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
19
deploy-chatmail/src/deploy_chatmail/deploy.py
Normal file
19
deploy-chatmail/src/deploy_chatmail/deploy.py
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
import os
|
||||||
|
import pyinfra
|
||||||
|
from deploy_chatmail import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
mail_domain = os.getenv("CHATMAIL_DOMAIN")
|
||||||
|
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
|
||||||
|
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "dkim")
|
||||||
|
|
||||||
|
assert mail_domain
|
||||||
|
assert mail_server
|
||||||
|
assert dkim_selector
|
||||||
|
|
||||||
|
deploy_chatmail(mail_domain, mail_server, dkim_selector)
|
||||||
|
|
||||||
|
|
||||||
|
if pyinfra.is_cli:
|
||||||
|
main()
|
||||||
5
deploy-chatmail/src/deploy_chatmail/dovecot/auth.conf
Normal file
5
deploy-chatmail/src/deploy_chatmail/dovecot/auth.conf
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
uri = proxy:/run/dovecot/doveauth.socket:auth
|
||||||
|
iterate_disable = yes
|
||||||
|
default_pass_scheme = plain
|
||||||
|
password_key = passdb/%w/%u
|
||||||
|
user_key = userdb/%u
|
||||||
144
deploy-chatmail/src/deploy_chatmail/dovecot/dovecot.conf.j2
Normal file
144
deploy-chatmail/src/deploy_chatmail/dovecot/dovecot.conf.j2
Normal file
@@ -0,0 +1,144 @@
|
|||||||
|
## Dovecot configuration file
|
||||||
|
|
||||||
|
protocols = imap lmtp
|
||||||
|
|
||||||
|
auth_mechanisms = plain
|
||||||
|
|
||||||
|
{% if debug == true %}
|
||||||
|
auth_verbose = yes
|
||||||
|
auth_debug = yes
|
||||||
|
auth_debug_passwords = yes
|
||||||
|
auth_verbose_passwords = plain
|
||||||
|
auth_cache_size = 100M
|
||||||
|
mail_debug = yes
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
|
mail_plugins = quota
|
||||||
|
|
||||||
|
# these are the capabilities Delta Chat cares about actually
|
||||||
|
# so let's keep the network overhead per login small
|
||||||
|
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
||||||
|
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY
|
||||||
|
|
||||||
|
|
||||||
|
# Authentication for system users.
|
||||||
|
passdb {
|
||||||
|
driver = dict
|
||||||
|
args = /etc/dovecot/auth.conf
|
||||||
|
}
|
||||||
|
userdb {
|
||||||
|
driver = dict
|
||||||
|
args = /etc/dovecot/auth.conf
|
||||||
|
}
|
||||||
|
##
|
||||||
|
## Mailbox locations and namespaces
|
||||||
|
##
|
||||||
|
|
||||||
|
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
||||||
|
mail_location = maildir:/home/vmail/mail/%d/%u
|
||||||
|
|
||||||
|
namespace inbox {
|
||||||
|
inbox = yes
|
||||||
|
|
||||||
|
mailbox Drafts {
|
||||||
|
special_use = \Drafts
|
||||||
|
}
|
||||||
|
mailbox Junk {
|
||||||
|
special_use = \Junk
|
||||||
|
}
|
||||||
|
mailbox Trash {
|
||||||
|
special_use = \Trash
|
||||||
|
}
|
||||||
|
|
||||||
|
# For \Sent mailboxes there are two widely used names. We'll mark both of
|
||||||
|
# them as \Sent. User typically deletes one of them if duplicates are created.
|
||||||
|
mailbox Sent {
|
||||||
|
special_use = \Sent
|
||||||
|
}
|
||||||
|
mailbox "Sent Messages" {
|
||||||
|
special_use = \Sent
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mail_uid = vmail
|
||||||
|
mail_gid = vmail
|
||||||
|
mail_privileged_group = vmail
|
||||||
|
|
||||||
|
##
|
||||||
|
## Mail processes
|
||||||
|
##
|
||||||
|
|
||||||
|
# Enable IMAP COMPRESS (RFC 4978).
|
||||||
|
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
||||||
|
protocol imap {
|
||||||
|
mail_plugins = $mail_plugins imap_zlib imap_quota
|
||||||
|
}
|
||||||
|
|
||||||
|
protocol lmtp {
|
||||||
|
mail_plugins = $mail_plugins quota
|
||||||
|
}
|
||||||
|
|
||||||
|
plugin {
|
||||||
|
imap_compress_deflate_level = 6
|
||||||
|
}
|
||||||
|
|
||||||
|
plugin {
|
||||||
|
# for now we define static quota-rules for all users
|
||||||
|
quota = maildir:User quota
|
||||||
|
quota_rule = *:storage=100M
|
||||||
|
quota_max_mail_size=30M
|
||||||
|
quota_grace = 0
|
||||||
|
# quota_over_flag_value = TRUE
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
service lmtp {
|
||||||
|
user=vmail
|
||||||
|
|
||||||
|
unix_listener /var/spool/postfix/private/dovecot-lmtp {
|
||||||
|
group = postfix
|
||||||
|
mode = 0600
|
||||||
|
user = postfix
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
service auth {
|
||||||
|
unix_listener /var/spool/postfix/private/auth {
|
||||||
|
mode = 0660
|
||||||
|
user = postfix
|
||||||
|
group = postfix
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
service auth-worker {
|
||||||
|
# Default is root.
|
||||||
|
# Drop privileges we don't need.
|
||||||
|
user = vmail
|
||||||
|
}
|
||||||
|
|
||||||
|
service imap-login {
|
||||||
|
# High-security mode.
|
||||||
|
# Each process serves a single connection and exits afterwards.
|
||||||
|
# This is the default, but we set it explicitly to be sure.
|
||||||
|
# See <https://doc.dovecot.org/admin_manual/login_processes/#high-security-mode> for details.
|
||||||
|
service_count = 1
|
||||||
|
|
||||||
|
# Inrease the number of simultaneous connections.
|
||||||
|
#
|
||||||
|
# As of Dovecot 2.3.19.1 the default is 100 processes.
|
||||||
|
# Combined with `service_count = 1` it means only 100 connections
|
||||||
|
# can be handled simultaneously.
|
||||||
|
process_limit = 10000
|
||||||
|
|
||||||
|
# Avoid startup latency for new connections.
|
||||||
|
process_min_avail = 10
|
||||||
|
}
|
||||||
|
|
||||||
|
ssl = required
|
||||||
|
ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain
|
||||||
|
ssl_key = </var/lib/acme/live/{{ config.hostname }}/privkey
|
||||||
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
|
ssl_min_protocol = TLSv1.2
|
||||||
|
ssl_prefer_server_ciphers = yes
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user