mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
Compare commits
164 Commits
1.5.0
...
invite-onl
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4a7b425958 | ||
|
|
cb87c85c03 | ||
|
|
5b4eb1701e | ||
|
|
f578704069 | ||
|
|
7319977527 | ||
|
|
7dcd109bec | ||
|
|
6940175b06 | ||
|
|
de139bde18 | ||
|
|
a92c9ff275 | ||
|
|
1afdab7b20 | ||
|
|
56cbd6f35b | ||
|
|
7bf2dfd62e | ||
|
|
b801838b69 | ||
|
|
abd50e20ed | ||
|
|
d6fb38750a | ||
|
|
3b73457de3 | ||
|
|
ba06a4ff70 | ||
|
|
7fdaffe829 | ||
|
|
73831c74d9 | ||
|
|
d8cbe9d6af | ||
|
|
180ddb8168 | ||
|
|
a1eeea4632 | ||
|
|
a49aa0e655 | ||
|
|
7e81495b51 | ||
|
|
6fde062613 | ||
|
|
84e0376762 | ||
|
|
d690c22c06 | ||
|
|
5410c1bebc | ||
|
|
915bd39dd5 | ||
|
|
2de8b155c2 | ||
|
|
c975aa3bd1 | ||
|
|
6b73f6933a | ||
|
|
3ce350de9e | ||
|
|
1e05974970 | ||
|
|
577c04d537 | ||
|
|
d880937d44 | ||
|
|
46d2334e9c | ||
|
|
0ba94dc613 | ||
|
|
d379feea4f | ||
|
|
e82abee1b9 | ||
|
|
94060ff254 | ||
|
|
1b5cbfbc3d | ||
|
|
f1dcecaa8f | ||
|
|
650338925a | ||
|
|
44f653ccca | ||
|
|
6c686da937 | ||
|
|
387532cfca | ||
|
|
68904f8f61 | ||
|
|
740fe8b146 | ||
|
|
162dc85635 | ||
|
|
b699be3ac8 | ||
|
|
b4122beec4 | ||
|
|
1596b2517c | ||
|
|
1f5b2e947c | ||
|
|
8a59d94105 | ||
|
|
96a1dbac08 | ||
|
|
5215e1dc2b | ||
|
|
624a33a61e | ||
|
|
6bc751213f | ||
|
|
4b721bfcd4 | ||
|
|
4a6aa446cd | ||
|
|
e0140bbad5 | ||
|
|
6cede707ac | ||
|
|
b27937a16d | ||
|
|
30b6df20a9 | ||
|
|
6c27eaa506 | ||
|
|
0c28310861 | ||
|
|
0125dda6d7 | ||
|
|
fe38fcbeba | ||
|
|
b4af6df55c | ||
|
|
15244f6462 | ||
|
|
23655df08a | ||
|
|
b925f3b5ab | ||
|
|
823bc90eb1 | ||
|
|
ed93678c9d | ||
|
|
2b4e18d16f | ||
|
|
09ff56e5b9 | ||
|
|
b35e84e479 | ||
|
|
0638bea363 | ||
|
|
ab9ec98bcc | ||
|
|
b9a4471ee4 | ||
|
|
5f29c53232 | ||
|
|
1d4aa3d205 | ||
|
|
a78c903521 | ||
|
|
a0a1dd65a6 | ||
|
|
046552061e | ||
|
|
1fba4a3cdf | ||
|
|
44ff6da5d2 | ||
|
|
71160b8f65 | ||
|
|
9f74d0a608 | ||
|
|
c9078d7c92 | ||
|
|
aa4259477f | ||
|
|
21f9885ffe | ||
|
|
f9e885c442 | ||
|
|
b45be700a8 | ||
|
|
9c381e1fbf | ||
|
|
3cc9bc3ceb | ||
|
|
2a89be8209 | ||
|
|
c848b61346 | ||
|
|
49787044ff | ||
|
|
04ae0b86fb | ||
|
|
b0434dc927 | ||
|
|
7578c5f1d3 | ||
|
|
5ba99dc782 | ||
|
|
6d898d5431 | ||
|
|
fc3fb93432 | ||
|
|
c4f0146e16 | ||
|
|
194030a456 | ||
|
|
ce240083c4 | ||
|
|
0722876603 | ||
|
|
724020ec2a | ||
|
|
b01348d313 | ||
|
|
46e31bbce3 | ||
|
|
a4f4627a75 | ||
|
|
8d34e036ec | ||
|
|
e004a5e2f6 | ||
|
|
acf6e862d0 | ||
|
|
31faf2c78e | ||
|
|
f8c28d8b9f | ||
|
|
f69a2355f6 | ||
|
|
388c01105c | ||
|
|
f8996e1d7d | ||
|
|
6b3d5025d9 | ||
|
|
ed271189d2 | ||
|
|
65f8a9a652 | ||
|
|
6c5b9fde1f | ||
|
|
258436442f | ||
|
|
05a32efa50 | ||
|
|
1142d06fdb | ||
|
|
35fe189be7 | ||
|
|
a78e8e10d2 | ||
|
|
9af37ccfbf | ||
|
|
803f3e6181 | ||
|
|
f188aef11e | ||
|
|
76d7e60018 | ||
|
|
fe749159e4 | ||
|
|
3c3532a292 | ||
|
|
710ca0070f | ||
|
|
4038fefefd | ||
|
|
cdcdc0b724 | ||
|
|
2313093b55 | ||
|
|
3f2ec54725 | ||
|
|
e928a33f95 | ||
|
|
2780f53d3b | ||
|
|
c3f1bdca52 | ||
|
|
f4e371676b | ||
|
|
8ec6e6e985 | ||
|
|
f4fc1a3f93 | ||
|
|
42bfb9f22f | ||
|
|
1a35cdc7a9 | ||
|
|
2daac76574 | ||
|
|
5633582d31 | ||
|
|
667a987dfc | ||
|
|
49907c78a3 | ||
|
|
5cfdb0698f | ||
|
|
7e6f8ddfba | ||
|
|
4d915f9800 | ||
|
|
9e6ba1a164 | ||
|
|
20f76c83f8 | ||
|
|
b2995551a2 | ||
|
|
c8f46147e0 | ||
|
|
9f6ea8121c | ||
|
|
9c08cbfbec | ||
|
|
c3190dd51a |
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
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:
|
||||||
|
- chatmail/relay version: `git rev-parse HEAD`
|
||||||
|
|
||||||
|
## 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
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
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.
|
||||||
4
.github/workflows/ci.yaml
vendored
4
.github/workflows/ci.yaml
vendored
@@ -10,6 +10,10 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
# Checkout pull request HEAD commit instead of merge commit
|
||||||
|
# Otherwise `test_deployed_state` will be unhappy.
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
|
|||||||
@@ -17,5 +17,4 @@ $TTL 300
|
|||||||
;; DNS records.
|
;; DNS records.
|
||||||
@ IN A 37.27.95.249
|
@ IN A 37.27.95.249
|
||||||
mta-sts.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
mta-sts.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
||||||
iroh.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
|
||||||
www.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
www.staging-ipv4.testrun.org. CNAME staging-ipv4.testrun.org.
|
||||||
|
|||||||
@@ -17,6 +17,5 @@ $TTL 300
|
|||||||
;; DNS records.
|
;; DNS records.
|
||||||
@ IN A 37.27.24.139
|
@ IN A 37.27.24.139
|
||||||
mta-sts.staging2.testrun.org. CNAME staging2.testrun.org.
|
mta-sts.staging2.testrun.org. CNAME staging2.testrun.org.
|
||||||
iroh.staging2.testrun.org. CNAME staging2.testrun.org.
|
|
||||||
www.staging2.testrun.org. CNAME staging2.testrun.org.
|
www.staging2.testrun.org. CNAME staging2.testrun.org.
|
||||||
|
|
||||||
|
|||||||
17
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
17
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
@@ -38,8 +38,8 @@ 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 .github/workflows/staging-ipv4.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging-ipv4.testrun.org.zone
|
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 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
|
||||||
|
|
||||||
@@ -49,7 +49,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_SERVER_ID }}/actions/rebuild"
|
"https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_IPV4_SERVER_ID }}/actions/rebuild"
|
||||||
|
|
||||||
- run: scripts/initenv.sh
|
- run: scripts/initenv.sh
|
||||||
|
|
||||||
@@ -63,16 +63,13 @@ 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-restore || true
|
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme-ipv4/acme acme-restore || true
|
||||||
rsync -avz root@ns.testrun.org:/tmp/dkimkeys-ipv4 dkimkeys-restore || true
|
rsync -avz root@ns.testrun.org:/tmp/dkimkeys-ipv4/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-ipv4/acme root@staging-ipv4.testrun.org:/var/lib/ || true
|
rsync -avz acme-restore/acme root@staging-ipv4.testrun.org:/var/lib/ || true
|
||||||
rsync -avz dkimkeys-restore/dkimkeys-ipv4/dkimkeys root@staging-ipv4.testrun.org:/etc/ || true
|
rsync -avz dkimkeys-restore/dkimkeys root@staging-ipv4.testrun.org:/etc/ || true
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
- name: run formatting checks
|
|
||||||
run: cmdeploy fmt -v
|
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
|||||||
3
.github/workflows/test-and-deploy.yaml
vendored
3
.github/workflows/test-and-deploy.yaml
vendored
@@ -70,9 +70,6 @@ jobs:
|
|||||||
rsync -avz dkimkeys-restore/dkimkeys root@staging2.testrun.org:/etc/ || true
|
rsync -avz dkimkeys-restore/dkimkeys root@staging2.testrun.org:/etc/ || true
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org chown root:root -R /var/lib/acme || true
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
- name: run formatting checks
|
|
||||||
run: cmdeploy fmt -v
|
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
|||||||
50
ARCHITECTURE.md
Normal file
50
ARCHITECTURE.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
This diagram shows components of the chatmail server; this is a draft
|
||||||
|
overview as of mid-August 2025:
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
graph LR;
|
||||||
|
cmdeploy --- sshd;
|
||||||
|
letsencrypt --- |80|acmetool-redirector;
|
||||||
|
acmetool-redirector --- |443|nginx-right(["`nginx
|
||||||
|
(external)`"]);
|
||||||
|
nginx-external --- |465|postfix;
|
||||||
|
nginx-external(["`nginx
|
||||||
|
(external)`"]) --- |8443|nginx-internal["`nginx
|
||||||
|
(internal)`"];
|
||||||
|
nginx-internal --- website["`Website
|
||||||
|
/var/www/html`"];
|
||||||
|
nginx-internal --- newemail.py;
|
||||||
|
nginx-internal --- autoconfig.xml;
|
||||||
|
certs-nginx[("`TLS certs
|
||||||
|
/var/lib/acme`")] --> nginx-internal;
|
||||||
|
cron --- chatmail-metrics;
|
||||||
|
cron --- acmetool;
|
||||||
|
cron --- expunge;
|
||||||
|
chatmail-metrics --- website;
|
||||||
|
acmetool --> certs[("`TLS certs
|
||||||
|
/var/lib/acme`")];
|
||||||
|
nginx-external --- |993|dovecot;
|
||||||
|
autoconfig.xml --- postfix;
|
||||||
|
autoconfig.xml --- dovecot;
|
||||||
|
postfix --- echobot;
|
||||||
|
postfix --- |10080,10081|filtermail;
|
||||||
|
postfix --- users["`User data
|
||||||
|
home/vmail/mail`"];
|
||||||
|
postfix --- |doveauth.socket|doveauth;
|
||||||
|
dovecot --- |doveauth.socket|doveauth;
|
||||||
|
dovecot --- users;
|
||||||
|
dovecot --- |metadata.socket|chatmail-metadata;
|
||||||
|
doveauth --- users;
|
||||||
|
expunge --- users;
|
||||||
|
chatmail-metadata --- iroh-relay;
|
||||||
|
certs-nginx --> postfix;
|
||||||
|
certs-nginx --> dovecot;
|
||||||
|
style certs fill:#ff6;
|
||||||
|
style certs-nginx fill:#ff6;
|
||||||
|
style nginx-external fill:#fc9;
|
||||||
|
style nginx-right fill:#fc9;
|
||||||
|
```
|
||||||
|
|
||||||
|
The edges in this graph should not be taken too literally; they
|
||||||
|
reflect some sort of communication path or dependency relationship
|
||||||
|
between components of the chatmail server.
|
||||||
295
CHANGELOG.md
295
CHANGELOG.md
@@ -2,36 +2,179 @@
|
|||||||
|
|
||||||
## untagged
|
## untagged
|
||||||
|
|
||||||
|
- Enable invite-only chatmail relays with invite tokens
|
||||||
|
that can override disabled account creation
|
||||||
|
([#600](https://github.com/chatmail/relay/pull/600))
|
||||||
|
|
||||||
|
- dovecot: keep mailbox index only in memory to avoid unnecessary disc usage
|
||||||
|
([#632](https://github.com/chatmail/relay/pull/632))
|
||||||
|
|
||||||
|
## 1.7.0 2025-09-11
|
||||||
|
|
||||||
|
- Make www upload path configurable
|
||||||
|
([#618](https://github.com/chatmail/relay/pull/618))
|
||||||
|
|
||||||
|
- Check whether GCC is installed in initenv.sh
|
||||||
|
([#608](https://github.com/chatmail/relay/pull/608))
|
||||||
|
|
||||||
|
- Expire push notification tokens after 90 days
|
||||||
|
([#583](https://github.com/chatmail/relay/pull/583))
|
||||||
|
|
||||||
|
- Use official `mtail` binary instead of `mtail` package
|
||||||
|
([#581](https://github.com/chatmail/relay/pull/581))
|
||||||
|
|
||||||
|
- dovecot: install from download.delta.chat instead of openSUSE Build Service
|
||||||
|
([#590](https://github.com/chatmail/relay/pull/590))
|
||||||
|
|
||||||
|
- Reconfigure Dovecot imap-login service to high-performance mode
|
||||||
|
([#578](https://github.com/chatmail/relay/pull/578))
|
||||||
|
|
||||||
|
- Set timezone to improve dovecot performance
|
||||||
|
([#584](https://github.com/chatmail/relay/pull/584))
|
||||||
|
|
||||||
|
- Increase nginx connection limits
|
||||||
|
([#576](https://github.com/chatmail/relay/pull/576))
|
||||||
|
|
||||||
|
- If `dns-utils` needs to be installed before cmdeploy run, apt update to make sure it works
|
||||||
|
([#560](https://github.com/chatmail/relay/pull/560))
|
||||||
|
|
||||||
|
- filtermail: respect config message size limit
|
||||||
|
([#572](https://github.com/chatmail/relay/pull/572))
|
||||||
|
|
||||||
|
- Don't deploy if one of the ports used for chatmail relay services is occupied by an unexpected process
|
||||||
|
([#568](https://github.com/chatmail/relay/pull/568))
|
||||||
|
|
||||||
|
- Add config value after how many days large files are deleted
|
||||||
|
([#555](https://github.com/chatmail/relay/pull/555))
|
||||||
|
|
||||||
|
- cmdeploy: push relay version to /etc/chatmail-version
|
||||||
|
([#573](https://github.com/chatmail/relay/pull/573))
|
||||||
|
|
||||||
|
- filtermail: allow partial body length in OpenPGP payloads
|
||||||
|
([#570](https://github.com/chatmail/relay/pull/570))
|
||||||
|
|
||||||
|
- chatmaild: allow echobot to receive unencrypted messages by default
|
||||||
|
([#556](https://github.com/chatmail/relay/pull/556))
|
||||||
|
|
||||||
|
|
||||||
|
## 1.6.0 2025-04-11
|
||||||
|
|
||||||
|
- Handle Port-25 connect errors more gracefully (common with VPNs)
|
||||||
|
([#552](https://github.com/chatmail/relay/pull/552))
|
||||||
|
|
||||||
|
- Avoid "acmetool not found" during initial run
|
||||||
|
([#550](https://github.com/chatmail/relay/pull/550))
|
||||||
|
|
||||||
|
- Fix timezone handling such that client/servers do not need to use
|
||||||
|
same timezone.
|
||||||
|
([#553](https://github.com/chatmail/relay/pull/553))
|
||||||
|
|
||||||
|
- 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))
|
||||||
|
|
||||||
|
- unbound: check that port 53 is not occupied by a different process
|
||||||
|
([#537](https://github.com/chatmail/server/pull/537))
|
||||||
|
|
||||||
|
- unbound: before unbound is there, use 9.9.9.9 for resolving
|
||||||
|
([#518](https://github.com/chatmail/relay/pull/518))
|
||||||
|
|
||||||
|
- 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
|
## 1.5.0 2024-12-20
|
||||||
|
|
||||||
- cmdeploy dns: always show recommended DNS records
|
- cmdeploy dns: always show recommended DNS records
|
||||||
([#463](https://github.com/deltachat/chatmail/pull/463))
|
([#463](https://github.com/chatmail/server/pull/463))
|
||||||
|
|
||||||
- add `--all` to `cmdeploy dns`
|
- add `--all` to `cmdeploy dns`
|
||||||
([#462](https://github.com/deltachat/chatmail/pull/462))
|
([#462](https://github.com/chatmail/server/pull/462))
|
||||||
|
|
||||||
- fix `_mta-sts` TXT DNS record
|
- fix `_mta-sts` TXT DNS record
|
||||||
([#461](https://github.com/deltachat/chatmail/pull/461)
|
([#461](https://github.com/chatmail/server/pull/461)
|
||||||
|
|
||||||
- deploy `iroh-relay` and also update "realtime relay services" in privacy policy.
|
- deploy `iroh-relay` and also update "realtime relay services" in privacy policy.
|
||||||
([#434](https://github.com/deltachat/chatmail/pull/434))
|
([#434](https://github.com/chatmail/server/pull/434))
|
||||||
([#451](https://github.com/deltachat/chatmail/pull/451))
|
([#451](https://github.com/chatmail/server/pull/451))
|
||||||
|
|
||||||
- add guide to migrate chatmail to a new server
|
- add guide to migrate chatmail to a new server
|
||||||
([#429](https://github.com/deltachat/chatmail/pull/429))
|
([#429](https://github.com/chatmail/server/pull/429))
|
||||||
|
|
||||||
- disable anvil authentication penalty
|
- disable anvil authentication penalty
|
||||||
([#414](https://github.com/deltachat/chatmail/pull/444)
|
([#414](https://github.com/chatmail/server/pull/444)
|
||||||
|
|
||||||
- increase `request_queue_size` for UNIX sockets to 1000.
|
- increase `request_queue_size` for UNIX sockets to 1000.
|
||||||
([#437](https://github.com/deltachat/chatmail/pull/437))
|
([#437](https://github.com/chatmail/server/pull/437))
|
||||||
|
|
||||||
- add argument to `cmdeploy run` for specifying
|
- add argument to `cmdeploy run` for specifying
|
||||||
a different SSH host than `mail_domain`
|
a different SSH host than `mail_domain`
|
||||||
([#439](https://github.com/deltachat/chatmail/pull/439))
|
([#439](https://github.com/chatmail/server/pull/439))
|
||||||
|
|
||||||
- query autoritative nameserver to bypass DNS cache
|
- query autoritative nameserver to bypass DNS cache
|
||||||
([#424](https://github.com/deltachat/chatmail/pull/424))
|
([#424](https://github.com/chatmail/server/pull/424))
|
||||||
|
|
||||||
- add mtail support (new optional `mtail_address` ini value)
|
- add mtail support (new optional `mtail_address` ini value)
|
||||||
This defines the address on which [`mtail`](https://google.github.io/mtail/)
|
This defines the address on which [`mtail`](https://google.github.io/mtail/)
|
||||||
@@ -41,195 +184,195 @@
|
|||||||
and assign an IP address from this network to the host.
|
and assign an IP address from this network to the host.
|
||||||
If you do not plan to collect metrics,
|
If you do not plan to collect metrics,
|
||||||
keep this setting unset.
|
keep this setting unset.
|
||||||
([#388](https://github.com/deltachat/chatmail/pull/388))
|
([#388](https://github.com/chatmail/server/pull/388))
|
||||||
|
|
||||||
- fix checking for required DNS records
|
- fix checking for required DNS records
|
||||||
([#412](https://github.com/deltachat/chatmail/pull/412))
|
([#412](https://github.com/chatmail/server/pull/412))
|
||||||
|
|
||||||
- add support for specifying whole domains for recipient passthrough list
|
- add support for specifying whole domains for recipient passthrough list
|
||||||
([#408](https://github.com/deltachat/chatmail/pull/408))
|
([#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/deltachat/chatmail/pull/405))
|
([#405](https://github.com/chatmail/server/pull/405))
|
||||||
|
|
||||||
- avoid nginx listening on ipv6 if v6 is dsiabled
|
- avoid nginx listening on ipv6 if v6 is dsiabled
|
||||||
([#402](https://github.com/deltachat/chatmail/pull/402))
|
([#402](https://github.com/chatmail/server/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/deltachat/chatmail/pull/396))
|
([#396](https://github.com/chatmail/server/pull/396))
|
||||||
|
|
||||||
- trigger "apt upgrade" during "cmdeploy run"
|
- trigger "apt upgrade" during "cmdeploy run"
|
||||||
([#398](https://github.com/deltachat/chatmail/pull/398))
|
([#398](https://github.com/chatmail/server/pull/398))
|
||||||
|
|
||||||
- drop hispanilandia passthrough address
|
- drop hispanilandia passthrough address
|
||||||
([#401](https://github.com/deltachat/chatmail/pull/401))
|
([#401](https://github.com/chatmail/server/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/deltachat/chatmail/pull/413))
|
([#413](https://github.com/chatmail/server/pull/413))
|
||||||
|
|
||||||
- fix OpenPGP payload check
|
- fix OpenPGP payload check
|
||||||
([#435](https://github.com/deltachat/chatmail/pull/435))
|
([#435](https://github.com/chatmail/server/pull/435))
|
||||||
|
|
||||||
- fix Dovecot quota_max_mail_size to use max_message_size config value
|
- fix Dovecot quota_max_mail_size to use max_message_size config value
|
||||||
([#438](https://github.com/deltachat/chatmail/pull/438))
|
([#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/deltachat/chatmail/pull/393))
|
([#393](https://github.com/chatmail/server/pull/393))
|
||||||
([#394](https://github.com/deltachat/chatmail/pull/394))
|
([#394](https://github.com/chatmail/server/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/deltachat/chatmail/pull/389))
|
([#389](https://github.com/chatmail/server/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/deltachat/chatmail/pull/312))
|
([#312](https://github.com/chatmail/server/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/deltachat/chatmail/pull/370))
|
([#370](https://github.com/chatmail/server/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/deltachat/chatmail/pull/379))
|
([#379](https://github.com/chatmail/server/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/deltachat/chatmail/pull/378))
|
([#378](https://github.com/chatmail/server/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/deltachat/chatmail/pull/351))
|
([#351](https://github.com/chatmail/server/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/deltachat/chatmail/pull/380))
|
([#380](https://github.com/chatmail/server/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/deltachat/chatmail/pull/350))
|
([#350](https://github.com/chatmail/server/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/deltachat/chatmail/pull/372))
|
([#372](https://github.com/chatmail/server/pull/372))
|
||||||
|
|
||||||
- reload nginx in the acmetool cronjob
|
- reload nginx in the acmetool cronjob
|
||||||
([#360](https://github.com/deltachat/chatmail/pull/360))
|
([#360](https://github.com/chatmail/server/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/deltachat/chatmail/pull/348))
|
([#348](https://github.com/chatmail/server/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/deltachat/chatmail/pull/346))
|
([#346](https://github.com/chatmail/server/pull/346))
|
||||||
|
|
||||||
- Don't fix file owner ship of /home/vmail
|
- Don't fix file owner ship of /home/vmail
|
||||||
([#345](https://github.com/deltachat/chatmail/pull/345))
|
([#345](https://github.com/chatmail/server/pull/345))
|
||||||
|
|
||||||
- Support iterating over all users with doveadm commands
|
- Support iterating over all users with doveadm commands
|
||||||
([#344](https://github.com/deltachat/chatmail/pull/344))
|
([#344](https://github.com/chatmail/server/pull/344))
|
||||||
|
|
||||||
- Test and fix for attempts to create inadmissible accounts
|
- Test and fix for attempts to create inadmissible accounts
|
||||||
([#333](https://github.com/deltachat/chatmail/pull/321))
|
([#333](https://github.com/chatmail/server/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/deltachat/chatmail/pull/323),
|
([#323](https://github.com/chatmail/server/pull/323),
|
||||||
[#324](https://github.com/deltachat/chatmail/pull/324))
|
[#324](https://github.com/chatmail/server/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/deltachat/chatmail/pull/320))
|
([#320](https://github.com/chatmail/server/pull/320))
|
||||||
|
|
||||||
- replace `bash` with `/bin/sh`
|
- replace `bash` with `/bin/sh`
|
||||||
([#334](https://github.com/deltachat/chatmail/pull/334))
|
([#334](https://github.com/chatmail/server/pull/334))
|
||||||
|
|
||||||
- Increase number of logged in IMAP sessions to 50000
|
- Increase number of logged in IMAP sessions to 50000
|
||||||
([#335](https://github.com/deltachat/chatmail/pull/335))
|
([#335](https://github.com/chatmail/server/pull/335))
|
||||||
|
|
||||||
- filtermail: do not allow ASCII armor without actual payload
|
- filtermail: do not allow ASCII armor without actual payload
|
||||||
([#325](https://github.com/deltachat/chatmail/pull/325))
|
([#325](https://github.com/chatmail/server/pull/325))
|
||||||
|
|
||||||
- Remove sieve to enable hardlink deduplication in LMTP
|
- Remove sieve to enable hardlink deduplication in LMTP
|
||||||
([#343](https://github.com/deltachat/chatmail/pull/343))
|
([#343](https://github.com/chatmail/server/pull/343))
|
||||||
|
|
||||||
- dovecot: enable gzip compression on disk
|
- dovecot: enable gzip compression on disk
|
||||||
([#341](https://github.com/deltachat/chatmail/pull/341))
|
([#341](https://github.com/chatmail/server/pull/341))
|
||||||
|
|
||||||
- DKIM-sign Content-Type and oversign all signed headers
|
- DKIM-sign Content-Type and oversign all signed headers
|
||||||
([#296](https://github.com/deltachat/chatmail/pull/296))
|
([#296](https://github.com/chatmail/server/pull/296))
|
||||||
|
|
||||||
- Add nonci_accounts metric
|
- Add nonci_accounts metric
|
||||||
([#347](https://github.com/deltachat/chatmail/pull/347))
|
([#347](https://github.com/chatmail/server/pull/347))
|
||||||
|
|
||||||
- doveauth: log when a new account is created
|
- doveauth: log when a new account is created
|
||||||
([#349](https://github.com/deltachat/chatmail/pull/349))
|
([#349](https://github.com/chatmail/server/pull/349))
|
||||||
|
|
||||||
- Multiplex HTTPS, IMAP and SMTP on port 443
|
- Multiplex HTTPS, IMAP and SMTP on port 443
|
||||||
([#357](https://github.com/deltachat/chatmail/pull/357))
|
([#357](https://github.com/chatmail/server/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/deltachat/chatmail/pull/316))
|
([#316](https://github.com/chatmail/server/pull/316))
|
||||||
|
|
||||||
- ensure cron and acl are installed
|
- ensure cron and acl are installed
|
||||||
([#293](https://github.com/deltachat/chatmail/pull/293),
|
([#293](https://github.com/chatmail/server/pull/293),
|
||||||
[#310](https://github.com/deltachat/chatmail/pull/310))
|
[#310](https://github.com/chatmail/server/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/deltachat/chatmail/pull/300))
|
([#300](https://github.com/chatmail/server/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/deltachat/chatmail/pull/299))
|
([#299](https://github.com/chatmail/server/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/deltachat/chatmail/pull/290))
|
([#290](https://github.com/chatmail/server/pull/290))
|
||||||
|
|
||||||
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
||||||
([#284](https://github.com/deltachat/chatmail/pull/284))
|
([#284](https://github.com/chatmail/server/pull/284))
|
||||||
|
|
||||||
- Emit "XCHATMAIL" capability from IMAP server
|
- Emit "XCHATMAIL" capability from IMAP server
|
||||||
([#278](https://github.com/deltachat/chatmail/pull/278))
|
([#278](https://github.com/chatmail/server/pull/278))
|
||||||
|
|
||||||
- Move echobot `into /var/lib/echobot`
|
- Move echobot `into /var/lib/echobot`
|
||||||
([#281](https://github.com/deltachat/chatmail/pull/281))
|
([#281](https://github.com/chatmail/server/pull/281))
|
||||||
|
|
||||||
- Accept Let's Encrypt's new Terms of Services
|
- Accept Let's Encrypt's new Terms of Services
|
||||||
([#275](https://github.com/deltachat/chatmail/pull/276))
|
([#275](https://github.com/chatmail/server/pull/276))
|
||||||
|
|
||||||
- Reload Dovecot and Postfix when TLS certificate updates
|
- Reload Dovecot and Postfix when TLS certificate updates
|
||||||
([#271](https://github.com/deltachat/chatmail/pull/271))
|
([#271](https://github.com/chatmail/server/pull/271))
|
||||||
|
|
||||||
- Use forked version of dovecot without hardcoded delays
|
- Use forked version of dovecot without hardcoded delays
|
||||||
([#270](https://github.com/deltachat/chatmail/pull/270))
|
([#270](https://github.com/chatmail/server/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/deltachat/chatmail/pull/267))
|
([#267](https://github.com/chatmail/server/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/deltachat/chatmail/pull/263))
|
([#265](https://github.com/chatmail/server/pull/263))
|
||||||
|
|
||||||
- Run chatmail-metadata and doveauth as vmail
|
- Run chatmail-metadata and doveauth as vmail
|
||||||
([#261](https://github.com/deltachat/chatmail/pull/261))
|
([#261](https://github.com/chatmail/server/pull/261))
|
||||||
|
|
||||||
- Apply systemd restrictions to echobot
|
- Apply systemd restrictions to echobot
|
||||||
([#259](https://github.com/deltachat/chatmail/pull/259))
|
([#259](https://github.com/chatmail/server/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/deltachat/chatmail/pull/258))
|
([#258](https://github.com/chatmail/server/pull/258))
|
||||||
|
|
||||||
|
|
||||||
## 1.1.0 - 2024-03-28
|
## 1.1.0 - 2024-03-28
|
||||||
@@ -237,27 +380,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/deltachat/chatmail/pull/255))
|
([#255](https://github.com/chatmail/server/pull/255))
|
||||||
|
|
||||||
- Persist push tokens and support multiple device per address
|
- Persist push tokens and support multiple device per address
|
||||||
([#254](https://github.com/deltachat/chatmail/pull/254))
|
([#254](https://github.com/chatmail/server/pull/254))
|
||||||
|
|
||||||
- Avoid warning for regular doveauth protocol's hello message.
|
- Avoid warning for regular doveauth protocol's hello message.
|
||||||
([#250](https://github.com/deltachat/chatmail/pull/250))
|
([#250](https://github.com/chatmail/server/pull/250))
|
||||||
|
|
||||||
- Fix various tests to pass again with "cmdeploy test".
|
- Fix various tests to pass again with "cmdeploy test".
|
||||||
([#245](https://github.com/deltachat/chatmail/pull/245),
|
([#245](https://github.com/chatmail/server/pull/245),
|
||||||
[#242](https://github.com/deltachat/chatmail/pull/242)
|
[#242](https://github.com/chatmail/server/pull/242)
|
||||||
|
|
||||||
- Ensure lets-encrypt certificates are reloaded after renewal
|
- Ensure lets-encrypt certificates are reloaded after renewal
|
||||||
([#244]) https://github.com/deltachat/chatmail/pull/244
|
([#244]) https://github.com/chatmail/server/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/deltachat/chatmail/pull/239)
|
([#238](https://github.com/chatmail/server/pull/239)
|
||||||
|
|
||||||
- Fix failing sieve-script compile errors on incoming messages
|
- Fix failing sieve-script compile errors on incoming messages
|
||||||
([#237](https://github.com/deltachat/chatmail/pull/239)
|
([#237](https://github.com/chatmail/server/pull/239)
|
||||||
|
|
||||||
- Fix quota reporting after expunging of old mails
|
- Fix quota reporting after expunging of old mails
|
||||||
([#233](https://github.com/deltachat/chatmail/pull/239)
|
([#233](https://github.com/chatmail/server/pull/239)
|
||||||
|
|||||||
403
README.md
403
README.md
@@ -1,58 +1,105 @@
|
|||||||
|
|
||||||
<img width="800px" src="www/src/collage-top.png"/>
|
<img width="800px" src="www/src/collage-top.png"/>
|
||||||
|
|
||||||
# Chatmail services optimized for Delta Chat apps
|
# Chatmail relays for end-to-end encrypted e-mail
|
||||||
|
|
||||||
This repository helps to setup a ready-to-use chatmail server
|
Chatmail relay servers are interoperable Mail Transport Agents (MTAs) designed for:
|
||||||
|
|
||||||
|
- **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) services.
|
[Postfix SMTP](https://www.postfix.org) and [Dovecot IMAP](https://www.dovecot.org) MTAs/MDAs.
|
||||||
|
|
||||||
The setup is designed and optimized for providing chatmail accounts
|
The automated setup is designed and optimized for providing chatmail addresses
|
||||||
for use by [Delta Chat apps](https://delta.chat).
|
for immediate permission-free onboarding through chat apps and bots.
|
||||||
|
Chatmail addresses are automatically created at first login,
|
||||||
|
after which the initially specified password is required
|
||||||
|
for sending and receiving messages through them.
|
||||||
|
|
||||||
Chatmail accounts are automatically created by a first login,
|
Please see [this list of known apps and client projects](https://chatmail.at/clients.html)
|
||||||
after which the initially specified password is required for using them.
|
and [this list of known public 3rd party chatmail relay servers](https://chatmail.at/relays).
|
||||||
|
|
||||||
## Deploying your own chatmail server
|
|
||||||
|
|
||||||
To deploy chatmail on your own server, you must have set-up ssh authentication and need to use an ed25519 key, due to an [upstream bug in paramiko](https://github.com/paramiko/paramiko/issues/2191). You also need to add your private key to the local ssh-agent, because you can't type in your password during deployment.
|
## Minimal requirements, Prerequisites
|
||||||
|
|
||||||
We use `chat.example.org` as the chatmail domain in the following steps.
|
You will need the following:
|
||||||
|
|
||||||
|
- 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. Install the `cmdeploy` command in a virtualenv
|
1. Setup the initial DNS records.
|
||||||
|
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.
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/deltachat/chatmail
|
chat.example.com. 3600 IN A 198.51.100.5
|
||||||
cd chatmail
|
chat.example.com. 3600 IN AAAA 2001:db8::5
|
||||||
|
www.chat.example.com. 3600 IN CNAME chat.example.com.
|
||||||
|
mta-sts.chat.example.com. 3600 IN CNAME chat.example.com.
|
||||||
|
```
|
||||||
|
|
||||||
|
2. On your local PC, clone the repository and bootstrap the Python virtualenv.
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/chatmail/relay
|
||||||
|
cd relay
|
||||||
scripts/initenv.sh
|
scripts/initenv.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create chatmail configuration file `chatmail.ini`:
|
3. On your local PC, create chatmail configuration file `chatmail.ini`:
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy init chat.example.org # <-- use your domain
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Point your domain to the server's IP address,
|
4. Verify that SSH root login to your remote server works:
|
||||||
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. From your local PC, deploy the remote chatmail relay server:
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy run
|
scripts/cmdeploy run
|
||||||
```
|
```
|
||||||
This script will check that you have all necessary DNS records.
|
This script will also check that you have all necessary DNS records.
|
||||||
If DNS records are missing, it will recommend
|
If DNS records are missing, it will recommend
|
||||||
which you should configure at your DNS provider
|
which you should configure at your DNS provider
|
||||||
(it can take some time until they are public).
|
(it can take some time until they are public).
|
||||||
|
|
||||||
### Other helpful commands:
|
### Other helpful commands
|
||||||
|
|
||||||
To check the status of your remotely running chatmail service:
|
To check the status of your remotely running chatmail service:
|
||||||
|
|
||||||
@@ -82,25 +129,25 @@ scripts/cmdeploy bench
|
|||||||
|
|
||||||
This repository has four directories:
|
This repository has four directories:
|
||||||
|
|
||||||
- [cmdeploy](https://github.com/deltachat/chatmail/tree/main/cmdeploy)
|
- [cmdeploy](https://github.com/chatmail/relay/tree/main/cmdeploy)
|
||||||
is a collection of configuration files
|
is a collection of configuration files
|
||||||
and a [pyinfra](https://pyinfra.com)-based deployment script.
|
and a [pyinfra](https://pyinfra.com)-based deployment script.
|
||||||
|
|
||||||
- [chatmaild](https://github.com/deltachat/chatmail/tree/main/chatmaild)
|
- [chatmaild](https://github.com/chatmail/relay/tree/main/chatmaild)
|
||||||
is a python package containing several small services
|
is a Python package containing several small services
|
||||||
which handle authentication,
|
which handle authentication,
|
||||||
trigger push notifications on new messages,
|
trigger push notifications on new messages,
|
||||||
ensure that outbound mails are encrypted,
|
ensure that outbound mails are encrypted,
|
||||||
delete inactive users,
|
delete inactive users,
|
||||||
and some other minor things.
|
and some other minor things.
|
||||||
chatmaild can also be installed as a stand-alone python package.
|
chatmaild can also be installed as a stand-alone Python package.
|
||||||
|
|
||||||
- [www](https://github.com/deltachat/chatmail/tree/main/www)
|
- [www](https://github.com/chatmail/relay/tree/main/www)
|
||||||
contains the html, css, and markdown files
|
contains the html, css, and markdown files
|
||||||
which make up a chatmail server's web page.
|
which make up a chatmail relay's web page.
|
||||||
Edit them before deploying to make your chatmail server stand out.
|
Edit them before deploying to make your chatmail relay stand out.
|
||||||
|
|
||||||
- [scripts](https://github.com/deltachat/chatmail/tree/main/scripts)
|
- [scripts](https://github.com/chatmail/relay/tree/main/scripts)
|
||||||
offers two convenience tools for beginners;
|
offers two convenience tools for beginners;
|
||||||
`initenv.sh` installs the necessary dependencies to a local virtual environment,
|
`initenv.sh` installs the necessary dependencies to a local virtual environment,
|
||||||
and the `scripts/cmdeploy` script enables you
|
and the `scripts/cmdeploy` script enables you
|
||||||
@@ -111,80 +158,82 @@ This repository has four directories:
|
|||||||
The `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
The `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
||||||
helps with setting up and managing the chatmail service.
|
helps with setting up and managing the chatmail service.
|
||||||
`cmdeploy init` creates the `chatmail.ini` config file.
|
`cmdeploy init` creates the `chatmail.ini` config file.
|
||||||
`cmdeploy run` uses a [pyinfra](https://pyinfra.com/)-based [script](`cmdeploy/src/cmdeploy/__init__.py`)
|
`cmdeploy run` uses a [pyinfra](https://pyinfra.com/)-based [`script`](cmdeploy/src/cmdeploy/__init__.py)
|
||||||
to automatically install or upgrade all chatmail components on a server,
|
to automatically install or upgrade all chatmail components on a relay,
|
||||||
according to the `chatmail.ini` config.
|
according to the `chatmail.ini` config.
|
||||||
|
|
||||||
The components of chatmail are:
|
The components of chatmail are:
|
||||||
|
|
||||||
- [postfix smtp server](https://www.postfix.org) accepts sent messages (both from your users and from other servers)
|
- [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 server](https://www.dovecot.org) stores messages for your users until they download them
|
- [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
|
- [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
|
- [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
|
- [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
|
- [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:
|
- and the chatmaild services, explained in the next section:
|
||||||
|
|
||||||
### chatmaild
|
### chatmaild
|
||||||
|
|
||||||
chatmaild offers several commands
|
`chatmaild` implements various systemd-controlled services
|
||||||
which differentiate a *chatmail* server from a classic mail server.
|
that integrate with Dovecot and Postfix to achieve instant-onboarding and
|
||||||
If you deploy them with cmdeploy,
|
only relaying OpenPGP end-to-end messages encrypted messages.
|
||||||
they are run by systemd services in the background.
|
A short overview of `chatmaild` services:
|
||||||
A short overview:
|
|
||||||
|
|
||||||
- [`doveauth`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/doveauth.py) implements
|
- [`doveauth`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/doveauth.py)
|
||||||
create-on-login account creation semantics and is used
|
implements create-on-login address semantics and is used
|
||||||
by Dovecot during login authentication and by Postfix
|
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 users
|
to authenticate logins.
|
||||||
to send mails for them.
|
|
||||||
|
|
||||||
- [`filtermail`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/filtermail.py) prevents
|
- [`filtermail`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/filtermail.py)
|
||||||
unencrypted e-mail from leaving the chatmail service
|
prevents unencrypted email from leaving or entering the chatmail service
|
||||||
and is integrated into postfix's outbound mail pipelines.
|
and is integrated into Postfix's outbound and inbound mail pipelines.
|
||||||
|
|
||||||
- [`chatmail-metadata`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a
|
- [`chatmail-metadata`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/metadata.py) is contacted by a
|
||||||
[dovecot lua script](https://github.com/deltachat/chatmail/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua)
|
[Dovecot lua script](https://github.com/chatmail/relay/blob/main/cmdeploy/src/cmdeploy/dovecot/push_notification.lua)
|
||||||
to store user-specific server-side config.
|
to store user-specific relay-side config.
|
||||||
On new messages,
|
On new messages,
|
||||||
it [passes the user's push notification token](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/notifier.py)
|
it [passes the user's push notification token](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/notifier.py)
|
||||||
to [notifications.delta.chat](https://delta.chat/help#instant-delivery)
|
to [notifications.delta.chat](https://delta.chat/help#instant-delivery)
|
||||||
so the push notifications on the user's phone can be triggered
|
so the push notifications on the user's phone can be triggered
|
||||||
by Apple/Google.
|
by Apple/Google/Huawei.
|
||||||
|
|
||||||
- [`delete_inactive_users`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/delete_inactive_users.py)
|
- [`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.
|
deletes users if they have not logged in for a very long time.
|
||||||
The timeframe can be configured in `chatmail.ini`.
|
The timeframe can be configured in `chatmail.ini`.
|
||||||
|
|
||||||
- [`lastlogin`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/lastlogin.py)
|
- [`lastlogin`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/lastlogin.py)
|
||||||
is contacted by dovecot when a user logs in
|
is contacted by Dovecot when a user logs in
|
||||||
and stores the date of the login.
|
and stores the date of the login.
|
||||||
|
|
||||||
- [`echobot`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/echo.py)
|
- [`echobot`](https://github.com/chatmail/relay/blob/main/chatmaild/src/chatmaild/echo.py)
|
||||||
is a small bot for test purposes.
|
is a small bot for test purposes.
|
||||||
It simply echoes back messages from users.
|
It simply echoes back messages from users.
|
||||||
|
|
||||||
- [`chatmail-metrics`](https://github.com/deltachat/chatmail/blob/main/chatmaild/src/chatmaild/metrics.py)
|
- [`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`.
|
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 accounts on your chatmail provider,
|
create an address on your chatmail relay
|
||||||
|
|
||||||
- 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.
|
||||||
@@ -192,48 +241,91 @@ 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.
|
||||||
|
|
||||||
|
#### Custom web pages
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
You can skip uploading a web page
|
||||||
|
by setting `www_folder=disabled` in `chatmail.ini`.
|
||||||
|
|
||||||
If you need to stop account creation,
|
If you want to manage your web pages outside this git repository,
|
||||||
e.g. because some script is wildly creating accounts,
|
you can set `www_folder` in `chatmail.ini` to a custom directory on your computer.
|
||||||
login to the server with ssh and run:
|
`cmdeploy run` will upload it as the server's home page,
|
||||||
|
and if it contains a `src/index.md` file,
|
||||||
|
will build it with hugo.
|
||||||
|
|
||||||
|
|
||||||
|
## Mailbox directory layout
|
||||||
|
|
||||||
|
Fresh chatmail addresses have a mailbox directory that contains:
|
||||||
|
|
||||||
|
- a `password` file with the salted password required for authenticating
|
||||||
|
whether a login may use the address to send/receive messages.
|
||||||
|
If you modify the password file manually, you effectively block the user.
|
||||||
|
|
||||||
|
- `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.
|
||||||
|
|
||||||
|
## Restrict address creation
|
||||||
|
|
||||||
|
### Only allow new addresses with an invite token
|
||||||
|
|
||||||
|
To restrict address creation for anyone who doesn't have the invite link/QR code:
|
||||||
|
|
||||||
|
1. Use the `invite_token` option to add
|
||||||
|
one or more tokens of your choice to `chatmail.ini`:
|
||||||
|
`invite_token = s3cr3t privil3g3`
|
||||||
|
- (recommendation: choose 9 or more letters, or it will be easily bruteforced)
|
||||||
|
2. Run `scripts/cmdeploy run`
|
||||||
|
3. Distribute a `dcaccount` invite link/QR code
|
||||||
|
(like the one on your web page)
|
||||||
|
with one of your invite tokens added at the end,
|
||||||
|
for example: `dcaccount:https://example.org/new?s3cr3t`
|
||||||
|
|
||||||
|
### Emergency Command 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
|
||||||
```
|
```
|
||||||
|
|
||||||
While this file is present, account creation will be blocked.
|
Chatmail address creation will be denied while this file is present.
|
||||||
|
|
||||||
### 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).
|
||||||
|
|
||||||
Delta Chat apps will, however, discover all ports and configurations
|
chatmail-core based 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 service.
|
automatically by reading the [autoconfig XML file](https://www.ietf.org/archive/id/draft-bucksch-autoconfig-00.html) from the chatmail relay server.
|
||||||
|
|
||||||
## Email authentication
|
## Email authentication
|
||||||
|
|
||||||
chatmail servers rely on [DKIM](https://www.rfc-editor.org/rfc/rfc6376)
|
Chatmail relays enforce [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)
|
||||||
@@ -256,101 +348,130 @@ 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.
|
||||||
|
|
||||||
## Migrating chatmail server to a new host
|
## TLS requirements
|
||||||
|
|
||||||
If you want to migrate chatmail from an old machine
|
Postfix is configured to require valid TLS
|
||||||
|
by setting [`smtp_tls_security_level`](https://www.postfix.org/postconf.5.html#smtp_tls_security_level) to `verify`.
|
||||||
|
If emails don't arrive at your chatmail relay server,
|
||||||
|
the problem is likely that your relay does not have a valid TLS certificate.
|
||||||
|
|
||||||
|
You can test it by resolving `MX` records of your relay domain
|
||||||
|
and 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,
|
||||||
|
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,
|
to a new machine,
|
||||||
you can use these steps.
|
you can use these steps.
|
||||||
They were tested with a linux laptop;
|
They were tested with a Linux laptop;
|
||||||
you might need to adjust some of the steps to your environment.
|
you might need to adjust some of the steps to your environment.
|
||||||
|
|
||||||
Let's assume that your `mail_domain` is `mail.example.org`,
|
Let's assume that your `mail_domain` is `mail.example.org`,
|
||||||
all involved machines run Debian 12,
|
all involved machines run Debian 12,
|
||||||
your old server's IP address is `13.37.13.37`,
|
your old site's IP address is `13.37.13.37`,
|
||||||
and your new server's IP address is `13.12.23.42`.
|
and your new site's IP address is `13.12.23.42`.
|
||||||
|
|
||||||
During the guide, you might get a warning about changed SSH Host keys;
|
Note, you should lower the TTLs of your DNS records to a value
|
||||||
in this case, just run `ssh-keygen -R "mail.example.org"` as recommended
|
such as 300 (5 minutes) so the migration happens as smoothly as possible.
|
||||||
to make sure you can connect with SSH.
|
|
||||||
|
|
||||||
1. First, copy `/var/lib/acme` to the new server with
|
During the guide you might get a warning about changed SSH Host keys;
|
||||||
`ssh root@13.37.13.37 tar c /var/lib/acme | ssh root@13.12.23.42 tar x -C /var/lib/`.
|
in this case, just run `ssh-keygen -R "mail.example.org"` as recommended.
|
||||||
This transfers your TLS certificate.
|
|
||||||
|
|
||||||
2. You should also copy `/etc/dkimkeys` to the new server with
|
1. First, disable mail services on the old site.
|
||||||
`ssh root@13.37.13.37 tar c /etc/dkimkeys | ssh root@13.12.23.42 tar x -C /etc/`
|
|
||||||
so the DKIM DNS record stays correct.
|
|
||||||
|
|
||||||
3. On the new server, run `chown root: -R /var/lib/acme` and `chown root: -R /etc/dkimkeys` to make sure the permissions are correct.
|
```
|
||||||
|
cmdeploy run --disable-mail --ssh-host 13.37.13.37
|
||||||
4. Run `cmdeploy run --disable-mail --ssh-host 13.12.23.42` to install chatmail on the new machine.
|
```
|
||||||
postfix and dovecot are disabled for now,
|
|
||||||
we will enable them later.
|
|
||||||
|
|
||||||
5. Now, 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.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
6. Now you can run `cmdeploy run --disable-mail --ssh-host 13.37.13.37` to disable your old server.
|
|
||||||
|
|
||||||
Now your users will notice the migration
|
Now your users will notice the migration
|
||||||
and will not be able to send or receive messages
|
and will not be able to send or receive messages
|
||||||
until the migration is completed.
|
until the migration is completed.
|
||||||
|
|
||||||
7. After everything is stopped,
|
2. Now we want to copy `/home/vmail`, `/var/lib/acme`, `/etc/dkimkeys`, `/run/echobot`, and `/var/spool/postfix` to the new site.
|
||||||
you can copy the `/home/vmail/mail` directory to the new server.
|
Login to the old site while forwarding your SSH agent
|
||||||
It includes all user data, messages, password hashes, etc.
|
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 /"
|
||||||
|
```
|
||||||
|
|
||||||
Just run: `ssh root@13.37.13.37 tar c /home/vmail/mail | ssh root@13.12.23.42 tar x -C /home/vmail/`
|
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.
|
||||||
|
|
||||||
After this, your new server has all the necessary files to start operating :)
|
3. Install chatmail on the new machine:
|
||||||
|
|
||||||
8. To be sure the permissions are still fine,
|
```
|
||||||
run `chown vmail: -R /home/vmail` on the new server.
|
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.
|
||||||
|
|
||||||
9. Finally, you can run `cmdeploy run` to turn on chatmail on the new server.
|
3. On the new site, run the following to ensure the ownership is correct in case UIDs/GIDs changed:
|
||||||
Your users can continue using the chatmail server,
|
|
||||||
and messages which were sent after step 6. should arrive now.
|
```
|
||||||
Voilà!
|
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
|
## Setting up a reverse proxy
|
||||||
|
|
||||||
A chatmail server does not depend on the client IP address
|
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.
|
for its operation, so it can be run behind a reverse proxy.
|
||||||
This will not even affect incoming mail authentication
|
This will not even affect incoming mail authentication
|
||||||
as DKIM only checks the cryptographic signature
|
as DKIM only checks the cryptographic signature
|
||||||
of the message and does not use the IP address as the input.
|
of the message and does not use the IP address as the input.
|
||||||
|
|
||||||
For example, you may want to self-host your chatmail server
|
For example, you may want to self-host your chatmail relay
|
||||||
and only use hosted VPS to provide a public IP address
|
and only use hosted VPS to provide a public IP address
|
||||||
for client connections and incoming mail.
|
for client connections and incoming mail.
|
||||||
You can connect chatmail server to VPS
|
You can connect chatmail relay to VPS
|
||||||
using a tunnel protocol
|
using a tunnel protocol
|
||||||
such as [WireGuard](https://www.wireguard.com/)
|
such as [WireGuard](https://www.wireguard.com/)
|
||||||
and setup a reverse proxy on a VPS
|
and setup a reverse proxy on a VPS
|
||||||
to forward connections to the chatmail server
|
to forward connections to the chatmail relay
|
||||||
over the tunnel.
|
over the tunnel.
|
||||||
You can also setup multiple reverse proxies
|
You can also setup multiple reverse proxies
|
||||||
for your chatmail server in different networks
|
for your chatmail relay in different networks
|
||||||
to ensure your server is reachable even when
|
to ensure your relay is reachable even when
|
||||||
one of the IPs becomes inaccessible due to
|
one of the IPs becomes inaccessible due to
|
||||||
hosting or routing problems.
|
hosting or routing problems.
|
||||||
|
|
||||||
Note that your server still needs
|
Note that your chatmail relay still needs
|
||||||
to be able to make outgoing connections on port 25
|
to be able to make outgoing connections on port 25
|
||||||
to send messages outside.
|
to send messages outside.
|
||||||
|
|
||||||
To setup a reverse proxy
|
To setup a reverse proxy
|
||||||
(or rather Destination NAT, DNAT)
|
(or rather Destination NAT, DNAT)
|
||||||
for your chatmail server,
|
for your chatmail relay,
|
||||||
put the following configuration in `/etc/nftables.conf`:
|
put the following configuration in `/etc/nftables.conf`:
|
||||||
```
|
```
|
||||||
#!/usr/sbin/nft -f
|
#!/usr/sbin/nft -f
|
||||||
@@ -362,7 +483,7 @@ define wan = eth0
|
|||||||
# Which ports to proxy.
|
# Which ports to proxy.
|
||||||
#
|
#
|
||||||
# Note that SSH is not proxied
|
# Note that SSH is not proxied
|
||||||
# so it is possible to log into the proxy server
|
# so it is possible to log into the proxy server
|
||||||
# and not the original one.
|
# and not the original one.
|
||||||
define ports = { smtp, http, https, imap, imaps, submission, submissions }
|
define ports = { smtp, http, https, imap, imaps, submission, submissions }
|
||||||
|
|
||||||
@@ -425,7 +546,7 @@ table inet filter {
|
|||||||
```
|
```
|
||||||
|
|
||||||
Run `systemctl enable nftables.service`
|
Run `systemctl enable nftables.service`
|
||||||
to ensure configuration is reloaded when the proxy server reboots.
|
to ensure configuration is reloaded when the proxy relay reboots.
|
||||||
|
|
||||||
Uncomment in `/etc/sysctl.conf` the following two lines:
|
Uncomment in `/etc/sysctl.conf` the following two lines:
|
||||||
|
|
||||||
@@ -434,7 +555,19 @@ net.ipv4.ip_forward=1
|
|||||||
net.ipv6.conf.all.forwarding=1
|
net.ipv6.conf.all.forwarding=1
|
||||||
```
|
```
|
||||||
|
|
||||||
Then reboot the server or do `sysctl -p` and `nft -f /etc/nftables.conf`.
|
Then reboot the relay or do `sysctl -p` and `nft -f /etc/nftables.conf`.
|
||||||
|
|
||||||
Once proxy server is set up,
|
Once proxy relay is set up,
|
||||||
you can add its IP address to the DNS.
|
you can add its IP address to the DNS.
|
||||||
|
|
||||||
|
## Neighbors and Acquaintances
|
||||||
|
|
||||||
|
Here are some related projects that you may be interested in:
|
||||||
|
|
||||||
|
- [Mox](https://github.com/mjl-/mox): A Golang email server. [Work is in
|
||||||
|
progress](https://github.com/mjl-/mox/issues/251) to modify it to support all
|
||||||
|
of the features and configuration settings required to operate as a chatmail
|
||||||
|
relay.
|
||||||
|
- [Maddy-Chatmail](https://github.com/sadraiiali/maddy_chatmail): a plugin for the
|
||||||
|
[Maddy email server](https://maddy.email/) which aims to implement the
|
||||||
|
chatmail relay features and configuration options.
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ dependencies = [
|
|||||||
"deltachat-rpc-client",
|
"deltachat-rpc-client",
|
||||||
"filelock",
|
"filelock",
|
||||||
"requests",
|
"requests",
|
||||||
|
"crypt-r >= 3.13.1 ; python_version >= '3.11'",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -47,6 +48,9 @@ lint.select = [
|
|||||||
"PLE", # Pylint Error
|
"PLE", # Pylint Error
|
||||||
"PLW", # Pylint Warning
|
"PLW", # Pylint Warning
|
||||||
]
|
]
|
||||||
|
lint.ignore = [
|
||||||
|
"PLC0415" # import-outside-top-level
|
||||||
|
]
|
||||||
|
|
||||||
[tool.tox]
|
[tool.tox]
|
||||||
legacy_tox_ini = """
|
legacy_tox_ini = """
|
||||||
|
|||||||
@@ -1,59 +0,0 @@
|
|||||||
"""Generated from deltachat, draft-ietf-lamps-header-protection, and
|
|
||||||
encrypted_subject localizations in
|
|
||||||
https://github.com/thunderbird/thunderbird-android/
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
common_encrypted_subjects = {
|
|
||||||
"...",
|
|
||||||
"[...]",
|
|
||||||
"암호화된 메시지",
|
|
||||||
"Ĉifrita mesaĝo",
|
|
||||||
"Courriel chiffré",
|
|
||||||
"Dulrituð skilaboð",
|
|
||||||
"Encrypted Message",
|
|
||||||
"Fersifere berjocht",
|
|
||||||
"Kemennadenn enrineget",
|
|
||||||
"Krüptitud kiri",
|
|
||||||
"Krypterat meddelande",
|
|
||||||
"Krypteret besked",
|
|
||||||
"Kryptert melding",
|
|
||||||
"Mensagem criptografada",
|
|
||||||
"Mensagem encriptada",
|
|
||||||
"Mensaje cifrado",
|
|
||||||
"Mensaxe cifrada",
|
|
||||||
"Mesaj Criptat",
|
|
||||||
"Mesazh i Fshehtëzuar",
|
|
||||||
"Messaggio criptato",
|
|
||||||
"Messaghju cifratu",
|
|
||||||
"Missatge encriptat",
|
|
||||||
"Neges wedi'i Hamgryptio",
|
|
||||||
"Pesan terenkripsi",
|
|
||||||
"Salattu viesti",
|
|
||||||
"Şifreli İleti",
|
|
||||||
"Šifrēta ziņa",
|
|
||||||
"Šifrirana poruka",
|
|
||||||
"Šifrirano sporočilo",
|
|
||||||
"Šifruotas laiškas",
|
|
||||||
"Tin nhắn được mã hóa",
|
|
||||||
"Titkosított üzenet",
|
|
||||||
"Verschlüsselte Nachricht",
|
|
||||||
"Versleuteld bericht",
|
|
||||||
"Zašifrovaná zpráva",
|
|
||||||
"Zaszyfrowana wiadomość",
|
|
||||||
"Zifratu mezua",
|
|
||||||
"Κρυπτογραφημένο μήνυμα",
|
|
||||||
"Зашифроване повідомлення",
|
|
||||||
"Зашифрованное сообщение",
|
|
||||||
"Зашыфраваны ліст",
|
|
||||||
"Криптирано съобщение",
|
|
||||||
"Шифрована порука",
|
|
||||||
"დაშიფრული წერილი",
|
|
||||||
"הודעה מוצפנת",
|
|
||||||
"پیام رمزنگاریشده",
|
|
||||||
"رسالة مشفّرة",
|
|
||||||
"എൻക്രിപ്റ്റുചെയ്ത സന്ദേശം",
|
|
||||||
"加密邮件",
|
|
||||||
"已加密的訊息",
|
|
||||||
"暗号化されたメッセージ",
|
|
||||||
}
|
|
||||||
@@ -11,7 +11,11 @@ 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"]
|
||||||
return Config(inipath, params=params)
|
default_config_content = get_default_config_content(params["mail_domain"])
|
||||||
|
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:
|
||||||
@@ -22,14 +26,23 @@ class Config:
|
|||||||
self.max_mailbox_size = params["max_mailbox_size"]
|
self.max_mailbox_size = params["max_mailbox_size"]
|
||||||
self.max_message_size = int(params.get("max_message_size", "31457280"))
|
self.max_message_size = int(params.get("max_message_size", "31457280"))
|
||||||
self.delete_mails_after = params["delete_mails_after"]
|
self.delete_mails_after = params["delete_mails_after"]
|
||||||
|
self.delete_large_after = params["delete_large_after"]
|
||||||
self.delete_inactive_users_after = int(params["delete_inactive_users_after"])
|
self.delete_inactive_users_after = int(params["delete_inactive_users_after"])
|
||||||
self.username_min_length = int(params["username_min_length"])
|
self.username_min_length = int(params["username_min_length"])
|
||||||
self.username_max_length = int(params["username_max_length"])
|
self.username_max_length = int(params["username_max_length"])
|
||||||
self.password_min_length = int(params["password_min_length"])
|
self.password_min_length = int(params["password_min_length"])
|
||||||
|
self.invite_token = params.get("invite_token", "")
|
||||||
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.www_folder = params.get("www_folder", "")
|
||||||
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.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"
|
||||||
@@ -54,7 +67,7 @@ class Config:
|
|||||||
def _getbytefile(self):
|
def _getbytefile(self):
|
||||||
return open(self._inipath, "rb")
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
def get_user(self, addr):
|
def get_user(self, addr) -> User:
|
||||||
if not addr or "@" not in addr or "/" in addr:
|
if not addr or "@" not in addr or "/" in addr:
|
||||||
raise ValueError(f"invalid address {addr!r}")
|
raise ValueError(f"invalid address {addr!r}")
|
||||||
|
|
||||||
@@ -69,6 +82,11 @@ 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")
|
||||||
@@ -100,7 +118,7 @@ def write_initial_config(inipath, mail_domain, overrides):
|
|||||||
lines = []
|
lines = []
|
||||||
for line in content.split("\n"):
|
for line in content.split("\n"):
|
||||||
for key, value in privacy.items():
|
for key, value in privacy.items():
|
||||||
value_lines = value.strip().split("\n")
|
value_lines = value.format(mail_domain=mail_domain).strip().split("\n")
|
||||||
if not line.startswith(f"{key} =") or not value_lines:
|
if not line.startswith(f"{key} =") or not value_lines:
|
||||||
continue
|
continue
|
||||||
if len(value_lines) == 1:
|
if len(value_lines) == 1:
|
||||||
@@ -113,5 +131,4 @@ def write_initial_config(inipath, 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)
|
|
||||||
|
|||||||
@@ -1,9 +1,13 @@
|
|||||||
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
|
||||||
@@ -13,7 +17,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.crypt(password, crypt.METHOD_SHA512)
|
passhash = crypt_r.crypt(password, crypt_r.METHOD_SHA512)
|
||||||
return "{SHA512-CRYPT}" + passhash
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
@@ -22,8 +26,19 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
if os.path.exists(NOCREATE_FILE):
|
if os.path.exists(NOCREATE_FILE):
|
||||||
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
||||||
return False
|
return False
|
||||||
|
password_length = len(cleartext_password)
|
||||||
|
if config.invite_token:
|
||||||
|
for inv_token in config.invite_token.split():
|
||||||
|
if cleartext_password.startswith(inv_token):
|
||||||
|
password_length = len(cleartext_password) - len(inv_token)
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
logging.warning(
|
||||||
|
"blocked account creation because password didn't contain invite token(s)."
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
if len(cleartext_password) < config.password_min_length:
|
if password_length < config.password_min_length:
|
||||||
logging.warning(
|
logging.warning(
|
||||||
"Password needs to be at least %s characters long",
|
"Password needs to be at least %s characters long",
|
||||||
config.password_min_length,
|
config.password_min_length,
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ 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
|
||||||
|
|
||||||
@@ -97,6 +98,10 @@ 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,10 +11,12 @@ 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.
|
||||||
@@ -36,6 +38,12 @@ def check_openpgp_payload(payload: bytes):
|
|||||||
|
|
||||||
packet_type_id = payload[i] & 0x3F
|
packet_type_id = payload[i] & 0x3F
|
||||||
i += 1
|
i += 1
|
||||||
|
|
||||||
|
while payload[i] >= 224 and payload[i] < 255:
|
||||||
|
# Partial body length.
|
||||||
|
partial_length = 1 << (payload[i] & 0x1F)
|
||||||
|
i += 1 + partial_length
|
||||||
|
|
||||||
if payload[i] < 192:
|
if payload[i] < 192:
|
||||||
# One-octet length.
|
# One-octet length.
|
||||||
body_len = payload[i]
|
body_len = payload[i]
|
||||||
@@ -54,7 +62,7 @@ def check_openpgp_payload(payload: bytes):
|
|||||||
)
|
)
|
||||||
i += 5
|
i += 5
|
||||||
else:
|
else:
|
||||||
# Partial body length is not allowed.
|
# Impossible, partial body length was processed above.
|
||||||
return False
|
return False
|
||||||
|
|
||||||
i += body_len
|
i += body_len
|
||||||
@@ -81,7 +89,9 @@ def check_armored_payload(payload: str):
|
|||||||
return False
|
return False
|
||||||
payload = payload.removeprefix(prefix)
|
payload = payload.removeprefix(prefix)
|
||||||
|
|
||||||
suffix = "-----END PGP MESSAGE-----\r\n\r\n"
|
while payload.endswith("\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)
|
||||||
@@ -100,6 +110,27 @@ 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.
|
||||||
|
|
||||||
@@ -107,8 +138,6 @@ 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
|
||||||
@@ -137,9 +166,19 @@ def check_encrypted(message):
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
async def asyncmain_beforequeue(config):
|
async def asyncmain_beforequeue(config, mode):
|
||||||
port = config.filtermail_smtp_port
|
if mode == "outgoing":
|
||||||
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
port = config.filtermail_smtp_port
|
||||||
|
handler = OutgoingBeforeQueueHandler(config)
|
||||||
|
else:
|
||||||
|
port = config.filtermail_smtp_port_incoming
|
||||||
|
handler = IncomingBeforeQueueHandler(config)
|
||||||
|
HackedController(
|
||||||
|
handler,
|
||||||
|
hostname="127.0.0.1",
|
||||||
|
port=port,
|
||||||
|
data_size_limit=config.max_message_size,
|
||||||
|
).start()
|
||||||
|
|
||||||
|
|
||||||
def recipient_matches_passthrough(recipient, passthrough_recipients):
|
def recipient_matches_passthrough(recipient, passthrough_recipients):
|
||||||
@@ -151,7 +190,21 @@ def recipient_matches_passthrough(recipient, passthrough_recipients):
|
|||||||
return False
|
return False
|
||||||
|
|
||||||
|
|
||||||
class BeforeQueueHandler:
|
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()
|
||||||
@@ -176,7 +229,9 @@ class BeforeQueueHandler:
|
|||||||
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(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
client.sendmail(
|
||||||
|
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):
|
||||||
@@ -187,44 +242,86 @@ class BeforeQueueHandler:
|
|||||||
mail_encrypted = check_encrypted(message)
|
mail_encrypted = check_encrypted(message)
|
||||||
|
|
||||||
_, from_addr = parseaddr(message.get("from").strip())
|
_, from_addr = parseaddr(message.get("from").strip())
|
||||||
envelope_from_domain = from_addr.split("@").pop()
|
|
||||||
|
|
||||||
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
|
||||||
if envelope.mail_from.lower() != from_addr.lower():
|
if envelope.mail_from.lower() != from_addr.lower():
|
||||||
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
||||||
|
|
||||||
if mail_encrypted:
|
if mail_encrypted or is_securejoin(message):
|
||||||
print("Filtering encrypted mail.", file=sys.stderr)
|
print("Outgoing: Filtering encrypted mail.", file=sys.stderr)
|
||||||
else:
|
return
|
||||||
print("Filtering unencrypted mail.", file=sys.stderr)
|
|
||||||
|
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
|
||||||
|
|
||||||
is_securejoin = message.get("secure-join") in [
|
|
||||||
"vc-request",
|
|
||||||
"vg-request",
|
|
||||||
]
|
|
||||||
if is_securejoin:
|
|
||||||
return
|
|
||||||
|
|
||||||
for recipient in envelope.rcpt_tos:
|
for recipient in envelope.rcpt_tos:
|
||||||
if envelope.mail_from == recipient:
|
|
||||||
# Always allow sending emails to self.
|
|
||||||
continue
|
|
||||||
if recipient_matches_passthrough(recipient, passthrough_recipients):
|
if recipient_matches_passthrough(recipient, passthrough_recipients):
|
||||||
continue
|
continue
|
||||||
res = recipient.split("@")
|
|
||||||
if len(res) != 2:
|
|
||||||
return f"500 Invalid address <{recipient}>"
|
|
||||||
_recipient_addr, recipient_domain = res
|
|
||||||
|
|
||||||
is_outgoing = recipient_domain != envelope_from_domain
|
print("Rejected unencrypted mail.", file=sys.stderr)
|
||||||
if is_outgoing and not mail_encrypted:
|
return ENCRYPTION_NEEDED_523
|
||||||
print("Rejected unencrypted mail.", file=sys.stderr)
|
|
||||||
return f"500 Invalid unencrypted mail to <{recipient}>"
|
|
||||||
|
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
|
||||||
|
|
||||||
|
print("Rejected unencrypted mail.", file=sys.stderr)
|
||||||
|
return ENCRYPTION_NEEDED_523
|
||||||
|
|
||||||
|
|
||||||
class SendRateLimiter:
|
class SendRateLimiter:
|
||||||
@@ -243,11 +340,14 @@ class SendRateLimiter:
|
|||||||
|
|
||||||
def main():
|
def main():
|
||||||
args = sys.argv[1:]
|
args = sys.argv[1:]
|
||||||
assert len(args) == 1
|
assert len(args) == 2
|
||||||
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)
|
||||||
task = asyncmain_beforequeue(config)
|
assert mode in ["incoming", "outgoing"]
|
||||||
|
task = asyncmain_beforequeue(config, mode)
|
||||||
loop.create_task(task)
|
loop.create_task(task)
|
||||||
|
logging.info("entering serving loop")
|
||||||
loop.run_forever()
|
loop.run_forever()
|
||||||
|
|||||||
@@ -23,6 +23,9 @@ max_message_size = 31457280
|
|||||||
# days after which mails are unconditionally deleted
|
# days after which mails are unconditionally deleted
|
||||||
delete_mails_after = 20
|
delete_mails_after = 20
|
||||||
|
|
||||||
|
# days after which large messages (>200k) are unconditionally deleted
|
||||||
|
delete_large_after = 7
|
||||||
|
|
||||||
# days after which users without a successful login are deleted (database and mails)
|
# days after which users without a successful login are deleted (database and mails)
|
||||||
delete_inactive_users_after = 90
|
delete_inactive_users_after = 90
|
||||||
|
|
||||||
@@ -40,18 +43,20 @@ 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, item may start with "@" to whitelist whole recipient domains)
|
||||||
passthrough_recipients = xstore@testrun.org
|
passthrough_recipients = xstore@testrun.org echo@{mail_domain}
|
||||||
|
|
||||||
#
|
#
|
||||||
# Deployment Details
|
# Deployment Details
|
||||||
#
|
#
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
# SMTP outgoing filtermail and reinjection
|
||||||
filtermail_smtp_port = 10080
|
filtermail_smtp_port = 10080
|
||||||
|
|
||||||
# postfix accepts on the localhost reinject SMTP port
|
|
||||||
postfix_reinject_port = 10025
|
postfix_reinject_port = 10025
|
||||||
|
|
||||||
|
# SMTP incoming filtermail and reinjection
|
||||||
|
filtermail_smtp_port_incoming = 10081
|
||||||
|
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
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
|
|
||||||
[privacy]
|
[privacy]
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org xstore@testrun.org
|
passthrough_recipients = privacy@testrun.org xstore@testrun.org echo@{mail_domain}
|
||||||
|
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
import logging
|
import logging
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
|
from contextlib import contextmanager
|
||||||
|
|
||||||
from .config import read_config
|
from .config import read_config
|
||||||
from .dictproxy import DictProxy
|
from .dictproxy import DictProxy
|
||||||
@@ -7,8 +9,15 @@ from .filedict import FileDict
|
|||||||
from .notifier import Notifier
|
from .notifier import Notifier
|
||||||
|
|
||||||
|
|
||||||
|
def _is_valid_token_timestamp(timestamp, now):
|
||||||
|
# Token if invalid after 90 days
|
||||||
|
# or if the timestamp is in the future.
|
||||||
|
return timestamp > now - 3600 * 24 * 90 and timestamp < now + 60
|
||||||
|
|
||||||
|
|
||||||
class Metadata:
|
class Metadata:
|
||||||
# each SETMETADATA on this key appends to a list of unique device tokens
|
# each SETMETADATA on this key appends to dictionary
|
||||||
|
# mapping of unique device tokens
|
||||||
# which only ever get removed if the upstream indicates the token is invalid
|
# which only ever get removed if the upstream indicates the token is invalid
|
||||||
DEVICETOKEN_KEY = "devicetoken"
|
DEVICETOKEN_KEY = "devicetoken"
|
||||||
|
|
||||||
@@ -18,21 +27,51 @@ class Metadata:
|
|||||||
def get_metadata_dict(self, addr):
|
def get_metadata_dict(self, addr):
|
||||||
return FileDict(self.vmail_dir / addr / "metadata.json")
|
return FileDict(self.vmail_dir / addr / "metadata.json")
|
||||||
|
|
||||||
def add_token_to_addr(self, addr, token):
|
@contextmanager
|
||||||
|
def _modify_tokens(self, addr):
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
with self.get_metadata_dict(addr).modify() as data:
|
||||||
tokens = data.setdefault(self.DEVICETOKEN_KEY, [])
|
tokens = data.setdefault(self.DEVICETOKEN_KEY, {})
|
||||||
if token not in tokens:
|
now = int(time.time())
|
||||||
tokens.append(token)
|
if isinstance(tokens, list):
|
||||||
|
data[self.DEVICETOKEN_KEY] = tokens = {t: now for t in tokens}
|
||||||
|
|
||||||
|
expired_tokens = [
|
||||||
|
token
|
||||||
|
for token, timestamp in tokens.items()
|
||||||
|
if not _is_valid_token_timestamp(tokens[token], now)
|
||||||
|
]
|
||||||
|
for expired_token in expired_tokens:
|
||||||
|
del tokens[expired_token]
|
||||||
|
|
||||||
|
yield tokens
|
||||||
|
|
||||||
|
def add_token_to_addr(self, addr, token):
|
||||||
|
with self._modify_tokens(addr) as tokens:
|
||||||
|
tokens[token] = int(time.time())
|
||||||
|
|
||||||
def remove_token_from_addr(self, addr, token):
|
def remove_token_from_addr(self, addr, token):
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
with self._modify_tokens(addr) as tokens:
|
||||||
tokens = data.get(self.DEVICETOKEN_KEY, [])
|
|
||||||
if token in tokens:
|
if token in tokens:
|
||||||
tokens.remove(token)
|
del tokens[token]
|
||||||
|
|
||||||
def get_tokens_for_addr(self, addr):
|
def get_tokens_for_addr(self, addr):
|
||||||
mdict = self.get_metadata_dict(addr).read()
|
mdict = self.get_metadata_dict(addr).read()
|
||||||
return mdict.get(self.DEVICETOKEN_KEY, [])
|
tokens = mdict.get(self.DEVICETOKEN_KEY, {})
|
||||||
|
|
||||||
|
now = int(time.time())
|
||||||
|
if isinstance(tokens, dict):
|
||||||
|
token_list = [
|
||||||
|
token
|
||||||
|
for token, timestamp in tokens.items()
|
||||||
|
if _is_valid_token_timestamp(timestamp, now)
|
||||||
|
]
|
||||||
|
if len(token_list) < len(tokens):
|
||||||
|
# Some tokens have expired, remove them.
|
||||||
|
with self._modify_tokens(addr) as _tokens:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
token_list = []
|
||||||
|
return token_list
|
||||||
|
|
||||||
|
|
||||||
class MetadataDictProxy(DictProxy):
|
class MetadataDictProxy(DictProxy):
|
||||||
|
|||||||
@@ -11,6 +11,8 @@ 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):
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
"""CGI script for creating new accounts."""
|
"""CGI script for creating new accounts."""
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
import os
|
||||||
import random
|
import random
|
||||||
import secrets
|
import secrets
|
||||||
import string
|
import string
|
||||||
@@ -20,7 +21,11 @@ def create_newemail_dict(config: Config):
|
|||||||
secrets.choice(ALPHANUMERIC_PUNCT)
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
for _ in range(config.password_min_length + 3)
|
for _ in range(config.password_min_length + 3)
|
||||||
)
|
)
|
||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
redirect_uri = os.getenv("REQUEST_URI", "/new")
|
||||||
|
invite_token = "" if redirect_uri == "/new" else redirect_uri[5:]
|
||||||
|
return dict(
|
||||||
|
email=f"{user}@{config.mail_domain}", password=f"{invite_token}{password}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
|
|||||||
@@ -17,11 +17,11 @@ and which are scheduled for retry using exponential back-off timing.
|
|||||||
If a token notification would be scheduled more than DROP_DEADLINE seconds
|
If a token notification would be scheduled more than DROP_DEADLINE seconds
|
||||||
after its first attempt, it is dropped with a log error.
|
after its first attempt, it is dropped with a log error.
|
||||||
|
|
||||||
Note that tokens are completely opaque to the notification machinery here
|
Note that tokens are opaque to the notification machinery here
|
||||||
and will in the future be encrypted foreclosing all ability to distinguish
|
and are encrypted foreclosing all ability to distinguish
|
||||||
which device token ultimately goes to which phone-provider notification service,
|
which device token ultimately goes to which phone-provider notification service,
|
||||||
or to understand the relation of "device tokens" and chatmail addresses.
|
or to understand the relation of "device tokens" and chatmail addresses.
|
||||||
The meaning and format of tokens is basically a matter of Delta-Chat Core and
|
The meaning and format of tokens is basically a matter of chatmail Core and
|
||||||
the `notification.delta.chat` service.
|
the `notification.delta.chat` service.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -95,7 +95,12 @@ class Notifier:
|
|||||||
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
||||||
queue_path.unlink()
|
queue_path.unlink()
|
||||||
continue
|
continue
|
||||||
queue_item = PersistentQueueItem.read_from_path(queue_path)
|
try:
|
||||||
|
queue_item = PersistentQueueItem.read_from_path(queue_path)
|
||||||
|
except ValueError:
|
||||||
|
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
||||||
|
queue_path.unlink()
|
||||||
|
continue
|
||||||
self.queue_for_retry(queue_item)
|
self.queue_for_retry(queue_item)
|
||||||
|
|
||||||
def queue_for_retry(self, queue_item, retry_num=0):
|
def queue_for_retry(self, queue_item, retry_num=0):
|
||||||
|
|||||||
56
chatmaild/src/chatmaild/tests/mail-data/asm.eml
Normal file
56
chatmaild/src/chatmaild/tests/mail-data/asm.eml
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
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--
|
||||||
46
chatmaild/src/chatmaild/tests/mail-data/mailer-daemon.eml
Normal file
46
chatmaild/src/chatmaild/tests/mail-data/mailer-daemon.eml
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
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--
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
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--
|
||||||
|
|
||||||
|
|
||||||
21
chatmaild/src/chatmaild/tests/mail-data/securejoin-vc.eml
Normal file
21
chatmaild/src/chatmaild/tests/mail-data/securejoin-vc.eml
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
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,12 +69,11 @@ 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.default).parsebytes(text.encode())
|
return BytesParser(policy=policy.SMTP).parsebytes(text.encode())
|
||||||
|
|
||||||
return maildata
|
return maildata
|
||||||
|
|
||||||
|
|||||||
@@ -15,6 +15,14 @@ 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"
|
||||||
@@ -27,6 +35,7 @@ def test_read_config_testrun(make_config):
|
|||||||
assert config.max_user_send_per_minute == 60
|
assert config.max_user_send_per_minute == 60
|
||||||
assert config.max_mailbox_size == "100M"
|
assert config.max_mailbox_size == "100M"
|
||||||
assert config.delete_mails_after == "20"
|
assert config.delete_mails_after == "20"
|
||||||
|
assert config.delete_large_after == "7"
|
||||||
assert config.username_min_length == 9
|
assert config.username_min_length == 9
|
||||||
assert config.username_max_length == 9
|
assert config.username_max_length == 9
|
||||||
assert config.password_min_length == 9
|
assert config.password_min_length == 9
|
||||||
|
|||||||
@@ -64,12 +64,38 @@ def test_dont_overwrite_password_on_wrong_login(dictproxy):
|
|||||||
assert res["password"] == res2["password"]
|
assert res["password"] == res2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_nocreate_file(monkeypatch, tmpdir, dictproxy):
|
@pytest.mark.parametrize(
|
||||||
p = tmpdir.join("nocreate")
|
["nocreate_file", "account", "invite_token", "password"],
|
||||||
p.write("")
|
[
|
||||||
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
(False, True, "asdf", "asdfasdmaimfelsgwerw"),
|
||||||
dictproxy.lookup_passdb("newuser12@chat.example.org", "zequ0Aimuchoodaechik")
|
(False, False, "asdf", "z9873240187420913798"),
|
||||||
assert not dictproxy.lookup_userdb("newuser12@chat.example.org")
|
(False, True, "", "dsaiujfw9fjiwf9w"),
|
||||||
|
(False, False, "asdf", "z987324018742asdf0913798"),
|
||||||
|
(False, True, "as df", "asj0wiefkj0ofkeefok"),
|
||||||
|
(False, True, "as df", "dfj0wiefkj0ofkeefok"),
|
||||||
|
(False, False, "as df", "j0wiefkj0ofas dfkeefok"),
|
||||||
|
(True, False, "asdf", "asdfmosadkdkfwdofkw"),
|
||||||
|
(True, False, "asdf", "z9873240187420913798"),
|
||||||
|
(True, False, "", "dsaiujfw9fjiwf9w"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_nocreate_file(
|
||||||
|
monkeypatch,
|
||||||
|
tmpdir,
|
||||||
|
dictproxy,
|
||||||
|
example_config,
|
||||||
|
nocreate_file: bool,
|
||||||
|
account: bool,
|
||||||
|
invite_token: str,
|
||||||
|
password: str,
|
||||||
|
):
|
||||||
|
if nocreate_file:
|
||||||
|
p = tmpdir.join("nocreate")
|
||||||
|
p.write("")
|
||||||
|
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
||||||
|
example_config.invite_token = invite_token
|
||||||
|
dictproxy.lookup_passdb("newuser12@chat.example.org", password)
|
||||||
|
assert bool(dictproxy.lookup_userdb("newuser12@chat.example.org")) == account
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request(dictproxy):
|
def test_handle_dovecot_request(dictproxy):
|
||||||
|
|||||||
@@ -1,11 +1,12 @@
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from chatmaild.filtermail import (
|
from chatmaild.filtermail import (
|
||||||
BeforeQueueHandler,
|
IncomingBeforeQueueHandler,
|
||||||
|
OutgoingBeforeQueueHandler,
|
||||||
SendRateLimiter,
|
SendRateLimiter,
|
||||||
check_armored_payload,
|
check_armored_payload,
|
||||||
check_encrypted,
|
check_encrypted,
|
||||||
common_encrypted_subjects,
|
is_securejoin,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -18,7 +19,13 @@ 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 BeforeQueueHandler(config)
|
return OutgoingBeforeQueueHandler(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):
|
||||||
@@ -29,14 +36,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(
|
||||||
"plain.eml", from_addr=env.mail_from, to_addr=to_addr
|
"encrypted.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(
|
||||||
"plain.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
"encrypted.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
|
||||||
@@ -55,19 +62,28 @@ def test_filtermail_no_encryption_detection(maildata):
|
|||||||
assert not check_encrypted(msg)
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_encryption_detection(maildata):
|
def test_filtermail_securejoin_detection(maildata):
|
||||||
for subject in common_encrypted_subjects:
|
msg = maildata(
|
||||||
msg = maildata(
|
"securejoin-vc.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
"encrypted.eml",
|
)
|
||||||
from_addr="1@example.org",
|
assert is_securejoin(msg)
|
||||||
to_addr="2@example.org",
|
|
||||||
subject=subject,
|
|
||||||
)
|
|
||||||
assert check_encrypted(msg)
|
|
||||||
|
|
||||||
# if the subject is not a known encrypted subject value, it is not considered ac-encrypted
|
msg = maildata(
|
||||||
msg.replace_header("Subject", "Click this link")
|
"securejoin-vc-fake.eml",
|
||||||
assert not check_encrypted(msg)
|
from_addr="some@example.org",
|
||||||
|
to_addr="other@example.org",
|
||||||
|
)
|
||||||
|
assert not is_securejoin(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_encryption_detection(maildata):
|
||||||
|
msg = maildata(
|
||||||
|
"encrypted.eml",
|
||||||
|
from_addr="1@example.org",
|
||||||
|
to_addr="2@example.org",
|
||||||
|
subject="Subject does not matter, will be replaced anyway",
|
||||||
|
)
|
||||||
|
assert check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_no_literal_packets(maildata):
|
def test_filtermail_no_literal_packets(maildata):
|
||||||
@@ -97,7 +113,7 @@ def test_send_rate_limiter():
|
|||||||
break
|
break
|
||||||
|
|
||||||
|
|
||||||
def test_excempt_privacy(maildata, gencreds, handler):
|
def test_cleartext_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]
|
||||||
@@ -118,10 +134,73 @@ def test_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 "500" in handler.check_DATA(envelope=env2)
|
assert "523" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
def test_passthrough_domains(maildata, gencreds, handler):
|
def test_cleartext_self_send_autocrypt_setup_message(maildata, gencreds, handler):
|
||||||
|
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]
|
from_addr = gencreds()[0]
|
||||||
to_addr = "privacy@x.y.z"
|
to_addr = "privacy@x.y.z"
|
||||||
handler.config.passthrough_recipients = ["@x.y.z"]
|
handler.config.passthrough_recipients = ["@x.y.z"]
|
||||||
@@ -142,10 +221,10 @@ def test_passthrough_domains(maildata, gencreds, handler):
|
|||||||
rcpt_tos = [to_addr, false_to]
|
rcpt_tos = [to_addr, false_to]
|
||||||
content = msg.as_bytes()
|
content = msg.as_bytes()
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
assert "523" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
def test_passthrough_senders(gencreds, handler, maildata):
|
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]
|
||||||
@@ -196,10 +275,20 @@ 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
|
||||||
@@ -215,3 +304,45 @@ HELLOWORLD
|
|||||||
\r
|
\r
|
||||||
"""
|
"""
|
||||||
assert check_armored_payload(payload) == False
|
assert check_armored_payload(payload) == False
|
||||||
|
|
||||||
|
# Test payload using partial body length
|
||||||
|
# as generated by GopenPGP.
|
||||||
|
payload = """-----BEGIN PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
wV4DdCVjRfOT3TQSAQdAY5+pjT6mlCxPGdR3be4w7oJJRUGIPI/Vnh+mJxGSm34w\r
|
||||||
|
LNlVc89S1g22uQYFif2sUJsQWbpoHpNkuWpkSgOaHmNvrZiY/YU5iv+cZ3LbmtUG\r
|
||||||
|
0uoBisSHh9O1c+5sYZSbrvYZ1NOwlD7Fv/U5/Mw4E5+CjxfdgNGp5o3DDddzPK78\r
|
||||||
|
jseDhdSXxnaiIJC93hxNX6R1RPt3G2gukyzx69wciPQShcF8zf3W3o75Ed7B8etV\r
|
||||||
|
QEeB16xzdFhKa9JxdjTu3osgCs21IO7wpcFkjc7nZzlW6jPnELJJaNmv4yOOCjMp\r
|
||||||
|
6YAkaN/BkL+jHTznHDuDsT5ilnTXpwHDU1Cm9PIx/KFcNCQnIB+2DcdIHPHUH1ci\r
|
||||||
|
jvqoeXAVWjKXEjS7PqPFuP/xGbrWG2ugs+toXJOKbgRkExvKs1dwPFKrgghvCVbW\r
|
||||||
|
AcKejQKAPArLwpkA7aD875TZQShvGt74fNs45XBlGOYOnNOAJ1KAmzrXLIDViyyB\r
|
||||||
|
kDsmTBk785xofuCkjBpXSe6vsMprPzCteDfaUibh8FHeJjucxPerwuOPEmnogNaf\r
|
||||||
|
YyL4+iy8H8I9/p7pmUqILprxTG0jTOtlk0bTVzeiF56W1xbtSEMuOo4oFbQTyOM2\r
|
||||||
|
bKXaYo774Jm+rRtKAnnI2dtf9RpK19cog6YNzfYjesLKbXDsPZbN5rmwyFiCvvxC\r
|
||||||
|
kQ6JLob+B2fPdY2gzy7LypxktS8Zi1HJcWDHJGVmQodaDLqKUObb4M26bXDe6oxI\r
|
||||||
|
NS8PJz5exVbM3KhZnUOEn6PJRBBf5a/ZqxlhZPcQo/oBuhKpBRpO5kSDwPIUByu3\r
|
||||||
|
UlXLSkpMqe9pUarAOEuQjfl2RVY7U+RrQYp4YP5keMO+i8NCefAFbowTTufO1JIq\r
|
||||||
|
2nVgCi/QVnxZyEc9OYt/8AE3g4cdojE+vsSDifZLSWYIetpfrohHv3dT3StD1QRG\r
|
||||||
|
0QE6qq6oKpg/IL0cjvuX4c7a7bslv2fXp8t75y37RU6253qdIebhxc/cRhPbc/yu\r
|
||||||
|
p0YLyD4SrvKTLP2ZV95jT4IPEpqm4AN3QmiOzdtqR2gLyb62L8QfqI/FdwsIiRiM\r
|
||||||
|
hqydwoqt/lfSqG1WKPh+6EkMkH+TDiCC1BQdbN1MNcyUtcjb35PR2c8Ld2TF3guA\r
|
||||||
|
jLIqMt/Vb7hBoMb2FcsOYY25ka9oV62OwgKWLXnFzk+modMR5fzb4kxVVAYEqP+D\r
|
||||||
|
T5KO1Vs76v1fyPGOq6BbBCvLwTqe/e6IZInJles4v5jrhnLcGKmNGivCUDe6X6NY\r
|
||||||
|
UKNt5RsZllwDQpaAb5dMNhyrk8SgIE7TBI7rvqIdUCE52Vy+0JDxFg5olRpFUfO6\r
|
||||||
|
/MyTW3Yo/ekk/npHr7iYYqJTCc21bDGLWQcIo/XO7WPxrKNWGBNPFnkRdw0MaKr4\r
|
||||||
|
+cEM3V8NFnSEpC12xA+RX/CezuJtwXZK5MpG76eYqMO6qyC+c25YcFecEufDZDxx\r
|
||||||
|
ZLqRszVRyxyWPtk/oIeQK2v9wOqY6N9/ff01gHz69vqYqN5bUw/QKZsmx1zW+gPw\r
|
||||||
|
6x2tDK2BHeYl182gCbhlKISRFwCtbjqZSkiKWao/VtygHkw0fK34avJuyQ/X9YaN\r
|
||||||
|
BRy+7Lf3VA53pnB5WJ1xwRXN8VDvmZeXzv2krHveCMemj0OjnRoCLu117xN0A5m9\r
|
||||||
|
Fm/RoDix5PolDHtWTtr2m1n2hp2LHnj8at9lFEd0SKhAYHVL9KjzycwWODZRXt+x\r
|
||||||
|
zGDDuooEeTvdY5NLyKcl4gETz1ZP4Ez5jGGjhPSwSpq1mU7UaJ9ZXXdr4KHyifW6\r
|
||||||
|
ggNzNsGhXTap7IWZpTtqXABydfiBshmH2NjqtNDwBweJVSgP10+r0WhMWlaZs6xl\r
|
||||||
|
V3o5yskJt6GlkwpJxZrTvN6Tiww/eW7HFV6NGf7IRSWY5tJc/iA7/92tOmkdvJ1q\r
|
||||||
|
myLbG7cJB787QjplEyVe2P/JBO6xYvbkJLf9Q+HaviTO25rugRSrYsoKMDfO8VlQ\r
|
||||||
|
1CcnTPVtApPZJEQzAWJEgVAM8uIlkqWJJMgyWT34sTkdBeCUFGloXQFs9Yxd0AGf\r
|
||||||
|
/zHEkYZSTKpVSvAIGu4=\r
|
||||||
|
=6iHb\r
|
||||||
|
-----END PGP MESSAGE-----\r
|
||||||
|
"""
|
||||||
|
assert check_armored_payload(payload) == True
|
||||||
|
|||||||
@@ -242,6 +242,22 @@ def test_requeue_removes_tmp_files(notifier, metadata, testaddr, caplog):
|
|||||||
assert queue_item.addr == testaddr
|
assert queue_item.addr == testaddr
|
||||||
|
|
||||||
|
|
||||||
|
def test_requeue_removes_invalid_files(notifier, metadata, testaddr, caplog):
|
||||||
|
metadata.add_token_to_addr(testaddr, "01234")
|
||||||
|
notifier.new_message_for_addr(testaddr, metadata)
|
||||||
|
# empty/invalid files should be ignored
|
||||||
|
p = notifier.queue_dir.joinpath("1203981203")
|
||||||
|
p.touch()
|
||||||
|
notifier2 = notifier.__class__(notifier.queue_dir)
|
||||||
|
notifier2.requeue_persistent_queue_items()
|
||||||
|
assert "spurious" in caplog.records[0].msg
|
||||||
|
assert not p.exists()
|
||||||
|
assert notifier2.retry_queues[0].qsize() == 1
|
||||||
|
when, queue_item = notifier2.retry_queues[0].get()
|
||||||
|
assert when <= int(time.time())
|
||||||
|
assert queue_item.addr == testaddr
|
||||||
|
|
||||||
|
|
||||||
def test_start_and_stop_notification_threads(notifier, testaddr):
|
def test_start_and_stop_notification_threads(notifier, testaddr):
|
||||||
threads = notifier.start_notification_threads(None)
|
threads = notifier.start_notification_threads(None)
|
||||||
for retry_num, threadlist in threads.items():
|
for retry_num, threadlist in threads.items():
|
||||||
|
|||||||
@@ -2,8 +2,15 @@ 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"):
|
||||||
tmp_path.joinpath(x).mkdir()
|
p = tmp_path.joinpath(x)
|
||||||
|
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,3 +40,17 @@ 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,6 +13,7 @@ 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
|
||||||
|
|
||||||
@@ -35,6 +36,13 @@ 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.
|
||||||
|
|
||||||
@@ -50,6 +58,8 @@ 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
|
||||||
|
if not self.addr.startswith("echo@"):
|
||||||
|
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
|
||||||
|
|||||||
@@ -41,3 +41,6 @@ lint.select = [
|
|||||||
"PLE", # Pylint Error
|
"PLE", # Pylint Error
|
||||||
"PLW", # Pylint Warning
|
"PLW", # Pylint Warning
|
||||||
]
|
]
|
||||||
|
lint.ignore = [
|
||||||
|
"PLC0415" # import-outside-top-level
|
||||||
|
]
|
||||||
|
|||||||
@@ -7,17 +7,35 @@ import io
|
|||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
|
from io import StringIO
|
||||||
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 host, facts
|
from pyinfra import facts, host, logger
|
||||||
|
from pyinfra.api import FactBase
|
||||||
from pyinfra.facts.files import File
|
from pyinfra.facts.files import File
|
||||||
|
from pyinfra.facts.server import Sysctl
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from pyinfra.operations import apt, files, pip, server, systemd
|
from pyinfra.operations import apt, files, pip, server, systemd
|
||||||
|
|
||||||
from .acmetool import deploy_acmetool
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
|
|
||||||
|
class Port(FactBase):
|
||||||
|
"""
|
||||||
|
Returns the process occuping a port.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def command(self, port: int) -> str:
|
||||||
|
return (
|
||||||
|
"ss -lptn 'src :%d' | awk 'NR>1 {print $6,$7}' | sed 's/users:((\"//;s/\".*//'"
|
||||||
|
% (port,)
|
||||||
|
)
|
||||||
|
|
||||||
|
def process(self, output: [str]) -> str:
|
||||||
|
return output[0]
|
||||||
|
|
||||||
|
|
||||||
def _build_chatmaild(dist_dir) -> None:
|
def _build_chatmaild(dist_dir) -> None:
|
||||||
dist_dir = Path(dist_dir).resolve()
|
dist_dir = Path(dist_dir).resolve()
|
||||||
if dist_dir.exists():
|
if dist_dir.exists():
|
||||||
@@ -78,6 +96,11 @@ 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=[
|
||||||
@@ -101,12 +124,14 @@ 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/{fn}",
|
execpath=f"{remote_venv_dir}/bin/{execpath}",
|
||||||
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,
|
||||||
@@ -210,51 +235,37 @@ 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"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
f"/usr/sbin/opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
||||||
],
|
],
|
||||||
_sudo=True,
|
_use_su_login=True,
|
||||||
_sudo_user="opendkim",
|
_su_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 _install_mta_sts_daemon() -> bool:
|
def _uninstall_mta_sts_daemon() -> None:
|
||||||
need_restart = False
|
# Remove configuration.
|
||||||
|
files.file("/etc/mta-sts-daemon.yml", present=False)
|
||||||
|
|
||||||
config = files.put(
|
files.directory("/usr/local/lib/postfix-mta-sts-resolver", present=False)
|
||||||
name="upload postfix-mta-sts-resolver config",
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
files.file("/etc/systemd/system/mta-sts-daemon.service", present=False)
|
||||||
"postfix/mta-sts-daemon.yml"
|
|
||||||
),
|
systemd.service(
|
||||||
dest="/etc/mta-sts-daemon.yml",
|
name="Stop MTA-STS daemon",
|
||||||
user="root",
|
service="mta-sts-daemon.service",
|
||||||
group="root",
|
daemon_reload=True,
|
||||||
mode="644",
|
running=False,
|
||||||
|
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:
|
||||||
@@ -307,6 +318,40 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _install_dovecot_package(package: str, arch: str):
|
||||||
|
arch = "amd64" if arch == "x86_64" else arch
|
||||||
|
arch = "arm64" if arch == "aarch64" else arch
|
||||||
|
url = f"https://download.delta.chat/dovecot/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
||||||
|
deb_filename = "/root/" + url.split("/")[-1]
|
||||||
|
|
||||||
|
match (package, arch):
|
||||||
|
case ("core", "amd64"):
|
||||||
|
sha256 = "43f593332e22ac7701c62d58b575d2ca409e0f64857a2803be886c22860f5587"
|
||||||
|
case ("core", "arm64"):
|
||||||
|
sha256 = "4d21eba1a83f51c100f08f2e49f0c9f8f52f721ebc34f75018e043306da993a7"
|
||||||
|
case ("imapd", "amd64"):
|
||||||
|
sha256 = "8d8dc6fc00bbb6cdb25d345844f41ce2f1c53f764b79a838eb2a03103eebfa86"
|
||||||
|
case ("imapd", "arm64"):
|
||||||
|
sha256 = "178fa877ddd5df9930e8308b518f4b07df10e759050725f8217a0c1fb3fd707f"
|
||||||
|
case ("lmtpd", "amd64"):
|
||||||
|
sha256 = "2f69ba5e35363de50962d42cccbfe4ed8495265044e244007d7ccddad77513ab"
|
||||||
|
case ("lmtpd", "arm64"):
|
||||||
|
sha256 = "89f52fb36524f5877a177dff4a713ba771fd3f91f22ed0af7238d495e143b38f"
|
||||||
|
case _:
|
||||||
|
apt.packages(packages=[f"dovecot-{package}"])
|
||||||
|
return
|
||||||
|
|
||||||
|
files.download(
|
||||||
|
name=f"Download dovecot-{package}",
|
||||||
|
src=url,
|
||||||
|
dest=deb_filename,
|
||||||
|
sha256sum=sha256,
|
||||||
|
cache_time=60 * 60 * 24 * 365 * 10, # never redownload the package
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.deb(name=f"Install dovecot-{package}", src=deb_filename)
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
||||||
"""Configures Dovecot IMAP server."""
|
"""Configures Dovecot IMAP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
@@ -354,6 +399,10 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
# it is recommended to set the following inotify limits
|
# it is recommended to set the following inotify limits
|
||||||
for name in ("max_user_instances", "max_user_watches"):
|
for name in ("max_user_instances", "max_user_watches"):
|
||||||
key = f"fs.inotify.{name}"
|
key = f"fs.inotify.{name}"
|
||||||
|
if host.get_fact(Sysctl)[key] > 65535:
|
||||||
|
# Skip updating limits if already sufficient
|
||||||
|
# (enables running in incus containers where sysctl readonly)
|
||||||
|
continue
|
||||||
server.sysctl(
|
server.sysctl(
|
||||||
name=f"Change {key}",
|
name=f"Change {key}",
|
||||||
key=key,
|
key=key,
|
||||||
@@ -361,6 +410,13 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
persist=True,
|
persist=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
timezone_env = files.line(
|
||||||
|
name="Set TZ environment variable",
|
||||||
|
path="/etc/environment",
|
||||||
|
line="TZ=:/etc/localtime",
|
||||||
|
)
|
||||||
|
need_restart |= timezone_env.changed
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
@@ -442,9 +498,26 @@ def check_config(config):
|
|||||||
|
|
||||||
|
|
||||||
def deploy_mtail(config):
|
def deploy_mtail(config):
|
||||||
apt.packages(
|
# Uninstall mtail package, we are going to install a static binary.
|
||||||
name="Install mtail",
|
apt.packages(name="Uninstall mtail", packages=["mtail"], present=False)
|
||||||
packages=["mtail"],
|
|
||||||
|
(url, sha256sum) = {
|
||||||
|
"x86_64": (
|
||||||
|
"https://github.com/google/mtail/releases/download/v3.0.8/mtail_3.0.8_linux_amd64.tar.gz",
|
||||||
|
"123c2ee5f48c3eff12ebccee38befd2233d715da736000ccde49e3d5607724e4",
|
||||||
|
),
|
||||||
|
"aarch64": (
|
||||||
|
"https://github.com/google/mtail/releases/download/v3.0.8/mtail_3.0.8_linux_arm64.tar.gz",
|
||||||
|
"aa04811c0929b6754408676de520e050c45dddeb3401881888a092c9aea89cae",
|
||||||
|
),
|
||||||
|
}[host.get_fact(facts.server.Arch)]
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name="Download mtail",
|
||||||
|
commands=[
|
||||||
|
f"(echo '{sha256sum} /usr/local/bin/mtail' | sha256sum -c) || (curl -L {url} | gunzip | tar -x -f - mtail -O >/usr/local/bin/mtail.new && mv /usr/local/bin/mtail.new /usr/local/bin/mtail)",
|
||||||
|
"chmod 755 /usr/local/bin/mtail",
|
||||||
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
# Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`.
|
# Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`.
|
||||||
@@ -517,9 +590,9 @@ def deploy_iroh_relay(config) -> None:
|
|||||||
need_restart |= systemd_unit.changed
|
need_restart |= systemd_unit.changed
|
||||||
|
|
||||||
iroh_config = files.put(
|
iroh_config = files.put(
|
||||||
name=f"Upload iroh-relay config",
|
name="Upload iroh-relay config",
|
||||||
src=importlib.resources.files(__package__).joinpath("iroh-relay.toml"),
|
src=importlib.resources.files(__package__).joinpath("iroh-relay.toml"),
|
||||||
dest=f"/etc/iroh-relay.toml",
|
dest="/etc/iroh-relay.toml",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
@@ -545,11 +618,10 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
check_config(config)
|
check_config(config)
|
||||||
mail_domain = config.mail_domain
|
mail_domain = config.mail_domain
|
||||||
|
|
||||||
from .www import build_webpages
|
from .www import build_webpages, get_paths
|
||||||
|
|
||||||
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",
|
||||||
@@ -581,9 +653,15 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
path="/etc/apt/sources.list",
|
path="/etc/apt/sources.list",
|
||||||
line="deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./",
|
line="deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./",
|
||||||
escape_regex_characters=True,
|
escape_regex_characters=True,
|
||||||
ensure_newline=True,
|
present=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if host.get_fact(Port, port=53) != "unbound":
|
||||||
|
files.line(
|
||||||
|
name="Add 9.9.9.9 to resolv.conf",
|
||||||
|
path="/etc/resolv.conf",
|
||||||
|
line="nameserver 9.9.9.9",
|
||||||
|
)
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
||||||
|
|
||||||
@@ -595,6 +673,32 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
# Run local DNS resolver `unbound`.
|
# Run local DNS resolver `unbound`.
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
# to use 127.0.0.1 as the resolver.
|
# to use 127.0.0.1 as the resolver.
|
||||||
|
from cmdeploy.cmdeploy import Out
|
||||||
|
|
||||||
|
port_services = [
|
||||||
|
(["master", "smtpd"], 25),
|
||||||
|
("unbound", 53),
|
||||||
|
("acmetool", 80),
|
||||||
|
("imap-login", 143),
|
||||||
|
("nginx", 443),
|
||||||
|
(["master", "smtpd"], 465),
|
||||||
|
(["master", "smtpd"], 587),
|
||||||
|
("imap-login", 993),
|
||||||
|
("iroh-relay", 3340),
|
||||||
|
("nginx", 8443),
|
||||||
|
(["master", "smtpd"], config.postfix_reinject_port),
|
||||||
|
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
||||||
|
("filtermail", config.filtermail_smtp_port),
|
||||||
|
("filtermail", config.filtermail_smtp_port_incoming),
|
||||||
|
]
|
||||||
|
for service, port in port_services:
|
||||||
|
print(f"Checking if port {port} is available for {service}...")
|
||||||
|
running_service = host.get_fact(Port, port=port)
|
||||||
|
if running_service:
|
||||||
|
if running_service not in service:
|
||||||
|
Out().red(f"Deploy failed: port {port} is occupied by: {running_service}")
|
||||||
|
exit(1)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install unbound",
|
name="Install unbound",
|
||||||
packages=["unbound", "unbound-anchor", "dnsutils"],
|
packages=["unbound", "unbound-anchor", "dnsutils"],
|
||||||
@@ -632,10 +736,10 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
packages="postfix",
|
packages="postfix",
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
if not "dovecot.service" in host.get_fact(SystemdEnabled):
|
||||||
name="Install Dovecot",
|
_install_dovecot_package("core", host.get_fact(facts.server.Arch))
|
||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
_install_dovecot_package("imapd", host.get_fact(facts.server.Arch))
|
||||||
)
|
_install_dovecot_package("lmtpd", host.get_fact(facts.server.Arch))
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install nginx",
|
name="Install nginx",
|
||||||
@@ -647,19 +751,23 @@ def deploy_chatmail(config_path: Path, disable_mail: bool) -> None:
|
|||||||
packages=["fcgiwrap"],
|
packages=["fcgiwrap"],
|
||||||
)
|
)
|
||||||
|
|
||||||
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
www_path, src_dir, build_dir = get_paths(config)
|
||||||
|
# if www_folder was set to a non-existing folder, skip upload
|
||||||
build_dir = www_path.joinpath("build")
|
if not www_path.is_dir():
|
||||||
src_dir = www_path.joinpath("src")
|
logger.warning("Building web pages is disabled in chatmail.ini, skipping")
|
||||||
build_webpages(src_dir, build_dir, config)
|
else:
|
||||||
files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
|
# if www_folder is a hugo page, build it
|
||||||
|
if build_dir:
|
||||||
|
www_path = build_webpages(src_dir, build_dir, config)
|
||||||
|
# if it is not a hugo page, upload it as is
|
||||||
|
files.rsync(f"{www_path}/", "/var/www/html", flags=["-avz"])
|
||||||
|
|
||||||
_install_remote_venv_with_chatmaild(config)
|
_install_remote_venv_with_chatmaild(config)
|
||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
dovecot_need_restart = _configure_dovecot(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")
|
||||||
@@ -669,18 +777,10 @@ 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.
|
||||||
@@ -730,10 +830,29 @@ 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"],
|
||||||
)
|
)
|
||||||
|
try:
|
||||||
|
git_hash = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode()
|
||||||
|
except Exception:
|
||||||
|
git_hash = "unknown\n"
|
||||||
|
try:
|
||||||
|
git_diff = subprocess.check_output(["git", "diff"]).decode()
|
||||||
|
except Exception:
|
||||||
|
git_diff = ""
|
||||||
|
files.put(
|
||||||
|
name="Upload chatmail relay git commiit hash",
|
||||||
|
src=StringIO(git_hash + git_diff),
|
||||||
|
dest="/etc/chatmail-version",
|
||||||
|
mode="700",
|
||||||
|
)
|
||||||
|
|
||||||
deploy_mtail(config)
|
deploy_mtail(config)
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.systemd import SystemdStatus
|
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
from pyinfra.operations import apt, files, server, systemd
|
||||||
|
|
||||||
|
|
||||||
@@ -54,12 +52,6 @@ def deploy_acmetool(email="", domains=[]):
|
|||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
if host.get_fact(SystemdStatus).get("nginx.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Stop nginx service to free port 80",
|
|
||||||
service="nginx",
|
|
||||||
running=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Setup acmetool-redirector service",
|
name="Setup acmetool-redirector service",
|
||||||
@@ -70,6 +62,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.4-April-3-2024.pdf": true
|
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.5-February-24-2025.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:{{ mail_domain }} ~all"
|
{{ mail_domain }}. TXT "v=spf1 a ~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 %}
|
||||||
|
|||||||
@@ -56,12 +56,12 @@ def run_cmd_options(parser):
|
|||||||
"--disable-mail",
|
"--disable-mail",
|
||||||
dest="disable_mail",
|
dest="disable_mail",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
help="install/upgrade the server, but disable postfix & dovecot for now"
|
help="install/upgrade the server, but disable postfix & dovecot for now",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--ssh-host",
|
"--ssh-host",
|
||||||
dest="ssh_host",
|
dest="ssh_host",
|
||||||
help="specify an SSH host to deploy to; uses mail_domain from chatmail.ini by default"
|
help="specify an SSH host to deploy to; uses mail_domain from chatmail.ini by default",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -86,15 +86,27 @@ def run_cmd(args, out):
|
|||||||
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
|
||||||
|
|
||||||
retcode = out.check_call(cmd, env=env)
|
try:
|
||||||
if retcode == 0:
|
retcode = out.check_call(cmd, env=env)
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
if retcode == 0:
|
||||||
elif not remote_data["acme_account_url"]:
|
print("\nYou can try out the relay by talking to this echo bot: ")
|
||||||
out.red("Deploy completed but letsencrypt not configured")
|
sshexec = SSHExec(args.config.mail_domain, verbose=args.verbose)
|
||||||
out.red("Run 'cmdeploy run' again")
|
print(
|
||||||
retcode = 0
|
sshexec(
|
||||||
else:
|
call=remote.rshell.shell,
|
||||||
|
kwargs=dict(command="cat /var/lib/echobot/invite-link.txt"),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
out.green("Deploy completed, call `cmdeploy dns` next.")
|
||||||
|
elif not remote_data["acme_account_url"]:
|
||||||
|
out.red("Deploy completed but letsencrypt not configured")
|
||||||
|
out.red("Run 'cmdeploy run' again")
|
||||||
|
retcode = 0
|
||||||
|
else:
|
||||||
|
out.red("Deploy failed")
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
out.red("Deploy failed")
|
out.red("Deploy failed")
|
||||||
|
retcode = 1
|
||||||
return retcode
|
return retcode
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ 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'))
|
disable_mail = bool(os.environ.get("CHATMAIL_DISABLE_MAIL"))
|
||||||
|
|
||||||
deploy_chatmail(config_path, disable_mail)
|
deploy_chatmail(config_path, disable_mail)
|
||||||
|
|
||||||
|
|||||||
@@ -56,6 +56,11 @@ def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
|||||||
out(line)
|
out(line)
|
||||||
out("")
|
out("")
|
||||||
returncode = 1
|
returncode = 1
|
||||||
|
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:
|
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:
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ userdb {
|
|||||||
##
|
##
|
||||||
|
|
||||||
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
||||||
mail_location = maildir:{{ config.mailboxes_dir }}/%u
|
mail_location = maildir:{{ config.mailboxes_dir }}/%u:INDEX=MEMORY
|
||||||
|
|
||||||
namespace inbox {
|
namespace inbox {
|
||||||
inbox = yes
|
inbox = yes
|
||||||
@@ -177,20 +177,34 @@ service auth-worker {
|
|||||||
}
|
}
|
||||||
|
|
||||||
service imap-login {
|
service imap-login {
|
||||||
# High-security mode.
|
# High-performance mode as described in
|
||||||
# Each process serves a single connection and exits afterwards.
|
# <https://doc.dovecot.org/2.3/admin_manual/login_processes/#high-performance-mode>
|
||||||
# This is the default, but we set it explicitly to be sure.
|
|
||||||
# See <https://doc.dovecot.org/admin_manual/login_processes/#high-security-mode> for details.
|
|
||||||
service_count = 1
|
|
||||||
|
|
||||||
# Inrease the number of simultaneous connections.
|
|
||||||
#
|
#
|
||||||
# As of Dovecot 2.3.19.1 the default is 100 processes.
|
# So-called high-security mode described in
|
||||||
# Combined with `service_count = 1` it means only 100 connections
|
# <https://doc.dovecot.org/2.3/admin_manual/login_processes/#high-security-mode>
|
||||||
# can be handled simultaneously.
|
# and enabled by default with `service_count = 1` starts one process per connection
|
||||||
process_limit = 10000
|
# and has problems logging in thousands of users after Dovecot restart.
|
||||||
|
service_count = 0
|
||||||
|
|
||||||
|
# Increase virtual memory size limit.
|
||||||
|
# Since imap-login processes handle TLS connections
|
||||||
|
# even after logging users in
|
||||||
|
# and many connections are handled by each process,
|
||||||
|
# memory size limit should be increased.
|
||||||
|
#
|
||||||
|
# Otherwise the whole process eventually dies
|
||||||
|
# with an error similar to
|
||||||
|
# imap-login: Fatal: master: service(imap-login):
|
||||||
|
# child 1422951 returned error 83
|
||||||
|
# (Out of memory (service imap-login { vsz_limit=256 MB },
|
||||||
|
# you may need to increase it)
|
||||||
|
# and takes down all its TLS connections at once.
|
||||||
|
vsz_limit = 1G
|
||||||
|
|
||||||
# Avoid startup latency for new connections.
|
# Avoid startup latency for new connections.
|
||||||
|
#
|
||||||
|
# Should be set to at least the number of CPU cores
|
||||||
|
# according to the documentation.
|
||||||
process_min_avail = 10
|
process_min_avail = 10
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -209,7 +223,7 @@ 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.2
|
ssl_min_protocol = TLSv1.3
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
# delete already seen big mails after 7 days, in the INBOX
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/cur/*' -mtime +{{ config.delete_large_after }} -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
|
||||||
|
|||||||
@@ -2,15 +2,6 @@ function dovecot_lua_notify_begin_txn(user)
|
|||||||
return user
|
return user
|
||||||
end
|
end
|
||||||
|
|
||||||
function contains(v, needle)
|
|
||||||
for _, keyword in ipairs(v) do
|
|
||||||
if keyword == needle then
|
|
||||||
return true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
return false
|
|
||||||
end
|
|
||||||
|
|
||||||
function dovecot_lua_notify_event_message_new(user, event)
|
function dovecot_lua_notify_event_message_new(user, event)
|
||||||
local mbox = user:mailbox(event.mailbox)
|
local mbox = user:mailbox(event.mailbox)
|
||||||
mbox:sync()
|
mbox:sync()
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ Description=mtail
|
|||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=simple
|
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 -"
|
ExecStart=/bin/sh -c "journalctl -f -o short-iso -n 0 | /usr/local/bin/mtail --address={{ address }} --port={{ port }} --progs /etc/mtail --logtostderr --logs -"
|
||||||
Restart=on-failure
|
Restart=on-failure
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
|
|||||||
@@ -2,11 +2,25 @@ load_module modules/ngx_stream_module.so;
|
|||||||
|
|
||||||
user www-data;
|
user www-data;
|
||||||
worker_processes auto;
|
worker_processes auto;
|
||||||
|
|
||||||
|
# Increase the number of connections
|
||||||
|
# that a worker process can open
|
||||||
|
# to avoid errors such as
|
||||||
|
# accept4() failed (24: Too many open files)
|
||||||
|
# and
|
||||||
|
# socket() failed (24: Too many open files) while connecting to upstream
|
||||||
|
# in the logs.
|
||||||
|
# <https://nginx.org/en/docs/ngx_core_module.html#worker_rlimit_nofile>
|
||||||
|
worker_rlimit_nofile 2048;
|
||||||
pid /run/nginx.pid;
|
pid /run/nginx.pid;
|
||||||
error_log syslog:server=unix:/dev/log,facility=local3;
|
error_log syslog:server=unix:/dev/log,facility=local3;
|
||||||
|
|
||||||
events {
|
events {
|
||||||
worker_connections 768;
|
# Increase to avoid errors such as
|
||||||
|
# 768 worker_connections are not enough while connecting to upstream
|
||||||
|
# in the logs.
|
||||||
|
# <https://nginx.org/en/docs/ngx_core_module.html#worker_connections>
|
||||||
|
worker_connections 2048;
|
||||||
# multi_accept on;
|
# multi_accept on;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -46,10 +60,7 @@ http {
|
|||||||
|
|
||||||
server {
|
server {
|
||||||
|
|
||||||
listen 8443 ssl default_server;
|
listen 127.0.0.1:8443 ssl default_server;
|
||||||
{% if not disable_ipv6 %}
|
|
||||||
listen [::]:8443 ssl default_server;
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
root /var/www/html;
|
root /var/www/html;
|
||||||
|
|
||||||
@@ -73,12 +84,13 @@ http {
|
|||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
# Redirect to Delta Chat,
|
# Redirect to Delta Chat,
|
||||||
# which will in turn do a POST request.
|
# which will in turn do a POST request.
|
||||||
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
return 301 dcaccount:https://{{ config.domain_name }}$request_uri;
|
||||||
}
|
}
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
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;
|
||||||
|
fastcgi_param QUERY_STRING $query_string;
|
||||||
}
|
}
|
||||||
|
|
||||||
# Old URL for compatibility with e.g. printed QR codes.
|
# Old URL for compatibility with e.g. printed QR codes.
|
||||||
@@ -89,7 +101,7 @@ http {
|
|||||||
# Redirects are only for browsers.
|
# Redirects are only for browsers.
|
||||||
location /cgi-bin/newemail.py {
|
location /cgi-bin/newemail.py {
|
||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
return 301 dcaccount:https://{{ config.domain_name }}$request_uri;
|
||||||
}
|
}
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
@@ -120,10 +132,7 @@ http {
|
|||||||
|
|
||||||
# Redirect www. to non-www
|
# Redirect www. to non-www
|
||||||
server {
|
server {
|
||||||
listen 8443 ssl;
|
listen 127.0.0.1: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;
|
||||||
|
|||||||
3
cmdeploy/src/cmdeploy/opendkim/systemd.conf
Normal file
3
cmdeploy/src/cmdeploy/opendkim/systemd.conf
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
[Service]
|
||||||
|
Restart=always
|
||||||
|
RuntimeMaxSec=1d
|
||||||
@@ -20,9 +20,12 @@ 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=may
|
smtp_tls_security_level=verify
|
||||||
|
# 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 = socketmap:inet:127.0.0.1:8461:postfix
|
smtp_tls_policy_maps = inline:{nauta.cu=may}
|
||||||
smtpd_tls_protocols = >=TLSv1.2
|
smtpd_tls_protocols = >=TLSv1.2
|
||||||
|
|
||||||
# Disable anonymous cipher suites
|
# Disable anonymous cipher suites
|
||||||
|
|||||||
@@ -14,10 +14,11 @@ smtp inet n - y - - smtpd -v
|
|||||||
{%- else %}
|
{%- else %}
|
||||||
smtp inet n - y - - smtpd
|
smtp inet n - y - - smtpd
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
-o smtpd_milters=unix:opendkim/opendkim.sock
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port_incoming }}
|
||||||
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
|
||||||
@@ -31,11 +32,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
|
||||||
@@ -48,7 +49,6 @@ 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,17 +76,27 @@ 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 filered mail.
|
# Local SMTP server for reinjecting outgoing filtered mail.
|
||||||
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
127.0.0.1:{{ 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,3 +2,4 @@
|
|||||||
/^X-Originating-IP:/ IGNORE
|
/^X-Originating-IP:/ IGNORE
|
||||||
/^X-Mailer:/ IGNORE
|
/^X-Mailer:/ IGNORE
|
||||||
/^User-Agent:/ IGNORE
|
/^User-Agent:/ IGNORE
|
||||||
|
/^Subject:/ REPLACE Subject: [...]
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ def perform_initial_checks(mail_domain):
|
|||||||
"""Collecting initial DNS settings."""
|
"""Collecting initial DNS settings."""
|
||||||
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 update && apt-get install -y dnsutils")
|
||||||
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}")
|
||||||
@@ -27,7 +27,9 @@ def perform_initial_checks(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["acme_account_url"] = shell("acmetool account-url", fail_ok=True)
|
||||||
res["dkim_entry"] = get_dkim_entry(mail_domain, dkim_selector="opendkim")
|
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
|
||||||
@@ -48,7 +50,11 @@ 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))
|
||||||
return f'{dkim_selector}._domainkey.{mail_domain}. TXT "{dkim_value}"'
|
web_dkim_value = "".join(re.findall(".{1,255}", dkim_value_raw))
|
||||||
|
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):
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
from subprocess import CalledProcessError, check_output
|
from subprocess import DEVNULL, 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, shell=True).decode().rstrip()
|
return check_output(command, **args).decode().rstrip()
|
||||||
except CalledProcessError:
|
except CalledProcessError:
|
||||||
if not fail_ok:
|
if not fail_ok:
|
||||||
raise
|
raise
|
||||||
@@ -14,3 +17,22 @@ 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,6 +7,7 @@ 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,6 +7,7 @@ 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
|
||||||
|
|||||||
12
cmdeploy/src/cmdeploy/service/filtermail-incoming.service.f
Normal file
12
cmdeploy/src/cmdeploy/service/filtermail-incoming.service.f
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
[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=Chatmail Postfix before queue filter
|
Description=Outgoing Chatmail Postfix before queue filter
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} {config_path}
|
ExecStart={execpath} {config_path} outgoing
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=filtermail
|
User=vmail
|
||||||
|
|
||||||
[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_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_protected_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_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_protected_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):
|
||||||
|
|||||||
@@ -90,8 +90,13 @@ def test_concurrent_logins_same_account(
|
|||||||
|
|
||||||
|
|
||||||
def test_no_vrfy(chatmail_config):
|
def test_no_vrfy(chatmail_config):
|
||||||
|
domain = chatmail_config.mail_domain
|
||||||
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
sock.connect((chatmail_config.mail_domain, 25))
|
sock.settimeout(10)
|
||||||
|
try:
|
||||||
|
sock.connect((domain, 25))
|
||||||
|
except socket.timeout:
|
||||||
|
pytest.skip(f"port 25 not reachable for {domain}")
|
||||||
banner = sock.recv(1024)
|
banner = sock.recv(1024)
|
||||||
print(banner)
|
print(banner)
|
||||||
sock.send(b"VRFY wrongaddress@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
sock.send(b"VRFY wrongaddress@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
|
import datetime
|
||||||
import smtplib
|
import smtplib
|
||||||
|
import socket
|
||||||
|
import subprocess
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
@@ -52,6 +55,23 @@ 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."""
|
||||||
|
cmd = "systemctl show opendkim --timestamp=utc --property=ActiveEnterTimestamp"
|
||||||
|
out = sshexec(call=remote.rshell.shell, kwargs=dict(command=cmd))
|
||||||
|
datestring = out.split("=")[1]
|
||||||
|
since_date = datetime.datetime.strptime(datestring, "%a %Y-%m-%d %H:%M:%S %Z")
|
||||||
|
now = datetime.datetime.now(since_date.tzinfo)
|
||||||
|
assert (now - since_date).total_seconds() < 60 * 60 * 51
|
||||||
|
|
||||||
|
|
||||||
|
def test_timezone_env(remote):
|
||||||
|
for line in remote.iter_output("env"):
|
||||||
|
print(line)
|
||||||
|
if line == "tz=:/etc/localtime":
|
||||||
|
return True
|
||||||
|
pytest.fail("TZ is not set")
|
||||||
|
|
||||||
|
|
||||||
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)
|
||||||
@@ -107,14 +127,46 @@ 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."""
|
domain = cmsetup.maildomain
|
||||||
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
sock.settimeout(10)
|
||||||
|
try:
|
||||||
|
sock.connect((domain, 25))
|
||||||
|
except socket.timeout:
|
||||||
|
pytest.skip(f"port 25 not reachable for {domain}")
|
||||||
|
|
||||||
recipient = cmsetup.gen_users(1)[0]
|
recipient = cmsetup.gen_users(1)[0]
|
||||||
msg = maildata("plain.eml", from_addr=from_addr, to_addr=recipient.addr).as_string()
|
msg = maildata(
|
||||||
with smtplib.SMTP(cmsetup.maildomain, 25) as s:
|
"encrypted.eml", from_addr=from_addr, to_addr=recipient.addr
|
||||||
|
).as_string()
|
||||||
|
conn = smtplib.SMTP(cmsetup.maildomain, 25, timeout=10)
|
||||||
|
|
||||||
|
with conn 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."""
|
||||||
@@ -147,6 +199,25 @@ def test_expunged(remote, chatmail_config):
|
|||||||
f"find {chatmail_config.mailboxes_dir} -path '*/tmp/*' -mtime +{outdated_days} -type f",
|
f"find {chatmail_config.mailboxes_dir} -path '*/tmp/*' -mtime +{outdated_days} -type f",
|
||||||
f"find {chatmail_config.mailboxes_dir} -path '*/.*/tmp/*' -mtime +{outdated_days} -type f",
|
f"find {chatmail_config.mailboxes_dir} -path '*/.*/tmp/*' -mtime +{outdated_days} -type f",
|
||||||
]
|
]
|
||||||
|
outdated_days = int(chatmail_config.delete_large_after) + 1
|
||||||
|
find_cmds.append(
|
||||||
|
"find {chatmail_config.mailboxes_dir} -path '*/cur/*' -mtime +{outdated_days} -size +200k -type f"
|
||||||
|
)
|
||||||
for cmd in find_cmds:
|
for cmd in find_cmds:
|
||||||
for line in remote.iter_output(cmd):
|
for line in remote.iter_output(cmd):
|
||||||
assert not line
|
assert not line
|
||||||
|
|
||||||
|
|
||||||
|
def test_deployed_state(remote):
|
||||||
|
git_hash = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode()
|
||||||
|
git_diff = subprocess.check_output(["git", "diff"]).decode()
|
||||||
|
git_status = [git_hash.strip()]
|
||||||
|
for line in git_diff.splitlines():
|
||||||
|
git_status.append(line.strip().lower())
|
||||||
|
remote_version = []
|
||||||
|
for line in remote.iter_output("cat /etc/chatmail-version"):
|
||||||
|
print(line)
|
||||||
|
remote_version.append(line)
|
||||||
|
# assert len(git_status) == len(remote_version) # for some reason, we only get 11 lines from remote.iter_output()
|
||||||
|
for i in range(len(remote_version)):
|
||||||
|
assert git_status[i] == remote_version[i], "You have undeployed changes."
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import ipaddress
|
import ipaddress
|
||||||
import random
|
|
||||||
import re
|
import re
|
||||||
import time
|
import time
|
||||||
|
|
||||||
@@ -7,6 +6,9 @@ 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):
|
||||||
@@ -54,22 +56,23 @@ 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_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_protected_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"
|
||||||
|
|
||||||
@pytest.mark.slow
|
def test_exceed_quota(
|
||||||
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote, chatmail_config):
|
self, cmfactory, lp, tmpdir, remote, chatmail_config, sshdomain
|
||||||
|
):
|
||||||
"""This is a very slow test as it needs to upload >100MB of mail data
|
"""This is a very slow test as it needs to upload >100MB of mail data
|
||||||
before quota is exceeded, and thus depends on the speed of the upload.
|
before quota is exceeded, and thus depends on the speed of the upload.
|
||||||
"""
|
"""
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_protected_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.
|
||||||
@@ -82,49 +85,27 @@ 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)
|
|
||||||
|
|
||||||
msg = chat.send_file(str(attachment))
|
lp.sec(f"filling remote inbox for {user}")
|
||||||
msgs.append(msg)
|
fn = f"7743102289.M843172P2484002.c20,S={quota},W=2398:2,"
|
||||||
lp.indent(f"Sent out msg {i}, size {attachsize/(1024*1024)}MB")
|
path = chatmail_config.mailboxes_dir.joinpath(user, "cur", fn)
|
||||||
|
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 messages are arriving until quota is reached")
|
lp.sec("ac2: check quota is triggered")
|
||||||
|
|
||||||
addr = ac2.get_config("addr").lower()
|
starting = True
|
||||||
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 addr not in line:
|
if starting:
|
||||||
|
chat.send_text("hello")
|
||||||
|
starting = False
|
||||||
|
if user not in line:
|
||||||
# print(line)
|
# print(line)
|
||||||
continue
|
continue
|
||||||
if "quota" in line:
|
if "quota exceeded" in line:
|
||||||
if "quota exceeded" in line:
|
return
|
||||||
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)
|
||||||
@@ -172,7 +153,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_accepted_chat(user1, user2)
|
chat = cmfactory.get_protected_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()
|
||||||
@@ -181,11 +162,18 @@ 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):
|
def test_echobot(cmfactory, chatmail_config, lp, sshdomain):
|
||||||
ac = cmfactory.get_online_accounts(1)[0]
|
ac = cmfactory.get_online_accounts(1)[0]
|
||||||
|
|
||||||
lp.sec(f"Send message to echo@{chatmail_config.mail_domain}")
|
# establish contact with echobot
|
||||||
chat = ac.create_chat(f"echo@{chatmail_config.mail_domain}")
|
sshexec = SSHExec(sshdomain)
|
||||||
|
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 ssh-reachable chatmail instance")
|
pytest.skip("set CHATMAIL_DOMAIN2 to a second chatmail server")
|
||||||
return domain
|
return domain
|
||||||
|
|
||||||
|
|
||||||
@@ -302,10 +302,13 @@ def cmfactory(request, gencreds, tmpdir, maildomain):
|
|||||||
pytest.importorskip("deltachat")
|
pytest.importorskip("deltachat")
|
||||||
from deltachat.testplugin import ACFactory
|
from deltachat.testplugin import ACFactory
|
||||||
|
|
||||||
data = request.getfixturevalue("data")
|
|
||||||
|
|
||||||
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
||||||
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
|
||||||
|
class Data:
|
||||||
|
def read_path(self, path):
|
||||||
|
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
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
|
import importlib
|
||||||
import os
|
import os
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from cmdeploy.cmdeploy import get_parser, main
|
from cmdeploy.cmdeploy import get_parser, main
|
||||||
|
from cmdeploy.www import get_paths
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
@@ -27,3 +29,28 @@ class TestCmdline:
|
|||||||
assert main(["init", "chat.example.org"]) == 1
|
assert main(["init", "chat.example.org"]) == 1
|
||||||
out, err = capsys.readouterr()
|
out, err = capsys.readouterr()
|
||||||
assert "path exists" in out.lower()
|
assert "path exists" in out.lower()
|
||||||
|
|
||||||
|
|
||||||
|
def test_www_folder(example_config, tmp_path):
|
||||||
|
reporoot = importlib.resources.files(__package__).joinpath("../../../../").resolve()
|
||||||
|
assert not example_config.www_folder
|
||||||
|
www_path, src_dir, build_dir = get_paths(example_config)
|
||||||
|
assert www_path.absolute() == reporoot.joinpath("www").absolute()
|
||||||
|
assert src_dir == reporoot.joinpath("www").joinpath("src")
|
||||||
|
assert build_dir == reporoot.joinpath("www").joinpath("build")
|
||||||
|
example_config.www_folder = "disabled"
|
||||||
|
www_path, _, _ = get_paths(example_config)
|
||||||
|
assert not www_path.is_dir()
|
||||||
|
example_config.www_folder = str(tmp_path)
|
||||||
|
www_path, src_dir, build_dir = get_paths(example_config)
|
||||||
|
assert www_path == tmp_path
|
||||||
|
assert not src_dir.exists()
|
||||||
|
assert not build_dir
|
||||||
|
src_path = tmp_path.joinpath("src")
|
||||||
|
os.mkdir(src_path)
|
||||||
|
with open(src_path / "index.md", "w") as f:
|
||||||
|
f.write("# Test")
|
||||||
|
www_path, src_dir, build_dir = get_paths(example_config)
|
||||||
|
assert www_path == tmp_path
|
||||||
|
assert src_dir == src_path
|
||||||
|
assert build_dir == tmp_path.joinpath("build")
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import importlib.resources
|
|||||||
import time
|
import time
|
||||||
import traceback
|
import traceback
|
||||||
import webbrowser
|
import webbrowser
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
import markdown
|
import markdown
|
||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
@@ -30,9 +31,25 @@ def prepare_template(source):
|
|||||||
return render_vars, page_layout
|
return render_vars, page_layout
|
||||||
|
|
||||||
|
|
||||||
def build_webpages(src_dir, build_dir, config):
|
def get_paths(config) -> (Path, Path, Path):
|
||||||
|
reporoot = importlib.resources.files(__package__).joinpath("../../../").resolve()
|
||||||
|
www_path = Path(config.www_folder)
|
||||||
|
# if www_folder was not set, use default directory
|
||||||
|
if config.www_folder == "":
|
||||||
|
www_path = reporoot.joinpath("www")
|
||||||
|
src_dir = www_path.joinpath("src")
|
||||||
|
# if www_folder is a hugo page, build it
|
||||||
|
if src_dir.joinpath("index.md").is_file():
|
||||||
|
build_dir = www_path.joinpath("build")
|
||||||
|
# if it is not a hugo page, upload it as is
|
||||||
|
else:
|
||||||
|
build_dir = None
|
||||||
|
return www_path, src_dir, build_dir
|
||||||
|
|
||||||
|
|
||||||
|
def build_webpages(src_dir, build_dir, config) -> Path:
|
||||||
try:
|
try:
|
||||||
_build_webpages(src_dir, build_dir, config)
|
return _build_webpages(src_dir, build_dir, config)
|
||||||
except Exception:
|
except Exception:
|
||||||
print(traceback.format_exc())
|
print(traceback.format_exc())
|
||||||
|
|
||||||
@@ -106,15 +123,11 @@ def main():
|
|||||||
config = read_config(inipath)
|
config = read_config(inipath)
|
||||||
config.webdev = True
|
config.webdev = True
|
||||||
assert config.mail_domain
|
assert config.mail_domain
|
||||||
www_path = reporoot.joinpath("www")
|
|
||||||
src_path = www_path.joinpath("src")
|
|
||||||
stats = None
|
|
||||||
build_dir = www_path.joinpath("build")
|
|
||||||
src_dir = www_path.joinpath("src")
|
|
||||||
index_path = build_dir.joinpath("index.html")
|
|
||||||
|
|
||||||
# start web page generation, open a browser and wait for changes
|
# start web page generation, open a browser and wait for changes
|
||||||
build_webpages(src_dir, build_dir, config)
|
www_path, src_path, build_dir = get_paths(config)
|
||||||
|
build_dir = build_webpages(src_path, build_dir, config)
|
||||||
|
index_path = build_dir.joinpath("index.html")
|
||||||
webbrowser.open(str(index_path))
|
webbrowser.open(str(index_path))
|
||||||
stats = snapshot_dir_stats(src_path)
|
stats = snapshot_dir_stats(src_path)
|
||||||
print(f"\nOpened URL: file://{index_path.resolve()}\n")
|
print(f"\nOpened URL: file://{index_path.resolve()}\n")
|
||||||
@@ -135,7 +148,7 @@ def main():
|
|||||||
changenum += 1
|
changenum += 1
|
||||||
|
|
||||||
stats = newstats
|
stats = newstats
|
||||||
build_webpages(src_dir, build_dir, config)
|
build_webpages(src_path, build_dir, config)
|
||||||
print(f"[{changenum}] regenerated web pages at: {index_path}")
|
print(f"[{changenum}] regenerated web pages at: {index_path}")
|
||||||
print(f"URL: file://{index_path.resolve()}\n\n")
|
print(f"URL: file://{index_path.resolve()}\n\n")
|
||||||
count = 0
|
count = 0
|
||||||
|
|||||||
@@ -1,5 +1,23 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
|
if command -v lsb_release 2>&1 >/dev/null; then
|
||||||
|
case "$(lsb_release -is)" in
|
||||||
|
Ubuntu | Debian )
|
||||||
|
if ! dpkg -l | grep python3-dev 2>&1 >/dev/null
|
||||||
|
then
|
||||||
|
echo "You need to install python3-dev for installing the other dependencies."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! gcc --version 2>&1 >/dev/null
|
||||||
|
then
|
||||||
|
echo "You need to install gcc for building Python dependencies."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
python3 -m venv --upgrade-deps venv
|
python3 -m venv --upgrade-deps venv
|
||||||
|
|
||||||
venv/bin/pip install -e chatmaild
|
venv/bin/pip install -e chatmaild
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ for Delta Chat users. For details how it avoids storing personal information
|
|||||||
please see our [privacy policy](privacy.html).
|
please see our [privacy policy](privacy.html).
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
{% if not config.invite_token %}
|
||||||
<a class="cta-button" href="DCACCOUNT:https://{{ config.mail_domain }}/new">Get a {{config.mail_domain}} chat profile</a>
|
<a class="cta-button" href="DCACCOUNT:https://{{ config.mail_domain }}/new">Get a {{config.mail_domain}} chat profile</a>
|
||||||
|
|
||||||
If you are viewing this page on a different device
|
If you are viewing this page on a different device
|
||||||
@@ -23,6 +24,10 @@ you can also **scan this QR code** with Delta Chat:
|
|||||||
🐣 **Choose** your Avatar and Name
|
🐣 **Choose** your Avatar and Name
|
||||||
|
|
||||||
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
||||||
|
{% else %}
|
||||||
|
**To join this instance, you need an invite link or QR code -
|
||||||
|
ask the admin for an invite.**
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% if config.mail_domain != "nine.testrun.org" %}
|
{% if config.mail_domain != "nine.testrun.org" %}
|
||||||
<div class="experimental">Note: this is only a temporary development chatmail service</div>
|
<div class="experimental">Note: this is only a temporary development chatmail service</div>
|
||||||
|
|||||||
@@ -6,29 +6,6 @@ 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
|
||||||
|
|
||||||
@@ -38,10 +15,11 @@ The first login sets your password.
|
|||||||
|
|
||||||
- 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.
|
||||||
|
|
||||||
- Messages are unconditionally removed {{ 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).
|
- 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 latest {{ config.delete_mails_after }} days after arriving on the server.
|
||||||
|
Earlier, if storage may exceed otherwise.
|
||||||
|
|
||||||
|
|
||||||
### <a name="account-deletion"></a> Account deletion
|
### <a name="account-deletion"></a> Account deletion
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user