mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
Compare commits
360 Commits
link2xt/se
...
fix221
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e313bc3707 | ||
|
|
21778fa4f3 | ||
|
|
14342383cf | ||
|
|
926de76010 | ||
|
|
ee25d35db1 | ||
|
|
ee2115584b | ||
|
|
1c9c088657 | ||
|
|
b5afac2f1a | ||
|
|
c8d9f20a48 | ||
|
|
6a30db7ce0 | ||
|
|
9e9ab80422 | ||
|
|
5b9debfbdf | ||
|
|
788309b85a | ||
|
|
5bbb3d9b21 | ||
|
|
6bc2186912 | ||
|
|
8d5f91bf98 | ||
|
|
9ddf60d0fc | ||
|
|
05bdf65996 | ||
|
|
6d6217812d | ||
|
|
ea36e73b8e | ||
|
|
da268b57d4 | ||
|
|
5588e13e54 | ||
|
|
7c7f1cad7f | ||
|
|
a6b333672d | ||
|
|
29857143c9 | ||
|
|
d1460e7a1a | ||
|
|
87ab7e83d5 | ||
|
|
9f31357a9c | ||
|
|
c94ef0379a | ||
|
|
bc66325d71 | ||
|
|
27f44ae911 | ||
|
|
3940b9256d | ||
|
|
4886ff9b86 | ||
|
|
38a9fc3d6e | ||
|
|
e676545f7a | ||
|
|
ef95627138 | ||
|
|
bfaedb5cf1 | ||
|
|
ea8d53aa9b | ||
|
|
be7a000de6 | ||
|
|
ad3cf9ecaa | ||
|
|
691324a3e8 | ||
|
|
23a9f893b4 | ||
|
|
3ea826aecb | ||
|
|
532d094a08 | ||
|
|
0cea5840df | ||
|
|
45686778ea | ||
|
|
45108d9c93 | ||
|
|
3665d957a7 | ||
|
|
86940b2ee1 | ||
|
|
24fb9eb65b | ||
|
|
700256c273 | ||
|
|
d575d62b18 | ||
|
|
8cdf8ce376 | ||
|
|
7c9abfbde3 | ||
|
|
95de87a325 | ||
|
|
5366df8dc6 | ||
|
|
0a6db5161d | ||
|
|
62e25e44fd | ||
|
|
ce9fe920dc | ||
|
|
c171866faf | ||
|
|
7758c94e31 | ||
|
|
66debb9245 | ||
|
|
3542232393 | ||
|
|
536c12d989 | ||
|
|
265403e110 | ||
|
|
fd679af577 | ||
|
|
ecbf135549 | ||
|
|
7b90b936dd | ||
|
|
17a919ee53 | ||
|
|
1b15ec0eae | ||
|
|
bf863f05b6 | ||
|
|
a2316beab1 | ||
|
|
28fc91f5f3 | ||
|
|
67062677b0 | ||
|
|
faf8ffe678 | ||
|
|
5821098699 | ||
|
|
542d63888a | ||
|
|
449f8a014c | ||
|
|
57764d0cf5 | ||
|
|
c39a79e26a | ||
|
|
b6622fc68e | ||
|
|
75b41641f0 | ||
|
|
30a61972fb | ||
|
|
bcc54602ee | ||
|
|
f9998d5721 | ||
|
|
8605ceba5e | ||
|
|
30bcf9ff77 | ||
|
|
70b0e9d5e5 | ||
|
|
fdd533aa3b | ||
|
|
a44ed0aeb3 | ||
|
|
f5bfa6bd56 | ||
|
|
81a6f8808b | ||
|
|
be3685519f | ||
|
|
2cf950e901 | ||
|
|
46d5dbb07d | ||
|
|
d2e0d1fecc | ||
|
|
d333cfdd5a | ||
|
|
32238e99ab | ||
|
|
40a3a2cc86 | ||
|
|
fe978a1971 | ||
|
|
b426c2e7ff | ||
|
|
b626464453 | ||
|
|
76c3316f02 | ||
|
|
a6a9406228 | ||
|
|
7921f5dd0b | ||
|
|
39fc9d628f | ||
|
|
85a9183b61 | ||
|
|
36a4381484 | ||
|
|
5ff98a571c | ||
|
|
0a91aeb4a3 | ||
|
|
c38f1d7e54 | ||
|
|
42bba52f66 | ||
|
|
03aab4043c | ||
|
|
146def2f06 | ||
|
|
d642224a73 | ||
|
|
0238437ce7 | ||
|
|
7ed59ea8bc | ||
|
|
49d0a0bbb0 | ||
|
|
330a034329 | ||
|
|
aee18215fc | ||
|
|
336f87770d | ||
|
|
4199e04ab3 | ||
|
|
50922fb1d2 | ||
|
|
d2fe417715 | ||
|
|
2b731bf909 | ||
|
|
2669babb53 | ||
|
|
fe675a9a72 | ||
|
|
79f766b28e | ||
|
|
0eeb692c4b | ||
|
|
6c401173db | ||
|
|
b474b86e7b | ||
|
|
6a9beb8ff7 | ||
|
|
d0f5d08443 | ||
|
|
49848ec01e | ||
|
|
0ffe4d4996 | ||
|
|
7a2a889585 | ||
|
|
1e4b776de5 | ||
|
|
3d00ca1672 | ||
|
|
485bbb9cbd | ||
|
|
359c195419 | ||
|
|
1b9e822ff6 | ||
|
|
9f6c00d62c | ||
|
|
a1355c10ca | ||
|
|
92ca3283fd | ||
|
|
cea1f3f5f7 | ||
|
|
39550d3096 | ||
|
|
070003b983 | ||
|
|
049ed79e59 | ||
|
|
a9e55e3b25 | ||
|
|
5a178ed235 | ||
|
|
8a338f1320 | ||
|
|
d437b8a943 | ||
|
|
a4d520a9ad | ||
|
|
9c7dfdf2ff | ||
|
|
ffd15e4a9f | ||
|
|
7f8e0620ca | ||
|
|
dc9aebcb55 | ||
|
|
648b3e0ec3 | ||
|
|
2adfed2714 | ||
|
|
12542f7bed | ||
|
|
4aca88acf8 | ||
|
|
b1ac2b78c2 | ||
|
|
4a2b37f740 | ||
|
|
bb3a0a9945 | ||
|
|
3cde5be3b4 | ||
|
|
b055736439 | ||
|
|
2817ffd411 | ||
|
|
db45dc071b | ||
|
|
1c0543cb46 | ||
|
|
dde879c7fc | ||
|
|
cf95dfd49d | ||
|
|
4a96f19faf | ||
|
|
a2a78c0aff | ||
|
|
4b3a214276 | ||
|
|
bbf0e91761 | ||
|
|
f4b8ec6e10 | ||
|
|
3b45e82c76 | ||
|
|
4551f36b85 | ||
|
|
f2d32324e3 | ||
|
|
5d4b6eec69 | ||
|
|
98fd4b61c9 | ||
|
|
74f9e7536b | ||
|
|
849b9d430c | ||
|
|
0d0cc908c2 | ||
|
|
156434b952 | ||
|
|
02d07912dd | ||
|
|
4a7e36618f | ||
|
|
e272294e07 | ||
|
|
401f215dc9 | ||
|
|
3cd4265c94 | ||
|
|
8e6869d8e3 | ||
|
|
d6df0f0604 | ||
|
|
cad1d32682 | ||
|
|
fd10652f48 | ||
|
|
02918de6c1 | ||
|
|
e27dd84501 | ||
|
|
cdbda291c5 | ||
|
|
d70eb78a76 | ||
|
|
a5e4562505 | ||
|
|
3f2eb84323 | ||
|
|
613d3e14ea | ||
|
|
453c401ac6 | ||
|
|
8b756f2e0c | ||
|
|
9e9d5b7698 | ||
|
|
02adb758ff | ||
|
|
ffade66d97 | ||
|
|
988333d5fd | ||
|
|
db41e952e3 | ||
|
|
bb1b11df15 | ||
|
|
b3fdebf8df | ||
|
|
4615df2e3b | ||
|
|
73d8e01452 | ||
|
|
bf8a99d844 | ||
|
|
cb19ac34e3 | ||
|
|
15e5573ab4 | ||
|
|
74f5b2847f | ||
|
|
e417e43c54 | ||
|
|
158ebe1089 | ||
|
|
5fb7833677 | ||
|
|
587d8142d2 | ||
|
|
a6d24b3af7 | ||
|
|
d730af2e69 | ||
|
|
99b1e18b0a | ||
|
|
6012039c56 | ||
|
|
f388e86287 | ||
|
|
d3ca037ebf | ||
|
|
00a203c9aa | ||
|
|
6bffb5470d | ||
|
|
81c4a6170f | ||
|
|
6285283b02 | ||
|
|
b71e24d6a1 | ||
|
|
a4e48c9919 | ||
|
|
bc27eb58bf | ||
|
|
1b1f9365c9 | ||
|
|
d8c8040f07 | ||
|
|
652b9688d3 | ||
|
|
59c3730d84 | ||
|
|
84db074686 | ||
|
|
7eec0ab301 | ||
|
|
7cb8f90340 | ||
|
|
32360061b4 | ||
|
|
2055e9f5b8 | ||
|
|
8cb77d3b98 | ||
|
|
c67fb69af2 | ||
|
|
960bc1599b | ||
|
|
0f05216ea0 | ||
|
|
75551224b3 | ||
|
|
0b8de41da2 | ||
|
|
f9b5783296 | ||
|
|
d3281cc746 | ||
|
|
4c7e39c10c | ||
|
|
7b3c1d5ab9 | ||
|
|
2d5eb86776 | ||
|
|
5c9d9a98b3 | ||
|
|
5eb5c09052 | ||
|
|
a86e135967 | ||
|
|
776bd87888 | ||
|
|
d7683ed3f7 | ||
|
|
0cc9f18468 | ||
|
|
889e18f803 | ||
|
|
773b8d1e00 | ||
|
|
dca6d35a6f | ||
|
|
d29d2d147b | ||
|
|
347dae1f84 | ||
|
|
63cbb83344 | ||
|
|
27d135fee7 | ||
|
|
ccd7c789f0 | ||
|
|
c7625fad81 | ||
|
|
5305dfab12 | ||
|
|
4478270fc9 | ||
|
|
e7c9992fdc | ||
|
|
a9d43c42f4 | ||
|
|
bbf2f0dd36 | ||
|
|
43c02377ef | ||
|
|
70f330b0e4 | ||
|
|
02eaa55441 | ||
|
|
6c3ec903c2 | ||
|
|
7d9b81863f | ||
|
|
af90d0a7de | ||
|
|
322bc9a3aa | ||
|
|
e4009854dc | ||
|
|
9e14a741c3 | ||
|
|
01fcb9ae0e | ||
|
|
064f6d36ad | ||
|
|
6b3590e7c8 | ||
|
|
251aac18fb | ||
|
|
f46bf2f670 | ||
|
|
40a88c7fc6 | ||
|
|
8791e7735d | ||
|
|
248f67dcf6 | ||
|
|
a24df735d4 | ||
|
|
7d0797c510 | ||
|
|
3a9db729f8 | ||
|
|
7eb86cba34 | ||
|
|
5633c0612e | ||
|
|
d5912b909c | ||
|
|
f75eb0658c | ||
|
|
7c5ec1e0df | ||
|
|
11ebc4623c | ||
|
|
cf29053389 | ||
|
|
1e7d0d10f5 | ||
|
|
3dd94cbe69 | ||
|
|
ed1b2f9da1 | ||
|
|
7ee84b44df | ||
|
|
02205246dd | ||
|
|
fcd3194eb1 | ||
|
|
bdef189ce1 | ||
|
|
3058ddc542 | ||
|
|
bada933fef | ||
|
|
1d74b94162 | ||
|
|
eee6d0c871 | ||
|
|
ed5e37f1fa | ||
|
|
364300274e | ||
|
|
848b25c790 | ||
|
|
107d10ace4 | ||
|
|
83e6a42252 | ||
|
|
eb69dd58f7 | ||
|
|
31c45f951d | ||
|
|
3012bfb79d | ||
|
|
03442bc115 | ||
|
|
1ae6291d06 | ||
|
|
1b347f97a0 | ||
|
|
902f98c9ba | ||
|
|
89311063f8 | ||
|
|
1cdc5d1351 | ||
|
|
30680cb170 | ||
|
|
c514fb00a3 | ||
|
|
c7995356b9 | ||
|
|
fb2ea27477 | ||
|
|
7cf6cc2c91 | ||
|
|
4358d5fe61 | ||
|
|
10cb099c0e | ||
|
|
329b845c79 | ||
|
|
bbd2773506 | ||
|
|
410bc50a8b | ||
|
|
015269fa7b | ||
|
|
b8673d8625 | ||
|
|
31c71fa6e9 | ||
|
|
8fcd423015 | ||
|
|
df39d05263 | ||
|
|
05ce4f769b | ||
|
|
8dc05ba7ec | ||
|
|
6701c9749c | ||
|
|
c6d8f7e759 | ||
|
|
76765164dc | ||
|
|
1ea25eb28c | ||
|
|
f333226abe | ||
|
|
45fe8a668b | ||
|
|
beac91159d | ||
|
|
75e7c85e61 | ||
|
|
040b7a74a6 | ||
|
|
0138e59355 | ||
|
|
fffbdc10c3 | ||
|
|
3419e359c8 | ||
|
|
0b051f8154 | ||
|
|
5936f7a3be | ||
|
|
983ffa6236 | ||
|
|
b74fde2a9f | ||
|
|
e176595f1f | ||
|
|
179c79a052 |
4
.github/CODE_OF_CONDUCT.md
vendored
Normal file
4
.github/CODE_OF_CONDUCT.md
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
|
||||||
|
Please refer to
|
||||||
|
[Delta Chat community standards and practices](https://delta.chat/en/community-standards)
|
||||||
|
which also apply for all chatmail developments.
|
||||||
37
.github/workflows/ci.yaml
vendored
Normal file
37
.github/workflows/ci.yaml
vendored
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
push:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
tox:
|
||||||
|
name: isolated chatmaild tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: run chatmaild tests
|
||||||
|
working-directory: chatmaild
|
||||||
|
run: pipx run tox
|
||||||
|
|
||||||
|
scripts:
|
||||||
|
name: deploy-chatmail tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: initenv
|
||||||
|
run: scripts/initenv.sh
|
||||||
|
|
||||||
|
- name: append venv/bin to PATH
|
||||||
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
|
- name: run formatting checks
|
||||||
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
|
- name: run deploy-chatmail offline tests
|
||||||
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
# all other cmdeploy commands require a staging server
|
||||||
|
# see https://github.com/deltachat/chatmail/issues/100
|
||||||
20
.github/workflows/staging.testrun.org-default.zone
vendored
Normal file
20
.github/workflows/staging.testrun.org-default.zone
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
;; Zone file for staging.testrun.org
|
||||||
|
|
||||||
|
$ORIGIN staging.testrun.org.
|
||||||
|
$TTL 300
|
||||||
|
|
||||||
|
@ IN SOA ns.testrun.org. root.nine.testrun.org (
|
||||||
|
2023010101 ; Serial
|
||||||
|
7200 ; Refresh
|
||||||
|
3600 ; Retry
|
||||||
|
1209600 ; Expire
|
||||||
|
3600 ; Negative response caching TTL
|
||||||
|
)
|
||||||
|
|
||||||
|
;; Nameservers.
|
||||||
|
@ IN NS ns.testrun.org.
|
||||||
|
|
||||||
|
;; DNS records.
|
||||||
|
@ IN A 37.27.37.98
|
||||||
|
mta-sts.staging.testrun.org. CNAME staging.testrun.org.
|
||||||
|
www.staging.testrun.org. CNAME staging.testrun.org.
|
||||||
72
.github/workflows/test-and-deploy.yaml
vendored
Normal file
72
.github/workflows/test-and-deploy.yaml
vendored
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
name: deploy on staging.testrun.org, and run tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- staging-ci
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
name: deploy on staging.testrun.org, and run tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: prepare SSH
|
||||||
|
run: |
|
||||||
|
mkdir ~/.ssh
|
||||||
|
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
||||||
|
chmod 600 ~/.ssh/id_ed25519
|
||||||
|
ssh-keyscan staging.testrun.org > ~/.ssh/known_hosts
|
||||||
|
# rsync -avz root@staging.testrun.org:/var/lib/acme . || true
|
||||||
|
# rsync -avz root@staging.testrun.org:/var/lib/rspamd/dkim . || true
|
||||||
|
|
||||||
|
#- name: rebuild staging.testrun.org to have a clean VPS
|
||||||
|
# run: |
|
||||||
|
# curl -X POST \
|
||||||
|
# -H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
||||||
|
# -H "Content-Type: application/json" \
|
||||||
|
# -d '{"image":"debian-12"}' \
|
||||||
|
# "https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_SERVER_ID }}/actions/rebuild"
|
||||||
|
|
||||||
|
- run: scripts/initenv.sh
|
||||||
|
|
||||||
|
- name: append venv/bin to PATH
|
||||||
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
|
- name: run formatting checks
|
||||||
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
|
- name: run deploy-chatmail offline tests
|
||||||
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
#- name: upload TLS cert after rebuilding
|
||||||
|
# run: |
|
||||||
|
# echo " --- wait until staging.testrun.org VPS is rebuilt --- "
|
||||||
|
# rm ~/.ssh/known_hosts
|
||||||
|
# while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new -v root@staging.testrun.org id -u ; do sleep 1 ; done
|
||||||
|
# ssh -o StrictHostKeyChecking=accept-new -v root@staging.testrun.org id -u
|
||||||
|
# rsync -avz acme root@staging.testrun.org:/var/lib/ || true
|
||||||
|
# rsync -avz dkim root@staging.testrun.org:/var/lib/rspamd/ || true
|
||||||
|
|
||||||
|
- run: cmdeploy init staging.testrun.org
|
||||||
|
|
||||||
|
- run: cmdeploy run
|
||||||
|
|
||||||
|
- name: set DNS entries
|
||||||
|
run: |
|
||||||
|
#ssh -o StrictHostKeyChecking=accept-new -v root@staging.testrun.org chown _rspamd:_rspamd -R /var/lib/rspamd/dkim
|
||||||
|
cmdeploy dns --zonefile staging-generated.zone
|
||||||
|
cat staging-generated.zone >> .github/workflows/staging.testrun.org-default.zone
|
||||||
|
cat .github/workflows/staging.testrun.org-default.zone
|
||||||
|
scp -o StrictHostKeyChecking=accept-new .github/workflows/staging.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org nsd-checkzone staging.testrun.org /etc/nsd/staging.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
|
- name: cmdeploy test
|
||||||
|
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
|
- name: cmdeploy dns (try 3 times)
|
||||||
|
run: cmdeploy dns || cmdeploy dns || cmdeploy dns
|
||||||
|
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -3,6 +3,9 @@ __pycache__/
|
|||||||
*.py[cod]
|
*.py[cod]
|
||||||
*$py.class
|
*$py.class
|
||||||
*.swp
|
*.swp
|
||||||
|
*qr-*.png
|
||||||
|
chatmail.ini
|
||||||
|
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
*.so
|
*.so
|
||||||
@@ -159,3 +162,5 @@ cython_debug/
|
|||||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||||
#.idea/
|
#.idea/
|
||||||
|
|
||||||
|
chatmail.zone
|
||||||
|
|||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2023, chatmail and delta chat teams
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
180
README.md
180
README.md
@@ -1,68 +1,162 @@
|
|||||||
# Chat Mail server configuration
|
|
||||||
|
|
||||||
This package deploys Postfix and Dovecot servers, including OpenDKIM for DKIM signing.
|
<img width="800px" src="www/src/collage-top.png"/>
|
||||||
|
|
||||||
Postfix uses Dovecot for authentication as described in <https://www.postfix.org/SASL_README.html#server_dovecot>
|
# Chatmail services optimized for Delta Chat apps
|
||||||
|
|
||||||
## Getting started
|
This repository helps to setup a ready-to-use chatmail server
|
||||||
|
comprised of a minimal setup of the battle-tested
|
||||||
|
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services.
|
||||||
|
|
||||||
prepare:
|
The setup is designed and optimized for providing chatmail accounts
|
||||||
|
for use by [Delta Chat apps](https://delta.chat).
|
||||||
|
|
||||||
pip install -e chatmail-infra
|
Chatmail accounts are automatically created by a first login,
|
||||||
|
after which the initially specified password is required for using them.
|
||||||
|
|
||||||
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
then run with pyinfra command line tool:
|
We use `chat.example.org` as the chatmail domain in the following steps.
|
||||||
|
Please substitute it with your own domain.
|
||||||
|
|
||||||
CHATMAIL_DOMAIN=c1.testrun.org pyinfra --ssh-user root c1.testrun.org deploy.py
|
1. Install the `cmdeploy` command in a virtualenv
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/deltachat/chatmail
|
||||||
|
cd chatmail
|
||||||
|
scripts/initenv.sh
|
||||||
|
```
|
||||||
|
|
||||||
## Structure (wip)
|
2. Create chatmail configuration file `chatmail.ini`:
|
||||||
```
|
|
||||||
|
|
||||||
# package doveauth tool and deploy chatmail server to a envvar-specified ssh-reachable host
|
```
|
||||||
deploy.py
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
|
```
|
||||||
|
|
||||||
# chatmail pyinfra deploy package
|
3. Setup first DNS records for your chatmail domain,
|
||||||
chatmail-pyinfra
|
according to the hints provided by `cmdeploy init`.
|
||||||
pyproject.toml
|
Verify that SSH root login works:
|
||||||
chatmail/__init__ ...
|
|
||||||
|
|
||||||
# doveauth tool used by dovecot's auth mechanism on the host system
|
```
|
||||||
doveauth
|
ssh root@chat.example.org # <-- use your domain
|
||||||
README.md
|
```
|
||||||
pyproject.toml
|
|
||||||
doveauth.py
|
|
||||||
test_doveauth.py
|
|
||||||
|
|
||||||
# lmtp server to block (outgoing) unencrypted messages
|
4. Deploy to the remote chatmail server:
|
||||||
filtermail
|
|
||||||
README.md
|
|
||||||
pyproject.toml
|
|
||||||
....
|
|
||||||
|
|
||||||
# online tests (after deploy)
|
```
|
||||||
|
scripts/cmdeploy run
|
||||||
|
```
|
||||||
|
This script will also show you additional DNS records
|
||||||
|
which you should configure at your DNS provider
|
||||||
|
(it can take some time until they are public).
|
||||||
|
|
||||||
online-tests # runnable via pytest
|
### Other helpful commands:
|
||||||
|
|
||||||
|
To check the status of your remotely running chatmail service:
|
||||||
|
|
||||||
# scripts for setup/development/deployment
|
|
||||||
|
|
||||||
scripts/
|
|
||||||
init.sh # create venv/other perequires
|
|
||||||
deploy.sh # run pyinfra based deploy of everything
|
|
||||||
test.sh # run all local and online tests
|
|
||||||
bench.sh # run performance benchmark tests
|
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy status
|
||||||
```
|
```
|
||||||
|
|
||||||
## Dovecot/Postfix configuration
|
To check whether your DNS records are correct:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
|
To test whether your chatmail service is working correctly:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy test
|
||||||
|
```
|
||||||
|
|
||||||
|
To measure the performance of your chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy bench
|
||||||
|
```
|
||||||
|
|
||||||
|
## Overview of this repository
|
||||||
|
|
||||||
|
This repository drives the development of chatmail services,
|
||||||
|
comprised of minimal setups of
|
||||||
|
|
||||||
|
- [postfix smtp server](https://www.postfix.org)
|
||||||
|
- [dovecot imap server](https://www.dovecot.org)
|
||||||
|
|
||||||
|
as well as custom services that are integrated with these two:
|
||||||
|
|
||||||
|
- `chatmaild/src/chatmaild/doveauth.py` implements
|
||||||
|
create-on-login account creation semantics and is used
|
||||||
|
by Dovecot during login authentication and by Postfix
|
||||||
|
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
||||||
|
to authenticate users
|
||||||
|
to send mails for them.
|
||||||
|
|
||||||
|
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
||||||
|
unencrypted e-mail from leaving the chatmail service
|
||||||
|
and is integrated into postfix's outbound mail pipelines.
|
||||||
|
|
||||||
|
There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
||||||
|
which helps with setting up and managing the chatmail service.
|
||||||
|
`cmdeploy run` uses [pyinfra-based scripting](https://pyinfra.com/)
|
||||||
|
in `cmdeploy/src/cmdeploy/__init__.py`
|
||||||
|
to automatically install all chatmail components on a server.
|
||||||
|
|
||||||
|
|
||||||
|
### Home page and getting started for users
|
||||||
|
|
||||||
|
`cmdeploy run` also creates default static Web pages and deploys them
|
||||||
|
to a nginx web server with:
|
||||||
|
|
||||||
|
- a default `index.html` along with a QR code that users can click to
|
||||||
|
create accounts on your chatmail provider,
|
||||||
|
|
||||||
|
- a default `info.html` that is linked from the home page,
|
||||||
|
|
||||||
|
- a default `policy.html` that is linked from the home page.
|
||||||
|
|
||||||
|
All `.html` files are generated
|
||||||
|
by the according markdown `.md` file in the `www/src` directory.
|
||||||
|
|
||||||
|
|
||||||
|
### Refining the web pages
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy webdev
|
||||||
|
```
|
||||||
|
|
||||||
|
This starts a local live development cycle for chatmail Web pages:
|
||||||
|
|
||||||
|
- uses the `www/src/page-layout.html` file for producing static
|
||||||
|
HTML pages from `www/src/*.md` files
|
||||||
|
|
||||||
|
- continously builds the web presence reading files from `www/src` directory
|
||||||
|
and generating html files and copying assets to the `www/build` directory.
|
||||||
|
|
||||||
|
- Starts a browser window automatically where you can "refresh" as needed.
|
||||||
|
|
||||||
|
|
||||||
|
## Emergency Commands to disable automatic account creation
|
||||||
|
|
||||||
|
If you need to stop account creation,
|
||||||
|
e.g. because some script is wildly creating accounts,
|
||||||
|
login to the server with ssh and run:
|
||||||
|
|
||||||
|
```
|
||||||
|
touch /etc/chatmail-nocreate
|
||||||
|
```
|
||||||
|
|
||||||
|
While this file is present, account creation will be blocked.
|
||||||
|
|
||||||
### Ports
|
### Ports
|
||||||
|
|
||||||
Postfix 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 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 443 (https).
|
||||||
|
[acmetool](https://hlandau.github.io/acmetool/) listens on port 80 (http).
|
||||||
|
|
||||||
|
Delta Chat apps will, however, discover all ports and configurations
|
||||||
|
automatically by reading the [autoconfig XML file](https://www.ietf.org/archive/id/draft-bucksch-autoconfig-00.html) from the chatmail service.
|
||||||
|
|
||||||
## DNS
|
|
||||||
|
|
||||||
For DKIM you must add a DNS entry as in /etc/opendkim/selector.txt (where selector is the opendkim_selector configured in the chatmail inventory).
|
|
||||||
|
|||||||
4
chatmaild/MANIFEST.in
Normal file
4
chatmaild/MANIFEST.in
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
include src/chatmaild/*.f
|
||||||
|
include src/chatmaild/ini/*.ini.f
|
||||||
|
include src/chatmaild/ini/*.ini
|
||||||
|
include src/chatmaild/tests/mail-data/*
|
||||||
@@ -1,27 +1,43 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools>=45"]
|
requires = ["setuptools>=61"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "chatmaild"
|
name = "chatmaild"
|
||||||
version = "0.1"
|
version = "0.2"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd"
|
"aiosmtpd",
|
||||||
|
"iniconfig",
|
||||||
|
"deltachat-rpc-server",
|
||||||
|
"deltachat-rpc-client",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[tool.setuptools]
|
||||||
|
include-package-data = true
|
||||||
|
|
||||||
|
[tool.setuptools.packages.find]
|
||||||
|
where = ['src']
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
doveauth-dictproxy = "chatmaild.dictproxy:main"
|
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
|
echobot = "chatmaild.echo:main"
|
||||||
|
chatmail-metrics = "chatmaild.metrics:main"
|
||||||
|
|
||||||
|
[project.entry-points.pytest11]
|
||||||
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "-v -ra --strict-markers"
|
addopts = "-v -ra --strict-markers"
|
||||||
|
log_format = "%(asctime)s %(levelname)s %(message)s"
|
||||||
|
log_date_format = "%Y-%m-%d %H:%M:%S"
|
||||||
|
log_level = "INFO"
|
||||||
|
|
||||||
[tool.tox]
|
[tool.tox]
|
||||||
legacy_tox_ini = """
|
legacy_tox_ini = """
|
||||||
[tox]
|
[tox]
|
||||||
isolated_build = true
|
isolated_build = true
|
||||||
envlist = lint
|
envlist = lint,py
|
||||||
|
|
||||||
[testenv:lint]
|
[testenv:lint]
|
||||||
skipdist = True
|
skipdist = True
|
||||||
@@ -32,4 +48,9 @@ deps =
|
|||||||
commands =
|
commands =
|
||||||
black --quiet --check --diff src/
|
black --quiet --check --diff src/
|
||||||
ruff src/
|
ruff src/
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
deps = pytest
|
||||||
|
pdbpp
|
||||||
|
commands = pytest -v -rsXx {posargs}
|
||||||
"""
|
"""
|
||||||
|
|||||||
59
chatmaild/src/chatmaild/config.py
Normal file
59
chatmaild/src/chatmaild/config.py
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
import iniconfig
|
||||||
|
|
||||||
|
|
||||||
|
def read_config(inipath):
|
||||||
|
cfg = iniconfig.IniConfig(inipath)
|
||||||
|
return Config(inipath, params=cfg.sections["params"])
|
||||||
|
|
||||||
|
|
||||||
|
class Config:
|
||||||
|
def __init__(self, inipath, params):
|
||||||
|
self._inipath = inipath
|
||||||
|
self.mail_domain = params["mail_domain"]
|
||||||
|
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
||||||
|
self.max_mailbox_size = params["max_mailbox_size"]
|
||||||
|
self.delete_mails_after = params["delete_mails_after"]
|
||||||
|
self.username_min_length = int(params["username_min_length"])
|
||||||
|
self.username_max_length = int(params["username_max_length"])
|
||||||
|
self.password_min_length = int(params["password_min_length"])
|
||||||
|
self.passthrough_senders = params["passthrough_senders"].split()
|
||||||
|
self.passthrough_recipients = params["passthrough_recipients"].split()
|
||||||
|
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
||||||
|
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
||||||
|
self.privacy_postal = params.get("privacy_postal")
|
||||||
|
self.privacy_mail = params.get("privacy_mail")
|
||||||
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
|
self.privacy_supervisor = params.get("privacy_supervisor")
|
||||||
|
|
||||||
|
def _getbytefile(self):
|
||||||
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
|
|
||||||
|
def write_initial_config(inipath, mail_domain):
|
||||||
|
from importlib.resources import files
|
||||||
|
|
||||||
|
inidir = files(__package__).joinpath("ini")
|
||||||
|
content = (
|
||||||
|
inidir.joinpath("chatmail.ini.f").read_text().format(mail_domain=mail_domain)
|
||||||
|
)
|
||||||
|
if mail_domain.endswith(".testrun.org"):
|
||||||
|
override_inipath = inidir.joinpath("override-testrun.ini")
|
||||||
|
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
||||||
|
lines = []
|
||||||
|
for line in content.split("\n"):
|
||||||
|
for key, value in privacy.items():
|
||||||
|
value_lines = value.strip().split("\n")
|
||||||
|
if not line.startswith(f"{key} =") or not value_lines:
|
||||||
|
continue
|
||||||
|
if len(value_lines) == 1:
|
||||||
|
lines.append(f"{key} = {value}")
|
||||||
|
else:
|
||||||
|
lines.append(f"{key} =")
|
||||||
|
for vl in value_lines:
|
||||||
|
lines.append(f" {vl}")
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
lines.append(line)
|
||||||
|
content = "\n".join(lines)
|
||||||
|
|
||||||
|
inipath.write_text(content)
|
||||||
@@ -33,13 +33,6 @@ class Connection:
|
|||||||
def cursor(self):
|
def cursor(self):
|
||||||
return self._sqlconn.cursor()
|
return self._sqlconn.cursor()
|
||||||
|
|
||||||
def create_user(self, addr: str, password: str):
|
|
||||||
"""Create a row in the users table."""
|
|
||||||
self.execute("PRAGMA foreign_keys=on")
|
|
||||||
q = """INSERT INTO users (addr, password, last_login)
|
|
||||||
VALUES (?, ?, ?)"""
|
|
||||||
self.execute(q, (addr, password, int(time.time())))
|
|
||||||
|
|
||||||
def get_user(self, addr: str) -> {}:
|
def get_user(self, addr: str) -> {}:
|
||||||
"""Get a row from the users table."""
|
"""Get a row from the users table."""
|
||||||
q = "SELECT addr, password, last_login from users WHERE addr = ?"
|
q = "SELECT addr, password, last_login from users WHERE addr = ?"
|
||||||
|
|||||||
@@ -1,115 +0,0 @@
|
|||||||
import os
|
|
||||||
import sys
|
|
||||||
import json
|
|
||||||
from socketserver import (
|
|
||||||
UnixStreamServer,
|
|
||||||
StreamRequestHandler,
|
|
||||||
ThreadingMixIn,
|
|
||||||
)
|
|
||||||
import pwd
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
from .database import Database
|
|
||||||
|
|
||||||
|
|
||||||
def encrypt_password(password: str):
|
|
||||||
password = password.encode("ascii")
|
|
||||||
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
|
||||||
process = subprocess.Popen(
|
|
||||||
["doveadm", "pw", "-s", "SHA512-CRYPT"],
|
|
||||||
stdin=subprocess.PIPE,
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
)
|
|
||||||
stdout_data, _stderr_data = process.communicate(
|
|
||||||
input=password + b"\n" + password + b"\n"
|
|
||||||
)
|
|
||||||
return stdout_data.decode("ascii").strip()
|
|
||||||
|
|
||||||
|
|
||||||
def create_user(db, user, password):
|
|
||||||
with db.write_transaction() as conn:
|
|
||||||
conn.create_user(user, password)
|
|
||||||
return dict(home=f"/home/vmail/{user}", uid="vmail", gid="vmail", password=password)
|
|
||||||
|
|
||||||
|
|
||||||
def get_user_data(db, user):
|
|
||||||
with db.read_connection() as conn:
|
|
||||||
result = conn.get_user(user)
|
|
||||||
if result:
|
|
||||||
result["uid"] = "vmail"
|
|
||||||
result["gid"] = "vmail"
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def lookup_userdb(db, user):
|
|
||||||
return get_user_data(db, user)
|
|
||||||
|
|
||||||
|
|
||||||
def lookup_passdb(db, user, password):
|
|
||||||
userdata = get_user_data(db, user)
|
|
||||||
if not userdata:
|
|
||||||
return create_user(db, user, encrypt_password(password))
|
|
||||||
userdata["password"] = userdata["password"].strip()
|
|
||||||
return userdata
|
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_request(msg, db):
|
|
||||||
print(f"received msg: {msg!r}", file=sys.stderr)
|
|
||||||
short_command = msg[0]
|
|
||||||
if short_command == "L": # LOOKUP
|
|
||||||
parts = msg[1:].split("\t")
|
|
||||||
keyname, user = parts[:2]
|
|
||||||
namespace, type, *args = keyname.split("/")
|
|
||||||
reply_command = "F"
|
|
||||||
res = ""
|
|
||||||
if namespace == "shared":
|
|
||||||
if type == "userdb":
|
|
||||||
res = lookup_userdb(db, user)
|
|
||||||
if res:
|
|
||||||
reply_command = "O"
|
|
||||||
else:
|
|
||||||
reply_command = "N"
|
|
||||||
elif type == "passdb":
|
|
||||||
res = lookup_passdb(db, user, password=args[0])
|
|
||||||
if res:
|
|
||||||
reply_command = "O"
|
|
||||||
else:
|
|
||||||
reply_command = "N"
|
|
||||||
print(f"res: {res!r}", file=sys.stderr)
|
|
||||||
json_res = json.dumps(res) if res else ""
|
|
||||||
return f"{reply_command}{json_res}\n"
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
socket = sys.argv[1]
|
|
||||||
passwd_entry = pwd.getpwnam(sys.argv[2])
|
|
||||||
db = Database(sys.argv[3])
|
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
|
||||||
def handle(self):
|
|
||||||
while True:
|
|
||||||
msg = self.rfile.readline().strip().decode()
|
|
||||||
if not msg:
|
|
||||||
break
|
|
||||||
res = handle_dovecot_request(msg, db)
|
|
||||||
if res:
|
|
||||||
print(f"sending result: {res!r}", file=sys.stderr)
|
|
||||||
self.wfile.write(res.encode("ascii"))
|
|
||||||
self.wfile.flush()
|
|
||||||
|
|
||||||
try:
|
|
||||||
os.unlink(socket)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
with ThreadedUnixStreamServer(socket, Handler) as server:
|
|
||||||
os.chown(socket, uid=passwd_entry.pw_uid, gid=passwd_entry.pw_gid)
|
|
||||||
try:
|
|
||||||
server.serve_forever()
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
pass
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Dict authentication proxy for dovecot
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart=/usr/local/bin/doveauth-dictproxy /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,8 +1,61 @@
|
|||||||
#!/usr/bin/env python3
|
import logging
|
||||||
import base64
|
import os
|
||||||
|
import time
|
||||||
import sys
|
import sys
|
||||||
|
import json
|
||||||
|
import crypt
|
||||||
|
from socketserver import (
|
||||||
|
UnixStreamServer,
|
||||||
|
StreamRequestHandler,
|
||||||
|
ThreadingMixIn,
|
||||||
|
)
|
||||||
|
import pwd
|
||||||
|
|
||||||
from .database import Database
|
from .database import Database
|
||||||
|
from .config import read_config, Config
|
||||||
|
|
||||||
|
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
||||||
|
|
||||||
|
|
||||||
|
def encrypt_password(password: str):
|
||||||
|
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
||||||
|
passhash = crypt.crypt(password, crypt.METHOD_SHA512)
|
||||||
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
|
def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
||||||
|
"""Return True if user and password are admissable."""
|
||||||
|
if os.path.exists(NOCREATE_FILE):
|
||||||
|
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
||||||
|
return False
|
||||||
|
|
||||||
|
if len(cleartext_password) < config.password_min_length:
|
||||||
|
logging.warning(
|
||||||
|
"Password needs to be at least %s characters long",
|
||||||
|
config.password_min_length,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
parts = user.split("@")
|
||||||
|
if len(parts) != 2:
|
||||||
|
logging.warning(f"user {user!r} is not a proper e-mail address")
|
||||||
|
return False
|
||||||
|
localpart, domain = parts
|
||||||
|
|
||||||
|
if (
|
||||||
|
len(localpart) > config.username_max_length
|
||||||
|
or len(localpart) < config.username_min_length
|
||||||
|
):
|
||||||
|
if localpart != "echo":
|
||||||
|
logging.warning(
|
||||||
|
"localpart %s has to be between %s and %s chars long",
|
||||||
|
localpart,
|
||||||
|
config.username_min_length,
|
||||||
|
config.username_max_length,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
def get_user_data(db, user):
|
def get_user_data(db, user):
|
||||||
@@ -14,52 +67,138 @@ def get_user_data(db, user):
|
|||||||
return result
|
return result
|
||||||
|
|
||||||
|
|
||||||
def create_user(db, user, password):
|
def lookup_userdb(db, user):
|
||||||
|
return get_user_data(db, user)
|
||||||
|
|
||||||
|
|
||||||
|
def lookup_passdb(db, config: Config, user, cleartext_password):
|
||||||
with db.write_transaction() as conn:
|
with db.write_transaction() as conn:
|
||||||
conn.create_user(user, password)
|
userdata = conn.get_user(user)
|
||||||
return dict(home=f"/home/vmail/{user}", uid="vmail", gid="vmail", password=password)
|
if userdata:
|
||||||
|
# Update last login time.
|
||||||
|
conn.execute(
|
||||||
|
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
||||||
|
)
|
||||||
|
|
||||||
|
userdata["uid"] = "vmail"
|
||||||
|
userdata["gid"] = "vmail"
|
||||||
|
return userdata
|
||||||
|
if not is_allowed_to_create(config, user, cleartext_password):
|
||||||
|
return
|
||||||
|
|
||||||
|
encrypted_password = encrypt_password(cleartext_password)
|
||||||
|
q = """INSERT INTO users (addr, password, last_login)
|
||||||
|
VALUES (?, ?, ?)"""
|
||||||
|
conn.execute(q, (user, encrypted_password, int(time.time())))
|
||||||
|
return dict(
|
||||||
|
home=f"/home/vmail/mail/{config.mail_domain}/{user}",
|
||||||
|
uid="vmail",
|
||||||
|
gid="vmail",
|
||||||
|
password=encrypted_password,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def verify_user(db, user, password):
|
def split_and_unescape(s):
|
||||||
userdata = get_user_data(db, user)
|
"""Split strings using double quote as a separator and backslash as escape character
|
||||||
if userdata:
|
into parts."""
|
||||||
if userdata.get("password") == password:
|
|
||||||
userdata["status"] = "ok"
|
out = ""
|
||||||
|
i = 0
|
||||||
|
while i < len(s):
|
||||||
|
c = s[i]
|
||||||
|
if c == "\\":
|
||||||
|
# Skip escape character.
|
||||||
|
i += 1
|
||||||
|
|
||||||
|
# This will raise IndexError if there is no character
|
||||||
|
# after escape character. This is expected
|
||||||
|
# as this is an invalid input.
|
||||||
|
out += s[i]
|
||||||
|
elif c == '"':
|
||||||
|
# Separator
|
||||||
|
yield out
|
||||||
|
out = ""
|
||||||
else:
|
else:
|
||||||
userdata["status"] = "fail"
|
out += c
|
||||||
else:
|
i += 1
|
||||||
userdata = create_user(db, user, password)
|
yield out
|
||||||
userdata["status"] = "ok"
|
|
||||||
|
|
||||||
return userdata
|
|
||||||
|
|
||||||
|
|
||||||
def lookup_user(db, user):
|
def handle_dovecot_request(msg, db, config: Config):
|
||||||
userdata = get_user_data(db, user)
|
short_command = msg[0]
|
||||||
if userdata:
|
if short_command == "L": # LOOKUP
|
||||||
userdata["status"] = "ok"
|
parts = msg[1:].split("\t")
|
||||||
else:
|
|
||||||
userdata["status"] = "fail"
|
# Dovecot <2.3.17 has only one part,
|
||||||
return userdata
|
# do not attempt to read any other parts for compatibility.
|
||||||
|
keyname = parts[0]
|
||||||
|
|
||||||
|
namespace, type, args = keyname.split("/", 2)
|
||||||
|
args = list(split_and_unescape(args))
|
||||||
|
|
||||||
|
reply_command = "F"
|
||||||
|
res = ""
|
||||||
|
if namespace == "shared":
|
||||||
|
if type == "userdb":
|
||||||
|
user = args[0]
|
||||||
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
|
res = lookup_userdb(db, user)
|
||||||
|
if res:
|
||||||
|
reply_command = "O"
|
||||||
|
else:
|
||||||
|
reply_command = "N"
|
||||||
|
elif type == "passdb":
|
||||||
|
user = args[1]
|
||||||
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
|
res = lookup_passdb(db, config, user, cleartext_password=args[0])
|
||||||
|
if res:
|
||||||
|
reply_command = "O"
|
||||||
|
else:
|
||||||
|
reply_command = "N"
|
||||||
|
json_res = json.dumps(res) if res else ""
|
||||||
|
return f"{reply_command}{json_res}\n"
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
def dump_result(res):
|
def handle_dovecot_protocol(rfile, wfile, db: Database, config: Config):
|
||||||
for key, value in res.items():
|
while True:
|
||||||
print(f"{key}={value}")
|
msg = rfile.readline().strip().decode()
|
||||||
|
if not msg:
|
||||||
|
break
|
||||||
|
res = handle_dovecot_request(msg, db, config)
|
||||||
|
if res:
|
||||||
|
wfile.write(res.encode("ascii"))
|
||||||
|
wfile.flush()
|
||||||
|
else:
|
||||||
|
logging.warning("request had no answer: %r", msg)
|
||||||
|
|
||||||
|
|
||||||
|
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
||||||
|
request_queue_size = 100
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
db = Database("/home/vmail/passdb.sqlite")
|
socket = sys.argv[1]
|
||||||
if sys.argv[1] == "hexauth":
|
passwd_entry = pwd.getpwnam(sys.argv[2])
|
||||||
login = base64.b16decode(sys.argv[2]).decode()
|
db = Database(sys.argv[3])
|
||||||
password = base64.b16decode(sys.argv[3]).decode()
|
config = read_config(sys.argv[4])
|
||||||
res = verify_user(db, login, password)
|
|
||||||
dump_result(res)
|
|
||||||
elif sys.argv[1] == "hexlookup":
|
|
||||||
login = base64.b16decode(sys.argv[2]).decode()
|
|
||||||
res = lookup_user(db, login)
|
|
||||||
dump_result(res)
|
|
||||||
|
|
||||||
|
class Handler(StreamRequestHandler):
|
||||||
|
def handle(self):
|
||||||
|
try:
|
||||||
|
handle_dovecot_protocol(self.rfile, self.wfile, db, config)
|
||||||
|
except Exception:
|
||||||
|
logging.exception("Exception in the handler")
|
||||||
|
raise
|
||||||
|
|
||||||
if __name__ == "__main__":
|
try:
|
||||||
main()
|
os.unlink(socket)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
with ThreadedUnixStreamServer(socket, Handler) as server:
|
||||||
|
os.chown(socket, uid=passwd_entry.pw_uid, gid=passwd_entry.pw_gid)
|
||||||
|
try:
|
||||||
|
server.serve_forever()
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
pass
|
||||||
|
|||||||
10
chatmaild/src/chatmaild/doveauth.service.f
Normal file
10
chatmaild/src/chatmaild/doveauth.service.f
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Chatmail dict authentication proxy for dovecot
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite {config_path}
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
84
chatmaild/src/chatmaild/echo.py
Normal file
84
chatmaild/src/chatmaild/echo.py
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Advanced echo bot example.
|
||||||
|
|
||||||
|
it will echo back any message that has non-empty text and also supports the /help command.
|
||||||
|
"""
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
||||||
|
|
||||||
|
from chatmaild.newemail import create_newemail_dict
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
hooks = events.HookCollection()
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.RawEvent)
|
||||||
|
def log_event(event):
|
||||||
|
if event.kind == EventType.INFO:
|
||||||
|
logging.info(event.msg)
|
||||||
|
elif event.kind == EventType.WARNING:
|
||||||
|
logging.warning(event.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.RawEvent(EventType.ERROR))
|
||||||
|
def log_error(event):
|
||||||
|
logging.error(event.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.MemberListChanged)
|
||||||
|
def on_memberlist_changed(event):
|
||||||
|
logging.info(
|
||||||
|
"member %s was %s", event.member, "added" if event.member_added else "removed"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.GroupImageChanged)
|
||||||
|
def on_group_image_changed(event):
|
||||||
|
logging.info("group image %s", "deleted" if event.image_deleted else "changed")
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.GroupNameChanged)
|
||||||
|
def on_group_name_changed(event):
|
||||||
|
logging.info("group name changed, old name: %s", event.old_name)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.NewMessage(func=lambda e: not e.command))
|
||||||
|
def echo(event):
|
||||||
|
snapshot = event.message_snapshot
|
||||||
|
if snapshot.text or snapshot.file:
|
||||||
|
snapshot.chat.send_message(text=snapshot.text, file=snapshot.file)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.NewMessage(command="/help"))
|
||||||
|
def help_command(event):
|
||||||
|
snapshot = event.message_snapshot
|
||||||
|
snapshot.chat.send_text("Send me any message and I will echo it back")
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
path = os.environ.get("PATH")
|
||||||
|
venv_path = sys.argv[0].strip("echobot")
|
||||||
|
os.environ["PATH"] = path + ":" + venv_path
|
||||||
|
with Rpc() as rpc:
|
||||||
|
deltachat = DeltaChat(rpc)
|
||||||
|
system_info = deltachat.get_system_info()
|
||||||
|
logging.info("Running deltachat core %s", system_info.deltachat_core_version)
|
||||||
|
|
||||||
|
accounts = deltachat.get_all_accounts()
|
||||||
|
account = accounts[0] if accounts else deltachat.add_account()
|
||||||
|
|
||||||
|
bot = Bot(account, hooks)
|
||||||
|
if not bot.is_configured():
|
||||||
|
config = read_config(sys.argv[1])
|
||||||
|
password = create_newemail_dict(config).get("password")
|
||||||
|
email = "echo@" + config.mail_domain
|
||||||
|
bot.configure(email, password)
|
||||||
|
bot.run_forever()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
logging.basicConfig(level=logging.INFO)
|
||||||
|
main()
|
||||||
11
chatmaild/src/chatmaild/echobot.service.f
Normal file
11
chatmaild/src/chatmaild/echobot.service.f
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Chatmail echo bot for testing it works
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart={execpath} {config_path}
|
||||||
|
Environment="PATH={remote_venv_dir}:$PATH"
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -1,17 +1,20 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
|
import time
|
||||||
|
import sys
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
from email import policy
|
from email import policy
|
||||||
|
from email.utils import parseaddr
|
||||||
|
|
||||||
from aiosmtpd.lmtp import LMTP
|
from aiosmtpd.controller import Controller
|
||||||
from aiosmtpd.controller import UnixSocketController
|
|
||||||
from smtplib import SMTP as SMTPClient
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
|
from .config import read_config
|
||||||
|
|
||||||
def check_encrypted(content):
|
|
||||||
|
def check_encrypted(message):
|
||||||
"""Check that the message is an OpenPGP-encrypted message."""
|
"""Check that the message is an OpenPGP-encrypted message."""
|
||||||
message = BytesParser(policy=policy.default).parsebytes(content)
|
|
||||||
if not message.is_multipart():
|
if not message.is_multipart():
|
||||||
return False
|
return False
|
||||||
if message.get("subject") != "...":
|
if message.get("subject") != "...":
|
||||||
@@ -32,72 +35,129 @@ def check_encrypted(content):
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
class ExampleController(UnixSocketController):
|
def check_mdn(message, envelope):
|
||||||
def factory(self):
|
if len(envelope.rcpt_tos) != 1:
|
||||||
return LMTP(self.handler, **self.SMTP_kwargs)
|
return False
|
||||||
|
|
||||||
|
for name in ["auto-submitted", "chat-version"]:
|
||||||
|
if not message.get(name):
|
||||||
|
return False
|
||||||
|
|
||||||
|
if message.get_content_type() != "multipart/report":
|
||||||
|
return False
|
||||||
|
|
||||||
|
body = message.get_body()
|
||||||
|
if body.get_content_type() != "text/plain":
|
||||||
|
return False
|
||||||
|
|
||||||
|
if list(body.iter_attachments()) or list(body.iter_parts()):
|
||||||
|
return False
|
||||||
|
|
||||||
|
# even with all mime-structural checks an attacker
|
||||||
|
# could try to abuse the subject or body to contain links or other
|
||||||
|
# annoyance -- we skip on checking subject/body for now as Delta Chat
|
||||||
|
# should evolve to create E2E-encrypted read receipts anyway.
|
||||||
|
# and then MDNs are just encrypted mail and can pass the border
|
||||||
|
# to other instances.
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
class ExampleHandler:
|
async def asyncmain_beforequeue(config):
|
||||||
async def handle_RCPT(self, server, session, envelope, address, rcpt_options):
|
port = config.filtermail_smtp_port
|
||||||
envelope.rcpt_tos.append(address)
|
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
||||||
|
|
||||||
|
|
||||||
|
class BeforeQueueHandler:
|
||||||
|
def __init__(self, config):
|
||||||
|
self.config = config
|
||||||
|
self.send_rate_limiter = SendRateLimiter()
|
||||||
|
|
||||||
|
async def handle_MAIL(self, server, session, envelope, address, mail_options):
|
||||||
|
logging.info(f"handle_MAIL from {address}")
|
||||||
|
envelope.mail_from = address
|
||||||
|
max_sent = self.config.max_user_send_per_minute
|
||||||
|
if not self.send_rate_limiter.is_sending_allowed(address, max_sent):
|
||||||
|
return f"450 4.7.1: Too much mail from {address}"
|
||||||
|
|
||||||
|
parts = envelope.mail_from.split("@")
|
||||||
|
if len(parts) != 2:
|
||||||
|
return f"500 Invalid from address <{envelope.mail_from!r}>"
|
||||||
|
|
||||||
return "250 OK"
|
return "250 OK"
|
||||||
|
|
||||||
async def handle_DATA(self, server, session, envelope):
|
async def handle_DATA(self, server, session, envelope):
|
||||||
logging.info("Processing DATA message from %s", envelope.mail_from)
|
logging.info("handle_DATA before-queue")
|
||||||
|
error = self.check_DATA(envelope)
|
||||||
|
if error:
|
||||||
|
return error
|
||||||
|
logging.info("re-injecting the mail that passed checks")
|
||||||
|
client = SMTPClient("localhost", self.config.postfix_reinject_port)
|
||||||
|
client.sendmail(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
||||||
|
return "250 OK"
|
||||||
|
|
||||||
valid_recipients = []
|
def check_DATA(self, envelope):
|
||||||
|
"""the central filtering function for e-mails."""
|
||||||
|
logging.info(f"Processing DATA message from {envelope.mail_from}")
|
||||||
|
|
||||||
mail_encrypted = check_encrypted(envelope.content)
|
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
||||||
|
mail_encrypted = check_encrypted(message)
|
||||||
|
|
||||||
res = []
|
_, from_addr = parseaddr(message.get("from").strip())
|
||||||
|
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
||||||
|
if envelope.mail_from.lower() != from_addr.lower():
|
||||||
|
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
||||||
|
|
||||||
|
if not mail_encrypted and check_mdn(message, envelope):
|
||||||
|
return
|
||||||
|
|
||||||
|
if envelope.mail_from in self.config.passthrough_senders:
|
||||||
|
return
|
||||||
|
|
||||||
|
passthrough_recipients = self.config.passthrough_recipients
|
||||||
|
envelope_from_domain = from_addr.split("@").pop()
|
||||||
for recipient in envelope.rcpt_tos:
|
for recipient in envelope.rcpt_tos:
|
||||||
my_local_domain = envelope.mail_from.split("@")
|
|
||||||
if len(my_local_domain) != 2:
|
|
||||||
res += [f"500 Invalid from address <{envelope.mail_from}>"]
|
|
||||||
continue
|
|
||||||
|
|
||||||
if envelope.mail_from == recipient:
|
if envelope.mail_from == recipient:
|
||||||
# Always allow sending emails to self.
|
# Always allow sending emails to self.
|
||||||
valid_recipients += [recipient]
|
|
||||||
res += ["250 OK"]
|
|
||||||
continue
|
continue
|
||||||
|
if recipient in passthrough_recipients:
|
||||||
recipient_local_domain = recipient.split("@")
|
|
||||||
if len(recipient_local_domain) != 2:
|
|
||||||
res += [f"500 Invalid address <{recipient}>"]
|
|
||||||
continue
|
continue
|
||||||
|
res = recipient.split("@")
|
||||||
|
if len(res) != 2:
|
||||||
|
return f"500 Invalid address <{recipient}>"
|
||||||
|
_recipient_addr, recipient_domain = res
|
||||||
|
|
||||||
is_outgoing = recipient_local_domain[1] != my_local_domain[1]
|
is_outgoing = recipient_domain != envelope_from_domain
|
||||||
if is_outgoing and not mail_encrypted:
|
if is_outgoing and not mail_encrypted:
|
||||||
res += ["500 Outgoing mail must be encrypted"]
|
is_securejoin = message.get("secure-join") in [
|
||||||
continue
|
"vc-request",
|
||||||
|
"vg-request",
|
||||||
valid_recipients += [recipient]
|
]
|
||||||
res += ["250 OK"]
|
if not is_securejoin:
|
||||||
|
return f"500 Invalid unencrypted mail to <{recipient}>"
|
||||||
# Reinject the mail back into Postfix.
|
|
||||||
if valid_recipients:
|
|
||||||
logging.info("Reinjecting the mail")
|
|
||||||
client = SMTPClient("localhost", "10026")
|
|
||||||
client.sendmail(envelope.mail_from, valid_recipients, envelope.content)
|
|
||||||
|
|
||||||
return "\r\n".join(res)
|
|
||||||
|
|
||||||
|
|
||||||
async def asyncmain(loop):
|
class SendRateLimiter:
|
||||||
controller = ExampleController(
|
def __init__(self):
|
||||||
ExampleHandler(), unix_socket="/var/spool/postfix/private/filtermail"
|
self.addr2timestamps = {}
|
||||||
)
|
|
||||||
controller.start()
|
def is_sending_allowed(self, mail_from, max_send_per_minute):
|
||||||
|
last = self.addr2timestamps.setdefault(mail_from, [])
|
||||||
|
now = time.time()
|
||||||
|
last[:] = [ts for ts in last if ts >= (now - 60)]
|
||||||
|
if len(last) <= max_send_per_minute:
|
||||||
|
last.append(now)
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
logging.basicConfig(level=logging.INFO)
|
args = sys.argv[1:]
|
||||||
|
assert len(args) == 1
|
||||||
|
config = read_config(args[0])
|
||||||
|
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)
|
||||||
loop.create_task(asyncmain(loop=loop))
|
task = asyncmain_beforequeue(config)
|
||||||
|
loop.create_task(task)
|
||||||
loop.run_forever()
|
loop.run_forever()
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=Email filter for chatmail servers
|
Description=Chatmail Postfix BeforeQeue filter
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart=/usr/local/bin/filtermail
|
ExecStart={execpath} {config_path}
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
|
|
||||||
63
chatmaild/src/chatmaild/ini/chatmail.ini.f
Normal file
63
chatmaild/src/chatmaild/ini/chatmail.ini.f
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
[params]
|
||||||
|
|
||||||
|
# mail domain (MUST be set to fully qualified chat mail domain)
|
||||||
|
mail_domain = {mail_domain}
|
||||||
|
|
||||||
|
#
|
||||||
|
# If you only do private test deploys, you don't need to modify any settings below
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# Account Restrictions
|
||||||
|
#
|
||||||
|
|
||||||
|
# how many mails a user can send out per minute
|
||||||
|
max_user_send_per_minute = 60
|
||||||
|
|
||||||
|
# maximum mailbox size of a chatmail account
|
||||||
|
max_mailbox_size = 100M
|
||||||
|
|
||||||
|
# days after which mails are unconditionally deleted
|
||||||
|
delete_mails_after = 40
|
||||||
|
|
||||||
|
# minimum length a username must have
|
||||||
|
username_min_length = 9
|
||||||
|
|
||||||
|
# maximum length a username can have
|
||||||
|
username_max_length = 9
|
||||||
|
|
||||||
|
# minimum length a password must have
|
||||||
|
password_min_length = 9
|
||||||
|
|
||||||
|
# list of chatmail accounts which can send outbound un-encrypted mail
|
||||||
|
passthrough_senders =
|
||||||
|
|
||||||
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
|
passthrough_recipients = xstore@testrun.org groupsbot@hispanilandia.net
|
||||||
|
|
||||||
|
#
|
||||||
|
# Deployment Details
|
||||||
|
#
|
||||||
|
|
||||||
|
# where the filtermail SMTP service listens
|
||||||
|
filtermail_smtp_port = 10080
|
||||||
|
|
||||||
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
|
postfix_reinject_port = 10025
|
||||||
|
|
||||||
|
#
|
||||||
|
# Privacy Policy
|
||||||
|
#
|
||||||
|
|
||||||
|
# postal address of privacy contact
|
||||||
|
privacy_postal =
|
||||||
|
|
||||||
|
# email address of privacy contact
|
||||||
|
privacy_mail =
|
||||||
|
|
||||||
|
# postal address of the privacy data officer
|
||||||
|
privacy_pdo =
|
||||||
|
|
||||||
|
# postal address of the privacy supervisor
|
||||||
|
privacy_supervisor =
|
||||||
|
|
||||||
16
chatmaild/src/chatmaild/ini/override-testrun.ini
Normal file
16
chatmaild/src/chatmaild/ini/override-testrun.ini
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
|
||||||
|
[privacy]
|
||||||
|
|
||||||
|
passthrough_recipients = privacy@testrun.org xstore@testrun.org groupsbot@hispanilandia.net
|
||||||
|
|
||||||
|
privacy_postal =
|
||||||
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
|
Reichgrafen Str. 20, 79102 Freiburg, Germany
|
||||||
|
|
||||||
|
privacy_mail = privacy@testrun.org
|
||||||
|
privacy_pdo =
|
||||||
|
Prof. Dr. Fabian Schmieder, lexICT UG (limited), Ostfeldstr. 49, 30559 Hannover.
|
||||||
|
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
||||||
|
privacy_supervisor =
|
||||||
|
State Commissioner for Data Protection and Freedom of Information of
|
||||||
|
Baden-Württemberg in 70173 Stuttgart, Germany.
|
||||||
25
chatmaild/src/chatmaild/metrics.py
Normal file
25
chatmaild/src/chatmaild/metrics.py
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
from pathlib import Path
|
||||||
|
import time
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
def main(vmail_dir=None):
|
||||||
|
if vmail_dir is None:
|
||||||
|
vmail_dir = sys.argv[1]
|
||||||
|
|
||||||
|
accounts = 0
|
||||||
|
ci_accounts = 0
|
||||||
|
|
||||||
|
for path in Path(vmail_dir).iterdir():
|
||||||
|
accounts += 1
|
||||||
|
if path.name[:3] in ("ci-", "ac_"):
|
||||||
|
ci_accounts += 1
|
||||||
|
|
||||||
|
timestamp = int(time.time() * 1000)
|
||||||
|
print(f"accounts {accounts} {timestamp}")
|
||||||
|
print(f"ci_accounts {ci_accounts} {timestamp}")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
36
chatmaild/src/chatmaild/newemail.py
Normal file
36
chatmaild/src/chatmaild/newemail.py
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
#!/usr/local/lib/chatmaild/venv/bin/python3
|
||||||
|
|
||||||
|
""" CGI script for creating new accounts. """
|
||||||
|
|
||||||
|
import json
|
||||||
|
import random
|
||||||
|
import secrets
|
||||||
|
import string
|
||||||
|
|
||||||
|
from chatmaild.config import read_config, Config
|
||||||
|
|
||||||
|
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
||||||
|
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
||||||
|
ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
||||||
|
|
||||||
|
|
||||||
|
def create_newemail_dict(config: Config):
|
||||||
|
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
||||||
|
password = "".join(
|
||||||
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
|
for _ in range(config.password_min_length + 3)
|
||||||
|
)
|
||||||
|
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
||||||
|
|
||||||
|
|
||||||
|
def print_new_account():
|
||||||
|
config = read_config(CONFIG_PATH)
|
||||||
|
creds = create_newemail_dict(config)
|
||||||
|
|
||||||
|
print("Content-Type: application/json")
|
||||||
|
print("")
|
||||||
|
print(json.dumps(creds))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
print_new_account()
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from .dictproxy import get_user_data
|
|
||||||
from .doveauth import verify_user
|
|
||||||
from .database import Database, DBError
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def db(tmpdir):
|
|
||||||
db_path = tmpdir / "passdb.sqlite"
|
|
||||||
print("database path:", db_path)
|
|
||||||
return Database(db_path)
|
|
||||||
|
|
||||||
|
|
||||||
def test_basic(db):
|
|
||||||
verify_user(db, "link2xt@c1.testrun.org", "asdf")
|
|
||||||
data = get_user_data(db, "link2xt@c1.testrun.org")
|
|
||||||
assert data
|
|
||||||
|
|
||||||
|
|
||||||
def test_verify_or_create(db):
|
|
||||||
res = verify_user(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983")
|
|
||||||
assert res["status"] == "ok"
|
|
||||||
res = verify_user(db, "newuser1@something.org", "kajdlqweqwe")
|
|
||||||
assert res["status"] == "fail"
|
|
||||||
|
|
||||||
|
|
||||||
def test_db_version(db):
|
|
||||||
assert db.get_schema_version() == 1
|
|
||||||
|
|
||||||
|
|
||||||
def test_too_high_db_version(db):
|
|
||||||
with db.write_transaction() as conn:
|
|
||||||
conn.execute("PRAGMA user_version=%s;" % (999,))
|
|
||||||
with pytest.raises(DBError):
|
|
||||||
db.ensure_tables()
|
|
||||||
@@ -1,286 +0,0 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from .filtermail import check_encrypted
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail():
|
|
||||||
assert not check_encrypted(b"foo")
|
|
||||||
|
|
||||||
assert not check_encrypted(
|
|
||||||
"\r\n".join(
|
|
||||||
[
|
|
||||||
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
|
||||||
"Chat-Disposition-Notification-To: foobar@c2.testrun.org",
|
|
||||||
"Chat-User-Avatar: 0",
|
|
||||||
"From: <foobar@c2.testrun.org>",
|
|
||||||
"To: <barbaz@c2.testrun.org>",
|
|
||||||
"Date: Sun, 15 Oct 2023 16:41:44 +0000",
|
|
||||||
"Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"Chat-Version: 1.0",
|
|
||||||
"Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;",
|
|
||||||
"\tkeydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m",
|
|
||||||
"\tnNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID",
|
|
||||||
"\tFgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I",
|
|
||||||
"\tHjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK",
|
|
||||||
"\tKwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ",
|
|
||||||
"\tJlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI",
|
|
||||||
"\tvYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK",
|
|
||||||
"MIME-Version: 1.0",
|
|
||||||
"Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no",
|
|
||||||
"",
|
|
||||||
"Hi!",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
).encode()
|
|
||||||
)
|
|
||||||
|
|
||||||
assert not check_encrypted(
|
|
||||||
"\r\n".join(
|
|
||||||
[
|
|
||||||
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
|
||||||
"Chat-Disposition-Notification-To: foobar@c2.testrun.org",
|
|
||||||
"Chat-User-Avatar: 0",
|
|
||||||
"From: <foobar@c2.testrun.org>",
|
|
||||||
"To: <barbaz@c2.testrun.org>",
|
|
||||||
"Date: Sun, 15 Oct 2023 16:41:44 +0000",
|
|
||||||
"Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"Chat-Version: 1.0",
|
|
||||||
"Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;",
|
|
||||||
"\tkeydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m",
|
|
||||||
"\tnNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID",
|
|
||||||
"\tFgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I",
|
|
||||||
"\tHjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK",
|
|
||||||
"\tKwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ",
|
|
||||||
"\tJlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI",
|
|
||||||
"\tvYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK",
|
|
||||||
"MIME-Version: 1.0",
|
|
||||||
"Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no",
|
|
||||||
"",
|
|
||||||
"Hi!",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
).encode()
|
|
||||||
)
|
|
||||||
|
|
||||||
# https://xkcd.com/1181/
|
|
||||||
assert not check_encrypted(
|
|
||||||
"\r\n".join(
|
|
||||||
[
|
|
||||||
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
|
||||||
"Chat-Disposition-Notification-To: foobar@c2.testrun.org",
|
|
||||||
"Chat-User-Avatar: 0",
|
|
||||||
"From: <foobar@c2.testrun.org>",
|
|
||||||
"To: <barbaz@c2.testrun.org>",
|
|
||||||
"Date: Sun, 15 Oct 2023 16:41:44 +0000",
|
|
||||||
"Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"Chat-Version: 1.0",
|
|
||||||
"Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;",
|
|
||||||
"\tkeydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m",
|
|
||||||
"\tnNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID",
|
|
||||||
"\tFgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I",
|
|
||||||
"\tHjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK",
|
|
||||||
"\tKwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ",
|
|
||||||
"\tJlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI",
|
|
||||||
"\tvYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK",
|
|
||||||
"MIME-Version: 1.0",
|
|
||||||
"Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no",
|
|
||||||
"",
|
|
||||||
"-----BEGIN PGP MESSAGE-----",
|
|
||||||
"Hi!",
|
|
||||||
"-----END PGP MESSAGE-----",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
).encode()
|
|
||||||
)
|
|
||||||
|
|
||||||
assert check_encrypted(
|
|
||||||
"\r\n".join(
|
|
||||||
[
|
|
||||||
"Subject: ...",
|
|
||||||
"From: <barbaz@c2.testrun.org>",
|
|
||||||
"To: <foobar@c2.testrun.org>",
|
|
||||||
"Date: Sun, 15 Oct 2023 16:43:21 +0000",
|
|
||||||
"Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>",
|
|
||||||
"In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>",
|
|
||||||
"References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"\t<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>",
|
|
||||||
"Chat-Version: 1.0",
|
|
||||||
"Autocrypt: addr=barbaz@c2.testrun.org; prefer-encrypt=mutual;",
|
|
||||||
"\tkeydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH",
|
|
||||||
"\trNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID",
|
|
||||||
"\tFgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW",
|
|
||||||
"\tXQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK",
|
|
||||||
"\tKwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ",
|
|
||||||
"\tJlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP",
|
|
||||||
"\tIXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO",
|
|
||||||
"MIME-Version: 1.0",
|
|
||||||
'Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";',
|
|
||||||
'\tboundary="YFrteb74qSXmggbOxZL9dRnhymywAi"',
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--YFrteb74qSXmggbOxZL9dRnhymywAi",
|
|
||||||
"Content-Description: PGP/MIME version identification",
|
|
||||||
"Content-Type: application/pgp-encrypted",
|
|
||||||
"",
|
|
||||||
"Version: 1",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--YFrteb74qSXmggbOxZL9dRnhymywAi",
|
|
||||||
"Content-Description: OpenPGP encrypted message",
|
|
||||||
'Content-Disposition: inline; filename="encrypted.asc";',
|
|
||||||
'Content-Type: application/octet-stream; name="encrypted.asc"',
|
|
||||||
"",
|
|
||||||
"-----BEGIN PGP MESSAGE-----",
|
|
||||||
"",
|
|
||||||
"wU4DhW3gBZ/VvCYSAQdA8bMs2spwbKdGjVsL1ByPkNrqD7frpB73maeL6I6SzDYg",
|
|
||||||
"O5G53tv339RdKq3WRcCtEEvxjHlUx2XNwXzC04BpmfvBTgNfPUyLDzjXnxIBB0Ae",
|
|
||||||
"8ymwGvXMCCimHXN0Dg8Ui62KOi03h0UgheoHWovJSCDF4CKre/xtFr3nL7lq/PKI",
|
|
||||||
"JsjVNz7/RK9FSXF6WwfONtLCyQGEuVAsB/KXfCBEyfKhaMwGHvhujRidGW5uV1no",
|
|
||||||
"lMGl3ODmo29Lgeu2uSE7EpJRZoe6hU6ddmBkqxax61ZtkaFlGFFpdo2K8balNNdz",
|
|
||||||
"ZsJ/9mmI9x3oOJ4/l1nhQbUO9ADbs7gJhFdV5Qkp30b5fCI7bU+aoe1ccBbLe/WM",
|
|
||||||
"YUty1PqcuQT7XjA+XmYuL261tvW8pBetT+i33/E2d8PzzYt2IuK9qeevyS+yxdwA",
|
|
||||||
"kfwejFWzzsUlJaDxs1x4XOxkMgSj+jo+g12dFOb7fyClsAnq23iDb8AuaT/BScAI",
|
|
||||||
"+lO+gher69+6LmM7VGHLG5k762J1jTaQCaKt1s8TAWV99Eo4491vL6fyvk3l/Cfg",
|
|
||||||
"RXSwiWFgj19Pn0Rq7CD9v22UE2vdUMBTcV4aw79mClk1YQ23jbF0y5DCjPdJ62Zo",
|
|
||||||
"tskBgFt3NoWV80jZ76zIBLrrjLwCCll8JjJtFwSkt2GX5RFBsVa4A8IDht9RtEk7",
|
|
||||||
"rrHgbSZQfkauEi/mH3/6CDZoLqSHudUZ7d4MaJwun1TkFYGe2ORwGJd4OBj3oGJp",
|
|
||||||
"H8YBwCpk///L/fKjX0Gg3M8nrpM4wrRFhPKidAgO/kcm25X4+ZHlVkWBTCt5RWKI",
|
|
||||||
"fHh6oLDZCqCfcgMkE1KKmwfIHaUkhq5BPRigwy6i5dh1DM4+1UCLh3dxzVbqE9b9",
|
|
||||||
"61NB19nXdRtDA2sOUnj9ve6m/wEPyCb6/zBQZqvCBYb1/AjdXpUrFT+DbpfyxaXN",
|
|
||||||
"XfhDVb5mNqNM/IVj0V5fvTc6vOfYbzQtPm10H+FdWWfb+rJRfyC3MA2w2IqstFe3",
|
|
||||||
"w3bu2iE6CQvSqRvge+ZqLKt/NqYwOURiUmpuklbl3kPJ97+mfKWoiqk8Iz1VY+bb",
|
|
||||||
"NMUC7aoGv+jcoj+WS6PYO8N6BeRVUUB3ZJSf8nzjgxm1/BcM+UD3BPrlhT11ODRs",
|
|
||||||
"baifGbprMWwt3dhb8cQgRT8GPdpO1OsDkzL6iikMjLHWWiA99GV6ruiHsIPw6boW",
|
|
||||||
"A6/uSOskbDHOROotKmddGTBd0iiHXAoQsJFt1ZjUkt6EHrgWs+GAvrvKpXs1mrz8",
|
|
||||||
"uj3GwEFrHS+Xuf2UDgpszYT3hI2cL/kUtGakVR7m7vVMZqXBUbZdGAEb1PZNPwsI",
|
|
||||||
"E4aMK02+EVB+tSN4Fzj99N2YD0inVYt+oPjr2tHhUS6aSGBNS/48Ki47DOg4Sxkn",
|
|
||||||
"lkOWnEbCD+XTnbDd",
|
|
||||||
"=agR5",
|
|
||||||
"-----END PGP MESSAGE-----",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--YFrteb74qSXmggbOxZL9dRnhymywAi--",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
).encode()
|
|
||||||
)
|
|
||||||
|
|
||||||
assert not check_encrypted(
|
|
||||||
"\r\n".join(
|
|
||||||
[
|
|
||||||
"Subject: Buy Penis Enlargement at www.malicious-domain.com",
|
|
||||||
"From: <barbaz@c2.testrun.org>",
|
|
||||||
"To: <foobar@c2.testrun.org>",
|
|
||||||
"Date: Sun, 15 Oct 2023 16:43:21 +0000",
|
|
||||||
"Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>",
|
|
||||||
"In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>",
|
|
||||||
"References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>",
|
|
||||||
"\t<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>",
|
|
||||||
"Chat-Version: 1.0",
|
|
||||||
"Autocrypt: addr=barbaz@c2.testrun.org; prefer-encrypt=mutual;",
|
|
||||||
"\tkeydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH",
|
|
||||||
"\trNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID",
|
|
||||||
"\tFgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW",
|
|
||||||
"\tXQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK",
|
|
||||||
"\tKwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ",
|
|
||||||
"\tJlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP",
|
|
||||||
"\tIXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO",
|
|
||||||
"MIME-Version: 1.0",
|
|
||||||
'Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";',
|
|
||||||
'\tboundary="YFrteb74qSXmggbOxZL9dRnhymywAi"',
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--YFrteb74qSXmggbOxZL9dRnhymywAi",
|
|
||||||
"Content-Description: PGP/MIME version identification",
|
|
||||||
"Content-Type: application/pgp-encrypted",
|
|
||||||
"",
|
|
||||||
"Version: 1",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--YFrteb74qSXmggbOxZL9dRnhymywAi",
|
|
||||||
"Content-Description: OpenPGP encrypted message",
|
|
||||||
'Content-Disposition: inline; filename="encrypted.asc";',
|
|
||||||
'Content-Type: application/octet-stream; name="encrypted.asc"',
|
|
||||||
"",
|
|
||||||
"-----BEGIN PGP MESSAGE-----",
|
|
||||||
"",
|
|
||||||
"wU4DhW3gBZ/VvCYSAQdA8bMs2spwbKdGjVsL1ByPkNrqD7frpB73maeL6I6SzDYg",
|
|
||||||
"O5G53tv339RdKq3WRcCtEEvxjHlUx2XNwXzC04BpmfvBTgNfPUyLDzjXnxIBB0Ae",
|
|
||||||
"8ymwGvXMCCimHXN0Dg8Ui62KOi03h0UgheoHWovJSCDF4CKre/xtFr3nL7lq/PKI",
|
|
||||||
"JsjVNz7/RK9FSXF6WwfONtLCyQGEuVAsB/KXfCBEyfKhaMwGHvhujRidGW5uV1no",
|
|
||||||
"lMGl3ODmo29Lgeu2uSE7EpJRZoe6hU6ddmBkqxax61ZtkaFlGFFpdo2K8balNNdz",
|
|
||||||
"ZsJ/9mmI9x3oOJ4/l1nhQbUO9ADbs7gJhFdV5Qkp30b5fCI7bU+aoe1ccBbLe/WM",
|
|
||||||
"YUty1PqcuQT7XjA+XmYuL261tvW8pBetT+i33/E2d8PzzYt2IuK9qeevyS+yxdwA",
|
|
||||||
"kfwejFWzzsUlJaDxs1x4XOxkMgSj+jo+g12dFOb7fyClsAnq23iDb8AuaT/BScAI",
|
|
||||||
"+lO+gher69+6LmM7VGHLG5k762J1jTaQCaKt1s8TAWV99Eo4491vL6fyvk3l/Cfg",
|
|
||||||
"RXSwiWFgj19Pn0Rq7CD9v22UE2vdUMBTcV4aw79mClk1YQ23jbF0y5DCjPdJ62Zo",
|
|
||||||
"tskBgFt3NoWV80jZ76zIBLrrjLwCCll8JjJtFwSkt2GX5RFBsVa4A8IDht9RtEk7",
|
|
||||||
"rrHgbSZQfkauEi/mH3/6CDZoLqSHudUZ7d4MaJwun1TkFYGe2ORwGJd4OBj3oGJp",
|
|
||||||
"H8YBwCpk///L/fKjX0Gg3M8nrpM4wrRFhPKidAgO/kcm25X4+ZHlVkWBTCt5RWKI",
|
|
||||||
"fHh6oLDZCqCfcgMkE1KKmwfIHaUkhq5BPRigwy6i5dh1DM4+1UCLh3dxzVbqE9b9",
|
|
||||||
"61NB19nXdRtDA2sOUnj9ve6m/wEPyCb6/zBQZqvCBYb1/AjdXpUrFT+DbpfyxaXN",
|
|
||||||
"XfhDVb5mNqNM/IVj0V5fvTc6vOfYbzQtPm10H+FdWWfb+rJRfyC3MA2w2IqstFe3",
|
|
||||||
"w3bu2iE6CQvSqRvge+ZqLKt/NqYwOURiUmpuklbl3kPJ97+mfKWoiqk8Iz1VY+bb",
|
|
||||||
"NMUC7aoGv+jcoj+WS6PYO8N6BeRVUUB3ZJSf8nzjgxm1/BcM+UD3BPrlhT11ODRs",
|
|
||||||
"baifGbprMWwt3dhb8cQgRT8GPdpO1OsDkzL6iikMjLHWWiA99GV6ruiHsIPw6boW",
|
|
||||||
"A6/uSOskbDHOROotKmddGTBd0iiHXAoQsJFt1ZjUkt6EHrgWs+GAvrvKpXs1mrz8",
|
|
||||||
"uj3GwEFrHS+Xuf2UDgpszYT3hI2cL/kUtGakVR7m7vVMZqXBUbZdGAEb1PZNPwsI",
|
|
||||||
"E4aMK02+EVB+tSN4Fzj99N2YD0inVYt+oPjr2tHhUS6aSGBNS/48Ki47DOg4Sxkn",
|
|
||||||
"lkOWnEbCD+XTnbDd",
|
|
||||||
"=agR5",
|
|
||||||
"-----END PGP MESSAGE-----",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--YFrteb74qSXmggbOxZL9dRnhymywAi--",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
).encode()
|
|
||||||
)
|
|
||||||
|
|
||||||
assert not check_encrypted(
|
|
||||||
"\r\n".join(
|
|
||||||
[
|
|
||||||
"Subject: Message opened",
|
|
||||||
"From: <barbaz@c2.testrun.org>",
|
|
||||||
"To: <foobar@c2.testrun.org>",
|
|
||||||
"Date: Sun, 15 Oct 2023 16:43:25 +0000",
|
|
||||||
"Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>",
|
|
||||||
"Auto-Submitted: auto-replied",
|
|
||||||
"Chat-Version: 1.0",
|
|
||||||
"MIME-Version: 1.0",
|
|
||||||
"Content-Type: multipart/report; report-type=disposition-notification;",
|
|
||||||
'\tboundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"',
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi",
|
|
||||||
"Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no",
|
|
||||||
"",
|
|
||||||
'The "Hi!" message you sent was displayed on the screen of the recipient.',
|
|
||||||
"",
|
|
||||||
"This is no guarantee the content was read.",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi",
|
|
||||||
"Content-Type: message/disposition-notification",
|
|
||||||
"",
|
|
||||||
"Reporting-UA: Delta Chat 1.124.1",
|
|
||||||
"Original-Recipient: rfc822;barbaz@c2.testrun.org",
|
|
||||||
"Final-Recipient: rfc822;barbaz@c2.testrun.org",
|
|
||||||
"Original-Message-ID: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>",
|
|
||||||
"Disposition: manual-action/MDN-sent-automatically; displayed",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
"--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
]
|
|
||||||
).encode()
|
|
||||||
)
|
|
||||||
66
chatmaild/src/chatmaild/tests/mail-data/encrypted.eml
Normal file
66
chatmaild/src/chatmaild/tests/mail-data/encrypted.eml
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
From: {from_addr}
|
||||||
|
To: {to_addr}
|
||||||
|
Subject: ...
|
||||||
|
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
||||||
|
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
||||||
|
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
|
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
|
Chat-Version: 1.0
|
||||||
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
|
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
||||||
|
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
||||||
|
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
||||||
|
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
||||||
|
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
||||||
|
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
||||||
|
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
||||||
|
MIME-Version: 1.0
|
||||||
|
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
||||||
|
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
||||||
|
|
||||||
|
|
||||||
|
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
||||||
|
Content-Description: PGP/MIME version identification
|
||||||
|
Content-Type: application/pgp-encrypted
|
||||||
|
|
||||||
|
Version: 1
|
||||||
|
|
||||||
|
|
||||||
|
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
||||||
|
Content-Description: OpenPGP encrypted message
|
||||||
|
Content-Disposition: inline; filename="encrypted.asc";
|
||||||
|
Content-Type: application/octet-stream; name="encrypted.asc"
|
||||||
|
|
||||||
|
-----BEGIN PGP MESSAGE-----
|
||||||
|
|
||||||
|
wU4DhW3gBZ/VvCYSAQdA8bMs2spwbKdGjVsL1ByPkNrqD7frpB73maeL6I6SzDYg
|
||||||
|
O5G53tv339RdKq3WRcCtEEvxjHlUx2XNwXzC04BpmfvBTgNfPUyLDzjXnxIBB0Ae
|
||||||
|
8ymwGvXMCCimHXN0Dg8Ui62KOi03h0UgheoHWovJSCDF4CKre/xtFr3nL7lq/PKI
|
||||||
|
JsjVNz7/RK9FSXF6WwfONtLCyQGEuVAsB/KXfCBEyfKhaMwGHvhujRidGW5uV1no
|
||||||
|
lMGl3ODmo29Lgeu2uSE7EpJRZoe6hU6ddmBkqxax61ZtkaFlGFFpdo2K8balNNdz
|
||||||
|
ZsJ/9mmI9x3oOJ4/l1nhQbUO9ADbs7gJhFdV5Qkp30b5fCI7bU+aoe1ccBbLe/WM
|
||||||
|
YUty1PqcuQT7XjA+XmYuL261tvW8pBetT+i33/E2d8PzzYt2IuK9qeevyS+yxdwA
|
||||||
|
kfwejFWzzsUlJaDxs1x4XOxkMgSj+jo+g12dFOb7fyClsAnq23iDb8AuaT/BScAI
|
||||||
|
+lO+gher69+6LmM7VGHLG5k762J1jTaQCaKt1s8TAWV99Eo4491vL6fyvk3l/Cfg
|
||||||
|
RXSwiWFgj19Pn0Rq7CD9v22UE2vdUMBTcV4aw79mClk1YQ23jbF0y5DCjPdJ62Zo
|
||||||
|
tskBgFt3NoWV80jZ76zIBLrrjLwCCll8JjJtFwSkt2GX5RFBsVa4A8IDht9RtEk7
|
||||||
|
rrHgbSZQfkauEi/mH3/6CDZoLqSHudUZ7d4MaJwun1TkFYGe2ORwGJd4OBj3oGJp
|
||||||
|
H8YBwCpk///L/fKjX0Gg3M8nrpM4wrRFhPKidAgO/kcm25X4+ZHlVkWBTCt5RWKI
|
||||||
|
fHh6oLDZCqCfcgMkE1KKmwfIHaUkhq5BPRigwy6i5dh1DM4+1UCLh3dxzVbqE9b9
|
||||||
|
61NB19nXdRtDA2sOUnj9ve6m/wEPyCb6/zBQZqvCBYb1/AjdXpUrFT+DbpfyxaXN
|
||||||
|
XfhDVb5mNqNM/IVj0V5fvTc6vOfYbzQtPm10H+FdWWfb+rJRfyC3MA2w2IqstFe3
|
||||||
|
w3bu2iE6CQvSqRvge+ZqLKt/NqYwOURiUmpuklbl3kPJ97+mfKWoiqk8Iz1VY+bb
|
||||||
|
NMUC7aoGv+jcoj+WS6PYO8N6BeRVUUB3ZJSf8nzjgxm1/BcM+UD3BPrlhT11ODRs
|
||||||
|
baifGbprMWwt3dhb8cQgRT8GPdpO1OsDkzL6iikMjLHWWiA99GV6ruiHsIPw6boW
|
||||||
|
A6/uSOskbDHOROotKmddGTBd0iiHXAoQsJFt1ZjUkt6EHrgWs+GAvrvKpXs1mrz8
|
||||||
|
uj3GwEFrHS+Xuf2UDgpszYT3hI2cL/kUtGakVR7m7vVMZqXBUbZdGAEb1PZNPwsI
|
||||||
|
E4aMK02+EVB+tSN4Fzj99N2YD0inVYt+oPjr2tHhUS6aSGBNS/48Ki47DOg4Sxkn
|
||||||
|
lkOWnEbCD+XTnbDd
|
||||||
|
=agR5
|
||||||
|
-----END PGP MESSAGE-----
|
||||||
|
|
||||||
|
|
||||||
|
--YFrteb74qSXmggbOxZL9dRnhymywAi--
|
||||||
|
|
||||||
|
|
||||||
25
chatmaild/src/chatmaild/tests/mail-data/fake-encrypted.eml
Normal file
25
chatmaild/src/chatmaild/tests/mail-data/fake-encrypted.eml
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=
|
||||||
|
Chat-Disposition-Notification-To: foobar@c2.testrun.org
|
||||||
|
Chat-User-Avatar: 0
|
||||||
|
From: <{from_addr}>
|
||||||
|
To: <{to_addr}>
|
||||||
|
Date: Sun, 15 Oct 2023 16:41:44 +0000
|
||||||
|
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
|
Chat-Version: 1.0
|
||||||
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
|
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
||||||
|
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
||||||
|
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
||||||
|
HjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK
|
||||||
|
KwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ
|
||||||
|
JlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI
|
||||||
|
vYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK
|
||||||
|
MIME-Version: 1.0
|
||||||
|
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
||||||
|
|
||||||
|
-----BEGIN PGP MESSAGE-----
|
||||||
|
Hi!
|
||||||
|
-----END PGP MESSAGE-----
|
||||||
|
|
||||||
|
|
||||||
33
chatmaild/src/chatmaild/tests/mail-data/mdn.eml
Normal file
33
chatmaild/src/chatmaild/tests/mail-data/mdn.eml
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
Subject: Message opened
|
||||||
|
From: <{from_addr}>
|
||||||
|
To: <{to_addr}>
|
||||||
|
Date: Sun, 15 Oct 2023 16:43:25 +0000
|
||||||
|
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
|
||||||
|
Auto-Submitted: auto-replied
|
||||||
|
Chat-Version: 1.0
|
||||||
|
MIME-Version: 1.0
|
||||||
|
Content-Type: multipart/report; report-type=disposition-notification;
|
||||||
|
boundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"
|
||||||
|
|
||||||
|
|
||||||
|
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
||||||
|
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
||||||
|
|
||||||
|
The "Hi!" message you sent was displayed on the screen of the recipient.
|
||||||
|
|
||||||
|
This is no guarantee the content was read.
|
||||||
|
|
||||||
|
|
||||||
|
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
||||||
|
Content-Type: message/disposition-notification
|
||||||
|
|
||||||
|
Reporting-UA: Delta Chat 1.124.1
|
||||||
|
Original-Recipient: rfc822;barbaz@c2.testrun.org
|
||||||
|
Final-Recipient: rfc822;barbaz@c2.testrun.org
|
||||||
|
Original-Message-ID: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
|
Disposition: manual-action/MDN-sent-automatically; displayed
|
||||||
|
|
||||||
|
|
||||||
|
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--
|
||||||
|
|
||||||
|
|
||||||
23
chatmaild/src/chatmaild/tests/mail-data/plain.eml
Normal file
23
chatmaild/src/chatmaild/tests/mail-data/plain.eml
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=
|
||||||
|
Chat-Disposition-Notification-To: foobar@c2.testrun.org
|
||||||
|
Chat-User-Avatar: 0
|
||||||
|
From: <{from_addr}>
|
||||||
|
To: <{to_addr}>
|
||||||
|
Date: Sun, 15 Oct 2023 16:41:44 +0000
|
||||||
|
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
|
Chat-Version: 1.0
|
||||||
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
|
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
||||||
|
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
||||||
|
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
||||||
|
HjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK
|
||||||
|
KwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ
|
||||||
|
JlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI
|
||||||
|
vYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK
|
||||||
|
MIME-Version: 1.0
|
||||||
|
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
||||||
|
|
||||||
|
Hi!
|
||||||
|
|
||||||
|
|
||||||
75
chatmaild/src/chatmaild/tests/plugin.py
Normal file
75
chatmaild/src/chatmaild/tests/plugin.py
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
import random
|
||||||
|
from pathlib import Path
|
||||||
|
import os
|
||||||
|
import importlib.resources
|
||||||
|
import itertools
|
||||||
|
from email.parser import BytesParser
|
||||||
|
from email import policy
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from chatmaild.database import Database
|
||||||
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def make_config(tmp_path):
|
||||||
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
|
||||||
|
def make_conf(mail_domain):
|
||||||
|
write_initial_config(inipath, mail_domain=mail_domain)
|
||||||
|
return read_config(inipath)
|
||||||
|
|
||||||
|
return make_conf
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def example_config(make_config):
|
||||||
|
return make_config("chat.example.org")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildomain(example_config):
|
||||||
|
return example_config.mail_domain
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def gencreds(maildomain):
|
||||||
|
count = itertools.count()
|
||||||
|
next(count)
|
||||||
|
|
||||||
|
def gen(domain=None):
|
||||||
|
domain = domain if domain else maildomain
|
||||||
|
while 1:
|
||||||
|
num = next(count)
|
||||||
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
|
user = "".join(random.choices(alphanumeric, k=10))
|
||||||
|
user = f"ac{num}_{user}"[:9]
|
||||||
|
password = "".join(random.choices(alphanumeric, k=12))
|
||||||
|
yield f"{user}@{domain}", f"{password}"
|
||||||
|
|
||||||
|
return lambda domain=None: next(gen(domain))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def db(tmpdir):
|
||||||
|
db_path = tmpdir / "passdb.sqlite"
|
||||||
|
print("database path:", db_path)
|
||||||
|
return Database(db_path)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildata(request):
|
||||||
|
try:
|
||||||
|
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
||||||
|
except TypeError:
|
||||||
|
# in python3.9 or lower, the above doesn't work, so we get datadir this way:
|
||||||
|
datadir = Path(os.getcwd()).joinpath("chatmaild/src/chatmaild/tests/mail-data")
|
||||||
|
|
||||||
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
|
def maildata(name, from_addr, to_addr):
|
||||||
|
data = datadir.joinpath(name).read_text()
|
||||||
|
text = data.format(from_addr=from_addr, to_addr=to_addr)
|
||||||
|
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
||||||
|
|
||||||
|
return maildata
|
||||||
32
chatmaild/src/chatmaild/tests/test_config.py
Normal file
32
chatmaild/src/chatmaild/tests/test_config.py
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_config_basic(example_config):
|
||||||
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
assert not example_config.privacy_supervisor and not example_config.privacy_mail
|
||||||
|
assert not example_config.privacy_pdo and not example_config.privacy_postal
|
||||||
|
|
||||||
|
inipath = example_config._inipath
|
||||||
|
inipath.write_text(inipath.read_text().replace("60", "37"))
|
||||||
|
example_config = read_config(inipath)
|
||||||
|
assert example_config.max_user_send_per_minute == 37
|
||||||
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_config_testrun(make_config):
|
||||||
|
config = make_config("something.testrun.org")
|
||||||
|
assert config.mail_domain == "something.testrun.org"
|
||||||
|
assert len(config.privacy_postal.split("\n")) > 1
|
||||||
|
assert len(config.privacy_supervisor.split("\n")) > 1
|
||||||
|
assert len(config.privacy_pdo.split("\n")) > 1
|
||||||
|
assert config.privacy_mail == "privacy@testrun.org"
|
||||||
|
assert config.filtermail_smtp_port == 10080
|
||||||
|
assert config.postfix_reinject_port == 10025
|
||||||
|
assert config.max_user_send_per_minute == 60
|
||||||
|
assert config.max_mailbox_size == "100M"
|
||||||
|
assert config.delete_mails_after == "40"
|
||||||
|
assert config.username_min_length == 9
|
||||||
|
assert config.username_max_length == 9
|
||||||
|
assert config.password_min_length == 9
|
||||||
|
assert "privacy@testrun.org" in config.passthrough_recipients
|
||||||
|
assert config.passthrough_senders == []
|
||||||
114
chatmaild/src/chatmaild/tests/test_doveauth.py
Normal file
114
chatmaild/src/chatmaild/tests/test_doveauth.py
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
import io
|
||||||
|
import json
|
||||||
|
import pytest
|
||||||
|
import queue
|
||||||
|
import threading
|
||||||
|
import traceback
|
||||||
|
|
||||||
|
import chatmaild.doveauth
|
||||||
|
from chatmaild.doveauth import (
|
||||||
|
get_user_data,
|
||||||
|
lookup_passdb,
|
||||||
|
handle_dovecot_request,
|
||||||
|
handle_dovecot_protocol,
|
||||||
|
)
|
||||||
|
from chatmaild.database import DBError
|
||||||
|
|
||||||
|
|
||||||
|
def test_basic(db, example_config):
|
||||||
|
lookup_passdb(db, example_config, "asdf12345@chat.example.org", "q9mr3faue")
|
||||||
|
data = get_user_data(db, "asdf12345@chat.example.org")
|
||||||
|
assert data
|
||||||
|
data2 = lookup_passdb(
|
||||||
|
db, example_config, "asdf12345@chat.example.org", "q9mr3jewvadsfaue"
|
||||||
|
)
|
||||||
|
assert data == data2
|
||||||
|
|
||||||
|
|
||||||
|
def test_dont_overwrite_password_on_wrong_login(db, example_config):
|
||||||
|
"""Test that logging in with a different password doesn't create a new user"""
|
||||||
|
res = lookup_passdb(
|
||||||
|
db, example_config, "newuser12@chat.example.org", "kajdlkajsldk12l3kj1983"
|
||||||
|
)
|
||||||
|
assert res["password"]
|
||||||
|
res2 = lookup_passdb(db, example_config, "newuser12@chat.example.org", "kajdslqwe")
|
||||||
|
# this function always returns a password hash, which is actually compared by dovecot.
|
||||||
|
assert res["password"] == res2["password"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_nocreate_file(db, monkeypatch, tmpdir, example_config):
|
||||||
|
p = tmpdir.join("nocreate")
|
||||||
|
p.write("")
|
||||||
|
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
||||||
|
lookup_passdb(
|
||||||
|
db, example_config, "newuser12@chat.example.org", "zequ0Aimuchoodaechik"
|
||||||
|
)
|
||||||
|
assert not get_user_data(db, "newuser12@chat.example.org")
|
||||||
|
|
||||||
|
|
||||||
|
def test_db_version(db):
|
||||||
|
assert db.get_schema_version() == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_too_high_db_version(db):
|
||||||
|
with db.write_transaction() as conn:
|
||||||
|
conn.execute("PRAGMA user_version=%s;" % (999,))
|
||||||
|
with pytest.raises(DBError):
|
||||||
|
db.ensure_tables()
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_request(db, example_config):
|
||||||
|
# Test that password can contain ", ', \ and /
|
||||||
|
msg = (
|
||||||
|
'Lshared/passdb/laksjdlaksjdlak\\\\sjdlk\\"12j\\\'3l1/k2j3123"'
|
||||||
|
"some42123@chat.example.org\tsome42123@chat.example.org"
|
||||||
|
)
|
||||||
|
res = handle_dovecot_request(msg, db, example_config)
|
||||||
|
assert res
|
||||||
|
assert res[0] == "O" and res.endswith("\n")
|
||||||
|
userdata = json.loads(res[1:].strip())
|
||||||
|
assert (
|
||||||
|
userdata["home"]
|
||||||
|
== "/home/vmail/mail/chat.example.org/some42123@chat.example.org"
|
||||||
|
)
|
||||||
|
assert userdata["uid"] == userdata["gid"] == "vmail"
|
||||||
|
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_protocol(db, example_config):
|
||||||
|
rfile = io.BytesIO(
|
||||||
|
b"H3\t2\t0\t\tauth\nLshared/userdb/foobar@chat.example.org\tfoobar@chat.example.org\n"
|
||||||
|
)
|
||||||
|
wfile = io.BytesIO()
|
||||||
|
handle_dovecot_protocol(rfile, wfile, db, example_config)
|
||||||
|
assert wfile.getvalue() == b"N\n"
|
||||||
|
|
||||||
|
|
||||||
|
def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
||||||
|
num_threads = 50
|
||||||
|
req_per_thread = 5
|
||||||
|
results = queue.Queue()
|
||||||
|
|
||||||
|
def lookup(db):
|
||||||
|
for i in range(req_per_thread):
|
||||||
|
addr, password = gencreds()
|
||||||
|
try:
|
||||||
|
lookup_passdb(db, example_config, addr, password)
|
||||||
|
except Exception:
|
||||||
|
results.put(traceback.format_exc())
|
||||||
|
else:
|
||||||
|
results.put(None)
|
||||||
|
|
||||||
|
threads = []
|
||||||
|
for i in range(num_threads):
|
||||||
|
thread = threading.Thread(target=lookup, args=(db,), daemon=True)
|
||||||
|
threads.append(thread)
|
||||||
|
|
||||||
|
print(f"created {num_threads} threads, starting them and waiting for results")
|
||||||
|
for thread in threads:
|
||||||
|
thread.start()
|
||||||
|
|
||||||
|
for i in range(num_threads * req_per_thread):
|
||||||
|
res = results.get()
|
||||||
|
if res is not None:
|
||||||
|
pytest.fail(f"concurrent lookup failed\n{res}")
|
||||||
145
chatmaild/src/chatmaild/tests/test_filtermail.py
Normal file
145
chatmaild/src/chatmaild/tests/test_filtermail.py
Normal file
@@ -0,0 +1,145 @@
|
|||||||
|
from chatmaild.filtermail import (
|
||||||
|
check_encrypted,
|
||||||
|
BeforeQueueHandler,
|
||||||
|
SendRateLimiter,
|
||||||
|
check_mdn,
|
||||||
|
)
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildomain():
|
||||||
|
# let's not depend on a real chatmail instance for the offline tests below
|
||||||
|
return "chatmail.example.org"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def handler(make_config, maildomain):
|
||||||
|
config = make_config(maildomain)
|
||||||
|
return BeforeQueueHandler(config)
|
||||||
|
|
||||||
|
|
||||||
|
def test_reject_forged_from(maildata, gencreds, handler):
|
||||||
|
class env:
|
||||||
|
mail_from = gencreds()[0]
|
||||||
|
rcpt_tos = [gencreds()[0]]
|
||||||
|
|
||||||
|
# test that the filter lets good mail through
|
||||||
|
to_addr = gencreds()[0]
|
||||||
|
env.content = maildata(
|
||||||
|
"plain.eml", from_addr=env.mail_from, to_addr=to_addr
|
||||||
|
).as_bytes()
|
||||||
|
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
|
# test that the filter rejects forged mail
|
||||||
|
env.content = maildata(
|
||||||
|
"plain.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
||||||
|
).as_bytes()
|
||||||
|
error = handler.check_DATA(envelope=env)
|
||||||
|
assert "500" in error
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_no_encryption_detection(maildata):
|
||||||
|
msg = maildata(
|
||||||
|
"plain.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
|
)
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
# https://xkcd.com/1181/
|
||||||
|
msg = maildata(
|
||||||
|
"fake-encrypted.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
|
)
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_encryption_detection(maildata):
|
||||||
|
msg = maildata("encrypted.eml", from_addr="1@example.org", to_addr="2@example.org")
|
||||||
|
assert check_encrypted(msg)
|
||||||
|
|
||||||
|
# if the subject is not "..." it is not considered ac-encrypted
|
||||||
|
msg.replace_header("Subject", "Click this link")
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_is_mdn(maildata, gencreds, handler):
|
||||||
|
from_addr = gencreds()[0]
|
||||||
|
to_addr = gencreds()[0] + ".other"
|
||||||
|
msg = maildata("mdn.eml", from_addr, to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
assert check_mdn(msg, env)
|
||||||
|
print(msg.as_string())
|
||||||
|
|
||||||
|
assert not handler.check_DATA(env)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_to_multiple_recipients_no_mdn(maildata, gencreds):
|
||||||
|
from_addr = gencreds()[0]
|
||||||
|
to_addr = gencreds()[0] + ".other"
|
||||||
|
thirdaddr = gencreds()[0]
|
||||||
|
msg = maildata("mdn.eml", from_addr, to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr, thirdaddr]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
assert not check_mdn(msg, env)
|
||||||
|
|
||||||
|
|
||||||
|
def test_send_rate_limiter():
|
||||||
|
limiter = SendRateLimiter()
|
||||||
|
for i in range(100):
|
||||||
|
if limiter.is_sending_allowed("some@example.org", 10):
|
||||||
|
if i <= 10:
|
||||||
|
continue
|
||||||
|
pytest.fail("limiter didn't work")
|
||||||
|
else:
|
||||||
|
assert i == 11
|
||||||
|
break
|
||||||
|
|
||||||
|
|
||||||
|
def test_excempt_privacy(maildata, gencreds, handler):
|
||||||
|
from_addr = gencreds()[0]
|
||||||
|
to_addr = "privacy@testrun.org"
|
||||||
|
handler.config.passthrough_recipients = [to_addr]
|
||||||
|
false_to = "privacy@something.org"
|
||||||
|
|
||||||
|
msg = maildata("plain.eml", from_addr, to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
# assert that None/no error is returned
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
|
class env2:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr, false_to]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
assert "500" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
|
def test_passthrough_senders(gencreds, handler, maildata):
|
||||||
|
acc1 = gencreds()[0]
|
||||||
|
to_addr = "recipient@something.org"
|
||||||
|
handler.config.passthrough_senders = [acc1]
|
||||||
|
|
||||||
|
msg = maildata("plain.eml", acc1, to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = acc1
|
||||||
|
rcpt_tos = to_addr
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
# assert that None/no error is returned
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
16
chatmaild/src/chatmaild/tests/test_metrics.py
Normal file
16
chatmaild/src/chatmaild/tests/test_metrics.py
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
from chatmaild.metrics import main
|
||||||
|
|
||||||
|
|
||||||
|
def test_main(tmp_path, capsys):
|
||||||
|
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
||||||
|
tmp_path.joinpath(x).mkdir()
|
||||||
|
main(tmp_path)
|
||||||
|
out, _ = capsys.readouterr()
|
||||||
|
d = {}
|
||||||
|
for line in out.split("\n"):
|
||||||
|
if line.strip():
|
||||||
|
name, num, _ = line.split()
|
||||||
|
d[name] = int(num)
|
||||||
|
|
||||||
|
assert d["accounts"] == 4
|
||||||
|
assert d["ci_accounts"] == 3
|
||||||
27
chatmaild/src/chatmaild/tests/test_newmail.py
Normal file
27
chatmaild/src/chatmaild/tests/test_newmail.py
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import json
|
||||||
|
|
||||||
|
import chatmaild
|
||||||
|
from chatmaild.newemail import create_newemail_dict, print_new_account
|
||||||
|
|
||||||
|
|
||||||
|
def test_create_newemail_dict(example_config):
|
||||||
|
ac1 = create_newemail_dict(example_config)
|
||||||
|
assert "@" in ac1["email"]
|
||||||
|
assert len(ac1["password"]) >= 10
|
||||||
|
|
||||||
|
ac2 = create_newemail_dict(example_config)
|
||||||
|
|
||||||
|
assert ac1["email"] != ac2["email"]
|
||||||
|
assert ac1["password"] != ac2["password"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
||||||
|
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
||||||
|
print_new_account()
|
||||||
|
out, err = capsys.readouterr()
|
||||||
|
lines = out.split("\n")
|
||||||
|
assert lines[0] == "Content-Type: application/json"
|
||||||
|
assert not lines[1]
|
||||||
|
dic = json.loads(lines[2])
|
||||||
|
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
||||||
|
assert len(dic["password"]) >= 10
|
||||||
32
cmdeploy/pyproject.toml
Normal file
32
cmdeploy/pyproject.toml
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=68"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "cmdeploy"
|
||||||
|
version = "0.2"
|
||||||
|
dependencies = [
|
||||||
|
"pyinfra",
|
||||||
|
"pillow",
|
||||||
|
"qrcode",
|
||||||
|
"markdown",
|
||||||
|
"pytest",
|
||||||
|
"setuptools>=68",
|
||||||
|
"termcolor",
|
||||||
|
"build",
|
||||||
|
"tox",
|
||||||
|
"ruff",
|
||||||
|
"black",
|
||||||
|
"pytest",
|
||||||
|
"pytest-xdist",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
cmdeploy = "cmdeploy.cmdeploy:main"
|
||||||
|
|
||||||
|
[project.entry-points.pytest11]
|
||||||
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
"cmdeploy.testplugin" = "cmdeploy.tests.plugin"
|
||||||
|
|
||||||
|
[tool.pytest.ini_options]
|
||||||
|
addopts = "-v -ra --strict-markers"
|
||||||
578
cmdeploy/src/cmdeploy/__init__.py
Normal file
578
cmdeploy/src/cmdeploy/__init__.py
Normal file
@@ -0,0 +1,578 @@
|
|||||||
|
"""
|
||||||
|
Chat Mail pyinfra deploy.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sys
|
||||||
|
import importlib.resources
|
||||||
|
import subprocess
|
||||||
|
import shutil
|
||||||
|
import io
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from pyinfra import host
|
||||||
|
from pyinfra.operations import apt, files, server, systemd, pip
|
||||||
|
from pyinfra.facts.files import File
|
||||||
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
|
from chatmaild.config import read_config, Config
|
||||||
|
|
||||||
|
|
||||||
|
def _build_chatmaild(dist_dir) -> None:
|
||||||
|
dist_dir = Path(dist_dir).resolve()
|
||||||
|
if dist_dir.exists():
|
||||||
|
shutil.rmtree(dist_dir)
|
||||||
|
dist_dir.mkdir()
|
||||||
|
subprocess.check_output(
|
||||||
|
[sys.executable, "-m", "build", "-n"]
|
||||||
|
+ ["--sdist", "chatmaild", "--outdir", str(dist_dir)]
|
||||||
|
)
|
||||||
|
entries = list(dist_dir.iterdir())
|
||||||
|
assert len(entries) == 1
|
||||||
|
return entries[0]
|
||||||
|
|
||||||
|
|
||||||
|
def remove_legacy_artifacts():
|
||||||
|
# disable legacy doveauth-dictproxy.service
|
||||||
|
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
||||||
|
systemd.service(
|
||||||
|
name="Disable legacy doveauth-dictproxy.service",
|
||||||
|
service="doveauth-dictproxy.service",
|
||||||
|
running=False,
|
||||||
|
enabled=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _install_remote_venv_with_chatmaild(config) -> None:
|
||||||
|
remove_legacy_artifacts()
|
||||||
|
dist_file = _build_chatmaild(dist_dir=Path("chatmaild/dist"))
|
||||||
|
remote_base_dir = "/usr/local/lib/chatmaild"
|
||||||
|
remote_dist_file = f"{remote_base_dir}/dist/{dist_file.name}"
|
||||||
|
remote_venv_dir = f"{remote_base_dir}/venv"
|
||||||
|
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
||||||
|
root_owned = dict(user="root", group="root", mode="644")
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="apt install python3-virtualenv",
|
||||||
|
packages=["python3-virtualenv"],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name="Upload chatmaild source package",
|
||||||
|
src=dist_file.open("rb"),
|
||||||
|
dest=remote_dist_file,
|
||||||
|
create_remote_dir=True,
|
||||||
|
**root_owned,
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name=f"Upload {remote_chatmail_inipath}",
|
||||||
|
src=config._getbytefile(),
|
||||||
|
dest=remote_chatmail_inipath,
|
||||||
|
**root_owned,
|
||||||
|
)
|
||||||
|
|
||||||
|
pip.virtualenv(
|
||||||
|
name=f"chatmaild virtualenv {remote_venv_dir}",
|
||||||
|
path=remote_venv_dir,
|
||||||
|
always_copy=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name=f"forced pip-install {dist_file.name}",
|
||||||
|
commands=[
|
||||||
|
f"{remote_venv_dir}/bin/pip install --force-reinstall {remote_dist_file}"
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"),
|
||||||
|
dest="/etc/cron.d/chatmail-metrics",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={
|
||||||
|
"mail_domain": config.mail_domain,
|
||||||
|
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
# install systemd units
|
||||||
|
for fn in (
|
||||||
|
"doveauth",
|
||||||
|
"filtermail",
|
||||||
|
"echobot",
|
||||||
|
):
|
||||||
|
params = dict(
|
||||||
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
|
config_path=remote_chatmail_inipath,
|
||||||
|
remote_venv_dir=remote_venv_dir,
|
||||||
|
)
|
||||||
|
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
||||||
|
content = source_path.read_text().format(**params).encode()
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name=f"Upload {fn}.service",
|
||||||
|
src=io.BytesIO(content),
|
||||||
|
dest=f"/etc/systemd/system/{fn}.service",
|
||||||
|
**root_owned,
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name=f"Setup {fn} service",
|
||||||
|
service=f"{fn}.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=True,
|
||||||
|
daemon_reload=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
||||||
|
"""Configures OpenDKIM"""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
server.group(name="Create opendkim group", group="opendkim", system=True)
|
||||||
|
server.user(
|
||||||
|
name="Create opendkim user",
|
||||||
|
user="opendkim",
|
||||||
|
groups=["opendkim"],
|
||||||
|
system=True,
|
||||||
|
)
|
||||||
|
server.user(
|
||||||
|
name="Add postfix user to opendkim group for socket access",
|
||||||
|
user="postfix",
|
||||||
|
groups=["opendkim"],
|
||||||
|
system=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
||||||
|
dest="/etc/opendkim.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
screen_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/screen.lua"),
|
||||||
|
dest="/etc/opendkim/screen.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= screen_script.changed
|
||||||
|
|
||||||
|
final_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/final.lua"),
|
||||||
|
dest="/etc/opendkim/final.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= final_script.changed
|
||||||
|
|
||||||
|
files.directory(
|
||||||
|
name="Add opendkim directory to /etc",
|
||||||
|
path="/etc/opendkim",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="750",
|
||||||
|
present=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
keytable = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/KeyTable"),
|
||||||
|
dest="/etc/dkimkeys/KeyTable",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
need_restart |= keytable.changed
|
||||||
|
|
||||||
|
signing_table = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/SigningTable"),
|
||||||
|
dest="/etc/dkimkeys/SigningTable",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
need_restart |= signing_table.changed
|
||||||
|
files.directory(
|
||||||
|
name="Add opendkim socket directory to /var/spool/postfix",
|
||||||
|
path="/var/spool/postfix/opendkim",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="750",
|
||||||
|
present=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="apt install opendkim opendkim-tools",
|
||||||
|
packages=["opendkim", "opendkim-tools"],
|
||||||
|
)
|
||||||
|
|
||||||
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
||||||
|
server.shell(
|
||||||
|
name="Generate OpenDKIM domain keys",
|
||||||
|
commands=[
|
||||||
|
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
||||||
|
],
|
||||||
|
_sudo=True,
|
||||||
|
_sudo_user="opendkim",
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _install_mta_sts_daemon() -> bool:
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
config = files.put(
|
||||||
|
name="upload postfix-mta-sts-resolver config",
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/mta-sts-daemon.yml"
|
||||||
|
),
|
||||||
|
dest="/etc/mta-sts-daemon.yml",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
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:
|
||||||
|
"""Configures Postfix SMTP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"),
|
||||||
|
dest="/etc/postfix/main.cf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config=config,
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
master_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"),
|
||||||
|
dest="/etc/postfix/master.cf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
debug=debug,
|
||||||
|
config=config,
|
||||||
|
)
|
||||||
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
|
header_cleanup = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/submission_header_cleanup"
|
||||||
|
),
|
||||||
|
dest="/etc/postfix/submission_header_cleanup",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= header_cleanup.changed
|
||||||
|
|
||||||
|
# Login map that 1:1 maps email address to login.
|
||||||
|
login_map = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/login_map"),
|
||||||
|
dest="/etc/postfix/login_map",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= login_map.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
||||||
|
"""Configures Dovecot IMAP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"),
|
||||||
|
dest="/etc/dovecot/dovecot.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config=config,
|
||||||
|
debug=debug,
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
auth_config = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/auth.conf"),
|
||||||
|
dest="/etc/dovecot/auth.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= auth_config.changed
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
||||||
|
dest="/etc/cron.d/expunge",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config=config,
|
||||||
|
)
|
||||||
|
|
||||||
|
# as per https://doc.dovecot.org/configuration_manual/os/
|
||||||
|
# it is recommended to set the following inotify limits
|
||||||
|
for name in ("max_user_instances", "max_user_watches"):
|
||||||
|
key = f"fs.inotify.{name}"
|
||||||
|
server.sysctl(
|
||||||
|
name=f"Change {key}",
|
||||||
|
key=key,
|
||||||
|
value=65535,
|
||||||
|
persist=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
||||||
|
"""Configures nginx HTTP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("nginx/nginx.conf.j2"),
|
||||||
|
dest="/etc/nginx/nginx.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain},
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
autoconfig = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("nginx/autoconfig.xml.j2"),
|
||||||
|
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain},
|
||||||
|
)
|
||||||
|
need_restart |= autoconfig.changed
|
||||||
|
|
||||||
|
mta_sts_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("nginx/mta-sts.txt.j2"),
|
||||||
|
dest="/var/www/html/.well-known/mta-sts.txt",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain},
|
||||||
|
)
|
||||||
|
need_restart |= mta_sts_config.changed
|
||||||
|
|
||||||
|
# install CGI newemail script
|
||||||
|
#
|
||||||
|
cgi_dir = "/usr/lib/cgi-bin"
|
||||||
|
files.directory(
|
||||||
|
name=f"Ensure {cgi_dir} exists",
|
||||||
|
path=cgi_dir,
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name="Upload cgi newemail.py script",
|
||||||
|
src=importlib.resources.files("chatmaild").joinpath("newemail.py").open("rb"),
|
||||||
|
dest=f"{cgi_dir}/newemail.py",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="755",
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _remove_rspamd() -> None:
|
||||||
|
"""Remove rspamd"""
|
||||||
|
apt.packages(name="Remove rspamd", packages="rspamd", present=False)
|
||||||
|
|
||||||
|
|
||||||
|
def check_config(config):
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
||||||
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
|
for value in config.__dict__.values():
|
||||||
|
if any(x in str(value) for x in blocked_words):
|
||||||
|
raise ValueError(
|
||||||
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
|
)
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_chatmail(config_path: Path) -> None:
|
||||||
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
|
:param config_path: path to chatmail.ini
|
||||||
|
"""
|
||||||
|
config = read_config(config_path)
|
||||||
|
check_config(config)
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
|
||||||
|
from .www import build_webpages
|
||||||
|
|
||||||
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
|
||||||
|
# Run local DNS resolver `unbound`.
|
||||||
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
|
# to use 127.0.0.1 as the resolver.
|
||||||
|
apt.packages(
|
||||||
|
name="Install unbound",
|
||||||
|
packages=["unbound", "unbound-anchor", "dnsutils"],
|
||||||
|
)
|
||||||
|
server.shell(
|
||||||
|
name="Generate root keys for validating DNSSEC",
|
||||||
|
commands=[
|
||||||
|
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
||||||
|
"systemctl reset-failed unbound.service",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable unbound",
|
||||||
|
service="unbound.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Deploy acmetool to have TLS certificates.
|
||||||
|
deploy_acmetool(
|
||||||
|
nginx_hook=True,
|
||||||
|
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install Postfix",
|
||||||
|
packages="postfix",
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install Dovecot",
|
||||||
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install nginx",
|
||||||
|
packages=["nginx"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install fcgiwrap",
|
||||||
|
packages=["fcgiwrap"],
|
||||||
|
)
|
||||||
|
|
||||||
|
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
||||||
|
|
||||||
|
build_dir = www_path.joinpath("build")
|
||||||
|
src_dir = www_path.joinpath("src")
|
||||||
|
build_webpages(src_dir, build_dir, config)
|
||||||
|
files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
|
||||||
|
|
||||||
|
_install_remote_venv_with_chatmaild(config)
|
||||||
|
debug = False
|
||||||
|
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
||||||
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
|
nginx_need_restart = _configure_nginx(mail_domain)
|
||||||
|
|
||||||
|
_remove_rspamd()
|
||||||
|
opendkim_need_restart = _configure_opendkim(mail_domain, "opendkim")
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable OpenDKIM",
|
||||||
|
service="opendkim.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
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,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Postfix",
|
||||||
|
service="postfix.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=postfix_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Dovecot",
|
||||||
|
service="dovecot.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=dovecot_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable nginx",
|
||||||
|
service="nginx.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=nginx_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
# This file is used by auth proxy.
|
||||||
|
# https://wiki.debian.org/EtcMailName
|
||||||
|
server.shell(
|
||||||
|
name="Setup /etc/mailname",
|
||||||
|
commands=[f"echo {mail_domain} >/etc/mailname; chmod 644 /etc/mailname"],
|
||||||
|
)
|
||||||
|
|
||||||
|
journald_conf = files.put(
|
||||||
|
name="Configure journald",
|
||||||
|
src=importlib.resources.files(__package__).joinpath("journald.conf"),
|
||||||
|
dest="/etc/systemd/journald.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable journald",
|
||||||
|
service="systemd-journald.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=journald_conf,
|
||||||
|
)
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
from pyinfra.operations import apt, files, systemd, server
|
from pyinfra.operations import apt, files, systemd, server
|
||||||
|
from pyinfra import host
|
||||||
|
from pyinfra.facts.systemd import SystemdStatus
|
||||||
|
|
||||||
|
|
||||||
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
||||||
@@ -38,15 +40,30 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
email=email,
|
email=email,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
||||||
|
dest="/var/lib/acme/conf/target",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
service_file = files.put(
|
service_file = files.put(
|
||||||
src=importlib.resources.files(__package__)
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
.joinpath("acmetool-redirector.service")
|
"acmetool-redirector.service"
|
||||||
.open("rb"),
|
),
|
||||||
dest="/etc/systemd/system/acmetool-redirector.service",
|
dest="/etc/systemd/system/acmetool-redirector.service",
|
||||||
user="root",
|
user="root",
|
||||||
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",
|
||||||
service="acmetool-redirector.service",
|
service="acmetool-redirector.service",
|
||||||
@@ -55,8 +72,7 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
restarted=service_file.changed,
|
restarted=service_file.changed,
|
||||||
)
|
)
|
||||||
|
|
||||||
for domain in domains:
|
server.shell(
|
||||||
server.shell(
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
name=f"Request certificate for {domain}",
|
commands=[f"acmetool want { ' '.join(domains)}"],
|
||||||
commands=[f"acmetool want {domain}"],
|
)
|
||||||
)
|
|
||||||
7
cmdeploy/src/cmdeploy/acmetool/target.yaml.j2
Normal file
7
cmdeploy/src/cmdeploy/acmetool/target.yaml.j2
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
request:
|
||||||
|
provider: https://acme-v02.api.letsencrypt.org/directory
|
||||||
|
key:
|
||||||
|
type: rsa
|
||||||
|
challenge:
|
||||||
|
webroot-paths:
|
||||||
|
- /var/www/html/.well-known/acme-challenge
|
||||||
15
cmdeploy/src/cmdeploy/chatmail.zone.f
Normal file
15
cmdeploy/src/cmdeploy/chatmail.zone.f
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{chatmail_domain}. A {ipv4}
|
||||||
|
{chatmail_domain}. AAAA {ipv6}
|
||||||
|
{chatmail_domain}. MX 10 {chatmail_domain}.
|
||||||
|
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
||||||
|
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
||||||
|
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
||||||
|
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
||||||
|
{chatmail_domain}. CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
||||||
|
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
||||||
|
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
||||||
|
_mta-sts.{chatmail_domain}. TXT "v=STSv1; id={sts_id}"
|
||||||
|
mta-sts.{chatmail_domain}. CNAME {chatmail_domain}.
|
||||||
|
www.{chatmail_domain}. CNAME {chatmail_domain}.
|
||||||
|
{dkim_entry}
|
||||||
|
_adsp._domainkey.{chatmail_domain}. TXT "dkim=discardable"
|
||||||
316
cmdeploy/src/cmdeploy/cmdeploy.py
Normal file
316
cmdeploy/src/cmdeploy/cmdeploy.py
Normal file
@@ -0,0 +1,316 @@
|
|||||||
|
"""
|
||||||
|
Provides the `cmdeploy` entry point function,
|
||||||
|
along with command line option and subcommand parsing.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
import importlib.resources
|
||||||
|
import importlib.util
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
from termcolor import colored
|
||||||
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
from cmdeploy.dns import show_dns, check_necessary_dns
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# cmdeploy sub commands and options
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
def init_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"chatmail_domain",
|
||||||
|
action="store",
|
||||||
|
help="fully qualified DNS domain name for your chatmail instance",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def init_cmd(args, out):
|
||||||
|
"""Initialize chatmail config file."""
|
||||||
|
mail_domain = args.chatmail_domain
|
||||||
|
if args.inipath.exists():
|
||||||
|
print(f"Path exists, not modifying: {args.inipath}")
|
||||||
|
else:
|
||||||
|
write_initial_config(args.inipath, mail_domain)
|
||||||
|
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
||||||
|
check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--dry-run",
|
||||||
|
dest="dry_run",
|
||||||
|
action="store_true",
|
||||||
|
help="don't actually modify the server",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd(args, out):
|
||||||
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
mail_domain = args.config.mail_domain
|
||||||
|
if not check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
):
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
env = os.environ.copy()
|
||||||
|
env["CHATMAIL_INI"] = args.inipath
|
||||||
|
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
||||||
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
|
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path}"
|
||||||
|
|
||||||
|
out.check_call(cmd, env=env)
|
||||||
|
print("Deploy completed, call `cmdeploy dns` next.")
|
||||||
|
|
||||||
|
|
||||||
|
def dns_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--zonefile",
|
||||||
|
dest="zonefile",
|
||||||
|
help="print the whole zonefile for deploying directly",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dns_cmd(args, out):
|
||||||
|
"""Generate dns zone file."""
|
||||||
|
exit_code = show_dns(args, out)
|
||||||
|
exit(exit_code)
|
||||||
|
|
||||||
|
|
||||||
|
def status_cmd(args, out):
|
||||||
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
|
ssh = f"ssh root@{args.config.mail_domain}"
|
||||||
|
|
||||||
|
out.green(f"chatmail domain: {args.config.mail_domain}")
|
||||||
|
if args.config.privacy_mail:
|
||||||
|
out.green("privacy settings: present")
|
||||||
|
else:
|
||||||
|
out.red("no privacy settings")
|
||||||
|
|
||||||
|
s1 = "systemctl --type=service --state=running"
|
||||||
|
for line in out.shell_output(f"{ssh} -- {s1}").split("\n"):
|
||||||
|
if line.startswith(" "):
|
||||||
|
print(line)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--slow",
|
||||||
|
dest="slow",
|
||||||
|
action="store_true",
|
||||||
|
help="also run slow tests",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cmd(args, out):
|
||||||
|
"""Run local and online tests for chatmail deployment.
|
||||||
|
|
||||||
|
This will automatically pip-install 'deltachat' if it's not available.
|
||||||
|
"""
|
||||||
|
|
||||||
|
x = importlib.util.find_spec("deltachat")
|
||||||
|
if x is None:
|
||||||
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
|
pytest_path = shutil.which("pytest")
|
||||||
|
pytest_args = [
|
||||||
|
pytest_path,
|
||||||
|
"cmdeploy/src/",
|
||||||
|
"-n4",
|
||||||
|
"-rs",
|
||||||
|
"-x",
|
||||||
|
"-vrx",
|
||||||
|
"--durations=5",
|
||||||
|
]
|
||||||
|
if args.slow:
|
||||||
|
pytest_args.append("--slow")
|
||||||
|
ret = out.run_ret(pytest_args)
|
||||||
|
return ret
|
||||||
|
|
||||||
|
|
||||||
|
def fmt_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--verbose",
|
||||||
|
"-v",
|
||||||
|
dest="verbose",
|
||||||
|
action="store_true",
|
||||||
|
help="provide information on invocations",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--check",
|
||||||
|
"-c",
|
||||||
|
action="store_true",
|
||||||
|
help="only check but don't fix problems",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def fmt_cmd(args, out):
|
||||||
|
"""Run formattting fixes (ruff and black) on all chatmail source code."""
|
||||||
|
|
||||||
|
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
||||||
|
black_args = [shutil.which("black")]
|
||||||
|
ruff_args = [shutil.which("ruff")]
|
||||||
|
|
||||||
|
if args.check:
|
||||||
|
black_args.append("--check")
|
||||||
|
else:
|
||||||
|
ruff_args.append("--fix")
|
||||||
|
|
||||||
|
if not args.verbose:
|
||||||
|
black_args.append("-q")
|
||||||
|
ruff_args.append("-q")
|
||||||
|
|
||||||
|
black_args.extend(sources)
|
||||||
|
ruff_args.extend(sources)
|
||||||
|
|
||||||
|
out.check_call(" ".join(black_args), quiet=not args.verbose)
|
||||||
|
out.check_call(" ".join(ruff_args), quiet=not args.verbose)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def bench_cmd(args, out):
|
||||||
|
"""Run benchmarks against an online chatmail instance."""
|
||||||
|
args = ["pytest", "--pyargs", "cmdeploy.tests.online.benchmark", "-vrx"]
|
||||||
|
cmdstring = " ".join(args)
|
||||||
|
out.green(f"[$ {cmdstring}]")
|
||||||
|
subprocess.check_call(args)
|
||||||
|
|
||||||
|
|
||||||
|
def webdev_cmd(args, out):
|
||||||
|
"""Run local web development loop for static web pages."""
|
||||||
|
from .www import main
|
||||||
|
|
||||||
|
main()
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Parsing command line options and starting commands
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
class Out:
|
||||||
|
"""Convenience output printer providing coloring."""
|
||||||
|
|
||||||
|
def red(self, msg, file=sys.stderr):
|
||||||
|
print(colored(msg, "red"), file=file)
|
||||||
|
|
||||||
|
def green(self, msg, file=sys.stderr):
|
||||||
|
print(colored(msg, "green"), file=file)
|
||||||
|
|
||||||
|
def __call__(self, msg, red=False, green=False, file=sys.stdout):
|
||||||
|
color = "red" if red else ("green" if green else None)
|
||||||
|
print(colored(msg, color), file=file)
|
||||||
|
|
||||||
|
def shell_output(self, arg, no_print=False, timeout=10):
|
||||||
|
if not no_print:
|
||||||
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
|
output = subprocess.STDOUT
|
||||||
|
else:
|
||||||
|
output = subprocess.DEVNULL
|
||||||
|
return subprocess.check_output(
|
||||||
|
arg, shell=True, timeout=timeout, stderr=output
|
||||||
|
).decode()
|
||||||
|
|
||||||
|
def check_call(self, arg, env=None, quiet=False):
|
||||||
|
if not quiet:
|
||||||
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
|
return subprocess.check_call(arg, shell=True, env=env)
|
||||||
|
|
||||||
|
def run_ret(self, args, env=None, quiet=False):
|
||||||
|
if not quiet:
|
||||||
|
cmdstring = " ".join(args)
|
||||||
|
self(f"[$ {cmdstring}]", file=sys.stderr)
|
||||||
|
proc = subprocess.run(args, env=env)
|
||||||
|
return proc.returncode
|
||||||
|
|
||||||
|
|
||||||
|
def add_config_option(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--config",
|
||||||
|
dest="inipath",
|
||||||
|
action="store",
|
||||||
|
default=Path("chatmail.ini"),
|
||||||
|
type=Path,
|
||||||
|
help="path to the chatmail.ini file",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def add_subcommand(subparsers, func):
|
||||||
|
name = func.__name__
|
||||||
|
assert name.endswith("_cmd")
|
||||||
|
name = name[:-4]
|
||||||
|
doc = func.__doc__.strip()
|
||||||
|
help = doc.split("\n")[0].strip(".")
|
||||||
|
p = subparsers.add_parser(name, description=doc, help=help)
|
||||||
|
p.set_defaults(func=func)
|
||||||
|
add_config_option(p)
|
||||||
|
return p
|
||||||
|
|
||||||
|
|
||||||
|
description = """
|
||||||
|
Setup your chatmail server configuration and
|
||||||
|
deploy it via SSH to your remote location.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def get_parser():
|
||||||
|
"""Return an ArgumentParser for the 'cmdeploy' CLI"""
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser(description=description.strip())
|
||||||
|
subparsers = parser.add_subparsers(title="subcommands")
|
||||||
|
|
||||||
|
# find all subcommands in the module namespace
|
||||||
|
glob = globals()
|
||||||
|
for name, func in glob.items():
|
||||||
|
if name.endswith("_cmd"):
|
||||||
|
subparser = add_subcommand(subparsers, func)
|
||||||
|
addopts = glob.get(name + "_options")
|
||||||
|
if addopts is not None:
|
||||||
|
addopts(subparser)
|
||||||
|
|
||||||
|
return parser
|
||||||
|
|
||||||
|
|
||||||
|
def main(args=None):
|
||||||
|
"""Provide main entry point for 'xdcget' CLI invocation."""
|
||||||
|
parser = get_parser()
|
||||||
|
args = parser.parse_args(args=args)
|
||||||
|
if not hasattr(args, "func"):
|
||||||
|
return parser.parse_args(["-h"])
|
||||||
|
out = Out()
|
||||||
|
kwargs = {}
|
||||||
|
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
||||||
|
if not args.inipath.exists():
|
||||||
|
out.red(f"expecting {args.inipath} to exist, run init first?")
|
||||||
|
raise SystemExit(1)
|
||||||
|
try:
|
||||||
|
args.config = read_config(args.inipath)
|
||||||
|
except Exception as ex:
|
||||||
|
out.red(ex)
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
try:
|
||||||
|
res = args.func(args, out, **kwargs)
|
||||||
|
if res is None:
|
||||||
|
res = 0
|
||||||
|
return res
|
||||||
|
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
out.red("KeyboardInterrupt")
|
||||||
|
sys.exit(130)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
BIN
cmdeploy/src/cmdeploy/data/delta-chat-bw.png
Normal file
BIN
cmdeploy/src/cmdeploy/data/delta-chat-bw.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
cmdeploy/src/cmdeploy/data/opensans-regular.ttf
Normal file
BIN
cmdeploy/src/cmdeploy/data/opensans-regular.ttf
Normal file
Binary file not shown.
17
cmdeploy/src/cmdeploy/deploy.py
Normal file
17
cmdeploy/src/cmdeploy/deploy.py
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import os
|
||||||
|
import importlib.resources
|
||||||
|
import pyinfra
|
||||||
|
from cmdeploy import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
config_path = os.getenv(
|
||||||
|
"CHATMAIL_INI",
|
||||||
|
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
||||||
|
)
|
||||||
|
|
||||||
|
deploy_chatmail(config_path)
|
||||||
|
|
||||||
|
|
||||||
|
if pyinfra.is_cli:
|
||||||
|
main()
|
||||||
205
cmdeploy/src/cmdeploy/dns.py
Normal file
205
cmdeploy/src/cmdeploy/dns.py
Normal file
@@ -0,0 +1,205 @@
|
|||||||
|
import sys
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import importlib
|
||||||
|
import subprocess
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
|
|
||||||
|
class DNS:
|
||||||
|
def __init__(self, out, mail_domain):
|
||||||
|
self.session = requests.Session()
|
||||||
|
self.out = out
|
||||||
|
self.ssh = f"ssh root@{mail_domain} -- "
|
||||||
|
try:
|
||||||
|
self.shell(f"unbound-control flush_zone {mail_domain}")
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def shell(self, cmd):
|
||||||
|
try:
|
||||||
|
return self.out.shell_output(f"{self.ssh}{cmd}", no_print=True)
|
||||||
|
except (subprocess.CalledProcessError, subprocess.TimeoutExpired) as e:
|
||||||
|
if "exit status 255" in str(e) or "timed out" in str(e):
|
||||||
|
self.out.red(f"Error: can't reach the server with: {self.ssh[:-4]}")
|
||||||
|
sys.exit(1)
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
def get_ipv4(self):
|
||||||
|
cmd = "ip a | grep 'inet ' | grep 'scope global' | grep -oE '[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}' | head -1"
|
||||||
|
return self.shell(cmd).strip()
|
||||||
|
|
||||||
|
def get_ipv6(self):
|
||||||
|
cmd = "ip a | grep inet6 | grep 'scope global' | sed -e 's#/64 scope global##' | sed -e 's#inet6##'"
|
||||||
|
return self.shell(cmd).strip()
|
||||||
|
|
||||||
|
def get(self, typ: str, domain: str) -> str:
|
||||||
|
"""Get a DNS entry or empty string if there is none."""
|
||||||
|
dig_result = self.shell(f"dig -r -q {domain} -t {typ} +short")
|
||||||
|
line = dig_result.partition("\n")[0]
|
||||||
|
return line
|
||||||
|
|
||||||
|
def check_ptr_record(self, ip: str, mail_domain) -> bool:
|
||||||
|
"""Check the PTR record for an IPv4 or IPv6 address."""
|
||||||
|
result = self.shell(f"dig -r -x {ip} +short").rstrip()
|
||||||
|
return result == f"{mail_domain}."
|
||||||
|
|
||||||
|
|
||||||
|
def show_dns(args, out) -> int:
|
||||||
|
"""Check existing DNS records, optionally write them to zone file, return exit code 0 or 1."""
|
||||||
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
||||||
|
mail_domain = args.config.mail_domain
|
||||||
|
ssh = f"ssh root@{mail_domain}"
|
||||||
|
dns = DNS(out, mail_domain)
|
||||||
|
|
||||||
|
print("Checking your DKIM keys and DNS entries...")
|
||||||
|
try:
|
||||||
|
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
print("Please run `cmdeploy run` first.")
|
||||||
|
return 1
|
||||||
|
|
||||||
|
dkim_selector = "opendkim"
|
||||||
|
dkim_pubkey = out.shell_output(
|
||||||
|
ssh + f" -- openssl rsa -in /etc/dkimkeys/{dkim_selector}.private"
|
||||||
|
" -pubout 2>/dev/null | awk '/-/{next}{printf(\"%s\",$0)}'"
|
||||||
|
)
|
||||||
|
dkim_entry_value = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
||||||
|
dkim_entry_str = ""
|
||||||
|
while len(dkim_entry_value) >= 255:
|
||||||
|
dkim_entry_str += '"' + dkim_entry_value[:255] + '" '
|
||||||
|
dkim_entry_value = dkim_entry_value[255:]
|
||||||
|
dkim_entry_str += '"' + dkim_entry_value + '"'
|
||||||
|
dkim_entry = f"{dkim_selector}._domainkey.{mail_domain}. TXT {dkim_entry_str}"
|
||||||
|
|
||||||
|
ipv6 = dns.get_ipv6()
|
||||||
|
reverse_ipv6 = dns.check_ptr_record(ipv6, mail_domain)
|
||||||
|
ipv4 = dns.get_ipv4()
|
||||||
|
reverse_ipv4 = dns.check_ptr_record(ipv4, mail_domain)
|
||||||
|
to_print = []
|
||||||
|
|
||||||
|
with open(template, "r") as f:
|
||||||
|
zonefile = (
|
||||||
|
f.read()
|
||||||
|
.format(
|
||||||
|
acme_account_url=acme_account_url,
|
||||||
|
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
||||||
|
chatmail_domain=args.config.mail_domain,
|
||||||
|
dkim_entry=dkim_entry,
|
||||||
|
ipv6=ipv6,
|
||||||
|
ipv4=ipv4,
|
||||||
|
)
|
||||||
|
.strip()
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
with open(args.zonefile, "w+") as zf:
|
||||||
|
zf.write(zonefile)
|
||||||
|
print(f"DNS records successfully written to: {args.zonefile}")
|
||||||
|
return 0
|
||||||
|
except TypeError:
|
||||||
|
pass
|
||||||
|
for line in zonefile.splitlines():
|
||||||
|
line = line.format(
|
||||||
|
acme_account_url=acme_account_url,
|
||||||
|
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
||||||
|
chatmail_domain=args.config.mail_domain,
|
||||||
|
dkim_entry=dkim_entry,
|
||||||
|
ipv6=ipv6,
|
||||||
|
).strip()
|
||||||
|
for typ in ["A", "AAAA", "CNAME", "CAA"]:
|
||||||
|
if f" {typ} " in line:
|
||||||
|
domain, value = line.split(f" {typ} ")
|
||||||
|
current = dns.get(typ, domain.strip()[:-1])
|
||||||
|
if current != value.strip():
|
||||||
|
to_print.append(line)
|
||||||
|
if " MX " in line:
|
||||||
|
domain, typ, prio, value = line.split()
|
||||||
|
current = dns.get(typ, domain[:-1])
|
||||||
|
if not current:
|
||||||
|
to_print.append(line)
|
||||||
|
elif current.split()[1] != value:
|
||||||
|
print(line.replace(prio, str(int(current[0]) + 1)))
|
||||||
|
if " SRV " in line:
|
||||||
|
domain, typ, prio, weight, port, value = line.split()
|
||||||
|
current = dns.get("SRV", domain[:-1])
|
||||||
|
if current != f"{prio} {weight} {port} {value}":
|
||||||
|
to_print.append(line)
|
||||||
|
if " TXT " in line:
|
||||||
|
domain, value = line.split(" TXT ")
|
||||||
|
current = dns.get("TXT", domain.strip()[:-1])
|
||||||
|
if domain.startswith("_mta-sts."):
|
||||||
|
if current:
|
||||||
|
if current.split("id=")[0] == value.split("id=")[0]:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# TXT records longer than 255 bytes
|
||||||
|
# are split into multiple <character-string>s.
|
||||||
|
# This typically happens with DKIM record
|
||||||
|
# which contains long RSA key.
|
||||||
|
#
|
||||||
|
# Removing `" "` before comparison
|
||||||
|
# to get back a single string.
|
||||||
|
if current.replace('" "', "") != value.replace('" "', ""):
|
||||||
|
to_print.append(line)
|
||||||
|
|
||||||
|
exit_code = 0
|
||||||
|
if to_print:
|
||||||
|
to_print.insert(
|
||||||
|
0, "You should configure the following DNS entries at your provider:\n"
|
||||||
|
)
|
||||||
|
to_print.append(
|
||||||
|
"\nIf you already configured the DNS entries, wait a bit until the DNS entries propagate to the Internet."
|
||||||
|
)
|
||||||
|
print("\n".join(to_print))
|
||||||
|
exit_code = 1
|
||||||
|
else:
|
||||||
|
out.green("Great! All your DNS entries are correct.")
|
||||||
|
|
||||||
|
to_print = []
|
||||||
|
if not reverse_ipv4:
|
||||||
|
to_print.append(f"\tIPv4:\t{ipv4}\t{args.config.mail_domain}")
|
||||||
|
if not reverse_ipv6:
|
||||||
|
to_print.append(f"\tIPv6:\t{ipv6}\t{args.config.mail_domain}")
|
||||||
|
if len(to_print) > 0:
|
||||||
|
if len(to_print) == 1:
|
||||||
|
warning = "You should add the following PTR/reverse DNS entry:"
|
||||||
|
else:
|
||||||
|
warning = "You should add the following PTR/reverse DNS entries:"
|
||||||
|
out.red(warning)
|
||||||
|
for entry in to_print:
|
||||||
|
print(entry)
|
||||||
|
print(
|
||||||
|
"You can do so at your hosting provider (maybe this isn't your DNS provider)."
|
||||||
|
)
|
||||||
|
exit_code = 1
|
||||||
|
return exit_code
|
||||||
|
|
||||||
|
|
||||||
|
def check_necessary_dns(out, mail_domain):
|
||||||
|
"""Check whether $mail_domain and mta-sts.$mail_domain resolve."""
|
||||||
|
dns = DNS(out, mail_domain)
|
||||||
|
ipv4 = dns.get("A", mail_domain)
|
||||||
|
ipv6 = dns.get("AAAA", mail_domain)
|
||||||
|
mta_entry = dns.get("CNAME", "mta-sts." + mail_domain)
|
||||||
|
www_entry = dns.get("CNAME", "www." + mail_domain)
|
||||||
|
to_print = []
|
||||||
|
if not (ipv4 or ipv6):
|
||||||
|
to_print.append(f"\t{mail_domain}.\t\t\tA<your server's IPv4 address>")
|
||||||
|
if mta_entry != mail_domain + ".":
|
||||||
|
to_print.append(f"\tmta-sts.{mail_domain}.\tCNAME\t{mail_domain}.")
|
||||||
|
if www_entry != mail_domain + ".":
|
||||||
|
to_print.append(f"\twww.{mail_domain}.\tCNAME\t{mail_domain}.")
|
||||||
|
if to_print:
|
||||||
|
to_print.insert(
|
||||||
|
0,
|
||||||
|
"\nFor chatmail to work, you need to configure this at your DNS provider:\n",
|
||||||
|
)
|
||||||
|
for line in to_print:
|
||||||
|
print(line)
|
||||||
|
print()
|
||||||
|
else:
|
||||||
|
dns.out.green("\nAll necessary DNS entries seem to be set.")
|
||||||
|
return True
|
||||||
10
cmdeploy/src/cmdeploy/dovecot/auth.conf
Normal file
10
cmdeploy/src/cmdeploy/dovecot/auth.conf
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
uri = proxy:/run/dovecot/doveauth.socket:auth
|
||||||
|
iterate_disable = yes
|
||||||
|
default_pass_scheme = plain
|
||||||
|
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
||||||
|
# See <https://doc.dovecot.org/configuration_manual/config_file/config_variables/#modifiers>
|
||||||
|
# for documentation.
|
||||||
|
#
|
||||||
|
# We escape user-provided input and use double quote as a separator.
|
||||||
|
password_key = passdb/%Ew"%Eu
|
||||||
|
user_key = userdb/%Eu
|
||||||
@@ -4,13 +4,25 @@ protocols = imap lmtp
|
|||||||
|
|
||||||
auth_mechanisms = plain
|
auth_mechanisms = plain
|
||||||
|
|
||||||
|
{% if debug == true %}
|
||||||
auth_verbose = yes
|
auth_verbose = yes
|
||||||
auth_debug = yes
|
auth_debug = yes
|
||||||
auth_debug_passwords = yes
|
auth_debug_passwords = yes
|
||||||
auth_verbose_passwords = plain
|
auth_verbose_passwords = plain
|
||||||
auth_cache_size = 100M
|
auth_cache_size = 100M
|
||||||
mail_plugins = quota
|
|
||||||
mail_debug = yes
|
mail_debug = yes
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
mail_server_admin = mailto:root@{{ config.mail_domain }}
|
||||||
|
mail_server_comment = Chatmail server
|
||||||
|
|
||||||
|
mail_plugins = quota
|
||||||
|
|
||||||
|
# these are the capabilities Delta Chat cares about actually
|
||||||
|
# so let's keep the network overhead per login small
|
||||||
|
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
||||||
|
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY METADATA
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
# Authentication for system users.
|
||||||
passdb {
|
passdb {
|
||||||
@@ -63,6 +75,7 @@ mail_privileged_group = vmail
|
|||||||
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
||||||
protocol imap {
|
protocol imap {
|
||||||
mail_plugins = $mail_plugins imap_zlib imap_quota
|
mail_plugins = $mail_plugins imap_zlib imap_quota
|
||||||
|
imap_metadata = yes
|
||||||
}
|
}
|
||||||
|
|
||||||
protocol lmtp {
|
protocol lmtp {
|
||||||
@@ -76,7 +89,7 @@ plugin {
|
|||||||
plugin {
|
plugin {
|
||||||
# for now we define static quota-rules for all users
|
# for now we define static quota-rules for all users
|
||||||
quota = maildir:User quota
|
quota = maildir:User quota
|
||||||
quota_rule = *:storage=100M
|
quota_rule = *:storage={{ config.max_mailbox_size }}
|
||||||
quota_max_mail_size=30M
|
quota_max_mail_size=30M
|
||||||
quota_grace = 0
|
quota_grace = 0
|
||||||
# quota_over_flag_value = TRUE
|
# quota_over_flag_value = TRUE
|
||||||
@@ -108,9 +121,27 @@ service auth-worker {
|
|||||||
user = vmail
|
user = vmail
|
||||||
}
|
}
|
||||||
|
|
||||||
|
service imap-login {
|
||||||
|
# High-security mode.
|
||||||
|
# Each process serves a single connection and exits afterwards.
|
||||||
|
# This is the default, but we set it explicitly to be sure.
|
||||||
|
# See <https://doc.dovecot.org/admin_manual/login_processes/#high-security-mode> for details.
|
||||||
|
service_count = 1
|
||||||
|
|
||||||
|
# Inrease the number of simultaneous connections.
|
||||||
|
#
|
||||||
|
# As of Dovecot 2.3.19.1 the default is 100 processes.
|
||||||
|
# Combined with `service_count = 1` it means only 100 connections
|
||||||
|
# can be handled simultaneously.
|
||||||
|
process_limit = 10000
|
||||||
|
|
||||||
|
# Avoid startup latency for new connections.
|
||||||
|
process_min_avail = 10
|
||||||
|
}
|
||||||
|
|
||||||
ssl = required
|
ssl = required
|
||||||
ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain
|
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
ssl_key = </var/lib/acme/live/{{ config.hostname }}/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.2
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
10
cmdeploy/src/cmdeploy/dovecot/expunge.cron.j2
Normal file
10
cmdeploy/src/cmdeploy/dovecot/expunge.cron.j2
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
||||||
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# or in any IMAP subfolder
|
||||||
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/.*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# even if they are unseen
|
||||||
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/.*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# or only temporary (but then they shouldn't be around after {{ config.delete_mails_after }} days anyway).
|
||||||
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/.*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
87
cmdeploy/src/cmdeploy/genqr.py
Normal file
87
cmdeploy/src/cmdeploy/genqr.py
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
import importlib
|
||||||
|
import qrcode
|
||||||
|
import os
|
||||||
|
from PIL import ImageFont, ImageDraw, Image
|
||||||
|
import io
|
||||||
|
|
||||||
|
|
||||||
|
def gen_qr_png_data(maildomain):
|
||||||
|
url = f"DCACCOUNT:https://{maildomain}/new"
|
||||||
|
image = gen_qr(maildomain, url)
|
||||||
|
temp = io.BytesIO()
|
||||||
|
image.save(temp, format="png")
|
||||||
|
temp.seek(0)
|
||||||
|
return temp
|
||||||
|
|
||||||
|
|
||||||
|
def gen_qr(maildomain, url):
|
||||||
|
# taken and modified from
|
||||||
|
# https://github.com/deltachat/mailadm/blob/master/src/mailadm/gen_qr.py
|
||||||
|
|
||||||
|
# info = f"{maildomain} invite code"
|
||||||
|
info = ""
|
||||||
|
|
||||||
|
# load QR code
|
||||||
|
qr = qrcode.QRCode(
|
||||||
|
version=1,
|
||||||
|
error_correction=qrcode.constants.ERROR_CORRECT_H,
|
||||||
|
box_size=1,
|
||||||
|
border=1,
|
||||||
|
)
|
||||||
|
qr.add_data(url)
|
||||||
|
qr.make(fit=True)
|
||||||
|
qr_img = qr.make_image(fill_color="black", back_color="white")
|
||||||
|
|
||||||
|
# paint all elements
|
||||||
|
ttf_path = str(
|
||||||
|
importlib.resources.files(__package__).joinpath("data/opensans-regular.ttf")
|
||||||
|
)
|
||||||
|
logo_red_path = str(
|
||||||
|
importlib.resources.files(__package__).joinpath("data/delta-chat-bw.png")
|
||||||
|
)
|
||||||
|
|
||||||
|
assert os.path.exists(ttf_path), ttf_path
|
||||||
|
font_size = 16
|
||||||
|
font = ImageFont.truetype(font=ttf_path, size=font_size)
|
||||||
|
|
||||||
|
num_lines = ((info).count("\n") + 1) if info else 0
|
||||||
|
|
||||||
|
size = width = 384
|
||||||
|
qr_padding = 6
|
||||||
|
text_height = font_size * num_lines
|
||||||
|
height = size + text_height
|
||||||
|
|
||||||
|
image = Image.new("RGBA", (width, height), "white")
|
||||||
|
qr_final_size = width - (qr_padding * 2)
|
||||||
|
|
||||||
|
if num_lines:
|
||||||
|
draw = ImageDraw.Draw(image)
|
||||||
|
|
||||||
|
# draw text
|
||||||
|
if hasattr(font, "getsize"):
|
||||||
|
info_pos = (width - font.getsize(info.strip())[0]) // 2
|
||||||
|
else:
|
||||||
|
info_pos = (width - font.getbbox(info.strip())[3]) // 2
|
||||||
|
|
||||||
|
draw.multiline_text(
|
||||||
|
(info_pos, size - qr_padding // 2),
|
||||||
|
info,
|
||||||
|
font=font,
|
||||||
|
fill="black",
|
||||||
|
align="right",
|
||||||
|
)
|
||||||
|
|
||||||
|
# paste QR code
|
||||||
|
image.paste(
|
||||||
|
qr_img.resize((qr_final_size, qr_final_size), resample=Image.NEAREST),
|
||||||
|
(qr_padding, qr_padding),
|
||||||
|
)
|
||||||
|
|
||||||
|
# background delta logo
|
||||||
|
logo2_img = Image.open(logo_red_path)
|
||||||
|
logo2_width = int(size / 6)
|
||||||
|
logo2 = logo2_img.resize((logo2_width, logo2_width), resample=Image.NEAREST)
|
||||||
|
pos = int((size / 2) - (logo2_width / 2))
|
||||||
|
image.paste(logo2, (pos, pos), mask=logo2)
|
||||||
|
|
||||||
|
return image
|
||||||
2
cmdeploy/src/cmdeploy/journald.conf
Normal file
2
cmdeploy/src/cmdeploy/journald.conf
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[Journal]
|
||||||
|
MaxRetentionSec=3d
|
||||||
1
cmdeploy/src/cmdeploy/metrics.cron.j2
Normal file
1
cmdeploy/src/cmdeploy/metrics.cron.j2
Normal file
@@ -0,0 +1 @@
|
|||||||
|
*/5 * * * * root {{ config.execpath }} /home/vmail/mail/{{ config.mail_domain }} >/var/www/html/metrics
|
||||||
37
cmdeploy/src/cmdeploy/nginx/autoconfig.xml.j2
Normal file
37
cmdeploy/src/cmdeploy/nginx/autoconfig.xml.j2
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<clientConfig version="1.1">
|
||||||
|
<emailProvider id="{{ config.domain_name }}">
|
||||||
|
<domain>{{ config.domain_name }}</domain>
|
||||||
|
<displayName>{{ config.domain_name }} chatmail</displayName>
|
||||||
|
<displayShortName>{{ config.domain_name }}</displayShortName>
|
||||||
|
<incomingServer type="imap">
|
||||||
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
|
<port>993</port>
|
||||||
|
<socketType>SSL</socketType>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
</incomingServer>
|
||||||
|
<incomingServer type="imap">
|
||||||
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
|
<port>143</port>
|
||||||
|
<socketType>STARTTLS</socketType>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
</incomingServer>
|
||||||
|
<outgoingServer type="smtp">
|
||||||
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
|
<port>465</port>
|
||||||
|
<socketType>SSL</socketType>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
</outgoingServer>
|
||||||
|
<outgoingServer type="smtp">
|
||||||
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
|
<port>587</port>
|
||||||
|
<socketType>STARTTLS</socketType>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
</outgoingServer>
|
||||||
|
</emailProvider>
|
||||||
|
</clientConfig>
|
||||||
4
cmdeploy/src/cmdeploy/nginx/mta-sts.txt.j2
Normal file
4
cmdeploy/src/cmdeploy/nginx/mta-sts.txt.j2
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
version: STSv1
|
||||||
|
mode: enforce
|
||||||
|
mx: {{ config.domain_name }}
|
||||||
|
max_age: 2419200
|
||||||
84
cmdeploy/src/cmdeploy/nginx/nginx.conf.j2
Normal file
84
cmdeploy/src/cmdeploy/nginx/nginx.conf.j2
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
user www-data;
|
||||||
|
worker_processes auto;
|
||||||
|
pid /run/nginx.pid;
|
||||||
|
error_log /var/log/nginx/error.log;
|
||||||
|
|
||||||
|
events {
|
||||||
|
worker_connections 768;
|
||||||
|
# multi_accept on;
|
||||||
|
}
|
||||||
|
|
||||||
|
http {
|
||||||
|
sendfile on;
|
||||||
|
tcp_nopush on;
|
||||||
|
|
||||||
|
# Do not emit nginx version on error pages.
|
||||||
|
server_tokens off;
|
||||||
|
|
||||||
|
include /etc/nginx/mime.types;
|
||||||
|
default_type application/octet-stream;
|
||||||
|
|
||||||
|
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
||||||
|
ssl_prefer_server_ciphers on;
|
||||||
|
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
||||||
|
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
||||||
|
|
||||||
|
gzip on;
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl default_server;
|
||||||
|
listen [::]:443 ssl default_server;
|
||||||
|
|
||||||
|
root /var/www/html;
|
||||||
|
|
||||||
|
index index.html index.htm;
|
||||||
|
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
# First attempt to serve request as file, then
|
||||||
|
# as directory, then fall back to displaying a 404.
|
||||||
|
try_files $uri $uri/ =404;
|
||||||
|
}
|
||||||
|
|
||||||
|
location /metrics {
|
||||||
|
default_type text/plain;
|
||||||
|
}
|
||||||
|
|
||||||
|
location /new {
|
||||||
|
if ($request_method = GET) {
|
||||||
|
# Redirect to Delta Chat,
|
||||||
|
# which will in turn do a POST request.
|
||||||
|
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
||||||
|
}
|
||||||
|
|
||||||
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
|
include /etc/nginx/fastcgi_params;
|
||||||
|
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
||||||
|
}
|
||||||
|
|
||||||
|
# Old URL for compatibility with e.g. printed QR codes.
|
||||||
|
#
|
||||||
|
# Copy-paste instead of redirect to /new
|
||||||
|
# because Delta Chat core does not follow redirects.
|
||||||
|
#
|
||||||
|
# Redirects are only for browsers.
|
||||||
|
location /cgi-bin/newemail.py {
|
||||||
|
if ($request_method = GET) {
|
||||||
|
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
||||||
|
}
|
||||||
|
|
||||||
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
|
include /etc/nginx/fastcgi_params;
|
||||||
|
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Redirect www. to non-www
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name www.{{ config.domain_name }};
|
||||||
|
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
||||||
|
}
|
||||||
|
}
|
||||||
1
cmdeploy/src/cmdeploy/opendkim/KeyTable
Normal file
1
cmdeploy/src/cmdeploy/opendkim/KeyTable
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{{ config.opendkim_selector }}._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/{{ config.opendkim_selector }}.private
|
||||||
1
cmdeploy/src/cmdeploy/opendkim/SigningTable
Normal file
1
cmdeploy/src/cmdeploy/opendkim/SigningTable
Normal file
@@ -0,0 +1 @@
|
|||||||
|
*@{{ config.domain_name }} {{ config.opendkim_selector }}._domainkey.{{ config.domain_name }}
|
||||||
28
cmdeploy/src/cmdeploy/opendkim/final.lua
Normal file
28
cmdeploy/src/cmdeploy/opendkim/final.lua
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
if odkim.internal_ip(ctx) == 1 then
|
||||||
|
-- Outgoing message will be signed,
|
||||||
|
-- no need to look for signatures.
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
nsigs = odkim.get_sigcount(ctx)
|
||||||
|
if nsigs == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
for i = 1, nsigs do
|
||||||
|
sig = odkim.get_sighandle(ctx, i - 1)
|
||||||
|
sigres = odkim.sig_result(sig)
|
||||||
|
|
||||||
|
-- All signatures that do not correspond to From:
|
||||||
|
-- were ignored in screen.lua and return sigres -1.
|
||||||
|
--
|
||||||
|
-- Any valid signature that was not ignored like this
|
||||||
|
-- means the message is acceptable.
|
||||||
|
if sigres == 0 then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
odkim.set_reply(ctx, "554", "5.7.1", "No valid DKIM signature found")
|
||||||
|
odkim.set_result(ctx, SMFIS_REJECT)
|
||||||
|
return nil
|
||||||
@@ -1,7 +1,4 @@
|
|||||||
# This is a basic configuration for signing and verifying. It can easily be
|
# OpenDKIM configuration.
|
||||||
# adapted to suit a basic installation. See opendkim.conf(5) and
|
|
||||||
# /usr/share/doc/opendkim/examples/opendkim.conf.sample for complete
|
|
||||||
# documentation of available configuration parameters.
|
|
||||||
|
|
||||||
Syslog yes
|
Syslog yes
|
||||||
SyslogSuccess yes
|
SyslogSuccess yes
|
||||||
@@ -11,17 +8,30 @@ SyslogSuccess yes
|
|||||||
# oversigned, because it is often the identity key used by reputation systems
|
# oversigned, because it is often the identity key used by reputation systems
|
||||||
# and thus somewhat security sensitive.
|
# and thus somewhat security sensitive.
|
||||||
Canonicalization relaxed/simple
|
Canonicalization relaxed/simple
|
||||||
#Mode sv
|
|
||||||
#SubDomains no
|
|
||||||
OversignHeaders From
|
OversignHeaders From
|
||||||
|
|
||||||
|
On-BadSignature reject
|
||||||
|
On-KeyNotFound reject
|
||||||
|
On-NoSignature reject
|
||||||
|
|
||||||
# Signing domain, selector, and key (required). For example, perform signing
|
# Signing domain, selector, and key (required). For example, perform signing
|
||||||
# for domain "example.com" with selector "2020" (2020._domainkey.example.com),
|
# for domain "example.com" with selector "2020" (2020._domainkey.example.com),
|
||||||
# using the private key stored in /etc/dkimkeys/example.private. More granular
|
# using the private key stored in /etc/dkimkeys/example.private. More granular
|
||||||
# setup options can be found in /usr/share/doc/opendkim/README.opendkim.
|
# setup options can be found in /usr/share/doc/opendkim/README.opendkim.
|
||||||
Domain {{ config.domain_name }}
|
Domain {{ config.domain_name }}
|
||||||
Selector {{ config.opendkim_selector }}
|
Selector {{ config.opendkim_selector }}
|
||||||
KeyFile /etc/dkimkeys/{{ config.opendkim_selector }}.private
|
KeyFile /etc/dkimkeys/{{ config.opendkim_selector }}.private
|
||||||
|
KeyTable /etc/dkimkeys/KeyTable
|
||||||
|
SigningTable refile:/etc/dkimkeys/SigningTable
|
||||||
|
|
||||||
|
# Sign Autocrypt header in addition to the default specified in RFC 6376.
|
||||||
|
SignHeaders *,+autocrypt
|
||||||
|
|
||||||
|
# Script to ignore signatures that do not correspond to the From: domain.
|
||||||
|
ScreenPolicyScript /etc/opendkim/screen.lua
|
||||||
|
|
||||||
|
# Script to reject mails without a valid DKIM signature.
|
||||||
|
FinalPolicyScript /etc/opendkim/final.lua
|
||||||
|
|
||||||
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
||||||
# using a local socket with MTAs that access the socket as a non-privileged
|
# using a local socket with MTAs that access the socket as a non-privileged
|
||||||
@@ -30,22 +40,10 @@ KeyFile /etc/dkimkeys/{{ config.opendkim_selector }}.private
|
|||||||
UserID opendkim
|
UserID opendkim
|
||||||
UMask 007
|
UMask 007
|
||||||
|
|
||||||
# Socket for the MTA connection (required). If the MTA is inside a chroot jail,
|
|
||||||
# it must be ensured that the socket is accessible. In Debian, Postfix runs in
|
|
||||||
# a chroot in /var/spool/postfix, therefore a Unix socket would have to be
|
|
||||||
# configured as shown on the last line below.
|
|
||||||
#Socket local:/run/opendkim/opendkim.sock
|
|
||||||
#Socket inet:8891@localhost
|
|
||||||
#Socket inet:8891
|
|
||||||
Socket local:/var/spool/postfix/opendkim/opendkim.sock
|
Socket local:/var/spool/postfix/opendkim/opendkim.sock
|
||||||
|
|
||||||
PidFile /run/opendkim/opendkim.pid
|
PidFile /run/opendkim/opendkim.pid
|
||||||
|
|
||||||
# Hosts for which to sign rather than verify, default is 127.0.0.1. See the
|
|
||||||
# OPERATION section of opendkim(8) for more information.
|
|
||||||
#InternalHosts 192.168.0.0/16, 10.0.0.0/8, 172.16.0.0/12
|
|
||||||
|
|
||||||
# The trust anchor enables DNSSEC. In Debian, the trust anchor file is provided
|
# The trust anchor enables DNSSEC. In Debian, the trust anchor file is provided
|
||||||
# by the package dns-root-data.
|
# by the package dns-root-data.
|
||||||
TrustAnchorFile /usr/share/dns/root.key
|
TrustAnchorFile /usr/share/dns/root.key
|
||||||
#Nameservers 127.0.0.1
|
|
||||||
21
cmdeploy/src/cmdeploy/opendkim/screen.lua
Normal file
21
cmdeploy/src/cmdeploy/opendkim/screen.lua
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
-- Ignore signatures that do not correspond to the From: domain.
|
||||||
|
|
||||||
|
from_domain = odkim.get_fromdomain(ctx)
|
||||||
|
if from_domain == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
n = odkim.get_sigcount(ctx)
|
||||||
|
if n == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
for i = 1, n do
|
||||||
|
sig = odkim.get_sighandle(ctx, i - 1)
|
||||||
|
sig_domain = odkim.sig_getdomain(sig)
|
||||||
|
if from_domain ~= sig_domain then
|
||||||
|
odkim.sig_ignore(sig)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return nil
|
||||||
1
cmdeploy/src/cmdeploy/postfix/login_map
Normal file
1
cmdeploy/src/cmdeploy/postfix/login_map
Normal file
@@ -0,0 +1 @@
|
|||||||
|
/^(.*)$/ ${1}
|
||||||
79
cmdeploy/src/cmdeploy/postfix/main.cf.j2
Normal file
79
cmdeploy/src/cmdeploy/postfix/main.cf.j2
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
myorigin = {{ config.mail_domain }}
|
||||||
|
|
||||||
|
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
||||||
|
biff = no
|
||||||
|
|
||||||
|
# appending .domain is the MUA's job.
|
||||||
|
append_dot_mydomain = no
|
||||||
|
|
||||||
|
# Uncomment the next line to generate "delayed mail" warnings
|
||||||
|
#delay_warning_time = 4h
|
||||||
|
|
||||||
|
readme_directory = no
|
||||||
|
|
||||||
|
# See http://www.postfix.org/COMPATIBILITY_README.html
|
||||||
|
compatibility_level = 3.6
|
||||||
|
|
||||||
|
# TLS parameters
|
||||||
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
|
smtp_tls_security_level=may
|
||||||
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
|
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
||||||
|
smtpd_tls_protocols = >=TLSv1.2
|
||||||
|
|
||||||
|
# Disable anonymous cipher suites
|
||||||
|
# and known insecure algorithms.
|
||||||
|
#
|
||||||
|
# Disabling anonymous ciphers
|
||||||
|
# does not generally improve security
|
||||||
|
# because clients that want to verify certificate
|
||||||
|
# will not select them anyway,
|
||||||
|
# but makes cipher suite list shorter and security scanners happy.
|
||||||
|
# See <https://www.postfix.org/TLS_README.html> for discussion.
|
||||||
|
#
|
||||||
|
# Only ancient insecure ciphers should be disabled here
|
||||||
|
# as MTA clients that do not support more secure cipher
|
||||||
|
# likely do not support MTA-STS either and will
|
||||||
|
# otherwise fall back to using plaintext connection.
|
||||||
|
smtpd_tls_exclude_ciphers = aNULL, RC4, MD5, DES
|
||||||
|
|
||||||
|
# Override client's preference order.
|
||||||
|
# <https://www.postfix.org/postconf.5.html#tls_preempt_cipherlist>
|
||||||
|
#
|
||||||
|
# This is mostly to ensure cipher suites with forward secrecy
|
||||||
|
# are preferred over non cipher suites without forward secrecy.
|
||||||
|
# See <https://www.postfix.org/FORWARD_SECRECY_README.html#server_fs>.
|
||||||
|
tls_preempt_cipherlist = yes
|
||||||
|
|
||||||
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
|
myhostname = {{ config.mail_domain }}
|
||||||
|
alias_maps = hash:/etc/aliases
|
||||||
|
alias_database = hash:/etc/aliases
|
||||||
|
|
||||||
|
# Postfix does not deliver mail for any domain by itself.
|
||||||
|
# Primary domain is listed in `virtual_mailbox_domains` instead
|
||||||
|
# and handed over to Dovecot.
|
||||||
|
mydestination =
|
||||||
|
|
||||||
|
relayhost =
|
||||||
|
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
||||||
|
mailbox_size_limit = 0
|
||||||
|
# maximum 30MB sized messages
|
||||||
|
message_size_limit = 31457280
|
||||||
|
recipient_delimiter = +
|
||||||
|
inet_interfaces = all
|
||||||
|
inet_protocols = all
|
||||||
|
|
||||||
|
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
|
virtual_mailbox_domains = {{ config.mail_domain }}
|
||||||
|
|
||||||
|
mua_client_restrictions = permit_sasl_authenticated, reject
|
||||||
|
mua_sender_restrictions = reject_sender_login_mismatch, permit_sasl_authenticated, reject
|
||||||
|
mua_helo_restrictions = permit_mynetworks, reject_invalid_helo_hostname, reject_non_fqdn_helo_hostname, permit
|
||||||
|
|
||||||
|
# 1:1 map MAIL FROM to SASL login name.
|
||||||
|
smtpd_sender_login_maps = regexp:/etc/postfix/login_map
|
||||||
@@ -9,11 +9,12 @@
|
|||||||
# service type private unpriv chroot wakeup maxproc command + args
|
# service type private unpriv chroot wakeup maxproc command + args
|
||||||
# (yes) (yes) (no) (never) (100)
|
# (yes) (yes) (no) (never) (100)
|
||||||
# ==========================================================================
|
# ==========================================================================
|
||||||
smtp inet n - y - - smtpd -v
|
{% if debug == true %}
|
||||||
#smtp inet n - y - 1 postscreen
|
smtp inet n - y - - smtpd -v
|
||||||
#smtpd pass - - y - - smtpd
|
{%- else %}
|
||||||
#dnsblog unix - - y - 0 dnsblog
|
smtp inet n - y - - smtpd
|
||||||
#tlsproxy unix - - y - 0 tlsproxy
|
{%- endif %}
|
||||||
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
submission inet n - y - - smtpd
|
submission inet n - y - - smtpd
|
||||||
-o syslog_name=postfix/submission
|
-o syslog_name=postfix/submission
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
@@ -28,7 +29,9 @@ submission inet n - y - - smtpd
|
|||||||
-o smtpd_recipient_restrictions=
|
-o smtpd_recipient_restrictions=
|
||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o content_filter=filter:unix:private/filtermail
|
-o smtpd_client_connection_count_limit=1000
|
||||||
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
smtps inet n - y - - smtpd
|
smtps inet n - y - - smtpd
|
||||||
-o syslog_name=postfix/smtps
|
-o syslog_name=postfix/smtps
|
||||||
-o smtpd_tls_wrappermode=yes
|
-o smtpd_tls_wrappermode=yes
|
||||||
@@ -42,8 +45,10 @@ smtps inet n - y - - smtpd
|
|||||||
-o smtpd_sender_restrictions=$mua_sender_restrictions
|
-o smtpd_sender_restrictions=$mua_sender_restrictions
|
||||||
-o smtpd_recipient_restrictions=
|
-o smtpd_recipient_restrictions=
|
||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o content_filter=filter:unix:private/filtermail
|
-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
|
||||||
@@ -66,13 +71,22 @@ showq unix n - y - - showq
|
|||||||
error unix - - y - - error
|
error unix - - y - - error
|
||||||
retry unix - - y - - error
|
retry unix - - y - - error
|
||||||
discard unix - - y - - discard
|
discard unix - - y - - discard
|
||||||
local unix - n n - - local
|
|
||||||
virtual unix - n n - - virtual
|
|
||||||
lmtp unix - - y - - lmtp
|
lmtp unix - - y - - lmtp
|
||||||
anvil unix - - y - 1 anvil
|
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 filered mail.
|
||||||
localhost:10026 inet n - n - 10 smtpd
|
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
||||||
-o content_filter=
|
-o syslog_name=postfix/reinject
|
||||||
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
|
|
||||||
|
# Cleanup `Received` headers for authenticated mail
|
||||||
|
# to avoid leaking client IP.
|
||||||
|
#
|
||||||
|
# We do not do this for received mails
|
||||||
|
# as this will break DKIM signatures
|
||||||
|
# if `Received` header is signed.
|
||||||
|
authclean unix n - - - 0 cleanup
|
||||||
|
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
||||||
10
cmdeploy/src/cmdeploy/postfix/mta-sts-daemon.service
Normal file
10
cmdeploy/src/cmdeploy/postfix/mta-sts-daemon.service
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Postfix MTA-STS resolver daemon
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart=/usr/local/lib/postfix-mta-sts-resolver/bin/mta-sts-daemon
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
13
cmdeploy/src/cmdeploy/postfix/mta-sts-daemon.yml
Normal file
13
cmdeploy/src/cmdeploy/postfix/mta-sts-daemon.yml
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
host: 127.0.0.1
|
||||||
|
port: 8461
|
||||||
|
reuse_port: true
|
||||||
|
shutdown_timeout: 20
|
||||||
|
cache:
|
||||||
|
type: internal
|
||||||
|
options:
|
||||||
|
cache_size: 10000
|
||||||
|
proactive_policy_fetching:
|
||||||
|
enabled: true
|
||||||
|
default_zone:
|
||||||
|
strict_testing: false
|
||||||
|
timeout: 4
|
||||||
4
cmdeploy/src/cmdeploy/postfix/submission_header_cleanup
Normal file
4
cmdeploy/src/cmdeploy/postfix/submission_header_cleanup
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
/^Received:/ IGNORE
|
||||||
|
/^X-Originating-IP:/ IGNORE
|
||||||
|
/^X-Mailer:/ IGNORE
|
||||||
|
/^User-Agent:/ IGNORE
|
||||||
0
cmdeploy/src/cmdeploy/tests/__init__.py
Normal file
0
cmdeploy/src/cmdeploy/tests/__init__.py
Normal file
0
cmdeploy/src/cmdeploy/tests/online/__init__.py
Normal file
0
cmdeploy/src/cmdeploy/tests/online/__init__.py
Normal file
60
cmdeploy/src/cmdeploy/tests/online/benchmark.py
Normal file
60
cmdeploy/src/cmdeploy/tests/online/benchmark.py
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
def test_tls_imap(benchmark, imap):
|
||||||
|
def imap_connect():
|
||||||
|
imap.connect()
|
||||||
|
|
||||||
|
benchmark(imap_connect, 10)
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_imap(benchmark, imap, gencreds):
|
||||||
|
def imap_connect_and_login():
|
||||||
|
imap.connect()
|
||||||
|
imap.login(*gencreds())
|
||||||
|
|
||||||
|
benchmark(imap_connect_and_login, 10)
|
||||||
|
|
||||||
|
|
||||||
|
def test_tls_smtp(benchmark, smtp):
|
||||||
|
def smtp_connect():
|
||||||
|
smtp.connect()
|
||||||
|
|
||||||
|
benchmark(smtp_connect, 10)
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_smtp(benchmark, smtp, gencreds):
|
||||||
|
def smtp_connect_and_login():
|
||||||
|
smtp.connect()
|
||||||
|
smtp.login(*gencreds())
|
||||||
|
|
||||||
|
benchmark(smtp_connect_and_login, 10)
|
||||||
|
|
||||||
|
|
||||||
|
class TestDC:
|
||||||
|
def test_autoconfigure(self, benchmark, cmfactory):
|
||||||
|
def dc_autoconfig_and_idle_ready():
|
||||||
|
cmfactory.get_online_accounts(1)
|
||||||
|
|
||||||
|
benchmark(dc_autoconfig_and_idle_ready, 5)
|
||||||
|
|
||||||
|
def test_ping_pong(self, benchmark, cmfactory):
|
||||||
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
|
def dc_ping_pong():
|
||||||
|
chat.send_text("ping")
|
||||||
|
msg = ac2.wait_next_incoming_message()
|
||||||
|
msg.chat.send_text("pong")
|
||||||
|
ac1.wait_next_incoming_message()
|
||||||
|
|
||||||
|
benchmark(dc_ping_pong, 5)
|
||||||
|
|
||||||
|
def test_send_10_receive_10(self, benchmark, cmfactory, lp):
|
||||||
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
|
def dc_send_10_receive_10():
|
||||||
|
for i in range(10):
|
||||||
|
chat.send_text(f"hello {i}")
|
||||||
|
for i in range(10):
|
||||||
|
ac2.wait_next_incoming_message()
|
||||||
|
|
||||||
|
benchmark(dc_send_10_receive_10, 5)
|
||||||
102
cmdeploy/src/cmdeploy/tests/online/test_0_login.py
Normal file
102
cmdeploy/src/cmdeploy/tests/online/test_0_login.py
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
import pytest
|
||||||
|
import threading
|
||||||
|
import queue
|
||||||
|
import socket
|
||||||
|
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
from cmdeploy.cmdeploy import main
|
||||||
|
|
||||||
|
|
||||||
|
def test_init(tmp_path, maildomain):
|
||||||
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
main(["init", "--config", str(inipath), maildomain])
|
||||||
|
config = read_config(inipath)
|
||||||
|
assert config.mail_domain == maildomain
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
||||||
|
"""Test a) that an initial login creates a user automatically
|
||||||
|
and b) verify we can also login a second time with the same password
|
||||||
|
and c) that using a different password fails the login."""
|
||||||
|
user, password = gencreds()
|
||||||
|
lp.sec(f"login first time with {user} {password}")
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
imap_or_smtp.login(user, password)
|
||||||
|
lp.indent("success")
|
||||||
|
|
||||||
|
lp.sec(f"reconnect and login second time {user} {password}")
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
imap_or_smtp.login(user, password)
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
lp.sec("success")
|
||||||
|
|
||||||
|
lp.sec(f"reconnect and verify wrong password fails {user} ")
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
with pytest.raises(imap_or_smtp.AuthError):
|
||||||
|
imap_or_smtp.login(user, password + "wrong")
|
||||||
|
|
||||||
|
lp.sec("creating users with a short password is not allowed")
|
||||||
|
user, _password = gencreds()
|
||||||
|
with pytest.raises(imap_or_smtp.AuthError):
|
||||||
|
imap_or_smtp.login(user, "admin")
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_same_password(imap_or_smtp, gencreds):
|
||||||
|
"""Test two different users logging in with the same password
|
||||||
|
to ensure that authentication process does not confuse the users
|
||||||
|
by using only the password hash as a key.
|
||||||
|
"""
|
||||||
|
user1, password1 = gencreds()
|
||||||
|
user2, _ = gencreds()
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
imap_or_smtp.login(user1, password1)
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
imap_or_smtp.login(user2, password1)
|
||||||
|
|
||||||
|
|
||||||
|
def test_concurrent_logins_same_account(
|
||||||
|
make_imap_connection, make_smtp_connection, gencreds
|
||||||
|
):
|
||||||
|
"""Test concurrent smtp and imap logins
|
||||||
|
and check remote server succeeds on each connection.
|
||||||
|
"""
|
||||||
|
user1, password1 = gencreds()
|
||||||
|
login_results = queue.Queue()
|
||||||
|
|
||||||
|
def login_smtp_imap(smtp, imap):
|
||||||
|
try:
|
||||||
|
imap.login(user1, password1)
|
||||||
|
except Exception:
|
||||||
|
login_results.put(False)
|
||||||
|
else:
|
||||||
|
login_results.put(True)
|
||||||
|
|
||||||
|
conns = [(make_smtp_connection(), make_imap_connection()) for i in range(10)]
|
||||||
|
|
||||||
|
for args in conns:
|
||||||
|
thread = threading.Thread(target=login_smtp_imap, args=args, daemon=True)
|
||||||
|
thread.start()
|
||||||
|
|
||||||
|
for _ in conns:
|
||||||
|
assert login_results.get()
|
||||||
|
|
||||||
|
|
||||||
|
def test_no_vrfy(chatmail_config):
|
||||||
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
sock.connect((chatmail_config.mail_domain, 25))
|
||||||
|
banner = sock.recv(1024)
|
||||||
|
print(banner)
|
||||||
|
sock.send(b"VRFY wrongaddress@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
||||||
|
result = sock.recv(1024)
|
||||||
|
print(result)
|
||||||
|
sock.send(b"VRFY echo@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
||||||
|
result2 = sock.recv(1024)
|
||||||
|
print(result2)
|
||||||
|
assert result[0:10] == result2[0:10]
|
||||||
|
sock.send(b"VRFY wrongaddress\r\n")
|
||||||
|
result = sock.recv(1024)
|
||||||
|
print(result)
|
||||||
|
sock.send(b"VRFY echo\r\n")
|
||||||
|
result2 = sock.recv(1024)
|
||||||
|
print(result2)
|
||||||
|
assert result[0:10] == result2[0:10] == b"252 2.0.0 "
|
||||||
25
cmdeploy/src/cmdeploy/tests/online/test_0_qr.py
Normal file
25
cmdeploy/src/cmdeploy/tests/online/test_0_qr.py
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
import requests
|
||||||
|
|
||||||
|
from cmdeploy.genqr import gen_qr_png_data
|
||||||
|
|
||||||
|
|
||||||
|
def test_gen_qr_png_data(maildomain):
|
||||||
|
data = gen_qr_png_data(maildomain)
|
||||||
|
assert data
|
||||||
|
|
||||||
|
|
||||||
|
def test_fastcgi_working(maildomain, chatmail_config):
|
||||||
|
url = f"https://{maildomain}/new"
|
||||||
|
print(url)
|
||||||
|
res = requests.post(url)
|
||||||
|
assert maildomain in res.json().get("email")
|
||||||
|
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
||||||
|
|
||||||
|
|
||||||
|
def test_newemail_configure(maildomain, rpc):
|
||||||
|
"""Test configuring accounts by scanning a QR code works."""
|
||||||
|
url = f"DCACCOUNT:https://{maildomain}/new"
|
||||||
|
for i in range(3):
|
||||||
|
account_id = rpc.add_account()
|
||||||
|
rpc.set_config_from_qr(account_id, url)
|
||||||
|
rpc.configure(account_id)
|
||||||
100
cmdeploy/src/cmdeploy/tests/online/test_1_basic.py
Normal file
100
cmdeploy/src/cmdeploy/tests/online/test_1_basic.py
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
import smtplib
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
def test_remote(remote, imap_or_smtp):
|
||||||
|
lineproducer = remote.iter_output(imap_or_smtp.logcmd)
|
||||||
|
imap_or_smtp.connect()
|
||||||
|
assert imap_or_smtp.name in next(lineproducer)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_two_chatmailservers(cmfactory, maildomain2):
|
||||||
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
|
cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
domain1 = ac1.get_config("addr").split("@")[1]
|
||||||
|
domain2 = ac2.get_config("addr").split("@")[1]
|
||||||
|
assert domain1 != domain2
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("forgeaddr", ["internal", "someone@example.org"])
|
||||||
|
def test_reject_forged_from(cmsetup, maildata, gencreds, lp, forgeaddr):
|
||||||
|
user1, user3 = cmsetup.gen_users(2)
|
||||||
|
|
||||||
|
lp.sec("send encrypted message with forged from")
|
||||||
|
print("envelope_from", user1.addr)
|
||||||
|
if forgeaddr == "internal":
|
||||||
|
addr_to_forge = cmsetup.gen_users(1)[0].addr
|
||||||
|
else:
|
||||||
|
addr_to_forge = "someone@example.org"
|
||||||
|
|
||||||
|
print("message to inject:")
|
||||||
|
msg = maildata("encrypted.eml", from_addr=addr_to_forge, to_addr=user3.addr)
|
||||||
|
msg = msg.as_string()
|
||||||
|
for line in msg.split("\n")[:4]:
|
||||||
|
print(f" {line}")
|
||||||
|
|
||||||
|
lp.sec("Send forged mail and check remote postfix lmtp processing result")
|
||||||
|
with pytest.raises(smtplib.SMTPException) as e:
|
||||||
|
user1.smtp.sendmail(from_addr=user1.addr, to_addrs=[user3.addr], msg=msg)
|
||||||
|
assert "500" in str(e.value)
|
||||||
|
|
||||||
|
|
||||||
|
def test_authenticated_from(cmsetup, maildata):
|
||||||
|
"""Test that envelope FROM must be the same as login."""
|
||||||
|
user1, user2, user3 = cmsetup.gen_users(3)
|
||||||
|
|
||||||
|
msg = maildata("encrypted.eml", from_addr=user2.addr, to_addr=user3.addr)
|
||||||
|
with pytest.raises(smtplib.SMTPException) as e:
|
||||||
|
user1.smtp.sendmail(
|
||||||
|
from_addr=user2.addr, to_addrs=[user3.addr], msg=msg.as_string()
|
||||||
|
)
|
||||||
|
assert e.value.recipients[user3.addr][0] == 553
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("from_addr", ["fake@example.org", "fake@testrun.org"])
|
||||||
|
def test_reject_missing_dkim(cmsetup, maildata, from_addr):
|
||||||
|
"""Test that emails with missing or wrong DMARC, DKIM, and SPF entries are rejected."""
|
||||||
|
recipient = cmsetup.gen_users(1)[0]
|
||||||
|
msg = maildata("plain.eml", from_addr=from_addr, to_addr=recipient.addr).as_string()
|
||||||
|
with smtplib.SMTP(cmsetup.maildomain, 25) as s:
|
||||||
|
with pytest.raises(smtplib.SMTPDataError, match="No valid DKIM signature"):
|
||||||
|
s.sendmail(from_addr=from_addr, to_addrs=recipient.addr, msg=msg)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.slow
|
||||||
|
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
||||||
|
"""Test that the per-account send-mail limit is exceeded."""
|
||||||
|
user1, user2 = cmsetup.gen_users(2)
|
||||||
|
mail = maildata(
|
||||||
|
"encrypted.eml", from_addr=user1.addr, to_addr=user2.addr
|
||||||
|
).as_string()
|
||||||
|
for i in range(chatmail_config.max_user_send_per_minute + 5):
|
||||||
|
print("Sending mail", str(i))
|
||||||
|
try:
|
||||||
|
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
||||||
|
except smtplib.SMTPException as e:
|
||||||
|
if i < chatmail_config.max_user_send_per_minute:
|
||||||
|
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
||||||
|
outcome = e.recipients[user2.addr]
|
||||||
|
assert outcome[0] == 450
|
||||||
|
assert b"4.7.1: Too much mail from" in outcome[1]
|
||||||
|
return
|
||||||
|
pytest.fail("Rate limit was not exceeded")
|
||||||
|
|
||||||
|
|
||||||
|
def test_expunged(remote, chatmail_config):
|
||||||
|
outdated_days = int(chatmail_config.delete_mails_after) + 1
|
||||||
|
find_cmds = [
|
||||||
|
f"find /home/vmail/mail/{chatmail_config.mail_domain} -path '*/cur/*' -mtime +{outdated_days} -type f",
|
||||||
|
f"find /home/vmail/mail/{chatmail_config.mail_domain} -path '*/.*/cur/*' -mtime +{outdated_days} -type f",
|
||||||
|
f"find /home/vmail/mail/{chatmail_config.mail_domain} -path '*/new/*' -mtime +{outdated_days} -type f",
|
||||||
|
f"find /home/vmail/mail/{chatmail_config.mail_domain} -path '*/.*/new/*' -mtime +{outdated_days} -type f",
|
||||||
|
f"find /home/vmail/mail/{chatmail_config.mail_domain} -path '*/tmp/*' -mtime +{outdated_days} -type f",
|
||||||
|
f"find /home/vmail/mail/{chatmail_config.mail_domain} -path '*/.*/tmp/*' -mtime +{outdated_days} -type f",
|
||||||
|
]
|
||||||
|
for cmd in find_cmds:
|
||||||
|
for line in remote.iter_output(cmd):
|
||||||
|
assert not line
|
||||||
150
cmdeploy/src/cmdeploy/tests/online/test_2_deltachat.py
Normal file
150
cmdeploy/src/cmdeploy/tests/online/test_2_deltachat.py
Normal file
@@ -0,0 +1,150 @@
|
|||||||
|
import time
|
||||||
|
import re
|
||||||
|
import random
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
import requests
|
||||||
|
import ipaddress
|
||||||
|
|
||||||
|
|
||||||
|
class TestEndToEndDeltaChat:
|
||||||
|
"Tests that use Delta Chat accounts on the chat mail instance."
|
||||||
|
|
||||||
|
def test_one_on_one(self, cmfactory, lp):
|
||||||
|
"""Test that a DC account can send a message to a second DC account
|
||||||
|
on the same chat-mail instance."""
|
||||||
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
|
lp.sec("ac1: prepare and send text message to ac2")
|
||||||
|
chat.send_text("message0")
|
||||||
|
|
||||||
|
lp.sec("wait for ac2 to receive message")
|
||||||
|
msg2 = ac2._evtracker.wait_next_incoming_message()
|
||||||
|
assert msg2.text == "message0"
|
||||||
|
|
||||||
|
@pytest.mark.slow
|
||||||
|
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote, chatmail_config):
|
||||||
|
"""This is a very slow test as it needs to upload >100MB of mail data
|
||||||
|
before quota is exceeded, and thus depends on the speed of the upload.
|
||||||
|
"""
|
||||||
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
|
def parse_size_limit(limit: str) -> int:
|
||||||
|
"""Parse a size limit and return the number of bytes as integer.
|
||||||
|
|
||||||
|
Example input: 100M, 2.4T, 500 K
|
||||||
|
"""
|
||||||
|
units = {"B": 1, "K": 2**10, "M": 2**20, "G": 2**30, "T": 2**40}
|
||||||
|
size = re.sub(r"([KMGT])", r" \1", limit.upper())
|
||||||
|
number, unit = [string.strip() for string in size.split()]
|
||||||
|
return int(float(number) * units[unit])
|
||||||
|
|
||||||
|
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))
|
||||||
|
msgs.append(msg)
|
||||||
|
lp.indent(f"Sent out msg {i}, size {attachsize/(1024*1024)}MB")
|
||||||
|
|
||||||
|
lp.sec("ac2: check messages are arriving until quota is reached")
|
||||||
|
|
||||||
|
addr = ac2.get_config("addr").lower()
|
||||||
|
saved_ok = 0
|
||||||
|
for line in remote.iter_output("journalctl -f -u dovecot"):
|
||||||
|
if addr not in line:
|
||||||
|
# print(line)
|
||||||
|
continue
|
||||||
|
if "quota" in line:
|
||||||
|
if "quota exceeded" in line:
|
||||||
|
if saved_ok < num_to_send // 2:
|
||||||
|
pytest.fail(
|
||||||
|
f"quota exceeded too early: after {saved_ok} messages already"
|
||||||
|
)
|
||||||
|
lp.indent("good, message sending failed because quota was exceeded")
|
||||||
|
return
|
||||||
|
if "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):
|
||||||
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
|
|
||||||
|
lp.sec("ac1: create QR code and let ac2 scan it, starting the securejoin")
|
||||||
|
qr = ac1.get_setup_contact_qr()
|
||||||
|
|
||||||
|
lp.sec("ac2: start QR-code based setup contact protocol")
|
||||||
|
ch = ac2.qr_setup_contact(qr)
|
||||||
|
assert ch.id >= 10
|
||||||
|
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
||||||
|
|
||||||
|
def test_read_receipts_between_instances(self, cmfactory, lp, maildomain2):
|
||||||
|
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.switch_maildomain(maildomain2)
|
||||||
|
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
||||||
|
cmfactory.bring_accounts_online()
|
||||||
|
|
||||||
|
lp.sec("setup encrypted comms between ac1 and ac2 on different instances")
|
||||||
|
qr = ac1.get_setup_contact_qr()
|
||||||
|
ch = ac2.qr_setup_contact(qr)
|
||||||
|
assert ch.id >= 10
|
||||||
|
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
||||||
|
|
||||||
|
lp.sec("ac1 sends a message and ac2 marks it as seen")
|
||||||
|
chat = ac1.create_chat(ac2)
|
||||||
|
msg = chat.send_text("hi")
|
||||||
|
m = ac2.wait_next_incoming_message()
|
||||||
|
m.mark_seen()
|
||||||
|
# we can only indirectly wait for mark-seen to cause an smtp-error
|
||||||
|
lp.sec("try to wait for markseen to complete and check error states")
|
||||||
|
deadline = time.time() + 3.1
|
||||||
|
while time.time() < deadline:
|
||||||
|
msgs = m.chat.get_messages()
|
||||||
|
for msg in msgs:
|
||||||
|
assert "error" not in m.get_message_info()
|
||||||
|
time.sleep(1)
|
||||||
|
|
||||||
|
|
||||||
|
def test_hide_senders_ip_address(cmfactory):
|
||||||
|
public_ip = requests.get("http://icanhazip.com").content.decode().strip()
|
||||||
|
assert ipaddress.ip_address(public_ip)
|
||||||
|
|
||||||
|
user1, user2 = cmfactory.get_online_accounts(2)
|
||||||
|
chat = cmfactory.get_accepted_chat(user1, user2)
|
||||||
|
|
||||||
|
chat.send_text("testing submission header cleanup")
|
||||||
|
user2.wait_next_incoming_message()
|
||||||
|
user2.direct_imap.select_folder("Inbox")
|
||||||
|
msg = user2.direct_imap.get_all_messages()[0]
|
||||||
|
assert public_ip not in msg.obj.as_string()
|
||||||
|
|
||||||
|
|
||||||
|
def test_echobot(cmfactory, chatmail_config, lp):
|
||||||
|
ac = cmfactory.get_online_accounts(1)[0]
|
||||||
|
|
||||||
|
lp.sec(f"Send message to echo@{chatmail_config.mail_domain}")
|
||||||
|
chat = ac.create_chat(f"echo@{chatmail_config.mail_domain}")
|
||||||
|
text = "hi, I hope you text me back"
|
||||||
|
chat.send_text(text)
|
||||||
|
lp.sec("Wait for reply from echobot")
|
||||||
|
reply = ac.wait_next_incoming_message()
|
||||||
|
assert reply.text == text
|
||||||
405
cmdeploy/src/cmdeploy/tests/plugin.py
Normal file
405
cmdeploy/src/cmdeploy/tests/plugin.py
Normal file
@@ -0,0 +1,405 @@
|
|||||||
|
import os
|
||||||
|
import io
|
||||||
|
import time
|
||||||
|
import random
|
||||||
|
import subprocess
|
||||||
|
import imaplib
|
||||||
|
import smtplib
|
||||||
|
import itertools
|
||||||
|
from pathlib import Path
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from chatmaild.database import Database
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
|
conftestdir = Path(__file__).parent
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_addoption(parser):
|
||||||
|
parser.addoption(
|
||||||
|
"--slow", action="store_true", default=False, help="also run slow tests"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_configure(config):
|
||||||
|
config._benchresults = {}
|
||||||
|
config.addinivalue_line(
|
||||||
|
"markers", "slow: mark test to require --slow option to run"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_runtest_setup(item):
|
||||||
|
markers = list(item.iter_markers(name="slow"))
|
||||||
|
if markers:
|
||||||
|
if not item.config.getoption("--slow"):
|
||||||
|
pytest.skip("skipping slow test, use --slow to run")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def chatmail_config(pytestconfig):
|
||||||
|
current = basedir = Path().resolve()
|
||||||
|
while 1:
|
||||||
|
path = current.joinpath("chatmail.ini").resolve()
|
||||||
|
if path.exists():
|
||||||
|
return read_config(path)
|
||||||
|
if current == current.parent:
|
||||||
|
break
|
||||||
|
current = current.parent
|
||||||
|
|
||||||
|
pytest.skip(f"no chatmail.ini file found in {basedir} or parent dirs")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildomain(chatmail_config):
|
||||||
|
return chatmail_config.mail_domain
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def sshdomain(maildomain):
|
||||||
|
return os.environ.get("CHATMAIL_SSH", maildomain)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildomain2():
|
||||||
|
domain = os.environ.get("CHATMAIL_DOMAIN2")
|
||||||
|
if not domain:
|
||||||
|
pytest.skip("set CHATMAIL_DOMAIN2 to a ssh-reachable chatmail instance")
|
||||||
|
return domain
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def sshdomain2(maildomain2):
|
||||||
|
return os.environ.get("CHATMAIL_SSH2", maildomain2)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_report_header():
|
||||||
|
domain = os.environ.get("CHATMAIL_DOMAIN")
|
||||||
|
if domain:
|
||||||
|
text = f"chatmail test instance: {domain}"
|
||||||
|
return ["-" * len(text), text, "-" * len(text)]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def benchmark(request):
|
||||||
|
def bench(func, num, name=None, reportfunc=None):
|
||||||
|
if name is None:
|
||||||
|
name = func.__name__
|
||||||
|
durations = []
|
||||||
|
for i in range(num):
|
||||||
|
now = time.time()
|
||||||
|
func()
|
||||||
|
durations.append(time.time() - now)
|
||||||
|
durations.sort()
|
||||||
|
request.config._benchresults[name] = (reportfunc, durations)
|
||||||
|
|
||||||
|
return bench
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_terminal_summary(terminalreporter):
|
||||||
|
tr = terminalreporter
|
||||||
|
results = tr.config._benchresults
|
||||||
|
if not results:
|
||||||
|
return
|
||||||
|
|
||||||
|
tr.section("benchmark results")
|
||||||
|
float_names = "median min max".split()
|
||||||
|
width = max(map(len, float_names))
|
||||||
|
|
||||||
|
def fcol(parts):
|
||||||
|
return " ".join(part.rjust(width) for part in parts)
|
||||||
|
|
||||||
|
headers = f"{'benchmark name': <30} " + fcol(float_names)
|
||||||
|
tr.write_line(headers)
|
||||||
|
tr.write_line("-" * len(headers))
|
||||||
|
summary_lines = []
|
||||||
|
|
||||||
|
for name, (reportfunc, durations) in results.items():
|
||||||
|
measures = [
|
||||||
|
sorted(durations)[len(durations) // 2],
|
||||||
|
min(durations),
|
||||||
|
max(durations),
|
||||||
|
]
|
||||||
|
line = f"{name: <30} "
|
||||||
|
line += fcol(f"{float: 2.2f}" for float in measures)
|
||||||
|
tr.write_line(line)
|
||||||
|
vmedian, vmin, vmax = measures
|
||||||
|
if reportfunc:
|
||||||
|
for line in reportfunc(vmin=vmin, vmedian=vmedian, vmax=vmax):
|
||||||
|
summary_lines.append(line)
|
||||||
|
|
||||||
|
if summary_lines:
|
||||||
|
tr.write_line("")
|
||||||
|
tr.section("benchmark summary measures")
|
||||||
|
for line in summary_lines:
|
||||||
|
tr.write_line(line)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def imap(maildomain):
|
||||||
|
return ImapConn(maildomain)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def make_imap_connection(maildomain):
|
||||||
|
def make_imap_connection():
|
||||||
|
conn = ImapConn(maildomain)
|
||||||
|
conn.connect()
|
||||||
|
return conn
|
||||||
|
|
||||||
|
return make_imap_connection
|
||||||
|
|
||||||
|
|
||||||
|
class ImapConn:
|
||||||
|
AuthError = imaplib.IMAP4.error
|
||||||
|
logcmd = "journalctl -f -u dovecot"
|
||||||
|
name = "dovecot"
|
||||||
|
|
||||||
|
def __init__(self, host):
|
||||||
|
self.host = host
|
||||||
|
|
||||||
|
def connect(self):
|
||||||
|
print(f"imap-connect {self.host}")
|
||||||
|
self.conn = imaplib.IMAP4_SSL(self.host)
|
||||||
|
|
||||||
|
def login(self, user, password):
|
||||||
|
print(f"imap-login {user!r} {password!r}")
|
||||||
|
self.conn.login(user, password)
|
||||||
|
|
||||||
|
def fetch_all(self):
|
||||||
|
print("imap-fetch all")
|
||||||
|
status, res = self.conn.select()
|
||||||
|
if int(res[0]) == 0:
|
||||||
|
raise ValueError("no messages in imap folder")
|
||||||
|
status, results = self.conn.fetch("1:*", "(RFC822)")
|
||||||
|
assert status == "OK"
|
||||||
|
return results
|
||||||
|
|
||||||
|
def fetch_all_messages(self):
|
||||||
|
print("imap-fetch all messages")
|
||||||
|
results = self.fetch_all()
|
||||||
|
messages = []
|
||||||
|
for item in results:
|
||||||
|
if len(item) == 2:
|
||||||
|
messages.append(item[1].decode())
|
||||||
|
return messages
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def smtp(maildomain):
|
||||||
|
return SmtpConn(maildomain)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def make_smtp_connection(maildomain):
|
||||||
|
def make_smtp_connection():
|
||||||
|
conn = SmtpConn(maildomain)
|
||||||
|
conn.connect()
|
||||||
|
return conn
|
||||||
|
|
||||||
|
return make_smtp_connection
|
||||||
|
|
||||||
|
|
||||||
|
class SmtpConn:
|
||||||
|
AuthError = smtplib.SMTPAuthenticationError
|
||||||
|
logcmd = "journalctl -f -t postfix/smtpd -t postfix/smtp -t postfix/lmtp"
|
||||||
|
name = "postfix"
|
||||||
|
|
||||||
|
def __init__(self, host):
|
||||||
|
self.host = host
|
||||||
|
|
||||||
|
def connect(self):
|
||||||
|
print(f"smtp-connect {self.host}")
|
||||||
|
self.conn = smtplib.SMTP_SSL(self.host)
|
||||||
|
|
||||||
|
def login(self, user, password):
|
||||||
|
print(f"smtp-login {user!r} {password!r}")
|
||||||
|
self.conn.login(user, password)
|
||||||
|
|
||||||
|
def sendmail(self, from_addr, to_addrs, msg):
|
||||||
|
print(f"smtp-sendmail from={from_addr!r} to_addrs={to_addrs!r}")
|
||||||
|
print(f"smtp-sendmail message size: {len(msg)}")
|
||||||
|
return self.conn.sendmail(from_addr=from_addr, to_addrs=to_addrs, msg=msg)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(params=["imap", "smtp"])
|
||||||
|
def imap_or_smtp(request):
|
||||||
|
return request.getfixturevalue(request.param)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def gencreds(chatmail_config):
|
||||||
|
count = itertools.count()
|
||||||
|
next(count)
|
||||||
|
|
||||||
|
def gen(domain=None):
|
||||||
|
domain = domain if domain else chatmail_config.mail_domain
|
||||||
|
while 1:
|
||||||
|
num = next(count)
|
||||||
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
|
user = "".join(
|
||||||
|
random.choices(alphanumeric, k=chatmail_config.username_max_length)
|
||||||
|
)
|
||||||
|
if domain == "nine.testrun.org":
|
||||||
|
user = f"ac{num}_{user}"[:9]
|
||||||
|
else:
|
||||||
|
user = f"ac{num}_{user}"[: chatmail_config.username_max_length]
|
||||||
|
password = "".join(
|
||||||
|
random.choices(alphanumeric, k=chatmail_config.password_min_length)
|
||||||
|
)
|
||||||
|
yield f"{user}@{domain}", f"{password}"
|
||||||
|
|
||||||
|
return lambda domain=None: next(gen(domain))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def db(tmpdir):
|
||||||
|
db_path = tmpdir / "passdb.sqlite"
|
||||||
|
print("database path:", db_path)
|
||||||
|
return Database(db_path)
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Delta Chat testplugin re-use
|
||||||
|
# use the cmfactory fixture to get chatmail instance accounts
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
class ChatmailTestProcess:
|
||||||
|
"""Provider for chatmail instance accounts as used by deltachat.testplugin.acfactory"""
|
||||||
|
|
||||||
|
def __init__(self, pytestconfig, maildomain, gencreds):
|
||||||
|
self.pytestconfig = pytestconfig
|
||||||
|
self.maildomain = maildomain
|
||||||
|
assert "." in self.maildomain, maildomain
|
||||||
|
self.gencreds = gencreds
|
||||||
|
self._addr2files = {}
|
||||||
|
|
||||||
|
def get_liveconfig_producer(self):
|
||||||
|
while 1:
|
||||||
|
user, password = self.gencreds(self.maildomain)
|
||||||
|
config = {
|
||||||
|
"addr": user,
|
||||||
|
"mail_pw": password,
|
||||||
|
}
|
||||||
|
# speed up account configuration
|
||||||
|
config["mail_server"] = self.maildomain
|
||||||
|
config["send_server"] = self.maildomain
|
||||||
|
yield config
|
||||||
|
|
||||||
|
def cache_maybe_retrieve_configured_db_files(self, cache_addr, db_target_path):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def cache_maybe_store_configured_db_files(self, acc):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def cmfactory(request, gencreds, tmpdir, maildomain):
|
||||||
|
# cloned from deltachat.testplugin.amfactory
|
||||||
|
pytest.importorskip("deltachat")
|
||||||
|
from deltachat.testplugin import ACFactory
|
||||||
|
|
||||||
|
data = request.getfixturevalue("data")
|
||||||
|
|
||||||
|
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
||||||
|
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
||||||
|
|
||||||
|
# nb. a bit hacky
|
||||||
|
# would probably be better if deltachat's test machinery grows native support
|
||||||
|
def switch_maildomain(maildomain2):
|
||||||
|
am.testprocess.maildomain = maildomain2
|
||||||
|
|
||||||
|
am.switch_maildomain = switch_maildomain
|
||||||
|
|
||||||
|
yield am
|
||||||
|
if hasattr(request.node, "rep_call") and request.node.rep_call.failed:
|
||||||
|
if testproc.pytestconfig.getoption("--extra-info"):
|
||||||
|
logfile = io.StringIO()
|
||||||
|
am.dump_imap_summary(logfile=logfile)
|
||||||
|
print(logfile.getvalue())
|
||||||
|
# request.node.add_report_section("call", "imap-server-state", s)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def remote(sshdomain):
|
||||||
|
return Remote(sshdomain)
|
||||||
|
|
||||||
|
|
||||||
|
class Remote:
|
||||||
|
def __init__(self, sshdomain):
|
||||||
|
self.sshdomain = sshdomain
|
||||||
|
|
||||||
|
def iter_output(self, logcmd=""):
|
||||||
|
getjournal = "journalctl -f" if not logcmd else logcmd
|
||||||
|
self.popen = subprocess.Popen(
|
||||||
|
["ssh", f"root@{self.sshdomain}", getjournal],
|
||||||
|
stdout=subprocess.PIPE,
|
||||||
|
)
|
||||||
|
while 1:
|
||||||
|
line = self.popen.stdout.readline()
|
||||||
|
res = line.decode().strip().lower()
|
||||||
|
if res:
|
||||||
|
yield res
|
||||||
|
else:
|
||||||
|
break
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def lp(request):
|
||||||
|
class LP:
|
||||||
|
def sec(self, msg):
|
||||||
|
print(f"---- {msg} ----")
|
||||||
|
|
||||||
|
def indent(self, msg):
|
||||||
|
print(f" {msg}")
|
||||||
|
|
||||||
|
return LP()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def cmsetup(maildomain, gencreds):
|
||||||
|
return CMSetup(maildomain, gencreds)
|
||||||
|
|
||||||
|
|
||||||
|
class CMSetup:
|
||||||
|
def __init__(self, maildomain, gencreds):
|
||||||
|
self.maildomain = maildomain
|
||||||
|
self.gencreds = gencreds
|
||||||
|
|
||||||
|
def gen_users(self, num):
|
||||||
|
print(f"Creating {num} online users")
|
||||||
|
users = []
|
||||||
|
for i in range(num):
|
||||||
|
addr, password = self.gencreds()
|
||||||
|
user = CMUser(self.maildomain, addr, password)
|
||||||
|
assert user.smtp
|
||||||
|
users.append(user)
|
||||||
|
return users
|
||||||
|
|
||||||
|
|
||||||
|
class CMUser:
|
||||||
|
def __init__(self, maildomain, addr, password):
|
||||||
|
self.maildomain = maildomain
|
||||||
|
self.addr = addr
|
||||||
|
self.password = password
|
||||||
|
self._smtp = None
|
||||||
|
self._imap = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def smtp(self):
|
||||||
|
if not self._smtp:
|
||||||
|
handle = SmtpConn(self.maildomain)
|
||||||
|
handle.connect()
|
||||||
|
handle.login(self.addr, self.password)
|
||||||
|
self._smtp = handle
|
||||||
|
return self._smtp
|
||||||
|
|
||||||
|
@property
|
||||||
|
def imap(self):
|
||||||
|
if not self._imap:
|
||||||
|
imap = ImapConn(self.maildomain)
|
||||||
|
imap.connect()
|
||||||
|
imap.login(self.addr, self.password)
|
||||||
|
self._imap = imap
|
||||||
|
return self._imap
|
||||||
2
cmdeploy/src/cmdeploy/tests/pytest.ini
Normal file
2
cmdeploy/src/cmdeploy/tests/pytest.ini
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[pytest]
|
||||||
|
addopts = -vrsx --strict-markers
|
||||||
27
cmdeploy/src/cmdeploy/tests/test_cmdeploy.py
Normal file
27
cmdeploy/src/cmdeploy/tests/test_cmdeploy.py
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from cmdeploy.cmdeploy import get_parser, main
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _chdir(tmp_path):
|
||||||
|
old = os.getcwd()
|
||||||
|
os.chdir(tmp_path)
|
||||||
|
yield
|
||||||
|
os.chdir(old)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCmdline:
|
||||||
|
def test_parser(self, capsys):
|
||||||
|
parser = get_parser()
|
||||||
|
parser.parse_args([])
|
||||||
|
init = parser.parse_args(["init", "chat.example.org"])
|
||||||
|
run = parser.parse_args(["run"])
|
||||||
|
assert init and run
|
||||||
|
|
||||||
|
@pytest.mark.xfail(reason="init doesn't exit anymore, check for CLI output instead")
|
||||||
|
def test_init_not_overwrite(self):
|
||||||
|
main(["init", "chat.example.org"])
|
||||||
|
with pytest.raises(SystemExit):
|
||||||
|
main(["init", "chat.example.org"])
|
||||||
13
cmdeploy/src/cmdeploy/tests/test_helpers.py
Normal file
13
cmdeploy/src/cmdeploy/tests/test_helpers.py
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
import importlib.resources
|
||||||
|
|
||||||
|
from cmdeploy.www import build_webpages
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_webpages(tmp_path, make_config):
|
||||||
|
pkgroot = importlib.resources.files("cmdeploy")
|
||||||
|
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
||||||
|
assert src_dir.exists(), src_dir
|
||||||
|
config = make_config("chat.example.org")
|
||||||
|
build_dir = tmp_path.joinpath("build")
|
||||||
|
build_webpages(src_dir, build_dir, config)
|
||||||
|
assert len([x for x in build_dir.iterdir() if x.suffix == ".html"]) >= 3
|
||||||
143
cmdeploy/src/cmdeploy/www.py
Normal file
143
cmdeploy/src/cmdeploy/www.py
Normal file
@@ -0,0 +1,143 @@
|
|||||||
|
import importlib.resources
|
||||||
|
import webbrowser
|
||||||
|
import hashlib
|
||||||
|
import time
|
||||||
|
import traceback
|
||||||
|
|
||||||
|
import markdown
|
||||||
|
from jinja2 import Template
|
||||||
|
from .genqr import gen_qr_png_data
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
|
def snapshot_dir_stats(somedir):
|
||||||
|
d = {}
|
||||||
|
for path in somedir.iterdir():
|
||||||
|
if path.is_file() and path.name[0] != "." and path.suffix != ".swp":
|
||||||
|
mtime = path.stat().st_mtime
|
||||||
|
hash = hashlib.md5(path.read_bytes()).hexdigest()
|
||||||
|
d[path] = (mtime, hash)
|
||||||
|
return d
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_template(source):
|
||||||
|
assert source.exists(), source
|
||||||
|
render_vars = {}
|
||||||
|
render_vars["pagename"] = "home" if source.stem == "index" else source.stem
|
||||||
|
render_vars["markdown_html"] = markdown.markdown(source.read_text())
|
||||||
|
page_layout = source.with_name("page-layout.html").read_text()
|
||||||
|
return render_vars, page_layout
|
||||||
|
|
||||||
|
|
||||||
|
def build_webpages(src_dir, build_dir, config):
|
||||||
|
try:
|
||||||
|
_build_webpages(src_dir, build_dir, config)
|
||||||
|
except Exception:
|
||||||
|
print(traceback.format_exc())
|
||||||
|
|
||||||
|
|
||||||
|
def int_to_english(number):
|
||||||
|
if number >= 0 and number <= 12:
|
||||||
|
a = [
|
||||||
|
"zero",
|
||||||
|
"one",
|
||||||
|
"two",
|
||||||
|
"three",
|
||||||
|
"four",
|
||||||
|
"five",
|
||||||
|
"six",
|
||||||
|
"seven",
|
||||||
|
"eight",
|
||||||
|
"nine",
|
||||||
|
"ten",
|
||||||
|
"eleven",
|
||||||
|
"twelve",
|
||||||
|
]
|
||||||
|
return a[number]
|
||||||
|
elif number <= 50:
|
||||||
|
return str(number)
|
||||||
|
if number > 50:
|
||||||
|
return "more"
|
||||||
|
|
||||||
|
|
||||||
|
def _build_webpages(src_dir, build_dir, config):
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
assert src_dir.exists(), src_dir
|
||||||
|
if not build_dir.exists():
|
||||||
|
build_dir.mkdir()
|
||||||
|
|
||||||
|
qr_path = build_dir.joinpath(f"qr-chatmail-invite-{mail_domain}.png")
|
||||||
|
qr_path.write_bytes(gen_qr_png_data(mail_domain).read())
|
||||||
|
|
||||||
|
for path in src_dir.iterdir():
|
||||||
|
if path.suffix == ".md":
|
||||||
|
render_vars, content = prepare_template(path)
|
||||||
|
render_vars["username_min_length"] = int_to_english(
|
||||||
|
config.username_min_length
|
||||||
|
)
|
||||||
|
render_vars["username_max_length"] = int_to_english(
|
||||||
|
config.username_max_length
|
||||||
|
)
|
||||||
|
render_vars["password_min_length"] = int_to_english(
|
||||||
|
config.password_min_length
|
||||||
|
)
|
||||||
|
target = build_dir.joinpath(path.stem + ".html")
|
||||||
|
|
||||||
|
# recursive jinja2 rendering
|
||||||
|
while 1:
|
||||||
|
new = Template(content).render(config=config, **render_vars)
|
||||||
|
if new == content:
|
||||||
|
break
|
||||||
|
content = new
|
||||||
|
|
||||||
|
with target.open("w") as f:
|
||||||
|
f.write(content)
|
||||||
|
elif path.name != "page-layout.html":
|
||||||
|
target = build_dir.joinpath(path.name)
|
||||||
|
target.write_bytes(path.read_bytes())
|
||||||
|
return build_dir
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
path = importlib.resources.files(__package__)
|
||||||
|
reporoot = path.joinpath("../../../").resolve()
|
||||||
|
inipath = reporoot.joinpath("chatmail.ini")
|
||||||
|
config = read_config(inipath)
|
||||||
|
config.webdev = True
|
||||||
|
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
|
||||||
|
build_webpages(src_dir, build_dir, config)
|
||||||
|
webbrowser.open(str(index_path))
|
||||||
|
stats = snapshot_dir_stats(src_path)
|
||||||
|
print(f"\nOpened URL: file://{index_path.resolve()}\n")
|
||||||
|
print(f"watching {src_path} directory for changes")
|
||||||
|
|
||||||
|
changenum = 0
|
||||||
|
for count in range(0, 1000000):
|
||||||
|
newstats = snapshot_dir_stats(src_path)
|
||||||
|
if newstats == stats and count % 60 != 0:
|
||||||
|
count += 1
|
||||||
|
time.sleep(1.0)
|
||||||
|
continue
|
||||||
|
|
||||||
|
for key in newstats:
|
||||||
|
if stats[key] != newstats[key]:
|
||||||
|
print(f"*** CHANGED: {key}")
|
||||||
|
changenum += 1
|
||||||
|
|
||||||
|
stats = newstats
|
||||||
|
build_webpages(src_dir, build_dir, config)
|
||||||
|
print(f"[{changenum}] regenerated web pages at: {index_path}")
|
||||||
|
print(f"URL: file://{index_path.resolve()}\n\n")
|
||||||
|
count = 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
[build-system]
|
|
||||||
requires = ["setuptools>=45"]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "deploy-chatmail"
|
|
||||||
version = "0.1"
|
|
||||||
dependencies = [
|
|
||||||
"pyinfra",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
|
||||||
addopts = "-v -ra --strict-markers"
|
|
||||||
|
|
||||||
[tool.tox]
|
|
||||||
legacy_tox_ini = """
|
|
||||||
[tox]
|
|
||||||
isolated_build = true
|
|
||||||
envlist = lint
|
|
||||||
|
|
||||||
[testenv:lint]
|
|
||||||
skipdist = True
|
|
||||||
skip_install = True
|
|
||||||
deps =
|
|
||||||
ruff
|
|
||||||
black
|
|
||||||
commands =
|
|
||||||
black --quiet --check --diff src/
|
|
||||||
ruff src/
|
|
||||||
"""
|
|
||||||
@@ -1,255 +0,0 @@
|
|||||||
"""
|
|
||||||
Chat Mail pyinfra deploy.
|
|
||||||
"""
|
|
||||||
import importlib.resources
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from pyinfra import host, logger
|
|
||||||
from pyinfra.operations import apt, files, server, systemd, python
|
|
||||||
from pyinfra.facts.files import File
|
|
||||||
from .acmetool import deploy_acmetool
|
|
||||||
|
|
||||||
|
|
||||||
def _install_chatmaild() -> None:
|
|
||||||
chatmaild_filename = "chatmaild-0.1.tar.gz"
|
|
||||||
chatmaild_path = importlib.resources.files(__package__).joinpath(
|
|
||||||
f"../../../dist/{chatmaild_filename}"
|
|
||||||
)
|
|
||||||
remote_path = f"/tmp/{chatmaild_filename}"
|
|
||||||
if Path(str(chatmaild_path)).exists():
|
|
||||||
files.put(
|
|
||||||
name="Upload chatmaild source package",
|
|
||||||
src=chatmaild_path.open("rb"),
|
|
||||||
dest=remote_path,
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="apt install python3-aiosmtpd",
|
|
||||||
packages=["python3-aiosmtpd", "python3-pip"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# --no-deps because aiosmtplib is installed with `apt`.
|
|
||||||
server.shell(
|
|
||||||
name="install chatmaild with pip",
|
|
||||||
commands=[f"pip install --break-system-packages {remote_path}"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="upload doveauth-dictproxy.service",
|
|
||||||
src=importlib.resources.files("chatmaild")
|
|
||||||
.joinpath("doveauth-dictproxy.service")
|
|
||||||
.open("rb"),
|
|
||||||
dest="/etc/systemd/system/doveauth-dictproxy.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name="Setup doveauth-dictproxy service",
|
|
||||||
service="doveauth-dictproxy.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=True,
|
|
||||||
daemon_reload=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="upload filtermail.service",
|
|
||||||
src=importlib.resources.files("chatmaild")
|
|
||||||
.joinpath("filtermail.service")
|
|
||||||
.open("rb"),
|
|
||||||
dest="/etc/systemd/system/filtermail.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name="Setup filtermail service",
|
|
||||||
service="filtermail.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=True,
|
|
||||||
daemon_reload=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|
||||||
"""Configures OpenDKIM"""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
|
||||||
dest="/etc/opendkim.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
|
|
||||||
files.directory(
|
|
||||||
name="Add opendkim socket directory to /var/spool/postfix",
|
|
||||||
path="/var/spool/postfix/opendkim",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="750",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
|
||||||
server.shell(
|
|
||||||
name="Generate OpenDKIM domain keys",
|
|
||||||
commands=[
|
|
||||||
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
|
||||||
],
|
|
||||||
_sudo=True,
|
|
||||||
_sudo_user="opendkim",
|
|
||||||
)
|
|
||||||
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_postfix(domain: str) -> bool:
|
|
||||||
"""Configures Postfix SMTP server."""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"),
|
|
||||||
dest="/etc/postfix/main.cf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain},
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
master_config = files.put(
|
|
||||||
src=importlib.resources.files(__package__)
|
|
||||||
.joinpath("postfix/master.cf")
|
|
||||||
.open("rb"),
|
|
||||||
dest="/etc/postfix/master.cf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= master_config.changed
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(mail_server: str) -> bool:
|
|
||||||
"""Configures Dovecot IMAP server."""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"),
|
|
||||||
dest="/etc/dovecot/dovecot.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"hostname": mail_server},
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
auth_config = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/auth.conf"),
|
|
||||||
dest="/etc/dovecot/auth.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= auth_config.changed
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
src=importlib.resources.files(__package__)
|
|
||||||
.joinpath("dovecot/expunge.cron")
|
|
||||||
.open("rb"),
|
|
||||||
dest="/etc/cron.d/expunge",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
|
||||||
"""Deploy a chat-mail instance.
|
|
||||||
|
|
||||||
:param mail_domain: domain part of your future email addresses
|
|
||||||
:param mail_server: the DNS name under which your mail server is reachable
|
|
||||||
:param dkim_selector:
|
|
||||||
"""
|
|
||||||
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
|
||||||
|
|
||||||
server.group(name="Create opendkim group", group="opendkim", system=True)
|
|
||||||
server.user(
|
|
||||||
name="Add postfix user to opendkim group for socket access",
|
|
||||||
user="postfix",
|
|
||||||
groups=["opendkim"],
|
|
||||||
system=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
|
||||||
deploy_acmetool(domains=[mail_server])
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install Postfix",
|
|
||||||
packages="postfix",
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install Dovecot",
|
|
||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install OpenDKIM",
|
|
||||||
packages=[
|
|
||||||
"opendkim",
|
|
||||||
"opendkim-tools",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
_install_chatmaild()
|
|
||||||
dovecot_need_restart = _configure_dovecot(mail_server)
|
|
||||||
postfix_need_restart = _configure_postfix(mail_domain)
|
|
||||||
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable OpenDKIM",
|
|
||||||
service="opendkim.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=opendkim_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable Postfix",
|
|
||||||
service="postfix.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=postfix_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable Dovecot",
|
|
||||||
service="dovecot.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=dovecot_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
def callback():
|
|
||||||
result = server.shell(
|
|
||||||
commands=[
|
|
||||||
f"""sed 's/\tIN/ 600 IN/;s/\t(//;s/\"$//;s/^\t \"//g; s/ ).*//' """
|
|
||||||
f"""/etc/dkimkeys/{dkim_selector}.txt | tr --delete '\n'"""
|
|
||||||
]
|
|
||||||
)
|
|
||||||
logger.info(f"Add this TXT entry into DNS zone: {result.stdout}")
|
|
||||||
|
|
||||||
python.call(name="Print TXT entry for DKIM", function=callback)
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
uri = proxy:/run/dovecot/doveauth.socket:auth
|
|
||||||
iterate_disable = yes
|
|
||||||
default_pass_scheme = plain
|
|
||||||
password_key = passdb/%w/%u
|
|
||||||
user_key = userdb/%u
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d INBOX
|
|
||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d Deltachat
|
|
||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d Trash
|
|
||||||
2 30 * * * dovecot doveadm purge -A
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
myorigin = {{ config.domain_name }}
|
|
||||||
|
|
||||||
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
|
||||||
biff = no
|
|
||||||
|
|
||||||
# appending .domain is the MUA's job.
|
|
||||||
append_dot_mydomain = no
|
|
||||||
|
|
||||||
# Uncomment the next line to generate "delayed mail" warnings
|
|
||||||
#delay_warning_time = 4h
|
|
||||||
|
|
||||||
readme_directory = no
|
|
||||||
|
|
||||||
# See http://www.postfix.org/COMPATIBILITY_README.html -- default to 2 on
|
|
||||||
# fresh installs.
|
|
||||||
compatibility_level = 2
|
|
||||||
|
|
||||||
# TLS parameters
|
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.domain_name }}/fullchain
|
|
||||||
smtpd_tls_key_file=/var/lib/acme/live/{{ config.domain_name }}/privkey
|
|
||||||
smtpd_tls_security_level=may
|
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
|
||||||
smtp_tls_security_level=may
|
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
|
||||||
myhostname = {{ config.domain_name }}
|
|
||||||
alias_maps = hash:/etc/aliases
|
|
||||||
alias_database = hash:/etc/aliases
|
|
||||||
|
|
||||||
# Postfix does not deliver mail for any domain by itself.
|
|
||||||
# Primary domain is listed in `virtual_mailbox_domains` instead
|
|
||||||
# and handed over to Dovecot.
|
|
||||||
mydestination =
|
|
||||||
|
|
||||||
relayhost =
|
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
|
||||||
mailbox_size_limit = 0
|
|
||||||
# maximum 30MB sized messages
|
|
||||||
message_size_limit = 31457280
|
|
||||||
recipient_delimiter = +
|
|
||||||
inet_interfaces = all
|
|
||||||
inet_protocols = all
|
|
||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
|
||||||
virtual_mailbox_domains = {{ config.domain_name }}
|
|
||||||
|
|
||||||
smtpd_milters = unix:opendkim/opendkim.sock
|
|
||||||
non_smtpd_milters = $smtpd_milters
|
|
||||||
19
deploy.py
19
deploy.py
@@ -1,19 +0,0 @@
|
|||||||
import os
|
|
||||||
import pyinfra
|
|
||||||
from deploy_chatmail import deploy_chatmail
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
mail_domain = os.getenv("CHATMAIL_DOMAIN")
|
|
||||||
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
|
|
||||||
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "2023")
|
|
||||||
|
|
||||||
assert mail_domain
|
|
||||||
assert mail_server
|
|
||||||
assert dkim_selector
|
|
||||||
|
|
||||||
deploy_chatmail(mail_domain, mail_server, dkim_selector)
|
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
|
||||||
main()
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
def test_tls_serialized_connect(benchmark, imap_or_smtp):
|
|
||||||
def connect():
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
|
|
||||||
benchmark(connect)
|
|
||||||
|
|
||||||
|
|
||||||
def test_login(benchmark, imap_or_smtp, gencreds):
|
|
||||||
cls = imap_or_smtp.__class__
|
|
||||||
conns = []
|
|
||||||
for i in range(20):
|
|
||||||
conn = cls(imap_or_smtp.host)
|
|
||||||
conn.connect()
|
|
||||||
conns.append(conn)
|
|
||||||
|
|
||||||
def login():
|
|
||||||
conn = conns.pop()
|
|
||||||
conn.login(*gencreds())
|
|
||||||
|
|
||||||
benchmark(login)
|
|
||||||
|
|
||||||
|
|
||||||
def test_send_and_receive_10(benchmark, cmfactory, lp):
|
|
||||||
"""send many messages between two accounts"""
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
def send_10_receive_all():
|
|
||||||
for i in range(10):
|
|
||||||
chat.send_text(f"hello {i}")
|
|
||||||
for i in range(10):
|
|
||||||
ac2.wait_next_incoming_message()
|
|
||||||
|
|
||||||
benchmark(send_10_receive_all)
|
|
||||||
@@ -1,201 +0,0 @@
|
|||||||
import os
|
|
||||||
import io
|
|
||||||
import random
|
|
||||||
import subprocess
|
|
||||||
import imaplib
|
|
||||||
import smtplib
|
|
||||||
import itertools
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_addoption(parser):
|
|
||||||
parser.addoption(
|
|
||||||
"--slow", action="store_true", default=False, help="also run slow tests"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_runtest_setup(item):
|
|
||||||
markers = list(item.iter_markers(name="slow"))
|
|
||||||
if markers:
|
|
||||||
if not item.config.getoption("--slow"):
|
|
||||||
pytest.skip("skipping slow test, use --slow to run")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildomain():
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN")
|
|
||||||
if not domain:
|
|
||||||
pytest.skip("set CHATMAIL_DOMAIN to a ssh-reachable chatmail instance")
|
|
||||||
return domain
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def sshdomain(maildomain):
|
|
||||||
return os.environ.get("CHATMAIL_SSH", maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildomain2():
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN2")
|
|
||||||
if not domain:
|
|
||||||
pytest.skip("set CHATMAIL_DOMAIN2 to a ssh-reachable chatmail instance")
|
|
||||||
return domain
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def sshdomain2(maildomain2):
|
|
||||||
return os.environ.get("CHATMAIL_SSH2", maildomain2)
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_report_header():
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN")
|
|
||||||
if domain:
|
|
||||||
text = f"chatmail test instance: {domain}"
|
|
||||||
return ["-" * len(text), text, "-" * len(text)]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def imap(maildomain):
|
|
||||||
return ImapConn(maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
class ImapConn:
|
|
||||||
AuthError = imaplib.IMAP4.error
|
|
||||||
logcmd = "journalctl -f -u dovecot"
|
|
||||||
name = "dovecot"
|
|
||||||
|
|
||||||
def __init__(self, host):
|
|
||||||
self.host = host
|
|
||||||
|
|
||||||
def connect(self):
|
|
||||||
print(f"imap-connect {self.host}")
|
|
||||||
self.conn = imaplib.IMAP4_SSL(self.host)
|
|
||||||
|
|
||||||
def login(self, user, password):
|
|
||||||
print(f"imap-login {user!r} {password!r}")
|
|
||||||
self.conn.login(user, password)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def smtp(maildomain):
|
|
||||||
return SmtpConn(maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
class SmtpConn:
|
|
||||||
AuthError = smtplib.SMTPAuthenticationError
|
|
||||||
logcmd = "journalctl -f -t postfix/smtpd -t postfix/smtp -t postfix/lmtp"
|
|
||||||
name = "postfix"
|
|
||||||
|
|
||||||
def __init__(self, host):
|
|
||||||
self.host = host
|
|
||||||
|
|
||||||
def connect(self):
|
|
||||||
print(f"smtp-connect {self.host}")
|
|
||||||
self.conn = smtplib.SMTP_SSL(self.host)
|
|
||||||
|
|
||||||
def login(self, user, password):
|
|
||||||
print(f"smtp-login {user!r} {password!r}")
|
|
||||||
self.conn.login(user, password)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(params=["imap", "smtp"])
|
|
||||||
def imap_or_smtp(request):
|
|
||||||
return request.getfixturevalue(request.param)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def gencreds(maildomain):
|
|
||||||
count = itertools.count()
|
|
||||||
next(count)
|
|
||||||
|
|
||||||
def gen(domain=None):
|
|
||||||
domain = domain if domain else maildomain
|
|
||||||
while 1:
|
|
||||||
num = next(count)
|
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
|
||||||
user = "".join(random.choices(alphanumeric, k=10))
|
|
||||||
user = f"ac{num}_{user}"
|
|
||||||
password = "".join(random.choices(alphanumeric, k=10))
|
|
||||||
yield f"{user}@{domain}", f"{password}"
|
|
||||||
|
|
||||||
return lambda domain=None: next(gen(domain))
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Delta Chat testplugin re-use
|
|
||||||
# use the cmfactory fixture to get chatmail instance accounts
|
|
||||||
#
|
|
||||||
|
|
||||||
|
|
||||||
class ChatmailTestProcess:
|
|
||||||
"""Provider for chatmail instance accounts as used by deltachat.testplugin.acfactory"""
|
|
||||||
|
|
||||||
def __init__(self, pytestconfig, maildomain, gencreds):
|
|
||||||
self.pytestconfig = pytestconfig
|
|
||||||
self.maildomain = maildomain
|
|
||||||
assert "." in self.maildomain, maildomain
|
|
||||||
self.gencreds = gencreds
|
|
||||||
self._addr2files = {}
|
|
||||||
|
|
||||||
def get_liveconfig_producer(self):
|
|
||||||
while 1:
|
|
||||||
user, password = self.gencreds(self.maildomain)
|
|
||||||
config = {
|
|
||||||
"addr": user,
|
|
||||||
"mail_pw": password,
|
|
||||||
}
|
|
||||||
# speed up account configuration
|
|
||||||
config["mail_server"] = self.maildomain
|
|
||||||
config["send_server"] = self.maildomain
|
|
||||||
yield config
|
|
||||||
|
|
||||||
def cache_maybe_retrieve_configured_db_files(self, cache_addr, db_target_path):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def cache_maybe_store_configured_db_files(self, acc):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def cmfactory(request, gencreds, tmpdir, data, maildomain):
|
|
||||||
# cloned from deltachat.testplugin.amfactory
|
|
||||||
pytest.importorskip("deltachat")
|
|
||||||
from deltachat.testplugin import ACFactory
|
|
||||||
|
|
||||||
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
|
||||||
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
|
||||||
|
|
||||||
# nb. a bit hacky
|
|
||||||
# would probably be better if deltachat's test machinery grows native support
|
|
||||||
def switch_maildomain(maildomain2):
|
|
||||||
am.testprocess.maildomain = maildomain2
|
|
||||||
|
|
||||||
am.switch_maildomain = switch_maildomain
|
|
||||||
|
|
||||||
yield am
|
|
||||||
if hasattr(request.node, "rep_call") and request.node.rep_call.failed:
|
|
||||||
if testproc.pytestconfig.getoption("--extra-info"):
|
|
||||||
logfile = io.StringIO()
|
|
||||||
am.dump_imap_summary(logfile=logfile)
|
|
||||||
print(logfile.getvalue())
|
|
||||||
# request.node.add_report_section("call", "imap-server-state", s)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def remote(sshdomain):
|
|
||||||
return Remote(sshdomain)
|
|
||||||
|
|
||||||
|
|
||||||
class Remote:
|
|
||||||
def __init__(self, sshdomain):
|
|
||||||
self.sshdomain = sshdomain
|
|
||||||
|
|
||||||
def iter_output(self, logcmd=""):
|
|
||||||
getjournal = f"journalctl -f" if not logcmd else logcmd
|
|
||||||
self.popen = subprocess.Popen(
|
|
||||||
["ssh", f"root@{self.sshdomain}", getjournal],
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
)
|
|
||||||
while 1:
|
|
||||||
line = self.popen.stdout.readline()
|
|
||||||
yield line.decode().strip().lower()
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
[pytest]
|
|
||||||
addopts = -vrsx --strict-markers
|
|
||||||
markers = slow: mark test as slow (requires --slow option to run)
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
def test_remote(remote, imap_or_smtp):
|
|
||||||
lineproducer = remote.iter_output(imap_or_smtp.logcmd)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
assert imap_or_smtp.name in next(lineproducer)
|
|
||||||
|
|
||||||
|
|
||||||
def test_use_two_chatmailservers(cmfactory, maildomain2):
|
|
||||||
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.switch_maildomain(maildomain2)
|
|
||||||
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.bring_accounts_online()
|
|
||||||
cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
domain1 = ac1.get_config("addr").split("@")[1]
|
|
||||||
domain2 = ac2.get_config("addr").split("@")[1]
|
|
||||||
assert domain1 != domain2
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
|
||||||
"""Test a) that an initial login creates a user automatically
|
|
||||||
and b) verify we can also login a second time with the same password
|
|
||||||
and c) that using a different password fails the login."""
|
|
||||||
user, password = gencreds()
|
|
||||||
lp.sec(f"login first time with {user} {password}")
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user, password)
|
|
||||||
lp.indent("success")
|
|
||||||
|
|
||||||
lp.sec(f"reconnect and login second time {user} {password}")
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user, password)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
lp.sec("success")
|
|
||||||
|
|
||||||
lp.sec(f"reconnect and verify wrong password fails {user} ")
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
with pytest.raises(imap_or_smtp.AuthError):
|
|
||||||
imap_or_smtp.login(user, password + "wrong")
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_same_password(imap_or_smtp, gencreds):
|
|
||||||
"""Test two different users logging in with the same password
|
|
||||||
to ensure that authentication process does not confuse the users
|
|
||||||
by using only the password hash as a key.
|
|
||||||
"""
|
|
||||||
user1, password1 = gencreds()
|
|
||||||
user2, _ = gencreds()
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user1, password1)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user2, password1)
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
import random
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
|
|
||||||
class TestEndToEndDeltaChat:
|
|
||||||
"Tests that use Delta Chat accounts on the chat mail instance."
|
|
||||||
|
|
||||||
def test_one_on_one(self, cmfactory, lp):
|
|
||||||
"""Test that a DC account can send a message to a second DC account
|
|
||||||
on the same chat-mail instance."""
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
lp.sec("ac1: prepare and send text message to ac2")
|
|
||||||
chat.send_text("message0")
|
|
||||||
|
|
||||||
lp.sec("wait for ac2 to receive message")
|
|
||||||
msg2 = ac2._evtracker.wait_next_incoming_message()
|
|
||||||
assert msg2.text == "message0"
|
|
||||||
|
|
||||||
@pytest.mark.slow
|
|
||||||
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote):
|
|
||||||
"""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.
|
|
||||||
"""
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
quota = 1024 * 1024 * 100
|
|
||||||
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))
|
|
||||||
msgs.append(msg)
|
|
||||||
lp.indent(f"Sent out msg {i}, size {attachsize/(1024*1024)}MB")
|
|
||||||
|
|
||||||
lp.sec("ac2: check messages are arriving until quota is reached")
|
|
||||||
|
|
||||||
addr = ac2.get_config("addr").lower()
|
|
||||||
saved_ok = 0
|
|
||||||
for line in remote.iter_output("journalctl -f -u dovecot"):
|
|
||||||
if addr not in line:
|
|
||||||
# print(line)
|
|
||||||
continue
|
|
||||||
if "quota" in line:
|
|
||||||
if "quota exceeded" in line:
|
|
||||||
if saved_ok < num_to_send // 2:
|
|
||||||
pytest.fail(
|
|
||||||
f"quota exceeded too early: after {saved_ok} messages already"
|
|
||||||
)
|
|
||||||
lp.indent("good, message sending failed because quota was exceeded")
|
|
||||||
return
|
|
||||||
if "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")
|
|
||||||
71
plan.txt
71
plan.txt
@@ -1,71 +0,0 @@
|
|||||||
# Chat-mail server development (up until Oct 18th)
|
|
||||||
|
|
||||||
## Dovecot goals/steps
|
|
||||||
|
|
||||||
- automatic expiry of messages older than M days
|
|
||||||
- also expunge unread messages
|
|
||||||
|
|
||||||
- limit: configure max-connections per account
|
|
||||||
|
|
||||||
|
|
||||||
## Filtermail
|
|
||||||
|
|
||||||
- (alex, Only allow (outgoing) mails if secure-join or autocrypt-pgp-encrypted format.
|
|
||||||
TODO: mime-parse mails and check/add tests
|
|
||||||
|
|
||||||
|
|
||||||
## nami: send out rate limit / rspamd
|
|
||||||
|
|
||||||
- basic outgoing send rate/limits (depending on "account-rating")
|
|
||||||
use rspamd in a minimal way, check support dkim-signing
|
|
||||||
(including an online test exceeding rate limit)
|
|
||||||
|
|
||||||
|
|
||||||
## doveauth questions/futures
|
|
||||||
|
|
||||||
- bcrypt-password scheme is slow: require long passwords, use faster hashing
|
|
||||||
|
|
||||||
- define user-name and password policies, and implement them
|
|
||||||
(be very restrictive at the beginning, we can relax later)
|
|
||||||
|
|
||||||
- password is part of the dictproxy-lookup key, is it safe to use auth-caching?
|
|
||||||
|
|
||||||
|
|
||||||
## How to limit creation of accounts?
|
|
||||||
|
|
||||||
attack: a 3-line bash script to fill the chatmail db with millions of unused accouts
|
|
||||||
|
|
||||||
- make it computationally expensive (somehow try to except our tests from it)
|
|
||||||
1st pass instant onboarding: create userid + cheap password -- if it fails then
|
|
||||||
2nd pass instant onboarding: create userdid + comput. expensive password
|
|
||||||
|
|
||||||
- probably also do firewall: limit number of new tcp-connections per IP address per duration
|
|
||||||
|
|
||||||
|
|
||||||
## Open/deferred questions
|
|
||||||
|
|
||||||
- automatic expiry of users that haven't logged in for N days
|
|
||||||
Is it neccessary? If all messages are gone, does the existence of
|
|
||||||
an e-mail address bother anybody?
|
|
||||||
|
|
||||||
|
|
||||||
## web page for chat-mail servers?
|
|
||||||
|
|
||||||
- documentation for users, privacy policy etc.
|
|
||||||
(probably also with provider-messages ...)
|
|
||||||
|
|
||||||
|
|
||||||
## online tests (first with plain python/pytest)
|
|
||||||
|
|
||||||
- write tests for dovecot login (exists)
|
|
||||||
- write tests for postfix logins (exists)
|
|
||||||
- write A<>B send/receive tests (exists)
|
|
||||||
|
|
||||||
|
|
||||||
## Delta Chat
|
|
||||||
|
|
||||||
1. qr code that defines access to a chatmail instance (like mailadm but without http etc.)
|
|
||||||
|
|
||||||
2. support for creating username/password and verifying login works
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
set -e
|
|
||||||
|
|
||||||
online-tests/venv/bin/pytest online-tests/benchmark.py -vrx
|
|
||||||
6
scripts/cmdeploy
Executable file
6
scripts/cmdeploy
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Wrapper for cmdelpoy to run it in activated virtualenv.
|
||||||
|
set -e
|
||||||
|
. venv/bin/activate
|
||||||
|
cmdeploy "$@"
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
|
||||||
export CHATMAIL_DOMAIN
|
|
||||||
|
|
||||||
venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
|
|
||||||
|
|
||||||
deploy-chatmail/venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" deploy.py
|
|
||||||
|
|
||||||
rm -r dist/
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
import os
|
|
||||||
import time
|
|
||||||
import imaplib
|
|
||||||
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN", "c3.testrun.org")
|
|
||||||
|
|
||||||
print("connecting")
|
|
||||||
conn = imaplib.IMAP4_SSL(domain)
|
|
||||||
print("logging in")
|
|
||||||
conn.login(f"imapcapa", "pass")
|
|
||||||
status, res = conn.capability()
|
|
||||||
for capa in sorted(res[0].decode().split()):
|
|
||||||
print(capa)
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
set -e
|
|
||||||
python3 -m venv deploy-chatmail/venv
|
|
||||||
deploy-chatmail/venv/bin/pip install pyinfra pytest
|
|
||||||
deploy-chatmail/venv/bin/pip install -e deploy-chatmail
|
|
||||||
deploy-chatmail/venv/bin/pip install -e chatmaild
|
|
||||||
|
|
||||||
python3 -m venv chatmaild/venv
|
|
||||||
chatmaild/venv/bin/pip install pytest
|
|
||||||
chatmaild/venv/bin/pip install -e chatmaild
|
|
||||||
|
|
||||||
python3 -m venv online-tests/venv
|
|
||||||
online-tests/venv/bin/pip install pytest pytest-timeout pdbpp deltachat pytest-benchmark
|
|
||||||
|
|
||||||
python3 -m venv venv
|
|
||||||
venv/bin/pip install build
|
|
||||||
venv/bin/pip install 'setuptools>=68'
|
|
||||||
6
scripts/initenv.sh
Executable file
6
scripts/initenv.sh
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
python3 -m venv --upgrade-deps venv
|
||||||
|
|
||||||
|
venv/bin/pip install -e chatmaild
|
||||||
|
venv/bin/pip install -e cmdeploy
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user