mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 16:34:39 +00:00
Compare commits
146 Commits
fix-101
...
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 |
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.
|
||||||
5
.github/workflows/ci.yaml
vendored
5
.github/workflows/ci.yaml
vendored
@@ -31,10 +31,7 @@ jobs:
|
|||||||
run: cmdeploy fmt -v
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
- name: run deploy-chatmail offline tests
|
||||||
run: pytest tests
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
- name: initialize with chatmail domain
|
|
||||||
run: cmdeploy init chat.example.org
|
|
||||||
|
|
||||||
# all other cmdeploy commands require a staging server
|
# all other cmdeploy commands require a staging server
|
||||||
# see https://github.com/deltachat/chatmail/issues/100
|
# see https://github.com/deltachat/chatmail/issues/100
|
||||||
|
|||||||
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.
|
||||||
208
README.md
208
README.md
@@ -15,146 +15,148 @@ after which the initially specified password is required for using them.
|
|||||||
|
|
||||||
## Deploying your own chatmail server
|
## Deploying your own chatmail server
|
||||||
|
|
||||||
We subsequently use `CHATMAIL_DOMAIN` as a placeholder for your fully qualified
|
We use `chat.example.org` as the chatmail domain in the following steps.
|
||||||
DNS domain name (FQDN), for example `chat.example.org`.
|
Please substitute it with your own domain.
|
||||||
|
|
||||||
1. Setup DNS `A` and `AAAA` records for your `CHATMAIL_DOMAIN`.
|
1. Install the `cmdeploy` command in a virtualenv
|
||||||
Verify that DNS is set and SSH root login works:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
ssh root@CHATMAIL_DOMAIN
|
git clone https://github.com/deltachat/chatmail
|
||||||
|
cd chatmail
|
||||||
|
scripts/initenv.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install the `cmdeploy` command in a virtualenv
|
2. Create chatmail configuration file `chatmail.ini`:
|
||||||
|
|
||||||
```
|
```
|
||||||
source scripts/initenv.sh
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Create chatmail configuration file `chatmail.ini`:
|
3. Setup first DNS records for your chatmail domain,
|
||||||
|
according to the hints provided by `cmdeploy init`.
|
||||||
|
Verify that SSH root login works:
|
||||||
|
|
||||||
```
|
```
|
||||||
cmdeploy init CHATMAIL_DOMAIN
|
ssh root@chat.example.org # <-- use your domain
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Deploy to the remote chatmail server:
|
4. Deploy to the remote chatmail server:
|
||||||
|
|
||||||
```
|
```
|
||||||
cmdeploy run
|
scripts/cmdeploy run
|
||||||
```
|
```
|
||||||
|
This script will also show you additional DNS records
|
||||||
|
which you should configure at your DNS provider
|
||||||
|
(it can take some time until they are public).
|
||||||
|
|
||||||
5. To output a DNS zone file from which you can transfer DNS records
|
### Other helpful commands:
|
||||||
to your DNS provider:
|
|
||||||
|
|
||||||
```
|
To check the status of your remotely running chatmail service:
|
||||||
cmdeploy dns
|
|
||||||
```
|
|
||||||
|
|
||||||
6. To check status of your remotely running chatmail service:
|
```
|
||||||
|
scripts/cmdeploy status
|
||||||
```
|
|
||||||
cmdeploy status
|
|
||||||
```
|
|
||||||
|
|
||||||
7. To test your chatmail service:
|
|
||||||
|
|
||||||
```
|
|
||||||
cmdeploy test
|
|
||||||
```
|
|
||||||
|
|
||||||
8. To benchmark your chatmail service:
|
|
||||||
|
|
||||||
```
|
|
||||||
cmdeploy bench
|
|
||||||
```
|
|
||||||
|
|
||||||
### Refining the web pages
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
cmdeploy webdev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This starts a local live development cycle for chatmail Web pages:
|
To check whether your DNS records are correct:
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing static
|
```
|
||||||
HTML pages from `www/src/*.md` files
|
scripts/cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
- continously builds the web presence reading files from `www/src` directory
|
To test whether your chatmail service is working correctly:
|
||||||
and generating html files and copying assets to the `www/build` directory.
|
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
```
|
||||||
|
scripts/cmdeploy test
|
||||||
|
```
|
||||||
|
|
||||||
|
To measure the performance of your chatmail service:
|
||||||
|
|
||||||
### Home page and getting started for users
|
```
|
||||||
|
scripts/cmdeploy bench
|
||||||
|
```
|
||||||
|
|
||||||
`cmdeploy run` sets up mail services,
|
## Overview of this repository
|
||||||
and also creates default static Web pages and deploys them:
|
|
||||||
|
|
||||||
- a default `index.html` along with a QR code that users can click to
|
This repository drives the development of chatmail services,
|
||||||
create accounts on your chatmail provider,
|
comprised of minimal setups of
|
||||||
|
|
||||||
- a default `info.html` that is linked from the home page,
|
- [postfix smtp server](https://www.postfix.org)
|
||||||
|
- [dovecot imap server](https://www.dovecot.org)
|
||||||
|
|
||||||
- a default `policy.html` that is linked from the home page.
|
as well as custom services that are integrated with these two:
|
||||||
|
|
||||||
All `.html` files are generated
|
|
||||||
by the according markdown `.md` file in the `www/src` directory.
|
|
||||||
|
|
||||||
|
|
||||||
### Ports
|
|
||||||
|
|
||||||
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
|
||||||
Dovecot listens on ports 143(imap) and 993 (imaps).
|
|
||||||
|
|
||||||
Delta Chat will, however, discover all ports and configurations
|
|
||||||
automatically by reading the `autoconfig.xml` file from the chatmail instance.
|
|
||||||
|
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
|
||||||
|
|
||||||
If you need to stop account creation,
|
|
||||||
e.g. because some script is wildly creating accounts, run:
|
|
||||||
|
|
||||||
touch /etc/chatmail-nocreate
|
|
||||||
|
|
||||||
While this file is present, account creation will be blocked.
|
|
||||||
|
|
||||||
|
|
||||||
## Running tests and benchmarks (offline and online)
|
|
||||||
|
|
||||||
1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows
|
|
||||||
to login to the chatmail instance server.
|
|
||||||
|
|
||||||
2. To run local and online tests:
|
|
||||||
|
|
||||||
scripts/test.sh
|
|
||||||
|
|
||||||
3. To run benchmarks against your chatmail instance:
|
|
||||||
|
|
||||||
scripts/bench.sh
|
|
||||||
|
|
||||||
|
|
||||||
## Development Background for chatmail instances
|
|
||||||
|
|
||||||
This repository drives the development of "chatmail instances",
|
|
||||||
comprised of minimal setups of
|
|
||||||
|
|
||||||
- [postfix smtp server](https://www.postfix.org)
|
|
||||||
- [dovecot imap server](https://www.dovecot.org)
|
|
||||||
|
|
||||||
as well as two custom services that are integrated with these two:
|
|
||||||
|
|
||||||
- `chatmaild/src/chatmaild/doveauth.py` implements
|
- `chatmaild/src/chatmaild/doveauth.py` implements
|
||||||
create-on-login account creation semantics and is used
|
create-on-login account creation semantics and is used
|
||||||
by Dovecot during login authentication and by Postfix
|
by Dovecot during login authentication and by Postfix
|
||||||
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
||||||
to authenticate users
|
to authenticate users
|
||||||
to send mails for them.
|
to send mails for them.
|
||||||
|
|
||||||
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
||||||
unencrypted e-mail from leaving the chatmail 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.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -8,6 +8,12 @@ version = "0.2"
|
|||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
"iniconfig",
|
||||||
|
"deltachat-rpc-server",
|
||||||
|
"deltachat-rpc-client",
|
||||||
|
"ConfigArgParse",
|
||||||
|
"deltachat",
|
||||||
|
"setuptools>=60",
|
||||||
|
"setuptools-scm>=8",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -19,6 +25,9 @@ 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]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
|||||||
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 |
@@ -9,11 +9,17 @@ def read_config(inipath):
|
|||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
self.mailname = self.mail_domain = params["mailname"]
|
self.mail_domain = params["mail_domain"]
|
||||||
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
||||||
|
self.max_mailbox_size = params["max_mailbox_size"]
|
||||||
|
self.delete_mails_after = params["delete_mails_after"]
|
||||||
|
self.username_min_length = int(params["username_min_length"])
|
||||||
|
self.username_max_length = int(params["username_max_length"])
|
||||||
|
self.password_min_length = int(params["password_min_length"])
|
||||||
|
self.passthrough_senders = params["passthrough_senders"].split()
|
||||||
|
self.passthrough_recipients = params["passthrough_recipients"].split()
|
||||||
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
||||||
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].split()
|
|
||||||
self.privacy_postal = params.get("privacy_postal")
|
self.privacy_postal = params.get("privacy_postal")
|
||||||
self.privacy_mail = params.get("privacy_mail")
|
self.privacy_mail = params.get("privacy_mail")
|
||||||
self.privacy_pdo = params.get("privacy_pdo")
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
@@ -23,12 +29,14 @@ class Config:
|
|||||||
return open(self._inipath, "rb")
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
|
|
||||||
def write_initial_config(inipath, mailname):
|
def write_initial_config(inipath, mail_domain):
|
||||||
from importlib.resources import files
|
from importlib.resources import files
|
||||||
|
|
||||||
inidir = files(__package__).joinpath("ini")
|
inidir = files(__package__).joinpath("ini")
|
||||||
content = inidir.joinpath("chatmail.ini.f").read_text().format(mailname=mailname)
|
content = (
|
||||||
if mailname.endswith(".testrun.org"):
|
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")
|
override_inipath = inidir.joinpath("override-testrun.ini")
|
||||||
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
||||||
lines = []
|
lines = []
|
||||||
|
|||||||
@@ -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()
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
Description=Chatmail 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.
@@ -111,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:
|
||||||
|
|||||||
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
|
||||||
@@ -1,24 +1,54 @@
|
|||||||
[params]
|
[params]
|
||||||
|
|
||||||
# mail domain (MUST be set to fully qualified chat mail domain)
|
# mail domain (MUST be set to fully qualified chat mail domain)
|
||||||
mailname = {mailname}
|
mail_domain = {mail_domain}
|
||||||
|
|
||||||
#
|
#
|
||||||
# If you only do private test deploys, you don't need to modify any settings below
|
# If you only do private test deploys, you don't need to modify any settings below
|
||||||
#
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# Account Restrictions
|
||||||
|
#
|
||||||
|
|
||||||
# how many mails a user can send out per minute
|
# how many mails a user can send out per minute
|
||||||
max_user_send_per_minute = 60
|
max_user_send_per_minute = 60
|
||||||
|
|
||||||
|
# maximum mailbox size of a chatmail account
|
||||||
|
max_mailbox_size = 100M
|
||||||
|
|
||||||
|
# days after which mails are unconditionally deleted
|
||||||
|
delete_mails_after = 40
|
||||||
|
|
||||||
|
# minimum length a username must have
|
||||||
|
username_min_length = 9
|
||||||
|
|
||||||
|
# maximum length a username can have
|
||||||
|
username_max_length = 9
|
||||||
|
|
||||||
|
# minimum length a password must have
|
||||||
|
password_min_length = 9
|
||||||
|
|
||||||
|
# list of chatmail accounts which can send outbound un-encrypted mail
|
||||||
|
passthrough_senders =
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
passthrough_recipients =
|
passthrough_recipients =
|
||||||
|
|
||||||
|
#
|
||||||
|
# Deployment Details
|
||||||
|
#
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
# where the filtermail SMTP service listens
|
||||||
filtermail_smtp_port = 10080
|
filtermail_smtp_port = 10080
|
||||||
|
|
||||||
# postfix accepts on the localhost reinject SMTP port
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
postfix_reinject_port = 10025
|
postfix_reinject_port = 10025
|
||||||
|
|
||||||
|
#
|
||||||
|
# Privacy Policy
|
||||||
|
#
|
||||||
|
|
||||||
# postal address of privacy contact
|
# postal address of privacy contact
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
|
|
||||||
|
|||||||
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!
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -13,8 +13,8 @@ from chatmaild.config import read_config, write_initial_config
|
|||||||
def make_config(tmp_path):
|
def make_config(tmp_path):
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
inipath = tmp_path.joinpath("chatmail.ini")
|
||||||
|
|
||||||
def make_conf(mailname):
|
def make_conf(mail_domain):
|
||||||
write_initial_config(inipath, mailname=mailname)
|
write_initial_config(inipath, mail_domain=mail_domain)
|
||||||
return read_config(inipath)
|
return read_config(inipath)
|
||||||
|
|
||||||
return make_conf
|
return make_conf
|
||||||
@@ -27,7 +27,7 @@ def example_config(make_config):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain(example_config):
|
def maildomain(example_config):
|
||||||
return example_config.mailname
|
return example_config.mail_domain
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
|
|||||||
@@ -1,22 +1,21 @@
|
|||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_basic(make_config):
|
def test_read_config_basic(example_config):
|
||||||
config = make_config("chat.example.org")
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
assert config.mailname == "chat.example.org"
|
assert not example_config.privacy_supervisor and not example_config.privacy_mail
|
||||||
assert not config.privacy_supervisor and not config.privacy_mail
|
assert not example_config.privacy_pdo and not example_config.privacy_postal
|
||||||
assert not config.privacy_pdo and not config.privacy_postal
|
|
||||||
|
|
||||||
inipath = config._inipath
|
inipath = example_config._inipath
|
||||||
inipath.write_text(inipath.read_text().replace("60", "37"))
|
inipath.write_text(inipath.read_text().replace("60", "37"))
|
||||||
config = read_config(inipath)
|
example_config = read_config(inipath)
|
||||||
assert config.max_user_send_per_minute == 37
|
assert example_config.max_user_send_per_minute == 37
|
||||||
assert config.mailname == "chat.example.org"
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_testrun(make_config):
|
def test_read_config_testrun(make_config):
|
||||||
config = make_config("something.testrun.org")
|
config = make_config("something.testrun.org")
|
||||||
assert config.mailname == "something.testrun.org"
|
assert config.mail_domain == "something.testrun.org"
|
||||||
assert len(config.privacy_postal.split("\n")) > 1
|
assert len(config.privacy_postal.split("\n")) > 1
|
||||||
assert len(config.privacy_supervisor.split("\n")) > 1
|
assert len(config.privacy_supervisor.split("\n")) > 1
|
||||||
assert len(config.privacy_pdo.split("\n")) > 1
|
assert len(config.privacy_pdo.split("\n")) > 1
|
||||||
@@ -24,4 +23,10 @@ def test_read_config_testrun(make_config):
|
|||||||
assert config.filtermail_smtp_port == 10080
|
assert config.filtermail_smtp_port == 10080
|
||||||
assert config.postfix_reinject_port == 10025
|
assert config.postfix_reinject_port == 10025
|
||||||
assert config.max_user_send_per_minute == 60
|
assert config.max_user_send_per_minute == 60
|
||||||
assert config.passthrough_recipients
|
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,21 +51,25 @@ 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_50_concurrent_lookups_different_accounts(db, gencreds):
|
def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
||||||
num_threads = 50
|
num_threads = 50
|
||||||
req_per_thread = 5
|
req_per_thread = 5
|
||||||
results = queue.Queue()
|
results = queue.Queue()
|
||||||
@@ -68,7 +78,7 @@ def test_50_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:
|
||||||
|
|||||||
@@ -127,3 +127,19 @@ def test_excempt_privacy(maildata, gencreds, handler):
|
|||||||
content = msg.as_bytes()
|
content = msg.as_bytes()
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
assert "500" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
|
def test_passthrough_senders(gencreds, handler, maildata):
|
||||||
|
acc1 = gencreds()[0]
|
||||||
|
to_addr = "recipient@something.org"
|
||||||
|
handler.config.passthrough_senders = [acc1]
|
||||||
|
|
||||||
|
msg = maildata("plain.eml", acc1, to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = acc1
|
||||||
|
rcpt_tos = to_addr
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
# assert that None/no error is returned
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|||||||
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.
@@ -3,8 +3,8 @@ requires = ["setuptools>=68"]
|
|||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "deploy-chatmail"
|
name = "cmdeploy"
|
||||||
version = "0.1"
|
version = "0.2"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"pyinfra",
|
"pyinfra",
|
||||||
"pillow",
|
"pillow",
|
||||||
@@ -22,10 +22,11 @@ dependencies = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
cmdeploy = "deploy_chatmail.cmdeploy:main"
|
cmdeploy = "cmdeploy.cmdeploy:main"
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
|
"cmdeploy.testplugin" = "cmdeploy.tests.plugin"
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "-v -ra --strict-markers"
|
addopts = "-v -ra --strict-markers"
|
||||||
@@ -84,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()
|
||||||
@@ -112,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
|
||||||
|
|
||||||
@@ -240,10 +191,21 @@ def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= master_config.changed
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
|
header_cleanup = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/submission_header_cleanup"
|
||||||
|
),
|
||||||
|
dest="/etc/postfix/submission_header_cleanup",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= header_cleanup.changed
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
@@ -253,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
|
||||||
@@ -266,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/
|
||||||
@@ -346,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",
|
||||||
@@ -392,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"],
|
||||||
@@ -410,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)
|
|
||||||
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")
|
||||||
@@ -423,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
|
||||||
@@ -1,12 +1,15 @@
|
|||||||
|
{chatmail_domain}. A {ipv4}
|
||||||
|
{chatmail_domain}. AAAA {ipv6}
|
||||||
{chatmail_domain}. MX 10 {chatmail_domain}.
|
{chatmail_domain}. MX 10 {chatmail_domain}.
|
||||||
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
||||||
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
||||||
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
||||||
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
||||||
{chatmail_domain}. IN CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
{chatmail_domain}. CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
||||||
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
||||||
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;adkim=r;aspf=r"
|
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;adkim=s;aspf=s"
|
||||||
_mta-sts.{chatmail_domain}. IN TXT "v=STSv1; id={sts_id}"
|
_mta-sts.{chatmail_domain}. TXT "v=STSv1; id={sts_id}"
|
||||||
mta-sts.{chatmail_domain}. IN CNAME {chatmail_domain}.
|
mta-sts.{chatmail_domain}. CNAME {chatmail_domain}.
|
||||||
_smtp._tls.{chatmail_domain}. IN TXT "v=TLSRPTv1;rua=mailto:{email}"
|
www.{chatmail_domain}. CNAME {chatmail_domain}.
|
||||||
|
_smtp._tls.{chatmail_domain}. TXT "v=TLSRPTv1;rua=mailto:{email}"
|
||||||
{dkim_entry}
|
{dkim_entry}
|
||||||
@@ -3,7 +3,6 @@ Provides the `cmdeploy` entry point function,
|
|||||||
along with command line option and subcommand parsing.
|
along with command line option and subcommand parsing.
|
||||||
"""
|
"""
|
||||||
import argparse
|
import argparse
|
||||||
import datetime
|
|
||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
@@ -15,6 +14,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
from termcolor import colored
|
from termcolor import colored
|
||||||
from chatmaild.config import read_config, write_initial_config
|
from chatmaild.config import read_config, write_initial_config
|
||||||
|
from cmdeploy.dns import show_dns, check_necessary_dns
|
||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
@@ -32,11 +32,16 @@ def init_cmd_options(parser):
|
|||||||
|
|
||||||
def init_cmd(args, out):
|
def init_cmd(args, out):
|
||||||
"""Initialize chatmail config file."""
|
"""Initialize chatmail config file."""
|
||||||
|
mail_domain = args.chatmail_domain
|
||||||
if args.inipath.exists():
|
if args.inipath.exists():
|
||||||
out.red(f"Path exists, not modifying: {args.inipath}")
|
print(f"Path exists, not modifying: {args.inipath}")
|
||||||
raise SystemExit(1)
|
else:
|
||||||
write_initial_config(args.inipath, args.chatmail_domain)
|
write_initial_config(args.inipath, mail_domain)
|
||||||
out.green(f"created config file for {args.chatmail_domain} in {args.inipath}")
|
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
||||||
|
check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def run_cmd_options(parser):
|
def run_cmd_options(parser):
|
||||||
@@ -50,55 +55,42 @@ def run_cmd_options(parser):
|
|||||||
|
|
||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
mail_domain = args.config.mail_domain
|
||||||
|
if not check_necessary_dns(
|
||||||
|
out,
|
||||||
|
mail_domain,
|
||||||
|
):
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
env = os.environ.copy()
|
env = os.environ.copy()
|
||||||
env["CHATMAIL_DOMAIN"] = args.config.mailname
|
env["CHATMAIL_INI"] = args.inipath
|
||||||
deploypy = "deploy-chatmail/src/deploy_chatmail/deploy.py"
|
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
cmd = f"{pyinf} --ssh-user root {args.config.mailname} {deploypy}"
|
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path}"
|
||||||
|
|
||||||
out.check_call(cmd, env=env)
|
out.check_call(cmd, env=env)
|
||||||
|
print("Deploy completed, call `cmdeploy dns` next.")
|
||||||
|
|
||||||
|
|
||||||
|
def dns_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--zonefile",
|
||||||
|
dest="zonefile",
|
||||||
|
help="print the whole zonefile for deploying directly",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd(args, out):
|
def dns_cmd(args, out):
|
||||||
"""Generate dns zone file."""
|
"""Generate dns zone file."""
|
||||||
template = importlib.resources.files(__package__).joinpath("chatmail.zone.f")
|
show_dns(args, out)
|
||||||
ssh = f"ssh root@{args.config.mailname}"
|
|
||||||
|
|
||||||
def read_dkim_entries(entry):
|
|
||||||
lines = []
|
|
||||||
for line in entry.split("\n"):
|
|
||||||
if line.startswith(";") or not line.strip():
|
|
||||||
continue
|
|
||||||
line = line.replace("\t", " ")
|
|
||||||
lines.append(line)
|
|
||||||
return "\n".join(lines)
|
|
||||||
|
|
||||||
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
|
||||||
dkim_entry = read_dkim_entries(out.shell_output(f"{ssh} -- opendkim-genzone -F"))
|
|
||||||
|
|
||||||
out(
|
|
||||||
f"[writing {args.config.mailname} zone data (using space as separator) to stdout output]",
|
|
||||||
green=True,
|
|
||||||
)
|
|
||||||
print(
|
|
||||||
template.read_text()
|
|
||||||
.format(
|
|
||||||
acme_account_url=acme_account_url,
|
|
||||||
email=f"root@{args.config.mailname}",
|
|
||||||
sts_id=datetime.datetime.now().strftime("%Y%m%d%H%M"),
|
|
||||||
chatmail_domain=args.config.mailname,
|
|
||||||
dkim_entry=dkim_entry,
|
|
||||||
)
|
|
||||||
.strip()
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
def status_cmd(args, out):
|
||||||
"""Display status for online chatmail instance."""
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
ssh = f"ssh root@{args.config.mailname}"
|
ssh = f"ssh root@{args.config.mail_domain}"
|
||||||
|
|
||||||
out.green(f"chatmail domain: {args.config.mailname}")
|
out.green(f"chatmail domain: {args.config.mail_domain}")
|
||||||
if args.config.privacy_mail:
|
if args.config.privacy_mail:
|
||||||
out.green("privacy settings: present")
|
out.green("privacy settings: present")
|
||||||
else:
|
else:
|
||||||
@@ -110,6 +102,15 @@ def status_cmd(args, out):
|
|||||||
print(line)
|
print(line)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cmd_options(parser):
|
||||||
|
parser.add_argument(
|
||||||
|
"--slow",
|
||||||
|
dest="slow",
|
||||||
|
action="store_true",
|
||||||
|
help="also run slow tests",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_cmd(args, out):
|
def test_cmd(args, out):
|
||||||
"""Run local and online tests for chatmail deployment.
|
"""Run local and online tests for chatmail deployment.
|
||||||
|
|
||||||
@@ -121,9 +122,18 @@ def test_cmd(args, out):
|
|||||||
out.check_call(f"{sys.executable} -m pip install deltachat")
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
pytest_path = shutil.which("pytest")
|
pytest_path = shutil.which("pytest")
|
||||||
ret = out.run_ret(
|
pytest_args = [
|
||||||
[pytest_path, "tests/", "-n4", "-rs", "-x", "-vrx", "--durations=5"]
|
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
|
return ret
|
||||||
|
|
||||||
|
|
||||||
@@ -145,13 +155,9 @@ def fmt_cmd_options(parser):
|
|||||||
|
|
||||||
|
|
||||||
def fmt_cmd(args, out):
|
def fmt_cmd(args, out):
|
||||||
"""Run formattting fixes (fuff and black) on all chatmail source code."""
|
"""Run formattting fixes (ruff and black) on all chatmail source code."""
|
||||||
|
|
||||||
chatmaild = importlib.resources.files("chatmaild")
|
|
||||||
deploy_chatmail = importlib.resources.files("deploy_chatmail")
|
|
||||||
tests = deploy_chatmail.joinpath("../../../tests")
|
|
||||||
sources = list(str(x) for x in [chatmaild, deploy_chatmail, tests])
|
|
||||||
|
|
||||||
|
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
||||||
black_args = [shutil.which("black")]
|
black_args = [shutil.which("black")]
|
||||||
ruff_args = [shutil.which("ruff")]
|
ruff_args = [shutil.which("ruff")]
|
||||||
|
|
||||||
@@ -174,9 +180,10 @@ def fmt_cmd(args, out):
|
|||||||
|
|
||||||
def bench_cmd(args, out):
|
def bench_cmd(args, out):
|
||||||
"""Run benchmarks against an online chatmail instance."""
|
"""Run benchmarks against an online chatmail instance."""
|
||||||
pytest_path = shutil.which("pytest")
|
args = ["pytest", "--pyargs", "cmdeploy.tests.online.benchmark", "-vrx"]
|
||||||
benchmark = "tests/online/benchmark.py"
|
cmdstring = " ".join(args)
|
||||||
subprocess.check_call([pytest_path, benchmark, "-vrx"])
|
out.green(f"[$ {cmdstring}]")
|
||||||
|
subprocess.check_call(args)
|
||||||
|
|
||||||
|
|
||||||
def webdev_cmd(args, out):
|
def webdev_cmd(args, out):
|
||||||
@@ -204,9 +211,15 @@ class Out:
|
|||||||
color = "red" if red else ("green" if green else None)
|
color = "red" if red else ("green" if green else None)
|
||||||
print(colored(msg, color), file=file)
|
print(colored(msg, color), file=file)
|
||||||
|
|
||||||
def shell_output(self, arg):
|
def shell_output(self, arg, no_print=False, timeout=10):
|
||||||
self(f"[$ {arg}]", file=sys.stderr)
|
if not no_print:
|
||||||
return subprocess.check_output(arg, shell=True).decode()
|
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):
|
def check_call(self, arg, env=None, quiet=False):
|
||||||
if not quiet:
|
if not quiet:
|
||||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
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)
|
||||||
@@ -42,19 +42,29 @@ def test_reject_forged_from(cmsetup, maildata, gencreds, 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()
|
||||||
@@ -38,7 +38,7 @@ def pytest_runtest_setup(item):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def chatmail_config(pytestconfig):
|
def chatmail_config(pytestconfig):
|
||||||
current = basedir = Path()
|
current = basedir = Path().resolve()
|
||||||
while 1:
|
while 1:
|
||||||
path = current.joinpath("chatmail.ini").resolve()
|
path = current.joinpath("chatmail.ini").resolve()
|
||||||
if path.exists():
|
if path.exists():
|
||||||
@@ -52,7 +52,7 @@ def chatmail_config(pytestconfig):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain(chatmail_config):
|
def maildomain(chatmail_config):
|
||||||
return chatmail_config.mailname
|
return chatmail_config.mail_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))
|
||||||
@@ -1,8 +1,7 @@
|
|||||||
import os
|
import os
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from deploy_chatmail.cmdeploy import get_parser, main
|
from cmdeploy.cmdeploy import get_parser, main
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
@@ -21,12 +20,7 @@ class TestCmdline:
|
|||||||
run = parser.parse_args(["run"])
|
run = parser.parse_args(["run"])
|
||||||
assert init and run
|
assert init and run
|
||||||
|
|
||||||
def test_init(self, tmp_path):
|
@pytest.mark.xfail(reason="init doesn't exit anymore, check for CLI output instead")
|
||||||
main(["init", "chat.example.org"])
|
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
|
||||||
config = read_config(inipath)
|
|
||||||
assert config.mailname == "chat.example.org"
|
|
||||||
|
|
||||||
def test_init_not_overwrite(self):
|
def test_init_not_overwrite(self):
|
||||||
main(["init", "chat.example.org"])
|
main(["init", "chat.example.org"])
|
||||||
with pytest.raises(SystemExit):
|
with pytest.raises(SystemExit):
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
from deploy_chatmail.www import build_webpages
|
from cmdeploy.www import build_webpages
|
||||||
|
|
||||||
|
|
||||||
def test_build_webpages(tmp_path, make_config):
|
def test_build_webpages(tmp_path, make_config):
|
||||||
pkgroot = importlib.resources.files("deploy_chatmail")
|
pkgroot = importlib.resources.files("cmdeploy")
|
||||||
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
||||||
assert src_dir.exists(), src_dir
|
assert src_dir.exists(), src_dir
|
||||||
config = make_config("chat.example.org")
|
config = make_config("chat.example.org")
|
||||||
@@ -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
|
||||||
@@ -71,7 +104,7 @@ def main():
|
|||||||
inipath = reporoot.joinpath("chatmail.ini")
|
inipath = reporoot.joinpath("chatmail.ini")
|
||||||
config = read_config(inipath)
|
config = read_config(inipath)
|
||||||
config.webdev = True
|
config.webdev = True
|
||||||
assert config.mailname
|
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,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
|
|
||||||
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 "$@"
|
||||||
@@ -2,8 +2,5 @@
|
|||||||
set -e
|
set -e
|
||||||
python3 -m venv venv
|
python3 -m venv venv
|
||||||
|
|
||||||
venv/bin/pip install -e deploy-chatmail
|
|
||||||
venv/bin/pip install -e chatmaild
|
venv/bin/pip install -e chatmaild
|
||||||
|
venv/bin/pip install -e cmdeploy
|
||||||
source venv/bin/activate
|
|
||||||
echo activated 'venv' python virtualenv environment containing "cmdeploy" tool
|
|
||||||
|
|||||||
@@ -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,5 +1,5 @@
|
|||||||
|
|
||||||
<img width="800px" src="collage-top.png"/>
|
<img class="banner" src="collage-top.png"/>
|
||||||
|
|
||||||
## Dear [Delta Chat](https://get.delta.chat) users and newcomers,
|
## Dear [Delta Chat](https://get.delta.chat) users and newcomers,
|
||||||
|
|
||||||
@@ -14,6 +14,6 @@ Welcome to instant, interoperable and [privacy-preserving](privacy.html) messagi
|
|||||||
|
|
||||||
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
||||||
|
|
||||||
|
{% if config.mail_domain != "nine.testrun.org" %}
|
||||||
## ⚡ Note: this is an experimental service ⚡
|
<div class="experimental">Note: this is only a temporary development chatmail service</div>
|
||||||
|
{% endif %}
|
||||||
|
|||||||
@@ -1,18 +1,34 @@
|
|||||||
|
|
||||||
<img width="800px" src="collage-info.png"/>
|
<img class="banner" src="collage-info.png"/>
|
||||||
|
|
||||||
## More information
|
## More information
|
||||||
|
|
||||||
|
{{ config.mail_domain }} provides a low-maintenance, resource efficient and
|
||||||
|
interoperable e-mail service for everyone. What's behind a `chatmail` is
|
||||||
|
effectively a normal e-mail address just like any other but optimized
|
||||||
|
for the usage in chats, especially DeltaChat.
|
||||||
|
|
||||||
### Choosing a chatmail address instead of using a random one
|
### Choosing a chatmail address instead of using a random one
|
||||||
|
|
||||||
In the Delta Chat account setup
|
In the Delta Chat account setup
|
||||||
you may tap `LOG INTO YOUR E-MAIL ACCOUNT`
|
you may tap `LOG INTO YOUR E-MAIL ACCOUNT`
|
||||||
and fill the two fields like this:
|
and fill the two fields like this:
|
||||||
|
|
||||||
- `Address`: invent a word with *exactly* nine characters
|
- `Address`: invent a word with
|
||||||
and append `@{{config.mail_domain}}` to it.
|
{% if username_min_length == username_max_length %}
|
||||||
|
*exactly* {{ username_min_length }}
|
||||||
|
{% else %}
|
||||||
|
{{ username_min_length}}
|
||||||
|
{% if username_max_length == "more" %}
|
||||||
|
or more
|
||||||
|
{% else %}
|
||||||
|
to {{ username_max_length }}
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
characters
|
||||||
|
and append `@{{config.mail_domain}}` to it.
|
||||||
|
|
||||||
- `Password`: invent at least 9 characters.
|
- `Password`: invent at least {{ password_min_length }} characters.
|
||||||
|
|
||||||
If the e-mail address is not yet taken, you'll get that account.
|
If the e-mail address is not yet taken, you'll get that account.
|
||||||
The first login sets your password.
|
The first login sets your password.
|
||||||
@@ -24,11 +40,11 @@ The first login sets your password.
|
|||||||
{{config.mail_domain}} but setting up contact via [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
{{config.mail_domain}} but setting up contact via [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
||||||
allows your messages to pass freely to any outside recipients.
|
allows your messages to pass freely to any outside recipients.
|
||||||
|
|
||||||
- You may send up to 60 messages per minute
|
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
||||||
|
|
||||||
- Messages are unconditionally removed 40 days after arriving on the server
|
- Messages are unconditionally removed {{ config.delete_mails_after }} days after arriving on the server.
|
||||||
|
|
||||||
- You can store up to [100MB messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server)
|
- You can store up to [{{ config.max_mailbox_size }} messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server).
|
||||||
|
|
||||||
|
|
||||||
### Who are the operators? Which software is running?
|
### Who are the operators? Which software is running?
|
||||||
|
|||||||
44
www/src/logo.svg
Normal file
44
www/src/logo.svg
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<svg
|
||||||
|
width="145"
|
||||||
|
height="145"
|
||||||
|
version="1.1"
|
||||||
|
id="svg4"
|
||||||
|
sodipodi:docname="At_sign.svg"
|
||||||
|
inkscape:version="1.2.2 (b0a84865, 2022-12-01)"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg">
|
||||||
|
<defs
|
||||||
|
id="defs8" />
|
||||||
|
<sodipodi:namedview
|
||||||
|
id="namedview6"
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#000000"
|
||||||
|
borderopacity="0.25"
|
||||||
|
inkscape:showpageshadow="2"
|
||||||
|
inkscape:pageopacity="0.0"
|
||||||
|
inkscape:pagecheckerboard="0"
|
||||||
|
inkscape:deskcolor="#d1d1d1"
|
||||||
|
showgrid="false"
|
||||||
|
inkscape:zoom="3.0241379"
|
||||||
|
inkscape:cx="67.622577"
|
||||||
|
inkscape:cy="72.913341"
|
||||||
|
inkscape:window-width="1390"
|
||||||
|
inkscape:window-height="1027"
|
||||||
|
inkscape:window-x="55"
|
||||||
|
inkscape:window-y="25"
|
||||||
|
inkscape:window-maximized="0"
|
||||||
|
inkscape:current-layer="svg4" />
|
||||||
|
<g
|
||||||
|
aria-label="@"
|
||||||
|
id="text2"
|
||||||
|
style="font-size:144px;font-family:Arial">
|
||||||
|
<path
|
||||||
|
d="m 79.927878,94.422406 c -2.704286,3.120332 -5.741407,5.637394 -9.111364,7.551194 -3.328352,1.87221 -6.677506,2.80831 -10.047463,2.80831 -3.702792,0 -7.301573,-1.08172 -10.796342,-3.24515 -3.49477,-2.163426 -6.344671,-5.491779 -8.549704,-9.985058 -2.163429,-4.493275 -3.245144,-9.423397 -3.245144,-14.790365 0,-6.615099 1.684978,-13.230199 5.054935,-19.845299 3.411561,-6.656705 7.634407,-11.649233 12.66854,-14.977585 5.034133,-3.328352 9.92265,-4.992528 14.665552,-4.992528 3.619583,0 7.072748,0.956901 10.359496,2.870704 3.286748,1.872198 6.115847,4.742902 8.487297,8.612111 l 2.121825,-9.673023 h 11.170784 l -8.986557,41.87483 c -1.248129,5.824616 -1.872194,9.048957 -1.872194,9.673023 0,1.123319 0.416044,2.101022 1.248132,2.93311 0.873692,0.790484 1.913802,1.185726 3.120332,1.185726 2.20503,0 5.096537,-1.268934 8.674517,-3.806803 4.7429,-3.328352 8.4873,-7.780023 11.23319,-13.355013 2.78749,-5.616594 4.18124,-11.399606 4.18124,-17.349035 0,-6.947935 -1.78899,-13.438222 -5.36697,-19.47086 -3.53637,-6.032638 -8.84094,-10.858749 -15.913687,-14.478332 -7.03114,-3.619583 -14.811161,-5.429374 -23.340064,-5.429374 -9.73543,0 -18.638772,2.288242 -26.710026,6.864726 -8.029649,4.534879 -14.27031,11.06677 -18.721981,19.595673 -4.410066,8.487298 -6.615099,17.598662 -6.615099,27.334092 0,10.193078 2.205033,18.971607 6.615099,26.33559 2.290454,3.78888 -7.136335,18.96983 -3.810585,21.73443 3.138096,2.60861 18.971963,-7.14297 23.031819,-5.44631 8.404089,3.53637 17.702673,5.30456 27.895752,5.30456 10.90035,0 20.032515,-1.83059 27.396492,-5.49178 7.36399,-3.66119 12.87657,-8.11286 16.53776,-13.35501 l 9.29559,4 c -2.12183,4.36846 -3.76221,4.82013 -8.92116,9.35501 -5.15895,4.53488 -11.2956,8.11286 -18.40995,10.73393 -7.114346,2.66268 -15.684851,3.99402 -25.711512,3.99402 -9.236177,0 -17.76508,-1.18572 -25.586707,-3.55717 -7.780023,-2.37145 -29.296198,9.26152 -34.78798,4.47701 -5.49178,-4.7429 5.248856,-25.42482 2.461361,-31.62388 -3.49477,-7.863231 -5.242155,-16.350531 -5.242155,-25.461894 0,-10.151474 2.08022,-19.824498 6.240661,-29.019071 5.075736,-11.274793 12.273297,-19.907706 21.592683,-25.898739 9.360991,-5.991034 20.69819,-8.986551 34.011599,-8.986551 10.317891,0 19.574873,2.121824 27.77093,6.365473 8.23767,4.202045 14.72796,10.484309 19.47086,18.846794 4.03563,7.197561 6.05344,15.019189 6.05344,23.464883 0,12.065277 -4.24365,22.77841 -12.73094,32.1394 -7.572,8.404095 -15.85128,12.606135 -24.837827,12.606135 -2.870704,0 -5.200551,-0.43684 -6.98954,-1.31053 -1.747385,-0.8737 -3.037121,-2.12183 -3.869209,-3.744402 -0.540857,-1.040114 -0.936099,-2.829105 -1.185726,-5.366972 z M 49.723082,77.510217 c 0,5.699803 1.352143,10.130671 4.05643,13.292606 2.704286,3.161935 5.803814,4.742902 9.298583,4.742902 2.329847,0 4.784506,-0.686473 7.363979,-2.059418 2.579473,-1.41455 5.034133,-3.49477 7.363979,-6.240661 2.371451,-2.74589 4.306056,-6.219857 5.803815,-10.421902 1.497759,-4.243649 2.246638,-8.487298 2.246638,-12.730947 0,-5.658198 -1.41455,-10.047462 -4.243649,-13.167793 -2.787495,-3.12033 -6.199056,-4.680495 -10.234683,-4.680495 -2.662682,0 -5.179749,0.686473 -7.5512,2.059418 -2.329846,1.331341 -4.597286,3.494769 -6.802319,6.490286 -2.205033,2.995517 -3.97322,6.635903 -5.304561,10.921156 -1.331341,4.285253 -1.997012,8.216869 -1.997012,11.794848 z"
|
||||||
|
id="path347"
|
||||||
|
style="stroke-width:0.887561"
|
||||||
|
sodipodi:nodetypes="ccsscscsscccccscsccsccsccscscssccscscccsccsccscscccssscccscscsss" />
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 4.5 KiB |
74
www/src/main.css
Normal file
74
www/src/main.css
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
|
||||||
|
body {
|
||||||
|
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 'Segoe UI Emoji', 'Apple Color Emoji', 'Noto Color Emoji', sans-serif;
|
||||||
|
line-height: 1.4;
|
||||||
|
font-size: 1.2em;
|
||||||
|
max-width: 800px;
|
||||||
|
margin: 20px auto;
|
||||||
|
padding: 0 10px;
|
||||||
|
color: #363636;
|
||||||
|
background: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 2.2em;
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
color: #000;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
margin-top: 24px;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
text-decoration: none;
|
||||||
|
color: #0076d1;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
img, video {
|
||||||
|
max-width: 100%;
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
background: #efefef;
|
||||||
|
padding: 2.5px 5px;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#menu {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#menu li {
|
||||||
|
display: inline-block;
|
||||||
|
padding-right: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#domain {
|
||||||
|
margin-left: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
#domain a {
|
||||||
|
color: #888;
|
||||||
|
}
|
||||||
|
|
||||||
|
.banner {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.experimental {
|
||||||
|
margin: 3em 0;
|
||||||
|
padding: 1em;
|
||||||
|
border: 4px dashed red;
|
||||||
|
color: red;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
@@ -5,16 +5,23 @@
|
|||||||
{% if config.webdev %}
|
{% if config.webdev %}
|
||||||
<meta http-equiv="refresh" content="3">
|
<meta http-equiv="refresh" content="3">
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
||||||
<title>{{ config.mail_domain }} {{ pagename }}</title>
|
<title>{{ config.mail_domain }} {{ pagename }}</title>
|
||||||
<link rel="stylesheet" href="./water.css">
|
<link rel="stylesheet" href="./main.css">
|
||||||
|
<link rel="icon" href="/logo.svg">
|
||||||
|
<link rel=”mask-icon” href=”/logo.svg” color=”#000000">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
|
<ul id="menu">
|
||||||
|
<li><a href="index.html">home</a></li>
|
||||||
|
<li><a href="info.html">info</a></li>
|
||||||
|
<li><a href="privacy.html">privacy</a></li>
|
||||||
|
<li><a href="https://github.com/deltachat/chatmail">public code ↗</a></li>
|
||||||
|
<li id="domain"><a href="index.html">{{ config.mail_domain }}</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
{{ markdown_html }}
|
{{ markdown_html }}
|
||||||
<footer>
|
|
||||||
<a href="index.html">home</a> |
|
|
||||||
<a href="info.html">more info</a> |
|
|
||||||
<a href="privacy.html">privacy</a> |
|
|
||||||
<a href="https://github.com/deltachat/chatmail">-> public development </a>
|
|
||||||
</footer>
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<img width="800px" src="collage-privacy.png"/>
|
<img class="banner" src="collage-privacy.png"/>
|
||||||
|
|
||||||
# Privacy Policy for {{ config.mail_domain }}
|
# Privacy Policy for {{ config.mail_domain }}
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ we process the following data and details:
|
|||||||
Creating an account happens in one of two ways on our mail servers:
|
Creating an account happens in one of two ways on our mail servers:
|
||||||
|
|
||||||
- with a QR invitation token
|
- with a QR invitation token
|
||||||
which is scanned using the DeltaChat app
|
which is scanned using the Delta Chat app
|
||||||
and then the account is created.
|
and then the account is created.
|
||||||
|
|
||||||
- by letting Delta Chat otherwise create an account
|
- by letting Delta Chat otherwise create an account
|
||||||
@@ -218,97 +218,16 @@ on these or possible objections.
|
|||||||
A deletion can be made
|
A deletion can be made
|
||||||
directly in the Delta Chat email messenger.
|
directly in the Delta Chat email messenger.
|
||||||
|
|
||||||
a) request information about your personal data processed by us
|
If you have any questions or complaints,
|
||||||
in accordance with Art. 15 GDPR.
|
please feel free to contact us by email:
|
||||||
In particular,
|
{{ config.privacy_mail }}
|
||||||
you can request information about the processing purposes,
|
|
||||||
the category of personal data,
|
|
||||||
the categories of recipients to whom your data have been or will be disclosed,
|
|
||||||
the planned storage period,
|
|
||||||
the existence of a right to rectification, erasure, restriction of processing or objection,
|
|
||||||
the existence of a right of complaint,
|
|
||||||
the origin of your data if it has not been collected by us,
|
|
||||||
as well as the existence of automated decision-making including profiling
|
|
||||||
and, if applicable,
|
|
||||||
meaningful information about its details;
|
|
||||||
|
|
||||||
b) in accordance with Art. 16 of the GDPR,
|
As a rule, you can contact the supervisory authority of your usual place of residence
|
||||||
immediately request the correction
|
|
||||||
of inaccurate or incomplete personal data stored by us;
|
|
||||||
|
|
||||||
c) pursuant to Article 17 of the GDPR,
|
|
||||||
to request the erasure of your personal data stored by us,
|
|
||||||
unless the processing is necessary
|
|
||||||
for the exercise of the right to freedom of expression and information,
|
|
||||||
for compliance with a legal obligation,
|
|
||||||
for reasons of public interest,
|
|
||||||
or for the establishment, exercise or defence of legal claims;
|
|
||||||
|
|
||||||
d) pursuant to Art. 18 GDPR,
|
|
||||||
to request the restriction of the processing of your personal data,
|
|
||||||
insofar as the accuracy of the data is disputed by you,
|
|
||||||
the processing is unlawful,
|
|
||||||
but you object to its erasure
|
|
||||||
and we no longer require the data,
|
|
||||||
but you need it for the assertion, exercise or defence of legal claims
|
|
||||||
or you have objected to the processing pursuant to Art. 21 GDPR;
|
|
||||||
|
|
||||||
e) pursuant to Art. 20 GDPR,
|
|
||||||
to receive your personal data that you have provided to us
|
|
||||||
in a structured, common and machine-readable format
|
|
||||||
or to request that it be transferred to another controller;
|
|
||||||
|
|
||||||
f) in accordance with Art. 7 (3) of the GDPR,
|
|
||||||
to revoke your consent given to us at any time.
|
|
||||||
This has the consequence that we may no longer continue the data processing
|
|
||||||
based on this consent in the future; and
|
|
||||||
|
|
||||||
g) complain to a supervisory authority
|
|
||||||
in accordance with Article 77 of the GDPR.
|
|
||||||
As a rule,
|
|
||||||
you can contact the supervisory authority of your usual place of residence
|
|
||||||
or workplace
|
or workplace
|
||||||
or our registered office for this purpose.
|
or our registered office for this purpose.
|
||||||
The supervisory authority responsible for our place of business
|
The supervisory authority responsible for our place of business
|
||||||
is the `{{ config.privacy_supervisor }}`.
|
is the `{{ config.privacy_supervisor }}`.
|
||||||
|
|
||||||
If you have any questions or complaints, please feel free to contact us by email:
|
|
||||||
{{ config.privacy_mail }}
|
|
||||||
|
|
||||||
|
|
||||||
### 5.1 Right to object
|
|
||||||
|
|
||||||
If your personal data is processed on the basis of our legitimate interests
|
|
||||||
in accordance with Art. 6 (1) lit. f GDPR,
|
|
||||||
you have the right to object to the processing of your personal data
|
|
||||||
in accordance with Art. 21 GDPR,
|
|
||||||
provided that there are grounds for this based on your particular situation
|
|
||||||
or the objection is directed against direct advertising.
|
|
||||||
In the latter case,
|
|
||||||
you have a general right of objection,
|
|
||||||
which will be implemented by us
|
|
||||||
without specifying a particular situation.
|
|
||||||
|
|
||||||
If you wish to exercise your right of objection,
|
|
||||||
simply send an e-mail to: {{ config.privacy_mail }}
|
|
||||||
|
|
||||||
### 5.2 Right to withdraw
|
|
||||||
|
|
||||||
If your personal data is processed on the basis of your consent
|
|
||||||
in accordance with Art. 6 (1) lit. a GDPR
|
|
||||||
(e.g. via the mailing list),
|
|
||||||
you can withdraw your consent at any time
|
|
||||||
and without any disadvantages.
|
|
||||||
As a result,
|
|
||||||
we may no longer continue the data processing
|
|
||||||
that was based on this consent for the future.
|
|
||||||
However,
|
|
||||||
the withdrawal of your consent
|
|
||||||
does not affect the lawfulness of the processing
|
|
||||||
carried out on the basis of the consent until the withdrawal.
|
|
||||||
|
|
||||||
If you wish to make use of your right of withdrawal,
|
|
||||||
simply send an e-mail to: {{ config.privacy_mail }}
|
|
||||||
|
|
||||||
## 6. Validity of this privacy policy
|
## 6. Validity of this privacy policy
|
||||||
|
|
||||||
|
|||||||
1690
www/src/water.css
1690
www/src/water.css
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user