mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 16:34:39 +00:00
Compare commits
40 Commits
privacy-de
...
draft-init
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
805d743e9e | ||
|
|
b0d5ee084e | ||
|
|
56c7853e5b | ||
|
|
071d708a89 | ||
|
|
c7c7ed8ff2 | ||
|
|
0aa0ef8a74 | ||
|
|
0662e3a8b1 | ||
|
|
6c453f93a1 | ||
|
|
54f29f6bae | ||
|
|
ad8fee76cd | ||
|
|
528cd3da25 | ||
|
|
5734e00625 | ||
|
|
947e1d6f89 | ||
|
|
33423459fe | ||
|
|
c70b72a21a | ||
|
|
33352f4694 | ||
|
|
59083ad16a | ||
|
|
11518c2ef4 | ||
|
|
a0cdfe6126 | ||
|
|
c25eefccc4 | ||
|
|
8b878e38cf | ||
|
|
9e1e6d3c69 | ||
|
|
a1c817d758 | ||
|
|
ccc552f852 | ||
|
|
73768256f6 | ||
|
|
34f7b3c0d3 | ||
|
|
e2828f4103 | ||
|
|
df515bea41 | ||
|
|
5614f03611 | ||
|
|
70443545d7 | ||
|
|
10ef842061 | ||
|
|
98f92cd9b6 | ||
|
|
fe99b97386 | ||
|
|
542decf798 | ||
|
|
2e7f8483b3 | ||
|
|
5c58e625f0 | ||
|
|
009f549619 | ||
|
|
99d36235fe | ||
|
|
b52a8c969f | ||
|
|
8520a9d8f2 |
4
.github/CODE_OF_CONDUCT.md
vendored
4
.github/CODE_OF_CONDUCT.md
vendored
@@ -1,4 +0,0 @@
|
|||||||
|
|
||||||
Please refer to
|
|
||||||
[Delta Chat community standards and practices](https://delta.chat/en/community-standards)
|
|
||||||
which also apply for all chatmail developments.
|
|
||||||
5
.github/workflows/ci.yaml
vendored
5
.github/workflows/ci.yaml
vendored
@@ -31,7 +31,10 @@ jobs:
|
|||||||
run: cmdeploy fmt -v
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest --pyargs cmdeploy
|
run: pytest tests
|
||||||
|
|
||||||
|
- name: initialize with chatmail domain
|
||||||
|
run: cmdeploy init chat.example.org
|
||||||
|
|
||||||
# all other cmdeploy commands require a staging server
|
# all other cmdeploy commands require a staging server
|
||||||
# see https://github.com/deltachat/chatmail/issues/100
|
# see https://github.com/deltachat/chatmail/issues/100
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
;; 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.
|
|
||||||
86
.github/workflows/test-and-deploy.yaml
vendored
86
.github/workflows/test-and-deploy.yaml
vendored
@@ -1,86 +0,0 @@
|
|||||||
name: deploy on staging.testrun.org, and run tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
|
||||||
- 'scripts/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
name: deploy on staging.testrun.org, and run tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
concurrency:
|
|
||||||
group: staging-deploy
|
|
||||||
cancel-in-progress: true
|
|
||||||
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
|
|
||||||
# save previous acme & dkim state
|
|
||||||
rsync -avz root@staging.testrun.org:/var/lib/acme . || true
|
|
||||||
rsync -avz root@staging.testrun.org:/etc/dkimkeys . || true
|
|
||||||
# store previous acme & dkim state on ns.testrun.org, if it contains useful certs
|
|
||||||
if [ -f dkimkeys/opendkim.private ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" dkimkeys root@ns.testrun.org:/tmp/ || true; fi
|
|
||||||
if [ -z "$(ls -A acme/certs)" ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" acme root@ns.testrun.org:/tmp/ || true; fi
|
|
||||||
|
|
||||||
- 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: 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
|
|
||||||
# download acme & dkim state from ns.testrun.org
|
|
||||||
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme acme-restore || true
|
|
||||||
rsync -avz root@ns.testrun.org:/tmp/dkimkeys dkimkeys-restore || true
|
|
||||||
# restore acme & dkim state to staging.testrun.org
|
|
||||||
rsync -avz acme-restore/acme/ root@staging.testrun.org:/var/lib/acme || true
|
|
||||||
rsync -avz dkimkeys-restore/dkimkeys/ root@staging.testrun.org:/etc/dkimkeys || true
|
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging.testrun.org chown root:root -R /var/lib/acme || true
|
|
||||||
|
|
||||||
- name: run formatting checks
|
|
||||||
run: cmdeploy fmt -v
|
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
|
||||||
run: pytest --pyargs cmdeploy
|
|
||||||
|
|
||||||
- run: cmdeploy init staging.testrun.org
|
|
||||||
|
|
||||||
- run: cmdeploy run
|
|
||||||
|
|
||||||
- name: set DNS entries
|
|
||||||
run: |
|
|
||||||
ssh -o StrictHostKeyChecking=accept-new -v root@staging.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
|
||||||
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 .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
|
|
||||||
|
|
||||||
67
CHANGELOG.md
67
CHANGELOG.md
@@ -1,67 +0,0 @@
|
|||||||
# Changelog for chatmail deployment
|
|
||||||
|
|
||||||
## untagged
|
|
||||||
|
|
||||||
- Added a config option for an intro to the privacy policy
|
|
||||||
([#285](https://github.com/deltachat/chatmail/pull/285))
|
|
||||||
|
|
||||||
- Move echobot `into /var/lib/echobot`
|
|
||||||
([#281](https://github.com/deltachat/chatmail/pull/281))
|
|
||||||
|
|
||||||
- Accept Let's Encrypt's new Terms of Services
|
|
||||||
([#275](https://github.com/deltachat/chatmail/pull/276))
|
|
||||||
|
|
||||||
- Reload Dovecot and Postfix when TLS certificate updates
|
|
||||||
([#271](https://github.com/deltachat/chatmail/pull/271))
|
|
||||||
|
|
||||||
- Use forked version of dovecot without hardcoded delays
|
|
||||||
([#270](https://github.com/deltachat/chatmail/pull/270))
|
|
||||||
|
|
||||||
## 1.2.0 - 2024-04-04
|
|
||||||
|
|
||||||
- Install dig on the server to resolve DNS records
|
|
||||||
([#267](https://github.com/deltachat/chatmail/pull/267))
|
|
||||||
|
|
||||||
- preserve notification order and exponentially backoff with
|
|
||||||
retries for tokens where we didn't get a successful return
|
|
||||||
([#265](https://github.com/deltachat/chatmail/pull/263))
|
|
||||||
|
|
||||||
- Run chatmail-metadata and doveauth as vmail
|
|
||||||
([#261](https://github.com/deltachat/chatmail/pull/261))
|
|
||||||
|
|
||||||
- Apply systemd restrictions to echobot
|
|
||||||
([#259](https://github.com/deltachat/chatmail/pull/259))
|
|
||||||
|
|
||||||
- re-enable running the CI in pull requests, but not concurrently
|
|
||||||
([#258](https://github.com/deltachat/chatmail/pull/258))
|
|
||||||
|
|
||||||
|
|
||||||
## 1.1.0 - 2024-03-28
|
|
||||||
|
|
||||||
### The changelog starts to record changes from March 15th, 2024
|
|
||||||
|
|
||||||
- Move systemd unit templates to cmdeploy package
|
|
||||||
([#255](https://github.com/deltachat/chatmail/pull/255))
|
|
||||||
|
|
||||||
- Persist push tokens and support multiple device per address
|
|
||||||
([#254](https://github.com/deltachat/chatmail/pull/254))
|
|
||||||
|
|
||||||
- Avoid warning for regular doveauth protocol's hello message.
|
|
||||||
([#250](https://github.com/deltachat/chatmail/pull/250))
|
|
||||||
|
|
||||||
- Fix various tests to pass again with "cmdeploy test".
|
|
||||||
([#245](https://github.com/deltachat/chatmail/pull/245),
|
|
||||||
[#242](https://github.com/deltachat/chatmail/pull/242)
|
|
||||||
|
|
||||||
- Ensure lets-encrypt certificates are reloaded after renewal
|
|
||||||
([#244]) https://github.com/deltachat/chatmail/pull/244
|
|
||||||
|
|
||||||
- Persist tokens to avoid iOS users loosing push-notifications when the
|
|
||||||
chatmail metadata service is restarted (happens regularly during deploys)
|
|
||||||
([#238](https://github.com/deltachat/chatmail/pull/239)
|
|
||||||
|
|
||||||
- Fix failing sieve-script compile errors on incoming messages
|
|
||||||
([#237](https://github.com/deltachat/chatmail/pull/239)
|
|
||||||
|
|
||||||
- Fix quota reporting after expunging of old mails
|
|
||||||
([#233](https://github.com/deltachat/chatmail/pull/239)
|
|
||||||
21
LICENSE
21
LICENSE
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2023, chatmail and delta chat teams
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
|
||||||
the Software without restriction, including without limitation the rights to
|
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
||||||
of the Software, and to permit persons to whom the Software is furnished to do
|
|
||||||
so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
231
README.md
231
README.md
@@ -15,171 +15,146 @@ after which the initially specified password is required for using them.
|
|||||||
|
|
||||||
## Deploying your own chatmail server
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
We use `chat.example.org` as the chatmail domain in the following steps.
|
We subsequently use `CHATMAIL_DOMAIN` as a placeholder for your fully qualified
|
||||||
Please substitute it with your own domain.
|
DNS domain name (FQDN), for example `chat.example.org`.
|
||||||
|
|
||||||
1. Install the `cmdeploy` command in a virtualenv
|
1. Setup DNS `A` and `AAAA` records for your `CHATMAIL_DOMAIN`.
|
||||||
|
Verify that DNS is set and SSH root login works:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/deltachat/chatmail
|
ssh root@CHATMAIL_DOMAIN
|
||||||
cd chatmail
|
|
||||||
scripts/initenv.sh
|
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create chatmail configuration file `chatmail.ini`:
|
2. Install the `cmdeploy` command in a virtualenv
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy init chat.example.org # <-- use your domain
|
source scripts/initenv.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Setup first DNS records for your chatmail domain,
|
3. Create chatmail configuration file `chatmail.ini`:
|
||||||
according to the hints provided by `cmdeploy init`.
|
|
||||||
Verify that SSH root login works:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
ssh root@chat.example.org # <-- use your domain
|
cmdeploy init CHATMAIL_DOMAIN
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Deploy to the remote chatmail server:
|
4. Deploy to the remote chatmail server:
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy run
|
cmdeploy run
|
||||||
```
|
```
|
||||||
This script will also show you additional DNS records
|
|
||||||
which you should configure at your DNS provider
|
|
||||||
(it can take some time until they are public).
|
|
||||||
|
|
||||||
### Other helpful commands:
|
5. To output a DNS zone file from which you can transfer DNS records
|
||||||
|
to your DNS provider:
|
||||||
|
|
||||||
To check the status of your remotely running chatmail service:
|
```
|
||||||
|
cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
```
|
6. To check status of your remotely running chatmail service:
|
||||||
scripts/cmdeploy status
|
|
||||||
|
```
|
||||||
|
cmdeploy status
|
||||||
|
```
|
||||||
|
|
||||||
|
7. To test your chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
cmdeploy test
|
||||||
|
```
|
||||||
|
|
||||||
|
8. To benchmark your chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
cmdeploy bench
|
||||||
|
```
|
||||||
|
|
||||||
|
### Refining the web pages
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
cmdeploy webdev
|
||||||
```
|
```
|
||||||
|
|
||||||
To check whether your DNS records are correct:
|
This starts a local live development cycle for chatmail Web pages:
|
||||||
|
|
||||||
```
|
- uses the `www/src/page-layout.html` file for producing static
|
||||||
scripts/cmdeploy dns
|
HTML pages from `www/src/*.md` files
|
||||||
```
|
|
||||||
|
|
||||||
To test whether your chatmail service is working correctly:
|
- continously builds the web presence reading files from `www/src` directory
|
||||||
|
and generating html files and copying assets to the `www/build` directory.
|
||||||
|
|
||||||
```
|
- Starts a browser window automatically where you can "refresh" as needed.
|
||||||
scripts/cmdeploy test
|
|
||||||
```
|
|
||||||
|
|
||||||
To measure the performance of your chatmail service:
|
|
||||||
|
|
||||||
```
|
### Home page and getting started for users
|
||||||
scripts/cmdeploy bench
|
|
||||||
```
|
|
||||||
|
|
||||||
## Overview of this repository
|
`cmdeploy run` sets up mail services,
|
||||||
|
and also creates default static Web pages and deploys them:
|
||||||
|
|
||||||
This repository drives the development of chatmail services,
|
- a default `index.html` along with a QR code that users can click to
|
||||||
comprised of minimal setups of
|
create accounts on your chatmail provider,
|
||||||
|
|
||||||
- [postfix smtp server](https://www.postfix.org)
|
- a default `info.html` that is linked from the home page,
|
||||||
- [dovecot imap server](https://www.dovecot.org)
|
|
||||||
|
|
||||||
as well as custom services that are integrated with these two:
|
- 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
|
||||||
|
|
||||||
|
If you need to stop account creation,
|
||||||
|
e.g. because some script is wildly creating accounts, run:
|
||||||
|
|
||||||
|
touch /etc/chatmail-nocreate
|
||||||
|
|
||||||
|
While this file is present, account creation will be blocked.
|
||||||
|
|
||||||
|
|
||||||
|
## Running tests and benchmarks (offline and online)
|
||||||
|
|
||||||
|
1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows
|
||||||
|
to login to the chatmail instance server.
|
||||||
|
|
||||||
|
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
|
- `chatmaild/src/chatmaild/doveauth.py` implements
|
||||||
create-on-login account creation semantics and is used
|
create-on-login account creation semantics and is used
|
||||||
by Dovecot during login authentication and by Postfix
|
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)
|
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
||||||
to authenticate users
|
to authenticate users
|
||||||
to send mails for them.
|
to send mails for them.
|
||||||
|
|
||||||
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
||||||
unencrypted e-mail from leaving the chatmail service
|
unencrypted e-mail from leaving the chatmail instance
|
||||||
and is integrated into postfix's outbound mail pipelines.
|
and is integrated into postfix's outbound mail pipelines.
|
||||||
|
|
||||||
There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
|
||||||
which helps with setting up and managing the chatmail service.
|
|
||||||
`cmdeploy run` uses [pyinfra-based scripting](https://pyinfra.com/)
|
|
||||||
in `cmdeploy/src/cmdeploy/__init__.py`
|
|
||||||
to automatically install all chatmail components on a server.
|
|
||||||
|
|
||||||
|
|
||||||
### Home page and getting started for users
|
|
||||||
|
|
||||||
`cmdeploy run` also creates default static Web pages and deploys them
|
|
||||||
to a nginx web server with:
|
|
||||||
|
|
||||||
- a default `index.html` along with a QR code that users can click to
|
|
||||||
create accounts on your chatmail provider,
|
|
||||||
|
|
||||||
- a default `info.html` that is linked from the home page,
|
|
||||||
|
|
||||||
- a default `policy.html` that is linked from the home page.
|
|
||||||
|
|
||||||
All `.html` files are generated
|
|
||||||
by the according markdown `.md` file in the `www/src` directory.
|
|
||||||
|
|
||||||
|
|
||||||
### Refining the web pages
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy webdev
|
|
||||||
```
|
|
||||||
|
|
||||||
This starts a local live development cycle for chatmail Web pages:
|
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing static
|
|
||||||
HTML pages from `www/src/*.md` files
|
|
||||||
|
|
||||||
- continously builds the web presence reading files from `www/src` directory
|
|
||||||
and generating html files and copying assets to the `www/build` directory.
|
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
|
||||||
|
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
|
||||||
|
|
||||||
If you need to stop account creation,
|
|
||||||
e.g. because some script is wildly creating accounts,
|
|
||||||
login to the server with ssh and run:
|
|
||||||
|
|
||||||
```
|
|
||||||
touch /etc/chatmail-nocreate
|
|
||||||
```
|
|
||||||
|
|
||||||
While this file is present, account creation will be blocked.
|
|
||||||
|
|
||||||
### Ports
|
|
||||||
|
|
||||||
[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).
|
|
||||||
[nginx](https://www.nginx.com/) listens on port 443 (https).
|
|
||||||
[acmetool](https://hlandau.github.io/acmetool/) listens on port 80 (http).
|
|
||||||
|
|
||||||
Delta Chat apps will, however, discover all ports and configurations
|
|
||||||
automatically by reading the [autoconfig XML file](https://www.ietf.org/archive/id/draft-bucksch-autoconfig-00.html) from the chatmail service.
|
|
||||||
|
|
||||||
## Email authentication
|
|
||||||
|
|
||||||
chatmail servers rely on [DKIM](https://www.rfc-editor.org/rfc/rfc6376)
|
|
||||||
to authenticate incoming emails.
|
|
||||||
Incoming emails must have a valid DKIM signature with
|
|
||||||
Signing Domain Identifier (SDID, `d=` parameter in the DKIM-Signature header)
|
|
||||||
equal to the `From:` header domain.
|
|
||||||
This property is checked by OpenDKIM screen policy script
|
|
||||||
before validating the signatures.
|
|
||||||
This correpsonds to strict [DMARC](https://www.rfc-editor.org/rfc/rfc7489) alignment (`adkim=s`),
|
|
||||||
but chatmail does not rely on DMARC and does not consult the sender policy published in DMARC records.
|
|
||||||
Other legacy authentication mechanisms such as [iprev](https://www.rfc-editor.org/rfc/rfc8601#section-2.7.3)
|
|
||||||
and [SPF](https://www.rfc-editor.org/rfc/rfc7208) are also not taken into account.
|
|
||||||
If there is no valid DKIM signature on the incoming email,
|
|
||||||
the sender receives a "5.7.1 No valid DKIM signature found" error.
|
|
||||||
|
|
||||||
Outgoing emails must be sent over authenticated connection
|
|
||||||
with envelope MAIL FROM (return path) corresponding to the login.
|
|
||||||
This is ensured by Postfix which maps login username
|
|
||||||
to MAIL FROM with
|
|
||||||
[`smtpd_sender_login_maps`](https://www.postfix.org/postconf.5.html#smtpd_sender_login_maps)
|
|
||||||
and rejects incorrectly authenticated emails with [`reject_sender_login_mismatch`](reject_sender_login_mismatch) policy.
|
|
||||||
`From:` header must correspond to envelope MAIL FROM,
|
|
||||||
this is ensured by `filtermail` proxy.
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
include src/chatmaild/*.f
|
||||||
include src/chatmaild/ini/*.ini.f
|
include src/chatmaild/ini/*.ini.f
|
||||||
include src/chatmaild/ini/*.ini
|
include src/chatmaild/ini/*.ini
|
||||||
include src/chatmaild/tests/mail-data/*
|
include src/chatmaild/tests/mail-data/*
|
||||||
|
|||||||
@@ -8,10 +8,6 @@ version = "0.2"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
"iniconfig",
|
||||||
"deltachat-rpc-server",
|
|
||||||
"deltachat-rpc-client",
|
|
||||||
"filelock",
|
|
||||||
"requests",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -22,10 +18,7 @@ where = ['src']
|
|||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
chatmail-metadata = "chatmaild.metadata:main"
|
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
echobot = "chatmaild.echo:main"
|
|
||||||
chatmail-metrics = "chatmaild.metrics:main"
|
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
|||||||
@@ -9,35 +9,26 @@ def read_config(inipath):
|
|||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
self.mail_domain = params["mail_domain"]
|
self.mailname = self.mail_domain = params["mailname"]
|
||||||
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
||||||
self.max_mailbox_size = params["max_mailbox_size"]
|
|
||||||
self.delete_mails_after = params["delete_mails_after"]
|
|
||||||
self.username_min_length = int(params["username_min_length"])
|
|
||||||
self.username_max_length = int(params["username_max_length"])
|
|
||||||
self.password_min_length = int(params["password_min_length"])
|
|
||||||
self.passthrough_senders = params["passthrough_senders"].split()
|
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].split()
|
|
||||||
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
||||||
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
||||||
|
self.passthrough_recipients = params["passthrough_recipients"].split()
|
||||||
self.privacy_postal = params.get("privacy_postal")
|
self.privacy_postal = params.get("privacy_postal")
|
||||||
self.privacy_mail = params.get("privacy_mail")
|
self.privacy_mail = params.get("privacy_mail")
|
||||||
self.privacy_pdo = params.get("privacy_pdo")
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
self.privacy_supervisor = params.get("privacy_supervisor")
|
self.privacy_supervisor = params.get("privacy_supervisor")
|
||||||
self.privacy_intro = params.get("privacy_intro")
|
|
||||||
|
|
||||||
def _getbytefile(self):
|
def _getbytefile(self):
|
||||||
return open(self._inipath, "rb")
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
|
|
||||||
def write_initial_config(inipath, mail_domain):
|
def write_initial_config(inipath, mailname):
|
||||||
from importlib.resources import files
|
from importlib.resources import files
|
||||||
|
|
||||||
inidir = files(__package__).joinpath("ini")
|
inidir = files(__package__).joinpath("ini")
|
||||||
content = (
|
content = inidir.joinpath("chatmail.ini.f").read_text().format(mailname=mailname)
|
||||||
inidir.joinpath("chatmail.ini.f").read_text().format(mail_domain=mail_domain)
|
if mailname.endswith(".testrun.org"):
|
||||||
)
|
|
||||||
if mail_domain.endswith(".testrun.org"):
|
|
||||||
override_inipath = inidir.joinpath("override-testrun.ini")
|
override_inipath = inidir.joinpath("override-testrun.ini")
|
||||||
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
||||||
lines = []
|
lines = []
|
||||||
|
|||||||
@@ -4,40 +4,32 @@ import time
|
|||||||
import sys
|
import sys
|
||||||
import json
|
import json
|
||||||
import crypt
|
import crypt
|
||||||
from pathlib import Path
|
|
||||||
from socketserver import (
|
from socketserver import (
|
||||||
UnixStreamServer,
|
UnixStreamServer,
|
||||||
StreamRequestHandler,
|
StreamRequestHandler,
|
||||||
ThreadingMixIn,
|
ThreadingMixIn,
|
||||||
)
|
)
|
||||||
|
import pwd
|
||||||
|
|
||||||
from .database import Database
|
from .database import Database
|
||||||
from .config import read_config, Config
|
|
||||||
|
|
||||||
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
||||||
|
|
||||||
|
|
||||||
class UnknownCommand(ValueError):
|
|
||||||
"""dictproxy handler received an unkown command"""
|
|
||||||
|
|
||||||
|
|
||||||
def encrypt_password(password: str):
|
def encrypt_password(password: str):
|
||||||
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
||||||
passhash = crypt.crypt(password, crypt.METHOD_SHA512)
|
passhash = crypt.crypt(password, crypt.METHOD_SHA512)
|
||||||
return "{SHA512-CRYPT}" + passhash
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
def is_allowed_to_create(user, cleartext_password) -> bool:
|
||||||
"""Return True if user and password are admissable."""
|
"""Return True if user and password are admissable."""
|
||||||
if os.path.exists(NOCREATE_FILE):
|
if os.path.exists(NOCREATE_FILE):
|
||||||
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
if len(cleartext_password) < config.password_min_length:
|
if len(cleartext_password) < 9:
|
||||||
logging.warning(
|
logging.warning("Password needs to be at least 9 characters long")
|
||||||
"Password needs to be at least %s characters long",
|
|
||||||
config.password_min_length,
|
|
||||||
)
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
parts = user.split("@")
|
parts = user.split("@")
|
||||||
@@ -46,61 +38,29 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
return False
|
return False
|
||||||
localpart, domain = parts
|
localpart, domain = parts
|
||||||
|
|
||||||
if localpart == "echo":
|
if domain == "nine.testrun.org":
|
||||||
# echobot account should not be created in the database
|
# nine.testrun.org policy, username has to be exactly nine chars
|
||||||
return False
|
if len(localpart) != 9:
|
||||||
|
logging.warning(f"localpart {localpart!r} has not exactly nine chars")
|
||||||
if (
|
return False
|
||||||
len(localpart) > config.username_max_length
|
|
||||||
or len(localpart) < config.username_min_length
|
|
||||||
):
|
|
||||||
logging.warning(
|
|
||||||
"localpart %s has to be between %s and %s chars long",
|
|
||||||
localpart,
|
|
||||||
config.username_min_length,
|
|
||||||
config.username_max_length,
|
|
||||||
)
|
|
||||||
|
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
def get_user_data(db, config: Config, user):
|
def get_user_data(db, user):
|
||||||
if user == f"echo@{config.mail_domain}":
|
|
||||||
return dict(
|
|
||||||
home=f"/home/vmail/mail/{config.mail_domain}/echo@{config.mail_domain}",
|
|
||||||
uid="vmail",
|
|
||||||
gid="vmail",
|
|
||||||
)
|
|
||||||
|
|
||||||
with db.read_connection() as conn:
|
with db.read_connection() as conn:
|
||||||
result = conn.get_user(user)
|
result = conn.get_user(user)
|
||||||
if result:
|
if result:
|
||||||
result["home"] = f"/home/vmail/mail/{config.mail_domain}/{user}"
|
|
||||||
result["uid"] = "vmail"
|
result["uid"] = "vmail"
|
||||||
result["gid"] = "vmail"
|
result["gid"] = "vmail"
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
|
||||||
def lookup_userdb(db, config: Config, user):
|
def lookup_userdb(db, user):
|
||||||
return get_user_data(db, config, user)
|
return get_user_data(db, user)
|
||||||
|
|
||||||
|
|
||||||
def lookup_passdb(db, config: Config, user, cleartext_password):
|
def lookup_passdb(db, user, cleartext_password):
|
||||||
if user == f"echo@{config.mail_domain}":
|
|
||||||
# Echobot writes password it wants to log in with into /run/echobot/password
|
|
||||||
try:
|
|
||||||
password = Path("/run/echobot/password").read_text()
|
|
||||||
except Exception:
|
|
||||||
logging.exception("Exception when trying to read /run/echobot/password")
|
|
||||||
return None
|
|
||||||
|
|
||||||
return dict(
|
|
||||||
home=f"/home/vmail/mail/{config.mail_domain}/echo@{config.mail_domain}",
|
|
||||||
uid="vmail",
|
|
||||||
gid="vmail",
|
|
||||||
password=encrypt_password(password),
|
|
||||||
)
|
|
||||||
|
|
||||||
with db.write_transaction() as conn:
|
with db.write_transaction() as conn:
|
||||||
userdata = conn.get_user(user)
|
userdata = conn.get_user(user)
|
||||||
if userdata:
|
if userdata:
|
||||||
@@ -109,11 +69,10 @@ def lookup_passdb(db, config: Config, user, cleartext_password):
|
|||||||
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
||||||
)
|
)
|
||||||
|
|
||||||
userdata["home"] = f"/home/vmail/mail/{config.mail_domain}/{user}"
|
|
||||||
userdata["uid"] = "vmail"
|
userdata["uid"] = "vmail"
|
||||||
userdata["gid"] = "vmail"
|
userdata["gid"] = "vmail"
|
||||||
return userdata
|
return userdata
|
||||||
if not is_allowed_to_create(config, user, cleartext_password):
|
if not is_allowed_to_create(user, cleartext_password):
|
||||||
return
|
return
|
||||||
|
|
||||||
encrypted_password = encrypt_password(cleartext_password)
|
encrypted_password = encrypt_password(cleartext_password)
|
||||||
@@ -121,92 +80,39 @@ 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/mail/{config.mail_domain}/{user}",
|
home=f"/home/vmail/{user}",
|
||||||
uid="vmail",
|
uid="vmail",
|
||||||
gid="vmail",
|
gid="vmail",
|
||||||
password=encrypted_password,
|
password=encrypted_password,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def split_and_unescape(s):
|
def handle_dovecot_request(msg, db, mail_domain):
|
||||||
"""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):
|
|
||||||
# see https://doc.dovecot.org/3.0/developer_manual/design/dict_protocol/
|
|
||||||
short_command = msg[0]
|
short_command = msg[0]
|
||||||
if short_command == "H": # HELLO
|
if short_command == "L": # LOOKUP
|
||||||
# we don't do any checking on versions and just return
|
|
||||||
return
|
|
||||||
elif short_command == "L": # LOOKUP
|
|
||||||
parts = msg[1:].split("\t")
|
parts = msg[1:].split("\t")
|
||||||
|
keyname, user = parts[:2]
|
||||||
# Dovecot <2.3.17 has only one part,
|
namespace, type, *args = keyname.split("/")
|
||||||
# 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"@{mail_domain}"):
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
res = lookup_userdb(db, user)
|
||||||
res = lookup_userdb(db, config, user)
|
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
reply_command = "N"
|
reply_command = "N"
|
||||||
elif type == "passdb":
|
elif type == "passdb":
|
||||||
user = args[1]
|
if user.endswith(f"@{mail_domain}"):
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
res = lookup_passdb(db, user, cleartext_password=args[0])
|
||||||
res = lookup_passdb(db, config, user, cleartext_password=args[0])
|
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
reply_command = "N"
|
reply_command = "N"
|
||||||
json_res = json.dumps(res) if res else ""
|
json_res = json.dumps(res) if res else ""
|
||||||
return f"{reply_command}{json_res}\n"
|
return f"{reply_command}{json_res}\n"
|
||||||
raise UnknownCommand(msg)
|
return None
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_protocol(rfile, wfile, db: Database, config: Config):
|
|
||||||
while True:
|
|
||||||
msg = rfile.readline().strip().decode()
|
|
||||||
if not msg:
|
|
||||||
break
|
|
||||||
try:
|
|
||||||
res = handle_dovecot_request(msg, db, config)
|
|
||||||
except UnknownCommand:
|
|
||||||
logging.warning("unknown command: %r", msg)
|
|
||||||
else:
|
|
||||||
if res:
|
|
||||||
wfile.write(res.encode("ascii"))
|
|
||||||
wfile.flush()
|
|
||||||
|
|
||||||
|
|
||||||
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
||||||
@@ -215,13 +121,24 @@ class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
|||||||
|
|
||||||
def main():
|
def main():
|
||||||
socket = sys.argv[1]
|
socket = sys.argv[1]
|
||||||
db = Database(sys.argv[2])
|
passwd_entry = pwd.getpwnam(sys.argv[2])
|
||||||
config = read_config(sys.argv[3])
|
db = Database(sys.argv[3])
|
||||||
|
with open("/etc/mailname", "r") as fp:
|
||||||
|
mail_domain = fp.read().strip()
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
class Handler(StreamRequestHandler):
|
||||||
def handle(self):
|
def handle(self):
|
||||||
try:
|
try:
|
||||||
handle_dovecot_protocol(self.rfile, self.wfile, db, config)
|
while True:
|
||||||
|
msg = self.rfile.readline().strip().decode()
|
||||||
|
if not msg:
|
||||||
|
break
|
||||||
|
res = handle_dovecot_request(msg, db, mail_domain)
|
||||||
|
if res:
|
||||||
|
self.wfile.write(res.encode("ascii"))
|
||||||
|
self.wfile.flush()
|
||||||
|
else:
|
||||||
|
logging.warn("request had no answer: %r", msg)
|
||||||
except Exception:
|
except Exception:
|
||||||
logging.exception("Exception in the handler")
|
logging.exception("Exception in the handler")
|
||||||
raise
|
raise
|
||||||
@@ -232,6 +149,7 @@ def main():
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
with ThreadedUnixStreamServer(socket, Handler) as server:
|
with ThreadedUnixStreamServer(socket, Handler) as server:
|
||||||
|
os.chown(socket, uid=passwd_entry.pw_uid, gid=passwd_entry.pw_gid)
|
||||||
try:
|
try:
|
||||||
server.serve_forever()
|
server.serve_forever()
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
|
|||||||
@@ -2,11 +2,9 @@
|
|||||||
Description=Chatmail dict authentication proxy for dovecot
|
Description=Chatmail dict authentication proxy for dovecot
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} /run/doveauth/doveauth.socket /home/vmail/passdb.sqlite {config_path}
|
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
User=vmail
|
|
||||||
RuntimeDirectory=doveauth
|
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Advanced echo bot example.
|
|
||||||
|
|
||||||
it will echo back any message that has non-empty text and also supports the /help command.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
from chatmaild.newemail import create_newemail_dict
|
|
||||||
|
|
||||||
hooks = events.HookCollection()
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.RawEvent)
|
|
||||||
def log_event(event):
|
|
||||||
if event.kind == EventType.INFO:
|
|
||||||
logging.info("%s", event.msg)
|
|
||||||
elif event.kind == EventType.WARNING:
|
|
||||||
logging.warning("%s", event.msg)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.RawEvent(EventType.ERROR))
|
|
||||||
def log_error(event):
|
|
||||||
logging.error("%s", event.msg)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.MemberListChanged)
|
|
||||||
def on_memberlist_changed(event):
|
|
||||||
logging.info(
|
|
||||||
"member %s was %s", event.member, "added" if event.member_added else "removed"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.GroupImageChanged)
|
|
||||||
def on_group_image_changed(event):
|
|
||||||
logging.info("group image %s", "deleted" if event.image_deleted else "changed")
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.GroupNameChanged)
|
|
||||||
def on_group_name_changed(event):
|
|
||||||
logging.info("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.is_info:
|
|
||||||
# Ignore info messages
|
|
||||||
return
|
|
||||||
if snapshot.text or snapshot.file:
|
|
||||||
snapshot.chat.send_message(text=snapshot.text, file=snapshot.file)
|
|
||||||
|
|
||||||
|
|
||||||
@hooks.on(events.NewMessage(command="/help"))
|
|
||||||
def help_command(event):
|
|
||||||
snapshot = event.message_snapshot
|
|
||||||
snapshot.chat.send_text("Send me any message and I will echo it back")
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
logging.basicConfig(level=logging.INFO)
|
|
||||||
path = os.environ.get("PATH")
|
|
||||||
venv_path = sys.argv[0].strip("echobot")
|
|
||||||
os.environ["PATH"] = path + ":" + venv_path
|
|
||||||
with Rpc() as rpc:
|
|
||||||
deltachat = DeltaChat(rpc)
|
|
||||||
system_info = deltachat.get_system_info()
|
|
||||||
logging.info("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)
|
|
||||||
|
|
||||||
config = read_config(sys.argv[1])
|
|
||||||
|
|
||||||
# Create password file
|
|
||||||
if bot.is_configured():
|
|
||||||
password = bot.account.get_config("mail_pw")
|
|
||||||
else:
|
|
||||||
password = create_newemail_dict(config)["password"]
|
|
||||||
Path("/run/echobot/password").write_text(password)
|
|
||||||
|
|
||||||
# Give the user which doveauth runs as access to the password file.
|
|
||||||
subprocess.run(
|
|
||||||
["/usr/bin/setfacl", "-m", "user:vmail:r", "/run/echobot/password"],
|
|
||||||
check=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if not bot.is_configured():
|
|
||||||
email = "echo@" + config.mail_domain
|
|
||||||
bot.configure(email, password)
|
|
||||||
bot.run_forever()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
import os
|
|
||||||
import logging
|
|
||||||
import json
|
|
||||||
import filelock
|
|
||||||
from contextlib import contextmanager
|
|
||||||
|
|
||||||
|
|
||||||
class FileDict:
|
|
||||||
"""Concurrency-safe multi-reader/single-writer persistent dict."""
|
|
||||||
|
|
||||||
def __init__(self, path):
|
|
||||||
self.path = path
|
|
||||||
self.lock_path = path.with_name(path.name + ".lock")
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def modify(self):
|
|
||||||
# the OS will release the lock if the process dies,
|
|
||||||
# and the contextmanager will otherwise guarantee release
|
|
||||||
with filelock.FileLock(self.lock_path):
|
|
||||||
data = self.read()
|
|
||||||
yield data
|
|
||||||
write_path = self.path.with_name(self.path.name + ".tmp")
|
|
||||||
with write_path.open("w") as f:
|
|
||||||
json.dump(data, f)
|
|
||||||
os.rename(write_path, self.path)
|
|
||||||
|
|
||||||
def read(self):
|
|
||||||
try:
|
|
||||||
with self.path.open("r") as f:
|
|
||||||
return json.load(f)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return {}
|
|
||||||
except Exception:
|
|
||||||
logging.warning("corrupt serialization state at: %r", self.path)
|
|
||||||
return {}
|
|
||||||
@@ -111,9 +111,6 @@ class BeforeQueueHandler:
|
|||||||
if not mail_encrypted and check_mdn(message, envelope):
|
if not mail_encrypted and check_mdn(message, envelope):
|
||||||
return
|
return
|
||||||
|
|
||||||
if envelope.mail_from in self.config.passthrough_senders:
|
|
||||||
return
|
|
||||||
|
|
||||||
passthrough_recipients = self.config.passthrough_recipients
|
passthrough_recipients = self.config.passthrough_recipients
|
||||||
envelope_from_domain = from_addr.split("@").pop()
|
envelope_from_domain = from_addr.split("@").pop()
|
||||||
for recipient in envelope.rcpt_tos:
|
for recipient in envelope.rcpt_tos:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=Chatmail Postfix before queue filter
|
Description=Chatmail Postfix BeforeQeue filter
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} {config_path}
|
ExecStart={execpath} {config_path}
|
||||||
@@ -1,43 +1,17 @@
|
|||||||
[params]
|
[params]
|
||||||
|
|
||||||
# mail domain (MUST be set to fully qualified chat mail domain)
|
# mail domain (MUST be set to fully qualified chat mail domain)
|
||||||
mail_domain = {mail_domain}
|
mailname = {mailname}
|
||||||
|
|
||||||
#
|
#
|
||||||
# If you only do private test deploys, you don't need to modify any settings below
|
# If you only do private test deploys, you don't need to modify any settings below
|
||||||
#
|
#
|
||||||
|
|
||||||
#
|
|
||||||
# Account Restrictions
|
|
||||||
#
|
|
||||||
|
|
||||||
# how many mails a user can send out per minute
|
# how many mails a user can send out per minute
|
||||||
max_user_send_per_minute = 60
|
max_user_send_per_minute = 60
|
||||||
|
|
||||||
# maximum mailbox size of a chatmail account
|
|
||||||
max_mailbox_size = 100M
|
|
||||||
|
|
||||||
# days after which mails are unconditionally deleted
|
|
||||||
delete_mails_after = 40
|
|
||||||
|
|
||||||
# minimum length a username must have
|
|
||||||
username_min_length = 9
|
|
||||||
|
|
||||||
# maximum length a username can have
|
|
||||||
username_max_length = 9
|
|
||||||
|
|
||||||
# minimum length a password must have
|
|
||||||
password_min_length = 9
|
|
||||||
|
|
||||||
# list of chatmail accounts which can send outbound un-encrypted mail
|
|
||||||
passthrough_senders =
|
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
passthrough_recipients = xstore@testrun.org groupsbot@hispanilandia.net
|
passthrough_recipients =
|
||||||
|
|
||||||
#
|
|
||||||
# Deployment Details
|
|
||||||
#
|
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
# where the filtermail SMTP service listens
|
||||||
filtermail_smtp_port = 10080
|
filtermail_smtp_port = 10080
|
||||||
@@ -45,10 +19,6 @@ filtermail_smtp_port = 10080
|
|||||||
# postfix accepts on the localhost reinject SMTP port
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
postfix_reinject_port = 10025
|
postfix_reinject_port = 10025
|
||||||
|
|
||||||
#
|
|
||||||
# Privacy Policy
|
|
||||||
#
|
|
||||||
|
|
||||||
# postal address of privacy contact
|
# postal address of privacy contact
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
|
|
||||||
@@ -61,4 +31,3 @@ privacy_pdo =
|
|||||||
# postal address of the privacy supervisor
|
# postal address of the privacy supervisor
|
||||||
privacy_supervisor =
|
privacy_supervisor =
|
||||||
|
|
||||||
privacy_intro =
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
|
|
||||||
[privacy]
|
[privacy]
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org xstore@testrun.org groupsbot@hispanilandia.net
|
passthrough_recipients = privacy@testrun.org
|
||||||
|
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
@@ -14,7 +14,3 @@ privacy_pdo =
|
|||||||
privacy_supervisor =
|
privacy_supervisor =
|
||||||
State Commissioner for Data Protection and Freedom of Information of
|
State Commissioner for Data Protection and Freedom of Information of
|
||||||
Baden-Württemberg in 70173 Stuttgart, Germany.
|
Baden-Württemberg in 70173 Stuttgart, Germany.
|
||||||
privacy_intro =
|
|
||||||
This is the default onboarding server for Delta Chat.
|
|
||||||
If you don't choose to login to an existing email account,
|
|
||||||
you can get one on this server.
|
|
||||||
|
|||||||
@@ -1,153 +0,0 @@
|
|||||||
from pathlib import Path
|
|
||||||
from socketserver import (
|
|
||||||
UnixStreamServer,
|
|
||||||
StreamRequestHandler,
|
|
||||||
ThreadingMixIn,
|
|
||||||
)
|
|
||||||
import sys
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
|
|
||||||
from .filedict import FileDict
|
|
||||||
from .notifier import Notifier
|
|
||||||
|
|
||||||
|
|
||||||
DICTPROXY_HELLO_CHAR = "H"
|
|
||||||
DICTPROXY_LOOKUP_CHAR = "L"
|
|
||||||
DICTPROXY_ITERATE_CHAR = "I"
|
|
||||||
DICTPROXY_BEGIN_TRANSACTION_CHAR = "B"
|
|
||||||
DICTPROXY_SET_CHAR = "S"
|
|
||||||
DICTPROXY_COMMIT_TRANSACTION_CHAR = "C"
|
|
||||||
DICTPROXY_TRANSACTION_CHARS = "BSC"
|
|
||||||
|
|
||||||
|
|
||||||
class Metadata:
|
|
||||||
# each SETMETADATA on this key appends to a list of unique device tokens
|
|
||||||
# which only ever get removed if the upstream indicates the token is invalid
|
|
||||||
DEVICETOKEN_KEY = "devicetoken"
|
|
||||||
|
|
||||||
def __init__(self, vmail_dir):
|
|
||||||
self.vmail_dir = vmail_dir
|
|
||||||
|
|
||||||
def get_metadata_dict(self, addr):
|
|
||||||
return FileDict(self.vmail_dir / addr / "metadata.json")
|
|
||||||
|
|
||||||
def add_token_to_addr(self, addr, token):
|
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
|
||||||
tokens = data.setdefault(self.DEVICETOKEN_KEY, [])
|
|
||||||
if token not in tokens:
|
|
||||||
tokens.append(token)
|
|
||||||
|
|
||||||
def remove_token_from_addr(self, addr, token):
|
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
|
||||||
tokens = data.get(self.DEVICETOKEN_KEY, [])
|
|
||||||
if token in tokens:
|
|
||||||
tokens.remove(token)
|
|
||||||
|
|
||||||
def get_tokens_for_addr(self, addr):
|
|
||||||
mdict = self.get_metadata_dict(addr).read()
|
|
||||||
return mdict.get(self.DEVICETOKEN_KEY, [])
|
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_protocol(rfile, wfile, notifier, metadata):
|
|
||||||
transactions = {}
|
|
||||||
while True:
|
|
||||||
msg = rfile.readline().strip().decode()
|
|
||||||
if not msg:
|
|
||||||
break
|
|
||||||
|
|
||||||
res = handle_dovecot_request(msg, transactions, notifier, metadata)
|
|
||||||
if res:
|
|
||||||
wfile.write(res.encode("ascii"))
|
|
||||||
wfile.flush()
|
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_request(msg, transactions, notifier, metadata):
|
|
||||||
# see https://doc.dovecot.org/3.0/developer_manual/design/dict_protocol/
|
|
||||||
short_command = msg[0]
|
|
||||||
parts = msg[1:].split("\t")
|
|
||||||
if short_command == DICTPROXY_LOOKUP_CHAR:
|
|
||||||
# Lpriv/43f5f508a7ea0366dff30200c15250e3/devicetoken\tlkj123poi@c2.testrun.org
|
|
||||||
keyparts = parts[0].split("/")
|
|
||||||
if keyparts[0] == "priv":
|
|
||||||
keyname = keyparts[2]
|
|
||||||
addr = parts[1]
|
|
||||||
if keyname == metadata.DEVICETOKEN_KEY:
|
|
||||||
res = " ".join(metadata.get_tokens_for_addr(addr))
|
|
||||||
return f"O{res}\n"
|
|
||||||
logging.warning("lookup ignored: %r", msg)
|
|
||||||
return "N\n"
|
|
||||||
elif short_command == DICTPROXY_ITERATE_CHAR:
|
|
||||||
# Empty line means ITER_FINISHED.
|
|
||||||
# If we don't return empty line Dovecot will timeout.
|
|
||||||
return "\n"
|
|
||||||
elif short_command == DICTPROXY_HELLO_CHAR:
|
|
||||||
return # no version checking
|
|
||||||
|
|
||||||
if short_command not in (DICTPROXY_TRANSACTION_CHARS):
|
|
||||||
logging.warning("unknown dictproxy request: %r", msg)
|
|
||||||
return
|
|
||||||
|
|
||||||
transaction_id = parts[0]
|
|
||||||
|
|
||||||
if short_command == DICTPROXY_BEGIN_TRANSACTION_CHAR:
|
|
||||||
addr = parts[1]
|
|
||||||
transactions[transaction_id] = dict(addr=addr, res="O\n")
|
|
||||||
elif short_command == DICTPROXY_COMMIT_TRANSACTION_CHAR:
|
|
||||||
# each set devicetoken operation persists directly
|
|
||||||
# and does not wait until a "commit" comes
|
|
||||||
# because our dovecot config does not involve
|
|
||||||
# multiple set-operations in a single commit
|
|
||||||
return transactions.pop(transaction_id)["res"]
|
|
||||||
elif short_command == DICTPROXY_SET_CHAR:
|
|
||||||
# For documentation on key structure see
|
|
||||||
# https://github.com/dovecot/core/blob/main/src/lib-storage/mailbox-attribute.h
|
|
||||||
|
|
||||||
keyname = parts[1].split("/")
|
|
||||||
value = parts[2] if len(parts) > 2 else ""
|
|
||||||
addr = transactions[transaction_id]["addr"]
|
|
||||||
if keyname[0] == "priv" and keyname[2] == metadata.DEVICETOKEN_KEY:
|
|
||||||
metadata.add_token_to_addr(addr, value)
|
|
||||||
elif keyname[0] == "priv" and keyname[2] == "messagenew":
|
|
||||||
notifier.new_message_for_addr(addr, metadata)
|
|
||||||
else:
|
|
||||||
# Transaction failed.
|
|
||||||
transactions[transaction_id]["res"] = "F\n"
|
|
||||||
|
|
||||||
|
|
||||||
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
|
||||||
request_queue_size = 100
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
socket, vmail_dir = sys.argv[1:]
|
|
||||||
|
|
||||||
vmail_dir = Path(vmail_dir)
|
|
||||||
if not vmail_dir.exists():
|
|
||||||
logging.error("vmail dir does not exist: %r", vmail_dir)
|
|
||||||
return 1
|
|
||||||
|
|
||||||
queue_dir = vmail_dir / "pending_notifications"
|
|
||||||
queue_dir.mkdir(exist_ok=True)
|
|
||||||
metadata = Metadata(vmail_dir)
|
|
||||||
notifier = Notifier(queue_dir)
|
|
||||||
notifier.start_notification_threads(metadata.remove_token_from_addr)
|
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
|
||||||
def handle(self):
|
|
||||||
try:
|
|
||||||
handle_dovecot_protocol(self.rfile, self.wfile, notifier, metadata)
|
|
||||||
except Exception:
|
|
||||||
logging.exception("Exception in the dovecot dictproxy handler")
|
|
||||||
raise
|
|
||||||
|
|
||||||
try:
|
|
||||||
os.unlink(socket)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
with ThreadedUnixStreamServer(socket, Handler) as server:
|
|
||||||
try:
|
|
||||||
server.serve_forever()
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
pass
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
#!/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()
|
|
||||||
@@ -1,31 +1,23 @@
|
|||||||
#!/usr/local/lib/chatmaild/venv/bin/python3
|
#!/usr/bin/python3
|
||||||
|
|
||||||
""" CGI script for creating new accounts. """
|
""" CGI script for creating new accounts. """
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import random
|
import random
|
||||||
import secrets
|
|
||||||
import string
|
|
||||||
|
|
||||||
from chatmaild.config import read_config, Config
|
mailname_path = "/etc/mailname"
|
||||||
|
|
||||||
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
|
||||||
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
|
||||||
ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
|
||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(config: Config):
|
def create_newemail_dict(domain):
|
||||||
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
password = "".join(
|
user = "".join(random.choices(alphanumeric, k=9))
|
||||||
secrets.choice(ALPHANUMERIC_PUNCT)
|
password = "".join(random.choices(alphanumeric, k=12))
|
||||||
for _ in range(config.password_min_length + 3)
|
return dict(email=f"{user}@{domain}", password=f"{password}")
|
||||||
)
|
|
||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
config = read_config(CONFIG_PATH)
|
domain = open(mailname_path).read().strip()
|
||||||
creds = create_newemail_dict(config)
|
creds = create_newemail_dict(domain=domain)
|
||||||
|
|
||||||
print("Content-Type: application/json")
|
print("Content-Type: application/json")
|
||||||
print("")
|
print("")
|
||||||
|
|||||||
@@ -1,165 +0,0 @@
|
|||||||
"""
|
|
||||||
This modules provides notification machinery for transmitting device tokens to
|
|
||||||
a central notification server which in turn contacts a phone provider's notification server
|
|
||||||
to trigger Delta Chat apps to retrieve messages and provide instant notifications to users.
|
|
||||||
|
|
||||||
The Notifier class arranges the queuing of tokens in separate PriorityQueues
|
|
||||||
from which NotifyThreads take and transmit them via HTTPS
|
|
||||||
to the `notifications.delta.chat` service.
|
|
||||||
The current lack of proper HTTP/2-support in Python leads us
|
|
||||||
to use multiple threads and connections to the Rust-implemented `notifications.delta.chat`
|
|
||||||
which itself uses HTTP/2 and thus only a single connection to phone-notification providers.
|
|
||||||
|
|
||||||
If a token fails to cause a successful notification
|
|
||||||
it is moved to a retry-number specific PriorityQueue
|
|
||||||
which handles all tokens that failed a particular number of times
|
|
||||||
and which are scheduled for retry using exponential back-off timing.
|
|
||||||
If a token notification would be scheduled more than DROP_DEADLINE seconds
|
|
||||||
after its first attempt, it is dropped with a log error.
|
|
||||||
|
|
||||||
Note that tokens are completely opaque to the notification machinery here
|
|
||||||
and will in the future be encrypted foreclosing all ability to distinguish
|
|
||||||
which device token ultimately goes to which phone-provider notification service,
|
|
||||||
or to understand the relation of "device tokens" and chatmail addresses.
|
|
||||||
The meaning and format of tokens is basically a matter of Delta-Chat Core and
|
|
||||||
the `notification.delta.chat` service.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import time
|
|
||||||
import math
|
|
||||||
import logging
|
|
||||||
from uuid import uuid4
|
|
||||||
from threading import Thread
|
|
||||||
from pathlib import Path
|
|
||||||
from queue import PriorityQueue
|
|
||||||
from dataclasses import dataclass
|
|
||||||
import requests
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class PersistentQueueItem:
|
|
||||||
path: Path
|
|
||||||
addr: str
|
|
||||||
start_ts: int
|
|
||||||
token: str
|
|
||||||
|
|
||||||
def delete(self):
|
|
||||||
self.path.unlink(missing_ok=True)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def create(cls, queue_dir, addr, start_ts, token):
|
|
||||||
queue_id = uuid4().hex
|
|
||||||
start_ts = int(start_ts)
|
|
||||||
path = queue_dir.joinpath(queue_id)
|
|
||||||
tmp_path = path.with_name(path.name + ".tmp")
|
|
||||||
tmp_path.write_text(f"{addr}\n{start_ts}\n{token}")
|
|
||||||
os.rename(tmp_path, path)
|
|
||||||
return cls(path, addr, start_ts, token)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def read_from_path(cls, path):
|
|
||||||
addr, start_ts, token = path.read_text().split("\n", maxsplit=2)
|
|
||||||
return cls(path, addr, int(start_ts), token)
|
|
||||||
|
|
||||||
def __lt__(self, other):
|
|
||||||
return self.start_ts < other.start_ts
|
|
||||||
|
|
||||||
|
|
||||||
class Notifier:
|
|
||||||
URL = "https://notifications.delta.chat/notify"
|
|
||||||
CONNECTION_TIMEOUT = 60.0 # seconds until http-request is given up
|
|
||||||
BASE_DELAY = 8.0 # base seconds for exponential back-off delay
|
|
||||||
DROP_DEADLINE = 5 * 60 * 60 # drop notifications after 5 hours
|
|
||||||
|
|
||||||
def __init__(self, queue_dir):
|
|
||||||
self.queue_dir = queue_dir
|
|
||||||
max_tries = int(math.log(self.DROP_DEADLINE, self.BASE_DELAY)) + 1
|
|
||||||
self.retry_queues = [PriorityQueue() for _ in range(max_tries)]
|
|
||||||
|
|
||||||
def compute_delay(self, retry_num):
|
|
||||||
return 0 if retry_num == 0 else pow(self.BASE_DELAY, retry_num)
|
|
||||||
|
|
||||||
def new_message_for_addr(self, addr, metadata):
|
|
||||||
start_ts = int(time.time())
|
|
||||||
for token in metadata.get_tokens_for_addr(addr):
|
|
||||||
queue_item = PersistentQueueItem.create(
|
|
||||||
self.queue_dir, addr, start_ts, token
|
|
||||||
)
|
|
||||||
self.queue_for_retry(queue_item)
|
|
||||||
|
|
||||||
def requeue_persistent_queue_items(self):
|
|
||||||
for queue_path in self.queue_dir.iterdir():
|
|
||||||
if queue_path.name.endswith(".tmp"):
|
|
||||||
logging.warning("removing spurious queue item: %r", queue_path)
|
|
||||||
queue_path.unlink()
|
|
||||||
continue
|
|
||||||
queue_item = PersistentQueueItem.read_from_path(queue_path)
|
|
||||||
self.queue_for_retry(queue_item)
|
|
||||||
|
|
||||||
def queue_for_retry(self, queue_item, retry_num=0):
|
|
||||||
delay = self.compute_delay(retry_num)
|
|
||||||
when = int(time.time()) + delay
|
|
||||||
deadline = queue_item.start_ts + self.DROP_DEADLINE
|
|
||||||
if retry_num >= len(self.retry_queues) or when > deadline:
|
|
||||||
queue_item.delete()
|
|
||||||
logging.error("notification exceeded deadline: %r", queue_item.token)
|
|
||||||
return
|
|
||||||
|
|
||||||
self.retry_queues[retry_num].put((when, queue_item))
|
|
||||||
|
|
||||||
def start_notification_threads(self, remove_token_from_addr):
|
|
||||||
self.requeue_persistent_queue_items()
|
|
||||||
threads = {}
|
|
||||||
for retry_num in range(len(self.retry_queues)):
|
|
||||||
# use 4 threads for first-try tokens and less for subsequent tries
|
|
||||||
num_threads = 4 if retry_num == 0 else 2
|
|
||||||
threads[retry_num] = []
|
|
||||||
for _ in range(num_threads):
|
|
||||||
thread = NotifyThread(self, retry_num, remove_token_from_addr)
|
|
||||||
threads[retry_num].append(thread)
|
|
||||||
thread.start()
|
|
||||||
return threads
|
|
||||||
|
|
||||||
|
|
||||||
class NotifyThread(Thread):
|
|
||||||
def __init__(self, notifier, retry_num, remove_token_from_addr):
|
|
||||||
super().__init__(daemon=True)
|
|
||||||
self.notifier = notifier
|
|
||||||
self.retry_num = retry_num
|
|
||||||
self.remove_token_from_addr = remove_token_from_addr
|
|
||||||
|
|
||||||
def stop(self):
|
|
||||||
self.notifier.retry_queues[self.retry_num].put((None, None))
|
|
||||||
|
|
||||||
def run(self):
|
|
||||||
requests_session = requests.Session()
|
|
||||||
while self.retry_one(requests_session):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def retry_one(self, requests_session, sleep=time.sleep):
|
|
||||||
when, queue_item = self.notifier.retry_queues[self.retry_num].get()
|
|
||||||
if when is None:
|
|
||||||
return False
|
|
||||||
wait_time = when - int(time.time())
|
|
||||||
if wait_time > 0:
|
|
||||||
sleep(wait_time)
|
|
||||||
self.perform_request_to_notification_server(requests_session, queue_item)
|
|
||||||
return True
|
|
||||||
|
|
||||||
def perform_request_to_notification_server(self, requests_session, queue_item):
|
|
||||||
timeout = self.notifier.CONNECTION_TIMEOUT
|
|
||||||
token = queue_item.token
|
|
||||||
try:
|
|
||||||
res = requests_session.post(self.notifier.URL, data=token, timeout=timeout)
|
|
||||||
except requests.exceptions.RequestException as e:
|
|
||||||
res = e
|
|
||||||
else:
|
|
||||||
if res.status_code in (200, 410):
|
|
||||||
if res.status_code == 410:
|
|
||||||
self.remove_token_from_addr(queue_item.addr, token)
|
|
||||||
queue_item.delete()
|
|
||||||
return
|
|
||||||
|
|
||||||
logging.warning("Notification request failed: %r", res)
|
|
||||||
self.notifier.queue_for_retry(queue_item, retry_num=self.retry_num + 1)
|
|
||||||
@@ -7,7 +7,7 @@ Date: Sun, 15 Oct 2023 16:41:44 +0000
|
|||||||
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
Chat-Version: 1.0
|
Chat-Version: 1.0
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;
|
||||||
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
||||||
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
||||||
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
||||||
@@ -20,4 +20,4 @@ Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
|||||||
|
|
||||||
Hi!
|
Hi!
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,4 @@
|
|||||||
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
|
||||||
@@ -15,8 +13,8 @@ from chatmaild.config import read_config, write_initial_config
|
|||||||
def make_config(tmp_path):
|
def make_config(tmp_path):
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
|
||||||
def make_conf(mail_domain):
|
def make_conf(mailname):
|
||||||
write_initial_config(inipath, mail_domain=mail_domain)
|
write_initial_config(inipath, mailname=mailname)
|
||||||
return read_config(inipath)
|
return read_config(inipath)
|
||||||
|
|
||||||
return make_conf
|
return make_conf
|
||||||
@@ -29,7 +27,7 @@ def example_config(make_config):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain(example_config):
|
def maildomain(example_config):
|
||||||
return example_config.mail_domain
|
return example_config.mailname
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -59,12 +57,7 @@ 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):
|
||||||
|
|||||||
@@ -1,21 +1,22 @@
|
|||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_basic(example_config):
|
def test_read_config_basic(make_config):
|
||||||
assert example_config.mail_domain == "chat.example.org"
|
config = make_config("chat.example.org")
|
||||||
assert not example_config.privacy_supervisor and not example_config.privacy_mail
|
assert config.mailname == "chat.example.org"
|
||||||
assert not example_config.privacy_pdo and not example_config.privacy_postal
|
assert not config.privacy_supervisor and not config.privacy_mail
|
||||||
|
assert not config.privacy_pdo and not config.privacy_postal
|
||||||
|
|
||||||
inipath = example_config._inipath
|
inipath = config._inipath
|
||||||
inipath.write_text(inipath.read_text().replace("60", "37"))
|
inipath.write_text(inipath.read_text().replace("60", "37"))
|
||||||
example_config = read_config(inipath)
|
config = read_config(inipath)
|
||||||
assert example_config.max_user_send_per_minute == 37
|
assert config.max_user_send_per_minute == 37
|
||||||
assert example_config.mail_domain == "chat.example.org"
|
assert config.mailname == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_testrun(make_config):
|
def test_read_config_testrun(make_config):
|
||||||
config = make_config("something.testrun.org")
|
config = make_config("something.testrun.org")
|
||||||
assert config.mail_domain == "something.testrun.org"
|
assert config.mailname == "something.testrun.org"
|
||||||
assert len(config.privacy_postal.split("\n")) > 1
|
assert len(config.privacy_postal.split("\n")) > 1
|
||||||
assert len(config.privacy_supervisor.split("\n")) > 1
|
assert len(config.privacy_supervisor.split("\n")) > 1
|
||||||
assert len(config.privacy_pdo.split("\n")) > 1
|
assert len(config.privacy_pdo.split("\n")) > 1
|
||||||
@@ -23,10 +24,4 @@ def test_read_config_testrun(make_config):
|
|||||||
assert config.filtermail_smtp_port == 10080
|
assert config.filtermail_smtp_port == 10080
|
||||||
assert config.postfix_reinject_port == 10025
|
assert config.postfix_reinject_port == 10025
|
||||||
assert config.max_user_send_per_minute == 60
|
assert config.max_user_send_per_minute == 60
|
||||||
assert config.max_mailbox_size == "100M"
|
assert config.passthrough_recipients
|
||||||
assert config.delete_mails_after == "40"
|
|
||||||
assert config.username_min_length == 9
|
|
||||||
assert config.username_max_length == 9
|
|
||||||
assert config.password_min_length == 9
|
|
||||||
assert "privacy@testrun.org" in config.passthrough_recipients
|
|
||||||
assert config.passthrough_senders == []
|
|
||||||
|
|||||||
@@ -1,49 +1,37 @@
|
|||||||
import io
|
|
||||||
import json
|
import json
|
||||||
import pytest
|
import pytest
|
||||||
import queue
|
|
||||||
import threading
|
import threading
|
||||||
|
import queue
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
import chatmaild.doveauth
|
import chatmaild.doveauth
|
||||||
from chatmaild.doveauth import (
|
from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_request
|
||||||
get_user_data,
|
|
||||||
lookup_passdb,
|
|
||||||
handle_dovecot_request,
|
|
||||||
handle_dovecot_protocol,
|
|
||||||
)
|
|
||||||
from chatmaild.database import DBError
|
from chatmaild.database import DBError
|
||||||
|
|
||||||
|
|
||||||
def test_basic(db, example_config):
|
def test_basic(db):
|
||||||
lookup_passdb(db, example_config, "asdf12345@chat.example.org", "q9mr3faue")
|
lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u")
|
||||||
data = get_user_data(db, example_config, "asdf12345@chat.example.org")
|
data = get_user_data(db, "link2xt@c1.testrun.org")
|
||||||
assert data
|
assert data
|
||||||
data2 = lookup_passdb(
|
data2 = lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u")
|
||||||
db, example_config, "asdf12345@chat.example.org", "q9mr3jewvadsfaue"
|
|
||||||
)
|
|
||||||
assert data == data2
|
assert data == data2
|
||||||
|
|
||||||
|
|
||||||
def test_dont_overwrite_password_on_wrong_login(db, example_config):
|
def test_dont_overwrite_password_on_wrong_login(db):
|
||||||
"""Test that logging in with a different password doesn't create a new user"""
|
"""Test that logging in with a different password doesn't create a new user"""
|
||||||
res = lookup_passdb(
|
res = lookup_passdb(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983")
|
||||||
db, example_config, "newuser12@chat.example.org", "kajdlkajsldk12l3kj1983"
|
|
||||||
)
|
|
||||||
assert res["password"]
|
assert res["password"]
|
||||||
res2 = lookup_passdb(db, example_config, "newuser12@chat.example.org", "kajdslqwe")
|
res2 = lookup_passdb(db, "newuser1@something.org", "kajdlqweqwe")
|
||||||
# this function always returns a password hash, which is actually compared by dovecot.
|
# this function always returns a password hash, which is actually compared by dovecot.
|
||||||
assert res["password"] == res2["password"]
|
assert res["password"] == res2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_nocreate_file(db, monkeypatch, tmpdir, example_config):
|
def test_nocreate_file(db, monkeypatch, tmpdir):
|
||||||
p = tmpdir.join("nocreate")
|
p = tmpdir.join("nocreate")
|
||||||
p.write("")
|
p.write("")
|
||||||
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
||||||
lookup_passdb(
|
lookup_passdb(db, "newuser1@something.org", "zequ0Aimuchoodaechik")
|
||||||
db, example_config, "newuser12@chat.example.org", "zequ0Aimuchoodaechik"
|
assert not get_user_data(db, "newuser1@something.org")
|
||||||
)
|
|
||||||
assert not get_user_data(db, example_config, "newuser12@chat.example.org")
|
|
||||||
|
|
||||||
|
|
||||||
def test_db_version(db):
|
def test_db_version(db):
|
||||||
@@ -57,42 +45,21 @@ def test_too_high_db_version(db):
|
|||||||
db.ensure_tables()
|
db.ensure_tables()
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request(db, example_config):
|
def test_handle_dovecot_request(db):
|
||||||
# Test that password can contain ", ', \ and /
|
|
||||||
msg = (
|
msg = (
|
||||||
'Lshared/passdb/laksjdlaksjdlak\\\\sjdlk\\"12j\\\'3l1/k2j3123"'
|
"Lshared/passdb/laksjdlaksjdlaksjdlk12j3l1k2j3123/"
|
||||||
"some42123@chat.example.org\tsome42123@chat.example.org"
|
"some42@c3.testrun.org\tsome42@c3.testrun.org"
|
||||||
)
|
)
|
||||||
res = handle_dovecot_request(msg, db, example_config)
|
res = handle_dovecot_request(msg, db, "c3.testrun.org")
|
||||||
assert res
|
assert res
|
||||||
assert res[0] == "O" and res.endswith("\n")
|
assert res[0] == "O" and res.endswith("\n")
|
||||||
userdata = json.loads(res[1:].strip())
|
userdata = json.loads(res[1:].strip())
|
||||||
assert (
|
assert userdata["home"] == "/home/vmail/some42@c3.testrun.org"
|
||||||
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_hello_is_skipped(db, example_config, caplog):
|
def test_50_concurrent_lookups_different_accounts(db, gencreds):
|
||||||
rfile = io.BytesIO(b"H3\t2\t0\t\tauth\n")
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
handle_dovecot_protocol(rfile, wfile, db, example_config)
|
|
||||||
assert wfile.getvalue() == b""
|
|
||||||
assert not caplog.messages
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol(db, example_config):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"H3\t2\t0\t\tauth\nLshared/userdb/foobar@chat.example.org\tfoobar@chat.example.org\n"
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
handle_dovecot_protocol(rfile, wfile, db, example_config)
|
|
||||||
assert wfile.getvalue() == b"N\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
|
||||||
num_threads = 50
|
num_threads = 50
|
||||||
req_per_thread = 5
|
req_per_thread = 5
|
||||||
results = queue.Queue()
|
results = queue.Queue()
|
||||||
@@ -101,7 +68,7 @@ def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
|||||||
for i in range(req_per_thread):
|
for i in range(req_per_thread):
|
||||||
addr, password = gencreds()
|
addr, password = gencreds()
|
||||||
try:
|
try:
|
||||||
lookup_passdb(db, example_config, addr, password)
|
lookup_passdb(db, addr, password)
|
||||||
except Exception:
|
except Exception:
|
||||||
results.put(traceback.format_exc())
|
results.put(traceback.format_exc())
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
from chatmaild.filedict import FileDict
|
|
||||||
|
|
||||||
|
|
||||||
def test_basic(tmp_path):
|
|
||||||
fdict = FileDict(tmp_path.joinpath("metadata"))
|
|
||||||
assert fdict.read() == {}
|
|
||||||
with fdict.modify() as d:
|
|
||||||
d["devicetoken"] = [1, 2, 3]
|
|
||||||
d["456"] = 4.2
|
|
||||||
new = fdict.read()
|
|
||||||
assert new["devicetoken"] == [1, 2, 3]
|
|
||||||
assert new["456"] == 4.2
|
|
||||||
|
|
||||||
|
|
||||||
def test_bad_marshal_file(tmp_path, caplog):
|
|
||||||
fdict1 = FileDict(tmp_path.joinpath("metadata"))
|
|
||||||
fdict1.path.write_bytes(b"l12k3l12k3l")
|
|
||||||
assert fdict1.read() == {}
|
|
||||||
assert "corrupt" in caplog.records[0].msg
|
|
||||||
@@ -127,19 +127,3 @@ def test_excempt_privacy(maildata, gencreds, handler):
|
|||||||
content = msg.as_bytes()
|
content = msg.as_bytes()
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
assert "500" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
def test_passthrough_senders(gencreds, handler, maildata):
|
|
||||||
acc1 = gencreds()[0]
|
|
||||||
to_addr = "recipient@something.org"
|
|
||||||
handler.config.passthrough_senders = [acc1]
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", acc1, to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = acc1
|
|
||||||
rcpt_tos = to_addr
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
# assert that None/no error is returned
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|||||||
@@ -1,298 +0,0 @@
|
|||||||
import io
|
|
||||||
import pytest
|
|
||||||
import requests
|
|
||||||
import time
|
|
||||||
|
|
||||||
from chatmaild.metadata import (
|
|
||||||
handle_dovecot_request,
|
|
||||||
handle_dovecot_protocol,
|
|
||||||
Metadata,
|
|
||||||
)
|
|
||||||
from chatmaild.notifier import (
|
|
||||||
Notifier,
|
|
||||||
NotifyThread,
|
|
||||||
PersistentQueueItem,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def notifier(metadata):
|
|
||||||
queue_dir = metadata.vmail_dir.joinpath("pending_notifications")
|
|
||||||
queue_dir.mkdir()
|
|
||||||
return Notifier(queue_dir)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def metadata(tmp_path):
|
|
||||||
vmail_dir = tmp_path.joinpath("vmaildir")
|
|
||||||
vmail_dir.mkdir()
|
|
||||||
return Metadata(vmail_dir)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def testaddr():
|
|
||||||
return "user.name@example.org"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def testaddr2():
|
|
||||||
return "user2@example.org"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def token():
|
|
||||||
return "01234"
|
|
||||||
|
|
||||||
|
|
||||||
def get_mocked_requests(statuslist):
|
|
||||||
class ReqMock:
|
|
||||||
requests = []
|
|
||||||
|
|
||||||
def post(self, url, data, timeout):
|
|
||||||
self.requests.append((url, data, timeout))
|
|
||||||
res = statuslist.pop(0)
|
|
||||||
if isinstance(res, Exception):
|
|
||||||
raise res
|
|
||||||
|
|
||||||
class Result:
|
|
||||||
status_code = res
|
|
||||||
|
|
||||||
return Result()
|
|
||||||
|
|
||||||
return ReqMock()
|
|
||||||
|
|
||||||
|
|
||||||
def test_metadata_persistence(tmp_path, testaddr, testaddr2):
|
|
||||||
metadata1 = Metadata(tmp_path)
|
|
||||||
metadata2 = Metadata(tmp_path)
|
|
||||||
assert not metadata1.get_tokens_for_addr(testaddr)
|
|
||||||
assert not metadata2.get_tokens_for_addr(testaddr)
|
|
||||||
|
|
||||||
metadata1.add_token_to_addr(testaddr, "01234")
|
|
||||||
metadata1.add_token_to_addr(testaddr2, "456")
|
|
||||||
assert metadata2.get_tokens_for_addr(testaddr) == ["01234"]
|
|
||||||
assert metadata2.get_tokens_for_addr(testaddr2) == ["456"]
|
|
||||||
metadata2.remove_token_from_addr(testaddr, "01234")
|
|
||||||
assert not metadata1.get_tokens_for_addr(testaddr)
|
|
||||||
assert metadata1.get_tokens_for_addr(testaddr2) == ["456"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_remove_nonexisting(metadata, tmp_path, testaddr):
|
|
||||||
metadata.add_token_to_addr(testaddr, "123")
|
|
||||||
metadata.remove_token_from_addr(testaddr, "1l23k1l2k3")
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["123"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_notifier_remove_without_set(metadata, testaddr):
|
|
||||||
metadata.remove_token_from_addr(testaddr, "123")
|
|
||||||
assert not metadata.get_tokens_for_addr(testaddr)
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request_lookup_fails(notifier, metadata, testaddr):
|
|
||||||
res = handle_dovecot_request(
|
|
||||||
f"Lpriv/123/chatmail\t{testaddr}", {}, notifier, metadata
|
|
||||||
)
|
|
||||||
assert res == "N\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request_happy_path(notifier, metadata, testaddr, token):
|
|
||||||
transactions = {}
|
|
||||||
|
|
||||||
# set device token in a transaction
|
|
||||||
tx = "1111"
|
|
||||||
msg = f"B{tx}\t{testaddr}"
|
|
||||||
res = handle_dovecot_request(msg, transactions, notifier, metadata)
|
|
||||||
assert not res and not metadata.get_tokens_for_addr(testaddr)
|
|
||||||
assert transactions == {tx: dict(addr=testaddr, res="O\n")}
|
|
||||||
|
|
||||||
msg = f"S{tx}\tpriv/guid00/devicetoken\t{token}"
|
|
||||||
res = handle_dovecot_request(msg, transactions, notifier, metadata)
|
|
||||||
assert not res
|
|
||||||
assert len(transactions) == 1
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == [token]
|
|
||||||
|
|
||||||
msg = f"C{tx}"
|
|
||||||
res = handle_dovecot_request(msg, transactions, notifier, metadata)
|
|
||||||
assert res == "O\n"
|
|
||||||
assert len(transactions) == 0
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == [token]
|
|
||||||
|
|
||||||
# trigger notification for incoming message
|
|
||||||
tx2 = "2222"
|
|
||||||
assert (
|
|
||||||
handle_dovecot_request(f"B{tx2}\t{testaddr}", transactions, notifier, metadata)
|
|
||||||
is None
|
|
||||||
)
|
|
||||||
msg = f"S{tx2}\tpriv/guid00/messagenew"
|
|
||||||
assert handle_dovecot_request(msg, transactions, notifier, metadata) is None
|
|
||||||
queue_item = notifier.retry_queues[0].get()[1]
|
|
||||||
assert queue_item.token == token
|
|
||||||
assert handle_dovecot_request(f"C{tx2}", transactions, notifier, metadata) == "O\n"
|
|
||||||
assert not transactions
|
|
||||||
assert queue_item.path.exists()
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_set_devicetoken(metadata, notifier):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"HELLO",
|
|
||||||
b"Btx00\tuser@example.org",
|
|
||||||
b"Stx00\tpriv/guid00/devicetoken\t01234",
|
|
||||||
b"Ctx00",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
handle_dovecot_protocol(rfile, wfile, notifier, metadata)
|
|
||||||
assert wfile.getvalue() == b"O\n"
|
|
||||||
assert metadata.get_tokens_for_addr("user@example.org") == ["01234"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_set_get_devicetoken(metadata, notifier):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"HELLO",
|
|
||||||
b"Btx00\tuser@example.org",
|
|
||||||
b"Stx00\tpriv/guid00/devicetoken\t01234",
|
|
||||||
b"Ctx00",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
handle_dovecot_protocol(rfile, wfile, notifier, metadata)
|
|
||||||
assert metadata.get_tokens_for_addr("user@example.org") == ["01234"]
|
|
||||||
assert wfile.getvalue() == b"O\n"
|
|
||||||
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join([b"HELLO", b"Lpriv/0123/devicetoken\tuser@example.org"])
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
handle_dovecot_protocol(rfile, wfile, notifier, metadata)
|
|
||||||
assert wfile.getvalue() == b"O01234\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_protocol_iterate(metadata, notifier):
|
|
||||||
rfile = io.BytesIO(
|
|
||||||
b"\n".join(
|
|
||||||
[
|
|
||||||
b"H",
|
|
||||||
b"I9\t0\tpriv/5cbe730f146fea6535be0d003dd4fc98/\tci-2dzsrs@nine.testrun.org",
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
wfile = io.BytesIO()
|
|
||||||
handle_dovecot_protocol(rfile, wfile, notifier, metadata)
|
|
||||||
assert wfile.getvalue() == b"\n"
|
|
||||||
|
|
||||||
|
|
||||||
def test_notifier_thread_deletes_persistent_file(metadata, notifier, testaddr):
|
|
||||||
reqmock = get_mocked_requests([200])
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
url, data, timeout = reqmock.requests[0]
|
|
||||||
assert data == "01234"
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["01234"]
|
|
||||||
notifier.requeue_persistent_queue_items()
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("status", [requests.exceptions.RequestException(), 404, 500])
|
|
||||||
def test_notifier_thread_connection_failures(
|
|
||||||
metadata, notifier, testaddr, status, caplog
|
|
||||||
):
|
|
||||||
"""test that tokens keep getting retried until they are given up."""
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
notifier.NOTIFICATION_RETRY_DELAY = 5
|
|
||||||
max_tries = len(notifier.retry_queues)
|
|
||||||
for i in range(max_tries):
|
|
||||||
caplog.clear()
|
|
||||||
reqmock = get_mocked_requests([status])
|
|
||||||
sleep_calls = []
|
|
||||||
NotifyThread(notifier, i, None).retry_one(reqmock, sleep=sleep_calls.append)
|
|
||||||
assert notifier.retry_queues[i].qsize() == 0
|
|
||||||
assert "request failed" in caplog.records[0].msg
|
|
||||||
if i > 0:
|
|
||||||
assert len(sleep_calls) == 1
|
|
||||||
if i + 1 < max_tries:
|
|
||||||
assert notifier.retry_queues[i + 1].qsize() == 1
|
|
||||||
assert len(caplog.records) == 1
|
|
||||||
else:
|
|
||||||
assert len(caplog.records) == 2
|
|
||||||
assert "deadline" in caplog.records[1].msg
|
|
||||||
notifier.requeue_persistent_queue_items()
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
|
|
||||||
|
|
||||||
def test_requeue_removes_tmp_files(notifier, metadata, testaddr, caplog):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
p = notifier.queue_dir.joinpath("1203981203.tmp")
|
|
||||||
p.touch()
|
|
||||||
notifier2 = notifier.__class__(notifier.queue_dir)
|
|
||||||
notifier2.requeue_persistent_queue_items()
|
|
||||||
assert "spurious" in caplog.records[0].msg
|
|
||||||
assert not p.exists()
|
|
||||||
assert notifier2.retry_queues[0].qsize() == 1
|
|
||||||
when, queue_item = notifier2.retry_queues[0].get()
|
|
||||||
assert when <= int(time.time())
|
|
||||||
assert queue_item.addr == testaddr
|
|
||||||
|
|
||||||
|
|
||||||
def test_start_and_stop_notification_threads(notifier, testaddr):
|
|
||||||
threads = notifier.start_notification_threads(None)
|
|
||||||
for retry_num, threadlist in threads.items():
|
|
||||||
for t in threadlist:
|
|
||||||
t.stop()
|
|
||||||
t.join()
|
|
||||||
|
|
||||||
|
|
||||||
def test_multi_device_notifier(metadata, notifier, testaddr):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
metadata.add_token_to_addr(testaddr, "56789")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
reqmock = get_mocked_requests([200, 200])
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
assert notifier.retry_queues[1].qsize() == 0
|
|
||||||
url, data, timeout = reqmock.requests[0]
|
|
||||||
assert data == "01234"
|
|
||||||
url, data, timeout = reqmock.requests[1]
|
|
||||||
assert data == "56789"
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["01234", "56789"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_notifier_thread_run_gone_removes_token(metadata, notifier, testaddr):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
metadata.add_token_to_addr(testaddr, "45678")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
|
|
||||||
reqmock = get_mocked_requests([410, 200])
|
|
||||||
NotifyThread(notifier, 0, metadata.remove_token_from_addr).retry_one(reqmock)
|
|
||||||
NotifyThread(notifier, 0, None).retry_one(reqmock)
|
|
||||||
url, data, timeout = reqmock.requests[0]
|
|
||||||
assert data == "01234"
|
|
||||||
url, data, timeout = reqmock.requests[1]
|
|
||||||
assert data == "45678"
|
|
||||||
assert metadata.get_tokens_for_addr(testaddr) == ["45678"]
|
|
||||||
assert notifier.retry_queues[0].qsize() == 0
|
|
||||||
assert notifier.retry_queues[1].qsize() == 0
|
|
||||||
|
|
||||||
|
|
||||||
def test_persistent_queue_items(tmp_path, testaddr, token):
|
|
||||||
queue_item = PersistentQueueItem.create(tmp_path, testaddr, 432, token)
|
|
||||||
assert queue_item.addr == testaddr
|
|
||||||
assert queue_item.start_ts == 432
|
|
||||||
assert queue_item.token == token
|
|
||||||
item2 = PersistentQueueItem.read_from_path(queue_item.path)
|
|
||||||
assert item2.addr == testaddr
|
|
||||||
assert item2.start_ts == 432
|
|
||||||
assert item2.token == token
|
|
||||||
assert item2 == queue_item
|
|
||||||
item2.delete()
|
|
||||||
assert not item2.path.exists()
|
|
||||||
assert not queue_item < item2 and not item2 < queue_item
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
from chatmaild.metrics import main
|
|
||||||
|
|
||||||
|
|
||||||
def test_main(tmp_path, capsys):
|
|
||||||
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
|
||||||
tmp_path.joinpath(x).mkdir()
|
|
||||||
main(tmp_path)
|
|
||||||
out, _ = capsys.readouterr()
|
|
||||||
d = {}
|
|
||||||
for line in out.split("\n"):
|
|
||||||
if line.strip():
|
|
||||||
name, num, _ = line.split()
|
|
||||||
d[name] = int(num)
|
|
||||||
|
|
||||||
assert d["accounts"] == 4
|
|
||||||
assert d["ci_accounts"] == 3
|
|
||||||
@@ -4,24 +4,26 @@ import chatmaild
|
|||||||
from chatmaild.newemail import create_newemail_dict, print_new_account
|
from chatmaild.newemail import create_newemail_dict, print_new_account
|
||||||
|
|
||||||
|
|
||||||
def test_create_newemail_dict(example_config):
|
def test_create_newemail_dict():
|
||||||
ac1 = create_newemail_dict(example_config)
|
ac1 = create_newemail_dict(domain="example.org")
|
||||||
assert "@" in ac1["email"]
|
assert "@" in ac1["email"]
|
||||||
assert len(ac1["password"]) >= 10
|
assert len(ac1["password"]) >= 10
|
||||||
|
|
||||||
ac2 = create_newemail_dict(example_config)
|
ac2 = create_newemail_dict(domain="example.org")
|
||||||
|
|
||||||
assert ac1["email"] != ac2["email"]
|
assert ac1["email"] != ac2["email"]
|
||||||
assert ac1["password"] != ac2["password"]
|
assert ac1["password"] != ac2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir):
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
p = tmpdir.join("mailname")
|
||||||
|
p.write(maildomain)
|
||||||
|
monkeypatch.setattr(chatmaild.newemail, "mailname_path", str(p))
|
||||||
print_new_account()
|
print_new_account()
|
||||||
out, err = capsys.readouterr()
|
out, err = capsys.readouterr()
|
||||||
lines = out.split("\n")
|
lines = out.split("\n")
|
||||||
assert lines[0] == "Content-Type: application/json"
|
assert lines[0] == "Content-Type: application/json"
|
||||||
assert not lines[1]
|
assert not lines[1]
|
||||||
dic = json.loads(lines[2])
|
dic = json.loads(lines[2])
|
||||||
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
assert dic["email"].endswith(f"@{maildomain}")
|
||||||
assert len(dic["password"]) >= 10
|
assert len(dic["password"]) >= 10
|
||||||
|
|||||||
@@ -1,75 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
|
|
||||||
from pyinfra.operations import apt, files, systemd, server
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.systemd import SystemdStatus
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_acmetool(email="", domains=[]):
|
|
||||||
"""Deploy acmetool."""
|
|
||||||
apt.packages(
|
|
||||||
name="Install acmetool",
|
|
||||||
packages=["acmetool"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("acmetool.cron").open("rb"),
|
|
||||||
dest="/etc/cron.d/acmetool",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("acmetool.hook").open("rb"),
|
|
||||||
dest="/usr/lib/acme/hooks/nginx",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="744",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("response-file.yaml.j2"),
|
|
||||||
dest="/var/lib/acme/conf/responses",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
email=email,
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
|
||||||
dest="/var/lib/acme/conf/target",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
service_file = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"acmetool-redirector.service"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/acmetool-redirector.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
if host.get_fact(SystemdStatus).get("nginx.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Stop nginx service to free port 80",
|
|
||||||
service="nginx",
|
|
||||||
running=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Setup acmetool-redirector service",
|
|
||||||
service="acmetool-redirector.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=service_file.changed,
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name=f"Request certificate for: { ', '.join(domains) }",
|
|
||||||
commands=[f"acmetool want --xlog.severity=debug { ' '.join(domains)}"],
|
|
||||||
)
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=acmetool HTTP redirector
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=notify
|
|
||||||
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
SHELL=/bin/sh
|
|
||||||
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin
|
|
||||||
MAILTO=root
|
|
||||||
20 16 * * * root /usr/bin/acmetool --batch reconcile && systemctl reload dovecot && systemctl reload postfix
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
"acme-enter-email": "{{ email }}"
|
|
||||||
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.4-April-3-2024.pdf": true
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
{chatmail_domain}. A {ipv4}
|
|
||||||
{chatmail_domain}. AAAA {ipv6}
|
|
||||||
{chatmail_domain}. MX 10 {chatmail_domain}.
|
|
||||||
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
|
||||||
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
|
||||||
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
|
||||||
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
|
||||||
{chatmail_domain}. CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
|
||||||
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} ~all"
|
|
||||||
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
|
||||||
_mta-sts.{chatmail_domain}. TXT "v=STSv1; id={sts_id}"
|
|
||||||
mta-sts.{chatmail_domain}. CNAME {chatmail_domain}.
|
|
||||||
www.{chatmail_domain}. CNAME {chatmail_domain}.
|
|
||||||
{dkim_entry}
|
|
||||||
_adsp._domainkey.{chatmail_domain}. TXT "dkim=discardable"
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
import os
|
|
||||||
import importlib.resources
|
|
||||||
import pyinfra
|
|
||||||
from cmdeploy import deploy_chatmail
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
config_path = os.getenv(
|
|
||||||
"CHATMAIL_INI",
|
|
||||||
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
|
||||||
)
|
|
||||||
|
|
||||||
deploy_chatmail(config_path)
|
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
|
||||||
main()
|
|
||||||
@@ -1,208 +0,0 @@
|
|||||||
import sys
|
|
||||||
|
|
||||||
import requests
|
|
||||||
import importlib
|
|
||||||
import subprocess
|
|
||||||
import datetime
|
|
||||||
|
|
||||||
|
|
||||||
class DNS:
|
|
||||||
def __init__(self, out, mail_domain):
|
|
||||||
self.session = requests.Session()
|
|
||||||
self.out = out
|
|
||||||
self.ssh = f"ssh root@{mail_domain} -- "
|
|
||||||
self.out.shell_output(
|
|
||||||
f"{ self.ssh }'apt-get update && apt-get install -y dnsutils'",
|
|
||||||
timeout=60,
|
|
||||||
no_print=True,
|
|
||||||
)
|
|
||||||
try:
|
|
||||||
self.shell(f"unbound-control flush_zone {mail_domain}")
|
|
||||||
except subprocess.CalledProcessError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
def shell(self, cmd):
|
|
||||||
try:
|
|
||||||
return self.out.shell_output(f"{self.ssh}{cmd}", no_print=True)
|
|
||||||
except (subprocess.CalledProcessError, subprocess.TimeoutExpired) as e:
|
|
||||||
if "exit status 255" in str(e) or "timed out" in str(e):
|
|
||||||
self.out.red(f"Error: can't reach the server with: {self.ssh[:-4]}")
|
|
||||||
sys.exit(1)
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
|
|
||||||
def get_ipv4(self):
|
|
||||||
cmd = "ip a | grep 'inet ' | grep 'scope global' | grep -oE '[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}' | head -1"
|
|
||||||
return self.shell(cmd).strip()
|
|
||||||
|
|
||||||
def get_ipv6(self):
|
|
||||||
cmd = "ip a | grep inet6 | grep 'scope global' | sed -e 's#/64 scope global##' | sed -e 's#inet6##'"
|
|
||||||
return self.shell(cmd).strip()
|
|
||||||
|
|
||||||
def get(self, typ: str, domain: str) -> str:
|
|
||||||
"""Get a DNS entry or empty string if there is none."""
|
|
||||||
dig_result = self.shell(f"dig -r -q {domain} -t {typ} +short")
|
|
||||||
line = dig_result.partition("\n")[0]
|
|
||||||
return line
|
|
||||||
|
|
||||||
def check_ptr_record(self, ip: str, mail_domain) -> bool:
|
|
||||||
"""Check the PTR record for an IPv4 or IPv6 address."""
|
|
||||||
result = self.shell(f"dig -r -x {ip} +short").rstrip()
|
|
||||||
return result == f"{mail_domain}."
|
|
||||||
|
|
||||||
|
|
||||||
def show_dns(args, out) -> int:
|
|
||||||
"""Check existing DNS records, optionally write them to zone file, return exit code 0 or 1."""
|
|
||||||
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
|
||||||
mail_domain = args.config.mail_domain
|
|
||||||
ssh = f"ssh root@{mail_domain}"
|
|
||||||
dns = DNS(out, mail_domain)
|
|
||||||
|
|
||||||
print("Checking your DKIM keys and DNS entries...")
|
|
||||||
try:
|
|
||||||
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
|
||||||
except subprocess.CalledProcessError:
|
|
||||||
print("Please run `cmdeploy run` first.")
|
|
||||||
return 1
|
|
||||||
|
|
||||||
dkim_selector = "opendkim"
|
|
||||||
dkim_pubkey = out.shell_output(
|
|
||||||
ssh + f" -- openssl rsa -in /etc/dkimkeys/{dkim_selector}.private"
|
|
||||||
" -pubout 2>/dev/null | awk '/-/{next}{printf(\"%s\",$0)}'"
|
|
||||||
)
|
|
||||||
dkim_entry_value = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
|
||||||
dkim_entry_str = ""
|
|
||||||
while len(dkim_entry_value) >= 255:
|
|
||||||
dkim_entry_str += '"' + dkim_entry_value[:255] + '" '
|
|
||||||
dkim_entry_value = dkim_entry_value[255:]
|
|
||||||
dkim_entry_str += '"' + dkim_entry_value + '"'
|
|
||||||
dkim_entry = f"{dkim_selector}._domainkey.{mail_domain}. TXT {dkim_entry_str}"
|
|
||||||
|
|
||||||
ipv6 = dns.get_ipv6()
|
|
||||||
reverse_ipv6 = dns.check_ptr_record(ipv6, mail_domain)
|
|
||||||
ipv4 = dns.get_ipv4()
|
|
||||||
reverse_ipv4 = dns.check_ptr_record(ipv4, mail_domain)
|
|
||||||
to_print = []
|
|
||||||
|
|
||||||
with open(template, "r") as f:
|
|
||||||
zonefile = (
|
|
||||||
f.read()
|
|
||||||
.format(
|
|
||||||
acme_account_url=acme_account_url,
|
|
||||||
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
|
||||||
chatmail_domain=args.config.mail_domain,
|
|
||||||
dkim_entry=dkim_entry,
|
|
||||||
ipv6=ipv6,
|
|
||||||
ipv4=ipv4,
|
|
||||||
)
|
|
||||||
.strip()
|
|
||||||
)
|
|
||||||
try:
|
|
||||||
with open(args.zonefile, "w+") as zf:
|
|
||||||
zf.write(zonefile)
|
|
||||||
print(f"DNS records successfully written to: {args.zonefile}")
|
|
||||||
return 0
|
|
||||||
except TypeError:
|
|
||||||
pass
|
|
||||||
for line in zonefile.splitlines():
|
|
||||||
line = line.format(
|
|
||||||
acme_account_url=acme_account_url,
|
|
||||||
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
|
||||||
chatmail_domain=args.config.mail_domain,
|
|
||||||
dkim_entry=dkim_entry,
|
|
||||||
ipv6=ipv6,
|
|
||||||
).strip()
|
|
||||||
for typ in ["A", "AAAA", "CNAME", "CAA"]:
|
|
||||||
if f" {typ} " in line:
|
|
||||||
domain, value = line.split(f" {typ} ")
|
|
||||||
current = dns.get(typ, domain.strip()[:-1])
|
|
||||||
if current != value.strip():
|
|
||||||
to_print.append(line)
|
|
||||||
if " MX " in line:
|
|
||||||
domain, typ, prio, value = line.split()
|
|
||||||
current = dns.get(typ, domain[:-1])
|
|
||||||
if not current:
|
|
||||||
to_print.append(line)
|
|
||||||
elif current.split()[1] != value:
|
|
||||||
print(line.replace(prio, str(int(current[0]) + 1)))
|
|
||||||
if " SRV " in line:
|
|
||||||
domain, typ, prio, weight, port, value = line.split()
|
|
||||||
current = dns.get("SRV", domain[:-1])
|
|
||||||
if current != f"{prio} {weight} {port} {value}":
|
|
||||||
to_print.append(line)
|
|
||||||
if " TXT " in line:
|
|
||||||
domain, value = line.split(" TXT ")
|
|
||||||
current = dns.get("TXT", domain.strip()[:-1])
|
|
||||||
if domain.startswith("_mta-sts."):
|
|
||||||
if current:
|
|
||||||
if current.split("id=")[0] == value.split("id=")[0]:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# TXT records longer than 255 bytes
|
|
||||||
# are split into multiple <character-string>s.
|
|
||||||
# This typically happens with DKIM record
|
|
||||||
# which contains long RSA key.
|
|
||||||
#
|
|
||||||
# Removing `" "` before comparison
|
|
||||||
# to get back a single string.
|
|
||||||
if current.replace('" "', "") != value.replace('" "', ""):
|
|
||||||
to_print.append(line)
|
|
||||||
|
|
||||||
exit_code = 0
|
|
||||||
if to_print:
|
|
||||||
to_print.insert(
|
|
||||||
0, "You should configure the following DNS entries at your provider:\n"
|
|
||||||
)
|
|
||||||
to_print.append(
|
|
||||||
"\nIf you already configured the DNS entries, wait a bit until the DNS entries propagate to the Internet."
|
|
||||||
)
|
|
||||||
print("\n".join(to_print))
|
|
||||||
exit_code = 1
|
|
||||||
else:
|
|
||||||
out.green("Great! All your DNS entries are correct.")
|
|
||||||
|
|
||||||
to_print = []
|
|
||||||
if not reverse_ipv4:
|
|
||||||
to_print.append(f"\tIPv4:\t{ipv4}\t{args.config.mail_domain}")
|
|
||||||
if not reverse_ipv6:
|
|
||||||
to_print.append(f"\tIPv6:\t{ipv6}\t{args.config.mail_domain}")
|
|
||||||
if len(to_print) > 0:
|
|
||||||
if len(to_print) == 1:
|
|
||||||
warning = "You should add the following PTR/reverse DNS entry:"
|
|
||||||
else:
|
|
||||||
warning = "You should add the following PTR/reverse DNS entries:"
|
|
||||||
out.red(warning)
|
|
||||||
for entry in to_print:
|
|
||||||
print(entry)
|
|
||||||
print(
|
|
||||||
"You can do so at your hosting provider (maybe this isn't your DNS provider)."
|
|
||||||
)
|
|
||||||
exit_code = 1
|
|
||||||
return exit_code
|
|
||||||
|
|
||||||
|
|
||||||
def check_necessary_dns(out, mail_domain):
|
|
||||||
"""Check whether $mail_domain and mta-sts.$mail_domain resolve."""
|
|
||||||
dns = DNS(out, mail_domain)
|
|
||||||
ipv4 = dns.get("A", mail_domain)
|
|
||||||
ipv6 = dns.get("AAAA", mail_domain)
|
|
||||||
mta_entry = dns.get("CNAME", "mta-sts." + mail_domain)
|
|
||||||
www_entry = dns.get("CNAME", "www." + mail_domain)
|
|
||||||
to_print = []
|
|
||||||
if not (ipv4 or ipv6):
|
|
||||||
to_print.append(f"\t{mail_domain}.\t\t\tA<your server's IPv4 address>")
|
|
||||||
if mta_entry != mail_domain + ".":
|
|
||||||
to_print.append(f"\tmta-sts.{mail_domain}.\tCNAME\t{mail_domain}.")
|
|
||||||
if www_entry != mail_domain + ".":
|
|
||||||
to_print.append(f"\twww.{mail_domain}.\tCNAME\t{mail_domain}.")
|
|
||||||
if to_print:
|
|
||||||
to_print.insert(
|
|
||||||
0,
|
|
||||||
"\nFor chatmail to work, you need to configure this at your DNS provider:\n",
|
|
||||||
)
|
|
||||||
for line in to_print:
|
|
||||||
print(line)
|
|
||||||
print()
|
|
||||||
else:
|
|
||||||
dns.out.green("\nAll necessary DNS entries seem to be set.")
|
|
||||||
return True
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
uri = proxy:/run/doveauth/doveauth.socket:auth
|
|
||||||
iterate_disable = yes
|
|
||||||
default_pass_scheme = plain
|
|
||||||
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
|
||||||
# See <https://doc.dovecot.org/configuration_manual/config_file/config_variables/#modifiers>
|
|
||||||
# for documentation.
|
|
||||||
#
|
|
||||||
# We escape user-provided input and use double quote as a separator.
|
|
||||||
password_key = passdb/%Ew"%Eu
|
|
||||||
user_key = userdb/%Eu
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
require ["imap4flags"];
|
|
||||||
|
|
||||||
# flag the message so it doesn't cause a push notification
|
|
||||||
|
|
||||||
if header :is ["Auto-Submitted"] ["auto-replied", "auto-generated"] {
|
|
||||||
addflag "$Auto";
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
|
||||||
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
# or in any IMAP subfolder
|
|
||||||
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/.*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
# even if they are unseen
|
|
||||||
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/.*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
# or only temporary (but then they shouldn't be around after {{ config.delete_mails_after }} days anyway).
|
|
||||||
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
2 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -path '*/.*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
|
||||||
3 0 * * * vmail find /home/vmail/mail/{{ config.mail_domain }} -name 'maildirsize' -type f -delete
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
function dovecot_lua_notify_begin_txn(user)
|
|
||||||
return user
|
|
||||||
end
|
|
||||||
|
|
||||||
function contains(v, needle)
|
|
||||||
for _, keyword in ipairs(v) do
|
|
||||||
if keyword == needle then
|
|
||||||
return true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
return false
|
|
||||||
end
|
|
||||||
|
|
||||||
function dovecot_lua_notify_event_message_new(user, event)
|
|
||||||
local mbox = user:mailbox(event.mailbox)
|
|
||||||
mbox:sync()
|
|
||||||
|
|
||||||
if user.username ~= event.from_address then
|
|
||||||
-- Incoming message
|
|
||||||
if not contains(event.keywords, "$Auto") then
|
|
||||||
-- Not an Auto-Submitted message, notifying.
|
|
||||||
|
|
||||||
-- Notify METADATA server about new message.
|
|
||||||
mbox:metadata_set("/private/messagenew", "")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
mbox:free()
|
|
||||||
end
|
|
||||||
|
|
||||||
function dovecot_lua_notify_end_txn(ctx, success)
|
|
||||||
end
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
*/5 * * * * root {{ config.execpath }} /home/vmail/mail/{{ config.mail_domain }} >/var/www/html/metrics
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
user www-data;
|
|
||||||
worker_processes auto;
|
|
||||||
pid /run/nginx.pid;
|
|
||||||
error_log /var/log/nginx/error.log;
|
|
||||||
|
|
||||||
events {
|
|
||||||
worker_connections 768;
|
|
||||||
# multi_accept on;
|
|
||||||
}
|
|
||||||
|
|
||||||
http {
|
|
||||||
sendfile on;
|
|
||||||
tcp_nopush on;
|
|
||||||
|
|
||||||
# Do not emit nginx version on error pages.
|
|
||||||
server_tokens off;
|
|
||||||
|
|
||||||
include /etc/nginx/mime.types;
|
|
||||||
default_type application/octet-stream;
|
|
||||||
|
|
||||||
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
|
||||||
ssl_prefer_server_ciphers on;
|
|
||||||
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
|
||||||
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
|
||||||
|
|
||||||
gzip on;
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 443 ssl default_server;
|
|
||||||
listen [::]:443 ssl default_server;
|
|
||||||
|
|
||||||
root /var/www/html;
|
|
||||||
|
|
||||||
index index.html index.htm;
|
|
||||||
|
|
||||||
server_name _;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
# First attempt to serve request as file, then
|
|
||||||
# as directory, then fall back to displaying a 404.
|
|
||||||
try_files $uri $uri/ =404;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /metrics {
|
|
||||||
default_type text/plain;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /new {
|
|
||||||
if ($request_method = GET) {
|
|
||||||
# Redirect to Delta Chat,
|
|
||||||
# which will in turn do a POST request.
|
|
||||||
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
|
||||||
}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
|
||||||
include /etc/nginx/fastcgi_params;
|
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Old URL for compatibility with e.g. printed QR codes.
|
|
||||||
#
|
|
||||||
# Copy-paste instead of redirect to /new
|
|
||||||
# because Delta Chat core does not follow redirects.
|
|
||||||
#
|
|
||||||
# Redirects are only for browsers.
|
|
||||||
location /cgi-bin/newemail.py {
|
|
||||||
if ($request_method = GET) {
|
|
||||||
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
|
||||||
}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
|
||||||
include /etc/nginx/fastcgi_params;
|
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# Redirect www. to non-www
|
|
||||||
server {
|
|
||||||
listen 443 ssl;
|
|
||||||
listen [::]:443 ssl;
|
|
||||||
server_name www.{{ config.domain_name }};
|
|
||||||
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
@@ -1 +0,0 @@
|
|||||||
{{ config.opendkim_selector }}._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/{{ config.opendkim_selector }}.private
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
if odkim.internal_ip(ctx) == 1 then
|
|
||||||
-- Outgoing message will be signed,
|
|
||||||
-- no need to look for signatures.
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
nsigs = odkim.get_sigcount(ctx)
|
|
||||||
if nsigs == nil then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
for i = 1, nsigs do
|
|
||||||
sig = odkim.get_sighandle(ctx, i - 1)
|
|
||||||
sigres = odkim.sig_result(sig)
|
|
||||||
|
|
||||||
-- All signatures that do not correspond to From:
|
|
||||||
-- were ignored in screen.lua and return sigres -1.
|
|
||||||
--
|
|
||||||
-- Any valid signature that was not ignored like this
|
|
||||||
-- means the message is acceptable.
|
|
||||||
if sigres == 0 then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
odkim.set_reply(ctx, "554", "5.7.1", "No valid DKIM signature found")
|
|
||||||
odkim.set_result(ctx, SMFIS_REJECT)
|
|
||||||
return nil
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
-- Ignore signatures that do not correspond to the From: domain.
|
|
||||||
|
|
||||||
from_domain = odkim.get_fromdomain(ctx)
|
|
||||||
if from_domain == nil then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
n = odkim.get_sigcount(ctx)
|
|
||||||
if n == nil then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
for i = 1, n do
|
|
||||||
sig = odkim.get_sighandle(ctx, i - 1)
|
|
||||||
sig_domain = odkim.sig_getdomain(sig)
|
|
||||||
if from_domain ~= sig_domain then
|
|
||||||
odkim.sig_ignore(sig)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
return nil
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
/^(.*)$/ ${1}
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
myorigin = {{ config.mail_domain }}
|
|
||||||
|
|
||||||
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
|
||||||
biff = no
|
|
||||||
|
|
||||||
# appending .domain is the MUA's job.
|
|
||||||
append_dot_mydomain = no
|
|
||||||
|
|
||||||
# Uncomment the next line to generate "delayed mail" warnings
|
|
||||||
#delay_warning_time = 4h
|
|
||||||
|
|
||||||
readme_directory = no
|
|
||||||
|
|
||||||
# See http://www.postfix.org/COMPATIBILITY_README.html
|
|
||||||
compatibility_level = 3.6
|
|
||||||
|
|
||||||
# TLS parameters
|
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
|
||||||
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
|
||||||
smtpd_tls_security_level=may
|
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
|
||||||
smtp_tls_security_level=may
|
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
|
||||||
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
|
||||||
smtpd_tls_protocols = >=TLSv1.2
|
|
||||||
|
|
||||||
# Disable anonymous cipher suites
|
|
||||||
# and known insecure algorithms.
|
|
||||||
#
|
|
||||||
# Disabling anonymous ciphers
|
|
||||||
# does not generally improve security
|
|
||||||
# because clients that want to verify certificate
|
|
||||||
# will not select them anyway,
|
|
||||||
# but makes cipher suite list shorter and security scanners happy.
|
|
||||||
# See <https://www.postfix.org/TLS_README.html> for discussion.
|
|
||||||
#
|
|
||||||
# Only ancient insecure ciphers should be disabled here
|
|
||||||
# as MTA clients that do not support more secure cipher
|
|
||||||
# likely do not support MTA-STS either and will
|
|
||||||
# otherwise fall back to using plaintext connection.
|
|
||||||
smtpd_tls_exclude_ciphers = aNULL, RC4, MD5, DES
|
|
||||||
|
|
||||||
# Override client's preference order.
|
|
||||||
# <https://www.postfix.org/postconf.5.html#tls_preempt_cipherlist>
|
|
||||||
#
|
|
||||||
# This is mostly to ensure cipher suites with forward secrecy
|
|
||||||
# are preferred over non cipher suites without forward secrecy.
|
|
||||||
# See <https://www.postfix.org/FORWARD_SECRECY_README.html#server_fs>.
|
|
||||||
tls_preempt_cipherlist = yes
|
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
|
||||||
myhostname = {{ config.mail_domain }}
|
|
||||||
alias_maps = hash:/etc/aliases
|
|
||||||
alias_database = hash:/etc/aliases
|
|
||||||
|
|
||||||
# Postfix does not deliver mail for any domain by itself.
|
|
||||||
# Primary domain is listed in `virtual_mailbox_domains` instead
|
|
||||||
# and handed over to Dovecot.
|
|
||||||
mydestination =
|
|
||||||
|
|
||||||
relayhost =
|
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
|
||||||
mailbox_size_limit = 0
|
|
||||||
# maximum 30MB sized messages
|
|
||||||
message_size_limit = 31457280
|
|
||||||
recipient_delimiter = +
|
|
||||||
inet_interfaces = all
|
|
||||||
inet_protocols = all
|
|
||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
|
||||||
virtual_mailbox_domains = {{ config.mail_domain }}
|
|
||||||
|
|
||||||
mua_client_restrictions = permit_sasl_authenticated, reject
|
|
||||||
mua_sender_restrictions = reject_sender_login_mismatch, permit_sasl_authenticated, reject
|
|
||||||
mua_helo_restrictions = permit_mynetworks, reject_invalid_helo_hostname, reject_non_fqdn_helo_hostname, permit
|
|
||||||
|
|
||||||
# 1:1 map MAIL FROM to SASL login name.
|
|
||||||
smtpd_sender_login_maps = regexp:/etc/postfix/login_map
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
/^Received:/ IGNORE
|
|
||||||
/^X-Originating-IP:/ IGNORE
|
|
||||||
/^X-Mailer:/ IGNORE
|
|
||||||
/^User-Agent:/ IGNORE
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail dict proxy for IMAP METADATA
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} /run/chatmail-metadata/metadata.socket /home/vmail/mail/{mail_domain}
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
User=vmail
|
|
||||||
RuntimeDirectory=chatmail-metadata
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail echo bot for testing it works
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} {config_path}
|
|
||||||
Environment="PATH={remote_venv_dir}:$PATH"
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
User=echobot
|
|
||||||
Group=echobot
|
|
||||||
|
|
||||||
# Create /var/lib/echobot
|
|
||||||
StateDirectory=echobot
|
|
||||||
|
|
||||||
# Create /run/echobot
|
|
||||||
#
|
|
||||||
# echobot stores /run/echobot/password
|
|
||||||
# with a password there, which doveauth then reads.
|
|
||||||
RuntimeDirectory=echobot
|
|
||||||
|
|
||||||
WorkingDirectory=/var/lib/echobot
|
|
||||||
|
|
||||||
# Apply security restrictions suggested by
|
|
||||||
# systemd-analyze security echobot.service
|
|
||||||
CapabilityBoundingSet=
|
|
||||||
LockPersonality=true
|
|
||||||
MemoryDenyWriteExecute=true
|
|
||||||
NoNewPrivileges=true
|
|
||||||
PrivateDevices=true
|
|
||||||
PrivateMounts=true
|
|
||||||
PrivateTmp=true
|
|
||||||
|
|
||||||
# We need to know about doveauth user to give it access to /run/echobot/password
|
|
||||||
PrivateUsers=false
|
|
||||||
|
|
||||||
ProtectClock=true
|
|
||||||
ProtectControlGroups=true
|
|
||||||
ProtectHostname=true
|
|
||||||
ProtectKernelLogs=true
|
|
||||||
ProtectKernelModules=true
|
|
||||||
ProtectKernelTunables=true
|
|
||||||
ProtectProc=noaccess
|
|
||||||
|
|
||||||
# Should be "strict", but we currently write /accounts folder in a protected path
|
|
||||||
ProtectSystem=full
|
|
||||||
|
|
||||||
RemoveIPC=true
|
|
||||||
RestrictAddressFamilies=AF_INET AF_INET6
|
|
||||||
RestrictNamespaces=true
|
|
||||||
RestrictRealtime=true
|
|
||||||
RestrictSUIDSGID=true
|
|
||||||
SystemCallArchitectures=native
|
|
||||||
SystemCallFilter=~@clock
|
|
||||||
SystemCallFilter=~@cpu-emulation
|
|
||||||
SystemCallFilter=~@debug
|
|
||||||
SystemCallFilter=~@module
|
|
||||||
SystemCallFilter=~@mount
|
|
||||||
SystemCallFilter=~@obsolete
|
|
||||||
SystemCallFilter=~@raw-io
|
|
||||||
SystemCallFilter=~@reboot
|
|
||||||
SystemCallFilter=~@resources
|
|
||||||
SystemCallFilter=~@swap
|
|
||||||
UMask=0077
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
import requests
|
|
||||||
|
|
||||||
from cmdeploy.genqr import gen_qr_png_data
|
|
||||||
|
|
||||||
|
|
||||||
def test_gen_qr_png_data(maildomain):
|
|
||||||
data = gen_qr_png_data(maildomain)
|
|
||||||
assert data
|
|
||||||
|
|
||||||
|
|
||||||
def test_fastcgi_working(maildomain, chatmail_config):
|
|
||||||
url = f"https://{maildomain}/new"
|
|
||||||
print(url)
|
|
||||||
res = requests.post(url)
|
|
||||||
assert maildomain in res.json().get("email")
|
|
||||||
assert len(res.json().get("password")) > chatmail_config.password_min_length
|
|
||||||
|
|
||||||
|
|
||||||
def test_newemail_configure(maildomain, rpc):
|
|
||||||
"""Test configuring accounts by scanning a QR code works."""
|
|
||||||
url = f"DCACCOUNT:https://{maildomain}/new"
|
|
||||||
for i in range(3):
|
|
||||||
account_id = rpc.add_account()
|
|
||||||
rpc.set_config_from_qr(account_id, url)
|
|
||||||
rpc.configure(account_id)
|
|
||||||
@@ -3,8 +3,8 @@ requires = ["setuptools>=68"]
|
|||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "cmdeploy"
|
name = "deploy-chatmail"
|
||||||
version = "0.2"
|
version = "0.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"pyinfra",
|
"pyinfra",
|
||||||
"pillow",
|
"pillow",
|
||||||
@@ -19,15 +19,13 @@ dependencies = [
|
|||||||
"black",
|
"black",
|
||||||
"pytest",
|
"pytest",
|
||||||
"pytest-xdist",
|
"pytest-xdist",
|
||||||
"imap_tools",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
cmdeploy = "cmdeploy.cmdeploy:main"
|
cmdeploy = "deploy_chatmail.cmdeploy:main"
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
"cmdeploy.testplugin" = "cmdeploy.tests.plugin"
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "-v -ra --strict-markers"
|
addopts = "-v -ra --strict-markers"
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import subprocess
|
import subprocess
|
||||||
@@ -85,34 +84,16 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"),
|
|
||||||
dest="/etc/cron.d/chatmail-metrics",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={
|
|
||||||
"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",
|
|
||||||
"chatmail-metadata",
|
|
||||||
):
|
):
|
||||||
params = dict(
|
params = dict(
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
config_path=remote_chatmail_inipath,
|
config_path=remote_chatmail_inipath,
|
||||||
remote_venv_dir=remote_venv_dir,
|
|
||||||
mail_domain=config.mail_domain,
|
|
||||||
)
|
|
||||||
source_path = importlib.resources.files(__package__).joinpath(
|
|
||||||
"service", f"{fn}.service.f"
|
|
||||||
)
|
)
|
||||||
|
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
||||||
content = source_path.read_text().format(**params).encode()
|
content = source_path.read_text().format(**params).encode()
|
||||||
|
|
||||||
files.put(
|
files.put(
|
||||||
@@ -131,7 +112,7 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
||||||
"""Configures OpenDKIM"""
|
"""Configures OpenDKIM"""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -145,24 +126,6 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
screen_script = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/screen.lua"),
|
|
||||||
dest="/etc/opendkim/screen.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= screen_script.changed
|
|
||||||
|
|
||||||
final_script = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/final.lua"),
|
|
||||||
dest="/etc/opendkim/final.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= final_script.changed
|
|
||||||
|
|
||||||
files.directory(
|
files.directory(
|
||||||
name="Add opendkim directory to /etc",
|
name="Add opendkim directory to /etc",
|
||||||
path="/etc/opendkim",
|
path="/etc/opendkim",
|
||||||
@@ -191,6 +154,7 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
)
|
)
|
||||||
need_restart |= signing_table.changed
|
need_restart |= signing_table.changed
|
||||||
|
|
||||||
files.directory(
|
files.directory(
|
||||||
name="Add opendkim socket directory to /var/spool/postfix",
|
name="Add opendkim socket directory to /var/spool/postfix",
|
||||||
path="/var/spool/postfix/opendkim",
|
path="/var/spool/postfix/opendkim",
|
||||||
@@ -200,11 +164,6 @@ def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
|||||||
present=True,
|
present=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="apt install opendkim opendkim-tools",
|
|
||||||
packages=["opendkim", "opendkim-tools"],
|
|
||||||
)
|
|
||||||
|
|
||||||
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
||||||
server.shell(
|
server.shell(
|
||||||
name="Generate OpenDKIM domain keys",
|
name="Generate OpenDKIM domain keys",
|
||||||
@@ -236,7 +195,7 @@ def _install_mta_sts_daemon() -> bool:
|
|||||||
server.shell(
|
server.shell(
|
||||||
name="install postfix-mta-sts-resolver with pip",
|
name="install postfix-mta-sts-resolver with pip",
|
||||||
commands=[
|
commands=[
|
||||||
"python3 -m virtualenv /usr/local/lib/postfix-mta-sts-resolver",
|
"python3 -m venv /usr/local/lib/postfix-mta-sts-resolver",
|
||||||
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
@@ -281,31 +240,10 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= master_config.changed
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
header_cleanup = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"postfix/submission_header_cleanup"
|
|
||||||
),
|
|
||||||
dest="/etc/postfix/submission_header_cleanup",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= header_cleanup.changed
|
|
||||||
|
|
||||||
# Login map that 1:1 maps email address to login.
|
|
||||||
login_map = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("postfix/login_map"),
|
|
||||||
dest="/etc/postfix/login_map",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= login_map.changed
|
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
||||||
"""Configures Dovecot IMAP server."""
|
"""Configures Dovecot IMAP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -315,7 +253,7 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config={"hostname": mail_server},
|
||||||
debug=debug,
|
debug=debug,
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
@@ -327,38 +265,15 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
need_restart |= auth_config.changed
|
need_restart |= auth_config.changed
|
||||||
lua_push_notification_script = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"dovecot/push_notification.lua"
|
|
||||||
),
|
|
||||||
dest="/etc/dovecot/push_notification.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= lua_push_notification_script.changed
|
|
||||||
|
|
||||||
sieve_script = files.put(
|
files.put(
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/default.sieve"),
|
src=importlib.resources.files(__package__)
|
||||||
dest="/etc/dovecot/default.sieve",
|
.joinpath("dovecot/expunge.cron")
|
||||||
user="root",
|
.open("rb"),
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= sieve_script.changed
|
|
||||||
if sieve_script.changed:
|
|
||||||
server.shell(
|
|
||||||
name="compile sieve script",
|
|
||||||
commands=["/usr/bin/sievec /etc/dovecot/default.sieve"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
|
||||||
dest="/etc/cron.d/expunge",
|
dest="/etc/cron.d/expunge",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# as per https://doc.dovecot.org/configuration_manual/os/
|
# as per https://doc.dovecot.org/configuration_manual/os/
|
||||||
@@ -431,108 +346,41 @@ 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
|
mailname = config.mailname
|
||||||
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
if mailname != "testrun.org" and not mailname.endswith(".testrun.org"):
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
for key in config.__dict__:
|
for value in config.__dict__.values():
|
||||||
value = config.__dict__[key]
|
if any(x in value for x in blocked_words):
|
||||||
if key.startswith("privacy") and any(
|
|
||||||
x in str(value) for x in blocked_words
|
|
||||||
):
|
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
)
|
)
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(config_path: Path) -> None:
|
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
||||||
"""Deploy a chat-mail instance.
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
:param config_path: path to chatmail.ini
|
:param mail_domain: domain part of your future email addresses
|
||||||
|
:param mail_server: the DNS name under which your mail server is reachable
|
||||||
|
:param dkim_selector:
|
||||||
"""
|
"""
|
||||||
config = read_config(config_path)
|
|
||||||
check_config(config)
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
|
|
||||||
from .www import build_webpages
|
from .www import build_webpages
|
||||||
|
|
||||||
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
|
||||||
server.group(name="Create opendkim group", group="opendkim", system=True)
|
server.group(name="Create opendkim group", group="opendkim", system=True)
|
||||||
server.user(
|
|
||||||
name="Create opendkim user",
|
|
||||||
user="opendkim",
|
|
||||||
groups=["opendkim"],
|
|
||||||
system=True,
|
|
||||||
)
|
|
||||||
server.user(
|
server.user(
|
||||||
name="Add postfix user to opendkim group for socket access",
|
name="Add postfix user to opendkim group for socket access",
|
||||||
user="postfix",
|
user="postfix",
|
||||||
groups=["opendkim"],
|
groups=["opendkim"],
|
||||||
system=True,
|
system=True,
|
||||||
)
|
)
|
||||||
server.user(name="Create echobot user", user="echobot", system=True)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name="Fix file owner in /home/vmail",
|
|
||||||
commands=["test -d /home/vmail && chown -R vmail:vmail /home/vmail"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Add our OBS repository for dovecot_no_delay
|
|
||||||
files.put(
|
|
||||||
name = "Add Deltachat OBS GPG key to apt keyring",
|
|
||||||
src = importlib.resources.files(__package__).joinpath("obs-home-deltachat.gpg"),
|
|
||||||
dest = "/etc/apt/keyrings/obs-home-deltachat.gpg",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.line(
|
|
||||||
name = "Add DeltaChat OBS home repository to sources.list",
|
|
||||||
path = "/etc/apt/sources.list",
|
|
||||||
line = "deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./",
|
|
||||||
ensure_newline = True,
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install rsync",
|
|
||||||
packages=["rsync"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Run local DNS resolver `unbound`.
|
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
|
||||||
# to use 127.0.0.1 as the resolver.
|
|
||||||
apt.packages(
|
|
||||||
name="Install unbound",
|
|
||||||
packages=["unbound", "unbound-anchor", "dnsutils"],
|
|
||||||
)
|
|
||||||
server.shell(
|
|
||||||
name="Generate root keys for validating DNSSEC",
|
|
||||||
commands=[
|
|
||||||
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
|
||||||
"systemctl reset-failed unbound.service",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable unbound",
|
|
||||||
service="unbound.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
# Deploy acmetool to have TLS certificates.
|
||||||
deploy_acmetool(
|
deploy_acmetool(nginx_hook=True, domains=[mail_server, f"mta-sts.{mail_server}"])
|
||||||
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Postfix",
|
name="Install Postfix",
|
||||||
@@ -541,7 +389,15 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Dovecot",
|
name="Install Dovecot",
|
||||||
packages=["dovecot-imapd", "dovecot-lmtpd", "dovecot-sieve"],
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install OpenDKIM",
|
||||||
|
packages=[
|
||||||
|
"opendkim",
|
||||||
|
"opendkim-tools",
|
||||||
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
@@ -554,7 +410,11 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
packages=["fcgiwrap"],
|
packages=["fcgiwrap"],
|
||||||
)
|
)
|
||||||
|
|
||||||
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
pkg_root = importlib.resources.files(__package__)
|
||||||
|
chatmail_ini = pkg_root.joinpath("../../../chatmail.ini").resolve()
|
||||||
|
config = read_config(chatmail_ini)
|
||||||
|
check_config(config)
|
||||||
|
www_path = pkg_root.joinpath("../../../www").resolve()
|
||||||
|
|
||||||
build_dir = www_path.joinpath("build")
|
build_dir = www_path.joinpath("build")
|
||||||
src_dir = www_path.joinpath("src")
|
src_dir = www_path.joinpath("src")
|
||||||
@@ -563,14 +423,12 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
|
|
||||||
_install_remote_venv_with_chatmaild(config)
|
_install_remote_venv_with_chatmaild(config)
|
||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
||||||
postfix_need_restart = _configure_postfix(config, debug=debug)
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
|
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
||||||
mta_sts_need_restart = _install_mta_sts_daemon()
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
nginx_need_restart = _configure_nginx(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",
|
||||||
@@ -588,17 +446,6 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
restarted=mta_sts_need_restart,
|
restarted=mta_sts_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Dovecot should be started before Postfix
|
|
||||||
# because it creates authentication socket
|
|
||||||
# required by Postfix.
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable Dovecot",
|
|
||||||
service="dovecot.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=dovecot_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable Postfix",
|
name="Start and enable Postfix",
|
||||||
service="postfix.service",
|
service="postfix.service",
|
||||||
@@ -607,6 +454,14 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
restarted=postfix_need_restart,
|
restarted=postfix_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Dovecot",
|
||||||
|
service="dovecot.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=dovecot_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable nginx",
|
name="Start and enable nginx",
|
||||||
service="nginx.service",
|
service="nginx.service",
|
||||||
52
deploy-chatmail/src/deploy_chatmail/acmetool/__init__.py
Normal file
52
deploy-chatmail/src/deploy_chatmail/acmetool/__init__.py
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import importlib.resources
|
||||||
|
|
||||||
|
from pyinfra.operations import apt, files, server
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
||||||
|
"""Deploy acmetool."""
|
||||||
|
apt.packages(
|
||||||
|
name="Install acmetool",
|
||||||
|
packages=["acmetool"],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("acmetool.cron").open("rb"),
|
||||||
|
dest="/etc/cron.d/acmetool",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
|
if nginx_hook:
|
||||||
|
files.put(
|
||||||
|
src=importlib.resources.files(__package__)
|
||||||
|
.joinpath("acmetool.hook")
|
||||||
|
.open("rb"),
|
||||||
|
dest="/usr/lib/acme/hooks/nginx",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="744",
|
||||||
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("response-file.yaml.j2"),
|
||||||
|
dest="/var/lib/acme/conf/responses",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
email=email,
|
||||||
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
||||||
|
dest="/var/lib/acme/conf/target",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
|
commands=[f"acmetool want { ' '.join(domains)}"],
|
||||||
|
)
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
SHELL=/bin/sh
|
||||||
|
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin
|
||||||
|
MAILTO=root
|
||||||
|
20 16 * * * root /usr/bin/acmetool --batch reconcile
|
||||||
@@ -3,5 +3,3 @@ set -e
|
|||||||
EVENT_NAME="$1"
|
EVENT_NAME="$1"
|
||||||
[ "$EVENT_NAME" = "live-updated" ] || exit 42
|
[ "$EVENT_NAME" = "live-updated" ] || exit 42
|
||||||
systemctl restart nginx.service
|
systemctl restart nginx.service
|
||||||
systemctl reload dovecot.service
|
|
||||||
systemctl reload postfix.service
|
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
"acme-enter-email": "{{ email }}"
|
||||||
|
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.3-September-21-2022.pdf": true
|
||||||
12
deploy-chatmail/src/deploy_chatmail/chatmail.zone.f
Normal file
12
deploy-chatmail/src/deploy_chatmail/chatmail.zone.f
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
{chatmail_domain}. MX 10 {chatmail_domain}.
|
||||||
|
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
||||||
|
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
||||||
|
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
||||||
|
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
||||||
|
{chatmail_domain}. IN CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
||||||
|
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
||||||
|
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;adkim=r;aspf=r"
|
||||||
|
_mta-sts.{chatmail_domain}. IN TXT "v=STSv1; id={sts_id}"
|
||||||
|
mta-sts.{chatmail_domain}. IN CNAME {chatmail_domain}.
|
||||||
|
_smtp._tls.{chatmail_domain}. IN TXT "v=TLSRPTv1;rua=mailto:{email}"
|
||||||
|
{dkim_entry}
|
||||||
@@ -2,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,7 +15,6 @@ 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
|
|
||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
@@ -33,16 +32,11 @@ def init_cmd_options(parser):
|
|||||||
|
|
||||||
def init_cmd(args, out):
|
def init_cmd(args, out):
|
||||||
"""Initialize chatmail config file."""
|
"""Initialize chatmail config file."""
|
||||||
mail_domain = args.chatmail_domain
|
|
||||||
if args.inipath.exists():
|
if args.inipath.exists():
|
||||||
print(f"Path exists, not modifying: {args.inipath}")
|
out.red(f"Path exists, not modifying: {args.inipath}")
|
||||||
else:
|
raise SystemExit(1)
|
||||||
write_initial_config(args.inipath, mail_domain)
|
write_initial_config(args.inipath, args.chatmail_domain)
|
||||||
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
out.green(f"created config file for {args.chatmail_domain} in {args.inipath}")
|
||||||
check_necessary_dns(
|
|
||||||
out,
|
|
||||||
mail_domain,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd_options(parser):
|
def run_cmd_options(parser):
|
||||||
@@ -56,43 +50,55 @@ 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_INI"] = args.inipath
|
env["CHATMAIL_DOMAIN"] = args.config.mailname
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
deploypy = "deploy-chatmail/src/deploy_chatmail/deploy.py"
|
||||||
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.mailname} {deploypy}"
|
||||||
|
|
||||||
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."""
|
||||||
exit_code = show_dns(args, out)
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
||||||
exit(exit_code)
|
ssh = f"ssh root@{args.config.mailname}"
|
||||||
|
|
||||||
|
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.mailname} 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.mailname}",
|
||||||
|
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
||||||
|
chatmail_domain=args.config.mailname,
|
||||||
|
dkim_entry=dkim_entry,
|
||||||
|
)
|
||||||
|
.strip()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
def status_cmd(args, out):
|
||||||
"""Display status for online chatmail instance."""
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
ssh = f"ssh root@{args.config.mail_domain}"
|
ssh = f"ssh root@{args.config.mailname}"
|
||||||
|
|
||||||
out.green(f"chatmail domain: {args.config.mail_domain}")
|
out.green(f"chatmail domain: {args.config.mailname}")
|
||||||
if args.config.privacy_mail:
|
if args.config.privacy_mail:
|
||||||
out.green("privacy settings: present")
|
out.green("privacy settings: present")
|
||||||
else:
|
else:
|
||||||
@@ -104,15 +110,6 @@ def status_cmd(args, out):
|
|||||||
print(line)
|
print(line)
|
||||||
|
|
||||||
|
|
||||||
def test_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--slow",
|
|
||||||
dest="slow",
|
|
||||||
action="store_true",
|
|
||||||
help="also run slow tests",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cmd(args, out):
|
def test_cmd(args, out):
|
||||||
"""Run local and online tests for chatmail deployment.
|
"""Run local and online tests for chatmail deployment.
|
||||||
|
|
||||||
@@ -124,18 +121,9 @@ def test_cmd(args, out):
|
|||||||
out.check_call(f"{sys.executable} -m pip install deltachat")
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
pytest_path = shutil.which("pytest")
|
pytest_path = shutil.which("pytest")
|
||||||
pytest_args = [
|
ret = out.run_ret(
|
||||||
pytest_path,
|
[pytest_path, "tests/", "-n4", "-rs", "-x", "-vrx", "--durations=5"]
|
||||||
"cmdeploy/src/",
|
)
|
||||||
"-n4",
|
|
||||||
"-rs",
|
|
||||||
"-x",
|
|
||||||
"-vrx",
|
|
||||||
"--durations=5",
|
|
||||||
]
|
|
||||||
if args.slow:
|
|
||||||
pytest_args.append("--slow")
|
|
||||||
ret = out.run_ret(pytest_args)
|
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
|
|
||||||
@@ -157,9 +145,13 @@ def fmt_cmd_options(parser):
|
|||||||
|
|
||||||
|
|
||||||
def fmt_cmd(args, out):
|
def fmt_cmd(args, out):
|
||||||
"""Run formattting fixes (ruff and black) on all chatmail source code."""
|
"""Run formattting fixes (fuff and black) on all chatmail source code."""
|
||||||
|
|
||||||
|
chatmaild = importlib.resources.files("chatmaild")
|
||||||
|
deploy_chatmail = importlib.resources.files("deploy_chatmail")
|
||||||
|
tests = deploy_chatmail.joinpath("../../../tests")
|
||||||
|
sources = list(str(x) for x in [chatmaild, deploy_chatmail, tests])
|
||||||
|
|
||||||
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
|
||||||
black_args = [shutil.which("black")]
|
black_args = [shutil.which("black")]
|
||||||
ruff_args = [shutil.which("ruff")]
|
ruff_args = [shutil.which("ruff")]
|
||||||
|
|
||||||
@@ -182,10 +174,9 @@ def fmt_cmd(args, out):
|
|||||||
|
|
||||||
def bench_cmd(args, out):
|
def bench_cmd(args, out):
|
||||||
"""Run benchmarks against an online chatmail instance."""
|
"""Run benchmarks against an online chatmail instance."""
|
||||||
args = ["pytest", "--pyargs", "cmdeploy.tests.online.benchmark", "-vrx"]
|
pytest_path = shutil.which("pytest")
|
||||||
cmdstring = " ".join(args)
|
benchmark = "tests/online/benchmark.py"
|
||||||
out.green(f"[$ {cmdstring}]")
|
subprocess.check_call([pytest_path, benchmark, "-vrx"])
|
||||||
subprocess.check_call(args)
|
|
||||||
|
|
||||||
|
|
||||||
def webdev_cmd(args, out):
|
def webdev_cmd(args, out):
|
||||||
@@ -213,15 +204,9 @@ 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, no_print=False, timeout=10):
|
def shell_output(self, arg):
|
||||||
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:
|
||||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
19
deploy-chatmail/src/deploy_chatmail/deploy.py
Normal file
19
deploy-chatmail/src/deploy_chatmail/deploy.py
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
import os
|
||||||
|
import pyinfra
|
||||||
|
from deploy_chatmail import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
mail_domain = os.getenv("CHATMAIL_DOMAIN")
|
||||||
|
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
|
||||||
|
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "dkim")
|
||||||
|
|
||||||
|
assert mail_domain
|
||||||
|
assert mail_server
|
||||||
|
assert dkim_selector
|
||||||
|
|
||||||
|
deploy_chatmail(mail_domain, mail_server, dkim_selector)
|
||||||
|
|
||||||
|
|
||||||
|
if pyinfra.is_cli:
|
||||||
|
main()
|
||||||
5
deploy-chatmail/src/deploy_chatmail/dovecot/auth.conf
Normal file
5
deploy-chatmail/src/deploy_chatmail/dovecot/auth.conf
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
uri = proxy:/run/dovecot/doveauth.socket:auth
|
||||||
|
iterate_disable = yes
|
||||||
|
default_pass_scheme = plain
|
||||||
|
password_key = passdb/%w/%u
|
||||||
|
user_key = userdb/%u
|
||||||
@@ -13,21 +13,13 @@ auth_cache_size = 100M
|
|||||||
mail_debug = yes
|
mail_debug = yes
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
# Prevent warnings similar to:
|
|
||||||
# config: Warning: service auth { client_limit=1000 } is lower than required under max. load (10200). Counted for protocol services with service_count != 1: service lmtp { process_limit=100 } + service imap-urlauth-login { process_limit=100 } + service imap-login { process_limit=10000 }
|
|
||||||
# config: Warning: service anvil { client_limit=1000 } is lower than required under max. load (10103). Counted with: service imap-urlauth-login { process_limit=100 } + service imap-login { process_limit=10000 } + service auth { process_limit=1 }
|
|
||||||
# master: Warning: service(stats): client_limit (1000) reached, client connections are being dropped
|
|
||||||
default_client_limit = 20000
|
|
||||||
|
|
||||||
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 METADATA XDELTAPUSH
|
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
# Authentication for system users.
|
||||||
@@ -77,32 +69,14 @@ mail_privileged_group = vmail
|
|||||||
## Mail processes
|
## Mail processes
|
||||||
##
|
##
|
||||||
|
|
||||||
# Pass all IMAP METADATA requests to the server implementing Dovecot's dict protocol.
|
|
||||||
mail_attribute_dict = proxy:/run/chatmail-metadata/metadata.socket:metadata
|
|
||||||
|
|
||||||
# Enable IMAP COMPRESS (RFC 4978).
|
# Enable IMAP COMPRESS (RFC 4978).
|
||||||
# <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 {
|
||||||
# quota plugin documentation:
|
mail_plugins = $mail_plugins quota
|
||||||
# <https://doc.dovecot.org/configuration_manual/quota_plugin/>
|
|
||||||
#
|
|
||||||
# notify plugin is a dependency of push_notification plugin:
|
|
||||||
# <https://doc.dovecot.org/settings/plugin/notify-plugin/>
|
|
||||||
#
|
|
||||||
# push_notification plugin documentation:
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/push_notification/>
|
|
||||||
#
|
|
||||||
# mail_lua and push_notification_lua are needed for Lua push notification handler.
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/push_notification/#configuration>
|
|
||||||
#
|
|
||||||
# Sieve to mark messages that should not be notified as \Seen
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/sieve/configuration/>
|
|
||||||
mail_plugins = $mail_plugins quota mail_lua notify push_notification push_notification_lua sieve
|
|
||||||
}
|
}
|
||||||
|
|
||||||
plugin {
|
plugin {
|
||||||
@@ -112,21 +86,13 @@ plugin {
|
|||||||
plugin {
|
plugin {
|
||||||
# for now we define static quota-rules for all users
|
# for now we define static quota-rules for all users
|
||||||
quota = maildir:User quota
|
quota = maildir:User quota
|
||||||
quota_rule = *:storage={{ config.max_mailbox_size }}
|
quota_rule = *:storage=100M
|
||||||
quota_max_mail_size=30M
|
quota_max_mail_size=30M
|
||||||
quota_grace = 0
|
quota_grace = 0
|
||||||
# quota_over_flag_value = TRUE
|
# quota_over_flag_value = TRUE
|
||||||
}
|
}
|
||||||
|
|
||||||
# push_notification configuration
|
|
||||||
plugin {
|
|
||||||
# <https://doc.dovecot.org/configuration_manual/push_notification/#lua-lua>
|
|
||||||
push_notification_driver = lua:file=/etc/dovecot/push_notification.lua
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
sieve_default = file:/etc/dovecot/default.sieve
|
|
||||||
}
|
|
||||||
|
|
||||||
service lmtp {
|
service lmtp {
|
||||||
user=vmail
|
user=vmail
|
||||||
@@ -171,8 +137,8 @@ service imap-login {
|
|||||||
}
|
}
|
||||||
|
|
||||||
ssl = required
|
ssl = required
|
||||||
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain
|
||||||
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
ssl_key = </var/lib/acme/live/{{ config.hostname }}/privkey
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
ssl_min_protocol = TLSv1.2
|
ssl_min_protocol = TLSv1.2
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
4
deploy-chatmail/src/deploy_chatmail/dovecot/expunge.cron
Normal file
4
deploy-chatmail/src/deploy_chatmail/dovecot/expunge.cron
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d INBOX
|
||||||
|
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d Deltachat
|
||||||
|
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d Trash
|
||||||
|
2 30 * * * dovecot doveadm purge -A
|
||||||
@@ -6,7 +6,7 @@ import io
|
|||||||
|
|
||||||
|
|
||||||
def gen_qr_png_data(maildomain):
|
def gen_qr_png_data(maildomain):
|
||||||
url = f"DCACCOUNT:https://{maildomain}/new"
|
url = f"DCACCOUNT:https://{maildomain}/cgi-bin/newemail.py"
|
||||||
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")
|
||||||
55
deploy-chatmail/src/deploy_chatmail/nginx/nginx.conf.j2
Normal file
55
deploy-chatmail/src/deploy_chatmail/nginx/nginx.conf.j2
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
user www-data;
|
||||||
|
worker_processes auto;
|
||||||
|
pid /run/nginx.pid;
|
||||||
|
error_log /var/log/nginx/error.log;
|
||||||
|
|
||||||
|
events {
|
||||||
|
worker_connections 768;
|
||||||
|
# multi_accept on;
|
||||||
|
}
|
||||||
|
|
||||||
|
http {
|
||||||
|
sendfile on;
|
||||||
|
tcp_nopush on;
|
||||||
|
|
||||||
|
# Do not emit nginx version on error pages.
|
||||||
|
server_tokens off;
|
||||||
|
|
||||||
|
include /etc/nginx/mime.types;
|
||||||
|
default_type application/octet-stream;
|
||||||
|
|
||||||
|
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
||||||
|
ssl_prefer_server_ciphers on;
|
||||||
|
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
||||||
|
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
||||||
|
|
||||||
|
gzip on;
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl default_server;
|
||||||
|
listen [::]:443 ssl default_server;
|
||||||
|
|
||||||
|
root /var/www/html;
|
||||||
|
|
||||||
|
index index.html index.htm;
|
||||||
|
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
# First attempt to serve request as file, then
|
||||||
|
# as directory, then fall back to displaying a 404.
|
||||||
|
try_files $uri $uri/ =404;
|
||||||
|
}
|
||||||
|
|
||||||
|
# add cgi-bin support
|
||||||
|
include /usr/share/doc/fcgiwrap/examples/nginx.conf;
|
||||||
|
}
|
||||||
|
server {
|
||||||
|
listen 80 default_server;
|
||||||
|
listen [::]:80 default_server;
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
return 301 https://$host$request_uri;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
1
deploy-chatmail/src/deploy_chatmail/opendkim/KeyTable
Normal file
1
deploy-chatmail/src/deploy_chatmail/opendkim/KeyTable
Normal file
@@ -0,0 +1 @@
|
|||||||
|
dkim._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/dkim.private
|
||||||
@@ -8,12 +8,10 @@ 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
|
||||||
@@ -24,15 +22,6 @@ 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
|
||||||
@@ -40,10 +29,22 @@ FinalPolicyScript /etc/opendkim/final.lua
|
|||||||
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
|
||||||
51
deploy-chatmail/src/deploy_chatmail/postfix/main.cf.j2
Normal file
51
deploy-chatmail/src/deploy_chatmail/postfix/main.cf.j2
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
myorigin = {{ config.mailname }}
|
||||||
|
|
||||||
|
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
||||||
|
biff = no
|
||||||
|
|
||||||
|
# appending .domain is the MUA's job.
|
||||||
|
append_dot_mydomain = no
|
||||||
|
|
||||||
|
# Uncomment the next line to generate "delayed mail" warnings
|
||||||
|
#delay_warning_time = 4h
|
||||||
|
|
||||||
|
readme_directory = no
|
||||||
|
|
||||||
|
# See http://www.postfix.org/COMPATIBILITY_README.html -- default to 2 on
|
||||||
|
# fresh installs.
|
||||||
|
compatibility_level = 2
|
||||||
|
|
||||||
|
# TLS parameters
|
||||||
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mailname }}/fullchain
|
||||||
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mailname }}/privkey
|
||||||
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
|
smtp_tls_security_level=may
|
||||||
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
|
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
||||||
|
|
||||||
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
|
myhostname = {{ config.mailname }}
|
||||||
|
alias_maps = hash:/etc/aliases
|
||||||
|
alias_database = hash:/etc/aliases
|
||||||
|
|
||||||
|
# Postfix does not deliver mail for any domain by itself.
|
||||||
|
# Primary domain is listed in `virtual_mailbox_domains` instead
|
||||||
|
# and handed over to Dovecot.
|
||||||
|
mydestination =
|
||||||
|
|
||||||
|
relayhost =
|
||||||
|
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
||||||
|
mailbox_size_limit = 0
|
||||||
|
# maximum 30MB sized messages
|
||||||
|
message_size_limit = 31457280
|
||||||
|
recipient_delimiter = +
|
||||||
|
inet_interfaces = all
|
||||||
|
inet_protocols = all
|
||||||
|
|
||||||
|
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
|
virtual_mailbox_domains = {{ config.mailname }}
|
||||||
|
|
||||||
|
smtpd_milters = unix:opendkim/opendkim.sock
|
||||||
|
non_smtpd_milters = $smtpd_milters
|
||||||
@@ -11,10 +11,13 @@
|
|||||||
# ==========================================================================
|
# ==========================================================================
|
||||||
{% 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 %}
|
||||||
-o smtpd_milters=unix:opendkim/opendkim.sock
|
#smtp inet n - y - 1 postscreen
|
||||||
|
#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
|
||||||
@@ -31,7 +34,6 @@ 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
|
||||||
@@ -48,7 +50,6 @@ 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
|
||||||
@@ -79,14 +80,3 @@ 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
|
|
||||||
@@ -36,32 +36,8 @@ def build_webpages(src_dir, build_dir, config):
|
|||||||
print(traceback.format_exc())
|
print(traceback.format_exc())
|
||||||
|
|
||||||
|
|
||||||
def int_to_english(number):
|
|
||||||
if number >= 0 and number <= 12:
|
|
||||||
a = [
|
|
||||||
"zero",
|
|
||||||
"one",
|
|
||||||
"two",
|
|
||||||
"three",
|
|
||||||
"four",
|
|
||||||
"five",
|
|
||||||
"six",
|
|
||||||
"seven",
|
|
||||||
"eight",
|
|
||||||
"nine",
|
|
||||||
"ten",
|
|
||||||
"eleven",
|
|
||||||
"twelve",
|
|
||||||
]
|
|
||||||
return a[number]
|
|
||||||
elif number <= 50:
|
|
||||||
return str(number)
|
|
||||||
if number > 50:
|
|
||||||
return "more"
|
|
||||||
|
|
||||||
|
|
||||||
def _build_webpages(src_dir, build_dir, config):
|
def _build_webpages(src_dir, build_dir, config):
|
||||||
mail_domain = config.mail_domain
|
mail_domain = config.mailname
|
||||||
assert src_dir.exists(), src_dir
|
assert src_dir.exists(), src_dir
|
||||||
if not build_dir.exists():
|
if not build_dir.exists():
|
||||||
build_dir.mkdir()
|
build_dir.mkdir()
|
||||||
@@ -72,15 +48,6 @@ def _build_webpages(src_dir, build_dir, config):
|
|||||||
for path in src_dir.iterdir():
|
for path in src_dir.iterdir():
|
||||||
if path.suffix == ".md":
|
if path.suffix == ".md":
|
||||||
render_vars, content = prepare_template(path)
|
render_vars, content = prepare_template(path)
|
||||||
render_vars["username_min_length"] = int_to_english(
|
|
||||||
config.username_min_length
|
|
||||||
)
|
|
||||||
render_vars["username_max_length"] = int_to_english(
|
|
||||||
config.username_max_length
|
|
||||||
)
|
|
||||||
render_vars["password_min_length"] = int_to_english(
|
|
||||||
config.password_min_length
|
|
||||||
)
|
|
||||||
target = build_dir.joinpath(path.stem + ".html")
|
target = build_dir.joinpath(path.stem + ".html")
|
||||||
|
|
||||||
# recursive jinja2 rendering
|
# recursive jinja2 rendering
|
||||||
@@ -104,7 +71,7 @@ def main():
|
|||||||
inipath = reporoot.joinpath("chatmail.ini")
|
inipath = reporoot.joinpath("chatmail.ini")
|
||||||
config = read_config(inipath)
|
config = read_config(inipath)
|
||||||
config.webdev = True
|
config.webdev = True
|
||||||
assert config.mail_domain
|
assert config.mailname
|
||||||
www_path = reporoot.joinpath("www")
|
www_path = reporoot.joinpath("www")
|
||||||
src_path = www_path.joinpath("src")
|
src_path = www_path.joinpath("src")
|
||||||
stats = None
|
stats = None
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
#
|
|
||||||
# Wrapper for cmdelpoy to run it in activated virtualenv.
|
|
||||||
set -e
|
|
||||||
. venv/bin/activate
|
|
||||||
cmdeploy "$@"
|
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
set -e
|
set -e
|
||||||
python3 -m venv --upgrade-deps venv
|
python3 -m venv venv
|
||||||
|
|
||||||
|
venv/bin/pip install -e deploy-chatmail
|
||||||
venv/bin/pip install -e chatmaild
|
venv/bin/pip install -e chatmaild
|
||||||
venv/bin/pip install -e cmdeploy
|
|
||||||
|
source venv/bin/activate
|
||||||
|
echo activated 'venv' python virtualenv environment containing "cmdeploy" tool
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ def pytest_runtest_setup(item):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def chatmail_config(pytestconfig):
|
def chatmail_config(pytestconfig):
|
||||||
current = basedir = Path().resolve()
|
current = basedir = Path()
|
||||||
while 1:
|
while 1:
|
||||||
path = current.joinpath("chatmail.ini").resolve()
|
path = current.joinpath("chatmail.ini").resolve()
|
||||||
if path.exists():
|
if path.exists():
|
||||||
@@ -52,7 +52,7 @@ def chatmail_config(pytestconfig):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain(chatmail_config):
|
def maildomain(chatmail_config):
|
||||||
return chatmail_config.mail_domain
|
return chatmail_config.mailname
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -228,25 +228,18 @@ def imap_or_smtp(request):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def gencreds(chatmail_config):
|
def gencreds(maildomain):
|
||||||
count = itertools.count()
|
count = itertools.count()
|
||||||
next(count)
|
next(count)
|
||||||
|
|
||||||
def gen(domain=None):
|
def gen(domain=None):
|
||||||
domain = domain if domain else chatmail_config.mail_domain
|
domain = domain if domain else maildomain
|
||||||
while 1:
|
while 1:
|
||||||
num = next(count)
|
num = next(count)
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
user = "".join(
|
user = "".join(random.choices(alphanumeric, k=10))
|
||||||
random.choices(alphanumeric, k=chatmail_config.username_max_length)
|
user = f"ac{num}_{user}"[:9]
|
||||||
)
|
password = "".join(random.choices(alphanumeric, k=12))
|
||||||
if domain == "nine.testrun.org":
|
|
||||||
user = f"ac{num}_{user}"[:9]
|
|
||||||
else:
|
|
||||||
user = f"ac{num}_{user}"[: chatmail_config.username_max_length]
|
|
||||||
password = "".join(
|
|
||||||
random.choices(alphanumeric, k=chatmail_config.password_min_length)
|
|
||||||
)
|
|
||||||
yield f"{user}@{domain}", f"{password}"
|
yield f"{user}@{domain}", f"{password}"
|
||||||
|
|
||||||
return lambda domain=None: next(gen(domain))
|
return lambda domain=None: next(gen(domain))
|
||||||
@@ -30,31 +30,31 @@ def test_login_smtp(benchmark, smtp, gencreds):
|
|||||||
|
|
||||||
class TestDC:
|
class TestDC:
|
||||||
def test_autoconfigure(self, benchmark, cmfactory):
|
def test_autoconfigure(self, benchmark, cmfactory):
|
||||||
def dc_autoconfig_and_idle_ready():
|
def autoconfig_and_idle_ready():
|
||||||
cmfactory.get_online_accounts(1)
|
cmfactory.get_online_accounts(1)
|
||||||
|
|
||||||
benchmark(dc_autoconfig_and_idle_ready, 5)
|
benchmark(autoconfig_and_idle_ready, 5)
|
||||||
|
|
||||||
def test_ping_pong(self, benchmark, cmfactory):
|
def test_ping_pong(self, benchmark, cmfactory):
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
def dc_ping_pong():
|
def ping_pong():
|
||||||
chat.send_text("ping")
|
chat.send_text("ping")
|
||||||
msg = ac2.wait_next_incoming_message()
|
msg = ac2.wait_next_incoming_message()
|
||||||
msg.chat.send_text("pong")
|
msg.chat.send_text("pong")
|
||||||
ac1.wait_next_incoming_message()
|
ac1.wait_next_incoming_message()
|
||||||
|
|
||||||
benchmark(dc_ping_pong, 5)
|
benchmark(ping_pong, 5)
|
||||||
|
|
||||||
def test_send_10_receive_10(self, benchmark, cmfactory, lp):
|
def test_send_10_receive_10(self, benchmark, cmfactory, lp):
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
def dc_send_10_receive_10():
|
def send_10_receive_10():
|
||||||
for i in range(10):
|
for i in range(10):
|
||||||
chat.send_text(f"hello {i}")
|
chat.send_text(f"hello {i}")
|
||||||
for i in range(10):
|
for i in range(10):
|
||||||
ac2.wait_next_incoming_message()
|
ac2.wait_next_incoming_message()
|
||||||
|
|
||||||
benchmark(dc_send_10_receive_10, 5)
|
benchmark(send_10_receive_10, 5)
|
||||||
@@ -1,17 +1,6 @@
|
|||||||
import pytest
|
import pytest
|
||||||
import threading
|
import threading
|
||||||
import queue
|
import queue
|
||||||
import socket
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
from cmdeploy.cmdeploy import main
|
|
||||||
|
|
||||||
|
|
||||||
def test_init(tmp_path, maildomain):
|
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
|
||||||
main(["init", "--config", str(inipath), maildomain])
|
|
||||||
config = read_config(inipath)
|
|
||||||
assert config.mail_domain == maildomain
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
||||||
@@ -79,24 +68,3 @@ def test_concurrent_logins_same_account(
|
|||||||
|
|
||||||
for _ in conns:
|
for _ in conns:
|
||||||
assert login_results.get()
|
assert login_results.get()
|
||||||
|
|
||||||
|
|
||||||
def test_no_vrfy(chatmail_config):
|
|
||||||
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
||||||
sock.connect((chatmail_config.mail_domain, 25))
|
|
||||||
banner = sock.recv(1024)
|
|
||||||
print(banner)
|
|
||||||
sock.send(b"VRFY wrongaddress@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
|
||||||
result = sock.recv(1024)
|
|
||||||
print(result)
|
|
||||||
sock.send(b"VRFY echo@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
|
||||||
result2 = sock.recv(1024)
|
|
||||||
print(result2)
|
|
||||||
assert result[0:10] == result2[0:10]
|
|
||||||
sock.send(b"VRFY wrongaddress\r\n")
|
|
||||||
result = sock.recv(1024)
|
|
||||||
print(result)
|
|
||||||
sock.send(b"VRFY echo\r\n")
|
|
||||||
result2 = sock.recv(1024)
|
|
||||||
print(result2)
|
|
||||||
assert result[0:10] == result2[0:10] == b"252 2.0.0 "
|
|
||||||
6
tests/online/test_0_qr.py
Normal file
6
tests/online/test_0_qr.py
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
from deploy_chatmail.genqr import gen_qr_png_data
|
||||||
|
|
||||||
|
|
||||||
|
def test_gen_qr_png_data(maildomain):
|
||||||
|
data = gen_qr_png_data(maildomain)
|
||||||
|
assert data
|
||||||
@@ -42,59 +42,22 @@ 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):
|
||||||
"""Test that the per-account send-mail limit is exceeded."""
|
"""Test that the per-account send-mail limit is exceeded."""
|
||||||
user1, user2 = cmsetup.gen_users(2)
|
user1, user2 = cmsetup.gen_users(2)
|
||||||
mail = maildata(
|
mail = maildata(
|
||||||
"encrypted.eml", from_addr=user1.addr, to_addr=user2.addr
|
"encrypted.eml", from_addr=user1.addr, to_addr=user2.addr
|
||||||
).as_string()
|
).as_string()
|
||||||
for i in range(chatmail_config.max_user_send_per_minute + 5):
|
for i in range(100):
|
||||||
print("Sending mail", str(i))
|
print("Sending mail", str(i))
|
||||||
try:
|
try:
|
||||||
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
||||||
except smtplib.SMTPException as e:
|
except smtplib.SMTPException as e:
|
||||||
if i < chatmail_config.max_user_send_per_minute:
|
if i < 60:
|
||||||
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
||||||
outcome = e.recipients[user2.addr]
|
outcome = e.recipients[user2.addr]
|
||||||
assert outcome[0] == 450
|
assert outcome[0] == 450
|
||||||
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,50 +1,6 @@
|
|||||||
import time
|
import time
|
||||||
import re
|
|
||||||
import random
|
import random
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
import requests
|
|
||||||
import ipaddress
|
|
||||||
import imap_tools
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def imap_mailbox(cmfactory):
|
|
||||||
(ac1,) = cmfactory.get_online_accounts(1)
|
|
||||||
user = ac1.get_config("addr")
|
|
||||||
password = ac1.get_config("mail_pw")
|
|
||||||
mailbox = imap_tools.MailBox(user.split("@")[1])
|
|
||||||
mailbox.login(user, password)
|
|
||||||
return mailbox
|
|
||||||
|
|
||||||
|
|
||||||
class TestMetadataTokens:
|
|
||||||
"Tests that use Metadata extension for storing tokens"
|
|
||||||
|
|
||||||
def test_set_get_metadata(self, imap_mailbox):
|
|
||||||
"set and get metadata token for an account"
|
|
||||||
client = imap_mailbox.client
|
|
||||||
client.send(b'a01 SETMETADATA INBOX (/private/devicetoken "1111" )\n')
|
|
||||||
res = client.readline()
|
|
||||||
assert b"OK Setmetadata completed" in res
|
|
||||||
|
|
||||||
client.send(b"a02 GETMETADATA INBOX /private/devicetoken\n")
|
|
||||||
res = client.readline()
|
|
||||||
assert res[:1] == b"*"
|
|
||||||
res = client.readline().strip().rstrip(b")")
|
|
||||||
assert res == b"1111"
|
|
||||||
assert b"Getmetadata completed" in client.readline()
|
|
||||||
|
|
||||||
client.send(b'a01 SETMETADATA INBOX (/private/devicetoken "2222" )\n')
|
|
||||||
res = client.readline()
|
|
||||||
assert b"OK Setmetadata completed" in res
|
|
||||||
|
|
||||||
client.send(b"a02 GETMETADATA INBOX /private/devicetoken\n")
|
|
||||||
res = client.readline()
|
|
||||||
assert res[:1] == b"*"
|
|
||||||
res = client.readline().strip().rstrip(b")")
|
|
||||||
assert res == b"1111 2222"
|
|
||||||
assert b"Getmetadata completed" in client.readline()
|
|
||||||
|
|
||||||
|
|
||||||
class TestEndToEndDeltaChat:
|
class TestEndToEndDeltaChat:
|
||||||
@@ -64,24 +20,14 @@ class TestEndToEndDeltaChat:
|
|||||||
assert msg2.text == "message0"
|
assert msg2.text == "message0"
|
||||||
|
|
||||||
@pytest.mark.slow
|
@pytest.mark.slow
|
||||||
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote, chatmail_config):
|
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote):
|
||||||
"""This is a very slow test as it needs to upload >100MB of mail data
|
"""This is a very slow test as it needs to upload >100MB of mail data
|
||||||
before quota is exceeded, and thus depends on the speed of the upload.
|
before quota is exceeded, and thus depends on the speed of the upload.
|
||||||
"""
|
"""
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
def parse_size_limit(limit: str) -> int:
|
quota = 1024 * 1024 * 100
|
||||||
"""Parse a size limit and return the number of bytes as integer.
|
|
||||||
|
|
||||||
Example input: 100M, 2.4T, 500 K
|
|
||||||
"""
|
|
||||||
units = {"B": 1, "K": 2**10, "M": 2**20, "G": 2**30, "T": 2**40}
|
|
||||||
size = re.sub(r"([KMGT])", r" \1", limit.upper())
|
|
||||||
number, unit = [string.strip() for string in size.split()]
|
|
||||||
return int(float(number) * units[unit])
|
|
||||||
|
|
||||||
quota = parse_size_limit(chatmail_config.max_mailbox_size)
|
|
||||||
attachsize = 1 * 1024 * 1024
|
attachsize = 1 * 1024 * 1024
|
||||||
num_to_send = quota // attachsize + 2
|
num_to_send = quota // attachsize + 2
|
||||||
lp.sec(f"ac1: send {num_to_send} large files to ac2")
|
lp.sec(f"ac1: send {num_to_send} large files to ac2")
|
||||||
@@ -103,7 +49,7 @@ class TestEndToEndDeltaChat:
|
|||||||
|
|
||||||
addr = ac2.get_config("addr").lower()
|
addr = ac2.get_config("addr").lower()
|
||||||
saved_ok = 0
|
saved_ok = 0
|
||||||
for line in remote.iter_output("journalctl -n0 -f -u dovecot"):
|
for line in remote.iter_output("journalctl -f -u dovecot"):
|
||||||
if addr not in line:
|
if addr not in line:
|
||||||
# print(line)
|
# print(line)
|
||||||
continue
|
continue
|
||||||
@@ -115,10 +61,7 @@ class TestEndToEndDeltaChat:
|
|||||||
)
|
)
|
||||||
lp.indent("good, message sending failed because quota was exceeded")
|
lp.indent("good, message sending failed because quota was exceeded")
|
||||||
return
|
return
|
||||||
if (
|
if "saved mail to inbox" in line:
|
||||||
"stored mail into mailbox 'inbox'" in line
|
|
||||||
or "saved mail to inbox" in line
|
|
||||||
):
|
|
||||||
saved_ok += 1
|
saved_ok += 1
|
||||||
print(f"{saved_ok}: {line}")
|
print(f"{saved_ok}: {line}")
|
||||||
if saved_ok >= num_to_send:
|
if saved_ok >= num_to_send:
|
||||||
@@ -148,14 +91,14 @@ class TestEndToEndDeltaChat:
|
|||||||
|
|
||||||
lp.sec("setup encrypted comms between ac1 and ac2 on different instances")
|
lp.sec("setup encrypted comms between ac1 and ac2 on different instances")
|
||||||
qr = ac1.get_setup_contact_qr()
|
qr = ac1.get_setup_contact_qr()
|
||||||
ch = ac2.qr_setup_contact(qr)
|
ac2.qr_setup_contact(qr)
|
||||||
assert ch.id >= 10
|
msg = ac2.wait_next_incoming_message()
|
||||||
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
assert "verified" in msg.text
|
||||||
|
|
||||||
lp.sec("ac1 sends a message and ac2 marks it as seen")
|
lp.sec("ac1 sends a message and ac2 marks it as seen")
|
||||||
chat = ac1.create_chat(ac2)
|
chat = ac1.create_chat(ac2)
|
||||||
msg = chat.send_text("hi")
|
msg = chat.send_text("hi")
|
||||||
m = ac2._evtracker.wait_next_incoming_message()
|
m = ac2.wait_next_incoming_message()
|
||||||
m.mark_seen()
|
m.mark_seen()
|
||||||
# we can only indirectly wait for mark-seen to cause an smtp-error
|
# we can only indirectly wait for mark-seen to cause an smtp-error
|
||||||
lp.sec("try to wait for markseen to complete and check error states")
|
lp.sec("try to wait for markseen to complete and check error states")
|
||||||
@@ -165,29 +108,3 @@ 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._evtracker.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._evtracker.wait_next_incoming_message()
|
|
||||||
assert reply.text == text
|
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
import os
|
import os
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from cmdeploy.cmdeploy import get_parser, main
|
from deploy_chatmail.cmdeploy import get_parser, main
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
@@ -20,7 +21,12 @@ class TestCmdline:
|
|||||||
run = parser.parse_args(["run"])
|
run = parser.parse_args(["run"])
|
||||||
assert init and run
|
assert init and run
|
||||||
|
|
||||||
@pytest.mark.xfail(reason="init doesn't exit anymore, check for CLI output instead")
|
def test_init(self, tmp_path):
|
||||||
|
main(["init", "chat.example.org"])
|
||||||
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
config = read_config(inipath)
|
||||||
|
assert config.mailname == "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):
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
from cmdeploy.www import build_webpages
|
from deploy_chatmail.www import build_webpages
|
||||||
|
|
||||||
|
|
||||||
def test_build_webpages(tmp_path, make_config):
|
def test_build_webpages(tmp_path, make_config):
|
||||||
pkgroot = importlib.resources.files("cmdeploy")
|
pkgroot = importlib.resources.files("deploy_chatmail")
|
||||||
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
||||||
assert src_dir.exists(), src_dir
|
assert src_dir.exists(), src_dir
|
||||||
config = make_config("chat.example.org")
|
config = make_config("chat.example.org")
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
<img class="banner" src="collage-top.png"/>
|
<img width="800px" src="collage-top.png"/>
|
||||||
|
|
||||||
## Dear [Delta Chat](https://get.delta.chat) users and newcomers,
|
## Dear [Delta Chat](https://get.delta.chat) users and newcomers,
|
||||||
|
|
||||||
@@ -7,13 +7,13 @@ 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 }}/new">
|
<a href="DCACCOUNT:https://{{ config.mail_domain }}/cgi-bin/newemail.py">
|
||||||
<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
|
||||||
|
|
||||||
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
||||||
|
|
||||||
{% if config.mail_domain != "nine.testrun.org" %}
|
|
||||||
<div class="experimental">Note: this is only a temporary development chatmail service</div>
|
## ⚡ Note: this is an experimental service ⚡
|
||||||
{% endif %}
|
|
||||||
|
|||||||
@@ -1,34 +1,18 @@
|
|||||||
|
|
||||||
<img class="banner" src="collage-info.png"/>
|
<img width="800px" src="collage-info.png"/>
|
||||||
|
|
||||||
## 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
|
||||||
you may tap `LOG INTO YOUR E-MAIL ACCOUNT`
|
you may tap `LOG INTO YOUR E-MAIL ACCOUNT`
|
||||||
and fill the two fields like this:
|
and fill the two fields like this:
|
||||||
|
|
||||||
- `Address`: invent a word with
|
- `Address`: invent a word with *exactly* nine characters
|
||||||
{% if username_min_length == username_max_length %}
|
and append `@{{config.mail_domain}}` to it.
|
||||||
*exactly* {{ username_min_length }}
|
|
||||||
{% else %}
|
|
||||||
{{ username_min_length}}
|
|
||||||
{% if username_max_length == "more" %}
|
|
||||||
or more
|
|
||||||
{% else %}
|
|
||||||
to {{ username_max_length }}
|
|
||||||
{% endif %}
|
|
||||||
{% endif %}
|
|
||||||
characters
|
|
||||||
and append `@{{config.mail_domain}}` to it.
|
|
||||||
|
|
||||||
- `Password`: invent at least {{ password_min_length }} characters.
|
- `Password`: invent at least 9 characters.
|
||||||
|
|
||||||
If the e-mail address is not yet taken, you'll get that account.
|
If the e-mail address is not yet taken, you'll get that account.
|
||||||
The first login sets your password.
|
The first login sets your password.
|
||||||
@@ -40,11 +24,11 @@ The first login sets your password.
|
|||||||
{{config.mail_domain}} but setting up contact via [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
{{config.mail_domain}} but setting up contact via [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
||||||
allows your messages to pass freely to any outside recipients.
|
allows your messages to pass freely to any outside recipients.
|
||||||
|
|
||||||
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
- You may send up to 60 messages per minute
|
||||||
|
|
||||||
- Messages are unconditionally removed {{ config.delete_mails_after }} days after arriving on the server.
|
- Messages are unconditionally removed 40 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 [100MB messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server)
|
||||||
|
|
||||||
|
|
||||||
### Who are the operators? Which software is running?
|
### Who are the operators? Which software is running?
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
||||||
<svg
|
|
||||||
width="145"
|
|
||||||
height="145"
|
|
||||||
version="1.1"
|
|
||||||
id="svg4"
|
|
||||||
sodipodi:docname="At_sign.svg"
|
|
||||||
inkscape:version="1.2.2 (b0a84865, 2022-12-01)"
|
|
||||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
||||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
||||||
xmlns="http://www.w3.org/2000/svg"
|
|
||||||
xmlns:svg="http://www.w3.org/2000/svg">
|
|
||||||
<defs
|
|
||||||
id="defs8" />
|
|
||||||
<sodipodi:namedview
|
|
||||||
id="namedview6"
|
|
||||||
pagecolor="#ffffff"
|
|
||||||
bordercolor="#000000"
|
|
||||||
borderopacity="0.25"
|
|
||||||
inkscape:showpageshadow="2"
|
|
||||||
inkscape:pageopacity="0.0"
|
|
||||||
inkscape:pagecheckerboard="0"
|
|
||||||
inkscape:deskcolor="#d1d1d1"
|
|
||||||
showgrid="false"
|
|
||||||
inkscape:zoom="3.0241379"
|
|
||||||
inkscape:cx="67.622577"
|
|
||||||
inkscape:cy="72.913341"
|
|
||||||
inkscape:window-width="1390"
|
|
||||||
inkscape:window-height="1027"
|
|
||||||
inkscape:window-x="55"
|
|
||||||
inkscape:window-y="25"
|
|
||||||
inkscape:window-maximized="0"
|
|
||||||
inkscape:current-layer="svg4" />
|
|
||||||
<g
|
|
||||||
aria-label="@"
|
|
||||||
id="text2"
|
|
||||||
style="font-size:144px;font-family:Arial">
|
|
||||||
<path
|
|
||||||
d="m 79.927878,94.422406 c -2.704286,3.120332 -5.741407,5.637394 -9.111364,7.551194 -3.328352,1.87221 -6.677506,2.80831 -10.047463,2.80831 -3.702792,0 -7.301573,-1.08172 -10.796342,-3.24515 -3.49477,-2.163426 -6.344671,-5.491779 -8.549704,-9.985058 -2.163429,-4.493275 -3.245144,-9.423397 -3.245144,-14.790365 0,-6.615099 1.684978,-13.230199 5.054935,-19.845299 3.411561,-6.656705 7.634407,-11.649233 12.66854,-14.977585 5.034133,-3.328352 9.92265,-4.992528 14.665552,-4.992528 3.619583,0 7.072748,0.956901 10.359496,2.870704 3.286748,1.872198 6.115847,4.742902 8.487297,8.612111 l 2.121825,-9.673023 h 11.170784 l -8.986557,41.87483 c -1.248129,5.824616 -1.872194,9.048957 -1.872194,9.673023 0,1.123319 0.416044,2.101022 1.248132,2.93311 0.873692,0.790484 1.913802,1.185726 3.120332,1.185726 2.20503,0 5.096537,-1.268934 8.674517,-3.806803 4.7429,-3.328352 8.4873,-7.780023 11.23319,-13.355013 2.78749,-5.616594 4.18124,-11.399606 4.18124,-17.349035 0,-6.947935 -1.78899,-13.438222 -5.36697,-19.47086 -3.53637,-6.032638 -8.84094,-10.858749 -15.913687,-14.478332 -7.03114,-3.619583 -14.811161,-5.429374 -23.340064,-5.429374 -9.73543,0 -18.638772,2.288242 -26.710026,6.864726 -8.029649,4.534879 -14.27031,11.06677 -18.721981,19.595673 -4.410066,8.487298 -6.615099,17.598662 -6.615099,27.334092 0,10.193078 2.205033,18.971607 6.615099,26.33559 2.290454,3.78888 -7.136335,18.96983 -3.810585,21.73443 3.138096,2.60861 18.971963,-7.14297 23.031819,-5.44631 8.404089,3.53637 17.702673,5.30456 27.895752,5.30456 10.90035,0 20.032515,-1.83059 27.396492,-5.49178 7.36399,-3.66119 12.87657,-8.11286 16.53776,-13.35501 l 9.29559,4 c -2.12183,4.36846 -3.76221,4.82013 -8.92116,9.35501 -5.15895,4.53488 -11.2956,8.11286 -18.40995,10.73393 -7.114346,2.66268 -15.684851,3.99402 -25.711512,3.99402 -9.236177,0 -17.76508,-1.18572 -25.586707,-3.55717 -7.780023,-2.37145 -29.296198,9.26152 -34.78798,4.47701 -5.49178,-4.7429 5.248856,-25.42482 2.461361,-31.62388 -3.49477,-7.863231 -5.242155,-16.350531 -5.242155,-25.461894 0,-10.151474 2.08022,-19.824498 6.240661,-29.019071 5.075736,-11.274793 12.273297,-19.907706 21.592683,-25.898739 9.360991,-5.991034 20.69819,-8.986551 34.011599,-8.986551 10.317891,0 19.574873,2.121824 27.77093,6.365473 8.23767,4.202045 14.72796,10.484309 19.47086,18.846794 4.03563,7.197561 6.05344,15.019189 6.05344,23.464883 0,12.065277 -4.24365,22.77841 -12.73094,32.1394 -7.572,8.404095 -15.85128,12.606135 -24.837827,12.606135 -2.870704,0 -5.200551,-0.43684 -6.98954,-1.31053 -1.747385,-0.8737 -3.037121,-2.12183 -3.869209,-3.744402 -0.540857,-1.040114 -0.936099,-2.829105 -1.185726,-5.366972 z M 49.723082,77.510217 c 0,5.699803 1.352143,10.130671 4.05643,13.292606 2.704286,3.161935 5.803814,4.742902 9.298583,4.742902 2.329847,0 4.784506,-0.686473 7.363979,-2.059418 2.579473,-1.41455 5.034133,-3.49477 7.363979,-6.240661 2.371451,-2.74589 4.306056,-6.219857 5.803815,-10.421902 1.497759,-4.243649 2.246638,-8.487298 2.246638,-12.730947 0,-5.658198 -1.41455,-10.047462 -4.243649,-13.167793 -2.787495,-3.12033 -6.199056,-4.680495 -10.234683,-4.680495 -2.662682,0 -5.179749,0.686473 -7.5512,2.059418 -2.329846,1.331341 -4.597286,3.494769 -6.802319,6.490286 -2.205033,2.995517 -3.97322,6.635903 -5.304561,10.921156 -1.331341,4.285253 -1.997012,8.216869 -1.997012,11.794848 z"
|
|
||||||
id="path347"
|
|
||||||
style="stroke-width:0.887561"
|
|
||||||
sodipodi:nodetypes="ccsscscsscccccscsccsccsccscscssccscscccsccsccscscccssscccscscsss" />
|
|
||||||
</g>
|
|
||||||
</svg>
|
|
||||||
|
Before Width: | Height: | Size: 4.5 KiB |
@@ -1,74 +0,0 @@
|
|||||||
|
|
||||||
body {
|
|
||||||
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 'Segoe UI Emoji', 'Apple Color Emoji', 'Noto Color Emoji', sans-serif;
|
|
||||||
line-height: 1.4;
|
|
||||||
font-size: 1.2em;
|
|
||||||
max-width: 800px;
|
|
||||||
margin: 20px auto;
|
|
||||||
padding: 0 10px;
|
|
||||||
color: #363636;
|
|
||||||
background: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
font-size: 2.2em;
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2, h3, h4, h5, h6 {
|
|
||||||
color: #000;
|
|
||||||
margin-bottom: 12px;
|
|
||||||
margin-top: 24px;
|
|
||||||
font-weight: 600;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
text-decoration: none;
|
|
||||||
color: #0076d1;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
img, video {
|
|
||||||
max-width: 100%;
|
|
||||||
height: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
code {
|
|
||||||
background: #efefef;
|
|
||||||
padding: 2.5px 5px;
|
|
||||||
border-radius: 6px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#menu {
|
|
||||||
display: flex;
|
|
||||||
flex-wrap: wrap;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
#menu li {
|
|
||||||
display: inline-block;
|
|
||||||
padding-right: 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
#domain {
|
|
||||||
margin-left: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
#domain a {
|
|
||||||
color: #888;
|
|
||||||
}
|
|
||||||
|
|
||||||
.banner {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.experimental {
|
|
||||||
margin: 3em 0;
|
|
||||||
padding: 1em;
|
|
||||||
border: 4px dashed red;
|
|
||||||
color: red;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
@@ -5,23 +5,16 @@
|
|||||||
{% if config.webdev %}
|
{% if config.webdev %}
|
||||||
<meta http-equiv="refresh" content="3">
|
<meta http-equiv="refresh" content="3">
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
||||||
<title>{{ config.mail_domain }} {{ pagename }}</title>
|
<title>{{ config.mail_domain }} {{ pagename }}</title>
|
||||||
<link rel="stylesheet" href="./main.css">
|
<link rel="stylesheet" href="./water.css">
|
||||||
<link rel="icon" href="/logo.svg">
|
|
||||||
<link rel=”mask-icon” href=”/logo.svg” color=”#000000">
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
<ul id="menu">
|
|
||||||
<li><a href="index.html">home</a></li>
|
|
||||||
<li><a href="info.html">info</a></li>
|
|
||||||
<li><a href="privacy.html">privacy</a></li>
|
|
||||||
<li><a href="https://github.com/deltachat/chatmail">public code ↗</a></li>
|
|
||||||
<li id="domain"><a href="index.html">{{ config.mail_domain }}</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
{{ markdown_html }}
|
{{ markdown_html }}
|
||||||
|
<footer>
|
||||||
|
<a href="index.html">home</a> |
|
||||||
|
<a href="info.html">more info</a> |
|
||||||
|
<a href="privacy.html">privacy</a> |
|
||||||
|
<a href="https://github.com/deltachat/chatmail">-> public development </a>
|
||||||
|
</footer>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user