mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
Compare commits
1 Commits
greeterbot
...
hpk/python
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
54c461568a |
4
.github/CODE_OF_CONDUCT.md
vendored
4
.github/CODE_OF_CONDUCT.md
vendored
@@ -1,4 +0,0 @@
|
|||||||
|
|
||||||
Please refer to
|
|
||||||
[Delta Chat community standards and practices](https://delta.chat/en/community-standards)
|
|
||||||
which also apply for all chatmail developments.
|
|
||||||
37
.github/workflows/ci.yaml
vendored
37
.github/workflows/ci.yaml
vendored
@@ -1,37 +0,0 @@
|
|||||||
name: CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
push:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
tox:
|
|
||||||
name: isolated chatmaild tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: run chatmaild tests
|
|
||||||
working-directory: chatmaild
|
|
||||||
run: pipx run tox
|
|
||||||
|
|
||||||
scripts:
|
|
||||||
name: deploy-chatmail tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: initenv
|
|
||||||
run: scripts/initenv.sh
|
|
||||||
|
|
||||||
- name: append venv/bin to PATH
|
|
||||||
run: echo venv/bin >>$GITHUB_PATH
|
|
||||||
|
|
||||||
- name: run formatting checks
|
|
||||||
run: cmdeploy fmt -v
|
|
||||||
|
|
||||||
- name: run deploy-chatmail offline tests
|
|
||||||
run: pytest --pyargs cmdeploy
|
|
||||||
|
|
||||||
# all other cmdeploy commands require a staging server
|
|
||||||
# see https://github.com/deltachat/chatmail/issues/100
|
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -3,9 +3,6 @@ __pycache__/
|
|||||||
*.py[cod]
|
*.py[cod]
|
||||||
*$py.class
|
*$py.class
|
||||||
*.swp
|
*.swp
|
||||||
*qr-*.png
|
|
||||||
chatmail.ini
|
|
||||||
|
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
*.so
|
*.so
|
||||||
@@ -162,5 +159,3 @@ cython_debug/
|
|||||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||||
#.idea/
|
#.idea/
|
||||||
|
|
||||||
chatmail.zone
|
|
||||||
|
|||||||
21
LICENSE
21
LICENSE
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2023, chatmail and delta chat teams
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
|
||||||
the Software without restriction, including without limitation the rights to
|
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
||||||
of the Software, and to permit persons to whom the Software is furnished to do
|
|
||||||
so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
162
README.md
162
README.md
@@ -1,162 +1,20 @@
|
|||||||
|
# Chat Mail server configuration
|
||||||
|
|
||||||
<img width="800px" src="www/src/collage-top.png"/>
|
This package deploys Postfix and Dovecot servers, including OpenDKIM for DKIM signing.
|
||||||
|
|
||||||
# Chatmail services optimized for Delta Chat apps
|
Postfix uses Dovecot for authentication as described in <https://www.postfix.org/SASL_README.html#server_dovecot>
|
||||||
|
|
||||||
This repository helps to setup a ready-to-use chatmail server
|
## Ports
|
||||||
comprised of a minimal setup of the battle-tested
|
|
||||||
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services.
|
|
||||||
|
|
||||||
The setup is designed and optimized for providing chatmail accounts
|
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
||||||
for use by [Delta Chat apps](https://delta.chat).
|
Dovecot listens on ports 143(imap) and 993 (imaps).
|
||||||
|
|
||||||
Chatmail accounts are automatically created by a first login,
|
## DNS
|
||||||
after which the initially specified password is required for using them.
|
|
||||||
|
|
||||||
## Deploying your own chatmail server
|
For DKIM you must add a DNS entry as in /etc/opendkim/selector.txt (where selector is the opendkim_selector configured in the chatmail inventory).
|
||||||
|
|
||||||
We use `chat.example.org` as the chatmail domain in the following steps.
|
## Run with pyinfra
|
||||||
Please substitute it with your own domain.
|
|
||||||
|
|
||||||
1. Install the `cmdeploy` command in a virtualenv
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/deltachat/chatmail
|
|
||||||
cd chatmail
|
|
||||||
scripts/initenv.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Create chatmail configuration file `chatmail.ini`:
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy init chat.example.org # <-- use your domain
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Setup first DNS records for your chatmail domain,
|
|
||||||
according to the hints provided by `cmdeploy init`.
|
|
||||||
Verify that SSH root login works:
|
|
||||||
|
|
||||||
```
|
|
||||||
ssh root@chat.example.org # <-- use your domain
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Deploy to the remote chatmail server:
|
|
||||||
|
|
||||||
```
|
|
||||||
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).
|
|
||||||
|
|
||||||
### Other helpful commands:
|
|
||||||
|
|
||||||
To check the status of your remotely running chatmail service:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
scripts/cmdeploy status
|
CHATMAIL_DOMAIN=c1.testrun.org pyinfra c1.testrun.org deploy.py
|
||||||
```
|
```
|
||||||
|
|
||||||
To check whether your DNS records are correct:
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy dns
|
|
||||||
```
|
|
||||||
|
|
||||||
To test whether your chatmail service is working correctly:
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy test
|
|
||||||
```
|
|
||||||
|
|
||||||
To measure the performance of your chatmail service:
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy bench
|
|
||||||
```
|
|
||||||
|
|
||||||
## Overview of this repository
|
|
||||||
|
|
||||||
This repository drives the development of chatmail services,
|
|
||||||
comprised of minimal setups of
|
|
||||||
|
|
||||||
- [postfix smtp server](https://www.postfix.org)
|
|
||||||
- [dovecot imap server](https://www.dovecot.org)
|
|
||||||
|
|
||||||
as well as custom services that are integrated with these two:
|
|
||||||
|
|
||||||
- `chatmaild/src/chatmaild/doveauth.py` implements
|
|
||||||
create-on-login account creation semantics and is used
|
|
||||||
by Dovecot during login authentication and by Postfix
|
|
||||||
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
|
||||||
to authenticate users
|
|
||||||
to send mails for them.
|
|
||||||
|
|
||||||
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
|
||||||
unencrypted e-mail from leaving the chatmail service
|
|
||||||
and is integrated into postfix's outbound mail pipelines.
|
|
||||||
|
|
||||||
There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
|
||||||
which helps with setting up and managing the chatmail service.
|
|
||||||
`cmdeploy run` uses [pyinfra-based scripting](https://pyinfra.com/)
|
|
||||||
in `cmdeploy/src/cmdeploy/__init__.py`
|
|
||||||
to automatically install all chatmail components on a server.
|
|
||||||
|
|
||||||
|
|
||||||
### Home page and getting started for users
|
|
||||||
|
|
||||||
`cmdeploy run` also creates default static Web pages and deploys them
|
|
||||||
to a nginx web server with:
|
|
||||||
|
|
||||||
- a default `index.html` along with a QR code that users can click to
|
|
||||||
create accounts on your chatmail provider,
|
|
||||||
|
|
||||||
- a default `info.html` that is linked from the home page,
|
|
||||||
|
|
||||||
- a default `policy.html` that is linked from the home page.
|
|
||||||
|
|
||||||
All `.html` files are generated
|
|
||||||
by the according markdown `.md` file in the `www/src` directory.
|
|
||||||
|
|
||||||
|
|
||||||
### Refining the web pages
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/cmdeploy webdev
|
|
||||||
```
|
|
||||||
|
|
||||||
This starts a local live development cycle for chatmail Web pages:
|
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing static
|
|
||||||
HTML pages from `www/src/*.md` files
|
|
||||||
|
|
||||||
- continously builds the web presence reading files from `www/src` directory
|
|
||||||
and generating html files and copying assets to the `www/build` directory.
|
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
|
||||||
|
|
||||||
|
|
||||||
## Emergency Commands to disable automatic account creation
|
|
||||||
|
|
||||||
If you need to stop account creation,
|
|
||||||
e.g. because some script is wildly creating accounts,
|
|
||||||
login to the server with ssh and run:
|
|
||||||
|
|
||||||
```
|
|
||||||
touch /etc/chatmail-nocreate
|
|
||||||
```
|
|
||||||
|
|
||||||
While this file is present, account creation will be blocked.
|
|
||||||
|
|
||||||
### Ports
|
|
||||||
|
|
||||||
[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.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
include src/chatmaild/*.f
|
|
||||||
include src/chatmaild/ini/*.ini.f
|
|
||||||
include src/chatmaild/ini/*.ini
|
|
||||||
include src/chatmaild/tests/mail-data/*
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
# chatmaild
|
|
||||||
|
|
||||||
chatmaild provides dovecot autentication
|
|
||||||
to create dovecot users on login
|
|
||||||
and mail filtering.
|
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
[build-system]
|
|
||||||
requires = ["setuptools>=61"]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "chatmaild"
|
|
||||||
version = "0.2"
|
|
||||||
dependencies = [
|
|
||||||
"aiosmtpd",
|
|
||||||
"iniconfig",
|
|
||||||
"deltachat-rpc-server",
|
|
||||||
"deltachat-rpc-client",
|
|
||||||
"ConfigArgParse",
|
|
||||||
"deltachat",
|
|
||||||
"setuptools>=60",
|
|
||||||
"setuptools-scm>=8",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.setuptools]
|
|
||||||
include-package-data = true
|
|
||||||
|
|
||||||
[tool.setuptools.packages.find]
|
|
||||||
where = ['src']
|
|
||||||
|
|
||||||
[project.scripts]
|
|
||||||
doveauth = "chatmaild.doveauth:main"
|
|
||||||
filtermail = "chatmaild.filtermail:main"
|
|
||||||
echobot = "chatmaild.echo:main"
|
|
||||||
greeterbot = "chatmaild.greeterbot:main"
|
|
||||||
chatmail-metrics = "chatmaild.metrics:main"
|
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
|
||||||
addopts = "-v -ra --strict-markers"
|
|
||||||
log_format = "%(asctime)s %(levelname)s %(message)s"
|
|
||||||
log_date_format = "%Y-%m-%d %H:%M:%S"
|
|
||||||
log_level = "INFO"
|
|
||||||
|
|
||||||
[tool.tox]
|
|
||||||
legacy_tox_ini = """
|
|
||||||
[tox]
|
|
||||||
isolated_build = true
|
|
||||||
envlist = lint,py
|
|
||||||
|
|
||||||
[testenv:lint]
|
|
||||||
skipdist = True
|
|
||||||
skip_install = True
|
|
||||||
deps =
|
|
||||||
ruff
|
|
||||||
black
|
|
||||||
commands =
|
|
||||||
black --quiet --check --diff src/
|
|
||||||
ruff src/
|
|
||||||
|
|
||||||
[testenv]
|
|
||||||
deps = pytest
|
|
||||||
pdbpp
|
|
||||||
commands = pytest -v -rsXx {posargs}
|
|
||||||
"""
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 35 KiB |
@@ -1,59 +0,0 @@
|
|||||||
import iniconfig
|
|
||||||
|
|
||||||
|
|
||||||
def read_config(inipath):
|
|
||||||
cfg = iniconfig.IniConfig(inipath)
|
|
||||||
return Config(inipath, params=cfg.sections["params"])
|
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
|
||||||
def __init__(self, inipath, params):
|
|
||||||
self._inipath = inipath
|
|
||||||
self.mail_domain = params["mail_domain"]
|
|
||||||
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
|
||||||
self.max_mailbox_size = params["max_mailbox_size"]
|
|
||||||
self.delete_mails_after = params["delete_mails_after"]
|
|
||||||
self.username_min_length = int(params["username_min_length"])
|
|
||||||
self.username_max_length = int(params["username_max_length"])
|
|
||||||
self.password_min_length = int(params["password_min_length"])
|
|
||||||
self.passthrough_senders = params["passthrough_senders"].split()
|
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].split()
|
|
||||||
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
|
||||||
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
|
||||||
self.privacy_postal = params.get("privacy_postal")
|
|
||||||
self.privacy_mail = params.get("privacy_mail")
|
|
||||||
self.privacy_pdo = params.get("privacy_pdo")
|
|
||||||
self.privacy_supervisor = params.get("privacy_supervisor")
|
|
||||||
|
|
||||||
def _getbytefile(self):
|
|
||||||
return open(self._inipath, "rb")
|
|
||||||
|
|
||||||
|
|
||||||
def write_initial_config(inipath, mail_domain):
|
|
||||||
from importlib.resources import files
|
|
||||||
|
|
||||||
inidir = files(__package__).joinpath("ini")
|
|
||||||
content = (
|
|
||||||
inidir.joinpath("chatmail.ini.f").read_text().format(mail_domain=mail_domain)
|
|
||||||
)
|
|
||||||
if mail_domain.endswith(".testrun.org"):
|
|
||||||
override_inipath = inidir.joinpath("override-testrun.ini")
|
|
||||||
privacy = iniconfig.IniConfig(override_inipath)["privacy"]
|
|
||||||
lines = []
|
|
||||||
for line in content.split("\n"):
|
|
||||||
for key, value in privacy.items():
|
|
||||||
value_lines = value.strip().split("\n")
|
|
||||||
if not line.startswith(f"{key} =") or not value_lines:
|
|
||||||
continue
|
|
||||||
if len(value_lines) == 1:
|
|
||||||
lines.append(f"{key} = {value}")
|
|
||||||
else:
|
|
||||||
lines.append(f"{key} =")
|
|
||||||
for vl in value_lines:
|
|
||||||
lines.append(f" {vl}")
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
lines.append(line)
|
|
||||||
content = "\n".join(lines)
|
|
||||||
|
|
||||||
inipath.write_text(content)
|
|
||||||
@@ -1,139 +0,0 @@
|
|||||||
import sqlite3
|
|
||||||
import contextlib
|
|
||||||
import time
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
|
|
||||||
class DBError(Exception):
|
|
||||||
"""error during an operation on the database."""
|
|
||||||
|
|
||||||
|
|
||||||
class Connection:
|
|
||||||
def __init__(self, sqlconn, write):
|
|
||||||
self._sqlconn = sqlconn
|
|
||||||
self._write = write
|
|
||||||
|
|
||||||
def close(self):
|
|
||||||
self._sqlconn.close()
|
|
||||||
|
|
||||||
def commit(self):
|
|
||||||
self._sqlconn.commit()
|
|
||||||
|
|
||||||
def rollback(self):
|
|
||||||
self._sqlconn.rollback()
|
|
||||||
|
|
||||||
def execute(self, query, params=()):
|
|
||||||
cur = self.cursor()
|
|
||||||
try:
|
|
||||||
cur.execute(query, params)
|
|
||||||
except sqlite3.IntegrityError as e:
|
|
||||||
raise DBError(e)
|
|
||||||
return cur
|
|
||||||
|
|
||||||
def cursor(self):
|
|
||||||
return self._sqlconn.cursor()
|
|
||||||
|
|
||||||
def get_user(self, addr: str) -> {}:
|
|
||||||
"""Get a row from the users table."""
|
|
||||||
q = "SELECT addr, password, last_login from users WHERE addr = ?"
|
|
||||||
row = self._sqlconn.execute(q, (addr,)).fetchone()
|
|
||||||
result = {}
|
|
||||||
if row:
|
|
||||||
result = dict(
|
|
||||||
user=row[0],
|
|
||||||
password=row[1],
|
|
||||||
last_login=row[2],
|
|
||||||
)
|
|
||||||
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:
|
|
||||||
def __init__(self, path: str, read_only=False):
|
|
||||||
self.path = Path(path)
|
|
||||||
if not read_only:
|
|
||||||
self.ensure_tables()
|
|
||||||
|
|
||||||
def _get_connection(
|
|
||||||
self, write=False, transaction=False, closing=False
|
|
||||||
) -> Connection:
|
|
||||||
# we let the database serialize all writers at connection time
|
|
||||||
# to play it very safe (we don't have massive amounts of writes).
|
|
||||||
mode = "ro"
|
|
||||||
if write:
|
|
||||||
mode = "rw"
|
|
||||||
if not self.path.exists():
|
|
||||||
mode = "rwc"
|
|
||||||
uri = "file:%s?mode=%s" % (self.path, mode)
|
|
||||||
sqlconn = sqlite3.connect(
|
|
||||||
uri,
|
|
||||||
timeout=60,
|
|
||||||
isolation_level=None if transaction else "DEFERRED",
|
|
||||||
uri=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Enable Write-Ahead Logging to avoid readers blocking writers and vice versa.
|
|
||||||
if write:
|
|
||||||
sqlconn.execute("PRAGMA journal_mode=wal")
|
|
||||||
|
|
||||||
if transaction:
|
|
||||||
start_time = time.time()
|
|
||||||
while 1:
|
|
||||||
try:
|
|
||||||
sqlconn.execute("begin immediate")
|
|
||||||
break
|
|
||||||
except sqlite3.OperationalError:
|
|
||||||
# another thread may be writing, give it a chance to finish
|
|
||||||
time.sleep(0.1)
|
|
||||||
if time.time() - start_time > 5:
|
|
||||||
# if it takes this long, something is wrong
|
|
||||||
raise
|
|
||||||
conn = Connection(sqlconn, write=write)
|
|
||||||
if closing:
|
|
||||||
conn = contextlib.closing(conn)
|
|
||||||
return conn
|
|
||||||
|
|
||||||
@contextlib.contextmanager
|
|
||||||
def write_transaction(self):
|
|
||||||
conn = self._get_connection(closing=False, write=True, transaction=True)
|
|
||||||
try:
|
|
||||||
yield conn
|
|
||||||
except Exception:
|
|
||||||
conn.rollback()
|
|
||||||
conn.close()
|
|
||||||
raise
|
|
||||||
else:
|
|
||||||
conn.commit()
|
|
||||||
conn.close()
|
|
||||||
|
|
||||||
def read_connection(self, closing=True) -> Connection:
|
|
||||||
return self._get_connection(closing=closing, write=False)
|
|
||||||
|
|
||||||
def get_schema_version(self) -> int:
|
|
||||||
with self.read_connection() as conn:
|
|
||||||
dbversion = conn.execute("PRAGMA user_version").fetchone()[0]
|
|
||||||
return dbversion
|
|
||||||
|
|
||||||
CURRENT_DBVERSION = 1
|
|
||||||
|
|
||||||
def ensure_tables(self):
|
|
||||||
with self.write_transaction() as conn:
|
|
||||||
if self.get_schema_version() > 1:
|
|
||||||
raise DBError(
|
|
||||||
"version is %s; downgrading schema is not supported"
|
|
||||||
% (self.get_schema_version(),)
|
|
||||||
)
|
|
||||||
conn.execute(
|
|
||||||
"""
|
|
||||||
CREATE TABLE IF NOT EXISTS users (
|
|
||||||
addr TEXT PRIMARY KEY,
|
|
||||||
password TEXT,
|
|
||||||
last_login INTEGER
|
|
||||||
)
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
conn.execute("PRAGMA user_version=%s" % (self.CURRENT_DBVERSION,))
|
|
||||||
@@ -1,200 +0,0 @@
|
|||||||
import logging
|
|
||||||
import os
|
|
||||||
import time
|
|
||||||
import sys
|
|
||||||
import json
|
|
||||||
import crypt
|
|
||||||
from socketserver import (
|
|
||||||
UnixStreamServer,
|
|
||||||
StreamRequestHandler,
|
|
||||||
ThreadingMixIn,
|
|
||||||
)
|
|
||||||
import pwd
|
|
||||||
|
|
||||||
from .database import Database
|
|
||||||
from .config import read_config, Config
|
|
||||||
|
|
||||||
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
|
||||||
|
|
||||||
|
|
||||||
def encrypt_password(password: str):
|
|
||||||
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
|
||||||
passhash = crypt.crypt(password, crypt.METHOD_SHA512)
|
|
||||||
return "{SHA512-CRYPT}" + passhash
|
|
||||||
|
|
||||||
|
|
||||||
def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|
||||||
"""Return True if user and password are admissable."""
|
|
||||||
if os.path.exists(NOCREATE_FILE):
|
|
||||||
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
|
||||||
return False
|
|
||||||
|
|
||||||
if len(cleartext_password) < config.password_min_length:
|
|
||||||
logging.warning(
|
|
||||||
"Password needs to be at least %s characters long",
|
|
||||||
config.password_min_length,
|
|
||||||
)
|
|
||||||
return False
|
|
||||||
|
|
||||||
parts = user.split("@")
|
|
||||||
if len(parts) != 2:
|
|
||||||
logging.warning(f"user {user!r} is not a proper e-mail address")
|
|
||||||
return False
|
|
||||||
localpart, domain = parts
|
|
||||||
|
|
||||||
if (
|
|
||||||
len(localpart) > config.username_max_length
|
|
||||||
or len(localpart) < config.username_min_length
|
|
||||||
):
|
|
||||||
if localpart 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 True
|
|
||||||
|
|
||||||
|
|
||||||
def get_user_data(db, user):
|
|
||||||
with db.read_connection() as conn:
|
|
||||||
result = conn.get_user(user)
|
|
||||||
if result:
|
|
||||||
result["uid"] = "vmail"
|
|
||||||
result["gid"] = "vmail"
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def lookup_userdb(db, user):
|
|
||||||
return get_user_data(db, user)
|
|
||||||
|
|
||||||
|
|
||||||
def lookup_passdb(db, config: Config, user, cleartext_password):
|
|
||||||
with db.write_transaction() as conn:
|
|
||||||
userdata = conn.get_user(user)
|
|
||||||
if userdata:
|
|
||||||
# Update last login time.
|
|
||||||
conn.execute(
|
|
||||||
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
|
||||||
)
|
|
||||||
|
|
||||||
userdata["uid"] = "vmail"
|
|
||||||
userdata["gid"] = "vmail"
|
|
||||||
return userdata
|
|
||||||
if not is_allowed_to_create(config, user, cleartext_password):
|
|
||||||
return
|
|
||||||
|
|
||||||
encrypted_password = encrypt_password(cleartext_password)
|
|
||||||
q = """INSERT INTO users (addr, password, last_login)
|
|
||||||
VALUES (?, ?, ?)"""
|
|
||||||
conn.execute(q, (user, encrypted_password, int(time.time())))
|
|
||||||
return dict(
|
|
||||||
home=f"/home/vmail/mail/{config.mail_domain}/{user}",
|
|
||||||
uid="vmail",
|
|
||||||
gid="vmail",
|
|
||||||
password=encrypted_password,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def 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]
|
|
||||||
if short_command == "L": # LOOKUP
|
|
||||||
parts = msg[1:].split("\t")
|
|
||||||
|
|
||||||
# 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"
|
|
||||||
res = ""
|
|
||||||
if namespace == "shared":
|
|
||||||
if type == "userdb":
|
|
||||||
user = args[0]
|
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
|
||||||
res = lookup_userdb(db, user)
|
|
||||||
if res:
|
|
||||||
reply_command = "O"
|
|
||||||
else:
|
|
||||||
reply_command = "N"
|
|
||||||
elif type == "passdb":
|
|
||||||
user = args[1]
|
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
|
||||||
res = lookup_passdb(db, config, user, cleartext_password=args[0])
|
|
||||||
if res:
|
|
||||||
reply_command = "O"
|
|
||||||
else:
|
|
||||||
reply_command = "N"
|
|
||||||
json_res = json.dumps(res) if res else ""
|
|
||||||
return f"{reply_command}{json_res}\n"
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
|
||||||
request_queue_size = 100
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
socket = sys.argv[1]
|
|
||||||
passwd_entry = pwd.getpwnam(sys.argv[2])
|
|
||||||
db = Database(sys.argv[3])
|
|
||||||
config = read_config(sys.argv[4])
|
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
|
||||||
def handle(self):
|
|
||||||
try:
|
|
||||||
while True:
|
|
||||||
msg = self.rfile.readline().strip().decode()
|
|
||||||
if not msg:
|
|
||||||
break
|
|
||||||
res = handle_dovecot_request(msg, db, config)
|
|
||||||
if res:
|
|
||||||
self.wfile.write(res.encode("ascii"))
|
|
||||||
self.wfile.flush()
|
|
||||||
else:
|
|
||||||
logging.warn("request had no answer: %r", msg)
|
|
||||||
except Exception:
|
|
||||||
logging.exception("Exception in the handler")
|
|
||||||
raise
|
|
||||||
|
|
||||||
try:
|
|
||||||
os.unlink(socket)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
with ThreadedUnixStreamServer(socket, Handler) as server:
|
|
||||||
os.chown(socket, uid=passwd_entry.pw_uid, gid=passwd_entry.pw_gid)
|
|
||||||
try:
|
|
||||||
server.serve_forever()
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
pass
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail dict authentication proxy for dovecot
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite {config_path}
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Advanced echo bot example.
|
|
||||||
|
|
||||||
it will echo back any message that has non-empty text and also supports the /help command.
|
|
||||||
"""
|
|
||||||
import logging
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
|
|
||||||
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()
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail echo bot for testing it works
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} {config_path}
|
|
||||||
Environment="PATH={remote_venv_dir}:$PATH"
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
Binary file not shown.
@@ -1,163 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
import asyncio
|
|
||||||
import logging
|
|
||||||
import time
|
|
||||||
import sys
|
|
||||||
from email.parser import BytesParser
|
|
||||||
from email import policy
|
|
||||||
from email.utils import parseaddr
|
|
||||||
|
|
||||||
from aiosmtpd.controller import Controller
|
|
||||||
from smtplib import SMTP as SMTPClient
|
|
||||||
|
|
||||||
from .config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def check_encrypted(message):
|
|
||||||
"""Check that the message is an OpenPGP-encrypted message."""
|
|
||||||
if not message.is_multipart():
|
|
||||||
return False
|
|
||||||
if message.get("subject") != "...":
|
|
||||||
return False
|
|
||||||
if message.get_content_type() != "multipart/encrypted":
|
|
||||||
return False
|
|
||||||
parts_count = 0
|
|
||||||
for part in message.iter_parts():
|
|
||||||
if parts_count == 0:
|
|
||||||
if part.get_content_type() != "application/pgp-encrypted":
|
|
||||||
return False
|
|
||||||
elif parts_count == 1:
|
|
||||||
if part.get_content_type() != "application/octet-stream":
|
|
||||||
return False
|
|
||||||
else:
|
|
||||||
return False
|
|
||||||
parts_count += 1
|
|
||||||
return True
|
|
||||||
|
|
||||||
|
|
||||||
def check_mdn(message, envelope):
|
|
||||||
if len(envelope.rcpt_tos) != 1:
|
|
||||||
return False
|
|
||||||
|
|
||||||
for name in ["auto-submitted", "chat-version"]:
|
|
||||||
if not message.get(name):
|
|
||||||
return False
|
|
||||||
|
|
||||||
if message.get_content_type() != "multipart/report":
|
|
||||||
return False
|
|
||||||
|
|
||||||
body = message.get_body()
|
|
||||||
if body.get_content_type() != "text/plain":
|
|
||||||
return False
|
|
||||||
|
|
||||||
if list(body.iter_attachments()) or list(body.iter_parts()):
|
|
||||||
return False
|
|
||||||
|
|
||||||
# even with all mime-structural checks an attacker
|
|
||||||
# could try to abuse the subject or body to contain links or other
|
|
||||||
# annoyance -- we skip on checking subject/body for now as Delta Chat
|
|
||||||
# should evolve to create E2E-encrypted read receipts anyway.
|
|
||||||
# and then MDNs are just encrypted mail and can pass the border
|
|
||||||
# to other instances.
|
|
||||||
|
|
||||||
return True
|
|
||||||
|
|
||||||
|
|
||||||
async def asyncmain_beforequeue(config):
|
|
||||||
port = config.filtermail_smtp_port
|
|
||||||
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
|
||||||
|
|
||||||
|
|
||||||
class BeforeQueueHandler:
|
|
||||||
def __init__(self, config):
|
|
||||||
self.config = config
|
|
||||||
self.send_rate_limiter = SendRateLimiter()
|
|
||||||
|
|
||||||
async def handle_MAIL(self, server, session, envelope, address, mail_options):
|
|
||||||
logging.info(f"handle_MAIL from {address}")
|
|
||||||
envelope.mail_from = address
|
|
||||||
max_sent = self.config.max_user_send_per_minute
|
|
||||||
if not self.send_rate_limiter.is_sending_allowed(address, max_sent):
|
|
||||||
return f"450 4.7.1: Too much mail from {address}"
|
|
||||||
|
|
||||||
parts = envelope.mail_from.split("@")
|
|
||||||
if len(parts) != 2:
|
|
||||||
return f"500 Invalid from address <{envelope.mail_from!r}>"
|
|
||||||
|
|
||||||
return "250 OK"
|
|
||||||
|
|
||||||
async def handle_DATA(self, server, session, envelope):
|
|
||||||
logging.info("handle_DATA before-queue")
|
|
||||||
error = self.check_DATA(envelope)
|
|
||||||
if error:
|
|
||||||
return error
|
|
||||||
logging.info("re-injecting the mail that passed checks")
|
|
||||||
client = SMTPClient("localhost", self.config.postfix_reinject_port)
|
|
||||||
client.sendmail(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
|
||||||
return "250 OK"
|
|
||||||
|
|
||||||
def check_DATA(self, envelope):
|
|
||||||
"""the central filtering function for e-mails."""
|
|
||||||
logging.info(f"Processing DATA message from {envelope.mail_from}")
|
|
||||||
|
|
||||||
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
|
||||||
mail_encrypted = check_encrypted(message)
|
|
||||||
|
|
||||||
_, from_addr = parseaddr(message.get("from").strip())
|
|
||||||
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
|
||||||
if envelope.mail_from.lower() != from_addr.lower():
|
|
||||||
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
|
||||||
|
|
||||||
if not mail_encrypted and check_mdn(message, envelope):
|
|
||||||
return
|
|
||||||
|
|
||||||
if envelope.mail_from in self.config.passthrough_senders:
|
|
||||||
return
|
|
||||||
|
|
||||||
passthrough_recipients = self.config.passthrough_recipients
|
|
||||||
envelope_from_domain = from_addr.split("@").pop()
|
|
||||||
for recipient in envelope.rcpt_tos:
|
|
||||||
if envelope.mail_from == recipient:
|
|
||||||
# Always allow sending emails to self.
|
|
||||||
continue
|
|
||||||
if recipient in passthrough_recipients:
|
|
||||||
continue
|
|
||||||
res = recipient.split("@")
|
|
||||||
if len(res) != 2:
|
|
||||||
return f"500 Invalid address <{recipient}>"
|
|
||||||
_recipient_addr, recipient_domain = res
|
|
||||||
|
|
||||||
is_outgoing = recipient_domain != envelope_from_domain
|
|
||||||
if is_outgoing and not mail_encrypted:
|
|
||||||
is_securejoin = message.get("secure-join") in [
|
|
||||||
"vc-request",
|
|
||||||
"vg-request",
|
|
||||||
]
|
|
||||||
if not is_securejoin:
|
|
||||||
return f"500 Invalid unencrypted mail to <{recipient}>"
|
|
||||||
|
|
||||||
|
|
||||||
class SendRateLimiter:
|
|
||||||
def __init__(self):
|
|
||||||
self.addr2timestamps = {}
|
|
||||||
|
|
||||||
def is_sending_allowed(self, mail_from, max_send_per_minute):
|
|
||||||
last = self.addr2timestamps.setdefault(mail_from, [])
|
|
||||||
now = time.time()
|
|
||||||
last[:] = [ts for ts in last if ts >= (now - 60)]
|
|
||||||
if len(last) <= max_send_per_minute:
|
|
||||||
last.append(now)
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
args = sys.argv[1:]
|
|
||||||
assert len(args) == 1
|
|
||||||
config = read_config(args[0])
|
|
||||||
logging.basicConfig(level=logging.WARN)
|
|
||||||
loop = asyncio.new_event_loop()
|
|
||||||
asyncio.set_event_loop(loop)
|
|
||||||
task = asyncmain_beforequeue(config)
|
|
||||||
loop.create_task(task)
|
|
||||||
loop.run_forever()
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Chatmail Postfix BeforeQeue filter
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={execpath} {config_path}
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,132 +0,0 @@
|
|||||||
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()
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[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,63 +0,0 @@
|
|||||||
[params]
|
|
||||||
|
|
||||||
# mail domain (MUST be set to fully qualified chat mail domain)
|
|
||||||
mail_domain = {mail_domain}
|
|
||||||
|
|
||||||
#
|
|
||||||
# If you only do private test deploys, you don't need to modify any settings below
|
|
||||||
#
|
|
||||||
|
|
||||||
#
|
|
||||||
# Account Restrictions
|
|
||||||
#
|
|
||||||
|
|
||||||
# how many mails a user can send out per minute
|
|
||||||
max_user_send_per_minute = 60
|
|
||||||
|
|
||||||
# maximum mailbox size of a chatmail account
|
|
||||||
max_mailbox_size = 100M
|
|
||||||
|
|
||||||
# days after which mails are unconditionally deleted
|
|
||||||
delete_mails_after = 40
|
|
||||||
|
|
||||||
# minimum length a username must have
|
|
||||||
username_min_length = 9
|
|
||||||
|
|
||||||
# maximum length a username can have
|
|
||||||
username_max_length = 9
|
|
||||||
|
|
||||||
# minimum length a password must have
|
|
||||||
password_min_length = 9
|
|
||||||
|
|
||||||
# list of chatmail accounts which can send outbound un-encrypted mail
|
|
||||||
passthrough_senders =
|
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
|
||||||
passthrough_recipients =
|
|
||||||
|
|
||||||
#
|
|
||||||
# Deployment Details
|
|
||||||
#
|
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
|
|
||||||
# postfix accepts on the localhost reinject SMTP port
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
|
|
||||||
#
|
|
||||||
# Privacy Policy
|
|
||||||
#
|
|
||||||
|
|
||||||
# postal address of privacy contact
|
|
||||||
privacy_postal =
|
|
||||||
|
|
||||||
# email address of privacy contact
|
|
||||||
privacy_mail =
|
|
||||||
|
|
||||||
# postal address of the privacy data officer
|
|
||||||
privacy_pdo =
|
|
||||||
|
|
||||||
# postal address of the privacy supervisor
|
|
||||||
privacy_supervisor =
|
|
||||||
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
|
|
||||||
[privacy]
|
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org
|
|
||||||
|
|
||||||
privacy_postal =
|
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
|
||||||
Reichgrafen Str. 20, 79102 Freiburg, Germany
|
|
||||||
|
|
||||||
privacy_mail = privacy@testrun.org
|
|
||||||
privacy_pdo =
|
|
||||||
Prof. Dr. Fabian Schmieder, lexICT UG (limited), Ostfeldstr. 49, 30559 Hannover.
|
|
||||||
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
|
||||||
privacy_supervisor =
|
|
||||||
State Commissioner for Data Protection and Freedom of Information of
|
|
||||||
Baden-Württemberg in 70173 Stuttgart, Germany.
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
from pathlib import Path
|
|
||||||
import time
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def main(vmail_dir=None):
|
|
||||||
if vmail_dir is None:
|
|
||||||
vmail_dir = sys.argv[1]
|
|
||||||
|
|
||||||
accounts = 0
|
|
||||||
ci_accounts = 0
|
|
||||||
|
|
||||||
for path in Path(vmail_dir).iterdir():
|
|
||||||
accounts += 1
|
|
||||||
if path.name[:3] in ("ci-", "ac_"):
|
|
||||||
ci_accounts += 1
|
|
||||||
|
|
||||||
timestamp = int(time.time() * 1000)
|
|
||||||
print(f"accounts {accounts} {timestamp}")
|
|
||||||
print(f"ci_accounts {ci_accounts} {timestamp}")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
#!/usr/local/lib/chatmaild/venv/bin/python3
|
|
||||||
|
|
||||||
""" CGI script for creating new accounts. """
|
|
||||||
|
|
||||||
import json
|
|
||||||
import random
|
|
||||||
import secrets
|
|
||||||
import string
|
|
||||||
|
|
||||||
from chatmaild.config import read_config, Config
|
|
||||||
|
|
||||||
CONFIG_PATH = "/usr/local/lib/chatmaild/chatmail.ini"
|
|
||||||
ALPHANUMERIC = string.ascii_lowercase + string.digits
|
|
||||||
ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
|
||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(config: Config):
|
|
||||||
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
|
||||||
password = "".join(
|
|
||||||
secrets.choice(ALPHANUMERIC_PUNCT)
|
|
||||||
for _ in range(config.password_min_length + 3)
|
|
||||||
)
|
|
||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
|
||||||
config = read_config(CONFIG_PATH)
|
|
||||||
creds = create_newemail_dict(config)
|
|
||||||
|
|
||||||
print("Content-Type: application/json")
|
|
||||||
print("")
|
|
||||||
print(json.dumps(creds))
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
print_new_account()
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
From: {from_addr}
|
|
||||||
To: {to_addr}
|
|
||||||
Subject: ...
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
|
||||||
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
|
||||||
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
|
||||||
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
|
||||||
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
|
||||||
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
|
||||||
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
|
||||||
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
|
||||||
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
|
||||||
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
|
||||||
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
|
||||||
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
|
||||||
Content-Description: PGP/MIME version identification
|
|
||||||
Content-Type: application/pgp-encrypted
|
|
||||||
|
|
||||||
Version: 1
|
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
|
||||||
Content-Description: OpenPGP encrypted message
|
|
||||||
Content-Disposition: inline; filename="encrypted.asc";
|
|
||||||
Content-Type: application/octet-stream; name="encrypted.asc"
|
|
||||||
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
|
||||||
|
|
||||||
wU4DhW3gBZ/VvCYSAQdA8bMs2spwbKdGjVsL1ByPkNrqD7frpB73maeL6I6SzDYg
|
|
||||||
O5G53tv339RdKq3WRcCtEEvxjHlUx2XNwXzC04BpmfvBTgNfPUyLDzjXnxIBB0Ae
|
|
||||||
8ymwGvXMCCimHXN0Dg8Ui62KOi03h0UgheoHWovJSCDF4CKre/xtFr3nL7lq/PKI
|
|
||||||
JsjVNz7/RK9FSXF6WwfONtLCyQGEuVAsB/KXfCBEyfKhaMwGHvhujRidGW5uV1no
|
|
||||||
lMGl3ODmo29Lgeu2uSE7EpJRZoe6hU6ddmBkqxax61ZtkaFlGFFpdo2K8balNNdz
|
|
||||||
ZsJ/9mmI9x3oOJ4/l1nhQbUO9ADbs7gJhFdV5Qkp30b5fCI7bU+aoe1ccBbLe/WM
|
|
||||||
YUty1PqcuQT7XjA+XmYuL261tvW8pBetT+i33/E2d8PzzYt2IuK9qeevyS+yxdwA
|
|
||||||
kfwejFWzzsUlJaDxs1x4XOxkMgSj+jo+g12dFOb7fyClsAnq23iDb8AuaT/BScAI
|
|
||||||
+lO+gher69+6LmM7VGHLG5k762J1jTaQCaKt1s8TAWV99Eo4491vL6fyvk3l/Cfg
|
|
||||||
RXSwiWFgj19Pn0Rq7CD9v22UE2vdUMBTcV4aw79mClk1YQ23jbF0y5DCjPdJ62Zo
|
|
||||||
tskBgFt3NoWV80jZ76zIBLrrjLwCCll8JjJtFwSkt2GX5RFBsVa4A8IDht9RtEk7
|
|
||||||
rrHgbSZQfkauEi/mH3/6CDZoLqSHudUZ7d4MaJwun1TkFYGe2ORwGJd4OBj3oGJp
|
|
||||||
H8YBwCpk///L/fKjX0Gg3M8nrpM4wrRFhPKidAgO/kcm25X4+ZHlVkWBTCt5RWKI
|
|
||||||
fHh6oLDZCqCfcgMkE1KKmwfIHaUkhq5BPRigwy6i5dh1DM4+1UCLh3dxzVbqE9b9
|
|
||||||
61NB19nXdRtDA2sOUnj9ve6m/wEPyCb6/zBQZqvCBYb1/AjdXpUrFT+DbpfyxaXN
|
|
||||||
XfhDVb5mNqNM/IVj0V5fvTc6vOfYbzQtPm10H+FdWWfb+rJRfyC3MA2w2IqstFe3
|
|
||||||
w3bu2iE6CQvSqRvge+ZqLKt/NqYwOURiUmpuklbl3kPJ97+mfKWoiqk8Iz1VY+bb
|
|
||||||
NMUC7aoGv+jcoj+WS6PYO8N6BeRVUUB3ZJSf8nzjgxm1/BcM+UD3BPrlhT11ODRs
|
|
||||||
baifGbprMWwt3dhb8cQgRT8GPdpO1OsDkzL6iikMjLHWWiA99GV6ruiHsIPw6boW
|
|
||||||
A6/uSOskbDHOROotKmddGTBd0iiHXAoQsJFt1ZjUkt6EHrgWs+GAvrvKpXs1mrz8
|
|
||||||
uj3GwEFrHS+Xuf2UDgpszYT3hI2cL/kUtGakVR7m7vVMZqXBUbZdGAEb1PZNPwsI
|
|
||||||
E4aMK02+EVB+tSN4Fzj99N2YD0inVYt+oPjr2tHhUS6aSGBNS/48Ki47DOg4Sxkn
|
|
||||||
lkOWnEbCD+XTnbDd
|
|
||||||
=agR5
|
|
||||||
-----END PGP MESSAGE-----
|
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=
|
|
||||||
Chat-Disposition-Notification-To: foobar@c2.testrun.org
|
|
||||||
Chat-User-Avatar: 0
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:41:44 +0000
|
|
||||||
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
|
||||||
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
|
||||||
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
|
||||||
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
|
||||||
HjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK
|
|
||||||
KwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ
|
|
||||||
JlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI
|
|
||||||
vYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
|
||||||
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
|
||||||
Hi!
|
|
||||||
-----END PGP MESSAGE-----
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
Subject: Message opened
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:25 +0000
|
|
||||||
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
|
|
||||||
Auto-Submitted: auto-replied
|
|
||||||
Chat-Version: 1.0
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/report; report-type=disposition-notification;
|
|
||||||
boundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
|
||||||
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
|
||||||
|
|
||||||
The "Hi!" message you sent was displayed on the screen of the recipient.
|
|
||||||
|
|
||||||
This is no guarantee the content was read.
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
|
||||||
Content-Type: message/disposition-notification
|
|
||||||
|
|
||||||
Reporting-UA: Delta Chat 1.124.1
|
|
||||||
Original-Recipient: rfc822;barbaz@c2.testrun.org
|
|
||||||
Final-Recipient: rfc822;barbaz@c2.testrun.org
|
|
||||||
Original-Message-ID: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
Disposition: manual-action/MDN-sent-automatically; displayed
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=
|
|
||||||
Chat-Disposition-Notification-To: foobar@c2.testrun.org
|
|
||||||
Chat-User-Avatar: 0
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:41:44 +0000
|
|
||||||
Message-ID: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
|
||||||
keydata=xjMEZSrw3hYJKwYBBAHaRw8BAQdAiEKNQFU28c6qsx4vo/JHdt73RXdjMOmByf/XsGiJ7m
|
|
||||||
nNFzxmb29iYXJAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUq8N4CGwMECwkIBwYVCAkKCwID
|
|
||||||
FgIBFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJCX3gEAhm0MehE5byBBU1avPczr/I
|
|
||||||
HjNLht7Qf6++mAhlJmtDcA/0C8VYJhsUpmiDjuZaMDWNv4FO2BJG6LH7gSm6n7ClMJzjgEZSrw3hIK
|
|
||||||
KwYBBAGXVQEFAQEHQAxGG/QW0owCfMp1A+vXEMwgzWcBpNFr58kX2eXuPpM6AwEIB8J4BBgWCAAgBQ
|
|
||||||
JlKvDeAhsMFiEEGil0OvTIa6RngmCLUYNnEa9leJAACgkQUYNnEa9leJDg1gEAwLf8KDoAAKyYgjyI
|
|
||||||
vYvO9VEgBni1C4Xx1VjcaEmlDK8BALoFuUCK+enw76TtDcAUKhlhUiM6SDRExkS4Nskp/BcK
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=no
|
|
||||||
|
|
||||||
Hi!
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
import random
|
|
||||||
import importlib.resources
|
|
||||||
import itertools
|
|
||||||
from email.parser import BytesParser
|
|
||||||
from email import policy
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from chatmaild.database import Database
|
|
||||||
from chatmaild.config import read_config, write_initial_config
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def make_config(tmp_path):
|
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
|
||||||
|
|
||||||
def make_conf(mail_domain):
|
|
||||||
write_initial_config(inipath, mail_domain=mail_domain)
|
|
||||||
return read_config(inipath)
|
|
||||||
|
|
||||||
return make_conf
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def example_config(make_config):
|
|
||||||
return make_config("chat.example.org")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildomain(example_config):
|
|
||||||
return example_config.mail_domain
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def gencreds(maildomain):
|
|
||||||
count = itertools.count()
|
|
||||||
next(count)
|
|
||||||
|
|
||||||
def gen(domain=None):
|
|
||||||
domain = domain if domain else maildomain
|
|
||||||
while 1:
|
|
||||||
num = next(count)
|
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
|
||||||
user = "".join(random.choices(alphanumeric, k=10))
|
|
||||||
user = f"ac{num}_{user}"[:9]
|
|
||||||
password = "".join(random.choices(alphanumeric, k=12))
|
|
||||||
yield f"{user}@{domain}", f"{password}"
|
|
||||||
|
|
||||||
return lambda domain=None: next(gen(domain))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def db(tmpdir):
|
|
||||||
db_path = tmpdir / "passdb.sqlite"
|
|
||||||
print("database path:", db_path)
|
|
||||||
return Database(db_path)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildata(request):
|
|
||||||
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
|
||||||
assert datadir.exists(), datadir
|
|
||||||
|
|
||||||
def maildata(name, from_addr, to_addr):
|
|
||||||
data = datadir.joinpath(name).read_text()
|
|
||||||
text = data.format(from_addr=from_addr, to_addr=to_addr)
|
|
||||||
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
|
||||||
|
|
||||||
return maildata
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_basic(example_config):
|
|
||||||
assert example_config.mail_domain == "chat.example.org"
|
|
||||||
assert not example_config.privacy_supervisor and not example_config.privacy_mail
|
|
||||||
assert not example_config.privacy_pdo and not example_config.privacy_postal
|
|
||||||
|
|
||||||
inipath = example_config._inipath
|
|
||||||
inipath.write_text(inipath.read_text().replace("60", "37"))
|
|
||||||
example_config = read_config(inipath)
|
|
||||||
assert example_config.max_user_send_per_minute == 37
|
|
||||||
assert example_config.mail_domain == "chat.example.org"
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_testrun(make_config):
|
|
||||||
config = make_config("something.testrun.org")
|
|
||||||
assert config.mail_domain == "something.testrun.org"
|
|
||||||
assert len(config.privacy_postal.split("\n")) > 1
|
|
||||||
assert len(config.privacy_supervisor.split("\n")) > 1
|
|
||||||
assert len(config.privacy_pdo.split("\n")) > 1
|
|
||||||
assert config.privacy_mail == "privacy@testrun.org"
|
|
||||||
assert config.filtermail_smtp_port == 10080
|
|
||||||
assert config.postfix_reinject_port == 10025
|
|
||||||
assert config.max_user_send_per_minute == 60
|
|
||||||
assert config.max_mailbox_size == "100M"
|
|
||||||
assert config.delete_mails_after == "40"
|
|
||||||
assert config.username_min_length == 9
|
|
||||||
assert config.username_max_length == 9
|
|
||||||
assert config.password_min_length == 9
|
|
||||||
assert config.passthrough_recipients == ["privacy@testrun.org"]
|
|
||||||
assert config.passthrough_senders == []
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
import json
|
|
||||||
import pytest
|
|
||||||
import threading
|
|
||||||
import queue
|
|
||||||
import traceback
|
|
||||||
|
|
||||||
import chatmaild.doveauth
|
|
||||||
from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_request
|
|
||||||
from chatmaild.database import DBError
|
|
||||||
|
|
||||||
|
|
||||||
def test_basic(db, example_config):
|
|
||||||
lookup_passdb(db, example_config, "asdf12345@chat.example.org", "q9mr3faue")
|
|
||||||
data = get_user_data(db, "asdf12345@chat.example.org")
|
|
||||||
assert data
|
|
||||||
data2 = lookup_passdb(
|
|
||||||
db, example_config, "asdf12345@chat.example.org", "q9mr3jewvadsfaue"
|
|
||||||
)
|
|
||||||
assert data == data2
|
|
||||||
|
|
||||||
|
|
||||||
def test_dont_overwrite_password_on_wrong_login(db, example_config):
|
|
||||||
"""Test that logging in with a different password doesn't create a new user"""
|
|
||||||
res = lookup_passdb(
|
|
||||||
db, example_config, "newuser12@chat.example.org", "kajdlkajsldk12l3kj1983"
|
|
||||||
)
|
|
||||||
assert res["password"]
|
|
||||||
res2 = lookup_passdb(db, example_config, "newuser12@chat.example.org", "kajdslqwe")
|
|
||||||
# this function always returns a password hash, which is actually compared by dovecot.
|
|
||||||
assert res["password"] == res2["password"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_nocreate_file(db, monkeypatch, tmpdir, example_config):
|
|
||||||
p = tmpdir.join("nocreate")
|
|
||||||
p.write("")
|
|
||||||
monkeypatch.setattr(chatmaild.doveauth, "NOCREATE_FILE", str(p))
|
|
||||||
lookup_passdb(
|
|
||||||
db, example_config, "newuser12@chat.example.org", "zequ0Aimuchoodaechik"
|
|
||||||
)
|
|
||||||
assert not get_user_data(db, "newuser12@chat.example.org")
|
|
||||||
|
|
||||||
|
|
||||||
def test_db_version(db):
|
|
||||||
assert db.get_schema_version() == 1
|
|
||||||
|
|
||||||
|
|
||||||
def test_too_high_db_version(db):
|
|
||||||
with db.write_transaction() as conn:
|
|
||||||
conn.execute("PRAGMA user_version=%s;" % (999,))
|
|
||||||
with pytest.raises(DBError):
|
|
||||||
db.ensure_tables()
|
|
||||||
|
|
||||||
|
|
||||||
def test_handle_dovecot_request(db, example_config):
|
|
||||||
# Test that password can contain ", ', \ and /
|
|
||||||
msg = (
|
|
||||||
'Lshared/passdb/laksjdlaksjdlak\\\\sjdlk\\"12j\\\'3l1/k2j3123"'
|
|
||||||
"some42123@chat.example.org\tsome42123@chat.example.org"
|
|
||||||
)
|
|
||||||
res = handle_dovecot_request(msg, db, example_config)
|
|
||||||
assert res
|
|
||||||
assert res[0] == "O" and res.endswith("\n")
|
|
||||||
userdata = json.loads(res[1:].strip())
|
|
||||||
assert (
|
|
||||||
userdata["home"]
|
|
||||||
== "/home/vmail/mail/chat.example.org/some42123@chat.example.org"
|
|
||||||
)
|
|
||||||
assert userdata["uid"] == userdata["gid"] == "vmail"
|
|
||||||
assert userdata["password"].startswith("{SHA512-CRYPT}")
|
|
||||||
|
|
||||||
|
|
||||||
def test_50_concurrent_lookups_different_accounts(db, gencreds, example_config):
|
|
||||||
num_threads = 50
|
|
||||||
req_per_thread = 5
|
|
||||||
results = queue.Queue()
|
|
||||||
|
|
||||||
def lookup(db):
|
|
||||||
for i in range(req_per_thread):
|
|
||||||
addr, password = gencreds()
|
|
||||||
try:
|
|
||||||
lookup_passdb(db, example_config, addr, password)
|
|
||||||
except Exception:
|
|
||||||
results.put(traceback.format_exc())
|
|
||||||
else:
|
|
||||||
results.put(None)
|
|
||||||
|
|
||||||
threads = []
|
|
||||||
for i in range(num_threads):
|
|
||||||
thread = threading.Thread(target=lookup, args=(db,), daemon=True)
|
|
||||||
threads.append(thread)
|
|
||||||
|
|
||||||
print(f"created {num_threads} threads, starting them and waiting for results")
|
|
||||||
for thread in threads:
|
|
||||||
thread.start()
|
|
||||||
|
|
||||||
for i in range(num_threads * req_per_thread):
|
|
||||||
res = results.get()
|
|
||||||
if res is not None:
|
|
||||||
pytest.fail(f"concurrent lookup failed\n{res}")
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
from chatmaild.filtermail import (
|
|
||||||
check_encrypted,
|
|
||||||
BeforeQueueHandler,
|
|
||||||
SendRateLimiter,
|
|
||||||
check_mdn,
|
|
||||||
)
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildomain():
|
|
||||||
# let's not depend on a real chatmail instance for the offline tests below
|
|
||||||
return "chatmail.example.org"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def handler(make_config, maildomain):
|
|
||||||
config = make_config(maildomain)
|
|
||||||
return BeforeQueueHandler(config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_reject_forged_from(maildata, gencreds, handler):
|
|
||||||
class env:
|
|
||||||
mail_from = gencreds()[0]
|
|
||||||
rcpt_tos = [gencreds()[0]]
|
|
||||||
|
|
||||||
# test that the filter lets good mail through
|
|
||||||
to_addr = gencreds()[0]
|
|
||||||
env.content = maildata(
|
|
||||||
"plain.eml", from_addr=env.mail_from, to_addr=to_addr
|
|
||||||
).as_bytes()
|
|
||||||
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
# test that the filter rejects forged mail
|
|
||||||
env.content = maildata(
|
|
||||||
"plain.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
|
||||||
).as_bytes()
|
|
||||||
error = handler.check_DATA(envelope=env)
|
|
||||||
assert "500" in error
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_no_encryption_detection(maildata):
|
|
||||||
msg = maildata(
|
|
||||||
"plain.eml", from_addr="some@example.org", to_addr="other@example.org"
|
|
||||||
)
|
|
||||||
assert not check_encrypted(msg)
|
|
||||||
|
|
||||||
# https://xkcd.com/1181/
|
|
||||||
msg = maildata(
|
|
||||||
"fake-encrypted.eml", from_addr="some@example.org", to_addr="other@example.org"
|
|
||||||
)
|
|
||||||
assert not check_encrypted(msg)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_encryption_detection(maildata):
|
|
||||||
msg = maildata("encrypted.eml", from_addr="1@example.org", to_addr="2@example.org")
|
|
||||||
assert check_encrypted(msg)
|
|
||||||
|
|
||||||
# if the subject is not "..." it is not considered ac-encrypted
|
|
||||||
msg.replace_header("Subject", "Click this link")
|
|
||||||
assert not check_encrypted(msg)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_is_mdn(maildata, gencreds, handler):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = gencreds()[0] + ".other"
|
|
||||||
msg = maildata("mdn.eml", from_addr, to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert check_mdn(msg, env)
|
|
||||||
print(msg.as_string())
|
|
||||||
|
|
||||||
assert not handler.check_DATA(env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_to_multiple_recipients_no_mdn(maildata, gencreds):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = gencreds()[0] + ".other"
|
|
||||||
thirdaddr = gencreds()[0]
|
|
||||||
msg = maildata("mdn.eml", from_addr, to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr, thirdaddr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert not check_mdn(msg, env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_send_rate_limiter():
|
|
||||||
limiter = SendRateLimiter()
|
|
||||||
for i in range(100):
|
|
||||||
if limiter.is_sending_allowed("some@example.org", 10):
|
|
||||||
if i <= 10:
|
|
||||||
continue
|
|
||||||
pytest.fail("limiter didn't work")
|
|
||||||
else:
|
|
||||||
assert i == 11
|
|
||||||
break
|
|
||||||
|
|
||||||
|
|
||||||
def test_excempt_privacy(maildata, gencreds, handler):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = "privacy@testrun.org"
|
|
||||||
handler.config.passthrough_recipients = [to_addr]
|
|
||||||
false_to = "privacy@something.org"
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", from_addr, to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
# assert that None/no error is returned
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
class env2:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr, false_to]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
|
||||||
|
|
||||||
|
|
||||||
def test_passthrough_senders(gencreds, handler, maildata):
|
|
||||||
acc1 = gencreds()[0]
|
|
||||||
to_addr = "recipient@something.org"
|
|
||||||
handler.config.passthrough_senders = [acc1]
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", acc1, to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = acc1
|
|
||||||
rcpt_tos = to_addr
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
# assert that None/no error is returned
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
from chatmaild.metrics import main
|
|
||||||
|
|
||||||
|
|
||||||
def test_main(tmp_path, capsys):
|
|
||||||
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
|
||||||
tmp_path.joinpath(x).mkdir()
|
|
||||||
main(tmp_path)
|
|
||||||
out, _ = capsys.readouterr()
|
|
||||||
d = {}
|
|
||||||
for line in out.split("\n"):
|
|
||||||
if line.strip():
|
|
||||||
name, num, _ = line.split()
|
|
||||||
d[name] = int(num)
|
|
||||||
|
|
||||||
assert d["accounts"] == 4
|
|
||||||
assert d["ci_accounts"] == 3
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import json
|
|
||||||
|
|
||||||
import chatmaild
|
|
||||||
from chatmaild.newemail import create_newemail_dict, print_new_account
|
|
||||||
|
|
||||||
|
|
||||||
def test_create_newemail_dict(example_config):
|
|
||||||
ac1 = create_newemail_dict(example_config)
|
|
||||||
assert "@" in ac1["email"]
|
|
||||||
assert len(ac1["password"]) >= 10
|
|
||||||
|
|
||||||
ac2 = create_newemail_dict(example_config)
|
|
||||||
|
|
||||||
assert ac1["email"] != ac2["email"]
|
|
||||||
assert ac1["password"] != ac2["password"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
|
||||||
print_new_account()
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
lines = out.split("\n")
|
|
||||||
assert lines[0] == "Content-Type: application/json"
|
|
||||||
assert not lines[1]
|
|
||||||
dic = json.loads(lines[2])
|
|
||||||
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
|
||||||
assert len(dic["password"]) >= 10
|
|
||||||
Binary file not shown.
@@ -1,32 +0,0 @@
|
|||||||
[build-system]
|
|
||||||
requires = ["setuptools>=68"]
|
|
||||||
build-backend = "setuptools.build_meta"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "cmdeploy"
|
|
||||||
version = "0.2"
|
|
||||||
dependencies = [
|
|
||||||
"pyinfra",
|
|
||||||
"pillow",
|
|
||||||
"qrcode",
|
|
||||||
"markdown",
|
|
||||||
"pytest",
|
|
||||||
"setuptools>=68",
|
|
||||||
"termcolor",
|
|
||||||
"build",
|
|
||||||
"tox",
|
|
||||||
"ruff",
|
|
||||||
"black",
|
|
||||||
"pytest",
|
|
||||||
"pytest-xdist",
|
|
||||||
]
|
|
||||||
|
|
||||||
[project.scripts]
|
|
||||||
cmdeploy = "cmdeploy.cmdeploy:main"
|
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
|
||||||
"cmdeploy.testplugin" = "cmdeploy.tests.plugin"
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
|
||||||
addopts = "-v -ra --strict-markers"
|
|
||||||
@@ -1,561 +0,0 @@
|
|||||||
"""
|
|
||||||
Chat Mail pyinfra deploy.
|
|
||||||
"""
|
|
||||||
import sys
|
|
||||||
import importlib.resources
|
|
||||||
import subprocess
|
|
||||||
import shutil
|
|
||||||
import io
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.operations import apt, files, server, systemd, pip
|
|
||||||
from pyinfra.facts.files import File
|
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
|
||||||
from .acmetool import deploy_acmetool
|
|
||||||
|
|
||||||
from chatmaild.config import read_config, Config
|
|
||||||
|
|
||||||
|
|
||||||
def _build_chatmaild(dist_dir) -> None:
|
|
||||||
dist_dir = Path(dist_dir).resolve()
|
|
||||||
if dist_dir.exists():
|
|
||||||
shutil.rmtree(dist_dir)
|
|
||||||
dist_dir.mkdir()
|
|
||||||
subprocess.check_output(
|
|
||||||
[sys.executable, "-m", "build", "-n"]
|
|
||||||
+ ["--sdist", "chatmaild", "--outdir", str(dist_dir)]
|
|
||||||
)
|
|
||||||
entries = list(dist_dir.iterdir())
|
|
||||||
assert len(entries) == 1
|
|
||||||
return entries[0]
|
|
||||||
|
|
||||||
|
|
||||||
def remove_legacy_artifacts():
|
|
||||||
# disable legacy doveauth-dictproxy.service
|
|
||||||
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Disable legacy doveauth-dictproxy.service",
|
|
||||||
service="doveauth-dictproxy.service",
|
|
||||||
running=False,
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _install_remote_venv_with_chatmaild(config) -> None:
|
|
||||||
remove_legacy_artifacts()
|
|
||||||
dist_file = _build_chatmaild(dist_dir=Path("chatmaild/dist"))
|
|
||||||
remote_base_dir = "/usr/local/lib/chatmaild"
|
|
||||||
remote_dist_file = f"{remote_base_dir}/dist/{dist_file.name}"
|
|
||||||
remote_venv_dir = f"{remote_base_dir}/venv"
|
|
||||||
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
|
||||||
root_owned = dict(user="root", group="root", mode="644")
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="apt install python3-virtualenv",
|
|
||||||
packages=["python3-virtualenv"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="Upload chatmaild source package",
|
|
||||||
src=dist_file.open("rb"),
|
|
||||||
dest=remote_dist_file,
|
|
||||||
create_remote_dir=True,
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name=f"Upload {remote_chatmail_inipath}",
|
|
||||||
src=config._getbytefile(),
|
|
||||||
dest=remote_chatmail_inipath,
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
pip.virtualenv(
|
|
||||||
name=f"chatmaild virtualenv {remote_venv_dir}",
|
|
||||||
path=remote_venv_dir,
|
|
||||||
always_copy=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name=f"forced pip-install {dist_file.name}",
|
|
||||||
commands=[
|
|
||||||
f"{remote_venv_dir}/bin/pip install --force-reinstall {remote_dist_file}"
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"),
|
|
||||||
dest="/etc/cron.d/chatmail-metrics",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={
|
|
||||||
"mail_domain": config.mail_domain,
|
|
||||||
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
# install systemd units
|
|
||||||
for fn in (
|
|
||||||
"doveauth",
|
|
||||||
"filtermail",
|
|
||||||
"echobot",
|
|
||||||
"greeterbot",
|
|
||||||
):
|
|
||||||
params = dict(
|
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
|
||||||
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")
|
|
||||||
content = source_path.read_text().format(**params).encode()
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name=f"Upload {fn}.service",
|
|
||||||
src=io.BytesIO(content),
|
|
||||||
dest=f"/etc/systemd/system/{fn}.service",
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name=f"Setup {fn} service",
|
|
||||||
service=f"{fn}.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=True,
|
|
||||||
daemon_reload=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _install_mta_sts_daemon() -> bool:
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
config = files.put(
|
|
||||||
name="upload postfix-mta-sts-resolver config",
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"postfix/mta-sts-daemon.yml"
|
|
||||||
),
|
|
||||||
dest="/etc/mta-sts-daemon.yml",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= config.changed
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name="install postfix-mta-sts-resolver with pip",
|
|
||||||
commands=[
|
|
||||||
"python3 -m virtualenv /usr/local/lib/postfix-mta-sts-resolver",
|
|
||||||
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd_unit = files.put(
|
|
||||||
name="upload mta-sts-daemon systemd unit",
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"postfix/mta-sts-daemon.service"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/mta-sts-daemon.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= systemd_unit.changed
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
|
||||||
"""Configures Postfix SMTP server."""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"),
|
|
||||||
dest="/etc/postfix/main.cf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
master_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"),
|
|
||||||
dest="/etc/postfix/master.cf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
debug=debug,
|
|
||||||
config=config,
|
|
||||||
)
|
|
||||||
need_restart |= master_config.changed
|
|
||||||
|
|
||||||
header_cleanup = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"postfix/submission_header_cleanup"
|
|
||||||
),
|
|
||||||
dest="/etc/postfix/submission_header_cleanup",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= header_cleanup.changed
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|
||||||
"""Configures Dovecot IMAP server."""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"),
|
|
||||||
dest="/etc/dovecot/dovecot.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
debug=debug,
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
auth_config = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/auth.conf"),
|
|
||||||
dest="/etc/dovecot/auth.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= auth_config.changed
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
|
||||||
dest="/etc/cron.d/expunge",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
)
|
|
||||||
|
|
||||||
# as per https://doc.dovecot.org/configuration_manual/os/
|
|
||||||
# it is recommended to set the following inotify limits
|
|
||||||
for name in ("max_user_instances", "max_user_watches"):
|
|
||||||
key = f"fs.inotify.{name}"
|
|
||||||
server.sysctl(
|
|
||||||
name=f"Change {key}",
|
|
||||||
key=key,
|
|
||||||
value=65535,
|
|
||||||
persist=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
|
||||||
"""Configures nginx HTTP server."""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("nginx/nginx.conf.j2"),
|
|
||||||
dest="/etc/nginx/nginx.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain},
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
autoconfig = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("nginx/autoconfig.xml.j2"),
|
|
||||||
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain},
|
|
||||||
)
|
|
||||||
need_restart |= autoconfig.changed
|
|
||||||
|
|
||||||
mta_sts_config = files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("nginx/mta-sts.txt.j2"),
|
|
||||||
dest="/var/www/html/.well-known/mta-sts.txt",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain},
|
|
||||||
)
|
|
||||||
need_restart |= mta_sts_config.changed
|
|
||||||
|
|
||||||
# install CGI newemail script
|
|
||||||
#
|
|
||||||
cgi_dir = "/usr/lib/cgi-bin"
|
|
||||||
files.directory(
|
|
||||||
name=f"Ensure {cgi_dir} exists",
|
|
||||||
path=cgi_dir,
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="Upload cgi newemail.py script",
|
|
||||||
src=importlib.resources.files("chatmaild").joinpath("newemail.py").open("rb"),
|
|
||||||
dest=f"{cgi_dir}/newemail.py",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
|
|
||||||
|
|
||||||
def remove_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):
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
|
||||||
for value in config.__dict__.values():
|
|
||||||
if any(x in str(value) for x in blocked_words):
|
|
||||||
raise ValueError(
|
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
|
||||||
)
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(config_path: Path) -> None:
|
|
||||||
"""Deploy a chat-mail instance.
|
|
||||||
|
|
||||||
:param config_path: path to chatmail.ini
|
|
||||||
"""
|
|
||||||
config = read_config(config_path)
|
|
||||||
check_config(config)
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
|
|
||||||
from .www import build_webpages
|
|
||||||
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
|
||||||
|
|
||||||
# Run local DNS resolver `unbound`.
|
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
|
||||||
# to use 127.0.0.1 as the resolver.
|
|
||||||
apt.packages(
|
|
||||||
name="Install unbound",
|
|
||||||
packages=["unbound", "unbound-anchor", "dnsutils"],
|
|
||||||
)
|
|
||||||
server.shell(
|
|
||||||
name="Generate root keys for validating DNSSEC",
|
|
||||||
commands=["unbound-anchor -a /var/lib/unbound/root.key || true"],
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable unbound",
|
|
||||||
service="unbound.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
|
||||||
deploy_acmetool(
|
|
||||||
nginx_hook=True,
|
|
||||||
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install Postfix",
|
|
||||||
packages="postfix",
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install Dovecot",
|
|
||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install nginx",
|
|
||||||
packages=["nginx"],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install fcgiwrap",
|
|
||||||
packages=["fcgiwrap"],
|
|
||||||
)
|
|
||||||
|
|
||||||
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
|
||||||
|
|
||||||
build_dir = www_path.joinpath("build")
|
|
||||||
src_dir = www_path.joinpath("src")
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
|
|
||||||
|
|
||||||
_install_remote_venv_with_chatmaild(config)
|
|
||||||
debug = False
|
|
||||||
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
|
||||||
postfix_need_restart = _configure_postfix(config, debug=debug)
|
|
||||||
mta_sts_need_restart = _install_mta_sts_daemon()
|
|
||||||
nginx_need_restart = _configure_nginx(mail_domain)
|
|
||||||
|
|
||||||
remove_opendkim()
|
|
||||||
rspamd_need_restart = _configure_rspamd("dkim", mail_domain)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable rspamd",
|
|
||||||
service="rspamd.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=rspamd_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable MTA-STS daemon",
|
|
||||||
service="mta-sts-daemon.service",
|
|
||||||
daemon_reload=True,
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=mta_sts_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable Postfix",
|
|
||||||
service="postfix.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=postfix_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable Dovecot",
|
|
||||||
service="dovecot.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=dovecot_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable nginx",
|
|
||||||
service="nginx.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=nginx_need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
# This file is used by auth proxy.
|
|
||||||
# https://wiki.debian.org/EtcMailName
|
|
||||||
server.shell(
|
|
||||||
name="Setup /etc/mailname",
|
|
||||||
commands=[f"echo {mail_domain} >/etc/mailname; chmod 644 /etc/mailname"],
|
|
||||||
)
|
|
||||||
|
|
||||||
journald_conf = files.put(
|
|
||||||
name="Configure journald",
|
|
||||||
src=importlib.resources.files(__package__).joinpath("journald.conf"),
|
|
||||||
dest="/etc/systemd/journald.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable journald",
|
|
||||||
service="systemd-journald.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=journald_conf,
|
|
||||||
)
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
request:
|
|
||||||
provider: https://acme-v02.api.letsencrypt.org/directory
|
|
||||||
key:
|
|
||||||
type: rsa
|
|
||||||
challenge:
|
|
||||||
webroot-paths:
|
|
||||||
- /var/www/html/.well-known/acme-challenge
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
{chatmail_domain}. A {ipv4}
|
|
||||||
{chatmail_domain}. AAAA {ipv6}
|
|
||||||
{chatmail_domain}. MX 10 {chatmail_domain}.
|
|
||||||
_submission._tcp.{chatmail_domain}. SRV 0 1 587 {chatmail_domain}.
|
|
||||||
_submissions._tcp.{chatmail_domain}. SRV 0 1 465 {chatmail_domain}.
|
|
||||||
_imap._tcp.{chatmail_domain}. SRV 0 1 143 {chatmail_domain}.
|
|
||||||
_imaps._tcp.{chatmail_domain}. SRV 0 1 993 {chatmail_domain}.
|
|
||||||
{chatmail_domain}. CAA 128 issue "letsencrypt.org;accounturi={acme_account_url}"
|
|
||||||
{chatmail_domain}. TXT "v=spf1 a:{chatmail_domain} -all"
|
|
||||||
_dmarc.{chatmail_domain}. TXT "v=DMARC1;p=reject;rua=mailto:{email};ruf=mailto:{email};fo=1;adkim=s;aspf=s"
|
|
||||||
_mta-sts.{chatmail_domain}. TXT "v=STSv1; id={sts_id}"
|
|
||||||
mta-sts.{chatmail_domain}. CNAME {chatmail_domain}.
|
|
||||||
www.{chatmail_domain}. CNAME {chatmail_domain}.
|
|
||||||
_smtp._tls.{chatmail_domain}. TXT "v=TLSRPTv1;rua=mailto:{email}"
|
|
||||||
{dkim_entry}
|
|
||||||
@@ -1,314 +0,0 @@
|
|||||||
"""
|
|
||||||
Provides the `cmdeploy` entry point function,
|
|
||||||
along with command line option and subcommand parsing.
|
|
||||||
"""
|
|
||||||
import argparse
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import importlib.resources
|
|
||||||
import importlib.util
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
|
|
||||||
from termcolor import colored
|
|
||||||
from chatmaild.config import read_config, write_initial_config
|
|
||||||
from cmdeploy.dns import show_dns, check_necessary_dns
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# cmdeploy sub commands and options
|
|
||||||
#
|
|
||||||
|
|
||||||
|
|
||||||
def init_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"chatmail_domain",
|
|
||||||
action="store",
|
|
||||||
help="fully qualified DNS domain name for your chatmail instance",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def init_cmd(args, out):
|
|
||||||
"""Initialize chatmail config file."""
|
|
||||||
mail_domain = args.chatmail_domain
|
|
||||||
if args.inipath.exists():
|
|
||||||
print(f"Path exists, not modifying: {args.inipath}")
|
|
||||||
else:
|
|
||||||
write_initial_config(args.inipath, mail_domain)
|
|
||||||
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
|
||||||
check_necessary_dns(
|
|
||||||
out,
|
|
||||||
mail_domain,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--dry-run",
|
|
||||||
dest="dry_run",
|
|
||||||
action="store_true",
|
|
||||||
help="don't actually modify the server",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args, out):
|
|
||||||
"""Deploy chatmail services on the remote server."""
|
|
||||||
mail_domain = args.config.mail_domain
|
|
||||||
if not check_necessary_dns(
|
|
||||||
out,
|
|
||||||
mail_domain,
|
|
||||||
):
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
env = os.environ.copy()
|
|
||||||
env["CHATMAIL_INI"] = args.inipath
|
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
|
||||||
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path}"
|
|
||||||
|
|
||||||
out.check_call(cmd, env=env)
|
|
||||||
print("Deploy completed, call `cmdeploy dns` next.")
|
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--zonefile",
|
|
||||||
dest="zonefile",
|
|
||||||
help="print the whole zonefile for deploying directly",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd(args, out):
|
|
||||||
"""Generate dns zone file."""
|
|
||||||
show_dns(args, out)
|
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
|
||||||
"""Display status for online chatmail instance."""
|
|
||||||
|
|
||||||
ssh = f"ssh root@{args.config.mail_domain}"
|
|
||||||
|
|
||||||
out.green(f"chatmail domain: {args.config.mail_domain}")
|
|
||||||
if args.config.privacy_mail:
|
|
||||||
out.green("privacy settings: present")
|
|
||||||
else:
|
|
||||||
out.red("no privacy settings")
|
|
||||||
|
|
||||||
s1 = "systemctl --type=service --state=running"
|
|
||||||
for line in out.shell_output(f"{ssh} -- {s1}").split("\n"):
|
|
||||||
if line.startswith(" "):
|
|
||||||
print(line)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--slow",
|
|
||||||
dest="slow",
|
|
||||||
action="store_true",
|
|
||||||
help="also run slow tests",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cmd(args, out):
|
|
||||||
"""Run local and online tests for chatmail deployment.
|
|
||||||
|
|
||||||
This will automatically pip-install 'deltachat' if it's not available.
|
|
||||||
"""
|
|
||||||
|
|
||||||
x = importlib.util.find_spec("deltachat")
|
|
||||||
if x is None:
|
|
||||||
out.check_call(f"{sys.executable} -m pip install deltachat")
|
|
||||||
|
|
||||||
pytest_path = shutil.which("pytest")
|
|
||||||
pytest_args = [
|
|
||||||
pytest_path,
|
|
||||||
"cmdeploy/src/",
|
|
||||||
"-n4",
|
|
||||||
"-rs",
|
|
||||||
"-x",
|
|
||||||
"-vrx",
|
|
||||||
"--durations=5",
|
|
||||||
]
|
|
||||||
if args.slow:
|
|
||||||
pytest_args.append("--slow")
|
|
||||||
ret = out.run_ret(pytest_args)
|
|
||||||
return ret
|
|
||||||
|
|
||||||
|
|
||||||
def fmt_cmd_options(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--verbose",
|
|
||||||
"-v",
|
|
||||||
dest="verbose",
|
|
||||||
action="store_true",
|
|
||||||
help="provide information on invocations",
|
|
||||||
)
|
|
||||||
|
|
||||||
parser.add_argument(
|
|
||||||
"--check",
|
|
||||||
"-c",
|
|
||||||
action="store_true",
|
|
||||||
help="only check but don't fix problems",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def fmt_cmd(args, out):
|
|
||||||
"""Run formattting fixes (ruff and black) on all chatmail source code."""
|
|
||||||
|
|
||||||
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
|
||||||
black_args = [shutil.which("black")]
|
|
||||||
ruff_args = [shutil.which("ruff")]
|
|
||||||
|
|
||||||
if args.check:
|
|
||||||
black_args.append("--check")
|
|
||||||
else:
|
|
||||||
ruff_args.append("--fix")
|
|
||||||
|
|
||||||
if not args.verbose:
|
|
||||||
black_args.append("-q")
|
|
||||||
ruff_args.append("-q")
|
|
||||||
|
|
||||||
black_args.extend(sources)
|
|
||||||
ruff_args.extend(sources)
|
|
||||||
|
|
||||||
out.check_call(" ".join(black_args), quiet=not args.verbose)
|
|
||||||
out.check_call(" ".join(ruff_args), quiet=not args.verbose)
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
def bench_cmd(args, out):
|
|
||||||
"""Run benchmarks against an online chatmail instance."""
|
|
||||||
args = ["pytest", "--pyargs", "cmdeploy.tests.online.benchmark", "-vrx"]
|
|
||||||
cmdstring = " ".join(args)
|
|
||||||
out.green(f"[$ {cmdstring}]")
|
|
||||||
subprocess.check_call(args)
|
|
||||||
|
|
||||||
|
|
||||||
def webdev_cmd(args, out):
|
|
||||||
"""Run local web development loop for static web pages."""
|
|
||||||
from .www import main
|
|
||||||
|
|
||||||
main()
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Parsing command line options and starting commands
|
|
||||||
#
|
|
||||||
|
|
||||||
|
|
||||||
class Out:
|
|
||||||
"""Convenience output printer providing coloring."""
|
|
||||||
|
|
||||||
def red(self, msg, file=sys.stderr):
|
|
||||||
print(colored(msg, "red"), file=file)
|
|
||||||
|
|
||||||
def green(self, msg, file=sys.stderr):
|
|
||||||
print(colored(msg, "green"), file=file)
|
|
||||||
|
|
||||||
def __call__(self, msg, red=False, green=False, file=sys.stdout):
|
|
||||||
color = "red" if red else ("green" if green else None)
|
|
||||||
print(colored(msg, color), file=file)
|
|
||||||
|
|
||||||
def shell_output(self, arg, no_print=False, timeout=10):
|
|
||||||
if not no_print:
|
|
||||||
self(f"[$ {arg}]", file=sys.stderr)
|
|
||||||
output = subprocess.STDOUT
|
|
||||||
else:
|
|
||||||
output = subprocess.DEVNULL
|
|
||||||
return subprocess.check_output(
|
|
||||||
arg, shell=True, timeout=timeout, stderr=output
|
|
||||||
).decode()
|
|
||||||
|
|
||||||
def check_call(self, arg, env=None, quiet=False):
|
|
||||||
if not quiet:
|
|
||||||
self(f"[$ {arg}]", file=sys.stderr)
|
|
||||||
return subprocess.check_call(arg, shell=True, env=env)
|
|
||||||
|
|
||||||
def run_ret(self, args, env=None, quiet=False):
|
|
||||||
if not quiet:
|
|
||||||
cmdstring = " ".join(args)
|
|
||||||
self(f"[$ {cmdstring}]", file=sys.stderr)
|
|
||||||
proc = subprocess.run(args, env=env)
|
|
||||||
return proc.returncode
|
|
||||||
|
|
||||||
|
|
||||||
def add_config_option(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--config",
|
|
||||||
dest="inipath",
|
|
||||||
action="store",
|
|
||||||
default=Path("chatmail.ini"),
|
|
||||||
type=Path,
|
|
||||||
help="path to the chatmail.ini file",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def add_subcommand(subparsers, func):
|
|
||||||
name = func.__name__
|
|
||||||
assert name.endswith("_cmd")
|
|
||||||
name = name[:-4]
|
|
||||||
doc = func.__doc__.strip()
|
|
||||||
help = doc.split("\n")[0].strip(".")
|
|
||||||
p = subparsers.add_parser(name, description=doc, help=help)
|
|
||||||
p.set_defaults(func=func)
|
|
||||||
add_config_option(p)
|
|
||||||
return p
|
|
||||||
|
|
||||||
|
|
||||||
description = """
|
|
||||||
Setup your chatmail server configuration and
|
|
||||||
deploy it via SSH to your remote location.
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
def get_parser():
|
|
||||||
"""Return an ArgumentParser for the 'cmdeploy' CLI"""
|
|
||||||
|
|
||||||
parser = argparse.ArgumentParser(description=description.strip())
|
|
||||||
subparsers = parser.add_subparsers(title="subcommands")
|
|
||||||
|
|
||||||
# find all subcommands in the module namespace
|
|
||||||
glob = globals()
|
|
||||||
for name, func in glob.items():
|
|
||||||
if name.endswith("_cmd"):
|
|
||||||
subparser = add_subcommand(subparsers, func)
|
|
||||||
addopts = glob.get(name + "_options")
|
|
||||||
if addopts is not None:
|
|
||||||
addopts(subparser)
|
|
||||||
|
|
||||||
return parser
|
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
|
||||||
"""Provide main entry point for 'xdcget' CLI invocation."""
|
|
||||||
parser = get_parser()
|
|
||||||
args = parser.parse_args(args=args)
|
|
||||||
if not hasattr(args, "func"):
|
|
||||||
return parser.parse_args(["-h"])
|
|
||||||
out = Out()
|
|
||||||
kwargs = {}
|
|
||||||
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
|
||||||
if not args.inipath.exists():
|
|
||||||
out.red(f"expecting {args.inipath} to exist, run init first?")
|
|
||||||
raise SystemExit(1)
|
|
||||||
try:
|
|
||||||
args.config = read_config(args.inipath)
|
|
||||||
except Exception as ex:
|
|
||||||
out.red(ex)
|
|
||||||
raise SystemExit(1)
|
|
||||||
|
|
||||||
try:
|
|
||||||
res = args.func(args, out, **kwargs)
|
|
||||||
if res is None:
|
|
||||||
res = 0
|
|
||||||
return res
|
|
||||||
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
out.red("KeyboardInterrupt")
|
|
||||||
sys.exit(130)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB |
Binary file not shown.
@@ -1,17 +0,0 @@
|
|||||||
import os
|
|
||||||
import importlib.resources
|
|
||||||
import pyinfra
|
|
||||||
from cmdeploy import deploy_chatmail
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
config_path = os.getenv(
|
|
||||||
"CHATMAIL_INI",
|
|
||||||
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
|
||||||
)
|
|
||||||
|
|
||||||
deploy_chatmail(config_path)
|
|
||||||
|
|
||||||
|
|
||||||
if pyinfra.is_cli:
|
|
||||||
main()
|
|
||||||
@@ -1,209 +0,0 @@
|
|||||||
import sys
|
|
||||||
|
|
||||||
import requests
|
|
||||||
import importlib
|
|
||||||
import subprocess
|
|
||||||
import datetime
|
|
||||||
|
|
||||||
|
|
||||||
class DNS:
|
|
||||||
def __init__(self, out, mail_domain):
|
|
||||||
self.session = requests.Session()
|
|
||||||
self.out = out
|
|
||||||
self.ssh = f"ssh root@{mail_domain} -- "
|
|
||||||
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
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
## Dovecot configuration file
|
|
||||||
|
|
||||||
protocols = imap lmtp
|
|
||||||
|
|
||||||
auth_mechanisms = plain
|
|
||||||
|
|
||||||
{% if debug == true %}
|
|
||||||
auth_verbose = yes
|
|
||||||
auth_debug = yes
|
|
||||||
auth_debug_passwords = yes
|
|
||||||
auth_verbose_passwords = plain
|
|
||||||
auth_cache_size = 100M
|
|
||||||
mail_debug = yes
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
|
|
||||||
mail_plugins = quota
|
|
||||||
|
|
||||||
# these are the capabilities Delta Chat cares about actually
|
|
||||||
# so let's keep the network overhead per login small
|
|
||||||
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
|
||||||
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY
|
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
|
||||||
passdb {
|
|
||||||
driver = dict
|
|
||||||
args = /etc/dovecot/auth.conf
|
|
||||||
}
|
|
||||||
userdb {
|
|
||||||
driver = dict
|
|
||||||
args = /etc/dovecot/auth.conf
|
|
||||||
}
|
|
||||||
##
|
|
||||||
## Mailbox locations and namespaces
|
|
||||||
##
|
|
||||||
|
|
||||||
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
|
||||||
mail_location = maildir:/home/vmail/mail/%d/%u
|
|
||||||
|
|
||||||
namespace inbox {
|
|
||||||
inbox = yes
|
|
||||||
|
|
||||||
mailbox Drafts {
|
|
||||||
special_use = \Drafts
|
|
||||||
}
|
|
||||||
mailbox Junk {
|
|
||||||
special_use = \Junk
|
|
||||||
}
|
|
||||||
mailbox Trash {
|
|
||||||
special_use = \Trash
|
|
||||||
}
|
|
||||||
|
|
||||||
# For \Sent mailboxes there are two widely used names. We'll mark both of
|
|
||||||
# them as \Sent. User typically deletes one of them if duplicates are created.
|
|
||||||
mailbox Sent {
|
|
||||||
special_use = \Sent
|
|
||||||
}
|
|
||||||
mailbox "Sent Messages" {
|
|
||||||
special_use = \Sent
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
mail_uid = vmail
|
|
||||||
mail_gid = vmail
|
|
||||||
mail_privileged_group = vmail
|
|
||||||
|
|
||||||
##
|
|
||||||
## Mail processes
|
|
||||||
##
|
|
||||||
|
|
||||||
# Enable IMAP COMPRESS (RFC 4978).
|
|
||||||
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
|
||||||
protocol imap {
|
|
||||||
mail_plugins = $mail_plugins imap_zlib imap_quota
|
|
||||||
}
|
|
||||||
|
|
||||||
protocol lmtp {
|
|
||||||
mail_plugins = $mail_plugins quota
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
imap_compress_deflate_level = 6
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin {
|
|
||||||
# for now we define static quota-rules for all users
|
|
||||||
quota = maildir:User quota
|
|
||||||
quota_rule = *:storage={{ config.max_mailbox_size }}
|
|
||||||
quota_max_mail_size=30M
|
|
||||||
quota_grace = 0
|
|
||||||
# quota_over_flag_value = TRUE
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
service lmtp {
|
|
||||||
user=vmail
|
|
||||||
|
|
||||||
unix_listener /var/spool/postfix/private/dovecot-lmtp {
|
|
||||||
group = postfix
|
|
||||||
mode = 0600
|
|
||||||
user = postfix
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
service auth {
|
|
||||||
unix_listener /var/spool/postfix/private/auth {
|
|
||||||
mode = 0660
|
|
||||||
user = postfix
|
|
||||||
group = postfix
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
service auth-worker {
|
|
||||||
# Default is root.
|
|
||||||
# Drop privileges we don't need.
|
|
||||||
user = vmail
|
|
||||||
}
|
|
||||||
|
|
||||||
service imap-login {
|
|
||||||
# High-security mode.
|
|
||||||
# Each process serves a single connection and exits afterwards.
|
|
||||||
# This is the default, but we set it explicitly to be sure.
|
|
||||||
# See <https://doc.dovecot.org/admin_manual/login_processes/#high-security-mode> for details.
|
|
||||||
service_count = 1
|
|
||||||
|
|
||||||
# Inrease the number of simultaneous connections.
|
|
||||||
#
|
|
||||||
# As of Dovecot 2.3.19.1 the default is 100 processes.
|
|
||||||
# Combined with `service_count = 1` it means only 100 connections
|
|
||||||
# can be handled simultaneously.
|
|
||||||
process_limit = 10000
|
|
||||||
|
|
||||||
# Avoid startup latency for new connections.
|
|
||||||
process_min_avail = 10
|
|
||||||
}
|
|
||||||
|
|
||||||
ssl = required
|
|
||||||
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
|
||||||
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
|
||||||
ssl_min_protocol = TLSv1.2
|
|
||||||
ssl_prefer_server_ciphers = yes
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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,87 +0,0 @@
|
|||||||
import importlib
|
|
||||||
import qrcode
|
|
||||||
import os
|
|
||||||
from PIL import ImageFont, ImageDraw, Image
|
|
||||||
import io
|
|
||||||
|
|
||||||
|
|
||||||
def gen_qr_png_data(maildomain):
|
|
||||||
url = f"DCACCOUNT:https://{maildomain}/cgi-bin/newemail.py"
|
|
||||||
image = gen_qr(maildomain, url)
|
|
||||||
temp = io.BytesIO()
|
|
||||||
image.save(temp, format="png")
|
|
||||||
temp.seek(0)
|
|
||||||
return temp
|
|
||||||
|
|
||||||
|
|
||||||
def gen_qr(maildomain, url):
|
|
||||||
# taken and modified from
|
|
||||||
# https://github.com/deltachat/mailadm/blob/master/src/mailadm/gen_qr.py
|
|
||||||
|
|
||||||
# info = f"{maildomain} invite code"
|
|
||||||
info = ""
|
|
||||||
|
|
||||||
# load QR code
|
|
||||||
qr = qrcode.QRCode(
|
|
||||||
version=1,
|
|
||||||
error_correction=qrcode.constants.ERROR_CORRECT_H,
|
|
||||||
box_size=1,
|
|
||||||
border=1,
|
|
||||||
)
|
|
||||||
qr.add_data(url)
|
|
||||||
qr.make(fit=True)
|
|
||||||
qr_img = qr.make_image(fill_color="black", back_color="white")
|
|
||||||
|
|
||||||
# paint all elements
|
|
||||||
ttf_path = str(
|
|
||||||
importlib.resources.files(__package__).joinpath("data/opensans-regular.ttf")
|
|
||||||
)
|
|
||||||
logo_red_path = str(
|
|
||||||
importlib.resources.files(__package__).joinpath("data/delta-chat-bw.png")
|
|
||||||
)
|
|
||||||
|
|
||||||
assert os.path.exists(ttf_path), ttf_path
|
|
||||||
font_size = 16
|
|
||||||
font = ImageFont.truetype(font=ttf_path, size=font_size)
|
|
||||||
|
|
||||||
num_lines = ((info).count("\n") + 1) if info else 0
|
|
||||||
|
|
||||||
size = width = 384
|
|
||||||
qr_padding = 6
|
|
||||||
text_height = font_size * num_lines
|
|
||||||
height = size + text_height
|
|
||||||
|
|
||||||
image = Image.new("RGBA", (width, height), "white")
|
|
||||||
qr_final_size = width - (qr_padding * 2)
|
|
||||||
|
|
||||||
if num_lines:
|
|
||||||
draw = ImageDraw.Draw(image)
|
|
||||||
|
|
||||||
# draw text
|
|
||||||
if hasattr(font, "getsize"):
|
|
||||||
info_pos = (width - font.getsize(info.strip())[0]) // 2
|
|
||||||
else:
|
|
||||||
info_pos = (width - font.getbbox(info.strip())[3]) // 2
|
|
||||||
|
|
||||||
draw.multiline_text(
|
|
||||||
(info_pos, size - qr_padding // 2),
|
|
||||||
info,
|
|
||||||
font=font,
|
|
||||||
fill="black",
|
|
||||||
align="right",
|
|
||||||
)
|
|
||||||
|
|
||||||
# paste QR code
|
|
||||||
image.paste(
|
|
||||||
qr_img.resize((qr_final_size, qr_final_size), resample=Image.NEAREST),
|
|
||||||
(qr_padding, qr_padding),
|
|
||||||
)
|
|
||||||
|
|
||||||
# background delta logo
|
|
||||||
logo2_img = Image.open(logo_red_path)
|
|
||||||
logo2_width = int(size / 6)
|
|
||||||
logo2 = logo2_img.resize((logo2_width, logo2_width), resample=Image.NEAREST)
|
|
||||||
pos = int((size / 2) - (logo2_width / 2))
|
|
||||||
image.paste(logo2, (pos, pos), mask=logo2)
|
|
||||||
|
|
||||||
return image
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
[Journal]
|
|
||||||
MaxRetentionSec=3d
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
*/5 * * * * root {{ config.execpath }} /home/vmail/mail/{{ config.mail_domain }} >/var/www/html/metrics
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
|
|
||||||
<clientConfig version="1.1">
|
|
||||||
<emailProvider id="{{ config.domain_name }}">
|
|
||||||
<domain>{{ config.domain_name }}</domain>
|
|
||||||
<displayName>{{ config.domain_name }} chatmail</displayName>
|
|
||||||
<displayShortName>{{ config.domain_name }}</displayShortName>
|
|
||||||
<incomingServer type="imap">
|
|
||||||
<hostname>{{ config.domain_name }}</hostname>
|
|
||||||
<port>993</port>
|
|
||||||
<socketType>SSL</socketType>
|
|
||||||
<authentication>password-cleartext</authentication>
|
|
||||||
<username>%EMAILADDRESS%</username>
|
|
||||||
</incomingServer>
|
|
||||||
<incomingServer type="imap">
|
|
||||||
<hostname>{{ config.domain_name }}</hostname>
|
|
||||||
<port>143</port>
|
|
||||||
<socketType>STARTTLS</socketType>
|
|
||||||
<authentication>password-cleartext</authentication>
|
|
||||||
<username>%EMAILADDRESS%</username>
|
|
||||||
</incomingServer>
|
|
||||||
<outgoingServer type="smtp">
|
|
||||||
<hostname>{{ config.domain_name }}</hostname>
|
|
||||||
<port>465</port>
|
|
||||||
<socketType>SSL</socketType>
|
|
||||||
<authentication>password-cleartext</authentication>
|
|
||||||
<username>%EMAILADDRESS%</username>
|
|
||||||
</outgoingServer>
|
|
||||||
<outgoingServer type="smtp">
|
|
||||||
<hostname>{{ config.domain_name }}</hostname>
|
|
||||||
<port>587</port>
|
|
||||||
<socketType>STARTTLS</socketType>
|
|
||||||
<authentication>password-cleartext</authentication>
|
|
||||||
<username>%EMAILADDRESS%</username>
|
|
||||||
</outgoingServer>
|
|
||||||
</emailProvider>
|
|
||||||
</clientConfig>
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
version: STSv1
|
|
||||||
mode: enforce
|
|
||||||
mx: {{ config.domain_name }}
|
|
||||||
max_age: 2419200
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
user www-data;
|
|
||||||
worker_processes auto;
|
|
||||||
pid /run/nginx.pid;
|
|
||||||
error_log /var/log/nginx/error.log;
|
|
||||||
|
|
||||||
events {
|
|
||||||
worker_connections 768;
|
|
||||||
# multi_accept on;
|
|
||||||
}
|
|
||||||
|
|
||||||
http {
|
|
||||||
sendfile on;
|
|
||||||
tcp_nopush on;
|
|
||||||
|
|
||||||
# Do not emit nginx version on error pages.
|
|
||||||
server_tokens off;
|
|
||||||
|
|
||||||
include /etc/nginx/mime.types;
|
|
||||||
default_type application/octet-stream;
|
|
||||||
|
|
||||||
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
|
||||||
ssl_prefer_server_ciphers on;
|
|
||||||
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
|
||||||
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
|
||||||
|
|
||||||
gzip on;
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 443 ssl default_server;
|
|
||||||
listen [::]:443 ssl default_server;
|
|
||||||
|
|
||||||
root /var/www/html;
|
|
||||||
|
|
||||||
index index.html index.htm;
|
|
||||||
|
|
||||||
server_name _;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
# First attempt to serve request as file, then
|
|
||||||
# as directory, then fall back to displaying a 404.
|
|
||||||
try_files $uri $uri/ =404;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /metrics {
|
|
||||||
default_type text/plain;
|
|
||||||
}
|
|
||||||
|
|
||||||
# add cgi-bin support
|
|
||||||
include /usr/share/doc/fcgiwrap/examples/nginx.conf;
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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 +0,0 @@
|
|||||||
dkim._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/dkim.private
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
*@{{ config.domain_name }} {{ config.opendkim_selector }}._domainkey.{{ config.domain_name }}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Postfix MTA-STS resolver daemon
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart=/usr/local/lib/postfix-mta-sts-resolver/bin/mta-sts-daemon
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
host: 127.0.0.1
|
|
||||||
port: 8461
|
|
||||||
reuse_port: true
|
|
||||||
shutdown_timeout: 20
|
|
||||||
cache:
|
|
||||||
type: internal
|
|
||||||
options:
|
|
||||||
cache_size: 10000
|
|
||||||
proactive_policy_fetching:
|
|
||||||
enabled: true
|
|
||||||
default_zone:
|
|
||||||
strict_testing: false
|
|
||||||
timeout: 4
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
/^Received:/ IGNORE
|
|
||||||
/^X-Originating-IP:/ IGNORE
|
|
||||||
/^X-Mailer:/ IGNORE
|
|
||||||
/^User-Agent:/ IGNORE
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
enabled = false;
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
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 }}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
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 +0,0 @@
|
|||||||
filters = "dkim";
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
def test_tls_imap(benchmark, imap):
|
|
||||||
def imap_connect():
|
|
||||||
imap.connect()
|
|
||||||
|
|
||||||
benchmark(imap_connect, 10)
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_imap(benchmark, imap, gencreds):
|
|
||||||
def imap_connect_and_login():
|
|
||||||
imap.connect()
|
|
||||||
imap.login(*gencreds())
|
|
||||||
|
|
||||||
benchmark(imap_connect_and_login, 10)
|
|
||||||
|
|
||||||
|
|
||||||
def test_tls_smtp(benchmark, smtp):
|
|
||||||
def smtp_connect():
|
|
||||||
smtp.connect()
|
|
||||||
|
|
||||||
benchmark(smtp_connect, 10)
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_smtp(benchmark, smtp, gencreds):
|
|
||||||
def smtp_connect_and_login():
|
|
||||||
smtp.connect()
|
|
||||||
smtp.login(*gencreds())
|
|
||||||
|
|
||||||
benchmark(smtp_connect_and_login, 10)
|
|
||||||
|
|
||||||
|
|
||||||
class TestDC:
|
|
||||||
def test_autoconfigure(self, benchmark, cmfactory):
|
|
||||||
def dc_autoconfig_and_idle_ready():
|
|
||||||
cmfactory.get_online_accounts(1)
|
|
||||||
|
|
||||||
benchmark(dc_autoconfig_and_idle_ready, 5)
|
|
||||||
|
|
||||||
def test_ping_pong(self, benchmark, cmfactory):
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
def dc_ping_pong():
|
|
||||||
chat.send_text("ping")
|
|
||||||
msg = ac2.wait_next_incoming_message()
|
|
||||||
msg.chat.send_text("pong")
|
|
||||||
ac1.wait_next_incoming_message()
|
|
||||||
|
|
||||||
benchmark(dc_ping_pong, 5)
|
|
||||||
|
|
||||||
def test_send_10_receive_10(self, benchmark, cmfactory, lp):
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
def dc_send_10_receive_10():
|
|
||||||
for i in range(10):
|
|
||||||
chat.send_text(f"hello {i}")
|
|
||||||
for i in range(10):
|
|
||||||
ac2.wait_next_incoming_message()
|
|
||||||
|
|
||||||
benchmark(dc_send_10_receive_10, 5)
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
import pytest
|
|
||||||
import threading
|
|
||||||
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):
|
|
||||||
"""Test a) that an initial login creates a user automatically
|
|
||||||
and b) verify we can also login a second time with the same password
|
|
||||||
and c) that using a different password fails the login."""
|
|
||||||
user, password = gencreds()
|
|
||||||
lp.sec(f"login first time with {user} {password}")
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user, password)
|
|
||||||
lp.indent("success")
|
|
||||||
|
|
||||||
lp.sec(f"reconnect and login second time {user} {password}")
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user, password)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
lp.sec("success")
|
|
||||||
|
|
||||||
lp.sec(f"reconnect and verify wrong password fails {user} ")
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
with pytest.raises(imap_or_smtp.AuthError):
|
|
||||||
imap_or_smtp.login(user, password + "wrong")
|
|
||||||
|
|
||||||
lp.sec("creating users with a short password is not allowed")
|
|
||||||
user, _password = gencreds()
|
|
||||||
with pytest.raises(imap_or_smtp.AuthError):
|
|
||||||
imap_or_smtp.login(user, "admin")
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_same_password(imap_or_smtp, gencreds):
|
|
||||||
"""Test two different users logging in with the same password
|
|
||||||
to ensure that authentication process does not confuse the users
|
|
||||||
by using only the password hash as a key.
|
|
||||||
"""
|
|
||||||
user1, password1 = gencreds()
|
|
||||||
user2, _ = gencreds()
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user1, password1)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
imap_or_smtp.login(user2, password1)
|
|
||||||
|
|
||||||
|
|
||||||
def test_concurrent_logins_same_account(
|
|
||||||
make_imap_connection, make_smtp_connection, gencreds
|
|
||||||
):
|
|
||||||
"""Test concurrent smtp and imap logins
|
|
||||||
and check remote server succeeds on each connection.
|
|
||||||
"""
|
|
||||||
user1, password1 = gencreds()
|
|
||||||
login_results = queue.Queue()
|
|
||||||
|
|
||||||
def login_smtp_imap(smtp, imap):
|
|
||||||
try:
|
|
||||||
imap.login(user1, password1)
|
|
||||||
except Exception:
|
|
||||||
login_results.put(False)
|
|
||||||
else:
|
|
||||||
login_results.put(True)
|
|
||||||
|
|
||||||
conns = [(make_smtp_connection(), make_imap_connection()) for i in range(10)]
|
|
||||||
|
|
||||||
for args in conns:
|
|
||||||
thread = threading.Thread(target=login_smtp_imap, args=args, daemon=True)
|
|
||||||
thread.start()
|
|
||||||
|
|
||||||
for _ in conns:
|
|
||||||
assert login_results.get()
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
import requests
|
|
||||||
|
|
||||||
from cmdeploy.genqr import gen_qr_png_data
|
|
||||||
|
|
||||||
|
|
||||||
def test_gen_qr_png_data(maildomain):
|
|
||||||
data = gen_qr_png_data(maildomain)
|
|
||||||
assert data
|
|
||||||
|
|
||||||
|
|
||||||
def test_fastcgi_working(maildomain, chatmail_config):
|
|
||||||
url = f"https://{maildomain}/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)
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
import smtplib
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
|
|
||||||
def test_remote(remote, imap_or_smtp):
|
|
||||||
lineproducer = remote.iter_output(imap_or_smtp.logcmd)
|
|
||||||
imap_or_smtp.connect()
|
|
||||||
assert imap_or_smtp.name in next(lineproducer)
|
|
||||||
|
|
||||||
|
|
||||||
def test_use_two_chatmailservers(cmfactory, maildomain2):
|
|
||||||
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.switch_maildomain(maildomain2)
|
|
||||||
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.bring_accounts_online()
|
|
||||||
cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
domain1 = ac1.get_config("addr").split("@")[1]
|
|
||||||
domain2 = ac2.get_config("addr").split("@")[1]
|
|
||||||
assert domain1 != domain2
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("forgeaddr", ["internal", "someone@example.org"])
|
|
||||||
def test_reject_forged_from(cmsetup, maildata, gencreds, lp, forgeaddr):
|
|
||||||
user1, user3 = cmsetup.gen_users(2)
|
|
||||||
|
|
||||||
lp.sec("send encrypted message with forged from")
|
|
||||||
print("envelope_from", user1.addr)
|
|
||||||
if forgeaddr == "internal":
|
|
||||||
addr_to_forge = cmsetup.gen_users(1)[0].addr
|
|
||||||
else:
|
|
||||||
addr_to_forge = "someone@example.org"
|
|
||||||
|
|
||||||
print("message to inject:")
|
|
||||||
msg = maildata("encrypted.eml", from_addr=addr_to_forge, to_addr=user3.addr)
|
|
||||||
msg = msg.as_string()
|
|
||||||
for line in msg.split("\n")[:4]:
|
|
||||||
print(f" {line}")
|
|
||||||
|
|
||||||
lp.sec("Send forged mail and check remote postfix lmtp processing result")
|
|
||||||
with pytest.raises(smtplib.SMTPException) as e:
|
|
||||||
user1.smtp.sendmail(from_addr=user1.addr, to_addrs=[user3.addr], msg=msg)
|
|
||||||
assert "500" in str(e.value)
|
|
||||||
|
|
||||||
|
|
||||||
@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
|
|
||||||
def test_exceed_rate_limit(cmsetup, gencreds, maildata, chatmail_config):
|
|
||||||
"""Test that the per-account send-mail limit is exceeded."""
|
|
||||||
user1, user2 = cmsetup.gen_users(2)
|
|
||||||
mail = maildata(
|
|
||||||
"encrypted.eml", from_addr=user1.addr, to_addr=user2.addr
|
|
||||||
).as_string()
|
|
||||||
for i in range(chatmail_config.max_user_send_per_minute + 5):
|
|
||||||
print("Sending mail", str(i))
|
|
||||||
try:
|
|
||||||
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
|
||||||
except smtplib.SMTPException as e:
|
|
||||||
if i < chatmail_config.max_user_send_per_minute:
|
|
||||||
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
|
||||||
outcome = e.recipients[user2.addr]
|
|
||||||
assert outcome[0] == 450
|
|
||||||
assert b"4.7.1: Too much mail from" in outcome[1]
|
|
||||||
return
|
|
||||||
pytest.fail("Rate limit was not exceeded")
|
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
import time
|
|
||||||
import re
|
|
||||||
import random
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
import requests
|
|
||||||
import ipaddress
|
|
||||||
|
|
||||||
|
|
||||||
class TestEndToEndDeltaChat:
|
|
||||||
"Tests that use Delta Chat accounts on the chat mail instance."
|
|
||||||
|
|
||||||
def test_one_on_one(self, cmfactory, lp):
|
|
||||||
"""Test that a DC account can send a message to a second DC account
|
|
||||||
on the same chat-mail instance."""
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
lp.sec("ac1: prepare and send text message to ac2")
|
|
||||||
chat.send_text("message0")
|
|
||||||
|
|
||||||
lp.sec("wait for ac2 to receive message")
|
|
||||||
msg2 = ac2._evtracker.wait_next_incoming_message()
|
|
||||||
assert msg2.text == "message0"
|
|
||||||
|
|
||||||
@pytest.mark.slow
|
|
||||||
def test_exceed_quota(self, cmfactory, lp, tmpdir, remote, chatmail_config):
|
|
||||||
"""This is a very slow test as it needs to upload >100MB of mail data
|
|
||||||
before quota is exceeded, and thus depends on the speed of the upload.
|
|
||||||
"""
|
|
||||||
ac1, ac2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(ac1, ac2)
|
|
||||||
|
|
||||||
def parse_size_limit(limit: str) -> int:
|
|
||||||
"""Parse a size limit and return the number of bytes as integer.
|
|
||||||
|
|
||||||
Example input: 100M, 2.4T, 500 K
|
|
||||||
"""
|
|
||||||
units = {"B": 1, "K": 2**10, "M": 2**20, "G": 2**30, "T": 2**40}
|
|
||||||
size = re.sub(r"([KMGT])", r" \1", limit.upper())
|
|
||||||
number, unit = [string.strip() for string in size.split()]
|
|
||||||
return int(float(number) * units[unit])
|
|
||||||
|
|
||||||
quota = parse_size_limit(chatmail_config.max_mailbox_size)
|
|
||||||
attachsize = 1 * 1024 * 1024
|
|
||||||
num_to_send = quota // attachsize + 2
|
|
||||||
lp.sec(f"ac1: send {num_to_send} large files to ac2")
|
|
||||||
lp.indent(f"per-user quota is assumed to be: {quota/(1024*1024)}MB")
|
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
|
||||||
msgs = []
|
|
||||||
for i in range(num_to_send):
|
|
||||||
attachment = tmpdir / f"attachment{i}"
|
|
||||||
data = "".join(random.choice(alphanumeric) for i in range(1024))
|
|
||||||
with open(attachment, "w+") as f:
|
|
||||||
for j in range(attachsize // len(data)):
|
|
||||||
f.write(data)
|
|
||||||
|
|
||||||
msg = chat.send_file(str(attachment))
|
|
||||||
msgs.append(msg)
|
|
||||||
lp.indent(f"Sent out msg {i}, size {attachsize/(1024*1024)}MB")
|
|
||||||
|
|
||||||
lp.sec("ac2: check messages are arriving until quota is reached")
|
|
||||||
|
|
||||||
addr = ac2.get_config("addr").lower()
|
|
||||||
saved_ok = 0
|
|
||||||
for line in remote.iter_output("journalctl -f -u dovecot"):
|
|
||||||
if addr not in line:
|
|
||||||
# print(line)
|
|
||||||
continue
|
|
||||||
if "quota" in line:
|
|
||||||
if "quota exceeded" in line:
|
|
||||||
if saved_ok < num_to_send // 2:
|
|
||||||
pytest.fail(
|
|
||||||
f"quota exceeded too early: after {saved_ok} messages already"
|
|
||||||
)
|
|
||||||
lp.indent("good, message sending failed because quota was exceeded")
|
|
||||||
return
|
|
||||||
if "saved mail to inbox" in line:
|
|
||||||
saved_ok += 1
|
|
||||||
print(f"{saved_ok}: {line}")
|
|
||||||
if saved_ok >= num_to_send:
|
|
||||||
break
|
|
||||||
|
|
||||||
pytest.fail("sending succeeded although messages should exceed quota")
|
|
||||||
|
|
||||||
def test_securejoin(self, cmfactory, lp, maildomain2):
|
|
||||||
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.switch_maildomain(maildomain2)
|
|
||||||
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.bring_accounts_online()
|
|
||||||
|
|
||||||
lp.sec("ac1: create QR code and let ac2 scan it, starting the securejoin")
|
|
||||||
qr = ac1.get_setup_contact_qr()
|
|
||||||
|
|
||||||
lp.sec("ac2: start QR-code based setup contact protocol")
|
|
||||||
ch = ac2.qr_setup_contact(qr)
|
|
||||||
assert ch.id >= 10
|
|
||||||
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
|
||||||
|
|
||||||
def test_read_receipts_between_instances(self, cmfactory, lp, maildomain2):
|
|
||||||
ac1 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.switch_maildomain(maildomain2)
|
|
||||||
ac2 = cmfactory.new_online_configuring_account(cache=False)
|
|
||||||
cmfactory.bring_accounts_online()
|
|
||||||
|
|
||||||
lp.sec("setup encrypted comms between ac1 and ac2 on different instances")
|
|
||||||
qr = ac1.get_setup_contact_qr()
|
|
||||||
ch = ac2.qr_setup_contact(qr)
|
|
||||||
assert ch.id >= 10
|
|
||||||
ac1._evtracker.wait_securejoin_inviter_progress(1000)
|
|
||||||
|
|
||||||
lp.sec("ac1 sends a message and ac2 marks it as seen")
|
|
||||||
chat = ac1.create_chat(ac2)
|
|
||||||
msg = chat.send_text("hi")
|
|
||||||
m = ac2.wait_next_incoming_message()
|
|
||||||
m.mark_seen()
|
|
||||||
# we can only indirectly wait for mark-seen to cause an smtp-error
|
|
||||||
lp.sec("try to wait for markseen to complete and check error states")
|
|
||||||
deadline = time.time() + 3.1
|
|
||||||
while time.time() < deadline:
|
|
||||||
msgs = m.chat.get_messages()
|
|
||||||
for msg in msgs:
|
|
||||||
assert "error" not in m.get_message_info()
|
|
||||||
time.sleep(1)
|
|
||||||
|
|
||||||
|
|
||||||
def test_hide_senders_ip_address(cmfactory):
|
|
||||||
public_ip = requests.get("http://icanhazip.com").content.decode().strip()
|
|
||||||
assert ipaddress.ip_address(public_ip)
|
|
||||||
|
|
||||||
user1, user2 = cmfactory.get_online_accounts(2)
|
|
||||||
chat = cmfactory.get_accepted_chat(user1, user2)
|
|
||||||
|
|
||||||
chat.send_text("testing submission header cleanup")
|
|
||||||
user2.wait_next_incoming_message()
|
|
||||||
user2.direct_imap.select_folder("Inbox")
|
|
||||||
msg = user2.direct_imap.get_all_messages()[0]
|
|
||||||
assert public_ip not in msg.obj.as_string()
|
|
||||||
@@ -1,405 +0,0 @@
|
|||||||
import os
|
|
||||||
import io
|
|
||||||
import time
|
|
||||||
import random
|
|
||||||
import subprocess
|
|
||||||
import imaplib
|
|
||||||
import smtplib
|
|
||||||
import itertools
|
|
||||||
from pathlib import Path
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from chatmaild.database import Database
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
conftestdir = Path(__file__).parent
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_addoption(parser):
|
|
||||||
parser.addoption(
|
|
||||||
"--slow", action="store_true", default=False, help="also run slow tests"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_configure(config):
|
|
||||||
config._benchresults = {}
|
|
||||||
config.addinivalue_line(
|
|
||||||
"markers", "slow: mark test to require --slow option to run"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_runtest_setup(item):
|
|
||||||
markers = list(item.iter_markers(name="slow"))
|
|
||||||
if markers:
|
|
||||||
if not item.config.getoption("--slow"):
|
|
||||||
pytest.skip("skipping slow test, use --slow to run")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def chatmail_config(pytestconfig):
|
|
||||||
current = basedir = Path().resolve()
|
|
||||||
while 1:
|
|
||||||
path = current.joinpath("chatmail.ini").resolve()
|
|
||||||
if path.exists():
|
|
||||||
return read_config(path)
|
|
||||||
if current == current.parent:
|
|
||||||
break
|
|
||||||
current = current.parent
|
|
||||||
|
|
||||||
pytest.skip(f"no chatmail.ini file found in {basedir} or parent dirs")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildomain(chatmail_config):
|
|
||||||
return chatmail_config.mail_domain
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def sshdomain(maildomain):
|
|
||||||
return os.environ.get("CHATMAIL_SSH", maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def maildomain2():
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN2")
|
|
||||||
if not domain:
|
|
||||||
pytest.skip("set CHATMAIL_DOMAIN2 to a ssh-reachable chatmail instance")
|
|
||||||
return domain
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def sshdomain2(maildomain2):
|
|
||||||
return os.environ.get("CHATMAIL_SSH2", maildomain2)
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_report_header():
|
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN")
|
|
||||||
if domain:
|
|
||||||
text = f"chatmail test instance: {domain}"
|
|
||||||
return ["-" * len(text), text, "-" * len(text)]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def benchmark(request):
|
|
||||||
def bench(func, num, name=None, reportfunc=None):
|
|
||||||
if name is None:
|
|
||||||
name = func.__name__
|
|
||||||
durations = []
|
|
||||||
for i in range(num):
|
|
||||||
now = time.time()
|
|
||||||
func()
|
|
||||||
durations.append(time.time() - now)
|
|
||||||
durations.sort()
|
|
||||||
request.config._benchresults[name] = (reportfunc, durations)
|
|
||||||
|
|
||||||
return bench
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_terminal_summary(terminalreporter):
|
|
||||||
tr = terminalreporter
|
|
||||||
results = tr.config._benchresults
|
|
||||||
if not results:
|
|
||||||
return
|
|
||||||
|
|
||||||
tr.section("benchmark results")
|
|
||||||
float_names = "median min max".split()
|
|
||||||
width = max(map(len, float_names))
|
|
||||||
|
|
||||||
def fcol(parts):
|
|
||||||
return " ".join(part.rjust(width) for part in parts)
|
|
||||||
|
|
||||||
headers = f"{'benchmark name': <30} " + fcol(float_names)
|
|
||||||
tr.write_line(headers)
|
|
||||||
tr.write_line("-" * len(headers))
|
|
||||||
summary_lines = []
|
|
||||||
|
|
||||||
for name, (reportfunc, durations) in results.items():
|
|
||||||
measures = [
|
|
||||||
sorted(durations)[len(durations) // 2],
|
|
||||||
min(durations),
|
|
||||||
max(durations),
|
|
||||||
]
|
|
||||||
line = f"{name: <30} "
|
|
||||||
line += fcol(f"{float: 2.2f}" for float in measures)
|
|
||||||
tr.write_line(line)
|
|
||||||
vmedian, vmin, vmax = measures
|
|
||||||
if reportfunc:
|
|
||||||
for line in reportfunc(vmin=vmin, vmedian=vmedian, vmax=vmax):
|
|
||||||
summary_lines.append(line)
|
|
||||||
|
|
||||||
if summary_lines:
|
|
||||||
tr.write_line("")
|
|
||||||
tr.section("benchmark summary measures")
|
|
||||||
for line in summary_lines:
|
|
||||||
tr.write_line(line)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def imap(maildomain):
|
|
||||||
return ImapConn(maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def make_imap_connection(maildomain):
|
|
||||||
def make_imap_connection():
|
|
||||||
conn = ImapConn(maildomain)
|
|
||||||
conn.connect()
|
|
||||||
return conn
|
|
||||||
|
|
||||||
return make_imap_connection
|
|
||||||
|
|
||||||
|
|
||||||
class ImapConn:
|
|
||||||
AuthError = imaplib.IMAP4.error
|
|
||||||
logcmd = "journalctl -f -u dovecot"
|
|
||||||
name = "dovecot"
|
|
||||||
|
|
||||||
def __init__(self, host):
|
|
||||||
self.host = host
|
|
||||||
|
|
||||||
def connect(self):
|
|
||||||
print(f"imap-connect {self.host}")
|
|
||||||
self.conn = imaplib.IMAP4_SSL(self.host)
|
|
||||||
|
|
||||||
def login(self, user, password):
|
|
||||||
print(f"imap-login {user!r} {password!r}")
|
|
||||||
self.conn.login(user, password)
|
|
||||||
|
|
||||||
def fetch_all(self):
|
|
||||||
print("imap-fetch all")
|
|
||||||
status, res = self.conn.select()
|
|
||||||
if int(res[0]) == 0:
|
|
||||||
raise ValueError("no messages in imap folder")
|
|
||||||
status, results = self.conn.fetch("1:*", "(RFC822)")
|
|
||||||
assert status == "OK"
|
|
||||||
return results
|
|
||||||
|
|
||||||
def fetch_all_messages(self):
|
|
||||||
print("imap-fetch all messages")
|
|
||||||
results = self.fetch_all()
|
|
||||||
messages = []
|
|
||||||
for item in results:
|
|
||||||
if len(item) == 2:
|
|
||||||
messages.append(item[1].decode())
|
|
||||||
return messages
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def smtp(maildomain):
|
|
||||||
return SmtpConn(maildomain)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def make_smtp_connection(maildomain):
|
|
||||||
def make_smtp_connection():
|
|
||||||
conn = SmtpConn(maildomain)
|
|
||||||
conn.connect()
|
|
||||||
return conn
|
|
||||||
|
|
||||||
return make_smtp_connection
|
|
||||||
|
|
||||||
|
|
||||||
class SmtpConn:
|
|
||||||
AuthError = smtplib.SMTPAuthenticationError
|
|
||||||
logcmd = "journalctl -f -t postfix/smtpd -t postfix/smtp -t postfix/lmtp"
|
|
||||||
name = "postfix"
|
|
||||||
|
|
||||||
def __init__(self, host):
|
|
||||||
self.host = host
|
|
||||||
|
|
||||||
def connect(self):
|
|
||||||
print(f"smtp-connect {self.host}")
|
|
||||||
self.conn = smtplib.SMTP_SSL(self.host)
|
|
||||||
|
|
||||||
def login(self, user, password):
|
|
||||||
print(f"smtp-login {user!r} {password!r}")
|
|
||||||
self.conn.login(user, password)
|
|
||||||
|
|
||||||
def sendmail(self, from_addr, to_addrs, msg):
|
|
||||||
print(f"smtp-sendmail from={from_addr!r} to_addrs={to_addrs!r}")
|
|
||||||
print(f"smtp-sendmail message size: {len(msg)}")
|
|
||||||
return self.conn.sendmail(from_addr=from_addr, to_addrs=to_addrs, msg=msg)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(params=["imap", "smtp"])
|
|
||||||
def imap_or_smtp(request):
|
|
||||||
return request.getfixturevalue(request.param)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def gencreds(chatmail_config):
|
|
||||||
count = itertools.count()
|
|
||||||
next(count)
|
|
||||||
|
|
||||||
def gen(domain=None):
|
|
||||||
domain = domain if domain else chatmail_config.mail_domain
|
|
||||||
while 1:
|
|
||||||
num = next(count)
|
|
||||||
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
|
|
||||||
user = "".join(
|
|
||||||
random.choices(alphanumeric, k=chatmail_config.username_max_length)
|
|
||||||
)
|
|
||||||
if domain == "nine.testrun.org":
|
|
||||||
user = f"ac{num}_{user}"[:9]
|
|
||||||
else:
|
|
||||||
user = f"ac{num}_{user}"[: chatmail_config.username_max_length]
|
|
||||||
password = "".join(
|
|
||||||
random.choices(alphanumeric, k=chatmail_config.password_min_length)
|
|
||||||
)
|
|
||||||
yield f"{user}@{domain}", f"{password}"
|
|
||||||
|
|
||||||
return lambda domain=None: next(gen(domain))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def db(tmpdir):
|
|
||||||
db_path = tmpdir / "passdb.sqlite"
|
|
||||||
print("database path:", db_path)
|
|
||||||
return Database(db_path)
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Delta Chat testplugin re-use
|
|
||||||
# use the cmfactory fixture to get chatmail instance accounts
|
|
||||||
#
|
|
||||||
|
|
||||||
|
|
||||||
class ChatmailTestProcess:
|
|
||||||
"""Provider for chatmail instance accounts as used by deltachat.testplugin.acfactory"""
|
|
||||||
|
|
||||||
def __init__(self, pytestconfig, maildomain, gencreds):
|
|
||||||
self.pytestconfig = pytestconfig
|
|
||||||
self.maildomain = maildomain
|
|
||||||
assert "." in self.maildomain, maildomain
|
|
||||||
self.gencreds = gencreds
|
|
||||||
self._addr2files = {}
|
|
||||||
|
|
||||||
def get_liveconfig_producer(self):
|
|
||||||
while 1:
|
|
||||||
user, password = self.gencreds(self.maildomain)
|
|
||||||
config = {
|
|
||||||
"addr": user,
|
|
||||||
"mail_pw": password,
|
|
||||||
}
|
|
||||||
# speed up account configuration
|
|
||||||
config["mail_server"] = self.maildomain
|
|
||||||
config["send_server"] = self.maildomain
|
|
||||||
yield config
|
|
||||||
|
|
||||||
def cache_maybe_retrieve_configured_db_files(self, cache_addr, db_target_path):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def cache_maybe_store_configured_db_files(self, acc):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def cmfactory(request, gencreds, tmpdir, maildomain):
|
|
||||||
# cloned from deltachat.testplugin.amfactory
|
|
||||||
pytest.importorskip("deltachat")
|
|
||||||
from deltachat.testplugin import ACFactory
|
|
||||||
|
|
||||||
data = request.getfixturevalue("data")
|
|
||||||
|
|
||||||
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
|
||||||
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
|
||||||
|
|
||||||
# nb. a bit hacky
|
|
||||||
# would probably be better if deltachat's test machinery grows native support
|
|
||||||
def switch_maildomain(maildomain2):
|
|
||||||
am.testprocess.maildomain = maildomain2
|
|
||||||
|
|
||||||
am.switch_maildomain = switch_maildomain
|
|
||||||
|
|
||||||
yield am
|
|
||||||
if hasattr(request.node, "rep_call") and request.node.rep_call.failed:
|
|
||||||
if testproc.pytestconfig.getoption("--extra-info"):
|
|
||||||
logfile = io.StringIO()
|
|
||||||
am.dump_imap_summary(logfile=logfile)
|
|
||||||
print(logfile.getvalue())
|
|
||||||
# request.node.add_report_section("call", "imap-server-state", s)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def remote(sshdomain):
|
|
||||||
return Remote(sshdomain)
|
|
||||||
|
|
||||||
|
|
||||||
class Remote:
|
|
||||||
def __init__(self, sshdomain):
|
|
||||||
self.sshdomain = sshdomain
|
|
||||||
|
|
||||||
def iter_output(self, logcmd=""):
|
|
||||||
getjournal = "journalctl -f" if not logcmd else logcmd
|
|
||||||
self.popen = subprocess.Popen(
|
|
||||||
["ssh", f"root@{self.sshdomain}", getjournal],
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
)
|
|
||||||
while 1:
|
|
||||||
line = self.popen.stdout.readline()
|
|
||||||
res = line.decode().strip().lower()
|
|
||||||
if res:
|
|
||||||
yield res
|
|
||||||
else:
|
|
||||||
break
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def lp(request):
|
|
||||||
class LP:
|
|
||||||
def sec(self, msg):
|
|
||||||
print(f"---- {msg} ----")
|
|
||||||
|
|
||||||
def indent(self, msg):
|
|
||||||
print(f" {msg}")
|
|
||||||
|
|
||||||
return LP()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def cmsetup(maildomain, gencreds):
|
|
||||||
return CMSetup(maildomain, gencreds)
|
|
||||||
|
|
||||||
|
|
||||||
class CMSetup:
|
|
||||||
def __init__(self, maildomain, gencreds):
|
|
||||||
self.maildomain = maildomain
|
|
||||||
self.gencreds = gencreds
|
|
||||||
|
|
||||||
def gen_users(self, num):
|
|
||||||
print(f"Creating {num} online users")
|
|
||||||
users = []
|
|
||||||
for i in range(num):
|
|
||||||
addr, password = self.gencreds()
|
|
||||||
user = CMUser(self.maildomain, addr, password)
|
|
||||||
assert user.smtp
|
|
||||||
users.append(user)
|
|
||||||
return users
|
|
||||||
|
|
||||||
|
|
||||||
class CMUser:
|
|
||||||
def __init__(self, maildomain, addr, password):
|
|
||||||
self.maildomain = maildomain
|
|
||||||
self.addr = addr
|
|
||||||
self.password = password
|
|
||||||
self._smtp = None
|
|
||||||
self._imap = None
|
|
||||||
|
|
||||||
@property
|
|
||||||
def smtp(self):
|
|
||||||
if not self._smtp:
|
|
||||||
handle = SmtpConn(self.maildomain)
|
|
||||||
handle.connect()
|
|
||||||
handle.login(self.addr, self.password)
|
|
||||||
self._smtp = handle
|
|
||||||
return self._smtp
|
|
||||||
|
|
||||||
@property
|
|
||||||
def imap(self):
|
|
||||||
if not self._imap:
|
|
||||||
imap = ImapConn(self.maildomain)
|
|
||||||
imap.connect()
|
|
||||||
imap.login(self.addr, self.password)
|
|
||||||
self._imap = imap
|
|
||||||
return self._imap
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
[pytest]
|
|
||||||
addopts = -vrsx --strict-markers
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import os
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
from cmdeploy.cmdeploy import get_parser, main
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
|
||||||
def _chdir(tmp_path):
|
|
||||||
old = os.getcwd()
|
|
||||||
os.chdir(tmp_path)
|
|
||||||
yield
|
|
||||||
os.chdir(old)
|
|
||||||
|
|
||||||
|
|
||||||
class TestCmdline:
|
|
||||||
def test_parser(self, capsys):
|
|
||||||
parser = get_parser()
|
|
||||||
parser.parse_args([])
|
|
||||||
init = parser.parse_args(["init", "chat.example.org"])
|
|
||||||
run = parser.parse_args(["run"])
|
|
||||||
assert init and run
|
|
||||||
|
|
||||||
@pytest.mark.xfail(reason="init doesn't exit anymore, check for CLI output instead")
|
|
||||||
def test_init_not_overwrite(self):
|
|
||||||
main(["init", "chat.example.org"])
|
|
||||||
with pytest.raises(SystemExit):
|
|
||||||
main(["init", "chat.example.org"])
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
|
|
||||||
from cmdeploy.www import build_webpages
|
|
||||||
|
|
||||||
|
|
||||||
def test_build_webpages(tmp_path, make_config):
|
|
||||||
pkgroot = importlib.resources.files("cmdeploy")
|
|
||||||
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
|
||||||
assert src_dir.exists(), src_dir
|
|
||||||
config = make_config("chat.example.org")
|
|
||||||
build_dir = tmp_path.joinpath("build")
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
assert len([x for x in build_dir.iterdir() if x.suffix == ".html"]) >= 3
|
|
||||||
@@ -1,143 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
import webbrowser
|
|
||||||
import hashlib
|
|
||||||
import time
|
|
||||||
import traceback
|
|
||||||
|
|
||||||
import markdown
|
|
||||||
from jinja2 import Template
|
|
||||||
from .genqr import gen_qr_png_data
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def snapshot_dir_stats(somedir):
|
|
||||||
d = {}
|
|
||||||
for path in somedir.iterdir():
|
|
||||||
if path.is_file() and path.name[0] != "." and path.suffix != ".swp":
|
|
||||||
mtime = path.stat().st_mtime
|
|
||||||
hash = hashlib.md5(path.read_bytes()).hexdigest()
|
|
||||||
d[path] = (mtime, hash)
|
|
||||||
return d
|
|
||||||
|
|
||||||
|
|
||||||
def prepare_template(source):
|
|
||||||
assert source.exists(), source
|
|
||||||
render_vars = {}
|
|
||||||
render_vars["pagename"] = "home" if source.stem == "index" else source.stem
|
|
||||||
render_vars["markdown_html"] = markdown.markdown(source.read_text())
|
|
||||||
page_layout = source.with_name("page-layout.html").read_text()
|
|
||||||
return render_vars, page_layout
|
|
||||||
|
|
||||||
|
|
||||||
def build_webpages(src_dir, build_dir, config):
|
|
||||||
try:
|
|
||||||
_build_webpages(src_dir, build_dir, config)
|
|
||||||
except Exception:
|
|
||||||
print(traceback.format_exc())
|
|
||||||
|
|
||||||
|
|
||||||
def int_to_english(number):
|
|
||||||
if number >= 0 and number <= 12:
|
|
||||||
a = [
|
|
||||||
"zero",
|
|
||||||
"one",
|
|
||||||
"two",
|
|
||||||
"three",
|
|
||||||
"four",
|
|
||||||
"five",
|
|
||||||
"six",
|
|
||||||
"seven",
|
|
||||||
"eight",
|
|
||||||
"nine",
|
|
||||||
"ten",
|
|
||||||
"eleven",
|
|
||||||
"twelve",
|
|
||||||
]
|
|
||||||
return a[number]
|
|
||||||
elif number <= 50:
|
|
||||||
return str(number)
|
|
||||||
if number > 50:
|
|
||||||
return "more"
|
|
||||||
|
|
||||||
|
|
||||||
def _build_webpages(src_dir, build_dir, config):
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
assert src_dir.exists(), src_dir
|
|
||||||
if not build_dir.exists():
|
|
||||||
build_dir.mkdir()
|
|
||||||
|
|
||||||
qr_path = build_dir.joinpath(f"qr-chatmail-invite-{mail_domain}.png")
|
|
||||||
qr_path.write_bytes(gen_qr_png_data(mail_domain).read())
|
|
||||||
|
|
||||||
for path in src_dir.iterdir():
|
|
||||||
if path.suffix == ".md":
|
|
||||||
render_vars, content = prepare_template(path)
|
|
||||||
render_vars["username_min_length"] = int_to_english(
|
|
||||||
config.username_min_length
|
|
||||||
)
|
|
||||||
render_vars["username_max_length"] = int_to_english(
|
|
||||||
config.username_max_length
|
|
||||||
)
|
|
||||||
render_vars["password_min_length"] = int_to_english(
|
|
||||||
config.password_min_length
|
|
||||||
)
|
|
||||||
target = build_dir.joinpath(path.stem + ".html")
|
|
||||||
|
|
||||||
# recursive jinja2 rendering
|
|
||||||
while 1:
|
|
||||||
new = Template(content).render(config=config, **render_vars)
|
|
||||||
if new == content:
|
|
||||||
break
|
|
||||||
content = new
|
|
||||||
|
|
||||||
with target.open("w") as f:
|
|
||||||
f.write(content)
|
|
||||||
elif path.name != "page-layout.html":
|
|
||||||
target = build_dir.joinpath(path.name)
|
|
||||||
target.write_bytes(path.read_bytes())
|
|
||||||
return build_dir
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
path = importlib.resources.files(__package__)
|
|
||||||
reporoot = path.joinpath("../../../").resolve()
|
|
||||||
inipath = reporoot.joinpath("chatmail.ini")
|
|
||||||
config = read_config(inipath)
|
|
||||||
config.webdev = True
|
|
||||||
assert config.mail_domain
|
|
||||||
www_path = reporoot.joinpath("www")
|
|
||||||
src_path = www_path.joinpath("src")
|
|
||||||
stats = None
|
|
||||||
build_dir = www_path.joinpath("build")
|
|
||||||
src_dir = www_path.joinpath("src")
|
|
||||||
index_path = build_dir.joinpath("index.html")
|
|
||||||
|
|
||||||
# start web page generation, open a browser and wait for changes
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
webbrowser.open(str(index_path))
|
|
||||||
stats = snapshot_dir_stats(src_path)
|
|
||||||
print(f"\nOpened URL: file://{index_path.resolve()}\n")
|
|
||||||
print(f"watching {src_path} directory for changes")
|
|
||||||
|
|
||||||
changenum = 0
|
|
||||||
for count in range(0, 1000000):
|
|
||||||
newstats = snapshot_dir_stats(src_path)
|
|
||||||
if newstats == stats and count % 60 != 0:
|
|
||||||
count += 1
|
|
||||||
time.sleep(1.0)
|
|
||||||
continue
|
|
||||||
|
|
||||||
for key in newstats:
|
|
||||||
if stats[key] != newstats[key]:
|
|
||||||
print(f"*** CHANGED: {key}")
|
|
||||||
changenum += 1
|
|
||||||
|
|
||||||
stats = newstats
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
print(f"[{changenum}] regenerated web pages at: {index_path}")
|
|
||||||
print(f"URL: file://{index_path.resolve()}\n\n")
|
|
||||||
count = 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
14
deploy.py
Normal file
14
deploy.py
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import os
|
||||||
|
from pyinfra import host, facts
|
||||||
|
from chatmail import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
mail_domain = os.getenv("CHATMAIL_DOMAIN")
|
||||||
|
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
|
||||||
|
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "2023")
|
||||||
|
|
||||||
|
deploy_chatmail(mail_domain, mail_server, dkim_selector)
|
||||||
|
|
||||||
|
|
||||||
|
main()
|
||||||
11
hpk-inv.py
Normal file
11
hpk-inv.py
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
|
||||||
|
chatmail = [
|
||||||
|
(
|
||||||
|
"c1.testrun.org",
|
||||||
|
{
|
||||||
|
"ssh_user": "root",
|
||||||
|
"domain": "c1.testrun.org",
|
||||||
|
"dkim_selector": "2023",
|
||||||
|
},
|
||||||
|
),
|
||||||
|
]
|
||||||
10
pyproject.toml
Normal file
10
pyproject.toml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=45"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "chatmail"
|
||||||
|
version = "0.1"
|
||||||
|
dependencies = [
|
||||||
|
"pyinfra",
|
||||||
|
]
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
#
|
|
||||||
# Wrapper for cmdelpoy to run it in activated virtualenv.
|
|
||||||
set -e
|
|
||||||
. venv/bin/activate
|
|
||||||
cmdeploy "$@"
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
set -e
|
|
||||||
python3 -m venv venv
|
|
||||||
|
|
||||||
venv/bin/pip install -e chatmaild
|
|
||||||
venv/bin/pip install -e cmdeploy
|
|
||||||
201
src/chatmail/__init__.py
Normal file
201
src/chatmail/__init__.py
Normal file
@@ -0,0 +1,201 @@
|
|||||||
|
"""
|
||||||
|
Chat Mail pyinfra deploy.
|
||||||
|
"""
|
||||||
|
import importlib.resources
|
||||||
|
from io import StringIO
|
||||||
|
|
||||||
|
from pyinfra import host, logger
|
||||||
|
from pyinfra.operations import apt, files, server, systemd, python
|
||||||
|
from pyinfra.facts.files import File
|
||||||
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
|
|
||||||
|
def _install_chatctl() -> None:
|
||||||
|
"""Setup chatctl."""
|
||||||
|
files.put(
|
||||||
|
src=importlib.resources.files(__package__)
|
||||||
|
.joinpath("chatctl/chatctl.py")
|
||||||
|
.open("rb"),
|
||||||
|
dest="/home/vmail/chatctl",
|
||||||
|
user="vmail",
|
||||||
|
group="vmail",
|
||||||
|
mode="755",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
||||||
|
"""Configures OpenDKIM"""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
||||||
|
dest="/etc/opendkim.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
|
||||||
|
files.directory(
|
||||||
|
name="Add opendkim socket directory to /var/spool/postfix",
|
||||||
|
path="/var/spool/postfix/opendkim",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="750",
|
||||||
|
present=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
||||||
|
server.shell(
|
||||||
|
name="Generate OpenDKIM domain keys",
|
||||||
|
commands=[
|
||||||
|
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
||||||
|
],
|
||||||
|
_sudo=True,
|
||||||
|
_sudo_user="opendkim",
|
||||||
|
)
|
||||||
|
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_postfix(domain: str) -> bool:
|
||||||
|
"""Configures Postfix SMTP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"),
|
||||||
|
dest="/etc/postfix/main.cf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain},
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
master_config = files.put(
|
||||||
|
src=importlib.resources.files(__package__)
|
||||||
|
.joinpath("postfix/master.cf")
|
||||||
|
.open("rb"),
|
||||||
|
dest="/etc/postfix/master.cf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_dovecot(mail_server: str) -> bool:
|
||||||
|
"""Configures Dovecot IMAP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"),
|
||||||
|
dest="/etc/dovecot/dovecot.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"hostname": mail_server},
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
# luarocks install http lpeg_patterns fifo
|
||||||
|
auth_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/auth.lua"),
|
||||||
|
dest="/etc/dovecot/auth.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= auth_script.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
||||||
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
|
:param mail_domain: the domain part of your future email addresses, so "example.org" in user@example.org
|
||||||
|
:param mail_server: the DNS name under which your mail server is reachable
|
||||||
|
:param dkim_selector:
|
||||||
|
"""
|
||||||
|
|
||||||
|
apt.update(name="apt update")
|
||||||
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
|
||||||
|
server.group(name="Create opendkim group", group="opendkim", system=True)
|
||||||
|
server.user(
|
||||||
|
name="Add postfix user to opendkim group for socket access",
|
||||||
|
user="postfix",
|
||||||
|
groups=["opendkim"],
|
||||||
|
system=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Deploy acmetool to have TLS certificates.
|
||||||
|
deploy_acmetool(domains=[mail_server])
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install Postfix",
|
||||||
|
packages="postfix",
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install Dovecot",
|
||||||
|
packages=[
|
||||||
|
"dovecot-imapd",
|
||||||
|
"dovecot-lmtpd",
|
||||||
|
"dovecot-auth-lua",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install OpenDKIM",
|
||||||
|
packages=[
|
||||||
|
"opendkim",
|
||||||
|
"opendkim-tools",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
_install_chatctl()
|
||||||
|
dovecot_need_restart = _configure_dovecot(mail_server)
|
||||||
|
postfix_need_restart = _configure_postfix(mail_domain)
|
||||||
|
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable OpenDKIM",
|
||||||
|
service="opendkim.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=opendkim_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Postfix",
|
||||||
|
service="postfix.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=postfix_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Dovecot",
|
||||||
|
service="dovecot.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=dovecot_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
def callback():
|
||||||
|
result = server.shell(
|
||||||
|
commands=[
|
||||||
|
f"""sed 's/\tIN/ 600 IN/;s/\t(//;s/\"$//;s/^\t \"//g; s/ ).*//' """
|
||||||
|
f"""/etc/dkimkeys/{dkim_selector}.txt | tr --delete '\n'"""
|
||||||
|
]
|
||||||
|
)
|
||||||
|
logger.info(f"Add this TXT entry into DNS zone: {result.stdout}")
|
||||||
|
|
||||||
|
python.call(name="Print TXT entry for DKIM", function=callback)
|
||||||
@@ -1,8 +1,14 @@
|
|||||||
import importlib.resources
|
from pathlib import Path
|
||||||
|
|
||||||
from pyinfra.operations import apt, files, systemd, server
|
from pyinfra.operations import apt, files, systemd, server
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.systemd import SystemdStatus
|
|
||||||
|
def openfile(basename):
|
||||||
|
# on newer python versions:
|
||||||
|
# importlib.resources.files(__package__).joinpath(basename).open("rb")
|
||||||
|
# but here we use a way supported on old pythons
|
||||||
|
dirpath = Path(__path__[0])
|
||||||
|
return dirpath.joinpath(basename).open("rb")
|
||||||
|
|
||||||
|
|
||||||
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
||||||
@@ -13,7 +19,7 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
)
|
)
|
||||||
|
|
||||||
files.put(
|
files.put(
|
||||||
src=importlib.resources.files(__package__).joinpath("acmetool.cron").open("rb"),
|
src=openfile("acmetool.cron"),
|
||||||
dest="/etc/cron.d/acmetool",
|
dest="/etc/cron.d/acmetool",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
@@ -22,9 +28,7 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
|
|
||||||
if nginx_hook:
|
if nginx_hook:
|
||||||
files.put(
|
files.put(
|
||||||
src=importlib.resources.files(__package__)
|
src=openfile("acmetool.hook"),
|
||||||
.joinpath("acmetool.hook")
|
|
||||||
.open("rb"),
|
|
||||||
dest="/usr/lib/acme/hooks/nginx",
|
dest="/usr/lib/acme/hooks/nginx",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
@@ -32,7 +36,7 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
)
|
)
|
||||||
|
|
||||||
files.template(
|
files.template(
|
||||||
src=importlib.resources.files(__package__).joinpath("response-file.yaml.j2"),
|
src=openfile("response-file.yaml.j2"),
|
||||||
dest="/var/lib/acme/conf/responses",
|
dest="/var/lib/acme/conf/responses",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
@@ -40,30 +44,13 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
email=email,
|
email=email,
|
||||||
)
|
)
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
|
||||||
dest="/var/lib/acme/conf/target",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
service_file = files.put(
|
service_file = files.put(
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
src=openfile("acmetool-redirector.service"),
|
||||||
"acmetool-redirector.service"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/acmetool-redirector.service",
|
dest="/etc/systemd/system/acmetool-redirector.service",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
if host.get_fact(SystemdStatus).get("nginx.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Stop nginx service to free port 80",
|
|
||||||
service="nginx",
|
|
||||||
running=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Setup acmetool-redirector service",
|
name="Setup acmetool-redirector service",
|
||||||
service="acmetool-redirector.service",
|
service="acmetool-redirector.service",
|
||||||
@@ -72,7 +59,8 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
restarted=service_file.changed,
|
restarted=service_file.changed,
|
||||||
)
|
)
|
||||||
|
|
||||||
server.shell(
|
for domain in domains:
|
||||||
name=f"Request certificate for: { ', '.join(domains) }",
|
server.shell(
|
||||||
commands=[f"acmetool want { ' '.join(domains)}"],
|
name=f"Request certificate for {domain}",
|
||||||
)
|
commands=[f"acmetool want {domain}"],
|
||||||
|
)
|
||||||
17
src/chatmail/chatctl/chatctl.py
Normal file
17
src/chatmail/chatctl/chatctl.py
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
import base64
|
||||||
|
import sys
|
||||||
|
|
||||||
|
if sys.argv[1] == "hexauth":
|
||||||
|
login = base64.b16decode(sys.argv[2])
|
||||||
|
password = base64.b16decode(sys.argv[3])
|
||||||
|
if login == b"link2xt@instant2.testrun.org" and password == b"Ahyei6ie":
|
||||||
|
sys.exit(0)
|
||||||
|
else:
|
||||||
|
sys.exit(1)
|
||||||
|
elif sys.argv[1] == "hexlookup":
|
||||||
|
login = base64.b16decode(sys.argv[2])
|
||||||
|
if login == b"link2xt@instant2.testrun.org":
|
||||||
|
sys.exit(0)
|
||||||
|
else:
|
||||||
|
sys.exit(1)
|
||||||
35
src/chatmail/dovecot/auth.lua
Normal file
35
src/chatmail/dovecot/auth.lua
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
-- Lua based authentication script for Dovecot.
|
||||||
|
--
|
||||||
|
-- It calls external chatctl command to answer requests.
|
||||||
|
|
||||||
|
-- Hexadecimal aka base16 encoding.
|
||||||
|
function hex(data)
|
||||||
|
return (data:gsub(".", function(char) return string.format("%2X", char:byte()) end))
|
||||||
|
end
|
||||||
|
|
||||||
|
-- Escape shell argument by hex encoding it and wrapping in quotes.
|
||||||
|
function escape(data)
|
||||||
|
return ("'"..hex(data).."'")
|
||||||
|
end
|
||||||
|
|
||||||
|
function auth_password_verify(request, password)
|
||||||
|
if os.execute("/home/vmail/chatctl hexauth "..escape(request.user).." "..escape(password)) then
|
||||||
|
return dovecot.auth.PASSDB_RESULT_OK, {}
|
||||||
|
end
|
||||||
|
return dovecot.auth.PASSDB_RESULT_PASSWORD_MISMATCH, ""
|
||||||
|
end
|
||||||
|
|
||||||
|
function auth_passdb_lookup(request)
|
||||||
|
if os.execute("/home/vmail/chatctl hexlookup "..escape(request.user)) then
|
||||||
|
return dovecot.auth.PASSDB_RESULT_OK, {}
|
||||||
|
end
|
||||||
|
return dovecot.auth.PASSDB_RESULT_USER_UNKNOWN, "no such user"
|
||||||
|
end
|
||||||
|
|
||||||
|
function auth_userdb_lookup(request)
|
||||||
|
if os.execute("/home/vmail/chatctl hexlookup "..escape(request.user)) then
|
||||||
|
return dovecot.auth.USERDB_RESULT_OK, "uid=vmail gid=vmail"
|
||||||
|
end
|
||||||
|
|
||||||
|
return dovecot.auth.USERDB_RESULT_USER_UNKNOWN, "no such user"
|
||||||
|
end
|
||||||
94
src/chatmail/dovecot/dovecot.conf.j2
Normal file
94
src/chatmail/dovecot/dovecot.conf.j2
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
## Dovecot configuration file
|
||||||
|
|
||||||
|
protocols = imap lmtp
|
||||||
|
|
||||||
|
auth_mechanisms = plain
|
||||||
|
|
||||||
|
# Authentication for system users.
|
||||||
|
passdb {
|
||||||
|
driver = lua
|
||||||
|
args = file=/etc/dovecot/auth.lua
|
||||||
|
}
|
||||||
|
userdb {
|
||||||
|
driver = lua
|
||||||
|
args = file=/etc/dovecot/auth.lua
|
||||||
|
}
|
||||||
|
|
||||||
|
##
|
||||||
|
## Mailbox locations and namespaces
|
||||||
|
##
|
||||||
|
|
||||||
|
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
||||||
|
mail_location = maildir:/home/vmail/mail/%d/%u
|
||||||
|
|
||||||
|
namespace inbox {
|
||||||
|
inbox = yes
|
||||||
|
|
||||||
|
mailbox Drafts {
|
||||||
|
special_use = \Drafts
|
||||||
|
}
|
||||||
|
mailbox Junk {
|
||||||
|
special_use = \Junk
|
||||||
|
}
|
||||||
|
mailbox Trash {
|
||||||
|
special_use = \Trash
|
||||||
|
}
|
||||||
|
|
||||||
|
# For \Sent mailboxes there are two widely used names. We'll mark both of
|
||||||
|
# them as \Sent. User typically deletes one of them if duplicates are created.
|
||||||
|
mailbox Sent {
|
||||||
|
special_use = \Sent
|
||||||
|
}
|
||||||
|
mailbox "Sent Messages" {
|
||||||
|
special_use = \Sent
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mail_uid = vmail
|
||||||
|
mail_gid = vmail
|
||||||
|
mail_privileged_group = vmail
|
||||||
|
|
||||||
|
##
|
||||||
|
## Mail processes
|
||||||
|
##
|
||||||
|
|
||||||
|
# Enable IMAP COMPRESS (RFC 4978).
|
||||||
|
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
||||||
|
protocol imap {
|
||||||
|
mail_plugins = $mail_plugins imap_zlib
|
||||||
|
}
|
||||||
|
|
||||||
|
plugin {
|
||||||
|
imap_compress_deflate_level = 6
|
||||||
|
}
|
||||||
|
|
||||||
|
service lmtp {
|
||||||
|
user=vmail
|
||||||
|
|
||||||
|
unix_listener /var/spool/postfix/private/dovecot-lmtp {
|
||||||
|
group = postfix
|
||||||
|
mode = 0600
|
||||||
|
user = postfix
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
service auth {
|
||||||
|
unix_listener /var/spool/postfix/private/auth {
|
||||||
|
mode = 0660
|
||||||
|
user = postfix
|
||||||
|
group = postfix
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
service auth-worker {
|
||||||
|
# Default is root.
|
||||||
|
# Drop privileges we don't need.
|
||||||
|
user = $default_internal_user
|
||||||
|
}
|
||||||
|
|
||||||
|
ssl = required
|
||||||
|
ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain
|
||||||
|
ssl_key = </var/lib/acme/live/{{ config.hostname }}/privkey
|
||||||
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
|
ssl_min_protocol = TLSv1.2
|
||||||
|
ssl_prefer_server_ciphers = yes
|
||||||
@@ -1,4 +1,7 @@
|
|||||||
# OpenDKIM configuration.
|
# This is a basic configuration for signing and verifying. It can easily be
|
||||||
|
# adapted to suit a basic installation. See opendkim.conf(5) and
|
||||||
|
# /usr/share/doc/opendkim/examples/opendkim.conf.sample for complete
|
||||||
|
# documentation of available configuration parameters.
|
||||||
|
|
||||||
Syslog yes
|
Syslog yes
|
||||||
SyslogSuccess yes
|
SyslogSuccess yes
|
||||||
@@ -18,9 +21,7 @@ OversignHeaders From
|
|||||||
# setup options can be found in /usr/share/doc/opendkim/README.opendkim.
|
# setup options can be found in /usr/share/doc/opendkim/README.opendkim.
|
||||||
Domain {{ config.domain_name }}
|
Domain {{ config.domain_name }}
|
||||||
Selector {{ config.opendkim_selector }}
|
Selector {{ config.opendkim_selector }}
|
||||||
KeyFile /etc/dkimkeys/{{ config.opendkim_selector }}.private
|
KeyFile /etc/dkimkeys/{{ config.opendkim_selector }}.private
|
||||||
KeyTable /etc/dkimkeys/KeyTable
|
|
||||||
SigningTable refile:/etc/dkimkeys/SigningTable
|
|
||||||
|
|
||||||
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
||||||
# using a local socket with MTAs that access the socket as a non-privileged
|
# using a local socket with MTAs that access the socket as a non-privileged
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
myorigin = {{ config.mail_domain }}
|
myorigin = {{ config.domain_name }}
|
||||||
|
|
||||||
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
||||||
biff = no
|
biff = no
|
||||||
@@ -11,21 +11,21 @@ append_dot_mydomain = no
|
|||||||
|
|
||||||
readme_directory = no
|
readme_directory = no
|
||||||
|
|
||||||
# See http://www.postfix.org/COMPATIBILITY_README.html
|
# See http://www.postfix.org/COMPATIBILITY_README.html -- default to 2 on
|
||||||
compatibility_level = 3.6
|
# fresh installs.
|
||||||
|
compatibility_level = 2
|
||||||
|
|
||||||
# TLS parameters
|
# TLS parameters
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.domain_name }}/fullchain
|
||||||
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.domain_name }}/privkey
|
||||||
smtpd_tls_security_level=may
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
smtp_tls_security_level=may
|
smtp_tls_security_level=may
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
myhostname = {{ config.mail_domain }}
|
myhostname = {{ config.domain_name }}
|
||||||
alias_maps = hash:/etc/aliases
|
alias_maps = hash:/etc/aliases
|
||||||
alias_database = hash:/etc/aliases
|
alias_database = hash:/etc/aliases
|
||||||
|
|
||||||
@@ -37,16 +37,12 @@ mydestination =
|
|||||||
relayhost =
|
relayhost =
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
||||||
mailbox_size_limit = 0
|
mailbox_size_limit = 0
|
||||||
# maximum 30MB sized messages
|
|
||||||
message_size_limit = 31457280
|
|
||||||
recipient_delimiter = +
|
recipient_delimiter = +
|
||||||
inet_interfaces = all
|
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.mail_domain }}
|
virtual_mailbox_domains = {{ config.domain_name }}
|
||||||
|
|
||||||
smtpd_milters = inet:127.0.0.1:11332
|
smtpd_milters = unix:opendkim/opendkim.sock
|
||||||
non_smtpd_milters = $smtpd_milters
|
non_smtpd_milters = $smtpd_milters
|
||||||
|
|
||||||
header_checks = regexp:/etc/postfix/submission_header_cleanup
|
|
||||||
@@ -9,11 +9,7 @@
|
|||||||
# service type private unpriv chroot wakeup maxproc command + args
|
# service type private unpriv chroot wakeup maxproc command + args
|
||||||
# (yes) (yes) (no) (never) (100)
|
# (yes) (yes) (no) (never) (100)
|
||||||
# ==========================================================================
|
# ==========================================================================
|
||||||
{% if debug == true %}
|
smtp inet n - y - - smtpd
|
||||||
smtp inet n - y - - smtpd -v
|
|
||||||
{% else %}
|
|
||||||
smtp inet n - y - - smtpd
|
|
||||||
{% endif %}
|
|
||||||
#smtp inet n - y - 1 postscreen
|
#smtp inet n - y - 1 postscreen
|
||||||
#smtpd pass - - y - - smtpd
|
#smtpd pass - - y - - smtpd
|
||||||
#dnsblog unix - - y - 0 dnsblog
|
#dnsblog unix - - y - 0 dnsblog
|
||||||
@@ -32,8 +28,6 @@ submission inet n - y - - smtpd
|
|||||||
-o smtpd_recipient_restrictions=
|
-o smtpd_recipient_restrictions=
|
||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_client_connection_count_limit=1000
|
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
|
||||||
smtps inet n - y - - smtpd
|
smtps inet n - y - - smtpd
|
||||||
-o syslog_name=postfix/smtps
|
-o syslog_name=postfix/smtps
|
||||||
-o smtpd_tls_wrappermode=yes
|
-o smtpd_tls_wrappermode=yes
|
||||||
@@ -47,9 +41,7 @@ smtps inet n - y - - smtpd
|
|||||||
-o smtpd_sender_restrictions=$mua_sender_restrictions
|
-o smtpd_sender_restrictions=$mua_sender_restrictions
|
||||||
-o smtpd_recipient_restrictions=
|
-o smtpd_recipient_restrictions=
|
||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
-o smtpd_client_connection_count_limit=1000
|
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
|
||||||
#628 inet n - y - - qmqpd
|
#628 inet n - y - - qmqpd
|
||||||
pickup unix n - y 60 1 pickup
|
pickup unix n - y 60 1 pickup
|
||||||
cleanup unix n - y - 0 cleanup
|
cleanup unix n - y - 0 cleanup
|
||||||
@@ -72,11 +64,9 @@ showq unix n - y - - showq
|
|||||||
error unix - - y - - error
|
error unix - - y - - error
|
||||||
retry unix - - y - - error
|
retry unix - - y - - error
|
||||||
discard unix - - y - - discard
|
discard unix - - y - - discard
|
||||||
|
local unix - n n - - local
|
||||||
|
virtual unix - n n - - virtual
|
||||||
lmtp unix - - y - - lmtp
|
lmtp unix - - y - - lmtp
|
||||||
anvil unix - - y - 1 anvil
|
anvil unix - - y - 1 anvil
|
||||||
scache unix - - y - 1 scache
|
scache unix - - y - 1 scache
|
||||||
postlog unix-dgram n - n - 1 postlogd
|
postlog unix-dgram n - n - 1 postlogd
|
||||||
filter unix - n n - - lmtp
|
|
||||||
# Local SMTP server for reinjecting filered mail.
|
|
||||||
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
|
||||||
-o syslog_name=postfix/reinject
|
|
||||||
13
tox.ini
Normal file
13
tox.ini
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
[tox]
|
||||||
|
isolated_build = true
|
||||||
|
envlist = lint
|
||||||
|
|
||||||
|
[testenv:lint]
|
||||||
|
skipdist = True
|
||||||
|
skip_install = True
|
||||||
|
deps =
|
||||||
|
ruff
|
||||||
|
black
|
||||||
|
commands =
|
||||||
|
black --quiet --check --diff src/
|
||||||
|
ruff src/
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 50 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB |
@@ -1,19 +0,0 @@
|
|||||||
|
|
||||||
<img class="banner" src="collage-top.png"/>
|
|
||||||
|
|
||||||
## Dear [Delta Chat](https://get.delta.chat) users and newcomers,
|
|
||||||
|
|
||||||
Welcome to instant, interoperable and [privacy-preserving](privacy.html) messaging :)
|
|
||||||
|
|
||||||
👉 **Tap** or scan this QR code to get a random `@{{config.mail_domain}}` e-mail address
|
|
||||||
|
|
||||||
<a href="DCACCOUNT:https://{{ config.mail_domain }}/cgi-bin/newemail.py">
|
|
||||||
<img width=300 style="float: none;" src="qr-chatmail-invite-{{config.mail_domain}}.png" /></a>
|
|
||||||
|
|
||||||
🐣 **Choose** your Avatar and Name
|
|
||||||
|
|
||||||
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
|
||||||
|
|
||||||
{% if config.mail_domain != "nine.testrun.org" %}
|
|
||||||
<div class="experimental">Note: this is only a temporary development chatmail service</div>
|
|
||||||
{% endif %}
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
|
|
||||||
<img class="banner" src="collage-info.png"/>
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
In the Delta Chat account setup
|
|
||||||
you may tap `LOG INTO YOUR E-MAIL ACCOUNT`
|
|
||||||
and fill the two fields like this:
|
|
||||||
|
|
||||||
- `Address`: invent a word with
|
|
||||||
{% 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 {{ password_min_length }} characters.
|
|
||||||
|
|
||||||
If the e-mail address is not yet taken, you'll get that account.
|
|
||||||
The first login sets your password.
|
|
||||||
|
|
||||||
|
|
||||||
### Rate and storage limits
|
|
||||||
|
|
||||||
- Un-encrypted messages are blocked to recipients outside
|
|
||||||
{{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.
|
|
||||||
|
|
||||||
- You may send up to {{ config.max_user_send_per_minute }} messages per minute.
|
|
||||||
|
|
||||||
- Messages are unconditionally removed {{ config.delete_mails_after }} days after arriving on the server.
|
|
||||||
|
|
||||||
- You can store up to [{{ config.max_mailbox_size }} messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server).
|
|
||||||
|
|
||||||
|
|
||||||
### Who are the operators? Which software is running?
|
|
||||||
|
|
||||||
This chatmail provider is run by a small voluntary group of devs and sysadmins,
|
|
||||||
who [publically develop chatmail provider setups](https://github.com/deltachat/chatmail).
|
|
||||||
Chatmail setups aim to be very low-maintenance, resource efficient and
|
|
||||||
interoperable with any other standards-compliant e-mail service.
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
||||||
<svg
|
|
||||||
width="145"
|
|
||||||
height="145"
|
|
||||||
version="1.1"
|
|
||||||
id="svg4"
|
|
||||||
sodipodi:docname="At_sign.svg"
|
|
||||||
inkscape:version="1.2.2 (b0a84865, 2022-12-01)"
|
|
||||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
||||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
||||||
xmlns="http://www.w3.org/2000/svg"
|
|
||||||
xmlns:svg="http://www.w3.org/2000/svg">
|
|
||||||
<defs
|
|
||||||
id="defs8" />
|
|
||||||
<sodipodi:namedview
|
|
||||||
id="namedview6"
|
|
||||||
pagecolor="#ffffff"
|
|
||||||
bordercolor="#000000"
|
|
||||||
borderopacity="0.25"
|
|
||||||
inkscape:showpageshadow="2"
|
|
||||||
inkscape:pageopacity="0.0"
|
|
||||||
inkscape:pagecheckerboard="0"
|
|
||||||
inkscape:deskcolor="#d1d1d1"
|
|
||||||
showgrid="false"
|
|
||||||
inkscape:zoom="3.0241379"
|
|
||||||
inkscape:cx="67.622577"
|
|
||||||
inkscape:cy="72.913341"
|
|
||||||
inkscape:window-width="1390"
|
|
||||||
inkscape:window-height="1027"
|
|
||||||
inkscape:window-x="55"
|
|
||||||
inkscape:window-y="25"
|
|
||||||
inkscape:window-maximized="0"
|
|
||||||
inkscape:current-layer="svg4" />
|
|
||||||
<g
|
|
||||||
aria-label="@"
|
|
||||||
id="text2"
|
|
||||||
style="font-size:144px;font-family:Arial">
|
|
||||||
<path
|
|
||||||
d="m 79.927878,94.422406 c -2.704286,3.120332 -5.741407,5.637394 -9.111364,7.551194 -3.328352,1.87221 -6.677506,2.80831 -10.047463,2.80831 -3.702792,0 -7.301573,-1.08172 -10.796342,-3.24515 -3.49477,-2.163426 -6.344671,-5.491779 -8.549704,-9.985058 -2.163429,-4.493275 -3.245144,-9.423397 -3.245144,-14.790365 0,-6.615099 1.684978,-13.230199 5.054935,-19.845299 3.411561,-6.656705 7.634407,-11.649233 12.66854,-14.977585 5.034133,-3.328352 9.92265,-4.992528 14.665552,-4.992528 3.619583,0 7.072748,0.956901 10.359496,2.870704 3.286748,1.872198 6.115847,4.742902 8.487297,8.612111 l 2.121825,-9.673023 h 11.170784 l -8.986557,41.87483 c -1.248129,5.824616 -1.872194,9.048957 -1.872194,9.673023 0,1.123319 0.416044,2.101022 1.248132,2.93311 0.873692,0.790484 1.913802,1.185726 3.120332,1.185726 2.20503,0 5.096537,-1.268934 8.674517,-3.806803 4.7429,-3.328352 8.4873,-7.780023 11.23319,-13.355013 2.78749,-5.616594 4.18124,-11.399606 4.18124,-17.349035 0,-6.947935 -1.78899,-13.438222 -5.36697,-19.47086 -3.53637,-6.032638 -8.84094,-10.858749 -15.913687,-14.478332 -7.03114,-3.619583 -14.811161,-5.429374 -23.340064,-5.429374 -9.73543,0 -18.638772,2.288242 -26.710026,6.864726 -8.029649,4.534879 -14.27031,11.06677 -18.721981,19.595673 -4.410066,8.487298 -6.615099,17.598662 -6.615099,27.334092 0,10.193078 2.205033,18.971607 6.615099,26.33559 2.290454,3.78888 -7.136335,18.96983 -3.810585,21.73443 3.138096,2.60861 18.971963,-7.14297 23.031819,-5.44631 8.404089,3.53637 17.702673,5.30456 27.895752,5.30456 10.90035,0 20.032515,-1.83059 27.396492,-5.49178 7.36399,-3.66119 12.87657,-8.11286 16.53776,-13.35501 l 9.29559,4 c -2.12183,4.36846 -3.76221,4.82013 -8.92116,9.35501 -5.15895,4.53488 -11.2956,8.11286 -18.40995,10.73393 -7.114346,2.66268 -15.684851,3.99402 -25.711512,3.99402 -9.236177,0 -17.76508,-1.18572 -25.586707,-3.55717 -7.780023,-2.37145 -29.296198,9.26152 -34.78798,4.47701 -5.49178,-4.7429 5.248856,-25.42482 2.461361,-31.62388 -3.49477,-7.863231 -5.242155,-16.350531 -5.242155,-25.461894 0,-10.151474 2.08022,-19.824498 6.240661,-29.019071 5.075736,-11.274793 12.273297,-19.907706 21.592683,-25.898739 9.360991,-5.991034 20.69819,-8.986551 34.011599,-8.986551 10.317891,0 19.574873,2.121824 27.77093,6.365473 8.23767,4.202045 14.72796,10.484309 19.47086,18.846794 4.03563,7.197561 6.05344,15.019189 6.05344,23.464883 0,12.065277 -4.24365,22.77841 -12.73094,32.1394 -7.572,8.404095 -15.85128,12.606135 -24.837827,12.606135 -2.870704,0 -5.200551,-0.43684 -6.98954,-1.31053 -1.747385,-0.8737 -3.037121,-2.12183 -3.869209,-3.744402 -0.540857,-1.040114 -0.936099,-2.829105 -1.185726,-5.366972 z M 49.723082,77.510217 c 0,5.699803 1.352143,10.130671 4.05643,13.292606 2.704286,3.161935 5.803814,4.742902 9.298583,4.742902 2.329847,0 4.784506,-0.686473 7.363979,-2.059418 2.579473,-1.41455 5.034133,-3.49477 7.363979,-6.240661 2.371451,-2.74589 4.306056,-6.219857 5.803815,-10.421902 1.497759,-4.243649 2.246638,-8.487298 2.246638,-12.730947 0,-5.658198 -1.41455,-10.047462 -4.243649,-13.167793 -2.787495,-3.12033 -6.199056,-4.680495 -10.234683,-4.680495 -2.662682,0 -5.179749,0.686473 -7.5512,2.059418 -2.329846,1.331341 -4.597286,3.494769 -6.802319,6.490286 -2.205033,2.995517 -3.97322,6.635903 -5.304561,10.921156 -1.331341,4.285253 -1.997012,8.216869 -1.997012,11.794848 z"
|
|
||||||
id="path347"
|
|
||||||
style="stroke-width:0.887561"
|
|
||||||
sodipodi:nodetypes="ccsscscsscccccscsccsccsccscscssccscscccsccsccscscccssscccscscsss" />
|
|
||||||
</g>
|
|
||||||
</svg>
|
|
||||||
|
Before Width: | Height: | Size: 4.5 KiB |
@@ -1,74 +0,0 @@
|
|||||||
|
|
||||||
body {
|
|
||||||
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 'Segoe UI Emoji', 'Apple Color Emoji', 'Noto Color Emoji', sans-serif;
|
|
||||||
line-height: 1.4;
|
|
||||||
font-size: 1.2em;
|
|
||||||
max-width: 800px;
|
|
||||||
margin: 20px auto;
|
|
||||||
padding: 0 10px;
|
|
||||||
color: #363636;
|
|
||||||
background: #fff;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
font-size: 2.2em;
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2, h3, h4, h5, h6 {
|
|
||||||
color: #000;
|
|
||||||
margin-bottom: 12px;
|
|
||||||
margin-top: 24px;
|
|
||||||
font-weight: 600;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
text-decoration: none;
|
|
||||||
color: #0076d1;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
img, video {
|
|
||||||
max-width: 100%;
|
|
||||||
height: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
code {
|
|
||||||
background: #efefef;
|
|
||||||
padding: 2.5px 5px;
|
|
||||||
border-radius: 6px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#menu {
|
|
||||||
display: flex;
|
|
||||||
flex-wrap: wrap;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
#menu li {
|
|
||||||
display: inline-block;
|
|
||||||
padding-right: 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
#domain {
|
|
||||||
margin-left: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
#domain a {
|
|
||||||
color: #888;
|
|
||||||
}
|
|
||||||
|
|
||||||
.banner {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.experimental {
|
|
||||||
margin: 3em 0;
|
|
||||||
padding: 1em;
|
|
||||||
border: 4px dashed red;
|
|
||||||
color: red;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user