mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
Compare commits
16 Commits
link2xt/se
...
nginx
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5af1bc939a | ||
|
|
1ea25eb28c | ||
|
|
f333226abe | ||
|
|
45fe8a668b | ||
|
|
beac91159d | ||
|
|
75e7c85e61 | ||
|
|
040b7a74a6 | ||
|
|
0138e59355 | ||
|
|
fffbdc10c3 | ||
|
|
3419e359c8 | ||
|
|
0b051f8154 | ||
|
|
5936f7a3be | ||
|
|
983ffa6236 | ||
|
|
b74fde2a9f | ||
|
|
e176595f1f | ||
|
|
179c79a052 |
77
README.md
77
README.md
@@ -1,61 +1,40 @@
|
|||||||
# Chat Mail server configuration
|
# Chat Mail server configuration
|
||||||
|
|
||||||
This package deploys Postfix and Dovecot servers, including OpenDKIM for DKIM signing.
|
This repository setups a ready-to-go chatmail instance
|
||||||
|
comprised of a minimal setup of the battle-tested
|
||||||
Postfix uses Dovecot for authentication as described in <https://www.postfix.org/SASL_README.html#server_dovecot>
|
[postfix smtp server](https://www.postfix.org) and [dovecot imap server](https://www.dovecot.org).
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
prepare:
|
1. prepare your local system:
|
||||||
|
|
||||||
pip install -e chatmail-infra
|
scripts/init.sh
|
||||||
|
|
||||||
|
2. set environment variable to the chatmail domain you want to setup:
|
||||||
|
|
||||||
|
export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host
|
||||||
|
|
||||||
|
3. run the deploy of the chat mail instance:
|
||||||
|
|
||||||
|
scripts/deploy.sh
|
||||||
|
|
||||||
|
|
||||||
then run with pyinfra command line tool:
|
## Running tests and benchmarks (offline and online)
|
||||||
|
|
||||||
CHATMAIL_DOMAIN=c1.testrun.org pyinfra --ssh-user root c1.testrun.org deploy.py
|
1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows
|
||||||
|
to login to the chatmail instance server.
|
||||||
|
|
||||||
|
2. To run local and online tests:
|
||||||
|
|
||||||
## Structure (wip)
|
scripts/test.sh
|
||||||
```
|
|
||||||
|
|
||||||
# package doveauth tool and deploy chatmail server to a envvar-specified ssh-reachable host
|
3. To run benchmarks against your chatmail instance:
|
||||||
deploy.py
|
|
||||||
|
|
||||||
# chatmail pyinfra deploy package
|
scripts/bench.sh
|
||||||
chatmail-pyinfra
|
|
||||||
pyproject.toml
|
|
||||||
chatmail/__init__ ...
|
|
||||||
|
|
||||||
# doveauth tool used by dovecot's auth mechanism on the host system
|
## Running tests (offline and online)
|
||||||
doveauth
|
|
||||||
README.md
|
|
||||||
pyproject.toml
|
|
||||||
doveauth.py
|
|
||||||
test_doveauth.py
|
|
||||||
|
|
||||||
# lmtp server to block (outgoing) unencrypted messages
|
|
||||||
filtermail
|
|
||||||
README.md
|
|
||||||
pyproject.toml
|
|
||||||
....
|
|
||||||
|
|
||||||
# online tests (after deploy)
|
|
||||||
|
|
||||||
online-tests # runnable via pytest
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# scripts for setup/development/deployment
|
|
||||||
|
|
||||||
scripts/
|
|
||||||
init.sh # create venv/other perequires
|
|
||||||
deploy.sh # run pyinfra based deploy of everything
|
|
||||||
test.sh # run all local and online tests
|
|
||||||
bench.sh # run performance benchmark tests
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Dovecot/Postfix configuration
|
## Dovecot/Postfix configuration
|
||||||
|
|
||||||
### Ports
|
### Ports
|
||||||
@@ -65,4 +44,16 @@ Dovecot listens on ports 143(imap) and 993 (imaps).
|
|||||||
|
|
||||||
## DNS
|
## DNS
|
||||||
|
|
||||||
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).
|
For DKIM you must add a DNS entry as found in /etc/opendkim/selector.txt on your chatmail instance.
|
||||||
|
The above `scripts/deploy.sh` prints out the DKIM selector and DNS entry you
|
||||||
|
need to setup with your DNS provider.
|
||||||
|
|
||||||
|
## Emergency Commands
|
||||||
|
|
||||||
|
If you need to stop account creation,
|
||||||
|
e.g. because some script is wildly creating accounts,
|
||||||
|
just run `touch /tmp/nocreate`.
|
||||||
|
You can remove the file
|
||||||
|
as soon as the attacker was banned
|
||||||
|
by different means.
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ dependencies = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
|
||||||
doveauth-dictproxy = "chatmaild.dictproxy:main"
|
doveauth-dictproxy = "chatmaild.dictproxy:main"
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import json
|
import json
|
||||||
@@ -11,6 +12,8 @@ import subprocess
|
|||||||
|
|
||||||
from .database import Database
|
from .database import Database
|
||||||
|
|
||||||
|
NOCREATE_FILE = "/etc/chatmail-nocreate"
|
||||||
|
|
||||||
|
|
||||||
def encrypt_password(password: str):
|
def encrypt_password(password: str):
|
||||||
password = password.encode("ascii")
|
password = password.encode("ascii")
|
||||||
@@ -27,6 +30,9 @@ def encrypt_password(password: str):
|
|||||||
|
|
||||||
|
|
||||||
def create_user(db, user, password):
|
def create_user(db, user, password):
|
||||||
|
if os.path.exists(NOCREATE_FILE):
|
||||||
|
logging.warning(f"Didn't create account: {NOCREATE_FILE} exists. Delete the file to enable account creation.")
|
||||||
|
return
|
||||||
with db.write_transaction() as conn:
|
with db.write_transaction() as conn:
|
||||||
conn.create_user(user, password)
|
conn.create_user(user, password)
|
||||||
return dict(home=f"/home/vmail/{user}", uid="vmail", gid="vmail", password=password)
|
return dict(home=f"/home/vmail/{user}", uid="vmail", gid="vmail", password=password)
|
||||||
@@ -53,7 +59,7 @@ def lookup_passdb(db, user, password):
|
|||||||
return userdata
|
return userdata
|
||||||
|
|
||||||
|
|
||||||
def handle_dovecot_request(msg, db):
|
def handle_dovecot_request(msg, db, mail_domain):
|
||||||
print(f"received msg: {msg!r}", file=sys.stderr)
|
print(f"received msg: {msg!r}", file=sys.stderr)
|
||||||
short_command = msg[0]
|
short_command = msg[0]
|
||||||
if short_command == "L": # LOOKUP
|
if short_command == "L": # LOOKUP
|
||||||
@@ -64,13 +70,15 @@ def handle_dovecot_request(msg, db):
|
|||||||
res = ""
|
res = ""
|
||||||
if namespace == "shared":
|
if namespace == "shared":
|
||||||
if type == "userdb":
|
if type == "userdb":
|
||||||
res = lookup_userdb(db, user)
|
if user.endswith(f"@{mail_domain}"):
|
||||||
|
res = lookup_userdb(db, user)
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
reply_command = "N"
|
reply_command = "N"
|
||||||
elif type == "passdb":
|
elif type == "passdb":
|
||||||
res = lookup_passdb(db, user, password=args[0])
|
if user.endswith(f"@{mail_domain}"):
|
||||||
|
res = lookup_passdb(db, user, password=args[0])
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
@@ -89,6 +97,8 @@ def main():
|
|||||||
socket = sys.argv[1]
|
socket = sys.argv[1]
|
||||||
passwd_entry = pwd.getpwnam(sys.argv[2])
|
passwd_entry = pwd.getpwnam(sys.argv[2])
|
||||||
db = Database(sys.argv[3])
|
db = Database(sys.argv[3])
|
||||||
|
with open("/etc/mailname", "r") as fp:
|
||||||
|
mail_domain = fp.read().strip()
|
||||||
|
|
||||||
class Handler(StreamRequestHandler):
|
class Handler(StreamRequestHandler):
|
||||||
def handle(self):
|
def handle(self):
|
||||||
@@ -96,7 +106,7 @@ def main():
|
|||||||
msg = self.rfile.readline().strip().decode()
|
msg = self.rfile.readline().strip().decode()
|
||||||
if not msg:
|
if not msg:
|
||||||
break
|
break
|
||||||
res = handle_dovecot_request(msg, db)
|
res = handle_dovecot_request(msg, db, mail_domain)
|
||||||
if res:
|
if res:
|
||||||
print(f"sending result: {res!r}", file=sys.stderr)
|
print(f"sending result: {res!r}", file=sys.stderr)
|
||||||
self.wfile.write(res.encode("ascii"))
|
self.wfile.write(res.encode("ascii"))
|
||||||
|
|||||||
@@ -1,65 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
import base64
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from .database import Database
|
|
||||||
|
|
||||||
|
|
||||||
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 create_user(db, user, password):
|
|
||||||
with db.write_transaction() as conn:
|
|
||||||
conn.create_user(user, password)
|
|
||||||
return dict(home=f"/home/vmail/{user}", uid="vmail", gid="vmail", password=password)
|
|
||||||
|
|
||||||
|
|
||||||
def verify_user(db, user, password):
|
|
||||||
userdata = get_user_data(db, user)
|
|
||||||
if userdata:
|
|
||||||
if userdata.get("password") == password:
|
|
||||||
userdata["status"] = "ok"
|
|
||||||
else:
|
|
||||||
userdata["status"] = "fail"
|
|
||||||
else:
|
|
||||||
userdata = create_user(db, user, password)
|
|
||||||
userdata["status"] = "ok"
|
|
||||||
|
|
||||||
return userdata
|
|
||||||
|
|
||||||
|
|
||||||
def lookup_user(db, user):
|
|
||||||
userdata = get_user_data(db, user)
|
|
||||||
if userdata:
|
|
||||||
userdata["status"] = "ok"
|
|
||||||
else:
|
|
||||||
userdata["status"] = "fail"
|
|
||||||
return userdata
|
|
||||||
|
|
||||||
|
|
||||||
def dump_result(res):
|
|
||||||
for key, value in res.items():
|
|
||||||
print(f"{key}={value}")
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
db = Database("/home/vmail/passdb.sqlite")
|
|
||||||
if sys.argv[1] == "hexauth":
|
|
||||||
login = base64.b16decode(sys.argv[2]).decode()
|
|
||||||
password = base64.b16decode(sys.argv[3]).decode()
|
|
||||||
res = verify_user(db, login, password)
|
|
||||||
dump_result(res)
|
|
||||||
elif sys.argv[1] == "hexlookup":
|
|
||||||
login = base64.b16decode(sys.argv[2]).decode()
|
|
||||||
res = lookup_user(db, login)
|
|
||||||
dump_result(res)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -9,9 +9,8 @@ from aiosmtpd.controller import UnixSocketController
|
|||||||
from smtplib import SMTP as SMTPClient
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
|
|
||||||
def check_encrypted(content):
|
def check_encrypted(message):
|
||||||
"""Check that the message is an OpenPGP-encrypted message."""
|
"""Check that the message is an OpenPGP-encrypted message."""
|
||||||
message = BytesParser(policy=policy.default).parsebytes(content)
|
|
||||||
if not message.is_multipart():
|
if not message.is_multipart():
|
||||||
return False
|
return False
|
||||||
if message.get("subject") != "...":
|
if message.get("subject") != "...":
|
||||||
@@ -47,7 +46,8 @@ class ExampleHandler:
|
|||||||
|
|
||||||
valid_recipients = []
|
valid_recipients = []
|
||||||
|
|
||||||
mail_encrypted = check_encrypted(envelope.content)
|
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
||||||
|
mail_encrypted = check_encrypted(message)
|
||||||
|
|
||||||
res = []
|
res = []
|
||||||
for recipient in envelope.rcpt_tos:
|
for recipient in envelope.rcpt_tos:
|
||||||
@@ -68,7 +68,13 @@ class ExampleHandler:
|
|||||||
continue
|
continue
|
||||||
|
|
||||||
is_outgoing = recipient_local_domain[1] != my_local_domain[1]
|
is_outgoing = recipient_local_domain[1] != my_local_domain[1]
|
||||||
if is_outgoing and not mail_encrypted:
|
|
||||||
|
if (
|
||||||
|
is_outgoing
|
||||||
|
and not mail_encrypted
|
||||||
|
and message.get("secure-join") != "vc-request"
|
||||||
|
and message.get("secure-join") != "vg-request"
|
||||||
|
):
|
||||||
res += ["500 Outgoing mail must be encrypted"]
|
res += ["500 Outgoing mail must be encrypted"]
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from .dictproxy import get_user_data
|
import chatmaild.dictproxy
|
||||||
from .doveauth import verify_user
|
from .dictproxy import get_user_data, lookup_passdb
|
||||||
from .database import Database, DBError
|
from .database import Database, DBError
|
||||||
|
|
||||||
|
|
||||||
@@ -13,16 +15,31 @@ def db(tmpdir):
|
|||||||
|
|
||||||
|
|
||||||
def test_basic(db):
|
def test_basic(db):
|
||||||
verify_user(db, "link2xt@c1.testrun.org", "asdf")
|
chatmaild.dictproxy.NOCREATE_FILE = "/tmp/nocreate"
|
||||||
|
if os.path.exists(chatmaild.dictproxy.NOCREATE_FILE):
|
||||||
|
os.remove(chatmaild.dictproxy.NOCREATE_FILE)
|
||||||
|
lookup_passdb(db, "link2xt@c1.testrun.org", "asdf")
|
||||||
data = get_user_data(db, "link2xt@c1.testrun.org")
|
data = get_user_data(db, "link2xt@c1.testrun.org")
|
||||||
assert data
|
assert data
|
||||||
|
|
||||||
|
|
||||||
def test_verify_or_create(db):
|
def test_dont_overwrite_password_on_wrong_login(db):
|
||||||
res = verify_user(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983")
|
"""Test that logging in with a different password doesn't create a new user"""
|
||||||
assert res["status"] == "ok"
|
res = lookup_passdb(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983")
|
||||||
res = verify_user(db, "newuser1@something.org", "kajdlqweqwe")
|
assert res["password"]
|
||||||
assert res["status"] == "fail"
|
res2 = lookup_passdb(db, "newuser1@something.org", "kajdlqweqwe")
|
||||||
|
# this function always returns a password hash, which is actually compared by dovecot.
|
||||||
|
assert res["password"] == res2["password"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_nocreate_file(db):
|
||||||
|
chatmaild.dictproxy.NOCREATE_FILE = "/tmp/nocreate"
|
||||||
|
with open(chatmaild.dictproxy.NOCREATE_FILE, "w+") as f:
|
||||||
|
f.write("")
|
||||||
|
assert os.path.exists(chatmaild.dictproxy.NOCREATE_FILE)
|
||||||
|
lookup_passdb(db, "newuser1@something.org", "kajdlqweqwe")
|
||||||
|
assert not get_user_data(db, "newuser1@something.org")
|
||||||
|
os.remove(chatmaild.dictproxy.NOCREATE_FILE)
|
||||||
|
|
||||||
|
|
||||||
def test_db_version(db):
|
def test_db_version(db):
|
||||||
|
|||||||
@@ -1,12 +1,16 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from .filtermail import check_encrypted
|
from .filtermail import check_encrypted
|
||||||
|
from email.parser import BytesParser
|
||||||
|
from email import policy
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail():
|
def test_filtermail():
|
||||||
assert not check_encrypted(b"foo")
|
def check_encrypted_bstr(content):
|
||||||
|
message = BytesParser(policy=policy.default).parsebytes(content)
|
||||||
|
return check_encrypted(message)
|
||||||
|
|
||||||
assert not check_encrypted(
|
assert not check_encrypted_bstr(b"foo")
|
||||||
|
|
||||||
|
assert not check_encrypted_bstr(
|
||||||
"\r\n".join(
|
"\r\n".join(
|
||||||
[
|
[
|
||||||
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
||||||
@@ -36,7 +40,7 @@ def test_filtermail():
|
|||||||
).encode()
|
).encode()
|
||||||
)
|
)
|
||||||
|
|
||||||
assert not check_encrypted(
|
assert not check_encrypted_bstr(
|
||||||
"\r\n".join(
|
"\r\n".join(
|
||||||
[
|
[
|
||||||
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
||||||
@@ -67,7 +71,7 @@ def test_filtermail():
|
|||||||
)
|
)
|
||||||
|
|
||||||
# https://xkcd.com/1181/
|
# https://xkcd.com/1181/
|
||||||
assert not check_encrypted(
|
assert not check_encrypted_bstr(
|
||||||
"\r\n".join(
|
"\r\n".join(
|
||||||
[
|
[
|
||||||
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
"Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
|
||||||
@@ -99,7 +103,7 @@ def test_filtermail():
|
|||||||
).encode()
|
).encode()
|
||||||
)
|
)
|
||||||
|
|
||||||
assert check_encrypted(
|
assert check_encrypted_bstr(
|
||||||
"\r\n".join(
|
"\r\n".join(
|
||||||
[
|
[
|
||||||
"Subject: ...",
|
"Subject: ...",
|
||||||
@@ -172,7 +176,7 @@ def test_filtermail():
|
|||||||
).encode()
|
).encode()
|
||||||
)
|
)
|
||||||
|
|
||||||
assert not check_encrypted(
|
assert not check_encrypted_bstr(
|
||||||
"\r\n".join(
|
"\r\n".join(
|
||||||
[
|
[
|
||||||
"Subject: Buy Penis Enlargement at www.malicious-domain.com",
|
"Subject: Buy Penis Enlargement at www.malicious-domain.com",
|
||||||
@@ -245,7 +249,7 @@ def test_filtermail():
|
|||||||
).encode()
|
).encode()
|
||||||
)
|
)
|
||||||
|
|
||||||
assert not check_encrypted(
|
assert not check_encrypted_bstr(
|
||||||
"\r\n".join(
|
"\r\n".join(
|
||||||
[
|
[
|
||||||
"Subject: Message opened",
|
"Subject: Message opened",
|
||||||
|
|||||||
@@ -110,7 +110,7 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_postfix(domain: str) -> bool:
|
def _configure_postfix(domain: str, debug: bool = False) -> bool:
|
||||||
"""Configures Postfix SMTP server."""
|
"""Configures Postfix SMTP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -124,21 +124,20 @@ def _configure_postfix(domain: str) -> bool:
|
|||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
master_config = files.put(
|
master_config = files.template(
|
||||||
src=importlib.resources.files(__package__)
|
src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"),
|
||||||
.joinpath("postfix/master.cf")
|
|
||||||
.open("rb"),
|
|
||||||
dest="/etc/postfix/master.cf",
|
dest="/etc/postfix/master.cf",
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
|
debug=debug,
|
||||||
)
|
)
|
||||||
need_restart |= master_config.changed
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(mail_server: str) -> bool:
|
def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
|
||||||
"""Configures Dovecot IMAP server."""
|
"""Configures Dovecot IMAP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -149,6 +148,7 @@ def _configure_dovecot(mail_server: str) -> bool:
|
|||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config={"hostname": mail_server},
|
config={"hostname": mail_server},
|
||||||
|
debug=debug,
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
auth_config = files.put(
|
auth_config = files.put(
|
||||||
@@ -173,6 +173,33 @@ def _configure_dovecot(mail_server: str) -> bool:
|
|||||||
return need_restart
|
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.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("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
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> None:
|
||||||
"""Deploy a chat-mail instance.
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
@@ -194,7 +221,7 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
)
|
)
|
||||||
|
|
||||||
# Deploy acmetool to have TLS certificates.
|
# Deploy acmetool to have TLS certificates.
|
||||||
deploy_acmetool(domains=[mail_server])
|
deploy_acmetool(nginx_hook=True, domains=[mail_server])
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Postfix",
|
name="Install Postfix",
|
||||||
@@ -214,10 +241,17 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install nginx",
|
||||||
|
packages=["nginx"],
|
||||||
|
)
|
||||||
|
|
||||||
_install_chatmaild()
|
_install_chatmaild()
|
||||||
dovecot_need_restart = _configure_dovecot(mail_server)
|
debug = False
|
||||||
postfix_need_restart = _configure_postfix(mail_domain)
|
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
||||||
|
postfix_need_restart = _configure_postfix(mail_domain, debug=debug)
|
||||||
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
opendkim_need_restart = _configure_opendkim(mail_domain, dkim_selector)
|
||||||
|
nginx_need_restart = _configure_nginx(mail_domain)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable OpenDKIM",
|
name="Start and enable OpenDKIM",
|
||||||
@@ -243,6 +277,21 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
restarted=dovecot_need_restart,
|
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"],
|
||||||
|
)
|
||||||
|
|
||||||
def callback():
|
def callback():
|
||||||
result = server.shell(
|
result = server.shell(
|
||||||
commands=[
|
commands=[
|
||||||
|
|||||||
@@ -38,22 +38,13 @@ def deploy_acmetool(nginx_hook=False, email="", domains=[]):
|
|||||||
email=email,
|
email=email,
|
||||||
)
|
)
|
||||||
|
|
||||||
service_file = files.put(
|
files.template(
|
||||||
src=importlib.resources.files(__package__)
|
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
||||||
.joinpath("acmetool-redirector.service")
|
dest="/var/lib/acme/conf/target",
|
||||||
.open("rb"),
|
|
||||||
dest="/etc/systemd/system/acmetool-redirector.service",
|
|
||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
systemd.service(
|
|
||||||
name="Setup acmetool-redirector service",
|
|
||||||
service="acmetool-redirector.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=service_file.changed,
|
|
||||||
)
|
|
||||||
|
|
||||||
for domain in domains:
|
for domain in domains:
|
||||||
server.shell(
|
server.shell(
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=acmetool HTTP redirector
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=notify
|
|
||||||
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
request:
|
||||||
|
provider: https://acme-v02.api.letsencrypt.org/directory
|
||||||
|
key:
|
||||||
|
type: rsa
|
||||||
|
challenge:
|
||||||
|
webroot-paths:
|
||||||
|
- /var/www/html/.well-known/acme-challenge
|
||||||
37
deploy-chatmail/src/deploy_chatmail/autoconfig.xml.j2
Normal file
37
deploy-chatmail/src/deploy_chatmail/autoconfig.xml.j2
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
<?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>
|
||||||
@@ -4,13 +4,23 @@ protocols = imap lmtp
|
|||||||
|
|
||||||
auth_mechanisms = plain
|
auth_mechanisms = plain
|
||||||
|
|
||||||
|
{% if debug == true %}
|
||||||
auth_verbose = yes
|
auth_verbose = yes
|
||||||
auth_debug = yes
|
auth_debug = yes
|
||||||
auth_debug_passwords = yes
|
auth_debug_passwords = yes
|
||||||
auth_verbose_passwords = plain
|
auth_verbose_passwords = plain
|
||||||
auth_cache_size = 100M
|
auth_cache_size = 100M
|
||||||
mail_plugins = quota
|
|
||||||
mail_debug = yes
|
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
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
# Authentication for system users.
|
||||||
passdb {
|
passdb {
|
||||||
|
|||||||
47
deploy-chatmail/src/deploy_chatmail/nginx.conf.j2
Normal file
47
deploy-chatmail/src/deploy_chatmail/nginx.conf.j2
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
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 80 default_server;
|
||||||
|
listen [::]:80 default_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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@@ -9,7 +9,11 @@
|
|||||||
# 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)
|
||||||
# ==========================================================================
|
# ==========================================================================
|
||||||
smtp inet n - y - - smtpd -v
|
{% if debug == true %}
|
||||||
|
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
|
||||||
@@ -66,8 +70,6 @@ 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
|
||||||
@@ -67,3 +67,17 @@ class TestEndToEndDeltaChat:
|
|||||||
break
|
break
|
||||||
|
|
||||||
pytest.fail("sending succeeded although messages should exceed quota")
|
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)
|
||||||
|
|||||||
6
plan.txt
6
plan.txt
@@ -8,12 +8,6 @@
|
|||||||
- limit: configure max-connections per account
|
- limit: configure max-connections per account
|
||||||
|
|
||||||
|
|
||||||
## Filtermail
|
|
||||||
|
|
||||||
- (alex, Only allow (outgoing) mails if secure-join or autocrypt-pgp-encrypted format.
|
|
||||||
TODO: mime-parse mails and check/add tests
|
|
||||||
|
|
||||||
|
|
||||||
## nami: send out rate limit / rspamd
|
## nami: send out rate limit / rspamd
|
||||||
|
|
||||||
- basic outgoing send rate/limits (depending on "account-rating")
|
- basic outgoing send rate/limits (depending on "account-rating")
|
||||||
|
|||||||
@@ -2,8 +2,9 @@
|
|||||||
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
||||||
export CHATMAIL_DOMAIN
|
export CHATMAIL_DOMAIN
|
||||||
|
|
||||||
venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
|
chatmaild/venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
|
||||||
|
|
||||||
deploy-chatmail/venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" deploy.py
|
deploy-chatmail/venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" \
|
||||||
|
deploy-chatmail/src/deploy_chatmail/deploy.py
|
||||||
|
|
||||||
rm -r dist/
|
rm -r dist/
|
||||||
|
|||||||
@@ -6,12 +6,9 @@ deploy-chatmail/venv/bin/pip install -e deploy-chatmail
|
|||||||
deploy-chatmail/venv/bin/pip install -e chatmaild
|
deploy-chatmail/venv/bin/pip install -e chatmaild
|
||||||
|
|
||||||
python3 -m venv chatmaild/venv
|
python3 -m venv chatmaild/venv
|
||||||
chatmaild/venv/bin/pip install pytest
|
sudo apt install -y dovecot-core && sudo systemctl disable --now dovecot
|
||||||
|
chatmaild/venv/bin/pip install --upgrade pytest build 'setuptools>=68'
|
||||||
chatmaild/venv/bin/pip install -e chatmaild
|
chatmaild/venv/bin/pip install -e chatmaild
|
||||||
|
|
||||||
python3 -m venv online-tests/venv
|
python3 -m venv online-tests/venv
|
||||||
online-tests/venv/bin/pip install pytest pytest-timeout pdbpp deltachat pytest-benchmark
|
online-tests/venv/bin/pip install pytest pytest-timeout pdbpp deltachat pytest-benchmark
|
||||||
|
|
||||||
python3 -m venv venv
|
|
||||||
venv/bin/pip install build
|
|
||||||
venv/bin/pip install 'setuptools>=68'
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
set -e
|
set -e
|
||||||
|
|
||||||
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
|
||||||
: ${CHATMAIL_SSH_HOST:=$CHATMAIL_DOMAIN}
|
: ${CHATMAIL_SSH:=$CHATMAIL_DOMAIN}
|
||||||
|
|
||||||
rsync -avz . "root@$CHATMAIL_SSH_HOST:/root/chatmail" --exclude='/.git' --filter="dir-merge,- .gitignore"
|
rsync -avz . "root@$CHATMAIL_SSH:/root/chatmail" --exclude='/.git' --filter="dir-merge,- .gitignore"
|
||||||
ssh "root@$CHATMAIL_SSH_HOST" "cd /root/chatmail; apt install -y python3-venv; python3 -m venv venv; venv/bin/pip install pyinfra build; venv/bin/python3 -m build -n --sdist chatmaild --outdir dist; venv/bin/pip install -e ./deploy-chatmail -e ./chatmaild; export CHATMAIL_DOMAIN=$CHATMAIL_DOMAIN; venv/bin/pyinfra @local deploy.py"
|
ssh "root@$CHATMAIL_SSH" "cd /root/chatmail; apt install -y python3-venv; python3 -m venv venv; venv/bin/pip install pyinfra build; venv/bin/python3 -m build -n --sdist chatmaild --outdir dist; venv/bin/pip install -e ./deploy-chatmail -e ./chatmaild; export CHATMAIL_DOMAIN=$CHATMAIL_DOMAIN; venv/bin/pyinfra @local deploy.py"
|
||||||
|
|||||||
@@ -1,7 +1,3 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
set -e
|
chatmaild/venv/bin/pytest chatmaild/ $@
|
||||||
pushd chatmaild/src/chatmaild
|
online-tests/venv/bin/pytest online-tests/ -vrx --durations=5 $@
|
||||||
../../venv/bin/pytest
|
|
||||||
popd
|
|
||||||
|
|
||||||
online-tests/venv/bin/pytest online-tests/ -vrx --durations=5
|
|
||||||
|
|||||||
Reference in New Issue
Block a user