mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 00:14:36 +00:00
Compare commits
1 Commits
postfix-lo
...
link2xt/do
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d96c9221c4 |
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,32 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Report something that isn't working.
|
|
||||||
title: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Please fill out as much of this form as you can (leaving out stuff that is not applicable is ok).
|
|
||||||
-->
|
|
||||||
|
|
||||||
- Server OS (Operating System) - preferably Debian 12:
|
|
||||||
- On which OS you run cmdeploy:
|
|
||||||
|
|
||||||
## Expected behavior
|
|
||||||
|
|
||||||
*What did you try to achieve?*
|
|
||||||
|
|
||||||
## Actual behavior
|
|
||||||
|
|
||||||
*What happened instead?*
|
|
||||||
|
|
||||||
### Steps to reproduce the problem:
|
|
||||||
|
|
||||||
1.
|
|
||||||
2.
|
|
||||||
|
|
||||||
### Screenshots
|
|
||||||
|
|
||||||
### Logs
|
|
||||||
|
|
||||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
5
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,5 +0,0 @@
|
|||||||
blank_issues_enabled: true
|
|
||||||
contact_links:
|
|
||||||
- name: Mutual Help Chat Group
|
|
||||||
url: https://i.delta.chat/#C2846EB4C1CB8DF84B1818F5E3A638FC3FBDC981&a=stalebot1%40nine.testrun.org&g=Chatmail%20Mutual%20Help&x=7sFF7Ik50pWv6J1z7RVC5527&i=d7s1HvOsk5UrSf9AoqRZggg4&s=XmX_9BAW6-g5Ao5E8PyaeKNB
|
|
||||||
about: If you have troubles setting up the relay server, feel free to ask here.
|
|
||||||
18
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
18
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
@@ -38,9 +38,7 @@ jobs:
|
|||||||
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 [ -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
|
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
|
# make sure CAA record isn't set
|
||||||
scp -o StrictHostKeyChecking=accept-new .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 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
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
- name: rebuild staging-ipv4.testrun.org to have a clean VPS
|
- name: rebuild staging-ipv4.testrun.org to have a clean VPS
|
||||||
@@ -49,7 +47,7 @@ jobs:
|
|||||||
-H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
-H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"image":"debian-12"}' \
|
-d '{"image":"debian-12"}' \
|
||||||
"https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_IPV4_SERVER_ID }}/actions/rebuild"
|
"https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_SERVER_ID }}/actions/rebuild"
|
||||||
|
|
||||||
- run: scripts/initenv.sh
|
- run: scripts/initenv.sh
|
||||||
|
|
||||||
@@ -63,11 +61,11 @@ jobs:
|
|||||||
while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org id -u ; do sleep 1 ; done
|
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
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org id -u
|
||||||
# download acme & dkim state from ns.testrun.org
|
# download acme & dkim state from ns.testrun.org
|
||||||
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme-ipv4/acme acme-restore || true
|
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 dkimkeys-restore || true
|
rsync -avz root@ns.testrun.org:/tmp/dkimkeys-ipv4 dkimkeys-restore || true
|
||||||
# restore acme & dkim state to staging2.testrun.org
|
# restore acme & dkim state to staging2.testrun.org
|
||||||
rsync -avz acme-restore/acme root@staging-ipv4.testrun.org:/var/lib/ || true
|
rsync -avz acme-restore/acme-ipv4/acme root@staging-ipv4.testrun.org:/var/lib/acme || true
|
||||||
rsync -avz dkimkeys-restore/dkimkeys root@staging-ipv4.testrun.org:/etc/ || true
|
rsync -avz dkimkeys-restore/dkimkeys-ipv4/dkimkeys root@staging-ipv4.testrun.org:/etc/dkimkeys || true
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
- name: run formatting checks
|
- name: run formatting checks
|
||||||
@@ -95,6 +93,6 @@ jobs:
|
|||||||
- name: cmdeploy test
|
- name: cmdeploy test
|
||||||
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
- name: cmdeploy dns
|
- name: cmdeploy dns (try 3 times)
|
||||||
run: cmdeploy dns -v
|
run: cmdeploy dns || cmdeploy dns || cmdeploy dns
|
||||||
|
|
||||||
|
|||||||
12
.github/workflows/test-and-deploy.yaml
vendored
12
.github/workflows/test-and-deploy.yaml
vendored
@@ -38,9 +38,7 @@ jobs:
|
|||||||
if [ -f dkimkeys/opendkim.private ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" dkimkeys root@ns.testrun.org:/tmp/ || true; fi
|
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
|
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
|
# 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 -o StrictHostKeyChecking=accept-new root@ns.testrun.org sed -i '/CAA/d' /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
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
- name: rebuild staging2.testrun.org to have a clean VPS
|
- name: rebuild staging2.testrun.org to have a clean VPS
|
||||||
@@ -66,8 +64,8 @@ jobs:
|
|||||||
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme acme-restore || true
|
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
|
rsync -avz root@ns.testrun.org:/tmp/dkimkeys dkimkeys-restore || true
|
||||||
# restore acme & dkim state to staging2.testrun.org
|
# restore acme & dkim state to staging2.testrun.org
|
||||||
rsync -avz acme-restore/acme root@staging2.testrun.org:/var/lib/ || true
|
rsync -avz acme-restore/acme/ root@staging2.testrun.org:/var/lib/acme || true
|
||||||
rsync -avz dkimkeys-restore/dkimkeys root@staging2.testrun.org:/etc/ || true
|
rsync -avz dkimkeys-restore/dkimkeys/ root@staging2.testrun.org:/etc/dkimkeys || true
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org chown root:root -R /var/lib/acme || true
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
- name: run formatting checks
|
- name: run formatting checks
|
||||||
@@ -93,6 +91,6 @@ jobs:
|
|||||||
- name: cmdeploy test
|
- name: cmdeploy test
|
||||||
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
- name: cmdeploy dns
|
- name: cmdeploy dns (try 3 times)
|
||||||
run: cmdeploy dns -v
|
run: cmdeploy dns -v || cmdeploy dns -v || cmdeploy dns -v
|
||||||
|
|
||||||
|
|||||||
247
CHANGELOG.md
247
CHANGELOG.md
@@ -2,307 +2,184 @@
|
|||||||
|
|
||||||
## untagged
|
## untagged
|
||||||
|
|
||||||
- Avoid "acmetool not found" during initial run
|
|
||||||
([#550](https://github.com/chatmail/relay/pull/550))
|
|
||||||
|
|
||||||
- Enforce end-to-end encryption for incoming messages.
|
|
||||||
New user address mailboxes now get a `enforceE2EEincoming` file
|
|
||||||
which prohibits incoming cleartext messages from other domains.
|
|
||||||
An outside MTA trying to submit a cleartext message will
|
|
||||||
get a "523 Encryption Needed" response, see RFC5248.
|
|
||||||
If the file does not exist (as it the case for all existing accounts)
|
|
||||||
incoming cleartext messages are accepted.
|
|
||||||
([#538](https://github.com/chatmail/server/pull/538))
|
|
||||||
|
|
||||||
- Enforce end-to-end encryption between local addresses
|
|
||||||
([#535](https://github.com/chatmail/server/pull/535))
|
|
||||||
|
|
||||||
- Limit the bind for the HTTPS server on 8443 to 127.0.0.1
|
|
||||||
([#522](https://github.com/chatmail/server/pull/522))
|
|
||||||
([#532](https://github.com/chatmail/server/pull/532))
|
|
||||||
|
|
||||||
- Send SNI when connecting to outside servers
|
|
||||||
([#524](https://github.com/chatmail/server/pull/524))
|
|
||||||
|
|
||||||
- postfix master.cf: use 127.0.0.1 for consistency
|
|
||||||
([#544](https://github.com/chatmail/relay/pull/544))
|
|
||||||
|
|
||||||
- Pass through `original_content` instead of `content` in filtermail
|
|
||||||
([#509](https://github.com/chatmail/server/pull/509))
|
|
||||||
|
|
||||||
- Document TLS requirements in the readme
|
|
||||||
([#514](https://github.com/chatmail/server/pull/514))
|
|
||||||
|
|
||||||
- Remove cleanup service from submission ports
|
|
||||||
([#512](https://github.com/chatmail/server/pull/512))
|
|
||||||
|
|
||||||
- cmdeploy dovecot: delete big messages after 7 days
|
|
||||||
([#504](https://github.com/chatmail/server/pull/504))
|
|
||||||
|
|
||||||
- mtail: fix getting logs from STDIN
|
|
||||||
([#502](https://github.com/chatmail/server/pull/502))
|
|
||||||
|
|
||||||
- filtermail: don't require exactly 2 lines after openPGP payload
|
|
||||||
([#497](https://github.com/chatmail/server/pull/497))
|
|
||||||
|
|
||||||
- cmdeploy dns: offer alternative DKIM record format for some web interfaces
|
|
||||||
([#470](https://github.com/chatmail/server/pull/470))
|
|
||||||
|
|
||||||
- journald: remove old logs from disk
|
|
||||||
([#490](https://github.com/chatmail/server/pull/490))
|
|
||||||
|
|
||||||
- opendkim: restart once every day to mend RAM leaks
|
|
||||||
([#498](https://github.com/chatmail/server/pull/498)
|
|
||||||
|
|
||||||
- migration guide: let opendkim own the DKIM keys directory
|
|
||||||
([#468](https://github.com/chatmail/server/pull/468))
|
|
||||||
|
|
||||||
- improve secure-join message detection
|
|
||||||
([#473](https://github.com/chatmail/server/pull/473))
|
|
||||||
|
|
||||||
- use old crypt lib in python < 3.11
|
|
||||||
([#483](https://github.com/chatmail/server/pull/483))
|
|
||||||
|
|
||||||
- chatmaild: set umask to 0700 for doveauth + metadata
|
|
||||||
([#490](https://github.com/chatmail/server/pull/492))
|
|
||||||
|
|
||||||
- remove MTA-STS daemon
|
|
||||||
([#488](https://github.com/chatmail/server/pull/488))
|
|
||||||
|
|
||||||
- replace `Subject` with `[...]` for all outgoing mails.
|
|
||||||
([#481](https://github.com/chatmail/server/pull/481))
|
|
||||||
|
|
||||||
- opendkim: use su instead of sudo
|
|
||||||
([#491](https://github.com/chatmail/server/pull/491))
|
|
||||||
|
|
||||||
## 1.5.0 2024-12-20
|
|
||||||
|
|
||||||
- cmdeploy dns: always show recommended DNS records
|
|
||||||
([#463](https://github.com/chatmail/server/pull/463))
|
|
||||||
|
|
||||||
- add `--all` to `cmdeploy dns`
|
|
||||||
([#462](https://github.com/chatmail/server/pull/462))
|
|
||||||
|
|
||||||
- fix `_mta-sts` TXT DNS record
|
|
||||||
([#461](https://github.com/chatmail/server/pull/461)
|
|
||||||
|
|
||||||
- deploy `iroh-relay` and also update "realtime relay services" in privacy policy.
|
|
||||||
([#434](https://github.com/chatmail/server/pull/434))
|
|
||||||
([#451](https://github.com/chatmail/server/pull/451))
|
|
||||||
|
|
||||||
- add guide to migrate chatmail to a new server
|
|
||||||
([#429](https://github.com/chatmail/server/pull/429))
|
|
||||||
|
|
||||||
- disable anvil authentication penalty
|
|
||||||
([#414](https://github.com/chatmail/server/pull/444)
|
|
||||||
|
|
||||||
- increase `request_queue_size` for UNIX sockets to 1000.
|
|
||||||
([#437](https://github.com/chatmail/server/pull/437))
|
|
||||||
|
|
||||||
- add argument to `cmdeploy run` for specifying
|
|
||||||
a different SSH host than `mail_domain`
|
|
||||||
([#439](https://github.com/chatmail/server/pull/439))
|
|
||||||
|
|
||||||
- query autoritative nameserver to bypass DNS cache
|
|
||||||
([#424](https://github.com/chatmail/server/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/chatmail/server/pull/388))
|
|
||||||
|
|
||||||
- fix checking for required DNS records
|
- fix checking for required DNS records
|
||||||
([#412](https://github.com/chatmail/server/pull/412))
|
([#412](https://github.com/deltachat/chatmail/pull/412))
|
||||||
|
|
||||||
- add support for specifying whole domains for recipient passthrough list
|
|
||||||
([#408](https://github.com/chatmail/server/pull/408))
|
|
||||||
|
|
||||||
- add a paragraph about "account deletion" to info page
|
- add a paragraph about "account deletion" to info page
|
||||||
([#405](https://github.com/chatmail/server/pull/405))
|
([#405](https://github.com/deltachat/chatmail/pull/405))
|
||||||
|
|
||||||
- avoid nginx listening on ipv6 if v6 is dsiabled
|
- avoid nginx listening on ipv6 if v6 is dsiabled
|
||||||
([#402](https://github.com/chatmail/server/pull/402))
|
([#402](https://github.com/deltachat/chatmail/pull/402))
|
||||||
|
|
||||||
- refactor ssh-based execution to allow organizing remote functions in
|
- refactor ssh-based execution to allow organizing remote functions in
|
||||||
modules.
|
modules.
|
||||||
([#396](https://github.com/chatmail/server/pull/396))
|
([#396](https://github.com/deltachat/chatmail/pull/396))
|
||||||
|
|
||||||
- trigger "apt upgrade" during "cmdeploy run"
|
- trigger "apt upgrade" during "cmdeploy run"
|
||||||
([#398](https://github.com/chatmail/server/pull/398))
|
([#398](https://github.com/deltachat/chatmail/pull/398))
|
||||||
|
|
||||||
- drop hispanilandia passthrough address
|
- drop hispanilandia passthrough address
|
||||||
([#401](https://github.com/chatmail/server/pull/401))
|
([#401](https://github.com/deltachat/chatmail/pull/401))
|
||||||
|
|
||||||
- set CAA record flags to 0
|
- set CAA record flags to 0
|
||||||
|
|
||||||
- add IMAP capabilities instead of overwriting them
|
- add IMAP capabilities instead of overwriting them
|
||||||
([#413](https://github.com/chatmail/server/pull/413))
|
([#413](https://github.com/deltachat/chatmail/pull/413))
|
||||||
|
|
||||||
- fix OpenPGP payload check
|
|
||||||
([#435](https://github.com/chatmail/server/pull/435))
|
|
||||||
|
|
||||||
- fix Dovecot quota_max_mail_size to use max_message_size config value
|
|
||||||
([#438](https://github.com/chatmail/server/pull/438))
|
|
||||||
|
|
||||||
|
|
||||||
## 1.4.1 2024-07-31
|
## 1.4.1 2024-07-31
|
||||||
|
|
||||||
- fix metadata dictproxy which would confuse transactions
|
- fix metadata dictproxy which would confuse transactions
|
||||||
resulting in missed notifications and other issues.
|
resulting in missed notifications and other issues.
|
||||||
([#393](https://github.com/chatmail/server/pull/393))
|
([#393](https://github.com/deltachat/chatmail/pull/393))
|
||||||
([#394](https://github.com/chatmail/server/pull/394))
|
([#394](https://github.com/deltachat/chatmail/pull/394))
|
||||||
|
|
||||||
- add optional "imap_rawlog" config option. If true,
|
- add optional "imap_rawlog" config option. If true,
|
||||||
.in/.out files are created in user home dirs
|
.in/.out files are created in user home dirs
|
||||||
containing the imap protocol messages.
|
containing the imap protocol messages.
|
||||||
([#389](https://github.com/chatmail/server/pull/389))
|
([#389](https://github.com/deltachat/chatmail/pull/389))
|
||||||
|
|
||||||
## 1.4.0 2024-07-28
|
## 1.4.0 2024-07-28
|
||||||
|
|
||||||
- Add `disable_ipv6` config option to chatmail.ini.
|
- Add `disable_ipv6` config option to chatmail.ini.
|
||||||
Required if the server doesn't have IPv6 connectivity.
|
Required if the server doesn't have IPv6 connectivity.
|
||||||
([#312](https://github.com/chatmail/server/pull/312))
|
([#312](https://github.com/deltachat/chatmail/pull/312))
|
||||||
|
|
||||||
- allow current K9/Thunderbird-mail releases to send encrypted messages
|
- allow current K9/Thunderbird-mail releases to send encrypted messages
|
||||||
outside by accepting their localized "encrypted subject" strings.
|
outside by accepting their localized "encrypted subject" strings.
|
||||||
([#370](https://github.com/chatmail/server/pull/370))
|
([#370](https://github.com/deltachat/chatmail/pull/370))
|
||||||
|
|
||||||
- Migrate and remove sqlite database in favor of password/lastlogin tracking
|
- Migrate and remove sqlite database in favor of password/lastlogin tracking
|
||||||
in a user's maildir.
|
in a user's maildir.
|
||||||
([#379](https://github.com/chatmail/server/pull/379))
|
([#379](https://github.com/deltachat/chatmail/pull/379))
|
||||||
|
|
||||||
- Require pyinfra V3 installed on the client side,
|
- Require pyinfra V3 installed on the client side,
|
||||||
run `./scripts/initenv.sh` to upgrade locally.
|
run `./scripts/initenv.sh` to upgrade locally.
|
||||||
([#378](https://github.com/chatmail/server/pull/378))
|
([#378](https://github.com/deltachat/chatmail/pull/378))
|
||||||
|
|
||||||
- don't hardcode "/home/vmail" paths but rather set them
|
- don't hardcode "/home/vmail" paths but rather set them
|
||||||
once in the config object and use it everywhere else,
|
once in the config object and use it everywhere else,
|
||||||
thereby also improving testability.
|
thereby also improving testability.
|
||||||
([#351](https://github.com/chatmail/server/pull/351))
|
([#351](https://github.com/deltachat/chatmail/pull/351))
|
||||||
temporarily introduced obligatory "passdb_path" and "mailboxes_dir"
|
temporarily introduced obligatory "passdb_path" and "mailboxes_dir"
|
||||||
settings but they were removed/obsoleted in
|
settings but they were removed/obsoleted in
|
||||||
([#380](https://github.com/chatmail/server/pull/380))
|
([#380](https://github.com/deltachat/chatmail/pull/380))
|
||||||
|
|
||||||
- BREAKING: new required chatmail.ini value 'delete_inactive_users_after = 100'
|
- BREAKING: new required chatmail.ini value 'delete_inactive_users_after = 100'
|
||||||
which removes users from database and mails after 100 days without any login.
|
which removes users from database and mails after 100 days without any login.
|
||||||
([#350](https://github.com/chatmail/server/pull/350))
|
([#350](https://github.com/deltachat/chatmail/pull/350))
|
||||||
|
|
||||||
- Refine DNS checking to distinguish between "required" and "recommended" settings
|
- Refine DNS checking to distinguish between "required" and "recommended" settings
|
||||||
([#372](https://github.com/chatmail/server/pull/372))
|
([#372](https://github.com/deltachat/chatmail/pull/372))
|
||||||
|
|
||||||
- reload nginx in the acmetool cronjob
|
- reload nginx in the acmetool cronjob
|
||||||
([#360](https://github.com/chatmail/server/pull/360))
|
([#360](https://github.com/deltachat/chatmail/pull/360))
|
||||||
|
|
||||||
- remove checking of reverse-DNS PTR records. Chatmail-servers don't
|
- 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.
|
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.
|
If it's an issue, a chatmail operator can still care to properly set reverse DNS.
|
||||||
([#348](https://github.com/chatmail/server/pull/348))
|
([#348](https://github.com/deltachat/chatmail/pull/348))
|
||||||
|
|
||||||
- Make DNS-checking faster and more interactive, run it fully during "cmdeploy run",
|
- 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.
|
also introducing a generic mechanism for rapid remote ssh-based python function execution.
|
||||||
([#346](https://github.com/chatmail/server/pull/346))
|
([#346](https://github.com/deltachat/chatmail/pull/346))
|
||||||
|
|
||||||
- Don't fix file owner ship of /home/vmail
|
- Don't fix file owner ship of /home/vmail
|
||||||
([#345](https://github.com/chatmail/server/pull/345))
|
([#345](https://github.com/deltachat/chatmail/pull/345))
|
||||||
|
|
||||||
- Support iterating over all users with doveadm commands
|
- Support iterating over all users with doveadm commands
|
||||||
([#344](https://github.com/chatmail/server/pull/344))
|
([#344](https://github.com/deltachat/chatmail/pull/344))
|
||||||
|
|
||||||
- Test and fix for attempts to create inadmissible accounts
|
- Test and fix for attempts to create inadmissible accounts
|
||||||
([#333](https://github.com/chatmail/server/pull/321))
|
([#333](https://github.com/deltachat/chatmail/pull/321))
|
||||||
|
|
||||||
- check that OpenPGP has only PKESK, SKESK and SEIPD packets
|
- check that OpenPGP has only PKESK, SKESK and SEIPD packets
|
||||||
([#323](https://github.com/chatmail/server/pull/323),
|
([#323](https://github.com/deltachat/chatmail/pull/323),
|
||||||
[#324](https://github.com/chatmail/server/pull/324))
|
[#324](https://github.com/deltachat/chatmail/pull/324))
|
||||||
|
|
||||||
- improve filtermail checks for encrypted messages and drop support for unencrypted MDNs
|
- improve filtermail checks for encrypted messages and drop support for unencrypted MDNs
|
||||||
([#320](https://github.com/chatmail/server/pull/320))
|
([#320](https://github.com/deltachat/chatmail/pull/320))
|
||||||
|
|
||||||
- replace `bash` with `/bin/sh`
|
- replace `bash` with `/bin/sh`
|
||||||
([#334](https://github.com/chatmail/server/pull/334))
|
([#334](https://github.com/deltachat/chatmail/pull/334))
|
||||||
|
|
||||||
- Increase number of logged in IMAP sessions to 50000
|
- Increase number of logged in IMAP sessions to 50000
|
||||||
([#335](https://github.com/chatmail/server/pull/335))
|
([#335](https://github.com/deltachat/chatmail/pull/335))
|
||||||
|
|
||||||
- filtermail: do not allow ASCII armor without actual payload
|
- filtermail: do not allow ASCII armor without actual payload
|
||||||
([#325](https://github.com/chatmail/server/pull/325))
|
([#325](https://github.com/deltachat/chatmail/pull/325))
|
||||||
|
|
||||||
- Remove sieve to enable hardlink deduplication in LMTP
|
- Remove sieve to enable hardlink deduplication in LMTP
|
||||||
([#343](https://github.com/chatmail/server/pull/343))
|
([#343](https://github.com/deltachat/chatmail/pull/343))
|
||||||
|
|
||||||
- dovecot: enable gzip compression on disk
|
- dovecot: enable gzip compression on disk
|
||||||
([#341](https://github.com/chatmail/server/pull/341))
|
([#341](https://github.com/deltachat/chatmail/pull/341))
|
||||||
|
|
||||||
- DKIM-sign Content-Type and oversign all signed headers
|
- DKIM-sign Content-Type and oversign all signed headers
|
||||||
([#296](https://github.com/chatmail/server/pull/296))
|
([#296](https://github.com/deltachat/chatmail/pull/296))
|
||||||
|
|
||||||
- Add nonci_accounts metric
|
- Add nonci_accounts metric
|
||||||
([#347](https://github.com/chatmail/server/pull/347))
|
([#347](https://github.com/deltachat/chatmail/pull/347))
|
||||||
|
|
||||||
- doveauth: log when a new account is created
|
- doveauth: log when a new account is created
|
||||||
([#349](https://github.com/chatmail/server/pull/349))
|
([#349](https://github.com/deltachat/chatmail/pull/349))
|
||||||
|
|
||||||
- Multiplex HTTPS, IMAP and SMTP on port 443
|
- Multiplex HTTPS, IMAP and SMTP on port 443
|
||||||
([#357](https://github.com/chatmail/server/pull/357))
|
([#357](https://github.com/deltachat/chatmail/pull/357))
|
||||||
|
|
||||||
## 1.3.0 - 2024-06-06
|
## 1.3.0 - 2024-06-06
|
||||||
|
|
||||||
- don't check necessary DNS records on cmdeploy init anymore
|
- don't check necessary DNS records on cmdeploy init anymore
|
||||||
([#316](https://github.com/chatmail/server/pull/316))
|
([#316](https://github.com/deltachat/chatmail/pull/316))
|
||||||
|
|
||||||
- ensure cron and acl are installed
|
- ensure cron and acl are installed
|
||||||
([#293](https://github.com/chatmail/server/pull/293),
|
([#293](https://github.com/deltachat/chatmail/pull/293),
|
||||||
[#310](https://github.com/chatmail/server/pull/310))
|
[#310](https://github.com/deltachat/chatmail/pull/310))
|
||||||
|
|
||||||
- change default for delete_mails_after from 40 to 20 days
|
- change default for delete_mails_after from 40 to 20 days
|
||||||
([#300](https://github.com/chatmail/server/pull/300))
|
([#300](https://github.com/deltachat/chatmail/pull/300))
|
||||||
|
|
||||||
- save journald logs only to memory and save nginx logs to journald instead of file
|
- save journald logs only to memory and save nginx logs to journald instead of file
|
||||||
([#299](https://github.com/chatmail/server/pull/299))
|
([#299](https://github.com/deltachat/chatmail/pull/299))
|
||||||
|
|
||||||
- fix writing of multiple obs repositories in `/etc/apt/sources.list`
|
- fix writing of multiple obs repositories in `/etc/apt/sources.list`
|
||||||
([#290](https://github.com/chatmail/server/pull/290))
|
([#290](https://github.com/deltachat/chatmail/pull/290))
|
||||||
|
|
||||||
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
||||||
([#284](https://github.com/chatmail/server/pull/284))
|
([#284](https://github.com/deltachat/chatmail/pull/284))
|
||||||
|
|
||||||
- Emit "XCHATMAIL" capability from IMAP server
|
- Emit "XCHATMAIL" capability from IMAP server
|
||||||
([#278](https://github.com/chatmail/server/pull/278))
|
([#278](https://github.com/deltachat/chatmail/pull/278))
|
||||||
|
|
||||||
- Move echobot `into /var/lib/echobot`
|
- Move echobot `into /var/lib/echobot`
|
||||||
([#281](https://github.com/chatmail/server/pull/281))
|
([#281](https://github.com/deltachat/chatmail/pull/281))
|
||||||
|
|
||||||
- Accept Let's Encrypt's new Terms of Services
|
- Accept Let's Encrypt's new Terms of Services
|
||||||
([#275](https://github.com/chatmail/server/pull/276))
|
([#275](https://github.com/deltachat/chatmail/pull/276))
|
||||||
|
|
||||||
- Reload Dovecot and Postfix when TLS certificate updates
|
- Reload Dovecot and Postfix when TLS certificate updates
|
||||||
([#271](https://github.com/chatmail/server/pull/271))
|
([#271](https://github.com/deltachat/chatmail/pull/271))
|
||||||
|
|
||||||
- Use forked version of dovecot without hardcoded delays
|
- Use forked version of dovecot without hardcoded delays
|
||||||
([#270](https://github.com/chatmail/server/pull/270))
|
([#270](https://github.com/deltachat/chatmail/pull/270))
|
||||||
|
|
||||||
## 1.2.0 - 2024-04-04
|
## 1.2.0 - 2024-04-04
|
||||||
|
|
||||||
- Install dig on the server to resolve DNS records
|
- Install dig on the server to resolve DNS records
|
||||||
([#267](https://github.com/chatmail/server/pull/267))
|
([#267](https://github.com/deltachat/chatmail/pull/267))
|
||||||
|
|
||||||
- preserve notification order and exponentially backoff with
|
- preserve notification order and exponentially backoff with
|
||||||
retries for tokens where we didn't get a successful return
|
retries for tokens where we didn't get a successful return
|
||||||
([#265](https://github.com/chatmail/server/pull/263))
|
([#265](https://github.com/deltachat/chatmail/pull/263))
|
||||||
|
|
||||||
- Run chatmail-metadata and doveauth as vmail
|
- Run chatmail-metadata and doveauth as vmail
|
||||||
([#261](https://github.com/chatmail/server/pull/261))
|
([#261](https://github.com/deltachat/chatmail/pull/261))
|
||||||
|
|
||||||
- Apply systemd restrictions to echobot
|
- Apply systemd restrictions to echobot
|
||||||
([#259](https://github.com/chatmail/server/pull/259))
|
([#259](https://github.com/deltachat/chatmail/pull/259))
|
||||||
|
|
||||||
- re-enable running the CI in pull requests, but not concurrently
|
- re-enable running the CI in pull requests, but not concurrently
|
||||||
([#258](https://github.com/chatmail/server/pull/258))
|
([#258](https://github.com/deltachat/chatmail/pull/258))
|
||||||
|
|
||||||
|
|
||||||
## 1.1.0 - 2024-03-28
|
## 1.1.0 - 2024-03-28
|
||||||
@@ -310,27 +187,27 @@
|
|||||||
### The changelog starts to record changes from March 15th, 2024
|
### The changelog starts to record changes from March 15th, 2024
|
||||||
|
|
||||||
- Move systemd unit templates to cmdeploy package
|
- Move systemd unit templates to cmdeploy package
|
||||||
([#255](https://github.com/chatmail/server/pull/255))
|
([#255](https://github.com/deltachat/chatmail/pull/255))
|
||||||
|
|
||||||
- Persist push tokens and support multiple device per address
|
- Persist push tokens and support multiple device per address
|
||||||
([#254](https://github.com/chatmail/server/pull/254))
|
([#254](https://github.com/deltachat/chatmail/pull/254))
|
||||||
|
|
||||||
- Avoid warning for regular doveauth protocol's hello message.
|
- Avoid warning for regular doveauth protocol's hello message.
|
||||||
([#250](https://github.com/chatmail/server/pull/250))
|
([#250](https://github.com/deltachat/chatmail/pull/250))
|
||||||
|
|
||||||
- Fix various tests to pass again with "cmdeploy test".
|
- Fix various tests to pass again with "cmdeploy test".
|
||||||
([#245](https://github.com/chatmail/server/pull/245),
|
([#245](https://github.com/deltachat/chatmail/pull/245),
|
||||||
[#242](https://github.com/chatmail/server/pull/242)
|
[#242](https://github.com/deltachat/chatmail/pull/242)
|
||||||
|
|
||||||
- Ensure lets-encrypt certificates are reloaded after renewal
|
- Ensure lets-encrypt certificates are reloaded after renewal
|
||||||
([#244]) https://github.com/chatmail/server/pull/244
|
([#244]) https://github.com/deltachat/chatmail/pull/244
|
||||||
|
|
||||||
- Persist tokens to avoid iOS users loosing push-notifications when the
|
- Persist tokens to avoid iOS users loosing push-notifications when the
|
||||||
chatmail metadata service is restarted (happens regularly during deploys)
|
chatmail metadata service is restarted (happens regularly during deploys)
|
||||||
([#238](https://github.com/chatmail/server/pull/239)
|
([#238](https://github.com/deltachat/chatmail/pull/239)
|
||||||
|
|
||||||
- Fix failing sieve-script compile errors on incoming messages
|
- Fix failing sieve-script compile errors on incoming messages
|
||||||
([#237](https://github.com/chatmail/server/pull/239)
|
([#237](https://github.com/deltachat/chatmail/pull/239)
|
||||||
|
|
||||||
- Fix quota reporting after expunging of old mails
|
- Fix quota reporting after expunging of old mails
|
||||||
([#233](https://github.com/chatmail/server/pull/239)
|
([#233](https://github.com/deltachat/chatmail/pull/239)
|
||||||
|
|||||||
522
README.md
522
README.md
@@ -1,96 +1,48 @@
|
|||||||
|
|
||||||
<img width="800px" src="www/src/collage-top.png"/>
|
<img width="800px" src="www/src/collage-top.png"/>
|
||||||
|
|
||||||
# Chatmail relays for end-to-end encrypted e-mail
|
# Chatmail services optimized for Delta Chat apps
|
||||||
|
|
||||||
Chatmail relay servers are interoperable Mail Transport Agents (MTAs) designed for:
|
This repository helps to setup a ready-to-use chatmail server
|
||||||
|
|
||||||
- **Convenience:** Low friction instant onboarding
|
|
||||||
|
|
||||||
- **Privacy:** No name, phone numbers, email required or collected
|
|
||||||
|
|
||||||
- **End-to-End Encryption enforced**: only OpenPGP messages with metadata minimization allowed
|
|
||||||
|
|
||||||
- **Instant:** Privacy-preserving Push Notifications for Apple, Google, and Huawei
|
|
||||||
|
|
||||||
- **Speed:** Message delivery in half a second, with optional P2P realtime connections
|
|
||||||
|
|
||||||
- **Transport Security:** Strict TLS and DKIM enforced
|
|
||||||
|
|
||||||
- **Reliability:** No spam or IP reputation checks; rate-limits are suitable for realtime chats
|
|
||||||
|
|
||||||
- **Efficiency:** Messages are only stored for transit and removed automatically
|
|
||||||
|
|
||||||
This repository contains everything needed to setup a ready-to-use chatmail relay
|
|
||||||
comprised of a minimal setup of the battle-tested
|
comprised of a minimal setup of the battle-tested
|
||||||
[Postfix SMTP](https://www.postfix.org) and [Dovecot IMAP](https://www.dovecot.org) MTAs/MDAs.
|
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services.
|
||||||
|
|
||||||
The automated setup is designed and optimized for providing chatmail addresses
|
The setup is designed and optimized for providing chatmail accounts
|
||||||
for immediate permission-free onboarding through chat apps and bots.
|
for use by [Delta Chat apps](https://delta.chat).
|
||||||
Chatmail addresses are automatically created at first login,
|
|
||||||
after which the initially specified password is required
|
|
||||||
for sending and receiving messages through them.
|
|
||||||
|
|
||||||
Please see [this list of known apps and client projects](https://chatmail.at/clients.html)
|
Chatmail accounts are automatically created by a first login,
|
||||||
and [this list of known public 3rd party chatmail relay servers](https://chatmail.at/relays).
|
after which the initially specified password is required for using them.
|
||||||
|
|
||||||
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
## Minimal requirements, Prerequisites
|
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.
|
||||||
|
|
||||||
You will need the following:
|
We use `chat.example.org` as the chatmail domain in the following steps.
|
||||||
|
|
||||||
- Control over a domain through a DNS provider of your choice.
|
|
||||||
|
|
||||||
- A Debian 12 server with reachable SMTP/SUBMISSIONS/IMAPS/HTTPS ports.
|
|
||||||
IPv6 is encouraged if available.
|
|
||||||
Chatmail relay servers only require 1GB RAM, one CPU, and perhaps 10GB storage for a
|
|
||||||
few thousand active chatmail addresses.
|
|
||||||
|
|
||||||
- Key-based SSH authentication to the root user.
|
|
||||||
You must add a passphrase-protected private key to your local ssh-agent
|
|
||||||
because you can't type in your passphrase during deployment.
|
|
||||||
(An ed25519 private key is required due to an [upstream bug in paramiko](https://github.com/paramiko/paramiko/issues/2191))
|
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
We use `chat.example.org` as the chatmail domain in the following steps.
|
|
||||||
Please substitute it with your own domain.
|
Please substitute it with your own domain.
|
||||||
|
|
||||||
1. Setup the initial DNS records.
|
1. Install the `cmdeploy` command in a virtualenv
|
||||||
The following is an example in the familiar BIND zone file format with
|
|
||||||
a TTL of 1 hour (3600 seconds).
|
|
||||||
Please substitute your domain and IP addresses.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
chat.example.com. 3600 IN A 198.51.100.5
|
git clone https://github.com/deltachat/chatmail
|
||||||
chat.example.com. 3600 IN AAAA 2001:db8::5
|
cd chatmail
|
||||||
www.chat.example.com. 3600 IN CNAME chat.example.com.
|
|
||||||
mta-sts.chat.example.com. 3600 IN CNAME chat.example.com.
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Clone the repository and bootstrap the Python virtualenv.
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/chatmail/relay
|
|
||||||
cd relay
|
|
||||||
scripts/initenv.sh
|
scripts/initenv.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Create chatmail configuration file `chatmail.ini`:
|
2. Create chatmail configuration file `chatmail.ini`:
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy init chat.example.org # <-- use your domain
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Verify that SSH root login works:
|
3. Point your domain to the server's IP address,
|
||||||
|
if you haven't done so already.
|
||||||
|
Verify that SSH root login works:
|
||||||
|
|
||||||
```
|
```
|
||||||
ssh root@chat.example.org # <-- use your domain
|
ssh root@chat.example.org # <-- use your domain
|
||||||
```
|
```
|
||||||
|
|
||||||
|
4. Deploy to the remote chatmail server:
|
||||||
5. Deploy the remote chatmail relay server:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy run
|
scripts/cmdeploy run
|
||||||
@@ -128,113 +80,43 @@ scripts/cmdeploy bench
|
|||||||
|
|
||||||
## Overview of this repository
|
## Overview of this repository
|
||||||
|
|
||||||
This repository has four directories:
|
This repository drives the development of chatmail services,
|
||||||
|
comprised of minimal setups of
|
||||||
|
|
||||||
- [cmdeploy](https://github.com/chatmail/relay/tree/main/cmdeploy)
|
- [postfix smtp server](https://www.postfix.org)
|
||||||
is a collection of configuration files
|
- [dovecot imap server](https://www.dovecot.org)
|
||||||
and a [pyinfra](https://pyinfra.com)-based deployment script.
|
|
||||||
|
|
||||||
- [chatmaild](https://github.com/chatmail/relay/tree/main/chatmaild)
|
as well as custom services that are integrated with these two:
|
||||||
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/chatmail/relay/tree/main/www)
|
- `chatmaild/src/chatmaild/doveauth.py` implements
|
||||||
contains the html, css, and markdown files
|
create-on-login account creation semantics and is used
|
||||||
which make up a chatmail relay's web page.
|
by Dovecot during login authentication and by Postfix
|
||||||
Edit them before deploying to make your chatmail relay stand out.
|
|
||||||
|
|
||||||
- [scripts](https://github.com/chatmail/relay/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 relay,
|
|
||||||
according to the `chatmail.ini` config.
|
|
||||||
|
|
||||||
The components of chatmail are:
|
|
||||||
|
|
||||||
- [Postfix SMTP MTA](https://www.postfix.org) accepts and relays messages
|
|
||||||
(both from your users and from the wider e-mail MTA network)
|
|
||||||
|
|
||||||
- [Dovecot IMAP MDA](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
|
|
||||||
|
|
||||||
- [Iroh relay](https://www.iroh.computer/docs/concepts/relay)
|
|
||||||
which helps client devices to establish Peer-to-Peer connections
|
|
||||||
|
|
||||||
- and the chatmaild services, explained in the next section:
|
|
||||||
|
|
||||||
### chatmaild
|
|
||||||
|
|
||||||
`chatmaild` implements various systemd-controlled services
|
|
||||||
that integrate with Dovecot and Postfix to achieve instant-onboarding and
|
|
||||||
only relaying OpenPGP end-to-end messages encrypted messages.
|
|
||||||
A short overview of `chatmaild` services:
|
|
||||||
|
|
||||||
- [`doveauth`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/doveauth.py)
|
|
||||||
implements create-on-login address semantics and is used
|
|
||||||
by Dovecot during IMAP login and by Postfix during SMTP/SUBMISSION login
|
|
||||||
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
||||||
to authenticate logins.
|
to authenticate users
|
||||||
|
to send mails for them.
|
||||||
|
|
||||||
- [`filtermail`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/filtermail.py)
|
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
||||||
prevents unencrypted email from leaving or entering the chatmail service
|
unencrypted e-mail from leaving the chatmail service
|
||||||
and is integrated into Postfix's outbound and inbound mail pipelines.
|
and is integrated into postfix's outbound mail pipelines.
|
||||||
|
|
||||||
- [`chatmail-metadata`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a
|
There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
||||||
[Dovecot lua script](https://github.com/chatmail/relay/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua)
|
which helps with setting up and managing the chatmail service.
|
||||||
to store user-specific relay-side config.
|
`cmdeploy run` uses [pyinfra-based scripting](https://pyinfra.com/)
|
||||||
On new messages,
|
in `cmdeploy/src/cmdeploy/__init__.py`
|
||||||
it [passes the user's push notification token](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/notifier.py)
|
to automatically install all chatmail components on a server.
|
||||||
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/Huawei.
|
|
||||||
|
|
||||||
- [`delete_inactive_users`](https://github.com/chatmail/relay/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/chatmail/relay/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/chatmail/relay/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/chatmail/relay/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
|
### Home page and getting started for users
|
||||||
|
|
||||||
`cmdeploy run` also creates default static web pages and deploys them
|
`cmdeploy run` also creates default static Web pages and deploys them
|
||||||
to a Nginx web server with:
|
to a nginx web server with:
|
||||||
|
|
||||||
- a default `index.html` along with a QR code that users can click to
|
- a default `index.html` along with a QR code that users can click to
|
||||||
create an address on your chatmail relay
|
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.
|
||||||
@@ -242,64 +124,48 @@ by the according markdown `.md` file in the `www/src` directory.
|
|||||||
|
|
||||||
### Refining the web pages
|
### Refining the web pages
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy webdev
|
scripts/cmdeploy webdev
|
||||||
```
|
```
|
||||||
|
|
||||||
This starts a local live development cycle for chatmail web pages:
|
This starts a local live development cycle for chatmail Web pages:
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing static
|
- uses the `www/src/page-layout.html` file for producing static
|
||||||
HTML pages from `www/src/*.md` files
|
HTML pages from `www/src/*.md` files
|
||||||
|
|
||||||
- continously builds the web presence reading files from `www/src` directory
|
- continously builds the web presence reading files from `www/src` directory
|
||||||
and generating HTML files and copying assets to the `www/build` directory.
|
and generating html files and copying assets to the `www/build` directory.
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
- Starts a browser window automatically where you can "refresh" as needed.
|
||||||
|
|
||||||
## Mailbox directory layout
|
|
||||||
|
|
||||||
Fresh chatmail addresses have a mailbox directory that contains:
|
## Emergency Commands to disable automatic account creation
|
||||||
|
|
||||||
- a `password` file with the salted password required for authenticating
|
If you need to stop account creation,
|
||||||
whether a login may use the address to send/receive messages.
|
e.g. because some script is wildly creating accounts,
|
||||||
If you modify the password file manually, you effectively block the user.
|
login to the server with ssh and run:
|
||||||
|
|
||||||
- `enforceE2EEincoming` is a default-created file with each address.
|
|
||||||
If present the file indicates that this chatmail address rejects incoming cleartext messages.
|
|
||||||
If absent the address accepts incoming cleartext messages.
|
|
||||||
|
|
||||||
- `dovecot*`, `cur`, `new` and `tmp` represent IMAP/mailbox state.
|
|
||||||
If the address is only used by one device, the Maildir directories
|
|
||||||
will typically be empty unless the user of that address hasn't been online
|
|
||||||
for a while.
|
|
||||||
|
|
||||||
|
|
||||||
## Emergency Commands to disable automatic address creation
|
|
||||||
|
|
||||||
If you need to stop address creation,
|
|
||||||
e.g. because some script is wildly creating addresses,
|
|
||||||
login with ssh and run:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
touch /etc/chatmail-nocreate
|
touch /etc/chatmail-nocreate
|
||||||
```
|
```
|
||||||
|
|
||||||
Chatmail address creation will be denied while this file is present.
|
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](http://www.postfix.org/) 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](https://www.dovecot.org/) listens on ports 143 (imap) and 993 (imaps).
|
||||||
[Nginx](https://www.nginx.com/) listens on port 8443 (HTTPS-ALT) and 443 (HTTPS).
|
[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.
|
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).
|
[acmetool](https://hlandau.github.io/acmetool/) listens on port 80 (http).
|
||||||
|
|
||||||
chatmail-core based apps will, however, discover all ports and configurations
|
Delta Chat apps 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 relay server.
|
automatically by reading the [autoconfig XML file](https://www.ietf.org/archive/id/draft-bucksch-autoconfig-00.html) from the chatmail service.
|
||||||
|
|
||||||
## Email authentication
|
## Email authentication
|
||||||
|
|
||||||
Chatmail relays enforce [DKIM](https://www.rfc-editor.org/rfc/rfc6376)
|
chatmail servers rely on [DKIM](https://www.rfc-editor.org/rfc/rfc6376)
|
||||||
to authenticate incoming emails.
|
to authenticate incoming emails.
|
||||||
Incoming emails must have a valid DKIM signature with
|
Incoming emails must have a valid DKIM signature with
|
||||||
Signing Domain Identifier (SDID, `d=` parameter in the DKIM-Signature header)
|
Signing Domain Identifier (SDID, `d=` parameter in the DKIM-Signature header)
|
||||||
@@ -322,214 +188,112 @@ and rejects incorrectly authenticated emails with [`reject_sender_login_mismatch
|
|||||||
`From:` header must correspond to envelope MAIL FROM,
|
`From:` header must correspond to envelope MAIL FROM,
|
||||||
this is ensured by `filtermail` proxy.
|
this is ensured by `filtermail` proxy.
|
||||||
|
|
||||||
## TLS requirements
|
## Migrating chatmail server to a new host
|
||||||
|
|
||||||
Postfix is configured to require valid TLS
|
If you want to migrate your chatmail server to a new host,
|
||||||
by setting [`smtp_tls_security_level`](https://www.postfix.org/postconf.5.html#smtp_tls_security_level) to `verify`.
|
follow these steps:
|
||||||
If emails don't arrive at your chatmail relay server,
|
|
||||||
the problem is likely that your relay does not have a valid TLS certificate.
|
|
||||||
|
|
||||||
You can test it by resolving `MX` records of your relay domain
|
1. Block all ports except 80 and 22 with firewall on a new server.
|
||||||
and then connecting to MX relays (e.g `mx.example.org`) with
|
|
||||||
`openssl s_client -connect mx.example.org:25 -verify_hostname mx.example.org -verify_return_error -starttls smtp`
|
|
||||||
from the host that has open port 25 to verify that certificate is valid.
|
|
||||||
|
|
||||||
When providing a TLS certificate to your chatmail relay server,
|
To do this, add the following config to `/etc/nftables.conf`:
|
||||||
make sure to provide the full certificate chain
|
|
||||||
and not just the last certificate.
|
|
||||||
|
|
||||||
If you are running an Exim server and don't see incoming connections
|
|
||||||
from a chatmail relay server in the logs,
|
|
||||||
make sure `smtp_no_mail` log item is enabled in the config
|
|
||||||
with `log_selector = +smtp_no_mail`.
|
|
||||||
By default Exim does not log sessions that are closed
|
|
||||||
before sending the `MAIL` command.
|
|
||||||
This happens if certificate is not recognized as valid by Postfix,
|
|
||||||
so you might think that connection is not established
|
|
||||||
while actually it is a problem with your TLS certificate.
|
|
||||||
|
|
||||||
## Migrating a chatmail relay to a new host
|
|
||||||
|
|
||||||
If you want to migrate chatmail relay from an old machine
|
|
||||||
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 site's IP address is `13.37.13.37`,
|
|
||||||
and your new site's IP address is `13.12.23.42`.
|
|
||||||
|
|
||||||
Note, you should lower the TTLs of your DNS records to a value
|
|
||||||
such as 300 (5 minutes) so the migration happens as smoothly as possible.
|
|
||||||
|
|
||||||
During the guide you might get a warning about changed SSH Host keys;
|
|
||||||
in this case, just run `ssh-keygen -R "mail.example.org"` as recommended.
|
|
||||||
|
|
||||||
1. First, disable mail services on the old site.
|
|
||||||
|
|
||||||
```
|
|
||||||
cmdeploy run --disable-mail --ssh-host 13.37.13.37
|
|
||||||
```
|
|
||||||
|
|
||||||
Now your users will notice the migration
|
|
||||||
and will not be able to send or receive messages
|
|
||||||
until the migration is completed.
|
|
||||||
|
|
||||||
2. Now we want to copy `/home/vmail`, `/var/lib/acme`, `/etc/dkimkeys`, `/run/echobot`, and `/var/spool/postfix` to the new site.
|
|
||||||
Login to the old site while forwarding your SSH agent
|
|
||||||
so you can copy directly from the old to the new site with your SSH key:
|
|
||||||
```
|
|
||||||
ssh -A root@13.37.13.37
|
|
||||||
tar c - /home/vmail/mail /var/lib/acme /etc/dkimkeys /run/echobot /var/spool/postfix | ssh root@13.12.23.42 "tar x -C /"
|
|
||||||
```
|
|
||||||
|
|
||||||
This transfers all addresses, the TLS certificate, DKIM keys (so DKIM DNS record remains valid), and the echobot's password so it continues to function.
|
|
||||||
It also preserves the Postfix mail spool so any messages pending delivery will still be delivered.
|
|
||||||
|
|
||||||
3. Install chatmail on the new machine:
|
|
||||||
|
|
||||||
```
|
|
||||||
cmdeploy run --disable-mail --ssh-host 13.12.23.42
|
|
||||||
```
|
|
||||||
Postfix and Dovecot are disabled for now; we will enable them later.
|
|
||||||
We first need to make the new site fully operational.
|
|
||||||
|
|
||||||
3. On the new site, run the following to ensure the ownership is correct in case UIDs/GIDs changed:
|
|
||||||
|
|
||||||
```
|
|
||||||
chown root: -R /var/lib/acme
|
|
||||||
chown opendkim: -R /etc/dkimkeys
|
|
||||||
chown vmail: -R /home/vmail/mail
|
|
||||||
chown echobot: -R /run/echobot
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Now, update DNS entries.
|
|
||||||
|
|
||||||
If other MTAs try to deliver messages to your chatmail domain they may fail intermittently,
|
|
||||||
as DNS catches up with the new site settings
|
|
||||||
but normally will retry delivering messages
|
|
||||||
for at least a week, so messages will not be lost.
|
|
||||||
|
|
||||||
5. Finally, you can execute `cmdeploy run --ssh-host 13.12.23.42` to turn on chatmail on the new relay.
|
|
||||||
Your users will be able to use the chatmail relay as soon as the DNS changes have propagated.
|
|
||||||
Voilà!
|
|
||||||
|
|
||||||
## Setting up a reverse proxy
|
|
||||||
|
|
||||||
A chatmail relay MTA does not track or 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 relay
|
|
||||||
and only use hosted VPS to provide a public IP address
|
|
||||||
for client connections and incoming mail.
|
|
||||||
You can connect chatmail relay 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 relay
|
|
||||||
over the tunnel.
|
|
||||||
You can also setup multiple reverse proxies
|
|
||||||
for your chatmail relay in different networks
|
|
||||||
to ensure your relay is reachable even when
|
|
||||||
one of the IPs becomes inaccessible due to
|
|
||||||
hosting or routing problems.
|
|
||||||
|
|
||||||
Note that your chatmail relay 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 relay,
|
|
||||||
put the following configuration in `/etc/nftables.conf`:
|
|
||||||
```
|
```
|
||||||
#!/usr/sbin/nft -f
|
#!/usr/sbin/nft -f
|
||||||
|
|
||||||
flush ruleset
|
flush ruleset
|
||||||
|
|
||||||
define wan = eth0
|
table inet filter {
|
||||||
|
chain input {
|
||||||
|
type filter hook input priority filter; policy drop;
|
||||||
|
|
||||||
# Which ports to proxy.
|
# Accept ICMP.
|
||||||
#
|
# It is especially important to accept ICMPv6 ND messages,
|
||||||
# Note that SSH is not proxied
|
# otherwise IPv6 connectivity breaks.
|
||||||
# so it is possible to log into the proxy server
|
icmp type { echo-request } accept
|
||||||
# and not the original one.
|
icmpv6 type { echo-request, nd-neighbor-solicit, nd-router-advert, nd-neighbor-advert } accept
|
||||||
define ports = { smtp, http, https, imap, imaps, submission, submissions }
|
|
||||||
|
|
||||||
# The host we want to proxy to.
|
tcp dport { ssh, http } accept
|
||||||
define ipv4_address = AAA.BBB.CCC.DDD
|
|
||||||
define ipv6_address = [XXX::1]
|
|
||||||
|
|
||||||
table ip nat {
|
ct state established accept
|
||||||
chain prerouting {
|
}
|
||||||
type nat hook prerouting priority dstnat; policy accept;
|
chain forward {
|
||||||
iif $wan tcp dport $ports dnat to $ipv4_address
|
type filter hook forward priority filter;
|
||||||
}
|
}
|
||||||
|
chain output {
|
||||||
chain postrouting {
|
type filter hook output priority filter;
|
||||||
type nat hook postrouting priority 0;
|
}
|
||||||
|
|
||||||
oifname $wan masquerade
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
Then execute `nft -f /etc/nftables.conf` as root.
|
||||||
|
|
||||||
table ip6 nat {
|
This will ensure users will not connect to the new server
|
||||||
chain prerouting {
|
and mails will not be delivered to the new server
|
||||||
type nat hook prerouting priority dstnat; policy accept;
|
before you finish the setup.
|
||||||
iif $wan tcp dport $ports dnat to $ipv6_address
|
|
||||||
}
|
|
||||||
|
|
||||||
chain postrouting {
|
Port 22 is needed for SSH access
|
||||||
type nat hook postrouting priority 0;
|
and port 80 is needed to get a TLS certificate.
|
||||||
|
They are not used by Delta Chat
|
||||||
|
or by other email servers trying to deliver the messages.
|
||||||
|
|
||||||
oifname $wan masquerade
|
2. Point DNS to the new IP addresses.
|
||||||
}
|
|
||||||
}
|
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.
|
||||||
|
|
||||||
|
3. Setup the new server with `cmdeploy`.
|
||||||
|
|
||||||
|
This step is similar to initial setup.
|
||||||
|
However, because ports Delta Chat uses are blocked,
|
||||||
|
new server will not become usable immediately.
|
||||||
|
If other servers try to deliver messages to your new server they will fail,
|
||||||
|
but normally email servers will retry delivering messages
|
||||||
|
for at least a week, so messages will not be lost.
|
||||||
|
|
||||||
|
4. Firewall all ports except `ssh` (22) on the old server.
|
||||||
|
Existing users will not be able to connect from now on
|
||||||
|
and no more messages will be delivered to your old chatmail server.
|
||||||
|
|
||||||
|
Blocking users from connecting to the new server
|
||||||
|
until mailboxes are migrated is needed to avoid UID validity change.
|
||||||
|
If Delta Chat connects to the new server before it is fully set up,
|
||||||
|
it will lose track of the IMAP message UID
|
||||||
|
and miss messages that arrived during migration.
|
||||||
|
|
||||||
|
Same for SMTP port 25, you want it blocked during migration so no new mails arrive
|
||||||
|
while the server is moving.
|
||||||
|
|
||||||
|
5. Use `rsync -avz` over SSH to copy /home/vmail/mail from the old server to the new one
|
||||||
|
preserving file permissions and timestamps.
|
||||||
|
|
||||||
|
6. Unblock ports used by Delta Chat and SMTP message exchange.
|
||||||
|
For that you can modify `/etc/nftables.conf` as follows:
|
||||||
|
```
|
||||||
|
#!/usr/sbin/nft -f
|
||||||
|
|
||||||
|
flush ruleset
|
||||||
|
|
||||||
table inet filter {
|
table inet filter {
|
||||||
chain input {
|
chain input {
|
||||||
type filter hook input priority filter; policy drop;
|
type filter hook input priority filter; policy drop;
|
||||||
|
|
||||||
# Accept ICMP.
|
# Accept ICMP.
|
||||||
# It is especially important to accept ICMPv6 ND messages,
|
# It is especially important to accept ICMPv6 ND messages,
|
||||||
# otherwise IPv6 connectivity breaks.
|
# otherwise IPv6 connectivity breaks.
|
||||||
icmp type { echo-request } accept
|
icmp type { echo-request } accept
|
||||||
icmpv6 type { echo-request, nd-neighbor-solicit, nd-router-advert, nd-neighbor-advert } accept
|
icmpv6 type { echo-request, nd-neighbor-solicit, nd-router-advert, nd-neighbor-advert } accept
|
||||||
|
|
||||||
# Allow incoming SSH connections.
|
tcp dport { ssh, smtp, http, https, imap, imaps, submission, submissions } accept
|
||||||
tcp dport { ssh } accept
|
|
||||||
|
|
||||||
ct state established accept
|
ct state established accept
|
||||||
}
|
}
|
||||||
chain forward {
|
chain forward {
|
||||||
type filter hook forward priority filter; policy drop;
|
type filter hook forward priority filter;
|
||||||
|
}
|
||||||
ct state established accept
|
chain output {
|
||||||
ip daddr $ipv4_address counter accept
|
type filter hook output priority filter;
|
||||||
ip6 daddr $ipv6_address counter accept
|
}
|
||||||
}
|
|
||||||
chain output {
|
|
||||||
type filter hook output priority filter;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
Execute `nft -f /etc/nftables.conf` as root to apply the changes.
|
||||||
Run `systemctl enable nftables.service`
|
|
||||||
to ensure configuration is reloaded when the proxy relay reboots.
|
|
||||||
|
|
||||||
Uncomment in `/etc/sysctl.conf` the following two lines:
|
|
||||||
|
|
||||||
```
|
|
||||||
net.ipv4.ip_forward=1
|
|
||||||
net.ipv6.conf.all.forwarding=1
|
|
||||||
```
|
|
||||||
|
|
||||||
Then reboot the relay or do `sysctl -p` and `nft -f /etc/nftables.conf`.
|
|
||||||
|
|
||||||
Once proxy relay is set up,
|
|
||||||
you can add its IP address to the DNS.
|
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ dependencies = [
|
|||||||
"deltachat-rpc-client",
|
"deltachat-rpc-client",
|
||||||
"filelock",
|
"filelock",
|
||||||
"requests",
|
"requests",
|
||||||
"crypt-r >= 3.13.1 ; python_version >= '3.11'",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
|
|||||||
59
chatmaild/src/chatmaild/common_encrypted_subjects.py
Normal file
59
chatmaild/src/chatmaild/common_encrypted_subjects.py
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
"""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",
|
||||||
|
"Κρυπτογραφημένο μήνυμα",
|
||||||
|
"Зашифроване повідомлення",
|
||||||
|
"Зашифрованное сообщение",
|
||||||
|
"Зашыфраваны ліст",
|
||||||
|
"Криптирано съобщение",
|
||||||
|
"Шифрована порука",
|
||||||
|
"დაშიფრული წერილი",
|
||||||
|
"הודעה מוצפנת",
|
||||||
|
"پیام رمزنگاریشده",
|
||||||
|
"رسالة مشفّرة",
|
||||||
|
"എൻക്രിപ്റ്റുചെയ്ത സന്ദേശം",
|
||||||
|
"加密邮件",
|
||||||
|
"已加密的訊息",
|
||||||
|
"暗号化されたメッセージ",
|
||||||
|
}
|
||||||
@@ -11,11 +11,7 @@ def read_config(inipath):
|
|||||||
assert Path(inipath).exists(), inipath
|
assert Path(inipath).exists(), inipath
|
||||||
cfg = iniconfig.IniConfig(inipath)
|
cfg = iniconfig.IniConfig(inipath)
|
||||||
params = cfg.sections["params"]
|
params = cfg.sections["params"]
|
||||||
default_config_content = get_default_config_content(params["mail_domain"])
|
return Config(inipath, params=params)
|
||||||
df_params = iniconfig.IniConfig("ini", data=default_config_content)["params"]
|
|
||||||
new_params = dict(df_params.items())
|
|
||||||
new_params.update(params)
|
|
||||||
return Config(inipath, params=new_params)
|
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
@@ -33,22 +29,10 @@ class Config:
|
|||||||
self.passthrough_senders = params["passthrough_senders"].split()
|
self.passthrough_senders = params["passthrough_senders"].split()
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].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.filtermail_smtp_port_incoming = int(
|
|
||||||
params["filtermail_smtp_port_incoming"]
|
|
||||||
)
|
|
||||||
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
||||||
self.postfix_reinject_port_incoming = int(
|
|
||||||
params["postfix_reinject_port_incoming"]
|
|
||||||
)
|
|
||||||
self.mtail_address = params.get("mtail_address")
|
|
||||||
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
||||||
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
||||||
if "iroh_relay" not in params:
|
self.iroh_relay = params.get("iroh_relay")
|
||||||
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")
|
||||||
@@ -79,11 +63,6 @@ class Config:
|
|||||||
|
|
||||||
def write_initial_config(inipath, mail_domain, overrides):
|
def write_initial_config(inipath, mail_domain, overrides):
|
||||||
"""Write out default config file, using the specified config value overrides."""
|
"""Write out default config file, using the specified config value overrides."""
|
||||||
content = get_default_config_content(mail_domain, **overrides)
|
|
||||||
inipath.write_text(content)
|
|
||||||
|
|
||||||
|
|
||||||
def get_default_config_content(mail_domain, **overrides):
|
|
||||||
from importlib.resources import files
|
from importlib.resources import files
|
||||||
|
|
||||||
inidir = files(__package__).joinpath("ini")
|
inidir = files(__package__).joinpath("ini")
|
||||||
@@ -128,4 +107,5 @@ def get_default_config_content(mail_domain, **overrides):
|
|||||||
else:
|
else:
|
||||||
lines.append(line)
|
lines.append(line)
|
||||||
content = "\n".join(lines)
|
content = "\n".join(lines)
|
||||||
return content
|
|
||||||
|
inipath.write_text(content)
|
||||||
|
|||||||
@@ -87,12 +87,8 @@ class DictProxy:
|
|||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
with CustomThreadingUnixStreamServer(socket, Handler) as server:
|
with ThreadingUnixStreamServer(socket, Handler) as server:
|
||||||
try:
|
try:
|
||||||
server.serve_forever()
|
server.serve_forever()
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
class CustomThreadingUnixStreamServer(ThreadingUnixStreamServer):
|
|
||||||
request_queue_size = 1000
|
|
||||||
|
|||||||
@@ -1,13 +1,9 @@
|
|||||||
|
import crypt
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
try:
|
|
||||||
import crypt_r
|
|
||||||
except ImportError:
|
|
||||||
import crypt as crypt_r
|
|
||||||
|
|
||||||
from .config import Config, read_config
|
from .config import Config, read_config
|
||||||
from .dictproxy import DictProxy
|
from .dictproxy import DictProxy
|
||||||
from .migrate_db import migrate_from_db_to_maildir
|
from .migrate_db import migrate_from_db_to_maildir
|
||||||
@@ -17,7 +13,7 @@ NOCREATE_FILE = "/etc/chatmail-nocreate"
|
|||||||
|
|
||||||
def encrypt_password(password: str):
|
def encrypt_password(password: str):
|
||||||
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
||||||
passhash = crypt_r.crypt(password, crypt_r.METHOD_SHA512)
|
passhash = crypt.crypt(password, crypt.METHOD_SHA512)
|
||||||
return "{SHA512-CRYPT}" + passhash
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import logging
|
|||||||
import os
|
import os
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
||||||
|
|
||||||
@@ -98,10 +97,6 @@ def main():
|
|||||||
if not bot.is_configured():
|
if not bot.is_configured():
|
||||||
bot.configure(addr, password)
|
bot.configure(addr, password)
|
||||||
|
|
||||||
# write invite link to working directory
|
|
||||||
invitelink = bot.account.get_qr_code()
|
|
||||||
Path("invite-link.txt").write_text(invitelink)
|
|
||||||
|
|
||||||
bot.run_forever()
|
bot.run_forever()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -11,12 +11,10 @@ from email.utils import parseaddr
|
|||||||
from smtplib import SMTP as SMTPClient
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
from aiosmtpd.controller import Controller
|
from aiosmtpd.controller import Controller
|
||||||
from aiosmtpd.smtp import SMTP
|
|
||||||
|
|
||||||
|
from .common_encrypted_subjects import common_encrypted_subjects
|
||||||
from .config import read_config
|
from .config import read_config
|
||||||
|
|
||||||
ENCRYPTION_NEEDED_523 = "523 Encryption Needed: Invalid Unencrypted Mail"
|
|
||||||
|
|
||||||
|
|
||||||
def check_openpgp_payload(payload: bytes):
|
def check_openpgp_payload(payload: bytes):
|
||||||
"""Checks the OpenPGP payload.
|
"""Checks the OpenPGP payload.
|
||||||
@@ -62,11 +60,10 @@ def check_openpgp_payload(payload: bytes):
|
|||||||
i += body_len
|
i += body_len
|
||||||
|
|
||||||
if i == len(payload):
|
if i == len(payload):
|
||||||
# Last packet should be
|
if packet_type_id == 18:
|
||||||
# Symmetrically Encrypted and Integrity Protected Data Packet (SEIPD)
|
# Last packet should be
|
||||||
#
|
# Symmetrically Encrypted and Integrity Protected Data Packet (SEIPD)
|
||||||
# This is the only place where this function may return `True`.
|
return True
|
||||||
return packet_type_id == 18
|
|
||||||
elif packet_type_id not in [1, 3]:
|
elif packet_type_id not in [1, 3]:
|
||||||
# All packets except the last one must be either
|
# All packets except the last one must be either
|
||||||
# Public-Key Encrypted Session Key Packet (PKESK)
|
# Public-Key Encrypted Session Key Packet (PKESK)
|
||||||
@@ -74,7 +71,13 @@ def check_openpgp_payload(payload: bytes):
|
|||||||
# Symmetric-Key Encrypted Session Key Packet (SKESK)
|
# Symmetric-Key Encrypted Session Key Packet (SKESK)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
return False
|
if i == 0:
|
||||||
|
return False
|
||||||
|
|
||||||
|
if i > len(payload):
|
||||||
|
# Payload is truncated.
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
def check_armored_payload(payload: str):
|
def check_armored_payload(payload: str):
|
||||||
@@ -83,9 +86,7 @@ def check_armored_payload(payload: str):
|
|||||||
return False
|
return False
|
||||||
payload = payload.removeprefix(prefix)
|
payload = payload.removeprefix(prefix)
|
||||||
|
|
||||||
while payload.endswith("\r\n"):
|
suffix = "-----END PGP MESSAGE-----\r\n\r\n"
|
||||||
payload = payload.removesuffix("\r\n")
|
|
||||||
suffix = "-----END PGP MESSAGE-----"
|
|
||||||
if not payload.endswith(suffix):
|
if not payload.endswith(suffix):
|
||||||
return False
|
return False
|
||||||
payload = payload.removesuffix(suffix)
|
payload = payload.removesuffix(suffix)
|
||||||
@@ -104,27 +105,6 @@ def check_armored_payload(payload: str):
|
|||||||
return False
|
return False
|
||||||
|
|
||||||
|
|
||||||
def is_securejoin(message):
|
|
||||||
if message.get("secure-join") not in ["vc-request", "vg-request"]:
|
|
||||||
return False
|
|
||||||
if not message.is_multipart():
|
|
||||||
return False
|
|
||||||
parts_count = 0
|
|
||||||
for part in message.iter_parts():
|
|
||||||
parts_count += 1
|
|
||||||
if parts_count > 1:
|
|
||||||
return False
|
|
||||||
if part.is_multipart():
|
|
||||||
return False
|
|
||||||
if part.get_content_type() != "text/plain":
|
|
||||||
return False
|
|
||||||
|
|
||||||
payload = part.get_payload().strip().lower()
|
|
||||||
if payload not in ("secure-join: vc-request", "secure-join: vg-request"):
|
|
||||||
return False
|
|
||||||
return True
|
|
||||||
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
@@ -132,6 +112,8 @@ def check_encrypted(message):
|
|||||||
"""
|
"""
|
||||||
if not message.is_multipart():
|
if not message.is_multipart():
|
||||||
return False
|
return False
|
||||||
|
if message.get("subject") not in common_encrypted_subjects:
|
||||||
|
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
|
||||||
@@ -160,40 +142,12 @@ def check_encrypted(message):
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
async def asyncmain_beforequeue(config, mode):
|
async def asyncmain_beforequeue(config):
|
||||||
if mode == "outgoing":
|
port = config.filtermail_smtp_port
|
||||||
port = config.filtermail_smtp_port
|
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
||||||
handler = OutgoingBeforeQueueHandler(config)
|
|
||||||
else:
|
|
||||||
port = config.filtermail_smtp_port_incoming
|
|
||||||
handler = IncomingBeforeQueueHandler(config)
|
|
||||||
HackedController(handler, hostname="127.0.0.1", port=port).start()
|
|
||||||
|
|
||||||
|
|
||||||
def recipient_matches_passthrough(recipient, passthrough_recipients):
|
class BeforeQueueHandler:
|
||||||
for addr in passthrough_recipients:
|
|
||||||
if recipient == addr:
|
|
||||||
return True
|
|
||||||
if addr[0] == "@" and recipient.endswith(addr):
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
class HackedController(Controller):
|
|
||||||
def factory(self):
|
|
||||||
return SMTPDiscardRCPTO_options(self.handler, **self.SMTP_kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class SMTPDiscardRCPTO_options(SMTP):
|
|
||||||
def _getparams(self, params):
|
|
||||||
# aiosmtpd's SMTP daemon fails to handle a request if there are RCPT TO options
|
|
||||||
# We just ignore them for our incoming filtermail purposes
|
|
||||||
if len(params) == 1 and params[0].startswith("ORCPT"):
|
|
||||||
return {}
|
|
||||||
return super()._getparams(params)
|
|
||||||
|
|
||||||
|
|
||||||
class OutgoingBeforeQueueHandler:
|
|
||||||
def __init__(self, config):
|
def __init__(self, config):
|
||||||
self.config = config
|
self.config = config
|
||||||
self.send_rate_limiter = SendRateLimiter()
|
self.send_rate_limiter = SendRateLimiter()
|
||||||
@@ -218,9 +172,7 @@ class OutgoingBeforeQueueHandler:
|
|||||||
return error
|
return error
|
||||||
logging.info("re-injecting the mail that passed checks")
|
logging.info("re-injecting the mail that passed checks")
|
||||||
client = SMTPClient("localhost", self.config.postfix_reinject_port)
|
client = SMTPClient("localhost", self.config.postfix_reinject_port)
|
||||||
client.sendmail(
|
client.sendmail(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
||||||
envelope.mail_from, envelope.rcpt_tos, envelope.original_content
|
|
||||||
)
|
|
||||||
return "250 OK"
|
return "250 OK"
|
||||||
|
|
||||||
def check_DATA(self, envelope):
|
def check_DATA(self, envelope):
|
||||||
@@ -231,86 +183,34 @@ class OutgoingBeforeQueueHandler:
|
|||||||
mail_encrypted = check_encrypted(message)
|
mail_encrypted = check_encrypted(message)
|
||||||
|
|
||||||
_, from_addr = parseaddr(message.get("from").strip())
|
_, from_addr = parseaddr(message.get("from").strip())
|
||||||
|
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 or is_securejoin(message):
|
|
||||||
print("Outgoing: Filtering encrypted mail.", file=sys.stderr)
|
|
||||||
return
|
|
||||||
|
|
||||||
print("Outgoing: Filtering unencrypted mail.", file=sys.stderr)
|
|
||||||
|
|
||||||
if envelope.mail_from in self.config.passthrough_senders:
|
if envelope.mail_from in self.config.passthrough_senders:
|
||||||
return
|
return
|
||||||
|
|
||||||
# allow self-sent Autocrypt Setup Message
|
|
||||||
if envelope.rcpt_tos == [from_addr]:
|
|
||||||
if message.get("subject") == "Autocrypt Setup Message":
|
|
||||||
if message.get_content_type() == "multipart/mixed":
|
|
||||||
return
|
|
||||||
|
|
||||||
passthrough_recipients = self.config.passthrough_recipients
|
passthrough_recipients = self.config.passthrough_recipients
|
||||||
|
envelope_from_domain = from_addr.split("@").pop()
|
||||||
for recipient in envelope.rcpt_tos:
|
for recipient in envelope.rcpt_tos:
|
||||||
if recipient_matches_passthrough(recipient, passthrough_recipients):
|
if envelope.mail_from == recipient:
|
||||||
|
# Always allow sending emails to self.
|
||||||
continue
|
continue
|
||||||
|
if recipient in passthrough_recipients:
|
||||||
print("Rejected unencrypted mail.", file=sys.stderr)
|
|
||||||
return ENCRYPTION_NEEDED_523
|
|
||||||
|
|
||||||
|
|
||||||
class IncomingBeforeQueueHandler:
|
|
||||||
def __init__(self, config):
|
|
||||||
self.config = config
|
|
||||||
|
|
||||||
async def handle_DATA(self, server, session, envelope):
|
|
||||||
logging.info("handle_DATA before-queue")
|
|
||||||
error = self.check_DATA(envelope)
|
|
||||||
if error:
|
|
||||||
return error
|
|
||||||
logging.info("re-injecting the mail that passed checks")
|
|
||||||
|
|
||||||
# the smtp daemon on reinject_port_incoming gives it to dkim milter
|
|
||||||
# which looks at source address to determine whether to verify or sign
|
|
||||||
client = SMTPClient(
|
|
||||||
"localhost",
|
|
||||||
self.config.postfix_reinject_port_incoming,
|
|
||||||
source_address=("127.0.0.2", 0),
|
|
||||||
)
|
|
||||||
client.sendmail(
|
|
||||||
envelope.mail_from, envelope.rcpt_tos, envelope.original_content
|
|
||||||
)
|
|
||||||
return "250 OK"
|
|
||||||
|
|
||||||
def check_DATA(self, envelope):
|
|
||||||
"""the central filtering function for e-mails."""
|
|
||||||
logging.info(f"Processing DATA message from {envelope.mail_from}")
|
|
||||||
|
|
||||||
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
|
||||||
mail_encrypted = check_encrypted(message)
|
|
||||||
|
|
||||||
if mail_encrypted or is_securejoin(message):
|
|
||||||
print("Incoming: Filtering encrypted mail.", file=sys.stderr)
|
|
||||||
return
|
|
||||||
|
|
||||||
print("Incoming: Filtering unencrypted mail.", file=sys.stderr)
|
|
||||||
|
|
||||||
# we want cleartext mailer-daemon messages to pass through
|
|
||||||
# chatmail core will typically not display them as normal messages
|
|
||||||
if message.get("auto-submitted"):
|
|
||||||
_, from_addr = parseaddr(message.get("from").strip())
|
|
||||||
if from_addr.lower().startswith("mailer-daemon@"):
|
|
||||||
if message.get_content_type() == "multipart/report":
|
|
||||||
return
|
|
||||||
|
|
||||||
for recipient in envelope.rcpt_tos:
|
|
||||||
user = self.config.get_user(recipient)
|
|
||||||
if user is None or user.is_incoming_cleartext_ok():
|
|
||||||
continue
|
continue
|
||||||
|
res = recipient.split("@")
|
||||||
|
if len(res) != 2:
|
||||||
|
return f"500 Invalid address <{recipient}>"
|
||||||
|
_recipient_addr, recipient_domain = res
|
||||||
|
|
||||||
print("Rejected unencrypted mail.", file=sys.stderr)
|
is_outgoing = recipient_domain != envelope_from_domain
|
||||||
return ENCRYPTION_NEEDED_523
|
if is_outgoing and not mail_encrypted:
|
||||||
|
is_securejoin = message.get("secure-join") in [
|
||||||
|
"vc-request",
|
||||||
|
"vg-request",
|
||||||
|
]
|
||||||
|
if not is_securejoin:
|
||||||
|
return f"500 Invalid unencrypted mail to <{recipient}>"
|
||||||
|
|
||||||
|
|
||||||
class SendRateLimiter:
|
class SendRateLimiter:
|
||||||
@@ -329,14 +229,11 @@ class SendRateLimiter:
|
|||||||
|
|
||||||
def main():
|
def main():
|
||||||
args = sys.argv[1:]
|
args = sys.argv[1:]
|
||||||
assert len(args) == 2
|
assert len(args) == 1
|
||||||
config = read_config(args[0])
|
config = read_config(args[0])
|
||||||
mode = args[1]
|
|
||||||
logging.basicConfig(level=logging.WARN)
|
logging.basicConfig(level=logging.WARN)
|
||||||
loop = asyncio.new_event_loop()
|
loop = asyncio.new_event_loop()
|
||||||
asyncio.set_event_loop(loop)
|
asyncio.set_event_loop(loop)
|
||||||
assert mode in ["incoming", "outgoing"]
|
task = asyncmain_beforequeue(config)
|
||||||
task = asyncmain_beforequeue(config, mode)
|
|
||||||
loop.create_task(task)
|
loop.create_task(task)
|
||||||
logging.info("entering serving loop")
|
|
||||||
loop.run_forever()
|
loop.run_forever()
|
||||||
|
|||||||
@@ -39,47 +39,22 @@ password_min_length = 9
|
|||||||
passthrough_senders =
|
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)
|
# (space-separated)
|
||||||
passthrough_recipients = xstore@testrun.org
|
passthrough_recipients = xstore@testrun.org
|
||||||
|
|
||||||
#
|
#
|
||||||
# Deployment Details
|
# Deployment Details
|
||||||
#
|
#
|
||||||
|
|
||||||
# SMTP outgoing filtermail and reinjection
|
# where the filtermail SMTP service listens
|
||||||
filtermail_smtp_port = 10080
|
filtermail_smtp_port = 10080
|
||||||
postfix_reinject_port = 10025
|
|
||||||
|
|
||||||
# SMTP incoming filtermail and reinjection
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
filtermail_smtp_port_incoming = 10081
|
postfix_reinject_port = 10025
|
||||||
postfix_reinject_port_incoming = 10026
|
|
||||||
|
|
||||||
# if set to "True" IPv6 is disabled
|
# if set to "True" IPv6 is disabled
|
||||||
disable_ipv6 = False
|
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
|
# Debugging options
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -11,8 +11,6 @@ def main(vmail_dir=None):
|
|||||||
ci_accounts = 0
|
ci_accounts = 0
|
||||||
|
|
||||||
for path in Path(vmail_dir).iterdir():
|
for path in Path(vmail_dir).iterdir():
|
||||||
if not path.joinpath("cur").is_dir():
|
|
||||||
continue
|
|
||||||
accounts += 1
|
accounts += 1
|
||||||
if path.name[:3] in ("ci-", "ac_"):
|
if path.name[:3] in ("ci-", "ac_"):
|
||||||
ci_accounts += 1
|
ci_accounts += 1
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ def migrate_from_db_to_maildir(config, chunking=10000):
|
|||||||
# don't transfer special/CI accounts
|
# don't transfer special/CI accounts
|
||||||
rows = [row for row in all_rows if row[0][:3] not in ("ci-", "ac_")]
|
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"ignoring {len(all_rows)-len(rows)} CI accounts")
|
||||||
logging.info(f"migrating {len(rows)} sqlite database passwords to user dirs")
|
logging.info(f"migrating {len(rows)} sqlite database passwords to user dirs")
|
||||||
|
|
||||||
for i, row in enumerate(rows):
|
for i, row in enumerate(rows):
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
From: {from_addr}
|
|
||||||
To: {to_addr}
|
|
||||||
Autocrypt-Setup-Message: v1
|
|
||||||
Subject: Autocrypt Setup Message
|
|
||||||
Date: Tue, 22 Jan 2019 12:56:29 +0100
|
|
||||||
Content-type: multipart/mixed; boundary="Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ"
|
|
||||||
|
|
||||||
--Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ
|
|
||||||
Content-Type: text/plain
|
|
||||||
|
|
||||||
This message contains all information to transfer your Autocrypt
|
|
||||||
settings along with your secret key securely from your original
|
|
||||||
device.
|
|
||||||
|
|
||||||
To set up your new device for Autocrypt, please follow the
|
|
||||||
instuctions that should be presented by your new device.
|
|
||||||
|
|
||||||
You can keep this message and use it as a backup for your secret
|
|
||||||
key. If you want to do this, you should write down the Setup Code
|
|
||||||
and store it securely.
|
|
||||||
--Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ
|
|
||||||
Content-Type: application/autocrypt-setup
|
|
||||||
Content-Disposition: attachment; filename="autocrypt-setup-message.html"
|
|
||||||
|
|
||||||
<html><body>
|
|
||||||
<p>
|
|
||||||
This is the Autocrypt setup file used to transfer settings and
|
|
||||||
keys between clients. You can decrypt it using the Setup Code
|
|
||||||
presented on your old device, and then import the contained key
|
|
||||||
into your keyring.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
|
||||||
Passphrase-Format: numeric9x4
|
|
||||||
Passphrase-Begin: 17
|
|
||||||
|
|
||||||
jA0EBwMCFAxADoCdzeX/0ukBlqI5+pfpKb751qd/7nLNbkpy3gVcaf1QwRPZYt40
|
|
||||||
Ynp08UqRQ2g48ZlnzHLSwlTGOPTuv2Jt8ka+pgZ45xzvJSG2gau03xP4VsC271kR
|
|
||||||
VmCjdb0Y6Rk96mAwfGzrkbaRQ9Z7fIoL866GOv6h9neiVIkp+JYlTV6ISD0ZQJ4Q
|
|
||||||
I6dOQkB/TWZyVjtiJDOQHdfNWliA6NtqaLq19wlu9L5xXjuNpY95KwR8EJXWe0+o
|
|
||||||
Y3d2U/KxOAkXKghP2Qg1GtlPVeGC5T4p03TGI6pzKT+kHX6Rrm9wK6sM9aTquMmF
|
|
||||||
Vok84Jg1DFnwivWC2RILR81rXi7k/+Y6MUbveFgJ9cQduqpxnmD7TjOblYu7M6zp
|
|
||||||
YGAUxh8DRKlIMn2QsA++DBYQ6ACZvwuY8qTDLkqPDo4WqM313dsMJbyGjDdVE7EM
|
|
||||||
PESS+RlABETpZXz8g/ycr6DIUNdlbPcmYlsBfHWDOuR2GFFTwmlv5slWS39dJv38
|
|
||||||
E0eIe1CwdxI801Se7t7dUUS/ZF8wb6GlmxOcqGbF8eko1Z0S64IAm7/h13MRQCxI
|
|
||||||
geQnHfGYVJ2FOimoCMEKwfa9x++RFTDW0u7spDC2uWvK/1viV8OfRppFhLr/kmKb
|
|
||||||
18lWXuAz80DAjUDUsVqEq2MvJBJGoCJUEyjuRsLkHYRM5jYk4v50LyyR0Om73nWF
|
|
||||||
nZBqmqNzdr7Xb9PHHdFhnEc0VvoYbrcM0RVYcEMW3YbmejM891j1d6Iv+/n/qND/
|
|
||||||
NdebGrfWJMmFLf/iEkzTZ3/v5inW9LpWoRc94ioCjJTaEo8Rib6ARRFaJVIsmNXi
|
|
||||||
YicFGO98D+zX+a2t9Yz6IpPajVslnOp6ScpmXgts/2XWD7oE+JgxSAqo/dLVsHgP
|
|
||||||
Ufo=
|
|
||||||
=pulM
|
|
||||||
-----END PGP MESSAGE-----
|
|
||||||
</pre></body></html>
|
|
||||||
--Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ--
|
|
||||||
@@ -1,44 +1,44 @@
|
|||||||
From: {from_addr}
|
From: {from_addr}
|
||||||
To: {to_addr}
|
|
||||||
Subject: ...
|
To: {to_addr}
|
||||||
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
|
||||||
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
Subject: ...
|
||||||
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
||||||
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
|
||||||
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
|
||||||
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
|
||||||
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
|
||||||
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
Chat-Version: 1.0
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
|
||||||
|
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
||||||
Content-Description: PGP/MIME version identification
|
|
||||||
Content-Type: application/pgp-encrypted
|
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
||||||
|
|
||||||
Version: 1
|
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
||||||
|
|
||||||
|
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
|
||||||
Content-Description: OpenPGP encrypted message
|
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
||||||
Content-Disposition: inline; filename="encrypted.asc";
|
|
||||||
Content-Type: application/octet-stream; name="encrypted.asc"
|
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
||||||
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
MIME-Version: 1.0
|
||||||
|
|
||||||
yxJiAAAAAABIZWxsbyB3b3JsZCE=
|
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
||||||
=1I/B
|
|
||||||
-----END PGP MESSAGE-----
|
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi--
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
Date: Fri, 8 Jul 1994 09:21:47 -0400
|
|
||||||
From: Mail Delivery Subsystem <MAILER-DAEMON@example.org>
|
|
||||||
Subject: Returned mail: User unknown
|
|
||||||
To: <owner-ups-mib@CS.UTK.EDU>
|
|
||||||
Auto-Submitted: auto-replied
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/report; report-type=delivery-status;
|
|
||||||
boundary="JAA13167.773673707/CS.UTK.EDU"
|
|
||||||
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU
|
|
||||||
content-type: text/plain; charset=us-ascii
|
|
||||||
|
|
||||||
----- The following addresses had delivery problems -----
|
|
||||||
<arathib@vnet.ibm.com> (unrecoverable error)
|
|
||||||
<wsnell@sdcc13.ucsd.edu> (unrecoverable error)
|
|
||||||
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU
|
|
||||||
content-type: message/delivery-status
|
|
||||||
|
|
||||||
Reporting-MTA: dns; cs.utk.edu
|
|
||||||
|
|
||||||
Original-Recipient: rfc822;arathib@vnet.ibm.com
|
|
||||||
Final-Recipient: rfc822;arathib@vnet.ibm.com
|
|
||||||
Action: failed
|
|
||||||
Status: 5.0.0 (permanent failure)
|
|
||||||
Diagnostic-Code: smtp;
|
|
||||||
550 'arathib@vnet.IBM.COM' is not a registered gateway user
|
|
||||||
Remote-MTA: dns; vnet.ibm.com
|
|
||||||
|
|
||||||
Original-Recipient: rfc822;johnh@hpnjld.njd.hp.com
|
|
||||||
Final-Recipient: rfc822;johnh@hpnjld.njd.hp.com
|
|
||||||
Action: delayed
|
|
||||||
Status: 4.0.0 (hpnjld.njd.jp.com: host name lookup failure)
|
|
||||||
|
|
||||||
Original-Recipient: rfc822;wsnell@sdcc13.ucsd.edu
|
|
||||||
Final-Recipient: rfc822;wsnell@sdcc13.ucsd.edu
|
|
||||||
Action: failed
|
|
||||||
Status: 5.0.0
|
|
||||||
Diagnostic-Code: smtp; 550 user unknown
|
|
||||||
Remote-MTA: dns; sdcc13.ucsd.edu
|
|
||||||
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU
|
|
||||||
content-type: message/rfc822
|
|
||||||
|
|
||||||
[original message goes here]
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU--
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
Subject: Message from {from_addr}
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:25 +0000
|
|
||||||
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Secure-Join: vc-request
|
|
||||||
Secure-Join-Invitenumber: RANDOM-TOKEN
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/mixed; boundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
|
||||||
Content-Type: text/plain; charset=utf-8
|
|
||||||
|
|
||||||
Buy viagra!
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
Subject: Message from {from_addr}
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:25 +0000
|
|
||||||
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Secure-Join: vc-request
|
|
||||||
Secure-Join-Invitenumber: RANDOM-TOKEN
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/mixed; boundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
|
||||||
Content-Type: text/plain; charset=utf-8
|
|
||||||
|
|
||||||
Secure-Join: vc-request
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -69,11 +69,12 @@ def maildata(request):
|
|||||||
|
|
||||||
assert datadir.exists(), datadir
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
def maildata(name, from_addr, to_addr, subject="[...]"):
|
def maildata(name, from_addr, to_addr, subject="..."):
|
||||||
# Using `.read_bytes().decode()` instead of `.read_text()` to preserve newlines.
|
# Using `.read_bytes().decode()` instead of `.read_text()` to preserve newlines.
|
||||||
data = datadir.joinpath(name).read_bytes().decode()
|
data = datadir.joinpath(name).read_bytes().decode()
|
||||||
|
|
||||||
text = data.format(from_addr=from_addr, to_addr=to_addr, subject=subject)
|
text = data.format(from_addr=from_addr, to_addr=to_addr, subject=subject)
|
||||||
return BytesParser(policy=policy.SMTP).parsebytes(text.encode())
|
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
||||||
|
|
||||||
return maildata
|
return maildata
|
||||||
|
|
||||||
|
|||||||
@@ -15,14 +15,6 @@ def test_read_config_basic(example_config):
|
|||||||
assert example_config.mail_domain == "chat.example.org"
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_basic_using_defaults(tmp_path, maildomain):
|
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
|
||||||
inipath.write_text(f"[params]\nmail_domain = {maildomain}")
|
|
||||||
example_config = read_config(inipath)
|
|
||||||
assert example_config.max_user_send_per_minute == 60
|
|
||||||
assert example_config.filtermail_smtp_port_incoming == 10081
|
|
||||||
|
|
||||||
|
|
||||||
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.mail_domain == "something.testrun.org"
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from chatmaild.filtermail import (
|
from chatmaild.filtermail import (
|
||||||
IncomingBeforeQueueHandler,
|
BeforeQueueHandler,
|
||||||
OutgoingBeforeQueueHandler,
|
|
||||||
SendRateLimiter,
|
SendRateLimiter,
|
||||||
check_armored_payload,
|
check_armored_payload,
|
||||||
check_encrypted,
|
check_encrypted,
|
||||||
is_securejoin,
|
common_encrypted_subjects,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -19,13 +18,7 @@ def maildomain():
|
|||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def handler(make_config, maildomain):
|
def handler(make_config, maildomain):
|
||||||
config = make_config(maildomain)
|
config = make_config(maildomain)
|
||||||
return OutgoingBeforeQueueHandler(config)
|
return BeforeQueueHandler(config)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def inhandler(make_config, maildomain):
|
|
||||||
config = make_config(maildomain)
|
|
||||||
return IncomingBeforeQueueHandler(config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_reject_forged_from(maildata, gencreds, handler):
|
def test_reject_forged_from(maildata, gencreds, handler):
|
||||||
@@ -36,14 +29,14 @@ def test_reject_forged_from(maildata, gencreds, handler):
|
|||||||
# test that the filter lets good mail through
|
# test that the filter lets good mail through
|
||||||
to_addr = gencreds()[0]
|
to_addr = gencreds()[0]
|
||||||
env.content = maildata(
|
env.content = maildata(
|
||||||
"encrypted.eml", from_addr=env.mail_from, to_addr=to_addr
|
"plain.eml", from_addr=env.mail_from, to_addr=to_addr
|
||||||
).as_bytes()
|
).as_bytes()
|
||||||
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
# test that the filter rejects forged mail
|
# test that the filter rejects forged mail
|
||||||
env.content = maildata(
|
env.content = maildata(
|
||||||
"encrypted.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
"plain.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
||||||
).as_bytes()
|
).as_bytes()
|
||||||
error = handler.check_DATA(envelope=env)
|
error = handler.check_DATA(envelope=env)
|
||||||
assert "500" in error
|
assert "500" in error
|
||||||
@@ -62,28 +55,19 @@ def test_filtermail_no_encryption_detection(maildata):
|
|||||||
assert not check_encrypted(msg)
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_securejoin_detection(maildata):
|
|
||||||
msg = maildata(
|
|
||||||
"securejoin-vc.eml", from_addr="some@example.org", to_addr="other@example.org"
|
|
||||||
)
|
|
||||||
assert is_securejoin(msg)
|
|
||||||
|
|
||||||
msg = maildata(
|
|
||||||
"securejoin-vc-fake.eml",
|
|
||||||
from_addr="some@example.org",
|
|
||||||
to_addr="other@example.org",
|
|
||||||
)
|
|
||||||
assert not is_securejoin(msg)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_encryption_detection(maildata):
|
def test_filtermail_encryption_detection(maildata):
|
||||||
msg = maildata(
|
for subject in common_encrypted_subjects:
|
||||||
"encrypted.eml",
|
msg = maildata(
|
||||||
from_addr="1@example.org",
|
"encrypted.eml",
|
||||||
to_addr="2@example.org",
|
from_addr="1@example.org",
|
||||||
subject="Subject does not matter, will be replaced anyway",
|
to_addr="2@example.org",
|
||||||
)
|
subject=subject,
|
||||||
assert check_encrypted(msg)
|
)
|
||||||
|
assert check_encrypted(msg)
|
||||||
|
|
||||||
|
# if the subject is not a known encrypted subject value, it is not considered ac-encrypted
|
||||||
|
msg.replace_header("Subject", "Click this link")
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_no_literal_packets(maildata):
|
def test_filtermail_no_literal_packets(maildata):
|
||||||
@@ -113,7 +97,7 @@ def test_send_rate_limiter():
|
|||||||
break
|
break
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_excempt_privacy(maildata, gencreds, handler):
|
def test_excempt_privacy(maildata, gencreds, handler):
|
||||||
from_addr = gencreds()[0]
|
from_addr = gencreds()[0]
|
||||||
to_addr = "privacy@testrun.org"
|
to_addr = "privacy@testrun.org"
|
||||||
handler.config.passthrough_recipients = [to_addr]
|
handler.config.passthrough_recipients = [to_addr]
|
||||||
@@ -134,97 +118,10 @@ def test_cleartext_excempt_privacy(maildata, gencreds, handler):
|
|||||||
rcpt_tos = [to_addr, false_to]
|
rcpt_tos = [to_addr, false_to]
|
||||||
content = msg.as_bytes()
|
content = msg.as_bytes()
|
||||||
|
|
||||||
assert "523" in handler.check_DATA(envelope=env2)
|
assert "500" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_self_send_autocrypt_setup_message(maildata, gencreds, handler):
|
def test_passthrough_senders(gencreds, handler, maildata):
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = from_addr
|
|
||||||
|
|
||||||
msg = maildata("asm.eml", from_addr=from_addr, to_addr=to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_send_fails(maildata, gencreds, handler):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = gencreds()[0]
|
|
||||||
|
|
||||||
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()
|
|
||||||
|
|
||||||
res = handler.check_DATA(envelope=env)
|
|
||||||
assert "523 Encryption Needed" in res
|
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_incoming_fails(maildata, gencreds, inhandler):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr, password = gencreds()
|
|
||||||
|
|
||||||
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()
|
|
||||||
|
|
||||||
user = inhandler.config.get_user(to_addr)
|
|
||||||
user.set_password(password)
|
|
||||||
res = inhandler.check_DATA(envelope=env)
|
|
||||||
assert "523 Encryption Needed" in res
|
|
||||||
|
|
||||||
user.allow_incoming_cleartext()
|
|
||||||
assert not inhandler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_incoming_mailer_daemon(maildata, gencreds, inhandler):
|
|
||||||
from_addr = "mailer-daemon@example.org"
|
|
||||||
to_addr = gencreds()[0]
|
|
||||||
|
|
||||||
msg = maildata("mailer-daemon.eml", from_addr=from_addr, to_addr=to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert not inhandler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_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 "523" in handler.check_DATA(envelope=env2)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cleartext_passthrough_senders(gencreds, handler, maildata):
|
|
||||||
acc1 = gencreds()[0]
|
acc1 = gencreds()[0]
|
||||||
to_addr = "recipient@something.org"
|
to_addr = "recipient@something.org"
|
||||||
handler.config.passthrough_senders = [acc1]
|
handler.config.passthrough_senders = [acc1]
|
||||||
@@ -275,20 +172,10 @@ UN4fiB0KR9JyG2ayUdNJVkXZSZLnHyRgiaadlpUo16LVvw==\r
|
|||||||
=b5Kp\r
|
=b5Kp\r
|
||||||
-----END PGP MESSAGE-----\r
|
-----END PGP MESSAGE-----\r
|
||||||
\r
|
\r
|
||||||
\r
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
assert check_armored_payload(payload) == True
|
assert check_armored_payload(payload) == True
|
||||||
|
|
||||||
payload = payload.removesuffix("\r\n")
|
|
||||||
assert check_armored_payload(payload) == True
|
|
||||||
|
|
||||||
payload = payload.removesuffix("\r\n")
|
|
||||||
assert check_armored_payload(payload) == True
|
|
||||||
|
|
||||||
payload = payload.removesuffix("\r\n")
|
|
||||||
assert check_armored_payload(payload) == True
|
|
||||||
|
|
||||||
payload = """-----BEGIN PGP MESSAGE-----\r
|
payload = """-----BEGIN PGP MESSAGE-----\r
|
||||||
\r
|
\r
|
||||||
HELLOWORLD
|
HELLOWORLD
|
||||||
|
|||||||
@@ -2,15 +2,8 @@ from chatmaild.metrics import main
|
|||||||
|
|
||||||
|
|
||||||
def test_main(tmp_path, capsys):
|
def test_main(tmp_path, capsys):
|
||||||
paths = []
|
|
||||||
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
||||||
p = tmp_path.joinpath(x)
|
tmp_path.joinpath(x).mkdir()
|
||||||
p.mkdir()
|
|
||||||
p.joinpath("cur").mkdir()
|
|
||||||
paths.append(p)
|
|
||||||
|
|
||||||
tmp_path.joinpath("nomailbox").mkdir()
|
|
||||||
|
|
||||||
main(tmp_path)
|
main(tmp_path)
|
||||||
out, _ = capsys.readouterr()
|
out, _ = capsys.readouterr()
|
||||||
d = {}
|
d = {}
|
||||||
|
|||||||
@@ -40,17 +40,3 @@ def test_no_mailboxes_dir(testaddr, example_config, tmp_path):
|
|||||||
user.set_password("someeqkjwelkqwjleqwe")
|
user.set_password("someeqkjwelkqwjleqwe")
|
||||||
user.set_last_login_timestamp(100000)
|
user.set_last_login_timestamp(100000)
|
||||||
assert user.get_last_login_timestamp() == 86400
|
assert user.get_last_login_timestamp() == 86400
|
||||||
|
|
||||||
|
|
||||||
def test_set_get_cleartext_flag(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
|
|
||||||
|
|
||||||
assert not user.is_incoming_cleartext_ok()
|
|
||||||
user.allow_incoming_cleartext()
|
|
||||||
assert user.is_incoming_cleartext_ok()
|
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ class User:
|
|||||||
self.maildir = maildir
|
self.maildir = maildir
|
||||||
self.addr = addr
|
self.addr = addr
|
||||||
self.password_path = password_path
|
self.password_path = password_path
|
||||||
self.enforce_E2EE_path = maildir.joinpath("enforceE2EEincoming")
|
|
||||||
self.uid = uid
|
self.uid = uid
|
||||||
self.gid = gid
|
self.gid = gid
|
||||||
|
|
||||||
@@ -36,13 +35,6 @@ class User:
|
|||||||
home = str(self.maildir)
|
home = str(self.maildir)
|
||||||
return dict(addr=self.addr, home=home, uid=self.uid, gid=self.gid, password=pw)
|
return dict(addr=self.addr, home=home, uid=self.uid, gid=self.gid, password=pw)
|
||||||
|
|
||||||
def is_incoming_cleartext_ok(self):
|
|
||||||
return not self.enforce_E2EE_path.exists()
|
|
||||||
|
|
||||||
def allow_incoming_cleartext(self):
|
|
||||||
if self.enforce_E2EE_path.exists():
|
|
||||||
self.enforce_E2EE_path.unlink()
|
|
||||||
|
|
||||||
def set_password(self, enc_password):
|
def set_password(self, enc_password):
|
||||||
"""Set the specified password for this user.
|
"""Set the specified password for this user.
|
||||||
|
|
||||||
@@ -58,7 +50,6 @@ class User:
|
|||||||
if not self.addr.startswith("echo@"):
|
if not self.addr.startswith("echo@"):
|
||||||
logging.error(f"could not write password for: {self.addr}")
|
logging.error(f"could not write password for: {self.addr}")
|
||||||
raise
|
raise
|
||||||
self.enforce_E2EE_path.touch()
|
|
||||||
|
|
||||||
def set_last_login_timestamp(self, timestamp):
|
def set_last_login_timestamp(self, timestamp):
|
||||||
"""Track login time with daily granularity
|
"""Track login time with daily granularity
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import sys
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from chatmaild.config import Config, read_config
|
from chatmaild.config import Config, read_config
|
||||||
from pyinfra import facts, host
|
from pyinfra import host
|
||||||
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 pyinfra.operations import apt, files, pip, server, systemd
|
||||||
@@ -78,11 +78,6 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
always_copy=True,
|
always_copy=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="install gcc and headers to build crypt_r source package",
|
|
||||||
packages=["gcc", "python3-dev"],
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
server.shell(
|
||||||
name=f"forced pip-install {dist_file.name}",
|
name=f"forced pip-install {dist_file.name}",
|
||||||
commands=[
|
commands=[
|
||||||
@@ -106,14 +101,12 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
for fn in (
|
for fn in (
|
||||||
"doveauth",
|
"doveauth",
|
||||||
"filtermail",
|
"filtermail",
|
||||||
"filtermail-incoming",
|
|
||||||
"echobot",
|
"echobot",
|
||||||
"chatmail-metadata",
|
"chatmail-metadata",
|
||||||
"lastlogin",
|
"lastlogin",
|
||||||
):
|
):
|
||||||
execpath = fn if fn != "filtermail-incoming" else "filtermail"
|
|
||||||
params = dict(
|
params = dict(
|
||||||
execpath=f"{remote_venv_dir}/bin/{execpath}",
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
config_path=remote_chatmail_inipath,
|
config_path=remote_chatmail_inipath,
|
||||||
remote_venv_dir=remote_venv_dir,
|
remote_venv_dir=remote_venv_dir,
|
||||||
mail_domain=config.mail_domain,
|
mail_domain=config.mail_domain,
|
||||||
@@ -217,38 +210,51 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
server.shell(
|
server.shell(
|
||||||
name="Generate OpenDKIM domain keys",
|
name="Generate OpenDKIM domain keys",
|
||||||
commands=[
|
commands=[
|
||||||
f"/usr/sbin/opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
||||||
],
|
],
|
||||||
_use_su_login=True,
|
_sudo=True,
|
||||||
_su_user="opendkim",
|
_sudo_user="opendkim",
|
||||||
)
|
)
|
||||||
|
|
||||||
service_file = files.put(
|
|
||||||
name="Configure opendkim to restart once a day",
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/systemd.conf"),
|
|
||||||
dest="/etc/systemd/system/opendkim.service.d/10-prevent-memory-leak.conf",
|
|
||||||
)
|
|
||||||
need_restart |= service_file.changed
|
|
||||||
|
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _uninstall_mta_sts_daemon() -> None:
|
def _install_mta_sts_daemon() -> bool:
|
||||||
# Remove configuration.
|
need_restart = False
|
||||||
files.file("/etc/mta-sts-daemon.yml", present=False)
|
|
||||||
|
|
||||||
files.directory("/usr/local/lib/postfix-mta-sts-resolver", present=False)
|
config = files.put(
|
||||||
|
name="upload postfix-mta-sts-resolver config",
|
||||||
files.file("/etc/systemd/system/mta-sts-daemon.service", present=False)
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/mta-sts-daemon.yml"
|
||||||
systemd.service(
|
),
|
||||||
name="Stop MTA-STS daemon",
|
dest="/etc/mta-sts-daemon.yml",
|
||||||
service="mta-sts-daemon.service",
|
user="root",
|
||||||
daemon_reload=True,
|
group="root",
|
||||||
running=False,
|
mode="644",
|
||||||
enabled=False,
|
|
||||||
)
|
)
|
||||||
|
need_restart |= config.changed
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name="install postfix-mta-sts-resolver with pip",
|
||||||
|
commands=[
|
||||||
|
"python3 -m virtualenv /usr/local/lib/postfix-mta-sts-resolver",
|
||||||
|
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd_unit = files.put(
|
||||||
|
name="upload mta-sts-daemon systemd unit",
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/mta-sts-daemon.service"
|
||||||
|
),
|
||||||
|
dest="/etc/systemd/system/mta-sts-daemon.service",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= systemd_unit.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
||||||
@@ -435,105 +441,10 @@ def check_config(config):
|
|||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def deploy_mtail(config):
|
def deploy_chatmail(config_path: Path) -> 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="Upload iroh-relay config",
|
|
||||||
src=importlib.resources.files(__package__).joinpath("iroh-relay.toml"),
|
|
||||||
dest="/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 config_path: path to chatmail.ini
|
||||||
:param disable_mail: whether to disable postfix & dovecot
|
|
||||||
"""
|
"""
|
||||||
config = read_config(config_path)
|
config = read_config(config_path)
|
||||||
check_config(config)
|
check_config(config)
|
||||||
@@ -543,6 +454,7 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
|
|
||||||
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(
|
server.user(
|
||||||
name="Create opendkim user",
|
name="Create opendkim user",
|
||||||
@@ -557,7 +469,6 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
system=True,
|
system=True,
|
||||||
)
|
)
|
||||||
server.user(name="Create echobot user", user="echobot", 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
|
# Add our OBS repository for dovecot_no_delay
|
||||||
files.put(
|
files.put(
|
||||||
@@ -606,12 +517,9 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
enabled=True,
|
enabled=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
deploy_iroh_relay(config)
|
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
# Deploy acmetool to have TLS certificates.
|
||||||
tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"]
|
|
||||||
deploy_acmetool(
|
deploy_acmetool(
|
||||||
domains=tls_domains,
|
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
@@ -651,8 +559,8 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
||||||
postfix_need_restart = _configure_postfix(config, debug=debug)
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
nginx_need_restart = _configure_nginx(config)
|
nginx_need_restart = _configure_nginx(config)
|
||||||
_uninstall_mta_sts_daemon()
|
|
||||||
|
|
||||||
_remove_rspamd()
|
_remove_rspamd()
|
||||||
opendkim_need_restart = _configure_opendkim(mail_domain, "opendkim")
|
opendkim_need_restart = _configure_opendkim(mail_domain, "opendkim")
|
||||||
@@ -662,27 +570,35 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
service="opendkim.service",
|
service="opendkim.service",
|
||||||
running=True,
|
running=True,
|
||||||
enabled=True,
|
enabled=True,
|
||||||
daemon_reload=opendkim_need_restart,
|
|
||||||
restarted=opendkim_need_restart,
|
restarted=opendkim_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable MTA-STS daemon",
|
||||||
|
service="mta-sts-daemon.service",
|
||||||
|
daemon_reload=True,
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=mta_sts_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
# Dovecot should be started before Postfix
|
# Dovecot should be started before Postfix
|
||||||
# because it creates authentication socket
|
# because it creates authentication socket
|
||||||
# required by Postfix.
|
# required by Postfix.
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="disable dovecot for now" if disable_mail else "Start and enable Dovecot",
|
name="Start and enable Dovecot",
|
||||||
service="dovecot.service",
|
service="dovecot.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=dovecot_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="disable postfix for now" if disable_mail else "Start and enable Postfix",
|
name="Start and enable Postfix",
|
||||||
service="postfix.service",
|
service="postfix.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=postfix_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
@@ -715,15 +631,8 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
enabled=True,
|
enabled=True,
|
||||||
restarted=journald_conf.changed,
|
restarted=journald_conf.changed,
|
||||||
)
|
)
|
||||||
files.directory(
|
|
||||||
name="Ensure old logs on disk are deleted",
|
|
||||||
path="/var/log/journal/",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Ensure cron is installed",
|
name="Ensure cron is installed",
|
||||||
packages=["cron"],
|
packages=["cron"],
|
||||||
)
|
)
|
||||||
|
|
||||||
deploy_mtail(config)
|
|
||||||
|
|||||||
@@ -70,6 +70,6 @@ def deploy_acmetool(email="", domains=[]):
|
|||||||
)
|
)
|
||||||
|
|
||||||
server.shell(
|
server.shell(
|
||||||
name=f"Request certificate for: {', '.join(domains)}",
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
commands=[f"acmetool want --xlog.severity=debug {' '.join(domains)}"],
|
commands=[f"acmetool want --xlog.severity=debug { ' '.join(domains)}"],
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,2 +1,2 @@
|
|||||||
"acme-enter-email": "{{ email }}"
|
"acme-enter-email": "{{ email }}"
|
||||||
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.5-February-24-2025.pdf": true
|
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.4-April-3-2024.pdf": true
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ www.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
|||||||
;
|
;
|
||||||
; Recommended DNS entries for interoperability and security-hardening
|
; Recommended DNS entries for interoperability and security-hardening
|
||||||
;
|
;
|
||||||
{{ mail_domain }}. TXT "v=spf1 a ~all"
|
{{ mail_domain }}. TXT "v=spf1 a:{{ mail_domain }} ~all"
|
||||||
_dmarc.{{ mail_domain }}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
_dmarc.{{ mail_domain }}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
||||||
|
|
||||||
{% if acme_account_url %}
|
{% if acme_account_url %}
|
||||||
|
|||||||
@@ -52,36 +52,21 @@ 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()
|
sshexec = args.get_sshexec()
|
||||||
require_iroh = args.config.enable_iroh_relay
|
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
||||||
if not dns.check_initial_remote_data(remote_data, print=out.red):
|
if not dns.check_initial_remote_data(remote_data, print=out.red):
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
env = os.environ.copy()
|
env = os.environ.copy()
|
||||||
env["CHATMAIL_INI"] = args.inipath
|
env["CHATMAIL_INI"] = args.inipath
|
||||||
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
|
||||||
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
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.mail_domain} {deploy_path} -y"
|
||||||
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
|
||||||
if version.parse(pyinfra.__version__) < version.parse("3"):
|
if version.parse(pyinfra.__version__) < version.parse("3"):
|
||||||
out.red("Please re-run scripts/initenv.sh to update pyinfra to version 3.")
|
out.red("Please re-run scripts/initenv.sh to update pyinfra to version 3.")
|
||||||
return 1
|
return 1
|
||||||
|
|||||||
@@ -11,9 +11,8 @@ def main():
|
|||||||
"CHATMAIL_INI",
|
"CHATMAIL_INI",
|
||||||
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
||||||
)
|
)
|
||||||
disable_mail = bool(os.environ.get("CHATMAIL_DISABLE_MAIL"))
|
|
||||||
|
|
||||||
deploy_chatmail(config_path, disable_mail)
|
deploy_chatmail(config_path)
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
if pyinfra.is_cli:
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ def get_initial_remote_data(sshexec, mail_domain):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def check_initial_remote_data(remote_data, *, print=print):
|
def check_initial_remote_data(remote_data, print=print):
|
||||||
mail_domain = remote_data["mail_domain"]
|
mail_domain = remote_data["mail_domain"]
|
||||||
if not remote_data["A"] and not remote_data["AAAA"]:
|
if not remote_data["A"] and not remote_data["AAAA"]:
|
||||||
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
||||||
@@ -29,7 +29,7 @@ def check_initial_remote_data(remote_data, *, print=print):
|
|||||||
def get_filled_zone_file(remote_data):
|
def get_filled_zone_file(remote_data):
|
||||||
sts_id = remote_data.get("sts_id")
|
sts_id = remote_data.get("sts_id")
|
||||||
if not sts_id:
|
if not sts_id:
|
||||||
remote_data["sts_id"] = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
sts_id = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
||||||
|
|
||||||
template = importlib.resources.files(__package__).joinpath("chatmail.zone.j2")
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.j2")
|
||||||
content = template.read_text()
|
content = template.read_text()
|
||||||
@@ -49,23 +49,16 @@ def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
|||||||
kwargs=dict(zonefile=zonefile, mail_domain=remote_data["mail_domain"]),
|
kwargs=dict(zonefile=zonefile, mail_domain=remote_data["mail_domain"]),
|
||||||
)
|
)
|
||||||
|
|
||||||
returncode = 0
|
|
||||||
if required_diff:
|
if required_diff:
|
||||||
out.red("Please set required DNS entries at your DNS provider:\n")
|
out.red("Please set required DNS entries at your DNS provider:\n")
|
||||||
for line in required_diff:
|
for line in required_diff:
|
||||||
out(line)
|
out(line)
|
||||||
out("")
|
return 1
|
||||||
returncode = 1
|
elif recommended_diff:
|
||||||
if remote_data.get("dkim_entry") in required_diff:
|
|
||||||
out(
|
|
||||||
"If the DKIM entry above does not work with your DNS provider, you can try this one:\n"
|
|
||||||
)
|
|
||||||
out(remote_data.get("web_dkim_entry") + "\n")
|
|
||||||
if recommended_diff:
|
|
||||||
out("WARNING: these recommended DNS entries are not set:\n")
|
out("WARNING: these recommended DNS entries are not set:\n")
|
||||||
for line in recommended_diff:
|
for line in recommended_diff:
|
||||||
out(line)
|
out(line)
|
||||||
|
return 0
|
||||||
|
|
||||||
if not (recommended_diff or required_diff):
|
out.green("Great! All your DNS entries are verified and correct.")
|
||||||
out.green("Great! All your DNS entries are verified and correct.")
|
return 0
|
||||||
return returncode
|
|
||||||
|
|||||||
@@ -141,7 +141,7 @@ plugin {
|
|||||||
# for now we define static quota-rules for all users
|
# for now we define static quota-rules for all users
|
||||||
quota = maildir:User quota
|
quota = maildir:User quota
|
||||||
quota_rule = *:storage={{ config.max_mailbox_size }}
|
quota_rule = *:storage={{ config.max_mailbox_size }}
|
||||||
quota_max_mail_size={{ config.max_message_size }}
|
quota_max_mail_size=30M
|
||||||
quota_grace = 0
|
quota_grace = 0
|
||||||
# quota_over_flag_value = TRUE
|
# quota_over_flag_value = TRUE
|
||||||
}
|
}
|
||||||
@@ -194,22 +194,11 @@ service imap-login {
|
|||||||
process_min_avail = 10
|
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 = required
|
||||||
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
ssl_min_protocol = TLSv1.3
|
ssl_min_protocol = TLSv1.2
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
# delete already seen big mails after 7 days, in the INBOX
|
|
||||||
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/cur/*' -mtime +7 -size +200k -type f -delete
|
|
||||||
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
# 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
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
# or in any IMAP subfolder
|
# or in any IMAP subfolder
|
||||||
|
|||||||
@@ -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,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 /dev/stdin"
|
|
||||||
Restart=on-failure
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -46,7 +46,10 @@ http {
|
|||||||
|
|
||||||
server {
|
server {
|
||||||
|
|
||||||
listen 127.0.0.1:8443 ssl default_server;
|
listen 8443 ssl default_server;
|
||||||
|
{% if not disable_ipv6 %}
|
||||||
|
listen [::]:8443 ssl default_server;
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
root /var/www/html;
|
root /var/www/html;
|
||||||
|
|
||||||
@@ -93,31 +96,14 @@ http {
|
|||||||
include /etc/nginx/fastcgi_params;
|
include /etc/nginx/fastcgi_params;
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
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
|
# Redirect www. to non-www
|
||||||
server {
|
server {
|
||||||
listen 127.0.0.1:8443 ssl;
|
listen 8443 ssl;
|
||||||
|
{% if not disable_ipv6 %}
|
||||||
|
listen [::]:8443 ssl;
|
||||||
|
{% endif %}
|
||||||
server_name www.{{ config.domain_name }};
|
server_name www.{{ config.domain_name }};
|
||||||
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
access_log syslog:server=unix:/dev/log,facility=local7;
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
[Service]
|
|
||||||
Restart=always
|
|
||||||
RuntimeMaxSec=1d
|
|
||||||
@@ -20,12 +20,9 @@ smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
|||||||
smtpd_tls_security_level=may
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
smtp_tls_security_level=verify
|
smtp_tls_security_level=may
|
||||||
# Send SNI extension when connecting to other servers.
|
|
||||||
# <https://www.postfix.org/postconf.5.html#smtp_tls_servername>
|
|
||||||
smtp_tls_servername = hostname
|
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
smtp_tls_policy_maps = inline:{nauta.cu=may}
|
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
||||||
smtpd_tls_protocols = >=TLSv1.2
|
smtpd_tls_protocols = >=TLSv1.2
|
||||||
|
|
||||||
# Disable anonymous cipher suites
|
# Disable anonymous cipher suites
|
||||||
|
|||||||
@@ -14,11 +14,10 @@ smtp inet n - y - - smtpd -v
|
|||||||
{%- else %}
|
{%- else %}
|
||||||
smtp inet n - y - - smtpd
|
smtp inet n - y - - smtpd
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port_incoming }}
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
submission inet n - y - 5000 smtpd
|
submission inet n - y - 5000 smtpd
|
||||||
-o syslog_name=postfix/submission
|
-o syslog_name=postfix/submission
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
-o smtpd_tls_mandatory_protocols=>=TLSv1.3
|
|
||||||
-o smtpd_sasl_auth_enable=yes
|
-o smtpd_sasl_auth_enable=yes
|
||||||
-o smtpd_sasl_type=dovecot
|
-o smtpd_sasl_type=dovecot
|
||||||
-o smtpd_sasl_path=private/auth
|
-o smtpd_sasl_path=private/auth
|
||||||
@@ -32,11 +31,11 @@ submission inet n - y - 5000 smtpd
|
|||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
smtps inet n - y - 5000 smtpd
|
smtps inet n - y - 5000 smtpd
|
||||||
-o syslog_name=postfix/smtps
|
-o syslog_name=postfix/smtps
|
||||||
-o smtpd_tls_wrappermode=yes
|
-o smtpd_tls_wrappermode=yes
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
-o smtpd_tls_mandatory_protocols=>=TLSv1.3
|
|
||||||
-o smtpd_sasl_auth_enable=yes
|
-o smtpd_sasl_auth_enable=yes
|
||||||
-o smtpd_sasl_type=dovecot
|
-o smtpd_sasl_type=dovecot
|
||||||
-o smtpd_sasl_path=private/auth
|
-o smtpd_sasl_path=private/auth
|
||||||
@@ -49,6 +48,7 @@ smtps inet n - y - 5000 smtpd
|
|||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
#628 inet n - y - - qmqpd
|
#628 inet n - y - - qmqpd
|
||||||
pickup unix n - y 60 1 pickup
|
pickup unix n - y 60 1 pickup
|
||||||
cleanup unix n - y - 0 cleanup
|
cleanup unix n - y - 0 cleanup
|
||||||
@@ -76,27 +76,17 @@ anvil unix - - y - 1 anvil
|
|||||||
scache unix - - y - 1 scache
|
scache unix - - y - 1 scache
|
||||||
postlog unix-dgram n - n - 1 postlogd
|
postlog unix-dgram n - n - 1 postlogd
|
||||||
filter unix - n n - - lmtp
|
filter unix - n n - - lmtp
|
||||||
# Local SMTP server for reinjecting outgoing filtered mail.
|
# Local SMTP server for reinjecting filered mail.
|
||||||
127.0.0.1:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
||||||
-o syslog_name=postfix/reinject
|
-o syslog_name=postfix/reinject
|
||||||
-o smtpd_milters=unix:opendkim/opendkim.sock
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
-o cleanup_service_name=authclean
|
-o cleanup_service_name=authclean
|
||||||
|
|
||||||
# Local SMTP server for reinjecting incoming filtered mail
|
|
||||||
127.0.0.1:{{ config.postfix_reinject_port_incoming }} inet n - n - 10 smtpd
|
|
||||||
-o syslog_name=postfix/reinject_incoming
|
|
||||||
-o smtpd_milters=unix:opendkim/opendkim.sock
|
|
||||||
|
|
||||||
# Cleanup `Received` headers for authenticated mail
|
# Cleanup `Received` headers for authenticated mail
|
||||||
# to avoid leaking client IP.
|
# to avoid leaking client IP.
|
||||||
#
|
#
|
||||||
# We do not do this for received mails
|
# We do not do this for received mails
|
||||||
# as this will break DKIM signatures
|
# as this will break DKIM signatures
|
||||||
# if `Received` header is signed.
|
# if `Received` header is signed.
|
||||||
#
|
|
||||||
# This service also rewrites
|
|
||||||
# Subject with `[...]`
|
|
||||||
# to make sure the users
|
|
||||||
# cannot send unprotected Subject.
|
|
||||||
authclean unix n - - - 0 cleanup
|
authclean unix n - - - 0 cleanup
|
||||||
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
||||||
|
|||||||
@@ -2,4 +2,3 @@
|
|||||||
/^X-Originating-IP:/ IGNORE
|
/^X-Originating-IP:/ IGNORE
|
||||||
/^X-Mailer:/ IGNORE
|
/^X-Mailer:/ IGNORE
|
||||||
/^User-Agent:/ IGNORE
|
/^User-Agent:/ IGNORE
|
||||||
/^Subject:/ REPLACE Subject: [...]
|
|
||||||
|
|||||||
@@ -20,20 +20,19 @@ def perform_initial_checks(mail_domain):
|
|||||||
assert mail_domain
|
assert mail_domain
|
||||||
if not shell("dig", fail_ok=True):
|
if not shell("dig", fail_ok=True):
|
||||||
shell("apt-get install -y dnsutils")
|
shell("apt-get install -y dnsutils")
|
||||||
|
shell(f"unbound-control flush_zone {mail_domain}", fail_ok=True)
|
||||||
A = query_dns("A", mail_domain)
|
A = query_dns("A", mail_domain)
|
||||||
AAAA = query_dns("AAAA", mail_domain)
|
AAAA = query_dns("AAAA", mail_domain)
|
||||||
MTA_STS = query_dns("CNAME", f"mta-sts.{mail_domain}")
|
MTA_STS = query_dns("CNAME", f"mta-sts.{mail_domain}")
|
||||||
WWW = query_dns("CNAME", f"www.{mail_domain}")
|
WWW = query_dns("CNAME", f"www.{mail_domain}")
|
||||||
|
|
||||||
res = dict(mail_domain=mail_domain, A=A, AAAA=AAAA, MTA_STS=MTA_STS, WWW=WWW)
|
res = dict(mail_domain=mail_domain, A=A, AAAA=AAAA, MTA_STS=MTA_STS, WWW=WWW)
|
||||||
res["acme_account_url"] = shell("acmetool account-url", fail_ok=True)
|
|
||||||
res["dkim_entry"], res["web_dkim_entry"] = get_dkim_entry(
|
|
||||||
mail_domain, dkim_selector="opendkim"
|
|
||||||
)
|
|
||||||
|
|
||||||
if not MTA_STS or not WWW or (not A and not AAAA):
|
if not MTA_STS or not WWW or (not A and not AAAA):
|
||||||
return res
|
return res
|
||||||
|
|
||||||
|
res["acme_account_url"] = shell("acmetool account-url", fail_ok=True)
|
||||||
|
res["dkim_entry"] = get_dkim_entry(mail_domain, dkim_selector="opendkim")
|
||||||
|
|
||||||
# parse out sts-id if exists, example: "v=STSv1; id=2090123"
|
# parse out sts-id if exists, example: "v=STSv1; id=2090123"
|
||||||
parts = query_dns("TXT", f"_mta-sts.{mail_domain}").split("id=")
|
parts = query_dns("TXT", f"_mta-sts.{mail_domain}").split("id=")
|
||||||
res["sts_id"] = parts[1].rstrip('"') if len(parts) == 2 else ""
|
res["sts_id"] = parts[1].rstrip('"') if len(parts) == 2 else ""
|
||||||
@@ -50,28 +49,12 @@ def get_dkim_entry(mail_domain, dkim_selector):
|
|||||||
return
|
return
|
||||||
dkim_value_raw = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
dkim_value_raw = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
||||||
dkim_value = '" "'.join(re.findall(".{1,255}", dkim_value_raw))
|
dkim_value = '" "'.join(re.findall(".{1,255}", dkim_value_raw))
|
||||||
web_dkim_value = "".join(re.findall(".{1,255}", dkim_value_raw))
|
return f'{dkim_selector}._domainkey.{mail_domain}. TXT "{dkim_value}"'
|
||||||
return (
|
|
||||||
f'{dkim_selector}._domainkey.{mail_domain}. TXT "{dkim_value}"',
|
|
||||||
f'{dkim_selector}._domainkey.{mail_domain}. TXT "{web_dkim_value}"',
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def query_dns(typ, domain):
|
def query_dns(typ, domain):
|
||||||
# Get autoritative nameserver from the SOA record.
|
res = shell(f"dig -r -q {domain} -t {typ} +short")
|
||||||
soa_answers = [
|
print(res)
|
||||||
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:
|
if res:
|
||||||
return res.split("\n")[0]
|
return res.split("\n")[0]
|
||||||
return ""
|
return ""
|
||||||
@@ -79,6 +62,7 @@ def query_dns(typ, domain):
|
|||||||
|
|
||||||
def check_zonefile(zonefile, mail_domain):
|
def check_zonefile(zonefile, mail_domain):
|
||||||
"""Check expected zone file entries."""
|
"""Check expected zone file entries."""
|
||||||
|
shell(f"unbound-control flush_zone {mail_domain}", fail_ok=True)
|
||||||
required = True
|
required = True
|
||||||
required_diff = []
|
required_diff = []
|
||||||
recommended_diff = []
|
recommended_diff = []
|
||||||
|
|||||||
@@ -1,13 +1,10 @@
|
|||||||
from subprocess import DEVNULL, CalledProcessError, check_output
|
from subprocess import CalledProcessError, check_output
|
||||||
|
|
||||||
|
|
||||||
def shell(command, fail_ok=False):
|
def shell(command, fail_ok=False):
|
||||||
print(f"$ {command}")
|
print(f"$ {command}")
|
||||||
args = dict(shell=True)
|
|
||||||
if fail_ok:
|
|
||||||
args["stderr"] = DEVNULL
|
|
||||||
try:
|
try:
|
||||||
return check_output(command, **args).decode().rstrip()
|
return check_output(command, shell=True).decode().rstrip()
|
||||||
except CalledProcessError:
|
except CalledProcessError:
|
||||||
if not fail_ok:
|
if not fail_ok:
|
||||||
raise
|
raise
|
||||||
@@ -17,22 +14,3 @@ def shell(command, fail_ok=False):
|
|||||||
def get_systemd_running():
|
def get_systemd_running():
|
||||||
lines = shell("systemctl --type=service --state=running").split("\n")
|
lines = shell("systemctl --type=service --state=running").split("\n")
|
||||||
return [line for line in lines if line.startswith(" ")]
|
return [line for line in lines if line.startswith(" ")]
|
||||||
|
|
||||||
|
|
||||||
def write_numbytes(path, num):
|
|
||||||
with open(path, "w") as f:
|
|
||||||
f.write("x" * num)
|
|
||||||
|
|
||||||
|
|
||||||
def dovecot_recalc_quota(user):
|
|
||||||
shell(f"doveadm quota recalc -u {user}")
|
|
||||||
output = shell(f"doveadm quota get -u {user}")
|
|
||||||
#
|
|
||||||
# Quota name Type Value Limit %
|
|
||||||
# User quota STORAGE 5 102400 0
|
|
||||||
# User quota MESSAGE 2 - 0
|
|
||||||
#
|
|
||||||
for line in output.split("\n"):
|
|
||||||
parts = line.split()
|
|
||||||
if parts[2] == "STORAGE":
|
|
||||||
return dict(value=int(parts[3]), limit=int(parts[4]), percent=int(parts[5]))
|
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ Restart=always
|
|||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=vmail
|
User=vmail
|
||||||
RuntimeDirectory=chatmail-metadata
|
RuntimeDirectory=chatmail-metadata
|
||||||
UMask=0077
|
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ Restart=always
|
|||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=vmail
|
User=vmail
|
||||||
RuntimeDirectory=doveauth
|
RuntimeDirectory=doveauth
|
||||||
UMask=0077
|
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
|
|||||||
@@ -1,12 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Incoming Chatmail Postfix before queue filter
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} {config_path} incoming
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
User=vmail
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=Outgoing Chatmail Postfix before queue filter
|
Description=Chatmail Postfix before queue filter
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} {config_path} outgoing
|
ExecStart={execpath} {config_path}
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=vmail
|
User=filtermail
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ class TestDC:
|
|||||||
|
|
||||||
def test_ping_pong(self, benchmark, cmfactory):
|
def test_ping_pong(self, benchmark, cmfactory):
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_protected_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
def dc_ping_pong():
|
def dc_ping_pong():
|
||||||
chat.send_text("ping")
|
chat.send_text("ping")
|
||||||
@@ -49,7 +49,7 @@ class TestDC:
|
|||||||
|
|
||||||
def test_send_10_receive_10(self, benchmark, cmfactory, lp):
|
def test_send_10_receive_10(self, benchmark, cmfactory, lp):
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_protected_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
def dc_send_10_receive_10():
|
def dc_send_10_receive_10():
|
||||||
for i in range(10):
|
for i in range(10):
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
import datetime
|
|
||||||
import smtplib
|
import smtplib
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
@@ -53,14 +52,6 @@ class TestSSHExecutor:
|
|||||||
else:
|
else:
|
||||||
pytest.fail("didn't raise exception")
|
pytest.fail("didn't raise exception")
|
||||||
|
|
||||||
def test_opendkim_restarted(self, sshexec):
|
|
||||||
"""check that opendkim is not running for longer than a day."""
|
|
||||||
out = sshexec(call=remote.rshell.shell, kwargs=dict(command="systemctl status opendkim"))
|
|
||||||
assert type(out) == str
|
|
||||||
since_date_str = out.split("since ")[1].split(";")[0]
|
|
||||||
since_date = datetime.datetime.strptime(since_date_str, "%a %Y-%m-%d %H:%M:%S %Z")
|
|
||||||
assert (datetime.datetime.now() - since_date).total_seconds() < 60 * 60 * 24
|
|
||||||
|
|
||||||
|
|
||||||
def test_remote(remote, imap_or_smtp):
|
def test_remote(remote, imap_or_smtp):
|
||||||
lineproducer = remote.iter_output(imap_or_smtp.logcmd)
|
lineproducer = remote.iter_output(imap_or_smtp.logcmd)
|
||||||
@@ -116,34 +107,14 @@ def test_authenticated_from(cmsetup, maildata):
|
|||||||
|
|
||||||
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
||||||
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
||||||
|
"""Test that emails with missing or wrong DMARC, DKIM, and SPF entries are rejected."""
|
||||||
recipient = cmsetup.gen_users(1)[0]
|
recipient = cmsetup.gen_users(1)[0]
|
||||||
msg = maildata("encrypted.eml", from_addr=from_addr, to_addr=recipient.addr).as_string()
|
msg = maildata("plain.eml", from_addr=from_addr, to_addr=recipient.addr).as_string()
|
||||||
with smtplib.SMTP(cmsetup.maildomain, 25) as s:
|
with smtplib.SMTP(cmsetup.maildomain, 25) as s:
|
||||||
with pytest.raises(smtplib.SMTPDataError, match="No valid DKIM signature"):
|
with pytest.raises(smtplib.SMTPDataError, match="No valid DKIM signature"):
|
||||||
s.sendmail(from_addr=from_addr, to_addrs=recipient.addr, msg=msg)
|
s.sendmail(from_addr=from_addr, to_addrs=recipient.addr, msg=msg)
|
||||||
|
|
||||||
|
|
||||||
def test_rewrite_subject(cmsetup, maildata):
|
|
||||||
"""Test that subject gets replaced with [...]."""
|
|
||||||
user1, user2 = cmsetup.gen_users(2)
|
|
||||||
|
|
||||||
sent_msg = maildata(
|
|
||||||
"encrypted.eml",
|
|
||||||
from_addr=user1.addr,
|
|
||||||
to_addr=user2.addr,
|
|
||||||
subject="Unencrypted subject",
|
|
||||||
).as_string()
|
|
||||||
user1.smtp.sendmail(from_addr=user1.addr, to_addrs=[user2.addr], msg=sent_msg)
|
|
||||||
|
|
||||||
messages = user2.imap.fetch_all_messages()
|
|
||||||
assert len(messages) == 1
|
|
||||||
rcvd_msg = messages[0]
|
|
||||||
assert "Subject: [...]" not in sent_msg
|
|
||||||
assert "Subject: [...]" in rcvd_msg
|
|
||||||
assert "Subject: Unencrypted subject" in sent_msg
|
|
||||||
assert "Subject: Unencrypted subject" not in rcvd_msg
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.slow
|
@pytest.mark.slow
|
||||||
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
||||||
"""Test that the per-account send-mail limit is exceeded."""
|
"""Test that the per-account send-mail limit is exceeded."""
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
import ipaddress
|
import ipaddress
|
||||||
|
import random
|
||||||
import re
|
import re
|
||||||
import time
|
import time
|
||||||
|
|
||||||
@@ -6,9 +7,6 @@ import imap_tools
|
|||||||
import pytest
|
import pytest
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from cmdeploy.remote import rshell
|
|
||||||
from cmdeploy.sshexec import SSHExec
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def imap_mailbox(cmfactory):
|
def imap_mailbox(cmfactory):
|
||||||
@@ -56,23 +54,22 @@ class TestEndToEndDeltaChat:
|
|||||||
"""Test that a DC account can send a message to a second DC account
|
"""Test that a DC account can send a message to a second DC account
|
||||||
on the same chat-mail instance."""
|
on the same chat-mail instance."""
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_protected_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
|
lp.sec("ac1: prepare and send text message to ac2")
|
||||||
chat.send_text("message0")
|
chat.send_text("message0")
|
||||||
|
|
||||||
lp.sec("wait for ac2 to receive message")
|
lp.sec("wait for ac2 to receive message")
|
||||||
msg2 = ac2._evtracker.wait_next_incoming_message()
|
msg2 = ac2._evtracker.wait_next_incoming_message()
|
||||||
assert msg2.text == "message0"
|
assert msg2.text == "message0"
|
||||||
|
|
||||||
def test_exceed_quota(
|
@pytest.mark.slow
|
||||||
self, cmfactory, lp, tmpdir, remote, chatmail_config, sshdomain
|
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote, chatmail_config):
|
||||||
):
|
|
||||||
"""This is a very slow test as it needs to upload >100MB of mail data
|
"""This is a very slow test as it needs to upload >100MB of mail data
|
||||||
before quota is exceeded, and thus depends on the speed of the upload.
|
before quota is exceeded, and thus depends on the speed of the upload.
|
||||||
"""
|
"""
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_protected_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
user = ac2.get_config("configured_addr")
|
|
||||||
|
|
||||||
def parse_size_limit(limit: str) -> int:
|
def parse_size_limit(limit: str) -> int:
|
||||||
"""Parse a size limit and return the number of bytes as integer.
|
"""Parse a size limit and return the number of bytes as integer.
|
||||||
@@ -85,27 +82,49 @@ class TestEndToEndDeltaChat:
|
|||||||
return int(float(number) * units[unit])
|
return int(float(number) * units[unit])
|
||||||
|
|
||||||
quota = parse_size_limit(chatmail_config.max_mailbox_size)
|
quota = parse_size_limit(chatmail_config.max_mailbox_size)
|
||||||
|
attachsize = 1 * 1024 * 1024
|
||||||
|
num_to_send = quota // attachsize + 2
|
||||||
|
lp.sec(f"ac1: send {num_to_send} large files to ac2")
|
||||||
|
lp.indent(f"per-user quota is assumed to be: {quota/(1024*1024)}MB")
|
||||||
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
|
msgs = []
|
||||||
|
for i in range(num_to_send):
|
||||||
|
attachment = tmpdir / f"attachment{i}"
|
||||||
|
data = "".join(random.choice(alphanumeric) for i in range(1024))
|
||||||
|
with open(attachment, "w+") as f:
|
||||||
|
for j in range(attachsize // len(data)):
|
||||||
|
f.write(data)
|
||||||
|
|
||||||
lp.sec(f"filling remote inbox for {user}")
|
msg = chat.send_file(str(attachment))
|
||||||
fn = f"7743102289.M843172P2484002.c20,S={quota},W=2398:2,"
|
msgs.append(msg)
|
||||||
path = chatmail_config.mailboxes_dir.joinpath(user, "cur", fn)
|
lp.indent(f"Sent out msg {i}, size {attachsize/(1024*1024)}MB")
|
||||||
sshexec = SSHExec(sshdomain)
|
|
||||||
sshexec(call=rshell.write_numbytes, kwargs=dict(path=str(path), num=120))
|
|
||||||
res = sshexec(call=rshell.dovecot_recalc_quota, kwargs=dict(user=user))
|
|
||||||
assert res["percent"] >= 100
|
|
||||||
|
|
||||||
lp.sec("ac2: check quota is triggered")
|
lp.sec("ac2: check messages are arriving until quota is reached")
|
||||||
|
|
||||||
starting = True
|
addr = ac2.get_config("addr").lower()
|
||||||
|
saved_ok = 0
|
||||||
for line in remote.iter_output("journalctl -n0 -f -u dovecot"):
|
for line in remote.iter_output("journalctl -n0 -f -u dovecot"):
|
||||||
if starting:
|
if addr not in line:
|
||||||
chat.send_text("hello")
|
|
||||||
starting = False
|
|
||||||
if user not in line:
|
|
||||||
# print(line)
|
# print(line)
|
||||||
continue
|
continue
|
||||||
if "quota exceeded" in line:
|
if "quota" in line:
|
||||||
return
|
if "quota exceeded" in line:
|
||||||
|
if saved_ok < num_to_send // 2:
|
||||||
|
pytest.fail(
|
||||||
|
f"quota exceeded too early: after {saved_ok} messages already"
|
||||||
|
)
|
||||||
|
lp.indent("good, message sending failed because quota was exceeded")
|
||||||
|
return
|
||||||
|
if (
|
||||||
|
"stored mail into mailbox 'inbox'" in line
|
||||||
|
or "saved mail to inbox" in line
|
||||||
|
):
|
||||||
|
saved_ok += 1
|
||||||
|
print(f"{saved_ok}: {line}")
|
||||||
|
if saved_ok >= num_to_send:
|
||||||
|
break
|
||||||
|
|
||||||
|
pytest.fail("sending succeeded although messages should exceed quota")
|
||||||
|
|
||||||
def test_securejoin(self, cmfactory, lp, maildomain2):
|
def test_securejoin(self, cmfactory, lp, maildomain2):
|
||||||
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
@@ -153,7 +172,7 @@ def test_hide_senders_ip_address(cmfactory):
|
|||||||
assert ipaddress.ip_address(public_ip)
|
assert ipaddress.ip_address(public_ip)
|
||||||
|
|
||||||
user1, user2 = cmfactory.get_online_accounts(2)
|
user1, user2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_protected_chat(user1, user2)
|
chat = cmfactory.get_accepted_chat(user1, user2)
|
||||||
|
|
||||||
chat.send_text("testing submission header cleanup")
|
chat.send_text("testing submission header cleanup")
|
||||||
user2._evtracker.wait_next_incoming_message()
|
user2._evtracker.wait_next_incoming_message()
|
||||||
@@ -162,18 +181,11 @@ def test_hide_senders_ip_address(cmfactory):
|
|||||||
assert public_ip not in msg.obj.as_string()
|
assert public_ip not in msg.obj.as_string()
|
||||||
|
|
||||||
|
|
||||||
def test_echobot(cmfactory, chatmail_config, lp, sshdomain):
|
def test_echobot(cmfactory, chatmail_config, lp):
|
||||||
ac = cmfactory.get_online_accounts(1)[0]
|
ac = cmfactory.get_online_accounts(1)[0]
|
||||||
|
|
||||||
# establish contact with echobot
|
lp.sec(f"Send message to echo@{chatmail_config.mail_domain}")
|
||||||
sshexec = SSHExec(sshdomain)
|
chat = ac.create_chat(f"echo@{chatmail_config.mail_domain}")
|
||||||
command = "cat /var/lib/echobot/invite-link.txt"
|
|
||||||
echo_invite_link = sshexec(call=rshell.shell, kwargs=dict(command=command))
|
|
||||||
chat = ac.qr_setup_contact(echo_invite_link)
|
|
||||||
ac._evtracker.wait_securejoin_joiner_progress(1000)
|
|
||||||
|
|
||||||
# send message and check it gets replied back
|
|
||||||
lp.sec("Send message to echobot")
|
|
||||||
text = "hi, I hope you text me back"
|
text = "hi, I hope you text me back"
|
||||||
chat.send_text(text)
|
chat.send_text(text)
|
||||||
lp.sec("Wait for reply from echobot")
|
lp.sec("Wait for reply from echobot")
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ def sshdomain(maildomain):
|
|||||||
def maildomain2():
|
def maildomain2():
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN2")
|
domain = os.environ.get("CHATMAIL_DOMAIN2")
|
||||||
if not domain:
|
if not domain:
|
||||||
pytest.skip("set CHATMAIL_DOMAIN2 to a second chatmail server")
|
pytest.skip("set CHATMAIL_DOMAIN2 to a ssh-reachable chatmail instance")
|
||||||
return domain
|
return domain
|
||||||
|
|
||||||
|
|
||||||
@@ -302,12 +302,10 @@ def cmfactory(request, gencreds, tmpdir, maildomain):
|
|||||||
pytest.importorskip("deltachat")
|
pytest.importorskip("deltachat")
|
||||||
from deltachat.testplugin import ACFactory
|
from deltachat.testplugin import ACFactory
|
||||||
|
|
||||||
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
data = request.getfixturevalue("data")
|
||||||
|
|
||||||
class Data:
|
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
||||||
def read_path(self, path):
|
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
||||||
return
|
|
||||||
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=Data())
|
|
||||||
|
|
||||||
# nb. a bit hacky
|
# nb. a bit hacky
|
||||||
# would probably be better if deltachat's test machinery grows native support
|
# would probably be better if deltachat's test machinery grows native support
|
||||||
|
|||||||
@@ -6,6 +6,29 @@ interoperable e-mail service for everyone. What's behind a `chatmail` is
|
|||||||
effectively a normal e-mail address just like any other but optimized
|
effectively a normal e-mail address just like any other but optimized
|
||||||
for the usage in chats, especially DeltaChat.
|
for the usage in chats, especially DeltaChat.
|
||||||
|
|
||||||
|
### Choosing a chatmail address instead of using a random one
|
||||||
|
|
||||||
|
In the Delta Chat account setup you may tap `Create a profile` then `Use other server` and choose `Classic e-mail login`. Here fill the two fields like this:
|
||||||
|
|
||||||
|
- `E-Mail Address`: invent a word with
|
||||||
|
{% if username_min_length == username_max_length %}
|
||||||
|
*exactly* {{ username_min_length }}
|
||||||
|
{% else %}
|
||||||
|
{{ username_min_length}}
|
||||||
|
{% if username_max_length == "more" %}
|
||||||
|
or more
|
||||||
|
{% else %}
|
||||||
|
to {{ username_max_length }}
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
characters
|
||||||
|
and append `@{{config.mail_domain}}` to it.
|
||||||
|
|
||||||
|
- `Existing Password`: invent at least {{ password_min_length }} characters.
|
||||||
|
|
||||||
|
If the e-mail address is not yet taken, you'll get that account.
|
||||||
|
The first login sets your password.
|
||||||
|
|
||||||
|
|
||||||
### Rate and storage limits
|
### Rate and storage limits
|
||||||
|
|
||||||
@@ -15,10 +38,9 @@ for the usage in chats, especially DeltaChat.
|
|||||||
|
|
||||||
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
||||||
|
|
||||||
- You can store up to [{{ config.max_mailbox_size }} messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server).
|
- Messages are unconditionally removed {{ config.delete_mails_after }} days after arriving on the server.
|
||||||
|
|
||||||
- Messages are unconditionally removed latest {{ config.delete_mails_after }} days after arriving on the server.
|
- You can store up to [{{ config.max_mailbox_size }} messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server).
|
||||||
Earlier, if storage may exceed otherwise.
|
|
||||||
|
|
||||||
|
|
||||||
### <a name="account-deletion"></a> Account deletion
|
### <a name="account-deletion"></a> Account deletion
|
||||||
|
|||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
{% if config.mail_domain == "nine.testrun.org" %}
|
{% if config.mail_domain == "nine.testrun.org" %}
|
||||||
Welcome to `{{config.mail_domain}}`, the default chatmail onboarding server for Delta Chat users.
|
Welcome to `{{config.mail_domain}}`, the default chatmail onboarding server for Delta Chat users.
|
||||||
It is operated on the side by a small sysops team
|
It is operated on the side by a small sysops team employed by [merlinux](https://merlinux.eu),
|
||||||
on a voluntary basis.
|
an open-source R&D company also acting as the fiscal sponsor of Delta Chat app developments.
|
||||||
See [other chatmail servers](https://delta.chat/en/chatmail) for alternative server operators.
|
See [other chatmail servers](https://delta.chat/en/chatmail) for alternative server operators.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -23,22 +23,18 @@ A chatmail server behaves more like the Signal messaging server
|
|||||||
but does not know about phone numbers and securely and automatically interoperates
|
but does not know about phone numbers and securely and automatically interoperates
|
||||||
with other chatmail and classic e-mail servers.
|
with other chatmail and classic e-mail servers.
|
||||||
|
|
||||||
Unlike classic e-mail servers, this chatmail server
|
In particular, this chatmail server
|
||||||
|
|
||||||
- unconditionally removes messages after {{ config.delete_mails_after }} days,
|
- unconditionally removes messages after {{ config.delete_mails_after }} days,
|
||||||
|
|
||||||
- prohibits sending out un-encrypted messages,
|
- prohibits sending out un-encrypted messages,
|
||||||
|
|
||||||
- does not store Internet addresses ("IP addresses"),
|
- only has temporary log files used for debugging purposes.
|
||||||
|
|
||||||
- does not process IP addresses in relation to email addresses.
|
|
||||||
|
|
||||||
Due to the resulting lack of personal data processing
|
|
||||||
this chatmail server may not require a privacy policy.
|
|
||||||
|
|
||||||
Nevertheless, we provide legal details below to make life easier
|
|
||||||
for data protection specialists and lawyers scrutinizing chatmail operations.
|
|
||||||
|
|
||||||
|
Legally, authorities might still regard chatmail as a "classic e-mail" server
|
||||||
|
which collects and retains personal data.
|
||||||
|
We do not agree on this interpretation. Nevertheless, we provide more legal details below
|
||||||
|
to make life easier for data protection specialists and lawyers scrutinizing chatmail operations.
|
||||||
|
|
||||||
|
|
||||||
## 1. Name and contact information
|
## 1. Name and contact information
|
||||||
@@ -58,18 +54,18 @@ We have appointed a data protection officer:
|
|||||||
|
|
||||||
## 2. Processing when using chat e-mail services
|
## 2. Processing when using chat e-mail services
|
||||||
|
|
||||||
We provide services optimized for the use from [Delta Chat](https://delta.chat) apps
|
We provide e-mail services optimized for the use from [Delta Chat](https://delta.chat) apps
|
||||||
and process only the data necessary
|
and process only the data necessary
|
||||||
for the setup and technical execution of message delivery.
|
for the setup and technical execution of the e-mail dispatch.
|
||||||
The purpose of the processing is that users can
|
The purpose of the processing is to
|
||||||
read, write, manage, delete, send, and receive chat messages.
|
read, write, manage, delete, send, and receive emails.
|
||||||
For this purpose,
|
For this purpose,
|
||||||
we operate server-side software
|
we operate server-side software
|
||||||
that enables us to send and receive messages.
|
that enables us to send and receive e-mail messages.
|
||||||
|
Allowing the use of the e-mail service,
|
||||||
|
we process the following data and details:
|
||||||
|
|
||||||
We process the following data and details:
|
- Outgoing and incoming messages (SMTP) are stored for transit
|
||||||
|
|
||||||
- Outgoing and incoming messages (SMTP) are stored for transit
|
|
||||||
on behalf of their users until the message can be delivered.
|
on behalf of their users until the message can be delivered.
|
||||||
|
|
||||||
- E-Mail-Messages are stored for the recipient and made accessible via IMAP protocols,
|
- E-Mail-Messages are stored for the recipient and made accessible via IMAP protocols,
|
||||||
@@ -78,15 +74,9 @@ We process the following data and details:
|
|||||||
|
|
||||||
- IMAP and SMTP protocols are password protected with unique credentials for each account.
|
- IMAP and SMTP protocols are password protected with unique credentials for each account.
|
||||||
|
|
||||||
- Users can retrieve or delete all stored messages
|
- Users can retrieve or delete all stored messages
|
||||||
without intervention from the operators using standard IMAP client tools.
|
without intervention from the operators using standard IMAP client tools.
|
||||||
|
|
||||||
- Users can connect to a "realtime relay service"
|
|
||||||
to establish Peer-to-Peer connection between user devices,
|
|
||||||
allowing them to send and retrieve ephemeral messages
|
|
||||||
which are never stored on the chatmail server, also not in encrypted form.
|
|
||||||
|
|
||||||
|
|
||||||
### 2.1 Account setup
|
### 2.1 Account setup
|
||||||
|
|
||||||
Creating an account happens in one of two ways on our mail servers:
|
Creating an account happens in one of two ways on our mail servers:
|
||||||
@@ -263,7 +253,7 @@ is the `{{ config.privacy_supervisor }}`.
|
|||||||
## 6. Validity of this privacy policy
|
## 6. Validity of this privacy policy
|
||||||
|
|
||||||
This data protection declaration is valid
|
This data protection declaration is valid
|
||||||
as of *October 2024*.
|
as of *December 2023*.
|
||||||
Due to the further development of our service and offers
|
Due to the further development of our service and offers
|
||||||
or due to changed legal or official requirements,
|
or due to changed legal or official requirements,
|
||||||
it may become necessary to revise this data protection declaration from time to time.
|
it may become necessary to revise this data protection declaration from time to time.
|
||||||
|
|||||||
Reference in New Issue
Block a user