mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 16:34:39 +00:00
Compare commits
186 Commits
chatmail-i
...
greeterbot
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4b9b0f5f44 | ||
|
|
10c671ebda | ||
|
|
f2be32ac6f | ||
|
|
b702848c33 | ||
|
|
a6f2f74520 | ||
|
|
01ec341364 | ||
|
|
998799fe3f | ||
|
|
6186dc5259 | ||
|
|
5880133b5b | ||
|
|
6772bfe630 | ||
|
|
101c3a6b47 | ||
|
|
5ef2100765 | ||
|
|
d49aae365c | ||
|
|
998a185332 | ||
|
|
3e78555ca1 | ||
|
|
01cfd0be19 | ||
|
|
1bdc547479 | ||
|
|
c0b8ba816d | ||
|
|
118ae49674 | ||
|
|
a47df20e22 | ||
|
|
a1d8881887 | ||
|
|
cd7416a0dd | ||
|
|
173e3f6390 | ||
|
|
b8d53242cf | ||
|
|
c65f618fb1 | ||
|
|
42afad0852 | ||
|
|
8bc19439a9 | ||
|
|
cdaddb9b0f | ||
|
|
768bf2b22c | ||
|
|
185e6f7d2a | ||
|
|
90e7169eef | ||
|
|
3db7933d8b | ||
|
|
75b41641f0 | ||
|
|
30a61972fb | ||
|
|
bcc54602ee | ||
|
|
f9998d5721 | ||
|
|
8605ceba5e | ||
|
|
30bcf9ff77 | ||
|
|
70b0e9d5e5 | ||
|
|
fdd533aa3b | ||
|
|
a44ed0aeb3 | ||
|
|
f5bfa6bd56 | ||
|
|
81a6f8808b | ||
|
|
be3685519f | ||
|
|
2cf950e901 | ||
|
|
46d5dbb07d | ||
|
|
d2e0d1fecc | ||
|
|
d333cfdd5a | ||
|
|
32238e99ab | ||
|
|
40a3a2cc86 | ||
|
|
fe978a1971 | ||
|
|
b426c2e7ff | ||
|
|
b626464453 | ||
|
|
76c3316f02 | ||
|
|
a6a9406228 | ||
|
|
7921f5dd0b | ||
|
|
39fc9d628f | ||
|
|
85a9183b61 | ||
|
|
36a4381484 | ||
|
|
5ff98a571c | ||
|
|
0a91aeb4a3 | ||
|
|
c38f1d7e54 | ||
|
|
42bba52f66 | ||
|
|
03aab4043c | ||
|
|
146def2f06 | ||
|
|
d642224a73 | ||
|
|
0238437ce7 | ||
|
|
7ed59ea8bc | ||
|
|
49d0a0bbb0 | ||
|
|
330a034329 | ||
|
|
aee18215fc | ||
|
|
336f87770d | ||
|
|
4199e04ab3 | ||
|
|
50922fb1d2 | ||
|
|
d2fe417715 | ||
|
|
2b731bf909 | ||
|
|
2669babb53 | ||
|
|
fe675a9a72 | ||
|
|
79f766b28e | ||
|
|
0eeb692c4b | ||
|
|
6c401173db | ||
|
|
b474b86e7b | ||
|
|
6a9beb8ff7 | ||
|
|
d0f5d08443 | ||
|
|
49848ec01e | ||
|
|
0ffe4d4996 | ||
|
|
7a2a889585 | ||
|
|
1e4b776de5 | ||
|
|
3d00ca1672 | ||
|
|
485bbb9cbd | ||
|
|
359c195419 | ||
|
|
1b9e822ff6 | ||
|
|
9f6c00d62c | ||
|
|
a1355c10ca | ||
|
|
92ca3283fd | ||
|
|
cea1f3f5f7 | ||
|
|
39550d3096 | ||
|
|
070003b983 | ||
|
|
049ed79e59 | ||
|
|
a9e55e3b25 | ||
|
|
5a178ed235 | ||
|
|
8a338f1320 | ||
|
|
d437b8a943 | ||
|
|
a4d520a9ad | ||
|
|
9c7dfdf2ff | ||
|
|
ffd15e4a9f | ||
|
|
7f8e0620ca | ||
|
|
dc9aebcb55 | ||
|
|
648b3e0ec3 | ||
|
|
2adfed2714 | ||
|
|
12542f7bed | ||
|
|
4aca88acf8 | ||
|
|
b1ac2b78c2 | ||
|
|
4a2b37f740 | ||
|
|
bb3a0a9945 | ||
|
|
3cde5be3b4 | ||
|
|
b055736439 | ||
|
|
2817ffd411 | ||
|
|
db45dc071b | ||
|
|
1c0543cb46 | ||
|
|
dde879c7fc | ||
|
|
cf95dfd49d | ||
|
|
4a96f19faf | ||
|
|
a2a78c0aff | ||
|
|
4b3a214276 | ||
|
|
bbf0e91761 | ||
|
|
f4b8ec6e10 | ||
|
|
3b45e82c76 | ||
|
|
4551f36b85 | ||
|
|
f2d32324e3 | ||
|
|
5d4b6eec69 | ||
|
|
98fd4b61c9 | ||
|
|
74f9e7536b | ||
|
|
849b9d430c | ||
|
|
0d0cc908c2 | ||
|
|
156434b952 | ||
|
|
02d07912dd | ||
|
|
4a7e36618f | ||
|
|
e272294e07 | ||
|
|
401f215dc9 | ||
|
|
3cd4265c94 | ||
|
|
8e6869d8e3 | ||
|
|
d6df0f0604 | ||
|
|
cad1d32682 | ||
|
|
fd10652f48 | ||
|
|
02918de6c1 | ||
|
|
e27dd84501 | ||
|
|
cdbda291c5 | ||
|
|
d70eb78a76 | ||
|
|
a5e4562505 | ||
|
|
3f2eb84323 | ||
|
|
613d3e14ea | ||
|
|
453c401ac6 | ||
|
|
8b756f2e0c | ||
|
|
9e9d5b7698 | ||
|
|
02adb758ff | ||
|
|
ffade66d97 | ||
|
|
988333d5fd | ||
|
|
db41e952e3 | ||
|
|
bb1b11df15 | ||
|
|
b3fdebf8df | ||
|
|
4615df2e3b | ||
|
|
73d8e01452 | ||
|
|
bf8a99d844 | ||
|
|
cb19ac34e3 | ||
|
|
15e5573ab4 | ||
|
|
74f5b2847f | ||
|
|
e417e43c54 | ||
|
|
158ebe1089 | ||
|
|
5fb7833677 | ||
|
|
587d8142d2 | ||
|
|
a6d24b3af7 | ||
|
|
d730af2e69 | ||
|
|
99b1e18b0a | ||
|
|
6012039c56 | ||
|
|
f388e86287 | ||
|
|
d3ca037ebf | ||
|
|
00a203c9aa | ||
|
|
6bffb5470d | ||
|
|
81c4a6170f | ||
|
|
6285283b02 | ||
|
|
b71e24d6a1 | ||
|
|
a4e48c9919 | ||
|
|
bc27eb58bf | ||
|
|
1b1f9365c9 | ||
|
|
d8c8040f07 |
4
.github/CODE_OF_CONDUCT.md
vendored
Normal file
4
.github/CODE_OF_CONDUCT.md
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
|
||||||
|
Please refer to
|
||||||
|
[Delta Chat community standards and practices](https://delta.chat/en/community-standards)
|
||||||
|
which also apply for all chatmail developments.
|
||||||
30
.github/workflows/ci.yaml
vendored
30
.github/workflows/ci.yaml
vendored
@@ -6,26 +6,32 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
tox:
|
tox:
|
||||||
name: chatmail tests
|
name: isolated chatmaild tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
run: pipx run tox
|
run: pipx run tox
|
||||||
- name: run deploy-chatmail offline tests
|
|
||||||
working-directory: deploy-chatmail
|
|
||||||
run: pipx run tox
|
|
||||||
- name: run deploy-chatmail offline tests
|
|
||||||
working-directory: deploy-chatmail
|
|
||||||
run: pipx run tox
|
|
||||||
|
|
||||||
scripts:
|
scripts:
|
||||||
name: chatmail script invocations
|
name: deploy-chatmail tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- name: run init.sh
|
|
||||||
run: ./scripts/init.sh
|
- name: initenv
|
||||||
- name: run test.sh
|
run: scripts/initenv.sh
|
||||||
run: ./scripts/test.sh
|
|
||||||
|
- name: append venv/bin to PATH
|
||||||
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
|
- name: run formatting checks
|
||||||
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
|
- name: run deploy-chatmail offline tests
|
||||||
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
# all other cmdeploy commands require a staging server
|
||||||
|
# see https://github.com/deltachat/chatmail/issues/100
|
||||||
|
|||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -3,10 +3,8 @@ __pycache__/
|
|||||||
*.py[cod]
|
*.py[cod]
|
||||||
*$py.class
|
*$py.class
|
||||||
*.swp
|
*.swp
|
||||||
www/privacy.html*
|
|
||||||
www/index.html*
|
|
||||||
www/info.html*
|
|
||||||
*qr-*.png
|
*qr-*.png
|
||||||
|
chatmail.ini
|
||||||
|
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
|
|||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2023, chatmail and delta chat teams
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
201
README.md
201
README.md
@@ -1,9 +1,9 @@
|
|||||||
|
|
||||||
<img width="800px" src="www/src/collage-top.png"/>
|
<img width="800px" src="www/src/collage-top.png"/>
|
||||||
|
|
||||||
# Chatmail instances optimized for Delta Chat apps
|
# Chatmail services optimized for Delta Chat apps
|
||||||
|
|
||||||
This repository helps to setup a ready-to-use chatmail instance
|
This repository helps to setup a ready-to-use chatmail server
|
||||||
comprised of a minimal setup of the battle-tested
|
comprised of a minimal setup of the battle-tested
|
||||||
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services.
|
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services.
|
||||||
|
|
||||||
@@ -13,119 +13,150 @@ for use by [Delta Chat apps](https://delta.chat).
|
|||||||
Chatmail accounts are automatically created by a first login,
|
Chatmail accounts are automatically created by a first login,
|
||||||
after which the initially specified password is required for using them.
|
after which the initially specified password is required for using them.
|
||||||
|
|
||||||
## Getting Started deploying your own chatmail instance
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
1. Prepare your local (presumably Linux) system:
|
We use `chat.example.org` as the chatmail domain in the following steps.
|
||||||
|
Please substitute it with your own domain.
|
||||||
|
|
||||||
scripts/init.sh
|
1. Install the `cmdeploy` command in a virtualenv
|
||||||
|
|
||||||
2. Setup a domain with `A` and `AAAA` records for your chatmail server.
|
```
|
||||||
|
git clone https://github.com/deltachat/chatmail
|
||||||
|
cd chatmail
|
||||||
|
scripts/initenv.sh
|
||||||
|
```
|
||||||
|
|
||||||
3. Set environment variable to the chatmail domain you want to setup:
|
2. Create chatmail configuration file `chatmail.ini`:
|
||||||
|
|
||||||
export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host
|
```
|
||||||
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
|
```
|
||||||
|
|
||||||
4. Fill in privacy contact data into the `chatmail.ini` file
|
3. Setup first DNS records for your chatmail domain,
|
||||||
|
according to the hints provided by `cmdeploy init`.
|
||||||
|
Verify that SSH root login works:
|
||||||
|
|
||||||
5. Deploy the chat mail instance to your chatmail server:
|
```
|
||||||
|
ssh root@chat.example.org # <-- use your domain
|
||||||
|
```
|
||||||
|
|
||||||
scripts/deploy.sh
|
4. Deploy to the remote chatmail server:
|
||||||
|
|
||||||
This script remotely sets up packages and configures the chatmail provider.
|
```
|
||||||
|
scripts/cmdeploy run
|
||||||
|
```
|
||||||
|
This script will also show you additional DNS records
|
||||||
|
which you should configure at your DNS provider
|
||||||
|
(it can take some time until they are public).
|
||||||
|
|
||||||
6. Run `scripts/generate-dns-zone.sh` and
|
### Other helpful commands:
|
||||||
transfer the generated DNS records at your DNS provider
|
|
||||||
|
|
||||||
|
To check the status of your remotely running chatmail service:
|
||||||
|
|
||||||
### Home page and getting started for users
|
```
|
||||||
|
scripts/cmdeploy status
|
||||||
The `deploy.sh` script deploys
|
|
||||||
|
|
||||||
- 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 files are generated by the according markdown `.md` file in the `www` directory.
|
|
||||||
|
|
||||||
|
|
||||||
### Refining the web pages
|
|
||||||
|
|
||||||
The `scripts/webdev.sh` script supports live development of the chatmail web presence:
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/init.sh # to locally initialize python virtual environments etc.
|
|
||||||
scripts/webdev.sh
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing html documents
|
To check whether your DNS records are correct:
|
||||||
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.
|
scripts/cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
To test whether your chatmail service is working correctly:
|
||||||
|
|
||||||
Note that this script is not needed for running `scripts/deploy.sh"
|
```
|
||||||
which deploys the whole chatmail setup remotely.
|
scripts/cmdeploy test
|
||||||
The code that generates the web pages is identical
|
```
|
||||||
which means that `webdev.sh` gives a pretty good preview.
|
|
||||||
|
|
||||||
### Ports
|
To measure the performance of your chatmail service:
|
||||||
|
|
||||||
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
```
|
||||||
Dovecot listens on ports 143(imap) and 993 (imaps).
|
scripts/cmdeploy bench
|
||||||
|
```
|
||||||
|
|
||||||
Delta Chat will, however, discover all ports and configurations
|
## Overview of this repository
|
||||||
automatically by reading the `autoconfig.xml` file from the chatmail instance.
|
|
||||||
|
|
||||||
|
This repository drives the development of chatmail services,
|
||||||
|
comprised of minimal setups of
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
- [postfix smtp server](https://www.postfix.org)
|
||||||
|
- [dovecot imap server](https://www.dovecot.org)
|
||||||
|
|
||||||
If you need to stop account creation,
|
as well as custom services that are integrated with these two:
|
||||||
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 instance
|
unencrypted e-mail from leaving the chatmail service
|
||||||
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.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
32
chatmail.ini
32
chatmail.ini
@@ -1,32 +0,0 @@
|
|||||||
|
|
||||||
[params]
|
|
||||||
|
|
||||||
# how many mails a user can send out per minute
|
|
||||||
max_user_send_per_minute = 60
|
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
|
||||||
passthrough_recipients = privacy@testrun.org xstore@testrun.org
|
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
|
|
||||||
# to which port to re-inject messages after they passed filtermail
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
|
|
||||||
|
|
||||||
[privacy:testrun]
|
|
||||||
|
|
||||||
# the settings in this section are only applied
|
|
||||||
# if the instantiated mail domain shell-matches the 'domain' setting
|
|
||||||
domain = *.testrun.org
|
|
||||||
privacy_postal =
|
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
|
||||||
Reichgrafen Str. 20, 79102 Freiburg, Germany
|
|
||||||
|
|
||||||
privacy_mail = delta-privacy@merlinux.eu
|
|
||||||
privacy_pdo =
|
|
||||||
Prof. Dr. Fabian Schmieder, lexICT UG (limited), Ostfeldstr. 49, 30559 Hannover.
|
|
||||||
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
|
||||||
privacy_supervisor =
|
|
||||||
State Commissioner for Data Protection and Freedom of Information of
|
|
||||||
Baden-Württemberg in 70173 Stuttgart, Germany.
|
|
||||||
4
chatmaild/MANIFEST.in
Normal file
4
chatmaild/MANIFEST.in
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
include src/chatmaild/*.f
|
||||||
|
include src/chatmaild/ini/*.ini.f
|
||||||
|
include src/chatmaild/ini/*.ini
|
||||||
|
include src/chatmaild/tests/mail-data/*
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools>=45"]
|
requires = ["setuptools>=61"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
@@ -8,11 +8,29 @@ version = "0.2"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
"iniconfig",
|
||||||
|
"deltachat-rpc-server",
|
||||||
|
"deltachat-rpc-client",
|
||||||
|
"ConfigArgParse",
|
||||||
|
"deltachat",
|
||||||
|
"setuptools>=60",
|
||||||
|
"setuptools-scm>=8",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[tool.setuptools]
|
||||||
|
include-package-data = true
|
||||||
|
|
||||||
|
[tool.setuptools.packages.find]
|
||||||
|
where = ['src']
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
|
echobot = "chatmaild.echo:main"
|
||||||
|
greeterbot = "chatmaild.greeterbot:main"
|
||||||
|
chatmail-metrics = "chatmaild.metrics:main"
|
||||||
|
|
||||||
|
[project.entry-points.pytest11]
|
||||||
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "-v -ra --strict-markers"
|
addopts = "-v -ra --strict-markers"
|
||||||
@@ -37,8 +55,7 @@ commands =
|
|||||||
ruff src/
|
ruff src/
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
passenv = CHATMAIL_DOMAIN
|
|
||||||
deps = pytest
|
deps = pytest
|
||||||
pdbpp
|
pdbpp
|
||||||
commands = pytest -v -rsXx {posargs: ../tests/chatmaild}
|
commands = pytest -v -rsXx {posargs}
|
||||||
"""
|
"""
|
||||||
|
|||||||
BIN
chatmaild/src/chatmaild/avatar.jpg
Normal file
BIN
chatmaild/src/chatmaild/avatar.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
@@ -1,41 +1,59 @@
|
|||||||
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
from fnmatch import fnmatch
|
|
||||||
import iniconfig
|
import iniconfig
|
||||||
|
|
||||||
system_mailname_path = Path("/etc/mailname")
|
|
||||||
|
|
||||||
|
def read_config(inipath):
|
||||||
def read_config(inipath, mailname=None):
|
cfg = iniconfig.IniConfig(inipath)
|
||||||
if mailname is None:
|
return Config(inipath, params=cfg.sections["params"])
|
||||||
with open(system_mailname_path) as f:
|
|
||||||
mailname = f.read().strip()
|
|
||||||
|
|
||||||
ini = iniconfig.IniConfig(inipath)
|
|
||||||
privacy = {}
|
|
||||||
for section in ini:
|
|
||||||
if section.name.startswith("privacy:"):
|
|
||||||
domain = section["domain"]
|
|
||||||
if fnmatch(mailname, domain):
|
|
||||||
privacy = section
|
|
||||||
break
|
|
||||||
|
|
||||||
return Config(inipath, mailname, privacy, params=ini.sections["params"])
|
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, mailname, privacy, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
self.mailname = mailname
|
self.mail_domain = params["mail_domain"]
|
||||||
self.privacy_postal = privacy.get("privacy_postal")
|
|
||||||
self.privacy_mail = privacy.get("privacy_mail")
|
|
||||||
self.privacy_pdo = privacy.get("privacy_pdo")
|
|
||||||
self.privacy_supervisor = privacy.get("privacy_supervisor")
|
|
||||||
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_mail = params.get("privacy_mail")
|
||||||
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
|
self.privacy_supervisor = params.get("privacy_supervisor")
|
||||||
|
|
||||||
def _getbytefile(self):
|
def _getbytefile(self):
|
||||||
return open(self._inipath, "rb")
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
|
|
||||||
|
def write_initial_config(inipath, mail_domain):
|
||||||
|
from importlib.resources import files
|
||||||
|
|
||||||
|
inidir = files(__package__).joinpath("ini")
|
||||||
|
content = (
|
||||||
|
inidir.joinpath("chatmail.ini.f").read_text().format(mail_domain=mail_domain)
|
||||||
|
)
|
||||||
|
if mail_domain.endswith(".testrun.org"):
|
||||||
|
override_inipath = inidir.joinpath("override-testrun.ini")
|
||||||
|
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
||||||
|
lines = []
|
||||||
|
for line in content.split("\n"):
|
||||||
|
for key, value in privacy.items():
|
||||||
|
value_lines = value.strip().split("\n")
|
||||||
|
if not line.startswith(f"{key} =") or not value_lines:
|
||||||
|
continue
|
||||||
|
if len(value_lines) == 1:
|
||||||
|
lines.append(f"{key} = {value}")
|
||||||
|
else:
|
||||||
|
lines.append(f"{key} =")
|
||||||
|
for vl in value_lines:
|
||||||
|
lines.append(f" {vl}")
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
lines.append(line)
|
||||||
|
content = "\n".join(lines)
|
||||||
|
|
||||||
|
inipath.write_text(content)
|
||||||
|
|||||||
@@ -46,11 +46,17 @@ class Connection:
|
|||||||
)
|
)
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
def get_user_list(self) -> set[str]:
|
||||||
|
"""Get a set of all users."""
|
||||||
|
q = "SELECT addr from users"
|
||||||
|
return set([tup[0] for tup in self._sqlconn.execute(q).fetchall()])
|
||||||
|
|
||||||
|
|
||||||
class Database:
|
class Database:
|
||||||
def __init__(self, path: str):
|
def __init__(self, path: str, read_only=False):
|
||||||
self.path = Path(path)
|
self.path = Path(path)
|
||||||
self.ensure_tables()
|
if not read_only:
|
||||||
|
self.ensure_tables()
|
||||||
|
|
||||||
def _get_connection(
|
def _get_connection(
|
||||||
self, write=False, transaction=False, closing=False
|
self, write=False, transaction=False, closing=False
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ from socketserver import (
|
|||||||
import pwd
|
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"
|
||||||
|
|
||||||
@@ -22,14 +23,17 @@ def encrypt_password(password: str):
|
|||||||
return "{SHA512-CRYPT}" + passhash
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
def is_allowed_to_create(user, cleartext_password) -> bool:
|
def is_allowed_to_create(config: Config, 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) < 9:
|
if len(cleartext_password) < config.password_min_length:
|
||||||
logging.warning("Password needs to be at least 9 characters long")
|
logging.warning(
|
||||||
|
"Password needs to be at least %s characters long",
|
||||||
|
config.password_min_length,
|
||||||
|
)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
parts = user.split("@")
|
parts = user.split("@")
|
||||||
@@ -38,10 +42,17 @@ def is_allowed_to_create(user, cleartext_password) -> bool:
|
|||||||
return False
|
return False
|
||||||
localpart, domain = parts
|
localpart, domain = parts
|
||||||
|
|
||||||
if domain == "nine.testrun.org":
|
if (
|
||||||
# nine.testrun.org policy, username has to be exactly nine chars
|
len(localpart) > config.username_max_length
|
||||||
if len(localpart) != 9:
|
or len(localpart) < config.username_min_length
|
||||||
logging.warning(f"localpart {localpart!r} has not exactly nine chars")
|
):
|
||||||
|
if localpart not in ("echo", "hello"):
|
||||||
|
logging.warning(
|
||||||
|
"localpart %s has to be between %s and %s chars long",
|
||||||
|
localpart,
|
||||||
|
config.username_min_length,
|
||||||
|
config.username_max_length,
|
||||||
|
)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
return True
|
return True
|
||||||
@@ -60,7 +71,7 @@ def lookup_userdb(db, user):
|
|||||||
return get_user_data(db, user)
|
return get_user_data(db, user)
|
||||||
|
|
||||||
|
|
||||||
def lookup_passdb(db, user, cleartext_password):
|
def lookup_passdb(db, config: Config, user, cleartext_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:
|
||||||
@@ -72,7 +83,7 @@ def lookup_passdb(db, user, cleartext_password):
|
|||||||
userdata["uid"] = "vmail"
|
userdata["uid"] = "vmail"
|
||||||
userdata["gid"] = "vmail"
|
userdata["gid"] = "vmail"
|
||||||
return userdata
|
return userdata
|
||||||
if not is_allowed_to_create(user, cleartext_password):
|
if not is_allowed_to_create(config, user, cleartext_password):
|
||||||
return
|
return
|
||||||
|
|
||||||
encrypted_password = encrypt_password(cleartext_password)
|
encrypted_password = encrypt_password(cleartext_password)
|
||||||
@@ -80,32 +91,66 @@ def lookup_passdb(db, user, cleartext_password):
|
|||||||
VALUES (?, ?, ?)"""
|
VALUES (?, ?, ?)"""
|
||||||
conn.execute(q, (user, encrypted_password, int(time.time())))
|
conn.execute(q, (user, encrypted_password, int(time.time())))
|
||||||
return dict(
|
return dict(
|
||||||
home=f"/home/vmail/{user}",
|
home=f"/home/vmail/mail/{config.mail_domain}/{user}",
|
||||||
uid="vmail",
|
uid="vmail",
|
||||||
gid="vmail",
|
gid="vmail",
|
||||||
password=encrypted_password,
|
password=encrypted_password,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_request(msg, db, mail_domain):
|
def split_and_unescape(s):
|
||||||
|
"""Split strings using double quote as a separator and backslash as escape character
|
||||||
|
into parts."""
|
||||||
|
|
||||||
|
out = ""
|
||||||
|
i = 0
|
||||||
|
while i < len(s):
|
||||||
|
c = s[i]
|
||||||
|
if c == "\\":
|
||||||
|
# Skip escape character.
|
||||||
|
i += 1
|
||||||
|
|
||||||
|
# This will raise IndexError if there is no character
|
||||||
|
# after escape character. This is expected
|
||||||
|
# as this is an invalid input.
|
||||||
|
out += s[i]
|
||||||
|
elif c == '"':
|
||||||
|
# Separator
|
||||||
|
yield out
|
||||||
|
out = ""
|
||||||
|
else:
|
||||||
|
out += c
|
||||||
|
i += 1
|
||||||
|
yield out
|
||||||
|
|
||||||
|
|
||||||
|
def handle_dovecot_request(msg, db, config: Config):
|
||||||
short_command = msg[0]
|
short_command = msg[0]
|
||||||
if short_command == "L": # LOOKUP
|
if short_command == "L": # LOOKUP
|
||||||
parts = msg[1:].split("\t")
|
parts = msg[1:].split("\t")
|
||||||
keyname, user = parts[:2]
|
|
||||||
namespace, type, *args = keyname.split("/")
|
# Dovecot <2.3.17 has only one part,
|
||||||
|
# do not attempt to read any other parts for compatibility.
|
||||||
|
keyname = parts[0]
|
||||||
|
|
||||||
|
namespace, type, args = keyname.split("/", 2)
|
||||||
|
args = list(split_and_unescape(args))
|
||||||
|
|
||||||
reply_command = "F"
|
reply_command = "F"
|
||||||
res = ""
|
res = ""
|
||||||
if namespace == "shared":
|
if namespace == "shared":
|
||||||
if type == "userdb":
|
if type == "userdb":
|
||||||
if user.endswith(f"@{mail_domain}"):
|
user = args[0]
|
||||||
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
res = lookup_userdb(db, user)
|
res = lookup_userdb(db, 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":
|
||||||
if user.endswith(f"@{mail_domain}"):
|
user = args[1]
|
||||||
res = lookup_passdb(db, user, cleartext_password=args[0])
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
|
res = lookup_passdb(db, config, user, cleartext_password=args[0])
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
@@ -123,8 +168,7 @@ def main():
|
|||||||
socket = sys.argv[1]
|
socket = sys.argv[1]
|
||||||
passwd_entry = pwd.getpwnam(sys.argv[2])
|
passwd_entry = pwd.getpwnam(sys.argv[2])
|
||||||
db = Database(sys.argv[3])
|
db = Database(sys.argv[3])
|
||||||
with open("/etc/mailname", "r") as fp:
|
config = read_config(sys.argv[4])
|
||||||
mail_domain = fp.read().strip()
|
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
class Handler(StreamRequestHandler):
|
||||||
def handle(self):
|
def handle(self):
|
||||||
@@ -133,7 +177,7 @@ def main():
|
|||||||
msg = self.rfile.readline().strip().decode()
|
msg = self.rfile.readline().strip().decode()
|
||||||
if not msg:
|
if not msg:
|
||||||
break
|
break
|
||||||
res = handle_dovecot_request(msg, db, mail_domain)
|
res = handle_dovecot_request(msg, db, config)
|
||||||
if res:
|
if res:
|
||||||
self.wfile.write(res.encode("ascii"))
|
self.wfile.write(res.encode("ascii"))
|
||||||
self.wfile.flush()
|
self.wfile.flush()
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=Dict authentication proxy for dovecot
|
Description=Chatmail dict authentication proxy for dovecot
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite
|
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite {config_path}
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
|
|
||||||
|
|||||||
84
chatmaild/src/chatmaild/echo.py
Normal file
84
chatmaild/src/chatmaild/echo.py
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Advanced echo bot example.
|
||||||
|
|
||||||
|
it will echo back any message that has non-empty text and also supports the /help command.
|
||||||
|
"""
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
||||||
|
|
||||||
|
from chatmaild.newemail import create_newemail_dict
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
hooks = events.HookCollection()
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.RawEvent)
|
||||||
|
def log_event(event):
|
||||||
|
if event.kind == EventType.INFO:
|
||||||
|
logging.info(event.msg)
|
||||||
|
elif event.kind == EventType.WARNING:
|
||||||
|
logging.warning(event.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.RawEvent(EventType.ERROR))
|
||||||
|
def log_error(event):
|
||||||
|
logging.error(event.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.MemberListChanged)
|
||||||
|
def on_memberlist_changed(event):
|
||||||
|
logging.info(
|
||||||
|
"member %s was %s", event.member, "added" if event.member_added else "removed"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.GroupImageChanged)
|
||||||
|
def on_group_image_changed(event):
|
||||||
|
logging.info("group image %s", "deleted" if event.image_deleted else "changed")
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.GroupNameChanged)
|
||||||
|
def on_group_name_changed(event):
|
||||||
|
logging.info("group name changed, old name: %s", event.old_name)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.NewMessage(func=lambda e: not e.command))
|
||||||
|
def echo(event):
|
||||||
|
snapshot = event.message_snapshot
|
||||||
|
if snapshot.text or snapshot.file:
|
||||||
|
snapshot.chat.send_message(text=snapshot.text, file=snapshot.file)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.NewMessage(command="/help"))
|
||||||
|
def help_command(event):
|
||||||
|
snapshot = event.message_snapshot
|
||||||
|
snapshot.chat.send_text("Send me any message and I will echo it back")
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
path = os.environ.get("PATH")
|
||||||
|
venv_path = sys.argv[0].strip("echobot")
|
||||||
|
os.environ["PATH"] = path + ":" + venv_path
|
||||||
|
with Rpc() as rpc:
|
||||||
|
deltachat = DeltaChat(rpc)
|
||||||
|
system_info = deltachat.get_system_info()
|
||||||
|
logging.info("Running deltachat core %s", system_info.deltachat_core_version)
|
||||||
|
|
||||||
|
accounts = deltachat.get_all_accounts()
|
||||||
|
account = accounts[0] if accounts else deltachat.add_account()
|
||||||
|
|
||||||
|
bot = Bot(account, hooks)
|
||||||
|
if not bot.is_configured():
|
||||||
|
config = read_config(sys.argv[1])
|
||||||
|
password = create_newemail_dict(config).get("password")
|
||||||
|
email = "echo@" + config.mail_domain
|
||||||
|
bot.configure(email, password)
|
||||||
|
bot.run_forever()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
logging.basicConfig(level=logging.INFO)
|
||||||
|
main()
|
||||||
11
chatmaild/src/chatmaild/echobot.service.f
Normal file
11
chatmaild/src/chatmaild/echobot.service.f
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Chatmail echo bot for testing it works
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart={execpath} {config_path}
|
||||||
|
Environment="PATH={remote_venv_dir}:$PATH"
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
BIN
chatmaild/src/chatmaild/editor.xdc
Normal file
BIN
chatmaild/src/chatmaild/editor.xdc
Normal file
Binary file not shown.
@@ -7,7 +7,6 @@ from email.parser import BytesParser
|
|||||||
from email import policy
|
from email import policy
|
||||||
from email.utils import parseaddr
|
from email.utils import parseaddr
|
||||||
|
|
||||||
from aiosmtpd.smtp import SMTP
|
|
||||||
from aiosmtpd.controller import Controller
|
from aiosmtpd.controller import Controller
|
||||||
from smtplib import SMTP as SMTPClient
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
@@ -112,6 +111,9 @@ 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:
|
||||||
@@ -127,7 +129,10 @@ class BeforeQueueHandler:
|
|||||||
|
|
||||||
is_outgoing = recipient_domain != envelope_from_domain
|
is_outgoing = recipient_domain != envelope_from_domain
|
||||||
if is_outgoing and not mail_encrypted:
|
if is_outgoing and not mail_encrypted:
|
||||||
is_securejoin = message.get("secure-join") in ["vc-request", "vg-request"]
|
is_securejoin = message.get("secure-join") in [
|
||||||
|
"vc-request",
|
||||||
|
"vg-request",
|
||||||
|
]
|
||||||
if not is_securejoin:
|
if not is_securejoin:
|
||||||
return f"500 Invalid unencrypted mail to <{recipient}>"
|
return f"500 Invalid unencrypted mail to <{recipient}>"
|
||||||
|
|
||||||
|
|||||||
132
chatmaild/src/chatmaild/greeterbot.py
Normal file
132
chatmaild/src/chatmaild/greeterbot.py
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
import time
|
||||||
|
|
||||||
|
import deltachat
|
||||||
|
from deltachat.tracker import ConfigureFailed
|
||||||
|
from time import sleep
|
||||||
|
import tempfile
|
||||||
|
import os
|
||||||
|
import configargparse
|
||||||
|
import pkg_resources
|
||||||
|
import secrets
|
||||||
|
|
||||||
|
from chatmaild.database import Database
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
from chatmaild.newemail import ALPHANUMERIC_PUNCT, CONFIG_PATH
|
||||||
|
|
||||||
|
PASSDB_PATH = "/home/vmail/passdb.sqlite"
|
||||||
|
|
||||||
|
|
||||||
|
def setup_account(data_dir: str, debug: bool) -> deltachat.Account:
|
||||||
|
"""Create a deltachat account with a given addr/password combination.
|
||||||
|
|
||||||
|
:param data_dir: the directory where the data(base) is stored.
|
||||||
|
:param debug: whether to show log messages for the account.
|
||||||
|
:return: the deltachat account object.
|
||||||
|
"""
|
||||||
|
chatmail_config = read_config(CONFIG_PATH)
|
||||||
|
addr = "hello@" + chatmail_config.mail_domain
|
||||||
|
|
||||||
|
try:
|
||||||
|
os.mkdir(os.path.join(data_dir, addr))
|
||||||
|
except FileExistsError:
|
||||||
|
pass
|
||||||
|
db_path = os.path.join(data_dir, addr, "db.sqlite")
|
||||||
|
|
||||||
|
ac = deltachat.Account(db_path)
|
||||||
|
if debug:
|
||||||
|
ac.add_account_plugin(deltachat.events.FFIEventLogger(ac))
|
||||||
|
|
||||||
|
ac.set_config("mvbox_move", "0")
|
||||||
|
ac.set_config("sentbox_watch", "0")
|
||||||
|
ac.set_config("bot", "1")
|
||||||
|
ac.set_config("mdns_enabled", "0")
|
||||||
|
|
||||||
|
if not ac.is_configured():
|
||||||
|
cleartext_password = "".join(
|
||||||
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
|
for _ in range(chatmail_config.password_min_length + 3)
|
||||||
|
)
|
||||||
|
ac.set_config("mail_pw", cleartext_password)
|
||||||
|
ac.set_config("addr", addr)
|
||||||
|
|
||||||
|
configtracker = ac.configure()
|
||||||
|
try:
|
||||||
|
configtracker.wait_finish()
|
||||||
|
except ConfigureFailed:
|
||||||
|
print(
|
||||||
|
"configuration setup failed for %s with password:\n%s"
|
||||||
|
% (ac.get_config("addr"), ac.get_config("mail_pw"))
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
|
||||||
|
ac.start_io()
|
||||||
|
avatar = pkg_resources.resource_filename(__name__, "avatar.jpg")
|
||||||
|
ac.set_avatar(avatar)
|
||||||
|
ac.set_config("displayname", f"Hello at {chatmail_config.mail_domain}!")
|
||||||
|
return ac
|
||||||
|
|
||||||
|
|
||||||
|
class GreetBot:
|
||||||
|
def __init__(self, passdb, account):
|
||||||
|
self.db = Database(passdb, read_only=True)
|
||||||
|
self.account = account
|
||||||
|
self.domain = account.get_config("addr").split("@")[1]
|
||||||
|
with self.db.read_connection() as conn:
|
||||||
|
self.existing_users = conn.get_user_list()
|
||||||
|
|
||||||
|
def greet_users(self):
|
||||||
|
with self.db.read_connection() as conn:
|
||||||
|
users = conn.get_user_list()
|
||||||
|
new_users = users.difference(self.existing_users)
|
||||||
|
self.existing_users = users
|
||||||
|
time.sleep(20) # wait until Delta is configured on the user side
|
||||||
|
for user in new_users:
|
||||||
|
for ci_prefix in ["ac1_", "ac2_", "ac3_", "ac4_", "ac5_", "ci-"]:
|
||||||
|
if user.startswith(ci_prefix):
|
||||||
|
continue
|
||||||
|
if user not in [c.addr for c in self.account.get_contacts()]:
|
||||||
|
print("Inviting", user)
|
||||||
|
contact = self.account.create_contact(user)
|
||||||
|
chat = contact.create_chat()
|
||||||
|
chat.send_text(
|
||||||
|
"Welcome to %s! Here you can try out Delta Chat." % (self.domain,)
|
||||||
|
)
|
||||||
|
chat.send_text(
|
||||||
|
"I prepared some webxdc apps for you, if you are interested:"
|
||||||
|
)
|
||||||
|
chat.send_file(pkg_resources.resource_filename(__name__, "editor.xdc"))
|
||||||
|
chat.send_file(
|
||||||
|
pkg_resources.resource_filename(__name__, "tower-builder.xdc")
|
||||||
|
)
|
||||||
|
chat.send_text(
|
||||||
|
"You can visit https://webxdc.org/apps to discover more apps! "
|
||||||
|
"Some of these games you can also play with friends, directly in the chat."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
args = configargparse.ArgumentParser()
|
||||||
|
args.add_argument("--db_path", help="location of the Delta Chat database")
|
||||||
|
args.add_argument(
|
||||||
|
"--passdb", default=PASSDB_PATH, help="location of the chatmail passdb"
|
||||||
|
)
|
||||||
|
args.add_argument("--show-ffi", action="store_true", help="print Delta Chat log")
|
||||||
|
ops = args.parse_args()
|
||||||
|
|
||||||
|
# ensuring account data directory
|
||||||
|
if ops.db_path is None:
|
||||||
|
tempdir = tempfile.TemporaryDirectory(prefix="hellobot")
|
||||||
|
ops.db_path = tempdir.name
|
||||||
|
elif not os.path.exists(ops.db_path):
|
||||||
|
os.mkdir(ops.db_path)
|
||||||
|
|
||||||
|
ac = setup_account(ops.db_path, ops.show_ffi)
|
||||||
|
greeter = GreetBot(ops.passdb, ac)
|
||||||
|
print("waiting for new chatmail users...")
|
||||||
|
while 1:
|
||||||
|
greeter.greet_users()
|
||||||
|
sleep(5)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
11
chatmaild/src/chatmaild/greeterbot.service.f
Normal file
11
chatmaild/src/chatmaild/greeterbot.service.f
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Chatmail greeterbot, a Delta Chat bot to greet new users
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart={execpath} --passdb {passdb_path} --db_path /home/vmail/greeterbot/ --show-ffi
|
||||||
|
User=vmail
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
63
chatmaild/src/chatmaild/ini/chatmail.ini.f
Normal file
63
chatmaild/src/chatmaild/ini/chatmail.ini.f
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
[params]
|
||||||
|
|
||||||
|
# mail domain (MUST be set to fully qualified chat mail domain)
|
||||||
|
mail_domain = {mail_domain}
|
||||||
|
|
||||||
|
#
|
||||||
|
# If you only do private test deploys, you don't need to modify any settings below
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# Account Restrictions
|
||||||
|
#
|
||||||
|
|
||||||
|
# how many mails a user can send out per minute
|
||||||
|
max_user_send_per_minute = 60
|
||||||
|
|
||||||
|
# maximum mailbox size of a chatmail account
|
||||||
|
max_mailbox_size = 100M
|
||||||
|
|
||||||
|
# days after which mails are unconditionally deleted
|
||||||
|
delete_mails_after = 40
|
||||||
|
|
||||||
|
# minimum length a username must have
|
||||||
|
username_min_length = 9
|
||||||
|
|
||||||
|
# maximum length a username can have
|
||||||
|
username_max_length = 9
|
||||||
|
|
||||||
|
# minimum length a password must have
|
||||||
|
password_min_length = 9
|
||||||
|
|
||||||
|
# list of chatmail accounts which can send outbound un-encrypted mail
|
||||||
|
passthrough_senders =
|
||||||
|
|
||||||
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
|
passthrough_recipients =
|
||||||
|
|
||||||
|
#
|
||||||
|
# Deployment Details
|
||||||
|
#
|
||||||
|
|
||||||
|
# where the filtermail SMTP service listens
|
||||||
|
filtermail_smtp_port = 10080
|
||||||
|
|
||||||
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
|
postfix_reinject_port = 10025
|
||||||
|
|
||||||
|
#
|
||||||
|
# Privacy Policy
|
||||||
|
#
|
||||||
|
|
||||||
|
# postal address of privacy contact
|
||||||
|
privacy_postal =
|
||||||
|
|
||||||
|
# email address of privacy contact
|
||||||
|
privacy_mail =
|
||||||
|
|
||||||
|
# postal address of the privacy data officer
|
||||||
|
privacy_pdo =
|
||||||
|
|
||||||
|
# postal address of the privacy supervisor
|
||||||
|
privacy_supervisor =
|
||||||
|
|
||||||
16
chatmaild/src/chatmaild/ini/override-testrun.ini
Normal file
16
chatmaild/src/chatmaild/ini/override-testrun.ini
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
|
||||||
|
[privacy]
|
||||||
|
|
||||||
|
passthrough_recipients = privacy@testrun.org
|
||||||
|
|
||||||
|
privacy_postal =
|
||||||
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
|
Reichgrafen Str. 20, 79102 Freiburg, Germany
|
||||||
|
|
||||||
|
privacy_mail = privacy@testrun.org
|
||||||
|
privacy_pdo =
|
||||||
|
Prof. Dr. Fabian Schmieder, lexICT UG (limited), Ostfeldstr. 49, 30559 Hannover.
|
||||||
|
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
||||||
|
privacy_supervisor =
|
||||||
|
State Commissioner for Data Protection and Freedom of Information of
|
||||||
|
Baden-Württemberg in 70173 Stuttgart, Germany.
|
||||||
25
chatmaild/src/chatmaild/metrics.py
Normal file
25
chatmaild/src/chatmaild/metrics.py
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
from pathlib import Path
|
||||||
|
import time
|
||||||
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
def main(vmail_dir=None):
|
||||||
|
if vmail_dir is None:
|
||||||
|
vmail_dir = sys.argv[1]
|
||||||
|
|
||||||
|
accounts = 0
|
||||||
|
ci_accounts = 0
|
||||||
|
|
||||||
|
for path in Path(vmail_dir).iterdir():
|
||||||
|
accounts += 1
|
||||||
|
if path.name[:3] in ("ci-", "ac_"):
|
||||||
|
ci_accounts += 1
|
||||||
|
|
||||||
|
timestamp = int(time.time() * 1000)
|
||||||
|
print(f"accounts {accounts} {timestamp}")
|
||||||
|
print(f"ci_accounts {ci_accounts} {timestamp}")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -1,23 +1,31 @@
|
|||||||
#!/usr/bin/python3
|
#!/usr/local/lib/chatmaild/venv/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
|
||||||
|
|
||||||
mailname_path = "/etc/mailname"
|
from chatmaild.config import read_config, Config
|
||||||
|
|
||||||
|
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
||||||
|
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
||||||
|
ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(domain):
|
def create_newemail_dict(config: Config):
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
||||||
user = "".join(random.choices(alphanumeric, k=9))
|
password = "".join(
|
||||||
password = "".join(random.choices(alphanumeric, k=12))
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
return dict(email=f"{user}@{domain}", password=f"{password}")
|
for _ in range(config.password_min_length + 3)
|
||||||
|
)
|
||||||
|
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
domain = open(mailname_path).read().strip()
|
config = read_config(CONFIG_PATH)
|
||||||
creds = create_newemail_dict(domain=domain)
|
creds = create_newemail_dict(config)
|
||||||
|
|
||||||
print("Content-Type: application/json")
|
print("Content-Type: application/json")
|
||||||
print("")
|
print("")
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ Date: Sun, 15 Oct 2023 16:41:44 +0000
|
|||||||
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
Chat-Version: 1.0
|
Chat-Version: 1.0
|
||||||
Autocrypt: addr=foobar@c2.testrun.org; prefer-encrypt=mutual;
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
||||||
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
||||||
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
||||||
@@ -20,4 +20,4 @@ Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
|||||||
|
|
||||||
Hi!
|
Hi!
|
||||||
|
|
||||||
|
|
||||||
68
chatmaild/src/chatmaild/tests/plugin.py
Normal file
68
chatmaild/src/chatmaild/tests/plugin.py
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
import random
|
||||||
|
import importlib.resources
|
||||||
|
import itertools
|
||||||
|
from email.parser import BytesParser
|
||||||
|
from email import policy
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from chatmaild.database import Database
|
||||||
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def make_config(tmp_path):
|
||||||
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
|
||||||
|
def make_conf(mail_domain):
|
||||||
|
write_initial_config(inipath, mail_domain=mail_domain)
|
||||||
|
return read_config(inipath)
|
||||||
|
|
||||||
|
return make_conf
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def example_config(make_config):
|
||||||
|
return make_config("chat.example.org")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildomain(example_config):
|
||||||
|
return example_config.mail_domain
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def gencreds(maildomain):
|
||||||
|
count = itertools.count()
|
||||||
|
next(count)
|
||||||
|
|
||||||
|
def gen(domain=None):
|
||||||
|
domain = domain if domain else maildomain
|
||||||
|
while 1:
|
||||||
|
num = next(count)
|
||||||
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
|
user = "".join(random.choices(alphanumeric, k=10))
|
||||||
|
user = f"ac{num}_{user}"[:9]
|
||||||
|
password = "".join(random.choices(alphanumeric, k=12))
|
||||||
|
yield f"{user}@{domain}", f"{password}"
|
||||||
|
|
||||||
|
return lambda domain=None: next(gen(domain))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def db(tmpdir):
|
||||||
|
db_path = tmpdir / "passdb.sqlite"
|
||||||
|
print("database path:", db_path)
|
||||||
|
return Database(db_path)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildata(request):
|
||||||
|
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
||||||
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
|
def maildata(name, from_addr, to_addr):
|
||||||
|
data = datadir.joinpath(name).read_text()
|
||||||
|
text = data.format(from_addr=from_addr, to_addr=to_addr)
|
||||||
|
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
||||||
|
|
||||||
|
return maildata
|
||||||
32
chatmaild/src/chatmaild/tests/test_config.py
Normal file
32
chatmaild/src/chatmaild/tests/test_config.py
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_config_basic(example_config):
|
||||||
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
assert not example_config.privacy_supervisor and not example_config.privacy_mail
|
||||||
|
assert not example_config.privacy_pdo and not example_config.privacy_postal
|
||||||
|
|
||||||
|
inipath = example_config._inipath
|
||||||
|
inipath.write_text(inipath.read_text().replace("60", "37"))
|
||||||
|
example_config = read_config(inipath)
|
||||||
|
assert example_config.max_user_send_per_minute == 37
|
||||||
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_config_testrun(make_config):
|
||||||
|
config = make_config("something.testrun.org")
|
||||||
|
assert config.mail_domain == "something.testrun.org"
|
||||||
|
assert len(config.privacy_postal.split("\n")) > 1
|
||||||
|
assert len(config.privacy_supervisor.split("\n")) > 1
|
||||||
|
assert len(config.privacy_pdo.split("\n")) > 1
|
||||||
|
assert config.privacy_mail == "privacy@testrun.org"
|
||||||
|
assert config.filtermail_smtp_port == 10080
|
||||||
|
assert config.postfix_reinject_port == 10025
|
||||||
|
assert config.max_user_send_per_minute == 60
|
||||||
|
assert config.max_mailbox_size == "100M"
|
||||||
|
assert config.delete_mails_after == "40"
|
||||||
|
assert config.username_min_length == 9
|
||||||
|
assert config.username_max_length == 9
|
||||||
|
assert config.password_min_length == 9
|
||||||
|
assert config.passthrough_recipients == ["privacy@testrun.org"]
|
||||||
|
assert config.passthrough_senders == []
|
||||||
@@ -9,29 +9,35 @@ from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_requ
|
|||||||
from chatmaild.database import DBError
|
from chatmaild.database import DBError
|
||||||
|
|
||||||
|
|
||||||
def test_basic(db):
|
def test_basic(db, example_config):
|
||||||
lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u")
|
lookup_passdb(db, example_config, "asdf12345@chat.example.org", "q9mr3faue")
|
||||||
data = get_user_data(db, "link2xt@c1.testrun.org")
|
data = get_user_data(db, "asdf12345@chat.example.org")
|
||||||
assert data
|
assert data
|
||||||
data2 = lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u")
|
data2 = lookup_passdb(
|
||||||
|
db, example_config, "asdf12345@chat.example.org", "q9mr3jewvadsfaue"
|
||||||
|
)
|
||||||
assert data == data2
|
assert data == data2
|
||||||
|
|
||||||
|
|
||||||
def test_dont_overwrite_password_on_wrong_login(db):
|
def test_dont_overwrite_password_on_wrong_login(db, example_config):
|
||||||
"""Test that logging in with a different password doesn't create a new user"""
|
"""Test that logging in with a different password doesn't create a new user"""
|
||||||
res = lookup_passdb(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983")
|
res = lookup_passdb(
|
||||||
|
db, example_config, "newuser12@chat.example.org", "kajdlkajsldk12l3kj1983"
|
||||||
|
)
|
||||||
assert res["password"]
|
assert res["password"]
|
||||||
res2 = lookup_passdb(db, "newuser1@something.org", "kajdlqweqwe")
|
res2 = lookup_passdb(db, example_config, "newuser12@chat.example.org", "kajdslqwe")
|
||||||
# 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):
|
def test_nocreate_file(db, monkeypatch, tmpdir, example_config):
|
||||||
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(db, "newuser1@something.org", "zequ0Aimuchoodaechik")
|
lookup_passdb(
|
||||||
assert not get_user_data(db, "newuser1@something.org")
|
db, example_config, "newuser12@chat.example.org", "zequ0Aimuchoodaechik"
|
||||||
|
)
|
||||||
|
assert not get_user_data(db, "newuser12@chat.example.org")
|
||||||
|
|
||||||
|
|
||||||
def test_db_version(db):
|
def test_db_version(db):
|
||||||
@@ -45,22 +51,26 @@ def test_too_high_db_version(db):
|
|||||||
db.ensure_tables()
|
db.ensure_tables()
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request(db):
|
def test_handle_dovecot_request(db, example_config):
|
||||||
|
# Test that password can contain ", ', \ and /
|
||||||
msg = (
|
msg = (
|
||||||
"Lshared/passdb/laksjdlaksjdlaksjdlk12j3l1k2j3123/"
|
'Lshared/passdb/laksjdlaksjdlak\\\\sjdlk\\"12j\\\'3l1/k2j3123"'
|
||||||
"some42@c3.testrun.org\tsome42@c3.testrun.org"
|
"some42123@chat.example.org\tsome42123@chat.example.org"
|
||||||
)
|
)
|
||||||
res = handle_dovecot_request(msg, db, "c3.testrun.org")
|
res = handle_dovecot_request(msg, db, example_config)
|
||||||
assert res
|
assert res
|
||||||
assert res[0] == "O" and res.endswith("\n")
|
assert res[0] == "O" and res.endswith("\n")
|
||||||
userdata = json.loads(res[1:].strip())
|
userdata = json.loads(res[1:].strip())
|
||||||
assert userdata["home"] == "/home/vmail/some42@c3.testrun.org"
|
assert (
|
||||||
|
userdata["home"]
|
||||||
|
== "/home/vmail/mail/chat.example.org/some42123@chat.example.org"
|
||||||
|
)
|
||||||
assert userdata["uid"] == userdata["gid"] == "vmail"
|
assert userdata["uid"] == userdata["gid"] == "vmail"
|
||||||
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
||||||
|
|
||||||
|
|
||||||
def test_100_concurrent_lookups_different_accounts(db, gencreds):
|
def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
||||||
num_threads = 100
|
num_threads = 50
|
||||||
req_per_thread = 5
|
req_per_thread = 5
|
||||||
results = queue.Queue()
|
results = queue.Queue()
|
||||||
|
|
||||||
@@ -68,7 +78,7 @@ def test_100_concurrent_lookups_different_accounts(db, gencreds):
|
|||||||
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, addr, password)
|
lookup_passdb(db, example_config, addr, password)
|
||||||
except Exception:
|
except Exception:
|
||||||
results.put(traceback.format_exc())
|
results.put(traceback.format_exc())
|
||||||
else:
|
else:
|
||||||
@@ -5,8 +5,6 @@ from chatmaild.filtermail import (
|
|||||||
check_mdn,
|
check_mdn,
|
||||||
)
|
)
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
@@ -17,8 +15,8 @@ def maildomain():
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def handler(create_ini, maildomain):
|
def handler(make_config, maildomain):
|
||||||
config = read_config(create_ini(), maildomain)
|
config = make_config(maildomain)
|
||||||
return BeforeQueueHandler(config)
|
return BeforeQueueHandler(config)
|
||||||
|
|
||||||
|
|
||||||
@@ -28,27 +26,36 @@ def test_reject_forged_from(maildata, gencreds, handler):
|
|||||||
rcpt_tos = [gencreds()[0]]
|
rcpt_tos = [gencreds()[0]]
|
||||||
|
|
||||||
# test that the filter lets good mail through
|
# test that the filter lets good mail through
|
||||||
env.content = maildata("plain.eml", from_addr=env.mail_from).as_bytes()
|
to_addr = gencreds()[0]
|
||||||
|
env.content = maildata(
|
||||||
|
"plain.eml", from_addr=env.mail_from, to_addr=to_addr
|
||||||
|
).as_bytes()
|
||||||
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
# test that the filter rejects forged mail
|
# test that the filter rejects forged mail
|
||||||
env.content = maildata("plain.eml", from_addr="forged@c3.testrun.org").as_bytes()
|
env.content = maildata(
|
||||||
|
"plain.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
||||||
|
).as_bytes()
|
||||||
error = handler.check_DATA(envelope=env)
|
error = handler.check_DATA(envelope=env)
|
||||||
assert "500" in error
|
assert "500" in error
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_no_encryption_detection(maildata):
|
def test_filtermail_no_encryption_detection(maildata):
|
||||||
msg = maildata("plain.eml")
|
msg = maildata(
|
||||||
|
"plain.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
|
)
|
||||||
assert not check_encrypted(msg)
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
# https://xkcd.com/1181/
|
# https://xkcd.com/1181/
|
||||||
msg = maildata("fake-encrypted.eml")
|
msg = maildata(
|
||||||
|
"fake-encrypted.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
|
)
|
||||||
assert not check_encrypted(msg)
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_encryption_detection(maildata):
|
def test_filtermail_encryption_detection(maildata):
|
||||||
msg = maildata("encrypted.eml")
|
msg = maildata("encrypted.eml", from_addr="1@example.org", to_addr="2@example.org")
|
||||||
assert check_encrypted(msg)
|
assert check_encrypted(msg)
|
||||||
|
|
||||||
# if the subject is not "..." it is not considered ac-encrypted
|
# if the subject is not "..." it is not considered ac-encrypted
|
||||||
@@ -101,9 +108,8 @@ def test_send_rate_limiter():
|
|||||||
def test_excempt_privacy(maildata, gencreds, handler):
|
def test_excempt_privacy(maildata, gencreds, handler):
|
||||||
from_addr = gencreds()[0]
|
from_addr = gencreds()[0]
|
||||||
to_addr = "privacy@testrun.org"
|
to_addr = "privacy@testrun.org"
|
||||||
false_to = "privacy@tstrn.org"
|
handler.config.passthrough_recipients = [to_addr]
|
||||||
false_to2 = "prvcy@testrun.org"
|
false_to = "privacy@something.org"
|
||||||
assert to_addr in handler.config.passthrough_recipients
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", from_addr, to_addr)
|
msg = maildata("plain.eml", from_addr, to_addr)
|
||||||
|
|
||||||
@@ -117,7 +123,23 @@ def test_excempt_privacy(maildata, gencreds, handler):
|
|||||||
|
|
||||||
class env2:
|
class env2:
|
||||||
mail_from = from_addr
|
mail_from = from_addr
|
||||||
rcpt_tos = [to_addr, false_to, false_to2]
|
rcpt_tos = [to_addr, false_to]
|
||||||
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)
|
||||||
16
chatmaild/src/chatmaild/tests/test_metrics.py
Normal file
16
chatmaild/src/chatmaild/tests/test_metrics.py
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
from chatmaild.metrics import main
|
||||||
|
|
||||||
|
|
||||||
|
def test_main(tmp_path, capsys):
|
||||||
|
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
||||||
|
tmp_path.joinpath(x).mkdir()
|
||||||
|
main(tmp_path)
|
||||||
|
out, _ = capsys.readouterr()
|
||||||
|
d = {}
|
||||||
|
for line in out.split("\n"):
|
||||||
|
if line.strip():
|
||||||
|
name, num, _ = line.split()
|
||||||
|
d[name] = int(num)
|
||||||
|
|
||||||
|
assert d["accounts"] == 4
|
||||||
|
assert d["ci_accounts"] == 3
|
||||||
@@ -4,26 +4,24 @@ 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():
|
def test_create_newemail_dict(example_config):
|
||||||
ac1 = create_newemail_dict(domain="example.org")
|
ac1 = create_newemail_dict(example_config)
|
||||||
assert "@" in ac1["email"]
|
assert "@" in ac1["email"]
|
||||||
assert len(ac1["password"]) >= 10
|
assert len(ac1["password"]) >= 10
|
||||||
|
|
||||||
ac2 = create_newemail_dict(domain="example.org")
|
ac2 = create_newemail_dict(example_config)
|
||||||
|
|
||||||
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):
|
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
||||||
p = tmpdir.join("mailname")
|
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
||||||
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"@{maildomain}")
|
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
||||||
assert len(dic["password"]) >= 10
|
assert len(dic["password"]) >= 10
|
||||||
BIN
chatmaild/src/chatmaild/tower-builder.xdc
Normal file
BIN
chatmaild/src/chatmaild/tower-builder.xdc
Normal file
Binary file not shown.
32
cmdeploy/pyproject.toml
Normal file
32
cmdeploy/pyproject.toml
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=68"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "cmdeploy"
|
||||||
|
version = "0.2"
|
||||||
|
dependencies = [
|
||||||
|
"pyinfra",
|
||||||
|
"pillow",
|
||||||
|
"qrcode",
|
||||||
|
"markdown",
|
||||||
|
"pytest",
|
||||||
|
"setuptools>=68",
|
||||||
|
"termcolor",
|
||||||
|
"build",
|
||||||
|
"tox",
|
||||||
|
"ruff",
|
||||||
|
"black",
|
||||||
|
"pytest",
|
||||||
|
"pytest-xdist",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
cmdeploy = "cmdeploy.cmdeploy:main"
|
||||||
|
|
||||||
|
[project.entry-points.pytest11]
|
||||||
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
"cmdeploy.testplugin" = "cmdeploy.tests.plugin"
|
||||||
|
|
||||||
|
[tool.pytest.ini_options]
|
||||||
|
addopts = "-v -ra --strict-markers"
|
||||||
@@ -14,8 +14,7 @@ from pyinfra.facts.files import File
|
|||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from .acmetool import deploy_acmetool
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
import chatmaild.filtermail
|
from chatmaild.config import read_config, Config
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def _build_chatmaild(dist_dir) -> None:
|
def _build_chatmaild(dist_dir) -> None:
|
||||||
@@ -85,14 +84,30 @@ 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",
|
||||||
|
"greeterbot",
|
||||||
):
|
):
|
||||||
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,
|
||||||
|
passdb_path="/home/vmail/passdb.sqlite",
|
||||||
)
|
)
|
||||||
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
||||||
content = source_path.read_text().format(**params).encode()
|
content = source_path.read_text().format(**params).encode()
|
||||||
@@ -113,71 +128,6 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|
||||||
"""Configures OpenDKIM"""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
|
||||||
dest="/etc/opendkim.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
files.directory(
|
|
||||||
name="Add opendkim directory to /etc",
|
|
||||||
path="/etc/opendkim",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="750",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
keytable = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/KeyTable"),
|
|
||||||
dest="/etc/dkimkeys/KeyTable",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
need_restart |= keytable.changed
|
|
||||||
|
|
||||||
signing_table = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("opendkim/SigningTable"),
|
|
||||||
dest="/etc/dkimkeys/SigningTable",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
need_restart |= signing_table.changed
|
|
||||||
|
|
||||||
files.directory(
|
|
||||||
name="Add opendkim socket directory to /var/spool/postfix",
|
|
||||||
path="/var/spool/postfix/opendkim",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="750",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
|
||||||
server.shell(
|
|
||||||
name="Generate OpenDKIM domain keys",
|
|
||||||
commands=[
|
|
||||||
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
|
||||||
],
|
|
||||||
_sudo=True,
|
|
||||||
_sudo_user="opendkim",
|
|
||||||
)
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def _install_mta_sts_daemon() -> bool:
|
def _install_mta_sts_daemon() -> bool:
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -196,7 +146,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 venv /usr/local/lib/postfix-mta-sts-resolver",
|
"python3 -m virtualenv /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",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
@@ -216,7 +166,7 @@ def _install_mta_sts_daemon() -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_postfix(config: chatmaild.config.Config, debug: bool = False) -> bool:
|
def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
||||||
"""Configures Postfix SMTP server."""
|
"""Configures Postfix SMTP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -241,10 +191,21 @@ def _configure_postfix(config: chatmaild.config.Config, debug: bool = False) ->
|
|||||||
)
|
)
|
||||||
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
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
||||||
"""Configures Dovecot IMAP server."""
|
"""Configures Dovecot IMAP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -254,7 +215,7 @@ def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config={"hostname": mail_server},
|
config=config,
|
||||||
debug=debug,
|
debug=debug,
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
@@ -267,14 +228,13 @@ def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= auth_config.changed
|
need_restart |= auth_config.changed
|
||||||
|
|
||||||
files.put(
|
files.template(
|
||||||
src=importlib.resources.files(__package__)
|
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
||||||
.joinpath("dovecot/expunge.cron")
|
|
||||||
.open("rb"),
|
|
||||||
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/
|
||||||
@@ -347,41 +307,157 @@ def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def remove_opendkim() -> None:
|
||||||
|
"""Remove OpenDKIM, deprecated"""
|
||||||
|
files.file(
|
||||||
|
name="Remove legacy opendkim.conf",
|
||||||
|
path="/etc/opendkim.conf",
|
||||||
|
present=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
files.directory(
|
||||||
|
name="Remove legacy opendkim socket directory from /var/spool/postfix",
|
||||||
|
path="/var/spool/postfix/opendkim",
|
||||||
|
present=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(name="Remove openDKIM", packages="opendkim", present=False)
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_rspamd(dkim_selector: str, mail_domain: str) -> bool:
|
||||||
|
"""Configures rspamd for Rate Limiting."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="apt install rspamd",
|
||||||
|
packages="rspamd",
|
||||||
|
)
|
||||||
|
|
||||||
|
for module in ["phishing", "rbl", "hfilter", "ratelimit"]:
|
||||||
|
disabled_module_conf = files.put(
|
||||||
|
name=f"disable {module} rspamd plugin",
|
||||||
|
src=importlib.resources.files(__package__).joinpath("rspamd/disabled.conf"),
|
||||||
|
dest=f"/etc/rspamd/local.d/{module}.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= disabled_module_conf.changed
|
||||||
|
|
||||||
|
options_inc = files.put(
|
||||||
|
name="disable fuzzy checks",
|
||||||
|
src=importlib.resources.files(__package__).joinpath("rspamd/options.inc"),
|
||||||
|
dest="/etc/rspamd/local.d/options.inc",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= options_inc.changed
|
||||||
|
|
||||||
|
# https://rspamd.com/doc/modules/force_actions.html
|
||||||
|
force_actions_conf = files.put(
|
||||||
|
name="Set up rules to reject on DKIM, SPF and DMARC fails",
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"rspamd/force_actions.conf"
|
||||||
|
),
|
||||||
|
dest="/etc/rspamd/local.d/force_actions.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= force_actions_conf.changed
|
||||||
|
|
||||||
|
dkim_directory = "/var/lib/rspamd/dkim/"
|
||||||
|
dkim_key_path = f"{dkim_directory}{mail_domain}.{dkim_selector}.key"
|
||||||
|
dkim_dns_file = f"{dkim_directory}{mail_domain}.{dkim_selector}.zone"
|
||||||
|
|
||||||
|
dkim_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"rspamd/dkim_signing.conf.j2"
|
||||||
|
),
|
||||||
|
dest="/etc/rspamd/local.d/dkim_signing.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={
|
||||||
|
"dkim_selector": str(dkim_selector),
|
||||||
|
"mail_domain": mail_domain,
|
||||||
|
"dkim_key_path": dkim_key_path,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
need_restart |= dkim_config.changed
|
||||||
|
|
||||||
|
files.directory(
|
||||||
|
name="ensure DKIM key directory exists",
|
||||||
|
path=dkim_directory,
|
||||||
|
present=True,
|
||||||
|
user="_rspamd",
|
||||||
|
group="_rspamd",
|
||||||
|
)
|
||||||
|
|
||||||
|
if not host.get_fact(File, dkim_key_path):
|
||||||
|
server.shell(
|
||||||
|
name="Generate DKIM domain keys with rspamd",
|
||||||
|
commands=[
|
||||||
|
f"rspamadm dkim_keygen -b 2048 -s {dkim_selector} -d {mail_domain} -k {dkim_key_path} > {dkim_dns_file}"
|
||||||
|
],
|
||||||
|
_sudo=True,
|
||||||
|
_sudo_user="_rspamd",
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def check_config(config):
|
def check_config(config):
|
||||||
mailname = config.mailname
|
mail_domain = config.mail_domain
|
||||||
if mailname != "testrun.org" and not mailname.endswith(".testrun.org"):
|
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
for value in config.__dict__.values():
|
for value in config.__dict__.values():
|
||||||
if any(x in value for x in blocked_words):
|
if any(x in str(value) for x in blocked_words):
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
)
|
)
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
def deploy_chatmail(config_path: Path) -> None:
|
||||||
"""Deploy a chat-mail instance.
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
:param mail_domain: domain part of your future email addresses
|
:param config_path: path to chatmail.ini
|
||||||
:param mail_server: the DNS name under which your mail server is reachable
|
|
||||||
:param dkim_selector:
|
|
||||||
"""
|
"""
|
||||||
|
config = read_config(config_path)
|
||||||
|
check_config(config)
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
|
||||||
from .www import build_webpages
|
from .www import build_webpages
|
||||||
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
|
||||||
server.group(name="Create opendkim group", group="opendkim", system=True)
|
# Run local DNS resolver `unbound`.
|
||||||
server.user(
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
name="Add postfix user to opendkim group for socket access",
|
# to use 127.0.0.1 as the resolver.
|
||||||
user="postfix",
|
apt.packages(
|
||||||
groups=["opendkim"],
|
name="Install unbound",
|
||||||
system=True,
|
packages=["unbound", "unbound-anchor", "dnsutils"],
|
||||||
|
)
|
||||||
|
server.shell(
|
||||||
|
name="Generate root keys for validating DNSSEC",
|
||||||
|
commands=["unbound-anchor -a /var/lib/unbound/root.key || true"],
|
||||||
|
)
|
||||||
|
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(nginx_hook=True, domains=[mail_server, f"mta-sts.{mail_server}"])
|
deploy_acmetool(
|
||||||
|
nginx_hook=True,
|
||||||
|
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
||||||
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Postfix",
|
name="Install Postfix",
|
||||||
@@ -393,14 +469,6 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install OpenDKIM",
|
|
||||||
packages=[
|
|
||||||
"opendkim",
|
|
||||||
"opendkim-tools",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install nginx",
|
name="Install nginx",
|
||||||
packages=["nginx"],
|
packages=["nginx"],
|
||||||
@@ -411,11 +479,7 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
packages=["fcgiwrap"],
|
packages=["fcgiwrap"],
|
||||||
)
|
)
|
||||||
|
|
||||||
pkg_root = importlib.resources.files(__package__)
|
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
||||||
chatmail_ini = pkg_root.joinpath("../../../chatmail.ini").resolve()
|
|
||||||
config = read_config(chatmail_ini, mailname=mail_domain)
|
|
||||||
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")
|
||||||
@@ -424,18 +488,20 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
|
|
||||||
_install_remote_venv_with_chatmaild(config)
|
_install_remote_venv_with_chatmaild(config)
|
||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
||||||
postfix_need_restart = _configure_postfix(config, debug=debug)
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
|
||||||
mta_sts_need_restart = _install_mta_sts_daemon()
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
nginx_need_restart = _configure_nginx(mail_domain)
|
nginx_need_restart = _configure_nginx(mail_domain)
|
||||||
|
|
||||||
|
remove_opendkim()
|
||||||
|
rspamd_need_restart = _configure_rspamd("dkim", mail_domain)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable OpenDKIM",
|
name="Start and enable rspamd",
|
||||||
service="opendkim.service",
|
service="rspamd.service",
|
||||||
running=True,
|
running=True,
|
||||||
enabled=True,
|
enabled=True,
|
||||||
restarted=opendkim_need_restart,
|
restarted=rspamd_need_restart,
|
||||||
)
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
from pyinfra.operations import apt, files, server
|
from pyinfra.operations import apt, files, systemd, server
|
||||||
|
from pyinfra import host
|
||||||
|
from pyinfra.facts.systemd import SystemdStatus
|
||||||
|
|
||||||
|
|
||||||
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
||||||
@@ -46,6 +48,30 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
service_file = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"acmetool-redirector.service"
|
||||||
|
),
|
||||||
|
dest="/etc/systemd/system/acmetool-redirector.service",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
if host.get_fact(SystemdStatus).get("nginx.service"):
|
||||||
|
systemd.service(
|
||||||
|
name="Stop nginx service to free port 80",
|
||||||
|
service="nginx",
|
||||||
|
running=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Setup acmetool-redirector service",
|
||||||
|
service="acmetool-redirector.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=service_file.changed,
|
||||||
|
)
|
||||||
|
|
||||||
server.shell(
|
server.shell(
|
||||||
name=f"Request certificate for: { ', '.join(domains) }",
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
commands=[f"acmetool want { ' '.join(domains)}"],
|
commands=[f"acmetool want { ' '.join(domains)}"],
|
||||||
11
cmdeploy/src/cmdeploy/acmetool/acmetool-redirector.service
Normal file
11
cmdeploy/src/cmdeploy/acmetool/acmetool-redirector.service
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=acmetool HTTP redirector
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=notify
|
||||||
|
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
15
cmdeploy/src/cmdeploy/chatmail.zone.f
Normal file
15
cmdeploy/src/cmdeploy/chatmail.zone.f
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{chatmail_domain}. A {ipv4}
|
||||||
|
{chatmail_domain}. AAAA {ipv6}
|
||||||
|
{chatmail_domain}. MX 10 {chatmail_domain}.
|
||||||
|
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
||||||
|
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
||||||
|
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
||||||
|
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
||||||
|
{chatmail_domain}. CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
||||||
|
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
||||||
|
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;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}.
|
||||||
|
_smtp._tls.{chatmail_domain}. TXT "v=TLSRPTv1;rua=mailto:{email}"
|
||||||
|
{dkim_entry}
|
||||||
314
cmdeploy/src/cmdeploy/cmdeploy.py
Normal file
314
cmdeploy/src/cmdeploy/cmdeploy.py
Normal file
@@ -0,0 +1,314 @@
|
|||||||
|
"""
|
||||||
|
Provides the `cmdeploy` entry point function,
|
||||||
|
along with command line option and subcommand parsing.
|
||||||
|
"""
|
||||||
|
import argparse
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
import importlib.resources
|
||||||
|
import importlib.util
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
from termcolor import colored
|
||||||
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
from cmdeploy.dns import show_dns, check_necessary_dns
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# cmdeploy sub commands and options
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
def init_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"chatmail_domain",
|
||||||
|
action="store",
|
||||||
|
help="fully qualified DNS domain name for your chatmail instance",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def init_cmd(args, out):
|
||||||
|
"""Initialize chatmail config file."""
|
||||||
|
mail_domain = args.chatmail_domain
|
||||||
|
if args.inipath.exists():
|
||||||
|
print(f"Path exists, not modifying: {args.inipath}")
|
||||||
|
else:
|
||||||
|
write_initial_config(args.inipath, mail_domain)
|
||||||
|
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
||||||
|
check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--dry-run",
|
||||||
|
dest="dry_run",
|
||||||
|
action="store_true",
|
||||||
|
help="don't actually modify the server",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd(args, out):
|
||||||
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
mail_domain = args.config.mail_domain
|
||||||
|
if not check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
):
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
env = os.environ.copy()
|
||||||
|
env["CHATMAIL_INI"] = args.inipath
|
||||||
|
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
||||||
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
|
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path}"
|
||||||
|
|
||||||
|
out.check_call(cmd, env=env)
|
||||||
|
print("Deploy completed, call `cmdeploy dns` next.")
|
||||||
|
|
||||||
|
|
||||||
|
def dns_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--zonefile",
|
||||||
|
dest="zonefile",
|
||||||
|
help="print the whole zonefile for deploying directly",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dns_cmd(args, out):
|
||||||
|
"""Generate dns zone file."""
|
||||||
|
show_dns(args, out)
|
||||||
|
|
||||||
|
|
||||||
|
def status_cmd(args, out):
|
||||||
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
|
ssh = f"ssh root@{args.config.mail_domain}"
|
||||||
|
|
||||||
|
out.green(f"chatmail domain: {args.config.mail_domain}")
|
||||||
|
if args.config.privacy_mail:
|
||||||
|
out.green("privacy settings: present")
|
||||||
|
else:
|
||||||
|
out.red("no privacy settings")
|
||||||
|
|
||||||
|
s1 = "systemctl --type=service --state=running"
|
||||||
|
for line in out.shell_output(f"{ssh} -- {s1}").split("\n"):
|
||||||
|
if line.startswith(" "):
|
||||||
|
print(line)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--slow",
|
||||||
|
dest="slow",
|
||||||
|
action="store_true",
|
||||||
|
help="also run slow tests",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cmd(args, out):
|
||||||
|
"""Run local and online tests for chatmail deployment.
|
||||||
|
|
||||||
|
This will automatically pip-install 'deltachat' if it's not available.
|
||||||
|
"""
|
||||||
|
|
||||||
|
x = importlib.util.find_spec("deltachat")
|
||||||
|
if x is None:
|
||||||
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
|
pytest_path = shutil.which("pytest")
|
||||||
|
pytest_args = [
|
||||||
|
pytest_path,
|
||||||
|
"cmdeploy/src/",
|
||||||
|
"-n4",
|
||||||
|
"-rs",
|
||||||
|
"-x",
|
||||||
|
"-vrx",
|
||||||
|
"--durations=5",
|
||||||
|
]
|
||||||
|
if args.slow:
|
||||||
|
pytest_args.append("--slow")
|
||||||
|
ret = out.run_ret(pytest_args)
|
||||||
|
return ret
|
||||||
|
|
||||||
|
|
||||||
|
def fmt_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--verbose",
|
||||||
|
"-v",
|
||||||
|
dest="verbose",
|
||||||
|
action="store_true",
|
||||||
|
help="provide information on invocations",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.add_argument(
|
||||||
|
"--check",
|
||||||
|
"-c",
|
||||||
|
action="store_true",
|
||||||
|
help="only check but don't fix problems",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def fmt_cmd(args, out):
|
||||||
|
"""Run formattting fixes (ruff and black) on all chatmail source code."""
|
||||||
|
|
||||||
|
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
||||||
|
black_args = [shutil.which("black")]
|
||||||
|
ruff_args = [shutil.which("ruff")]
|
||||||
|
|
||||||
|
if args.check:
|
||||||
|
black_args.append("--check")
|
||||||
|
else:
|
||||||
|
ruff_args.append("--fix")
|
||||||
|
|
||||||
|
if not args.verbose:
|
||||||
|
black_args.append("-q")
|
||||||
|
ruff_args.append("-q")
|
||||||
|
|
||||||
|
black_args.extend(sources)
|
||||||
|
ruff_args.extend(sources)
|
||||||
|
|
||||||
|
out.check_call(" ".join(black_args), quiet=not args.verbose)
|
||||||
|
out.check_call(" ".join(ruff_args), quiet=not args.verbose)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def bench_cmd(args, out):
|
||||||
|
"""Run benchmarks against an online chatmail instance."""
|
||||||
|
args = ["pytest", "--pyargs", "cmdeploy.tests.online.benchmark", "-vrx"]
|
||||||
|
cmdstring = " ".join(args)
|
||||||
|
out.green(f"[$ {cmdstring}]")
|
||||||
|
subprocess.check_call(args)
|
||||||
|
|
||||||
|
|
||||||
|
def webdev_cmd(args, out):
|
||||||
|
"""Run local web development loop for static web pages."""
|
||||||
|
from .www import main
|
||||||
|
|
||||||
|
main()
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Parsing command line options and starting commands
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
class Out:
|
||||||
|
"""Convenience output printer providing coloring."""
|
||||||
|
|
||||||
|
def red(self, msg, file=sys.stderr):
|
||||||
|
print(colored(msg, "red"), file=file)
|
||||||
|
|
||||||
|
def green(self, msg, file=sys.stderr):
|
||||||
|
print(colored(msg, "green"), file=file)
|
||||||
|
|
||||||
|
def __call__(self, msg, red=False, green=False, file=sys.stdout):
|
||||||
|
color = "red" if red else ("green" if green else None)
|
||||||
|
print(colored(msg, color), file=file)
|
||||||
|
|
||||||
|
def shell_output(self, arg, no_print=False, timeout=10):
|
||||||
|
if not no_print:
|
||||||
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
|
output = subprocess.STDOUT
|
||||||
|
else:
|
||||||
|
output = subprocess.DEVNULL
|
||||||
|
return subprocess.check_output(
|
||||||
|
arg, shell=True, timeout=timeout, stderr=output
|
||||||
|
).decode()
|
||||||
|
|
||||||
|
def check_call(self, arg, env=None, quiet=False):
|
||||||
|
if not quiet:
|
||||||
|
self(f"[$ {arg}]", file=sys.stderr)
|
||||||
|
return subprocess.check_call(arg, shell=True, env=env)
|
||||||
|
|
||||||
|
def run_ret(self, args, env=None, quiet=False):
|
||||||
|
if not quiet:
|
||||||
|
cmdstring = " ".join(args)
|
||||||
|
self(f"[$ {cmdstring}]", file=sys.stderr)
|
||||||
|
proc = subprocess.run(args, env=env)
|
||||||
|
return proc.returncode
|
||||||
|
|
||||||
|
|
||||||
|
def add_config_option(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--config",
|
||||||
|
dest="inipath",
|
||||||
|
action="store",
|
||||||
|
default=Path("chatmail.ini"),
|
||||||
|
type=Path,
|
||||||
|
help="path to the chatmail.ini file",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def add_subcommand(subparsers, func):
|
||||||
|
name = func.__name__
|
||||||
|
assert name.endswith("_cmd")
|
||||||
|
name = name[:-4]
|
||||||
|
doc = func.__doc__.strip()
|
||||||
|
help = doc.split("\n")[0].strip(".")
|
||||||
|
p = subparsers.add_parser(name, description=doc, help=help)
|
||||||
|
p.set_defaults(func=func)
|
||||||
|
add_config_option(p)
|
||||||
|
return p
|
||||||
|
|
||||||
|
|
||||||
|
description = """
|
||||||
|
Setup your chatmail server configuration and
|
||||||
|
deploy it via SSH to your remote location.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def get_parser():
|
||||||
|
"""Return an ArgumentParser for the 'cmdeploy' CLI"""
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser(description=description.strip())
|
||||||
|
subparsers = parser.add_subparsers(title="subcommands")
|
||||||
|
|
||||||
|
# find all subcommands in the module namespace
|
||||||
|
glob = globals()
|
||||||
|
for name, func in glob.items():
|
||||||
|
if name.endswith("_cmd"):
|
||||||
|
subparser = add_subcommand(subparsers, func)
|
||||||
|
addopts = glob.get(name + "_options")
|
||||||
|
if addopts is not None:
|
||||||
|
addopts(subparser)
|
||||||
|
|
||||||
|
return parser
|
||||||
|
|
||||||
|
|
||||||
|
def main(args=None):
|
||||||
|
"""Provide main entry point for 'xdcget' CLI invocation."""
|
||||||
|
parser = get_parser()
|
||||||
|
args = parser.parse_args(args=args)
|
||||||
|
if not hasattr(args, "func"):
|
||||||
|
return parser.parse_args(["-h"])
|
||||||
|
out = Out()
|
||||||
|
kwargs = {}
|
||||||
|
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
||||||
|
if not args.inipath.exists():
|
||||||
|
out.red(f"expecting {args.inipath} to exist, run init first?")
|
||||||
|
raise SystemExit(1)
|
||||||
|
try:
|
||||||
|
args.config = read_config(args.inipath)
|
||||||
|
except Exception as ex:
|
||||||
|
out.red(ex)
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
try:
|
||||||
|
res = args.func(args, out, **kwargs)
|
||||||
|
if res is None:
|
||||||
|
res = 0
|
||||||
|
return res
|
||||||
|
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
out.red("KeyboardInterrupt")
|
||||||
|
sys.exit(130)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
17
cmdeploy/src/cmdeploy/deploy.py
Normal file
17
cmdeploy/src/cmdeploy/deploy.py
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import os
|
||||||
|
import importlib.resources
|
||||||
|
import pyinfra
|
||||||
|
from cmdeploy import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
config_path = os.getenv(
|
||||||
|
"CHATMAIL_INI",
|
||||||
|
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
||||||
|
)
|
||||||
|
|
||||||
|
deploy_chatmail(config_path)
|
||||||
|
|
||||||
|
|
||||||
|
if pyinfra.is_cli:
|
||||||
|
main()
|
||||||
209
cmdeploy/src/cmdeploy/dns.py
Normal file
209
cmdeploy/src/cmdeploy/dns.py
Normal file
@@ -0,0 +1,209 @@
|
|||||||
|
import sys
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import importlib
|
||||||
|
import subprocess
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
|
||||||
|
class DNS:
|
||||||
|
def __init__(self, out, mail_domain):
|
||||||
|
self.session = requests.Session()
|
||||||
|
self.out = out
|
||||||
|
self.ssh = f"ssh root@{mail_domain} -- "
|
||||||
|
try:
|
||||||
|
self.shell(f"unbound-control flush_zone {mail_domain}")
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def shell(self, cmd):
|
||||||
|
try:
|
||||||
|
return self.out.shell_output(f"{self.ssh}{cmd}", no_print=True)
|
||||||
|
except (subprocess.CalledProcessError, subprocess.TimeoutExpired) as e:
|
||||||
|
if "exit status 255" in str(e) or "timed out" in str(e):
|
||||||
|
self.out.red(f"Error: can't reach the server with: {self.ssh[:-4]}")
|
||||||
|
sys.exit(1)
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
def get_ipv4(self):
|
||||||
|
cmd = "ip a | grep 'inet ' | grep 'scope global' | grep -oE '[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}' | head -1"
|
||||||
|
return self.shell(cmd).strip()
|
||||||
|
|
||||||
|
def get_ipv6(self):
|
||||||
|
cmd = "ip a | grep inet6 | grep 'scope global' | sed -e 's#/64 scope global##' | sed -e 's#inet6##'"
|
||||||
|
return self.shell(cmd).strip()
|
||||||
|
|
||||||
|
def get(self, typ: str, domain: str) -> str | None:
|
||||||
|
"""Get a DNS entry"""
|
||||||
|
dig_result = self.shell(f"dig -r -q {domain} -t {typ} +short")
|
||||||
|
line = dig_result.partition("\n")[0]
|
||||||
|
if line:
|
||||||
|
return line
|
||||||
|
|
||||||
|
def check_ptr_record(self, ip: str, mail_domain) -> bool:
|
||||||
|
"""Check the PTR record for an IPv4 or IPv6 address."""
|
||||||
|
result = self.shell(f"dig -r -x {ip} +short").rstrip()
|
||||||
|
return result == f"{mail_domain}."
|
||||||
|
|
||||||
|
|
||||||
|
def show_dns(args, out):
|
||||||
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
||||||
|
mail_domain = args.config.mail_domain
|
||||||
|
ssh = f"ssh root@{mail_domain}"
|
||||||
|
dns = DNS(out, mail_domain)
|
||||||
|
|
||||||
|
def read_dkim_entries(entry):
|
||||||
|
lines = []
|
||||||
|
for line in entry.split("\n"):
|
||||||
|
if line.startswith(";") or not line.strip():
|
||||||
|
continue
|
||||||
|
line = line.replace("\t", " ")
|
||||||
|
lines.append(line)
|
||||||
|
lines[0] = f"dkim._domainkey.{mail_domain}. IN TXT " + lines[0].strip(
|
||||||
|
"dkim._domainkey IN TXT "
|
||||||
|
)
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
print("Checking your DKIM keys and DNS entries...")
|
||||||
|
try:
|
||||||
|
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
||||||
|
except subprocess.CalledProcessError:
|
||||||
|
print("Please run `cmdeploy run` first.")
|
||||||
|
return
|
||||||
|
dkim_entry = read_dkim_entries(
|
||||||
|
out.shell_output(f"{ssh} -- cat /var/lib/rspamd/dkim/{mail_domain}.dkim.zone")
|
||||||
|
)
|
||||||
|
|
||||||
|
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,
|
||||||
|
email=f"root@{args.config.mail_domain}",
|
||||||
|
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
||||||
|
chatmail_domain=args.config.mail_domain,
|
||||||
|
dkim_entry=dkim_entry,
|
||||||
|
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
|
||||||
|
except TypeError:
|
||||||
|
pass
|
||||||
|
started_dkim_parsing = False
|
||||||
|
for line in zonefile.splitlines():
|
||||||
|
line = line.format(
|
||||||
|
acme_account_url=acme_account_url,
|
||||||
|
email=f"root@{args.config.mail_domain}",
|
||||||
|
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
||||||
|
chatmail_domain=args.config.mail_domain,
|
||||||
|
dkim_entry=dkim_entry,
|
||||||
|
ipv6=ipv6,
|
||||||
|
).strip()
|
||||||
|
for typ in ["A", "AAAA", "CNAME", "CAA"]:
|
||||||
|
if f" {typ} " in line:
|
||||||
|
domain, value = line.split(f" {typ} ")
|
||||||
|
current = dns.get(typ, domain.strip()[:-1])
|
||||||
|
if current != value.strip():
|
||||||
|
to_print.append(line)
|
||||||
|
if " MX " in line:
|
||||||
|
domain, typ, prio, value = line.split()
|
||||||
|
current = dns.get(typ, domain[:-1])
|
||||||
|
if not current:
|
||||||
|
to_print.append(line)
|
||||||
|
elif current.split()[1] != value:
|
||||||
|
print(line.replace(prio, str(int(current[0]) + 1)))
|
||||||
|
if " SRV " in line:
|
||||||
|
domain, typ, prio, weight, port, value = line.split()
|
||||||
|
current = dns.get("SRV", domain[:-1])
|
||||||
|
if current != f"{prio} {weight} {port} {value}":
|
||||||
|
to_print.append(line)
|
||||||
|
if " TXT " in line:
|
||||||
|
domain, value = line.split(" TXT ")
|
||||||
|
current = dns.get("TXT", domain.strip()[:-1])
|
||||||
|
if domain.startswith("_mta-sts."):
|
||||||
|
if current:
|
||||||
|
if current.split("id=")[0] == value.split("id=")[0]:
|
||||||
|
continue
|
||||||
|
if current != value:
|
||||||
|
to_print.append(line)
|
||||||
|
if " IN TXT ( " in line:
|
||||||
|
started_dkim_parsing = True
|
||||||
|
dkim_lines = [line]
|
||||||
|
if started_dkim_parsing and line.startswith('"'):
|
||||||
|
dkim_lines.append(" " + line)
|
||||||
|
domain, data = "\n".join(dkim_lines).split(" IN TXT ")
|
||||||
|
current = dns.get("TXT", domain.strip()[:-1])
|
||||||
|
if current:
|
||||||
|
current = "( %s" % (current.replace('" "', '"\n "'))
|
||||||
|
if current != data:
|
||||||
|
to_print.append(dkim_entry)
|
||||||
|
else:
|
||||||
|
to_print.append(dkim_entry)
|
||||||
|
|
||||||
|
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))
|
||||||
|
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)."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def check_necessary_dns(out, mail_domain):
|
||||||
|
"""Check whether $mail_domain and mta-sts.$mail_domain resolve."""
|
||||||
|
dns = DNS(out, mail_domain)
|
||||||
|
ipv4 = dns.get("A", mail_domain)
|
||||||
|
ipv6 = dns.get("AAAA", mail_domain)
|
||||||
|
mta_entry = dns.get("CNAME", "mta-sts." + mail_domain)
|
||||||
|
www_entry = dns.get("CNAME", "www." + mail_domain)
|
||||||
|
to_print = []
|
||||||
|
if not (ipv4 or ipv6):
|
||||||
|
to_print.append(f"\t{mail_domain}.\t\t\tA<your server's IPv4 address>")
|
||||||
|
if mta_entry != mail_domain + ".":
|
||||||
|
to_print.append(f"\tmta-sts.{mail_domain}.\tCNAME\t{mail_domain}.")
|
||||||
|
if www_entry != mail_domain + ".":
|
||||||
|
to_print.append(f"\twww.{mail_domain}.\tCNAME\t{mail_domain}.")
|
||||||
|
if to_print:
|
||||||
|
to_print.insert(
|
||||||
|
0,
|
||||||
|
"\nFor chatmail to work, you need to configure this at your DNS provider:\n",
|
||||||
|
)
|
||||||
|
for line in to_print:
|
||||||
|
print(line)
|
||||||
|
print()
|
||||||
|
else:
|
||||||
|
dns.out.green("\nAll necessary DNS entries seem to be set.")
|
||||||
|
return True
|
||||||
10
cmdeploy/src/cmdeploy/dovecot/auth.conf
Normal file
10
cmdeploy/src/cmdeploy/dovecot/auth.conf
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
uri = proxy:/run/dovecot/doveauth.socket:auth
|
||||||
|
iterate_disable = yes
|
||||||
|
default_pass_scheme = plain
|
||||||
|
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
||||||
|
# See <https://doc.dovecot.org/configuration_manual/config_file/config_variables/#modifiers>
|
||||||
|
# for documentation.
|
||||||
|
#
|
||||||
|
# We escape user-provided input and use double quote as a separator.
|
||||||
|
password_key = passdb/%Ew"%Eu
|
||||||
|
user_key = userdb/%Eu
|
||||||
@@ -86,7 +86,7 @@ plugin {
|
|||||||
plugin {
|
plugin {
|
||||||
# for now we define static quota-rules for all users
|
# for now we define static quota-rules for all users
|
||||||
quota = maildir:User quota
|
quota = maildir:User quota
|
||||||
quota_rule = *:storage=100M
|
quota_rule = *:storage={{ config.max_mailbox_size }}
|
||||||
quota_max_mail_size=30M
|
quota_max_mail_size=30M
|
||||||
quota_grace = 0
|
quota_grace = 0
|
||||||
# quota_over_flag_value = TRUE
|
# quota_over_flag_value = TRUE
|
||||||
@@ -137,8 +137,8 @@ service imap-login {
|
|||||||
}
|
}
|
||||||
|
|
||||||
ssl = required
|
ssl = required
|
||||||
ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain
|
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
ssl_key = </var/lib/acme/live/{{ config.hostname }}/privkey
|
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
ssl_min_protocol = TLSv1.2
|
ssl_min_protocol = TLSv1.2
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
10
cmdeploy/src/cmdeploy/dovecot/expunge.cron.j2
Normal file
10
cmdeploy/src/cmdeploy/dovecot/expunge.cron.j2
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
||||||
|
2 0 * * * dovecot find /home/vmail/mail/{{ config.mail_domain }}/*/cur -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# or in any IMAP subfolder
|
||||||
|
2 0 * * * dovecot find /home/vmail/mail/{{ config.mail_domain }}/*/.*/cur -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# even if they are unseen
|
||||||
|
2 0 * * * dovecot find /home/vmail/mail/{{ config.mail_domain }}/*/new -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
2 0 * * * dovecot find /home/vmail/mail/{{ config.mail_domain }}/*/.*/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 * * * dovecot find /home/vmail/mail/{{ config.mail_domain }}/*/tmp -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
2 0 * * * dovecot find /home/vmail/mail/{{ config.mail_domain }}/*/.*/tmp -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
1
cmdeploy/src/cmdeploy/metrics.cron.j2
Normal file
1
cmdeploy/src/cmdeploy/metrics.cron.j2
Normal file
@@ -0,0 +1 @@
|
|||||||
|
*/5 * * * * root {{ config.execpath }} /home/vmail/mail/{{ config.mail_domain }} >/var/www/html/metrics
|
||||||
@@ -41,15 +41,19 @@ http {
|
|||||||
try_files $uri $uri/ =404;
|
try_files $uri $uri/ =404;
|
||||||
}
|
}
|
||||||
|
|
||||||
# add cgi-bin support
|
location /metrics {
|
||||||
include /usr/share/doc/fcgiwrap/examples/nginx.conf;
|
default_type text/plain;
|
||||||
|
}
|
||||||
|
|
||||||
|
# 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;
|
# Redirect www. to non-www
|
||||||
}
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name www.{{ config.domain_name }};
|
||||||
|
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
myorigin = {{ config.mailname }}
|
myorigin = {{ config.mail_domain }}
|
||||||
|
|
||||||
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
||||||
biff = no
|
biff = no
|
||||||
@@ -11,13 +11,12 @@ append_dot_mydomain = no
|
|||||||
|
|
||||||
readme_directory = no
|
readme_directory = no
|
||||||
|
|
||||||
# See http://www.postfix.org/COMPATIBILITY_README.html -- default to 2 on
|
# See http://www.postfix.org/COMPATIBILITY_README.html
|
||||||
# fresh installs.
|
compatibility_level = 3.6
|
||||||
compatibility_level = 2
|
|
||||||
|
|
||||||
# TLS parameters
|
# TLS parameters
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mailname }}/fullchain
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mailname }}/privkey
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
smtpd_tls_security_level=may
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
@@ -26,7 +25,7 @@ smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
|||||||
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
myhostname = {{ config.mailname }}
|
myhostname = {{ config.mail_domain }}
|
||||||
alias_maps = hash:/etc/aliases
|
alias_maps = hash:/etc/aliases
|
||||||
alias_database = hash:/etc/aliases
|
alias_database = hash:/etc/aliases
|
||||||
|
|
||||||
@@ -45,7 +44,9 @@ inet_interfaces = all
|
|||||||
inet_protocols = all
|
inet_protocols = all
|
||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
virtual_mailbox_domains = {{ config.mailname }}
|
virtual_mailbox_domains = {{ config.mail_domain }}
|
||||||
|
|
||||||
smtpd_milters = unix:opendkim/opendkim.sock
|
smtpd_milters = inet:127.0.0.1:11332
|
||||||
non_smtpd_milters = $smtpd_milters
|
non_smtpd_milters = $smtpd_milters
|
||||||
|
|
||||||
|
header_checks = regexp:/etc/postfix/submission_header_cleanup
|
||||||
4
cmdeploy/src/cmdeploy/postfix/submission_header_cleanup
Normal file
4
cmdeploy/src/cmdeploy/postfix/submission_header_cleanup
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
/^Received:/ IGNORE
|
||||||
|
/^X-Originating-IP:/ IGNORE
|
||||||
|
/^X-Mailer:/ IGNORE
|
||||||
|
/^User-Agent:/ IGNORE
|
||||||
1
cmdeploy/src/cmdeploy/rspamd/disabled.conf
Normal file
1
cmdeploy/src/cmdeploy/rspamd/disabled.conf
Normal file
@@ -0,0 +1 @@
|
|||||||
|
enabled = false;
|
||||||
10
cmdeploy/src/cmdeploy/rspamd/dkim_signing.conf.j2
Normal file
10
cmdeploy/src/cmdeploy/rspamd/dkim_signing.conf.j2
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
selector = {{ config.dkim_selector }}
|
||||||
|
use_esld = false # don't cut c1.testrun.org down to testrun.org
|
||||||
|
domain = {
|
||||||
|
{{ config.mail_domain }} {
|
||||||
|
selectors [
|
||||||
|
selector = {{ config.dkim_selector }}
|
||||||
|
path = {{ config.dkim_key_path }}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
30
cmdeploy/src/cmdeploy/rspamd/force_actions.conf
Normal file
30
cmdeploy/src/cmdeploy/rspamd/force_actions.conf
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
rules {
|
||||||
|
REJECT_DKIM_SPF {
|
||||||
|
action = "reject";
|
||||||
|
# Reject if
|
||||||
|
# - R_DKIM_RJECT: DKIM reject inserted by `dkim` module.
|
||||||
|
# - R_DKIM_PERMFAIL: permanent failure inserted by `dkim` module e.g. no DKIM DNS record found.
|
||||||
|
# - No DKIM signing (R_DKIM_NA symbol inserted by `dkim` module)
|
||||||
|
#
|
||||||
|
# - SPF failure (R_SPF_FAIL)
|
||||||
|
# - SPF permanent failure, e.g. failed to resolve DNS record referenced from SPF (R_SPF_PERMFAIL)
|
||||||
|
#
|
||||||
|
# - DMARC policy failure (DMARC_POLICY_REJECT)
|
||||||
|
#
|
||||||
|
# Do not reject if:
|
||||||
|
# - R_DKIM_TEMPFAIL, it is a DNS resolution failure
|
||||||
|
# and we do not want to lose messages because of faulty network.
|
||||||
|
#
|
||||||
|
# - R_SPF_SOFTFAIL
|
||||||
|
# - R_SPF_NEUTRAL
|
||||||
|
# - R_SPF_DNSFAIL
|
||||||
|
# - R_SPF_NA
|
||||||
|
#
|
||||||
|
# - DMARC_DNSFAIL
|
||||||
|
# - DMARC_NA
|
||||||
|
# - DMARC_POLICY_SOFTFAIL
|
||||||
|
# - DMARC_POLICY_QUARANTINE
|
||||||
|
# - DMARC_BAD_POLICY
|
||||||
|
expression = "R_DKIM_REJECT | R_DKIM_PERMFAIL | R_DKIM_NA | R_SPF_FAIL | R_SPF_PERMFAIL | DMARC_POLICY_REJECT";
|
||||||
|
}
|
||||||
|
}
|
||||||
1
cmdeploy/src/cmdeploy/rspamd/options.inc
Normal file
1
cmdeploy/src/cmdeploy/rspamd/options.inc
Normal file
@@ -0,0 +1 @@
|
|||||||
|
filters = "dkim";
|
||||||
0
cmdeploy/src/cmdeploy/tests/__init__.py
Normal file
0
cmdeploy/src/cmdeploy/tests/__init__.py
Normal file
0
cmdeploy/src/cmdeploy/tests/online/__init__.py
Normal file
0
cmdeploy/src/cmdeploy/tests/online/__init__.py
Normal file
@@ -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 autoconfig_and_idle_ready():
|
def dc_autoconfig_and_idle_ready():
|
||||||
cmfactory.get_online_accounts(1)
|
cmfactory.get_online_accounts(1)
|
||||||
|
|
||||||
benchmark(autoconfig_and_idle_ready, 5)
|
benchmark(dc_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 ping_pong():
|
def dc_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(ping_pong, 5)
|
benchmark(dc_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 send_10_receive_10():
|
def dc_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(send_10_receive_10, 5)
|
benchmark(dc_send_10_receive_10, 5)
|
||||||
@@ -2,6 +2,16 @@ import pytest
|
|||||||
import threading
|
import threading
|
||||||
import queue
|
import queue
|
||||||
|
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
from cmdeploy.cmdeploy import main
|
||||||
|
|
||||||
|
|
||||||
|
def test_init(tmp_path, maildomain):
|
||||||
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
main(["init", "--config", str(inipath), maildomain])
|
||||||
|
config = read_config(inipath)
|
||||||
|
assert config.mail_domain == maildomain
|
||||||
|
|
||||||
|
|
||||||
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
|
||||||
"""Test a) that an initial login creates a user automatically
|
"""Test a) that an initial login creates a user automatically
|
||||||
25
cmdeploy/src/cmdeploy/tests/online/test_0_qr.py
Normal file
25
cmdeploy/src/cmdeploy/tests/online/test_0_qr.py
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
import requests
|
||||||
|
|
||||||
|
from cmdeploy.genqr import gen_qr_png_data
|
||||||
|
|
||||||
|
|
||||||
|
def test_gen_qr_png_data(maildomain):
|
||||||
|
data = gen_qr_png_data(maildomain)
|
||||||
|
assert data
|
||||||
|
|
||||||
|
|
||||||
|
def test_fastcgi_working(maildomain, chatmail_config):
|
||||||
|
url = f"https://{maildomain}/cgi-bin/newemail.py"
|
||||||
|
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}/cgi-bin/newemail.py"
|
||||||
|
for i in range(3):
|
||||||
|
account_id = rpc.add_account()
|
||||||
|
rpc.set_config_from_qr(account_id, url)
|
||||||
|
rpc.configure(account_id)
|
||||||
@@ -20,7 +20,7 @@ def test_use_two_chatmailservers(cmfactory, maildomain2):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("forgeaddr", ["internal", "someone@example.org"])
|
@pytest.mark.parametrize("forgeaddr", ["internal", "someone@example.org"])
|
||||||
def test_reject_forged_from(cmsetup, maildata, lp, forgeaddr):
|
def test_reject_forged_from(cmsetup, maildata, gencreds, lp, forgeaddr):
|
||||||
user1, user3 = cmsetup.gen_users(2)
|
user1, user3 = cmsetup.gen_users(2)
|
||||||
|
|
||||||
lp.sec("send encrypted message with forged from")
|
lp.sec("send encrypted message with forged from")
|
||||||
@@ -42,19 +42,29 @@ def test_reject_forged_from(cmsetup, maildata, lp, forgeaddr):
|
|||||||
assert "500" in str(e.value)
|
assert "500" in str(e.value)
|
||||||
|
|
||||||
|
|
||||||
|
@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="Spam message rejected"):
|
||||||
|
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):
|
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
||||||
"""Test that the per-account send-mail limit is exceeded."""
|
"""Test that the per-account send-mail limit is exceeded."""
|
||||||
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(100):
|
for i in range(chatmail_config.max_user_send_per_minute + 5):
|
||||||
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 < 60:
|
if i < chatmail_config.max_user_send_per_minute:
|
||||||
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
|
||||||
@@ -1,6 +1,10 @@
|
|||||||
import time
|
import time
|
||||||
|
import re
|
||||||
import random
|
import random
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
import requests
|
||||||
|
import ipaddress
|
||||||
|
|
||||||
|
|
||||||
class TestEndToEndDeltaChat:
|
class TestEndToEndDeltaChat:
|
||||||
@@ -20,14 +24,24 @@ 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):
|
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote, chatmail_config):
|
||||||
"""This is a very slow test as it needs to upload >100MB of mail data
|
"""This is a very slow test as it needs to upload >100MB of mail data
|
||||||
before quota is exceeded, and thus depends on the speed of the upload.
|
before quota is exceeded, and thus depends on the speed of the upload.
|
||||||
"""
|
"""
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
ac1, ac2 = cmfactory.get_online_accounts(2)
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
||||||
|
|
||||||
quota = 1024 * 1024 * 100
|
def parse_size_limit(limit: str) -> int:
|
||||||
|
"""Parse a size limit and return the number of bytes as integer.
|
||||||
|
|
||||||
|
Example input: 100M, 2.4T, 500 K
|
||||||
|
"""
|
||||||
|
units = {"B": 1, "K": 2**10, "M": 2**20, "G": 2**30, "T": 2**40}
|
||||||
|
size = re.sub(r"([KMGT])", r" \1", limit.upper())
|
||||||
|
number, unit = [string.strip() for string in size.split()]
|
||||||
|
return int(float(number) * units[unit])
|
||||||
|
|
||||||
|
quota = parse_size_limit(chatmail_config.max_mailbox_size)
|
||||||
attachsize = 1 * 1024 * 1024
|
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")
|
||||||
@@ -91,9 +105,9 @@ 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()
|
||||||
ac2.qr_setup_contact(qr)
|
ch = ac2.qr_setup_contact(qr)
|
||||||
msg = ac2.wait_next_incoming_message()
|
assert ch.id >= 10
|
||||||
assert "verified" in msg.text
|
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
||||||
|
|
||||||
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)
|
||||||
@@ -108,3 +122,17 @@ class TestEndToEndDeltaChat:
|
|||||||
for msg in msgs:
|
for msg in msgs:
|
||||||
assert "error" not in m.get_message_info()
|
assert "error" not in m.get_message_info()
|
||||||
time.sleep(1)
|
time.sleep(1)
|
||||||
|
|
||||||
|
|
||||||
|
def test_hide_senders_ip_address(cmfactory):
|
||||||
|
public_ip = requests.get("http://icanhazip.com").content.decode().strip()
|
||||||
|
assert ipaddress.ip_address(public_ip)
|
||||||
|
|
||||||
|
user1, user2 = cmfactory.get_online_accounts(2)
|
||||||
|
chat = cmfactory.get_accepted_chat(user1, user2)
|
||||||
|
|
||||||
|
chat.send_text("testing submission header cleanup")
|
||||||
|
user2.wait_next_incoming_message()
|
||||||
|
user2.direct_imap.select_folder("Inbox")
|
||||||
|
msg = user2.direct_imap.get_all_messages()[0]
|
||||||
|
assert public_ip not in msg.obj.as_string()
|
||||||
@@ -3,17 +3,14 @@ import io
|
|||||||
import time
|
import time
|
||||||
import random
|
import random
|
||||||
import subprocess
|
import subprocess
|
||||||
import textwrap
|
|
||||||
import imaplib
|
import imaplib
|
||||||
import smtplib
|
import smtplib
|
||||||
import importlib.resources
|
|
||||||
import itertools
|
import itertools
|
||||||
from email.parser import BytesParser
|
|
||||||
from email import policy
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from chatmaild.database import Database
|
from chatmaild.database import Database
|
||||||
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
conftestdir = Path(__file__).parent
|
conftestdir = Path(__file__).parent
|
||||||
@@ -40,19 +37,22 @@ def pytest_runtest_setup(item):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def inipath():
|
def chatmail_config(pytestconfig):
|
||||||
dpath = importlib.resources.files("chatmaild")
|
current = basedir = Path().resolve()
|
||||||
inipath = dpath.joinpath("../../../chatmail.ini").resolve()
|
while 1:
|
||||||
assert inipath.exists()
|
path = current.joinpath("chatmail.ini").resolve()
|
||||||
return inipath
|
if path.exists():
|
||||||
|
return read_config(path)
|
||||||
|
if current == current.parent:
|
||||||
|
break
|
||||||
|
current = current.parent
|
||||||
|
|
||||||
|
pytest.skip(f"no chatmail.ini file found in {basedir} or parent dirs")
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain():
|
def maildomain(chatmail_config):
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN")
|
return chatmail_config.mail_domain
|
||||||
if not domain:
|
|
||||||
pytest.skip("set CHATMAIL_DOMAIN to a ssh-reachable chatmail instance")
|
|
||||||
return domain
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -228,18 +228,25 @@ def imap_or_smtp(request):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def gencreds(maildomain):
|
def gencreds(chatmail_config):
|
||||||
count = itertools.count()
|
count = itertools.count()
|
||||||
next(count)
|
next(count)
|
||||||
|
|
||||||
def gen(domain=None):
|
def gen(domain=None):
|
||||||
domain = domain if domain else maildomain
|
domain = domain if domain else chatmail_config.mail_domain
|
||||||
while 1:
|
while 1:
|
||||||
num = next(count)
|
num = next(count)
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
||||||
user = "".join(random.choices(alphanumeric, k=10))
|
user = "".join(
|
||||||
user = f"ac{num}_{user}"[:9]
|
random.choices(alphanumeric, k=chatmail_config.username_max_length)
|
||||||
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))
|
||||||
@@ -350,22 +357,6 @@ def lp(request):
|
|||||||
return LP()
|
return LP()
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildata(request, gencreds):
|
|
||||||
datadir = conftestdir.joinpath("mail-data")
|
|
||||||
|
|
||||||
def maildata(name, from_addr=None, to_addr=None):
|
|
||||||
if from_addr is None:
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
if to_addr is None:
|
|
||||||
to_addr = gencreds()[0]
|
|
||||||
data = datadir.joinpath(name).read_text()
|
|
||||||
text = data.format(from_addr=from_addr, to_addr=to_addr)
|
|
||||||
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
|
||||||
|
|
||||||
return maildata
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def cmsetup(maildomain, gencreds):
|
def cmsetup(maildomain, gencreds):
|
||||||
return CMSetup(maildomain, gencreds)
|
return CMSetup(maildomain, gencreds)
|
||||||
@@ -412,16 +403,3 @@ class CMUser:
|
|||||||
imap.login(self.addr, self.password)
|
imap.login(self.addr, self.password)
|
||||||
self._imap = imap
|
self._imap = imap
|
||||||
return self._imap
|
return self._imap
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def create_ini(tmp_path, inipath):
|
|
||||||
def create_ini_func(source=None):
|
|
||||||
if source is None:
|
|
||||||
source = inipath.read_text()
|
|
||||||
p = tmp_path.joinpath("chatmail.ini")
|
|
||||||
assert not p.exists(), p
|
|
||||||
p.write_text(textwrap.dedent(source))
|
|
||||||
return p
|
|
||||||
|
|
||||||
return create_ini_func
|
|
||||||
27
cmdeploy/src/cmdeploy/tests/test_cmdeploy.py
Normal file
27
cmdeploy/src/cmdeploy/tests/test_cmdeploy.py
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from cmdeploy.cmdeploy import get_parser, main
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _chdir(tmp_path):
|
||||||
|
old = os.getcwd()
|
||||||
|
os.chdir(tmp_path)
|
||||||
|
yield
|
||||||
|
os.chdir(old)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCmdline:
|
||||||
|
def test_parser(self, capsys):
|
||||||
|
parser = get_parser()
|
||||||
|
parser.parse_args([])
|
||||||
|
init = parser.parse_args(["init", "chat.example.org"])
|
||||||
|
run = parser.parse_args(["run"])
|
||||||
|
assert init and run
|
||||||
|
|
||||||
|
@pytest.mark.xfail(reason="init doesn't exit anymore, check for CLI output instead")
|
||||||
|
def test_init_not_overwrite(self):
|
||||||
|
main(["init", "chat.example.org"])
|
||||||
|
with pytest.raises(SystemExit):
|
||||||
|
main(["init", "chat.example.org"])
|
||||||
13
cmdeploy/src/cmdeploy/tests/test_helpers.py
Normal file
13
cmdeploy/src/cmdeploy/tests/test_helpers.py
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
import importlib.resources
|
||||||
|
|
||||||
|
from cmdeploy.www import build_webpages
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_webpages(tmp_path, make_config):
|
||||||
|
pkgroot = importlib.resources.files("cmdeploy")
|
||||||
|
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
||||||
|
assert src_dir.exists(), src_dir
|
||||||
|
config = make_config("chat.example.org")
|
||||||
|
build_dir = tmp_path.joinpath("build")
|
||||||
|
build_webpages(src_dir, build_dir, config)
|
||||||
|
assert len([x for x in build_dir.iterdir() if x.suffix == ".html"]) >= 3
|
||||||
@@ -36,8 +36,32 @@ 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.mailname
|
mail_domain = config.mail_domain
|
||||||
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()
|
||||||
@@ -48,6 +72,15 @@ 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
|
||||||
@@ -66,12 +99,12 @@ def _build_webpages(src_dir, build_dir, config):
|
|||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
chatmail_domain = "example.testrun.org"
|
|
||||||
path = importlib.resources.files(__package__)
|
path = importlib.resources.files(__package__)
|
||||||
reporoot = path.joinpath("../../../").resolve()
|
reporoot = path.joinpath("../../../").resolve()
|
||||||
inipath = reporoot.joinpath("chatmail.ini")
|
inipath = reporoot.joinpath("chatmail.ini")
|
||||||
config = read_config(inipath, mailname=chatmail_domain)
|
config = read_config(inipath)
|
||||||
config["webdev"] = True
|
config.webdev = True
|
||||||
|
assert config.mail_domain
|
||||||
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,33 +0,0 @@
|
|||||||
[build-system]
|
|
||||||
requires = ["setuptools>=45"]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "deploy-chatmail"
|
|
||||||
version = "0.1"
|
|
||||||
dependencies = [
|
|
||||||
"pyinfra",
|
|
||||||
"pillow",
|
|
||||||
"qrcode",
|
|
||||||
"markdown",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
|
||||||
addopts = "-v -ra --strict-markers"
|
|
||||||
|
|
||||||
[tool.tox]
|
|
||||||
legacy_tox_ini = """
|
|
||||||
[tox]
|
|
||||||
isolated_build = true
|
|
||||||
envlist = lint
|
|
||||||
|
|
||||||
[testenv:lint]
|
|
||||||
skipdist = True
|
|
||||||
skip_install = True
|
|
||||||
deps =
|
|
||||||
ruff
|
|
||||||
black
|
|
||||||
commands =
|
|
||||||
black --quiet --check --diff src/
|
|
||||||
ruff src/
|
|
||||||
"""
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
import os
|
|
||||||
import pyinfra
|
|
||||||
from deploy_chatmail import deploy_chatmail
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
mail_domain = os.getenv("CHATMAIL_DOMAIN")
|
|
||||||
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
|
|
||||||
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "dkim")
|
|
||||||
|
|
||||||
assert mail_domain
|
|
||||||
assert mail_server
|
|
||||||
assert dkim_selector
|
|
||||||
|
|
||||||
deploy_chatmail(mail_domain, mail_server, dkim_selector)
|
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
|
||||||
main()
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
uri = proxy:/run/dovecot/doveauth.socket:auth
|
|
||||||
iterate_disable = yes
|
|
||||||
default_pass_scheme = plain
|
|
||||||
password_key = passdb/%w/%u
|
|
||||||
user_key = userdb/%u
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d INBOX
|
|
||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d Deltachat
|
|
||||||
2 0 * * * dovecot doveadm expunge -A SEEN BEFORE 40d Trash
|
|
||||||
2 30 * * * dovecot doveadm purge -A
|
|
||||||
65
plan.txt
65
plan.txt
@@ -1,65 +0,0 @@
|
|||||||
# Chat-mail server development (up until Oct 18th)
|
|
||||||
|
|
||||||
## Dovecot goals/steps
|
|
||||||
|
|
||||||
- automatic expiry of messages older than M days
|
|
||||||
- also expunge unread messages
|
|
||||||
|
|
||||||
- limit: configure max-connections per account
|
|
||||||
|
|
||||||
|
|
||||||
## nami: send out rate limit / rspamd
|
|
||||||
|
|
||||||
- basic outgoing send rate/limits (depending on "account-rating")
|
|
||||||
use rspamd in a minimal way, check support dkim-signing
|
|
||||||
(including an online test exceeding rate limit)
|
|
||||||
|
|
||||||
|
|
||||||
## doveauth questions/futures
|
|
||||||
|
|
||||||
- bcrypt-password scheme is slow: require long passwords, use faster hashing
|
|
||||||
|
|
||||||
- define user-name and password policies, and implement them
|
|
||||||
(be very restrictive at the beginning, we can relax later)
|
|
||||||
|
|
||||||
- password is part of the dictproxy-lookup key, is it safe to use auth-caching?
|
|
||||||
|
|
||||||
|
|
||||||
## How to limit creation of accounts?
|
|
||||||
|
|
||||||
attack: a 3-line bash script to fill the chatmail db with millions of unused accouts
|
|
||||||
|
|
||||||
- make it computationally expensive (somehow try to except our tests from it)
|
|
||||||
1st pass instant onboarding: create userid + cheap password -- if it fails then
|
|
||||||
2nd pass instant onboarding: create userdid + comput. expensive password
|
|
||||||
|
|
||||||
- probably also do firewall: limit number of new tcp-connections per IP address per duration
|
|
||||||
|
|
||||||
|
|
||||||
## Open/deferred questions
|
|
||||||
|
|
||||||
- automatic expiry of users that haven't logged in for N days
|
|
||||||
Is it neccessary? If all messages are gone, does the existence of
|
|
||||||
an e-mail address bother anybody?
|
|
||||||
|
|
||||||
|
|
||||||
## web page for chat-mail servers?
|
|
||||||
|
|
||||||
- documentation for users, privacy policy etc.
|
|
||||||
(probably also with provider-messages ...)
|
|
||||||
|
|
||||||
|
|
||||||
## online tests (first with plain python/pytest)
|
|
||||||
|
|
||||||
- write tests for dovecot login (exists)
|
|
||||||
- write tests for postfix logins (exists)
|
|
||||||
- write A<>B send/receive tests (exists)
|
|
||||||
|
|
||||||
|
|
||||||
## Delta Chat
|
|
||||||
|
|
||||||
1. qr code that defines access to a chatmail instance (like mailadm but without http etc.)
|
|
||||||
|
|
||||||
2. support for creating username/password and verifying login works
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
set -e
|
|
||||||
|
|
||||||
venv/bin/pytest tests/online/benchmark.py -vrx
|
|
||||||
6
scripts/cmdeploy
Executable file
6
scripts/cmdeploy
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Wrapper for cmdelpoy to run it in activated virtualenv.
|
||||||
|
set -e
|
||||||
|
. venv/bin/activate
|
||||||
|
cmdeploy "$@"
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
echo -----------------------------------------
|
|
||||||
echo deploying to $CHATMAIL_DOMAIN
|
|
||||||
echo -----------------------------------------
|
|
||||||
|
|
||||||
venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" \
|
|
||||||
deploy-chatmail/src/deploy_chatmail/deploy.py
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
|
||||||
: ${CHATMAIL_SSH:=$CHATMAIL_DOMAIN}
|
|
||||||
|
|
||||||
set -e
|
|
||||||
SSH="ssh root@$CHATMAIL_SSH"
|
|
||||||
EMAIL="root@$CHATMAIL_DOMAIN"
|
|
||||||
ACME_ACCOUNT_URL="$($SSH -- acmetool account-url)"
|
|
||||||
|
|
||||||
cat <<EOF
|
|
||||||
$CHATMAIL_DOMAIN. MX 10 $CHATMAIL_DOMAIN.
|
|
||||||
$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"
|
|
||||||
_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"
|
|
||||||
_mta-sts.$CHATMAIL_DOMAIN. IN TXT "v=STSv1; id=$(date -u '+%Y%m%d%H%M')"
|
|
||||||
mta-sts.$CHATMAIL_DOMAIN. IN CNAME $CHATMAIL_DOMAIN.
|
|
||||||
_smtp._tls.$CHATMAIL_DOMAIN. IN TXT "v=TLSRPTv1;rua=mailto:$EMAIL"
|
|
||||||
EOF
|
|
||||||
$SSH opendkim-genzone -F | sed 's/^;.*$//;/^$/d'
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
import os
|
|
||||||
import time
|
|
||||||
import imaplib
|
|
||||||
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN", "c3.testrun.org")
|
|
||||||
|
|
||||||
print("connecting")
|
|
||||||
conn = imaplib.IMAP4_SSL(domain)
|
|
||||||
print("logging in")
|
|
||||||
conn.login(f"imapcapa", "pass")
|
|
||||||
status, res = conn.capability()
|
|
||||||
for capa in sorted(res[0].decode().split()):
|
|
||||||
print(capa)
|
|
||||||
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
set -e
|
|
||||||
python3 -m venv venv
|
|
||||||
pip=venv/bin/pip
|
|
||||||
|
|
||||||
$pip install pyinfra pytest build 'setuptools>=68' tox
|
|
||||||
$pip install -e deploy-chatmail
|
|
||||||
$pip install -e chatmaild
|
|
||||||
6
scripts/initenv.sh
Executable file
6
scripts/initenv.sh
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
python3 -m venv venv
|
||||||
|
|
||||||
|
venv/bin/pip install -e chatmaild
|
||||||
|
venv/bin/pip install -e cmdeploy
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
import os
|
|
||||||
import time
|
|
||||||
import imaplib
|
|
||||||
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN", "c3.testrun.org")
|
|
||||||
|
|
||||||
NUM_CONNECTIONS=10
|
|
||||||
|
|
||||||
conns = []
|
|
||||||
|
|
||||||
start = time.time()
|
|
||||||
for i in range(NUM_CONNECTIONS):
|
|
||||||
print(f"opening connection {i} to {domain}")
|
|
||||||
conn = imaplib.IMAP4_SSL(domain)
|
|
||||||
conns.append(conn)
|
|
||||||
|
|
||||||
tlsdone = time.time()
|
|
||||||
duration = tlsdone-start
|
|
||||||
print(f"{duration}: TLS connections opening TLS connections")
|
|
||||||
|
|
||||||
for i, conn in enumerate(conns):
|
|
||||||
print(f"logging into connection {i}")
|
|
||||||
conn.login(f"measure{i}", "pass")
|
|
||||||
|
|
||||||
logindone = time.time()
|
|
||||||
duration = logindone - tlsdone
|
|
||||||
print(f"{duration}: LOGINS done")
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
set -e
|
|
||||||
|
|
||||||
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
|
||||||
: ${CHATMAIL_SSH:=$CHATMAIL_DOMAIN}
|
|
||||||
|
|
||||||
rsync -avz . "root@$CHATMAIL_SSH:/root/chatmail" --exclude='/.git' --filter="dir-merge,- .gitignore"
|
|
||||||
ssh "root@$CHATMAIL_SSH" "cd /root/chatmail; apt install -y python3-venv; python3 -m venv venv; venv/bin/pip install pyinfra build; venv/bin/python3 -m build -n --sdist chatmaild --outdir dist; venv/bin/pip install -e ./deploy-chatmail -e ./chatmaild; export CHATMAIL_DOMAIN=$CHATMAIL_DOMAIN; venv/bin/pyinfra @local deploy.py"
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
venv/bin/tox -c chatmaild
|
|
||||||
venv/bin/tox -c deploy-chatmail
|
|
||||||
venv/bin/pytest tests/online -rs -vrx --durations=5 $@
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
echo -----------------------------------------
|
|
||||||
echo starting local webdev
|
|
||||||
echo -----------------------------------------
|
|
||||||
|
|
||||||
venv/bin/python3 -m deploy_chatmail.www
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
from chatmaild.config import read_config
|
|
||||||
import chatmaild.config
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_without_mailname(tmp_path, create_ini, monkeypatch):
|
|
||||||
mailname_path = tmp_path.joinpath("mailname")
|
|
||||||
mailname_path.write_text("something.example.org")
|
|
||||||
monkeypatch.setattr(chatmaild.config, "system_mailname_path", mailname_path)
|
|
||||||
|
|
||||||
inipath = create_ini(
|
|
||||||
"""
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 40
|
|
||||||
filtermail_smtp_port = 9875
|
|
||||||
postfix_reinject_port = 9999
|
|
||||||
passthrough_recipients =
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
config = read_config(inipath)
|
|
||||||
assert config.mailname == "something.example.org"
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_without_privacy_policy(tmp_path, create_ini):
|
|
||||||
inipath = create_ini(
|
|
||||||
"""
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 40
|
|
||||||
filtermail_smtp_port = 9875
|
|
||||||
postfix_reinject_port = 9999
|
|
||||||
passthrough_recipients =
|
|
||||||
|
|
||||||
[privacy:testrun]
|
|
||||||
domain = *.example.org
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
config = read_config(inipath, "something.example.org")
|
|
||||||
assert config.mailname == "something.example.org"
|
|
||||||
assert config.max_user_send_per_minute == 40
|
|
||||||
assert config.filtermail_smtp_port == 9875
|
|
||||||
assert config.postfix_reinject_port == 9999
|
|
||||||
assert config.passthrough_recipients == []
|
|
||||||
assert not config.privacy_postal
|
|
||||||
assert not config.privacy_mail
|
|
||||||
assert not config.privacy_pdo
|
|
||||||
assert not config.privacy_supervisor
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config(create_ini):
|
|
||||||
inipath = create_ini(
|
|
||||||
"""
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 40
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
passthrough_recipients = x@example.org y@example.org
|
|
||||||
|
|
||||||
[privacy:testrun]
|
|
||||||
domain = *.testrun.org
|
|
||||||
|
|
||||||
privacy_postal =
|
|
||||||
Postal Ltd
|
|
||||||
|
|
||||||
privacy_mail = privacy@merlinux.eu
|
|
||||||
|
|
||||||
privacy_pdo =
|
|
||||||
Postal PDO
|
|
||||||
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
|
||||||
|
|
||||||
privacy_supervisor =
|
|
||||||
line1
|
|
||||||
line2 with space
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
|
|
||||||
config = read_config(inipath, "something.testrun.org")
|
|
||||||
|
|
||||||
assert config.mailname == "something.testrun.org"
|
|
||||||
assert config.filtermail_smtp_port == 10080
|
|
||||||
assert config.postfix_reinject_port == 10025
|
|
||||||
assert config.passthrough_recipients == ["x@example.org", "y@example.org"]
|
|
||||||
assert config.privacy_postal == "Postal Ltd"
|
|
||||||
assert config.privacy_mail == "privacy@merlinux.eu"
|
|
||||||
lines = config.privacy_pdo.split("\n")
|
|
||||||
assert lines[0] == "Postal PDO"
|
|
||||||
assert lines[1].startswith("You can ")
|
|
||||||
lines = config.privacy_supervisor.split("\n")
|
|
||||||
assert lines[0] == "line1"
|
|
||||||
assert lines[1] == "line2 with space"
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
from deploy_chatmail.genqr import gen_qr_png_data
|
|
||||||
|
|
||||||
|
|
||||||
def test_gen_qr_png_data(maildomain):
|
|
||||||
data = gen_qr_png_data(maildomain)
|
|
||||||
assert data
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
import textwrap
|
|
||||||
import importlib.resources
|
|
||||||
|
|
||||||
from deploy_chatmail.www import build_webpages
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def make_config(create_ini, domain="example.org"):
|
|
||||||
inipath = create_ini(
|
|
||||||
textwrap.dedent(
|
|
||||||
f"""\
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 60
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
passthrough_recipients =
|
|
||||||
|
|
||||||
[privacy:{domain}]
|
|
||||||
domain = example.org
|
|
||||||
privacy_postal =
|
|
||||||
address-line1
|
|
||||||
address-line2
|
|
||||||
|
|
||||||
privacy_mail = privacy@{domain}
|
|
||||||
|
|
||||||
privacy_pdo =
|
|
||||||
address-line3
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
)
|
|
||||||
return read_config(inipath, domain)
|
|
||||||
|
|
||||||
|
|
||||||
def test_build_webpages(tmp_path, create_ini):
|
|
||||||
pkgroot = importlib.resources.files("deploy_chatmail")
|
|
||||||
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
|
||||||
assert src_dir.exists(), src_dir
|
|
||||||
config = make_config(create_ini, "example.org")
|
|
||||||
build_dir = tmp_path.joinpath("build")
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_get_settings(tmp_path, create_ini):
|
|
||||||
config = make_config(create_ini, "example.org")
|
|
||||||
assert config.privacy_postal == "address-line1\naddress-line2"
|
|
||||||
assert config.privacy_mail == "privacy@example.org"
|
|
||||||
assert config.privacy_pdo == "address-line3"
|
|
||||||
assert config.mailname == "example.org"
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user