mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 00:14:36 +00:00
Compare commits
154 Commits
dev-note
...
link2xt/py
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
88963bf1ad | ||
|
|
000fed7495 | ||
|
|
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 |
3
.github/workflows/ci.yaml
vendored
3
.github/workflows/ci.yaml
vendored
@@ -33,8 +33,5 @@ jobs:
|
|||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
- name: initialize with chatmail domain
|
|
||||||
run: cmdeploy init chat.example.org
|
|
||||||
|
|
||||||
# all other cmdeploy commands require a staging server
|
# all other cmdeploy commands require a staging server
|
||||||
# see https://github.com/deltachat/chatmail/issues/100
|
# see https://github.com/deltachat/chatmail/issues/100
|
||||||
|
|||||||
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
|
||||||
|
|
||||||
180
README.md
180
README.md
@@ -15,17 +15,10 @@ after which the initially specified password is required for using them.
|
|||||||
|
|
||||||
## Deploying your own chatmail server
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
We subsequently use `CHATMAIL_DOMAIN` as a placeholder for your fully qualified
|
We use `chat.example.org` as the chatmail domain in the following steps.
|
||||||
DNS domain name (FQDN), for example `chat.example.org`.
|
Please substitute it with your own domain.
|
||||||
|
|
||||||
1. Setup DNS `A` and `AAAA` records for your `CHATMAIL_DOMAIN`.
|
1. Install the `cmdeploy` command in a virtualenv
|
||||||
Verify that DNS is set and SSH root login works:
|
|
||||||
|
|
||||||
```
|
|
||||||
ssh root@CHATMAIL_DOMAIN
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Install the `cmdeploy` command in a virtualenv
|
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/deltachat/chatmail
|
git clone https://github.com/deltachat/chatmail
|
||||||
@@ -33,10 +26,18 @@ DNS domain name (FQDN), for example `chat.example.org`.
|
|||||||
scripts/initenv.sh
|
scripts/initenv.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Create chatmail configuration file `chatmail.ini`:
|
2. Create chatmail configuration file `chatmail.ini`:
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy init CHATMAIL_DOMAIN
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Setup first DNS records for your chatmail domain,
|
||||||
|
according to the hints provided by `cmdeploy init`.
|
||||||
|
Verify that SSH root login works:
|
||||||
|
|
||||||
|
```
|
||||||
|
ssh root@chat.example.org # <-- use your domain
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Deploy to the remote chatmail server:
|
4. Deploy to the remote chatmail server:
|
||||||
@@ -44,37 +45,85 @@ DNS domain name (FQDN), for example `chat.example.org`.
|
|||||||
```
|
```
|
||||||
scripts/cmdeploy run
|
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).
|
||||||
|
|
||||||
5. To output a DNS zone file from which you can transfer DNS records
|
### Other helpful commands:
|
||||||
to your DNS provider:
|
|
||||||
|
|
||||||
```
|
To check the status of your remotely running chatmail service:
|
||||||
scripts/cmdeploy dns
|
|
||||||
```
|
|
||||||
|
|
||||||
6. To check status of your remotely running chatmail service:
|
```
|
||||||
|
scripts/cmdeploy status
|
||||||
|
```
|
||||||
|
|
||||||
```
|
To check whether your DNS records are correct:
|
||||||
scripts/cmdeploy status
|
|
||||||
```
|
|
||||||
|
|
||||||
7. To test your chatmail service:
|
```
|
||||||
|
scripts/cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
```
|
To test whether your chatmail service is working correctly:
|
||||||
scripts/cmdeploy test
|
|
||||||
```
|
|
||||||
|
|
||||||
8. To benchmark your chatmail service:
|
```
|
||||||
|
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.
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy bench
|
|
||||||
```
|
|
||||||
|
|
||||||
### Refining the web pages
|
### Refining the web pages
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy webdev
|
scripts/cmdeploy webdev
|
||||||
```
|
```
|
||||||
|
|
||||||
This starts a local live development cycle for chatmail Web pages:
|
This starts a local live development cycle for chatmail Web pages:
|
||||||
@@ -88,75 +137,26 @@ This starts a local live development cycle for chatmail Web pages:
|
|||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
- Starts a browser window automatically where you can "refresh" as needed.
|
||||||
|
|
||||||
|
|
||||||
### Home page and getting started for users
|
|
||||||
|
|
||||||
`cmdeploy run` sets up mail services,
|
|
||||||
and also creates default static Web pages and deploys them:
|
|
||||||
|
|
||||||
- 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.
|
|
||||||
|
|
||||||
|
|
||||||
### Ports
|
|
||||||
|
|
||||||
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
|
||||||
Dovecot listens on ports 143(imap) and 993 (imaps).
|
|
||||||
|
|
||||||
Delta Chat will, however, discover all ports and configurations
|
|
||||||
automatically by reading the `autoconfig.xml` file from the chatmail instance.
|
|
||||||
|
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
## Emergency Commands to disable automatic account creation
|
||||||
|
|
||||||
If you need to stop account creation,
|
If you need to stop account creation,
|
||||||
e.g. because some script is wildly creating accounts, run:
|
e.g. because some script is wildly creating accounts,
|
||||||
|
login to the server with ssh and run:
|
||||||
|
|
||||||
|
```
|
||||||
touch /etc/chatmail-nocreate
|
touch /etc/chatmail-nocreate
|
||||||
|
```
|
||||||
|
|
||||||
While this file is present, account creation will be blocked.
|
While this file is present, account creation will be blocked.
|
||||||
|
|
||||||
|
### Ports
|
||||||
|
|
||||||
## Running tests and benchmarks (offline and online)
|
[Postfix](http://www.postfix.org/) listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
||||||
|
[Dovecot](https://www.dovecot.org/) listens on ports 143 (imap) and 993 (imaps).
|
||||||
1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows
|
[nginx](https://www.nginx.com/) listens on port 443 (https).
|
||||||
to login to the chatmail instance server.
|
[acmetool](https://hlandau.github.io/acmetool/) listens on port 80 (http).
|
||||||
|
|
||||||
2. To run local and online tests:
|
|
||||||
|
|
||||||
scripts/test.sh
|
|
||||||
|
|
||||||
3. To run benchmarks against your chatmail instance:
|
|
||||||
|
|
||||||
scripts/bench.sh
|
|
||||||
|
|
||||||
|
|
||||||
## Development Background for chatmail instances
|
|
||||||
|
|
||||||
This repository drives the development of "chatmail instances",
|
|
||||||
comprised of minimal setups of
|
|
||||||
|
|
||||||
- [postfix smtp server](https://www.postfix.org)
|
|
||||||
- [dovecot imap server](https://www.dovecot.org)
|
|
||||||
|
|
||||||
as well as two 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 instance
|
|
||||||
and is integrated into postfix's outbound mail pipelines.
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -8,6 +8,8 @@ version = "0.2"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
"iniconfig",
|
||||||
|
"deltachat-rpc-server",
|
||||||
|
"deltachat-rpc-client",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -19,6 +21,8 @@ where = ['src']
|
|||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
|
echobot = "chatmaild.echo:main"
|
||||||
|
chatmail-metrics = "chatmaild.metrics:main"
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
|||||||
@@ -46,6 +46,7 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
len(localpart) > config.username_max_length
|
len(localpart) > config.username_max_length
|
||||||
or len(localpart) < config.username_min_length
|
or len(localpart) < config.username_min_length
|
||||||
):
|
):
|
||||||
|
if localpart != "echo":
|
||||||
logging.warning(
|
logging.warning(
|
||||||
"localpart %s has to be between %s and %s chars long",
|
"localpart %s has to be between %s and %s chars long",
|
||||||
localpart,
|
localpart,
|
||||||
@@ -90,23 +91,56 @@ def lookup_passdb(db, config: Config, user, cleartext_password):
|
|||||||
VALUES (?, ?, ?)"""
|
VALUES (?, ?, ?)"""
|
||||||
conn.execute(q, (user, encrypted_password, int(time.time())))
|
conn.execute(q, (user, encrypted_password, int(time.time())))
|
||||||
return dict(
|
return dict(
|
||||||
home=f"/home/vmail/{user}",
|
home=f"/home/vmail/mail/{config.mail_domain}/{user}",
|
||||||
uid="vmail",
|
uid="vmail",
|
||||||
gid="vmail",
|
gid="vmail",
|
||||||
password=encrypted_password,
|
password=encrypted_password,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def split_and_unescape(s):
|
||||||
|
"""Split strings using double quote as a separator and backslash as escape character
|
||||||
|
into parts."""
|
||||||
|
|
||||||
|
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:
|
||||||
|
out += c
|
||||||
|
i += 1
|
||||||
|
yield out
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_request(msg, db, config: Config):
|
def handle_dovecot_request(msg, db, config: Config):
|
||||||
short_command = msg[0]
|
short_command = msg[0]
|
||||||
if short_command == "L": # LOOKUP
|
if short_command == "L": # LOOKUP
|
||||||
parts = msg[1:].split("\t")
|
parts = msg[1:].split("\t")
|
||||||
keyname, user = parts[:2]
|
|
||||||
namespace, type, *args = keyname.split("/")
|
# Dovecot <2.3.17 has only one part,
|
||||||
|
# do not attempt to read any other parts for compatibility.
|
||||||
|
keyname = parts[0]
|
||||||
|
|
||||||
|
namespace, type, args = keyname.split("/", 2)
|
||||||
|
args = list(split_and_unescape(args))
|
||||||
|
|
||||||
reply_command = "F"
|
reply_command = "F"
|
||||||
res = ""
|
res = ""
|
||||||
if namespace == "shared":
|
if namespace == "shared":
|
||||||
if type == "userdb":
|
if type == "userdb":
|
||||||
|
user = args[0]
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
res = lookup_userdb(db, user)
|
res = lookup_userdb(db, user)
|
||||||
if res:
|
if res:
|
||||||
@@ -114,6 +148,7 @@ def handle_dovecot_request(msg, db, config: Config):
|
|||||||
else:
|
else:
|
||||||
reply_command = "N"
|
reply_command = "N"
|
||||||
elif type == "passdb":
|
elif type == "passdb":
|
||||||
|
user = args[1]
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
res = lookup_passdb(db, config, user, cleartext_password=args[0])
|
res = lookup_passdb(db, config, user, cleartext_password=args[0])
|
||||||
if res:
|
if res:
|
||||||
@@ -125,6 +160,19 @@ def handle_dovecot_request(msg, db, config: Config):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def handle_dovecot_protocol(rfile, wfile, db: Database, config: Config):
|
||||||
|
while True:
|
||||||
|
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):
|
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
||||||
request_queue_size = 100
|
request_queue_size = 100
|
||||||
|
|
||||||
@@ -138,16 +186,7 @@ def main():
|
|||||||
class Handler(StreamRequestHandler):
|
class Handler(StreamRequestHandler):
|
||||||
def handle(self):
|
def handle(self):
|
||||||
try:
|
try:
|
||||||
while True:
|
handle_dovecot_protocol(self.rfile, self.wfile, db, config)
|
||||||
msg = self.rfile.readline().strip().decode()
|
|
||||||
if not msg:
|
|
||||||
break
|
|
||||||
res = handle_dovecot_request(msg, db, config)
|
|
||||||
if res:
|
|
||||||
self.wfile.write(res.encode("ascii"))
|
|
||||||
self.wfile.flush()
|
|
||||||
else:
|
|
||||||
logging.warn("request had no answer: %r", msg)
|
|
||||||
except Exception:
|
except Exception:
|
||||||
logging.exception("Exception in the handler")
|
logging.exception("Exception in the handler")
|
||||||
raise
|
raise
|
||||||
|
|||||||
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
|
||||||
@@ -17,8 +17,8 @@ max_user_send_per_minute = 60
|
|||||||
# maximum mailbox size of a chatmail account
|
# maximum mailbox size of a chatmail account
|
||||||
max_mailbox_size = 100M
|
max_mailbox_size = 100M
|
||||||
|
|
||||||
# time after which seen mails are deleted
|
# days after which mails are unconditionally deleted
|
||||||
delete_mails_after = 40d
|
delete_mails_after = 40
|
||||||
|
|
||||||
# minimum length a username must have
|
# minimum length a username must have
|
||||||
username_min_length = 9
|
username_min_length = 9
|
||||||
@@ -33,7 +33,7 @@ password_min_length = 9
|
|||||||
passthrough_senders =
|
passthrough_senders =
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
passthrough_recipients =
|
passthrough_recipients = xstore@testrun.org groupsbot@hispanilandia.net
|
||||||
|
|
||||||
#
|
#
|
||||||
# Deployment Details
|
# Deployment Details
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
|
|
||||||
[privacy]
|
[privacy]
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org
|
passthrough_recipients = privacy@testrun.org xstore@testrun.org groupsbot@hispanilandia.net
|
||||||
|
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
|
|||||||
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()
|
||||||
@@ -4,16 +4,22 @@
|
|||||||
|
|
||||||
import json
|
import json
|
||||||
import random
|
import random
|
||||||
|
import secrets
|
||||||
|
import string
|
||||||
|
|
||||||
from chatmaild.config import read_config, Config
|
from chatmaild.config import read_config, Config
|
||||||
|
|
||||||
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
||||||
|
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
||||||
|
ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(config: Config):
|
def create_newemail_dict(config: Config):
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
||||||
user = "".join(random.choices(alphanumeric, k=config.username_min_length))
|
password = "".join(
|
||||||
password = "".join(random.choices(alphanumeric, k=config.password_min_length + 3))
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
|
for _ in range(config.password_min_length + 3)
|
||||||
|
)
|
||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ Date: Sun, 15 Oct 2023 16:41:44 +0000
|
|||||||
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
Chat-Version: 1.0
|
Chat-Version: 1.0
|
||||||
Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
||||||
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
||||||
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
import random
|
import random
|
||||||
|
from pathlib import Path
|
||||||
|
import os
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import itertools
|
import itertools
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
@@ -57,7 +59,12 @@ def db(tmpdir):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildata(request):
|
def maildata(request):
|
||||||
|
try:
|
||||||
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
||||||
|
except TypeError:
|
||||||
|
# in python3.9 or lower, the above doesn't work, so we get datadir this way:
|
||||||
|
datadir = Path(os.getcwd()).joinpath("chatmaild/src/chatmaild/tests/mail-data")
|
||||||
|
|
||||||
assert datadir.exists(), datadir
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
def maildata(name, from_addr, to_addr):
|
def maildata(name, from_addr, to_addr):
|
||||||
|
|||||||
@@ -24,9 +24,9 @@ def test_read_config_testrun(make_config):
|
|||||||
assert config.postfix_reinject_port == 10025
|
assert config.postfix_reinject_port == 10025
|
||||||
assert config.max_user_send_per_minute == 60
|
assert config.max_user_send_per_minute == 60
|
||||||
assert config.max_mailbox_size == "100M"
|
assert config.max_mailbox_size == "100M"
|
||||||
assert config.delete_mails_after == "40d"
|
assert config.delete_mails_after == "40"
|
||||||
assert config.username_min_length == 9
|
assert config.username_min_length == 9
|
||||||
assert config.username_max_length == 9
|
assert config.username_max_length == 9
|
||||||
assert config.password_min_length == 9
|
assert config.password_min_length == 9
|
||||||
assert config.passthrough_recipients == ["privacy@testrun.org"]
|
assert "privacy@testrun.org" in config.passthrough_recipients
|
||||||
assert config.passthrough_senders == []
|
assert config.passthrough_senders == []
|
||||||
|
|||||||
@@ -1,11 +1,17 @@
|
|||||||
|
import io
|
||||||
import json
|
import json
|
||||||
import pytest
|
import pytest
|
||||||
import threading
|
|
||||||
import queue
|
import queue
|
||||||
|
import threading
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
import chatmaild.doveauth
|
import chatmaild.doveauth
|
||||||
from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_request
|
from chatmaild.doveauth import (
|
||||||
|
get_user_data,
|
||||||
|
lookup_passdb,
|
||||||
|
handle_dovecot_request,
|
||||||
|
handle_dovecot_protocol,
|
||||||
|
)
|
||||||
from chatmaild.database import DBError
|
from chatmaild.database import DBError
|
||||||
|
|
||||||
|
|
||||||
@@ -52,19 +58,32 @@ def test_too_high_db_version(db):
|
|||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request(db, example_config):
|
def test_handle_dovecot_request(db, example_config):
|
||||||
|
# Test that password can contain ", ', \ and /
|
||||||
msg = (
|
msg = (
|
||||||
"Lshared/passdb/laksjdlaksjdlaksjdlk12j3l1k2j3123/"
|
'Lshared/passdb/laksjdlaksjdlak\\\\sjdlk\\"12j\\\'3l1/k2j3123"'
|
||||||
"some42123@chat.example.org\tsome42123@chat.example.org"
|
"some42123@chat.example.org\tsome42123@chat.example.org"
|
||||||
)
|
)
|
||||||
res = handle_dovecot_request(msg, db, example_config)
|
res = handle_dovecot_request(msg, db, example_config)
|
||||||
assert res
|
assert res
|
||||||
assert res[0] == "O" and res.endswith("\n")
|
assert res[0] == "O" and res.endswith("\n")
|
||||||
userdata = json.loads(res[1:].strip())
|
userdata = json.loads(res[1:].strip())
|
||||||
assert userdata["home"] == "/home/vmail/some42123@chat.example.org"
|
assert (
|
||||||
|
userdata["home"]
|
||||||
|
== "/home/vmail/mail/chat.example.org/some42123@chat.example.org"
|
||||||
|
)
|
||||||
assert userdata["uid"] == userdata["gid"] == "vmail"
|
assert userdata["uid"] == userdata["gid"] == "vmail"
|
||||||
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_protocol(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):
|
def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
||||||
num_threads = 50
|
num_threads = 50
|
||||||
req_per_thread = 5
|
req_per_thread = 5
|
||||||
|
|||||||
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
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
"""
|
"""
|
||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import subprocess
|
import subprocess
|
||||||
@@ -84,14 +85,28 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"),
|
||||||
|
dest="/etc/cron.d/chatmail-metrics",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={
|
||||||
|
"mail_domain": config.mail_domain,
|
||||||
|
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
# install systemd units
|
# install systemd units
|
||||||
for fn in (
|
for fn in (
|
||||||
"doveauth",
|
"doveauth",
|
||||||
"filtermail",
|
"filtermail",
|
||||||
|
"echobot",
|
||||||
):
|
):
|
||||||
params = dict(
|
params = dict(
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
config_path=remote_chatmail_inipath,
|
config_path=remote_chatmail_inipath,
|
||||||
|
remote_venv_dir=remote_venv_dir,
|
||||||
)
|
)
|
||||||
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
||||||
content = source_path.read_text().format(**params).encode()
|
content = source_path.read_text().format(**params).encode()
|
||||||
@@ -112,10 +127,24 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
||||||
"""Configures OpenDKIM"""
|
"""Configures OpenDKIM"""
|
||||||
need_restart = False
|
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(
|
main_config = files.template(
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
||||||
dest="/etc/opendkim.conf",
|
dest="/etc/opendkim.conf",
|
||||||
@@ -126,6 +155,24 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
screen_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/screen.lua"),
|
||||||
|
dest="/etc/opendkim/screen.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= screen_script.changed
|
||||||
|
|
||||||
|
final_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/final.lua"),
|
||||||
|
dest="/etc/opendkim/final.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= final_script.changed
|
||||||
|
|
||||||
files.directory(
|
files.directory(
|
||||||
name="Add opendkim directory to /etc",
|
name="Add opendkim directory to /etc",
|
||||||
path="/etc/opendkim",
|
path="/etc/opendkim",
|
||||||
@@ -154,7 +201,6 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
)
|
)
|
||||||
need_restart |= signing_table.changed
|
need_restart |= signing_table.changed
|
||||||
|
|
||||||
files.directory(
|
files.directory(
|
||||||
name="Add opendkim socket directory to /var/spool/postfix",
|
name="Add opendkim socket directory to /var/spool/postfix",
|
||||||
path="/var/spool/postfix/opendkim",
|
path="/var/spool/postfix/opendkim",
|
||||||
@@ -164,6 +210,11 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|||||||
present=True,
|
present=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="apt install opendkim opendkim-tools",
|
||||||
|
packages=["opendkim", "opendkim-tools"],
|
||||||
|
)
|
||||||
|
|
||||||
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
||||||
server.shell(
|
server.shell(
|
||||||
name="Generate OpenDKIM domain keys",
|
name="Generate OpenDKIM domain keys",
|
||||||
@@ -240,6 +291,27 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= master_config.changed
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
|
header_cleanup = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/submission_header_cleanup"
|
||||||
|
),
|
||||||
|
dest="/etc/postfix/submission_header_cleanup",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= header_cleanup.changed
|
||||||
|
|
||||||
|
# Login map that 1:1 maps email address to login.
|
||||||
|
login_map = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/login_map"),
|
||||||
|
dest="/etc/postfix/login_map",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= login_map.changed
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
@@ -345,45 +417,51 @@ def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _remove_rspamd() -> None:
|
||||||
|
"""Remove rspamd"""
|
||||||
|
apt.packages(name="Remove rspamd", packages="rspamd", present=False)
|
||||||
|
|
||||||
|
|
||||||
def check_config(config):
|
def check_config(config):
|
||||||
mail_domain = config.mail_domain
|
mail_domain = config.mail_domain
|
||||||
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
for value in config.__dict__.values():
|
for value in config.__dict__.values():
|
||||||
if any(x in value for x in blocked_words):
|
if any(x in str(value) for x in blocked_words):
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
)
|
)
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
def deploy_chatmail(config_path: Path) -> None:
|
||||||
"""Deploy a chat-mail instance.
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
:param mail_domain: domain part of your future email addresses
|
:param config_path: path to chatmail.ini
|
||||||
:param mail_server: the DNS name under which your mail server is reachable
|
|
||||||
:param dkim_selector:
|
|
||||||
"""
|
"""
|
||||||
|
config = read_config(config_path)
|
||||||
|
check_config(config)
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
|
||||||
from .www import build_webpages
|
from .www import build_webpages
|
||||||
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
|
||||||
server.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,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Run local DNS resolver `unbound`.
|
# Run local DNS resolver `unbound`.
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
# to use 127.0.0.1 as the resolver.
|
# to use 127.0.0.1 as the resolver.
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install unbound",
|
name="Install unbound",
|
||||||
packages="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(
|
systemd.service(
|
||||||
name="Start and enable unbound",
|
name="Start and enable unbound",
|
||||||
@@ -393,7 +471,10 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
)
|
)
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
# Deploy acmetool to have TLS certificates.
|
||||||
deploy_acmetool(nginx_hook=True, domains=[mail_server, f"mta-sts.{mail_server}"])
|
deploy_acmetool(
|
||||||
|
nginx_hook=True,
|
||||||
|
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
||||||
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Postfix",
|
name="Install Postfix",
|
||||||
@@ -405,14 +486,6 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install OpenDKIM",
|
|
||||||
packages=[
|
|
||||||
"opendkim",
|
|
||||||
"opendkim-tools",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install nginx",
|
name="Install nginx",
|
||||||
packages=["nginx"],
|
packages=["nginx"],
|
||||||
@@ -423,11 +496,7 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
packages=["fcgiwrap"],
|
packages=["fcgiwrap"],
|
||||||
)
|
)
|
||||||
|
|
||||||
pkg_root = importlib.resources.files(__package__)
|
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
||||||
chatmail_ini = pkg_root.joinpath("../../../chatmail.ini").resolve()
|
|
||||||
config = read_config(chatmail_ini)
|
|
||||||
check_config(config)
|
|
||||||
www_path = pkg_root.joinpath("../../../www").resolve()
|
|
||||||
|
|
||||||
build_dir = www_path.joinpath("build")
|
build_dir = www_path.joinpath("build")
|
||||||
src_dir = www_path.joinpath("src")
|
src_dir = www_path.joinpath("src")
|
||||||
@@ -438,10 +507,12 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
||||||
postfix_need_restart = _configure_postfix(config, debug=debug)
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
|
||||||
mta_sts_need_restart = _install_mta_sts_daemon()
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
nginx_need_restart = _configure_nginx(mail_domain)
|
nginx_need_restart = _configure_nginx(mail_domain)
|
||||||
|
|
||||||
|
_remove_rspamd()
|
||||||
|
opendkim_need_restart = _configure_opendkim(mail_domain, "opendkim")
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable OpenDKIM",
|
name="Start and enable OpenDKIM",
|
||||||
service="opendkim.service",
|
service="opendkim.service",
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
from pyinfra.operations import apt, files, 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=[]):
|
||||||
@@ -46,6 +48,30 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
service_file = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"acmetool-redirector.service"
|
||||||
|
),
|
||||||
|
dest="/etc/systemd/system/acmetool-redirector.service",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
if host.get_fact(SystemdStatus).get("nginx.service"):
|
||||||
|
systemd.service(
|
||||||
|
name="Stop nginx service to free port 80",
|
||||||
|
service="nginx",
|
||||||
|
running=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Setup acmetool-redirector service",
|
||||||
|
service="acmetool-redirector.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=service_file.changed,
|
||||||
|
)
|
||||||
|
|
||||||
server.shell(
|
server.shell(
|
||||||
name=f"Request certificate for: { ', '.join(domains) }",
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
commands=[f"acmetool want { ' '.join(domains)}"],
|
commands=[f"acmetool want { ' '.join(domains)}"],
|
||||||
|
|||||||
11
cmdeploy/src/cmdeploy/acmetool/acmetool-redirector.service
Normal file
11
cmdeploy/src/cmdeploy/acmetool/acmetool-redirector.service
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=acmetool HTTP redirector
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=notify
|
||||||
|
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -1,12 +1,15 @@
|
|||||||
|
{chatmail_domain}. A {ipv4}
|
||||||
|
{chatmail_domain}. AAAA {ipv6}
|
||||||
{chatmail_domain}. MX 10 {chatmail_domain}.
|
{chatmail_domain}. MX 10 {chatmail_domain}.
|
||||||
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
||||||
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
||||||
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
||||||
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
||||||
{chatmail_domain}. IN CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
{chatmail_domain}. CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
||||||
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
||||||
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;adkim=r;aspf=r"
|
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
||||||
_mta-sts.{chatmail_domain}. IN TXT "v=STSv1; id={sts_id}"
|
_mta-sts.{chatmail_domain}. TXT "v=STSv1; id={sts_id}"
|
||||||
mta-sts.{chatmail_domain}. IN CNAME {chatmail_domain}.
|
mta-sts.{chatmail_domain}. CNAME {chatmail_domain}.
|
||||||
_smtp._tls.{chatmail_domain}. IN TXT "v=TLSRPTv1;rua=mailto:{email}"
|
www.{chatmail_domain}. CNAME {chatmail_domain}.
|
||||||
{dkim_entry}
|
{dkim_entry}
|
||||||
|
_adsp._domainkey.{chatmail_domain}. TXT "dkim=discardable"
|
||||||
|
|||||||
@@ -2,8 +2,8 @@
|
|||||||
Provides the `cmdeploy` entry point function,
|
Provides the `cmdeploy` entry point function,
|
||||||
along with command line option and subcommand parsing.
|
along with command line option and subcommand parsing.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import datetime
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
@@ -15,6 +15,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
from termcolor import colored
|
from termcolor import colored
|
||||||
from chatmaild.config import read_config, write_initial_config
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
from cmdeploy.dns import show_dns, check_necessary_dns
|
||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
@@ -32,11 +33,16 @@ def init_cmd_options(parser):
|
|||||||
|
|
||||||
def init_cmd(args, out):
|
def init_cmd(args, out):
|
||||||
"""Initialize chatmail config file."""
|
"""Initialize chatmail config file."""
|
||||||
|
mail_domain = args.chatmail_domain
|
||||||
if args.inipath.exists():
|
if args.inipath.exists():
|
||||||
out.red(f"Path exists, not modifying: {args.inipath}")
|
print(f"Path exists, not modifying: {args.inipath}")
|
||||||
raise SystemExit(1)
|
else:
|
||||||
write_initial_config(args.inipath, args.chatmail_domain)
|
write_initial_config(args.inipath, mail_domain)
|
||||||
out.green(f"created config file for {args.chatmail_domain} in {args.inipath}")
|
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
||||||
|
check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def run_cmd_options(parser):
|
def run_cmd_options(parser):
|
||||||
@@ -50,47 +56,35 @@ def run_cmd_options(parser):
|
|||||||
|
|
||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""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 = os.environ.copy()
|
||||||
env["CHATMAIL_DOMAIN"] = args.config.mail_domain
|
env["CHATMAIL_INI"] = args.inipath
|
||||||
deploy_path = "cmdeploy/src/cmdeploy/deploy.py"
|
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path}"
|
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path}"
|
||||||
|
|
||||||
out.check_call(cmd, env=env)
|
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):
|
def dns_cmd(args, out):
|
||||||
"""Generate dns zone file."""
|
"""Generate dns zone file."""
|
||||||
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
exit_code = show_dns(args, out)
|
||||||
ssh = f"ssh root@{args.config.mail_domain}"
|
exit(exit_code)
|
||||||
|
|
||||||
def read_dkim_entries(entry):
|
|
||||||
lines = []
|
|
||||||
for line in entry.split("\n"):
|
|
||||||
if line.startswith(";") or not line.strip():
|
|
||||||
continue
|
|
||||||
line = line.replace("\t", " ")
|
|
||||||
lines.append(line)
|
|
||||||
return "\n".join(lines)
|
|
||||||
|
|
||||||
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
|
||||||
dkim_entry = read_dkim_entries(out.shell_output(f"{ssh} -- opendkim-genzone -F"))
|
|
||||||
|
|
||||||
out(
|
|
||||||
f"[writing {args.config.mail_domain} zone data (using space as separator) to stdout output]",
|
|
||||||
green=True,
|
|
||||||
)
|
|
||||||
print(
|
|
||||||
template.read_text()
|
|
||||||
.format(
|
|
||||||
acme_account_url=acme_account_url,
|
|
||||||
email=f"root@{args.config.mail_domain}",
|
|
||||||
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
|
||||||
chatmail_domain=args.config.mail_domain,
|
|
||||||
dkim_entry=dkim_entry,
|
|
||||||
)
|
|
||||||
.strip()
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
def status_cmd(args, out):
|
||||||
@@ -219,9 +213,15 @@ class Out:
|
|||||||
color = "red" if red else ("green" if green else None)
|
color = "red" if red else ("green" if green else None)
|
||||||
print(colored(msg, color), file=file)
|
print(colored(msg, color), file=file)
|
||||||
|
|
||||||
def shell_output(self, arg):
|
def shell_output(self, arg, no_print=False, timeout=10):
|
||||||
|
if not no_print:
|
||||||
self(f"[$ {arg}]", file=sys.stderr)
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
return subprocess.check_output(arg, shell=True).decode()
|
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):
|
def check_call(self, arg, env=None, quiet=False):
|
||||||
if not quiet:
|
if not quiet:
|
||||||
|
|||||||
@@ -1,18 +1,16 @@
|
|||||||
import os
|
import os
|
||||||
|
import importlib.resources
|
||||||
import pyinfra
|
import pyinfra
|
||||||
from cmdeploy import deploy_chatmail
|
from cmdeploy import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
mail_domain = os.getenv("CHATMAIL_DOMAIN")
|
config_path = os.getenv(
|
||||||
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
|
"CHATMAIL_INI",
|
||||||
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "dkim")
|
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
||||||
|
)
|
||||||
|
|
||||||
assert mail_domain
|
deploy_chatmail(config_path)
|
||||||
assert mail_server
|
|
||||||
assert dkim_selector
|
|
||||||
|
|
||||||
deploy_chatmail(mail_domain, mail_server, dkim_selector)
|
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
if pyinfra.is_cli:
|
||||||
|
|||||||
209
cmdeploy/src/cmdeploy/dns.py
Normal file
209
cmdeploy/src/cmdeploy/dns.py
Normal file
@@ -0,0 +1,209 @@
|
|||||||
|
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) -> Optional[str]:
|
||||||
|
"""Get a DNS entry"""
|
||||||
|
dig_result = self.shell(f"dig -r -q {domain} -t {typ} +short")
|
||||||
|
line = dig_result.partition("\n")[0]
|
||||||
|
if line:
|
||||||
|
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)
|
||||||
|
|
||||||
|
def read_dkim_entries(entry):
|
||||||
|
lines = []
|
||||||
|
for line in entry.split("\n"):
|
||||||
|
if line.startswith(";") or not line.strip():
|
||||||
|
continue
|
||||||
|
line = line.replace("\t", " ")
|
||||||
|
lines.append(line)
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
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_entry = read_dkim_entries(out.shell_output(f"{ssh} -- opendkim-genzone -F"))
|
||||||
|
|
||||||
|
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
|
||||||
|
started_dkim_parsing = False
|
||||||
|
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
|
||||||
|
if current != value:
|
||||||
|
to_print.append(line)
|
||||||
|
if "IN TXT ( " in line:
|
||||||
|
started_dkim_parsing = True
|
||||||
|
dkim_lines = [line]
|
||||||
|
if started_dkim_parsing and line.startswith('"'):
|
||||||
|
dkim_lines.append(" " + line)
|
||||||
|
domain, data = "\n".join(dkim_lines).split(" IN TXT ")
|
||||||
|
current = dns.get("TXT", domain.strip()[:-1])
|
||||||
|
if current:
|
||||||
|
current = "( %s )" % (current.replace('" "', '"\n "'))
|
||||||
|
if current.replace(";", "\\;") != data:
|
||||||
|
to_print.append(dkim_entry)
|
||||||
|
else:
|
||||||
|
to_print.append(dkim_entry)
|
||||||
|
|
||||||
|
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
|
||||||
@@ -1,5 +1,10 @@
|
|||||||
uri = proxy:/run/dovecot/doveauth.socket:auth
|
uri = proxy:/run/dovecot/doveauth.socket:auth
|
||||||
iterate_disable = yes
|
iterate_disable = yes
|
||||||
default_pass_scheme = plain
|
default_pass_scheme = plain
|
||||||
password_key = passdb/%w/%u
|
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
||||||
user_key = userdb/%u
|
# 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
|
||||||
|
|||||||
@@ -13,13 +13,15 @@ auth_cache_size = 100M
|
|||||||
mail_debug = yes
|
mail_debug = yes
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
mail_server_admin = mailto:root@{{ config.mail_domain }}
|
||||||
|
mail_server_comment = Chatmail server
|
||||||
|
|
||||||
mail_plugins = quota
|
mail_plugins = quota
|
||||||
|
|
||||||
# these are the capabilities Delta Chat cares about actually
|
# these are the capabilities Delta Chat cares about actually
|
||||||
# so let's keep the network overhead per login small
|
# so let's keep the network overhead per login small
|
||||||
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
||||||
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY
|
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY METADATA
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
# Authentication for system users.
|
||||||
@@ -73,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 {
|
||||||
|
|||||||
@@ -1,4 +1,10 @@
|
|||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE {{ config.delete_mails_after }} INBOX
|
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE {{ config.delete_mails_after }} Deltachat
|
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE {{ config.delete_mails_after }} Trash
|
# or in any IMAP subfolder
|
||||||
2 30 * * * dovecot doveadm purge -A
|
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
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import io
|
|||||||
|
|
||||||
|
|
||||||
def gen_qr_png_data(maildomain):
|
def gen_qr_png_data(maildomain):
|
||||||
url = f"DCACCOUNT:https://{maildomain}/cgi-bin/newemail.py"
|
url = f"DCACCOUNT:https://{maildomain}/new"
|
||||||
image = gen_qr(maildomain, url)
|
image = gen_qr(maildomain, url)
|
||||||
temp = io.BytesIO()
|
temp = io.BytesIO()
|
||||||
image.save(temp, format="png")
|
image.save(temp, format="png")
|
||||||
|
|||||||
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
|
||||||
@@ -41,15 +41,44 @@ http {
|
|||||||
try_files $uri $uri/ =404;
|
try_files $uri $uri/ =404;
|
||||||
}
|
}
|
||||||
|
|
||||||
# add cgi-bin support
|
location /metrics {
|
||||||
include /usr/share/doc/fcgiwrap/examples/nginx.conf;
|
default_type text/plain;
|
||||||
}
|
}
|
||||||
server {
|
|
||||||
listen 80 default_server;
|
|
||||||
listen [::]:80 default_server;
|
|
||||||
server_name _;
|
|
||||||
|
|
||||||
return 301 https://$host$request_uri;
|
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 +1 @@
|
|||||||
dkim._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/dkim.private
|
{{ config.opendkim_selector }}._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/{{ config.opendkim_selector }}.private
|
||||||
|
|||||||
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
|
||||||
@@ -8,10 +8,12 @@ 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
|
||||||
@@ -22,6 +24,15 @@ KeyFile /etc/dkimkeys/{{ config.opendkim_selector }}.private
|
|||||||
KeyTable /etc/dkimkeys/KeyTable
|
KeyTable /etc/dkimkeys/KeyTable
|
||||||
SigningTable refile:/etc/dkimkeys/SigningTable
|
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
|
||||||
# user (for example, Postfix). You may need to add user "postfix" to group
|
# user (for example, Postfix). You may need to add user "postfix" to group
|
||||||
@@ -29,22 +40,10 @@ SigningTable refile:/etc/dkimkeys/SigningTable
|
|||||||
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}
|
||||||
@@ -11,9 +11,8 @@ append_dot_mydomain = no
|
|||||||
|
|
||||||
readme_directory = no
|
readme_directory = no
|
||||||
|
|
||||||
# See http://www.postfix.org/COMPATIBILITY_README.html -- default to 2 on
|
# See http://www.postfix.org/COMPATIBILITY_README.html
|
||||||
# fresh installs.
|
compatibility_level = 3.6
|
||||||
compatibility_level = 2
|
|
||||||
|
|
||||||
# TLS parameters
|
# TLS parameters
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
@@ -24,6 +23,31 @@ smtp_tls_CApath=/etc/ssl/certs
|
|||||||
smtp_tls_security_level=may
|
smtp_tls_security_level=may
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
smtp_tls_policy_maps = 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
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
myhostname = {{ config.mail_domain }}
|
myhostname = {{ config.mail_domain }}
|
||||||
@@ -47,5 +71,9 @@ inet_protocols = all
|
|||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
virtual_mailbox_domains = {{ config.mail_domain }}
|
virtual_mailbox_domains = {{ config.mail_domain }}
|
||||||
|
|
||||||
smtpd_milters = unix:opendkim/opendkim.sock
|
mua_client_restrictions = permit_sasl_authenticated, reject
|
||||||
non_smtpd_milters = $smtpd_milters
|
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
|
||||||
|
|||||||
@@ -11,13 +11,10 @@
|
|||||||
# ==========================================================================
|
# ==========================================================================
|
||||||
{% if debug == true %}
|
{% if debug == true %}
|
||||||
smtp inet n - y - - smtpd -v
|
smtp inet n - y - - smtpd -v
|
||||||
{% else %}
|
{%- else %}
|
||||||
smtp inet n - y - - smtpd
|
smtp inet n - y - - smtpd
|
||||||
{% endif %}
|
{%- endif %}
|
||||||
#smtp inet n - y - 1 postscreen
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
#smtpd pass - - y - - smtpd
|
|
||||||
#dnsblog unix - - y - 0 dnsblog
|
|
||||||
#tlsproxy unix - - y - 0 tlsproxy
|
|
||||||
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
|
||||||
@@ -34,6 +31,7 @@ submission inet n - y - - smtpd
|
|||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
smtps inet n - y - - 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
|
||||||
@@ -50,6 +48,7 @@ smtps inet n - y - - smtpd
|
|||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
#628 inet n - y - - qmqpd
|
#628 inet n - y - - qmqpd
|
||||||
pickup unix n - y 60 1 pickup
|
pickup unix n - y 60 1 pickup
|
||||||
cleanup unix n - y - 0 cleanup
|
cleanup unix n - y - 0 cleanup
|
||||||
@@ -80,3 +79,14 @@ filter unix - n n - - lmtp
|
|||||||
# Local SMTP server for reinjecting filered mail.
|
# Local SMTP server for reinjecting filered mail.
|
||||||
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
||||||
-o syslog_name=postfix/reinject
|
-o syslog_name=postfix/reinject
|
||||||
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
|
-o 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
|
||||||
|
|||||||
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
|
||||||
@@ -2,6 +2,16 @@ import pytest
|
|||||||
import threading
|
import threading
|
||||||
import queue
|
import queue
|
||||||
|
|
||||||
|
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):
|
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
||||||
"""Test a) that an initial login creates a user automatically
|
"""Test a) that an initial login creates a user automatically
|
||||||
|
|||||||
@@ -9,8 +9,17 @@ def test_gen_qr_png_data(maildomain):
|
|||||||
|
|
||||||
|
|
||||||
def test_fastcgi_working(maildomain, chatmail_config):
|
def test_fastcgi_working(maildomain, chatmail_config):
|
||||||
url = f"https://{maildomain}/cgi-bin/newemail.py"
|
url = f"https://{maildomain}/new"
|
||||||
print(url)
|
print(url)
|
||||||
res = requests.post(url)
|
res = requests.post(url)
|
||||||
assert maildomain in res.json().get("email")
|
assert maildomain in res.json().get("email")
|
||||||
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
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)
|
||||||
|
|||||||
@@ -42,6 +42,28 @@ def test_reject_forged_from(cmsetup, maildata, gencreds, lp, forgeaddr):
|
|||||||
assert "500" in str(e.value)
|
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
|
@pytest.mark.slow
|
||||||
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
||||||
"""Test that the per-account send-mail limit is exceeded."""
|
"""Test that the per-account send-mail limit is exceeded."""
|
||||||
@@ -61,3 +83,18 @@ def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
|||||||
assert b"4.7.1: Too much mail from" in outcome[1]
|
assert b"4.7.1: Too much mail from" in outcome[1]
|
||||||
return
|
return
|
||||||
pytest.fail("Rate limit was not exceeded")
|
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
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
import time
|
import time
|
||||||
import re
|
import re
|
||||||
import random
|
import random
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
import requests
|
||||||
|
import ipaddress
|
||||||
|
|
||||||
|
|
||||||
class TestEndToEndDeltaChat:
|
class TestEndToEndDeltaChat:
|
||||||
@@ -119,3 +122,29 @@ class TestEndToEndDeltaChat:
|
|||||||
for msg in msgs:
|
for msg in msgs:
|
||||||
assert "error" not in m.get_message_info()
|
assert "error" not in m.get_message_info()
|
||||||
time.sleep(1)
|
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
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ import os
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from cmdeploy.cmdeploy import get_parser, main
|
from cmdeploy.cmdeploy import get_parser, main
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
@@ -21,12 +20,7 @@ class TestCmdline:
|
|||||||
run = parser.parse_args(["run"])
|
run = parser.parse_args(["run"])
|
||||||
assert init and run
|
assert init and run
|
||||||
|
|
||||||
def test_init(self, tmp_path):
|
@pytest.mark.xfail(reason="init doesn't exit anymore, check for CLI output instead")
|
||||||
main(["init", "chat.example.org"])
|
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
|
||||||
config = read_config(inipath)
|
|
||||||
assert config.mail_domain == "chat.example.org"
|
|
||||||
|
|
||||||
def test_init_not_overwrite(self):
|
def test_init_not_overwrite(self):
|
||||||
main(["init", "chat.example.org"])
|
main(["init", "chat.example.org"])
|
||||||
with pytest.raises(SystemExit):
|
with pytest.raises(SystemExit):
|
||||||
|
|||||||
@@ -36,29 +36,6 @@ def build_webpages(src_dir, build_dir, config):
|
|||||||
print(traceback.format_exc())
|
print(traceback.format_exc())
|
||||||
|
|
||||||
|
|
||||||
def timespan_to_english(timespan):
|
|
||||||
val = int(timespan[:-1])
|
|
||||||
c = timespan[-1].lower()
|
|
||||||
match c:
|
|
||||||
case "y":
|
|
||||||
return f"{val} years"
|
|
||||||
case "m":
|
|
||||||
return f"{val} months"
|
|
||||||
case "w":
|
|
||||||
return f"{val} weeks"
|
|
||||||
case "d":
|
|
||||||
return f"{val} days"
|
|
||||||
case "h":
|
|
||||||
return f"{val} hours"
|
|
||||||
case "c":
|
|
||||||
return f"{val} seconds"
|
|
||||||
case _:
|
|
||||||
raise ValueError(
|
|
||||||
c
|
|
||||||
+ " is not a valid time unit. Try [y]ears, [w]eeks, [d]ays, or [h]ours"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def int_to_english(number):
|
def int_to_english(number):
|
||||||
if number >= 0 and number <= 12:
|
if number >= 0 and number <= 12:
|
||||||
a = [
|
a = [
|
||||||
@@ -104,9 +81,6 @@ def _build_webpages(src_dir, build_dir, config):
|
|||||||
render_vars["password_min_length"] = int_to_english(
|
render_vars["password_min_length"] = int_to_english(
|
||||||
config.password_min_length
|
config.password_min_length
|
||||||
)
|
)
|
||||||
render_vars["delete_mails_after"] = timespan_to_english(
|
|
||||||
config.delete_mails_after
|
|
||||||
)
|
|
||||||
target = build_dir.joinpath(path.stem + ".html")
|
target = build_dir.joinpath(path.stem + ".html")
|
||||||
|
|
||||||
# recursive jinja2 rendering
|
# recursive jinja2 rendering
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
set -e
|
set -e
|
||||||
python3 -m venv venv
|
python3 -m venv --upgrade-deps venv
|
||||||
|
|
||||||
venv/bin/pip install -e chatmaild
|
venv/bin/pip install -e chatmaild
|
||||||
venv/bin/pip install -e cmdeploy
|
venv/bin/pip install -e cmdeploy
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ Welcome to instant, interoperable and [privacy-preserving](privacy.html) messagi
|
|||||||
|
|
||||||
👉 **Tap** or scan this QR code to get a random `@{{config.mail_domain}}` e-mail address
|
👉 **Tap** or scan this QR code to get a random `@{{config.mail_domain}}` e-mail address
|
||||||
|
|
||||||
<a href="DCACCOUNT:https://{{ config.mail_domain }}/cgi-bin/newemail.py">
|
<a href="DCACCOUNT:https://{{ config.mail_domain }}/new">
|
||||||
<img width=300 style="float: none;" src="qr-chatmail-invite-{{config.mail_domain}}.png" /></a>
|
<img width=300 style="float: none;" src="qr-chatmail-invite-{{config.mail_domain}}.png" /></a>
|
||||||
|
|
||||||
🐣 **Choose** your Avatar and Name
|
🐣 **Choose** your Avatar and Name
|
||||||
|
|||||||
@@ -3,6 +3,11 @@
|
|||||||
|
|
||||||
## More information
|
## More information
|
||||||
|
|
||||||
|
{{ config.mail_domain }} provides a low-maintenance, resource efficient and
|
||||||
|
interoperable e-mail service for everyone. What's behind a `chatmail` is
|
||||||
|
effectively a normal e-mail address just like any other but optimized
|
||||||
|
for the usage in chats, especially DeltaChat.
|
||||||
|
|
||||||
### Choosing a chatmail address instead of using a random one
|
### Choosing a chatmail address instead of using a random one
|
||||||
|
|
||||||
In the Delta Chat account setup
|
In the Delta Chat account setup
|
||||||
@@ -37,7 +42,7 @@ The first login sets your password.
|
|||||||
|
|
||||||
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
||||||
|
|
||||||
- Seen messages are removed {{ delete_mails_after }} after arriving on the server.
|
- Messages are unconditionally removed {{ config.delete_mails_after }} days after arriving on the server.
|
||||||
|
|
||||||
- You can store up to [{{ config.max_mailbox_size }} messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server).
|
- You can store up to [{{ config.max_mailbox_size }} messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server).
|
||||||
|
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ we process the following data and details:
|
|||||||
Creating an account happens in one of two ways on our mail servers:
|
Creating an account happens in one of two ways on our mail servers:
|
||||||
|
|
||||||
- with a QR invitation token
|
- with a QR invitation token
|
||||||
which is scanned using the DeltaChat app
|
which is scanned using the Delta Chat app
|
||||||
and then the account is created.
|
and then the account is created.
|
||||||
|
|
||||||
- by letting Delta Chat otherwise create an account
|
- by letting Delta Chat otherwise create an account
|
||||||
|
|||||||
Reference in New Issue
Block a user