Compare commits

..

8 Commits

Author SHA1 Message Date
holger krekel
31e08832a6 shift functions to a DictProxy class 2023-10-21 01:40:58 +02:00
holger krekel
9d175316ff formatting and fixture move 2023-10-21 01:32:36 +02:00
holger krekel
fdd528841f fix nocreate tests 2023-10-21 01:17:09 +02:00
holger krekel
00b4c484ff add missing file 2023-10-21 01:16:35 +02:00
holger krekel
0950d7ea8f rename fixture to maildata and rename doveauth 2023-10-21 00:53:47 +02:00
holger krekel
7dd2d0b9b4 more maildata shifting 2023-10-21 00:47:19 +02:00
holger krekel
dd232689a7 move all inlined mails to a data directory 2023-10-21 00:06:30 +02:00
holger krekel
c613ca24af move all tests into a root "tests" folder so they can share setup and config 2023-10-20 23:07:48 +02:00
32 changed files with 170 additions and 486 deletions

View File

@@ -5,27 +5,14 @@ on:
push: push:
jobs: jobs:
tox: lint:
name: chatmail tests name: Lint
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: run chatmaild tests - name: Lint chatmaild
working-directory: chatmaild working-directory: chatmaild
run: pipx run tox run: pipx run tox
- name: run deploy-chatmail offline tests - name: Lint deploy-chatmail
working-directory: deploy-chatmail working-directory: deploy-chatmail
run: pipx run tox run: pipx run tox
- name: run deploy-chatmail offline tests
working-directory: deploy-chatmail
run: pipx run tox
scripts:
name: chatmail script invocations
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: run init.sh
run: ./scripts/init.sh
- name: run test.sh
run: ./scripts/test.sh

2
.gitignore vendored
View File

@@ -159,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

View File

@@ -1,61 +1,23 @@
# Chatmail instances optimized for Delta Chat apps # Chat Mail server configuration
This repository helps to setup a ready-to-use chatmail instance This repository setups a ready-to-go chatmail instance
comprised of a minimal setup of the battle-tested comprised of a minimal setup of the battle-tested
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services. [postfix smtp server](https://www.postfix.org) and [dovecot imap server](https://www.dovecot.org).
The setup is designed and optimized for providing chatmail accounts ## Getting started
for use by [Delta Chat apps](https://delta.chat).
Chatmail accounts are automatically created by a first login, 1. prepare your local system:
after which the initially specified password is required for using them.
## Getting Started deploying your own chatmail instance
1. Prepare your local (presumably Linux) system:
scripts/init.sh scripts/init.sh
2. Setup a domain with `A` and `AAAA` records for your chatmail server. 2. set environment variable to the chatmail domain you want to setup:
3. Set environment variable to the chatmail domain you want to setup:
export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host
4. Deploy the chat mail instance to your chatmail server: 3. run the deploy of the chat mail instance:
scripts/deploy.sh scripts/deploy.sh
This script uses `pyinfra` and `ssh` to setup packages and configure
the chatmail instance on your remote server.
5. Run `scripts/generate-dns-zone.sh` and
transfer the generated DNS records at your DNS provider
6. Start a Delta Chat app and create a new account
by typing an e-mail address with an arbitrary username
and `@<your-chatmail-domain>` appended.
Use an at least 10-character random password.
### Ports
Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
Dovecot listens on ports 143(imap) and 993 (imaps).
Delta Chat will, however, discover all ports and configurations
automatically by reading the `autoconfig.xml` file from the chatmail instance.
## Emergency Commands to disable automatic account creation
If you need to stop account creation,
e.g. because some script is wildly creating accounts, run:
touch /etc/chatmail-nocreate
While this file is present, account creation will be blocked.
## Running tests and benchmarks (offline and online) ## Running tests and benchmarks (offline and online)
@@ -70,26 +32,28 @@ While this file is present, account creation will be blocked.
scripts/bench.sh scripts/bench.sh
## Running tests (offline and online)
## Development Background for chatmail instances ```
## Dovecot/Postfix configuration
This repository drives the development of "chatmail instances", ### Ports
comprised of minimal setups of
- [postfix smtp server](https://www.postfix.org) Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
- [dovecot imap server](https://www.dovecot.org) Dovecot listens on ports 143(imap) and 993 (imaps).
as well as two custom services that are integrated with these two: ## DNS
- `chatmaild/src/chatmaild/dictproxy.py` implements For DKIM you must add a DNS entry as found in /etc/opendkim/selector.txt on your chatmail instance.
create-on-login account creation semantics and is used The above `scripts/deploy.sh` prints out the DKIM selector and DNS entry you
by Dovecot during login authentication and by Postfix need to setup with your DNS provider.
which in turn uses Dovecot SASL to authenticate users
to send mails for them.
- `chatmaild/src/chatmaild/filtermail.py` prevents
unencrypted e-mail from leaving the chatmail instance
and is integrated into postfix's outbound mail pipelines.
## 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.

View File

@@ -20,7 +20,7 @@ addopts = "-v -ra --strict-markers"
legacy_tox_ini = """ legacy_tox_ini = """
[tox] [tox]
isolated_build = true isolated_build = true
envlist = lint,py envlist = lint
[testenv:lint] [testenv:lint]
skipdist = True skipdist = True
@@ -31,10 +31,4 @@ deps =
commands = commands =
black --quiet --check --diff src/ black --quiet --check --diff src/
ruff src/ ruff src/
[testenv]
passenv = CHATMAIL_DOMAIN
deps = pytest
pdbpp
commands = pytest -v -rsXx {posargs: ../tests/chatmaild}
""" """

View File

@@ -21,92 +21,68 @@ def encrypt_password(password: str):
return "{SHA512-CRYPT}" + passhash return "{SHA512-CRYPT}" + passhash
def is_allowed_to_create(user, cleartext_password) -> bool: class DictProxy:
"""Return True if user and password are admissable.""" def __init__(self, db, mail_domain):
if os.path.exists(NOCREATE_FILE): self.db = db
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.") self.mail_domain = mail_domain
return False
if len(cleartext_password) < 10: def create_user(self, user, password):
logging.warning("Password needs to be at least 10 characters long") if os.path.exists(NOCREATE_FILE):
return False logging.warning(f"Didn't create account: {NOCREATE_FILE} exists.")
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 domain == "nine.testrun.org":
# nine.testrun.org policy, username has to be exactly nine chars
if len(localpart) != 9:
logging.warning(f"localpart {localpart!r} has not exactly nine chars")
return False
return True
def create_user(db, user, encrypted_password):
with db.write_transaction() as conn:
conn.create_user(user, encrypted_password)
return dict(
home=f"/home/vmail/{user}",
uid="vmail",
gid="vmail",
password=encrypted_password,
)
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, user, cleartext_password):
userdata = get_user_data(db, user)
if not userdata:
if not is_allowed_to_create(user, cleartext_password):
return return
encrypted_password = encrypt_password(cleartext_password) with self.db.write_transaction() as conn:
userdata = create_user(db=db, user=user, encrypted_password=encrypted_password) conn.create_user(user, password)
userdata["password"] = userdata["password"].strip() return dict(home=f"/home/vmail/{user}", uid="vmail", gid="vmail", password=password)
return userdata
def get_user_data(self, user):
with self.db.read_connection() as conn:
result = conn.get_user(user)
if result:
result["uid"] = "vmail"
result["gid"] = "vmail"
return result
def handle_dovecot_request(msg, db, mail_domain): def lookup_userdb(self, user):
short_command = msg[0] return self.get_user_data(user)
if short_command == "L": # LOOKUP
parts = msg[1:].split("\t")
keyname, user = parts[:2] def lookup_passdb(self, user, password):
namespace, type, *args = keyname.split("/") userdata = self.get_user_data(user)
reply_command = "F" if not userdata:
res = "" return self.create_user(user, encrypt_password(password))
if namespace == "shared": userdata["password"] = userdata["password"].strip()
if type == "userdb": return userdata
if user.endswith(f"@{mail_domain}"):
res = lookup_userdb(db, user)
if res: def handle_dovecot_request(self, msg):
reply_command = "O" print(f"received msg: {msg!r}", file=sys.stderr)
else: short_command = msg[0]
reply_command = "N" if short_command == "L": # LOOKUP
elif type == "passdb": parts = msg[1:].split("\t")
if user.endswith(f"@{mail_domain}"): keyname, user = parts[:2]
res = lookup_passdb(db, user, cleartext_password=args[0]) namespace, type, *args = keyname.split("/")
if res: reply_command = "F"
reply_command = "O" res = ""
else: if namespace == "shared":
reply_command = "N" if type == "userdb":
json_res = json.dumps(res) if res else "" if user.endswith(f"@{self.mail_domain}"):
return f"{reply_command}{json_res}\n" res = lookup_userdb(db, user)
return None if res:
reply_command = "O"
else:
reply_command = "N"
elif type == "passdb":
if user.endswith(f"@{self.mail_domain}"):
res = lookup_passdb(db, user, password=args[0])
if res:
reply_command = "O"
else:
reply_command = "N"
print(f"res: {res!r}", file=sys.stderr)
json_res = json.dumps(res) if res else ""
return f"{reply_command}{json_res}\n"
return None
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer): class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
@@ -116,18 +92,20 @@ class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
def main(): 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])
with open("/etc/mailname", "r") as fp: with open("/etc/mailname", "r") as fp:
mail_domain = fp.read().strip() mail_domain = fp.read().strip()
db = Database(sys.argv[3])
dictproxy = DictProxy(db, mail_domain)
class Handler(StreamRequestHandler): class Handler(StreamRequestHandler):
def handle(self): def handle(self):
while True: while True:
msg = self.rfile.readline().strip().decode() msg = self.rfile.readline().strip().decode()
if not msg: if not msg:
break break
res = handle_dovecot_request(msg, db, mail_domain) res = dictproxy.handle_dovecot_request(msg)
if res: if res:
print(f"sending result: {res!r}", file=sys.stderr)
self.wfile.write(res.encode("ascii")) self.wfile.write(res.encode("ascii"))
self.wfile.flush() self.wfile.flush()

View File

@@ -34,34 +34,6 @@ def check_encrypted(message):
return True 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
class SMTPController(Controller): class SMTPController(Controller):
def factory(self): def factory(self):
return SMTP(self.handler, **self.SMTP_kwargs) return SMTP(self.handler, **self.SMTP_kwargs)
@@ -110,9 +82,6 @@ def check_DATA(envelope):
if envelope.mail_from.lower() != from_addr.lower(): if envelope.mail_from.lower() != from_addr.lower():
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>" return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
if not mail_encrypted and check_mdn(message, envelope):
return
envelope_from_domain = from_addr.split("@").pop() envelope_from_domain = from_addr.split("@").pop()
for recipient in envelope.rcpt_tos: for recipient in envelope.rcpt_tos:
if envelope.mail_from == recipient: if envelope.mail_from == recipient:

View File

@@ -4,8 +4,8 @@ Chat Mail pyinfra deploy.
import importlib.resources import importlib.resources
from pathlib import Path from pathlib import Path
from pyinfra import host from pyinfra import host, logger
from pyinfra.operations import apt, files, server, systemd from pyinfra.operations import apt, files, server, systemd, python
from pyinfra.facts.files import File from pyinfra.facts.files import File
from .acmetool import deploy_acmetool from .acmetool import deploy_acmetool
@@ -70,36 +70,6 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
mode="644", mode="644",
config={"domain_name": domain, "opendkim_selector": dkim_selector}, config={"domain_name": domain, "opendkim_selector": dkim_selector},
) )
need_restart |= main_config.changed
files.directory(
name="Add opendkim directory to /etc",
path="/etc/opendkim",
user="opendkim",
group="opendkim",
mode="750",
present=True,
)
keytable = files.template(
src=importlib.resources.files(__package__).joinpath("opendkim/KeyTable"),
dest="/etc/dkimkeys/KeyTable",
user="opendkim",
group="opendkim",
mode="644",
config={"domain_name": domain, "opendkim_selector": dkim_selector},
)
need_restart |= keytable.changed
signing_table = files.template(
src=importlib.resources.files(__package__).joinpath("opendkim/SigningTable"),
dest="/etc/dkimkeys/SigningTable",
user="opendkim",
group="opendkim",
mode="644",
config={"domain_name": domain, "opendkim_selector": dkim_selector},
)
need_restart |= signing_table.changed
files.directory( files.directory(
name="Add opendkim socket directory to /var/spool/postfix", name="Add opendkim socket directory to /var/spool/postfix",
@@ -120,6 +90,8 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
_sudo_user="opendkim", _sudo_user="opendkim",
) )
need_restart |= main_config.changed
return need_restart return need_restart
@@ -183,17 +155,6 @@ def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
mode="644", mode="644",
) )
# 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 return need_restart
@@ -202,7 +163,7 @@ def _configure_nginx(domain: str, debug: bool = False) -> bool:
need_restart = False need_restart = False
main_config = files.template( main_config = files.template(
src=importlib.resources.files(__package__).joinpath("nginx/nginx.conf.j2"), src=importlib.resources.files(__package__).joinpath("nginx.conf.j2"),
dest="/etc/nginx/nginx.conf", dest="/etc/nginx/nginx.conf",
user="root", user="root",
group="root", group="root",
@@ -212,7 +173,7 @@ def _configure_nginx(domain: str, debug: bool = False) -> bool:
need_restart |= main_config.changed need_restart |= main_config.changed
autoconfig = files.template( autoconfig = files.template(
src=importlib.resources.files(__package__).joinpath("nginx/autoconfig.xml.j2"), src=importlib.resources.files(__package__).joinpath("autoconfig.xml.j2"),
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml", dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
user="root", user="root",
group="root", group="root",
@@ -277,12 +238,6 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
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) nginx_need_restart = _configure_nginx(mail_domain)
# deploy web pages and info if we have them
pkg_root = importlib.resources.files(__package__)
www_path = pkg_root.joinpath(f"../../../www/{mail_domain}").resolve()
if www_path.is_dir():
files.rsync(f"{www_path}/", "/var/www/html", flags=["-avz"])
systemd.service( systemd.service(
name="Start and enable OpenDKIM", name="Start and enable OpenDKIM",
service="opendkim.service", service="opendkim.service",
@@ -337,3 +292,14 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
enabled=True, enabled=True,
restarted=journald_conf, restarted=journald_conf,
) )
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)

View File

@@ -6,7 +6,7 @@ from deploy_chatmail import deploy_chatmail
def main(): def main():
mail_domain = os.getenv("CHATMAIL_DOMAIN") mail_domain = os.getenv("CHATMAIL_DOMAIN")
mail_server = os.getenv("CHATMAIL_SERVER", mail_domain) mail_server = os.getenv("CHATMAIL_SERVER", mail_domain)
dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "dkim") dkim_selector = os.getenv("CHATMAIL_DKIM_SELECTOR", "2023")
assert mail_domain assert mail_domain
assert mail_server assert mail_server

View File

@@ -118,24 +118,6 @@ service auth-worker {
user = vmail 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 = required
ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain ssl_cert = </var/lib/acme/live/{{ config.hostname }}/fullchain
ssl_key = </var/lib/acme/live/{{ config.hostname }}/privkey ssl_key = </var/lib/acme/live/{{ config.hostname }}/privkey

View File

@@ -1 +0,0 @@
dkim._domainkey.{{ config.domain_name }} {{ config.domain_name }}:{{ config.opendkim_selector }}:/etc/dkimkeys/dkim.private

View File

@@ -1 +0,0 @@
*@{{ config.domain_name }} {{ config.opendkim_selector }}._domainkey.{{ config.domain_name }}

View File

@@ -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 /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

View File

@@ -1,4 +1,4 @@
#!/bin/bash #!/bin/bash
set -e set -e
venv/bin/pytest online-tests/benchmark.py -vrx online-tests/venv/bin/pytest online-tests/benchmark.py -vrx

View File

@@ -1,15 +1,10 @@
#!/usr/bin/env bash #!/usr/bin/env bash
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
export CHATMAIL_DOMAIN
echo ----------------------------------------- chatmaild/venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
echo deploying to $CHATMAIL_DOMAIN
echo -----------------------------------------
echo WARNING: in five seconds deploy to $CHATMAIL_DOMAIN starts deploy-chatmail/venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" \
sleep 5
venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" \
deploy-chatmail/src/deploy_chatmail/deploy.py deploy-chatmail/src/deploy_chatmail/deploy.py
rm -r dist/ rm -r dist/

View File

@@ -1,20 +0,0 @@
#!/bin/sh
: ${CHATMAIL_DOMAIN:=c1.testrun.org}
: ${CHATMAIL_SSH:=$CHATMAIL_DOMAIN}
set -e
SSH="ssh root@$CHATMAIL_SSH"
EMAIL="root@$CHATMAIL_DOMAIN"
ACME_ACCOUNT_URL="$($SSH -- acmetool account-url)"
cat <<EOF
$CHATMAIL_DOMAIN. MX 10 $CHATMAIL_DOMAIN.
$CHATMAIL_DOMAIN. TXT "v=spf1 a:$CHATMAIL_DOMAIN -all"
_dmarc.$CHATMAIL_DOMAIN. TXT "v=DMARC1;p=reject;rua=mailto:$EMAIL;ruf=mailto:$EMAIL;fo=1;adkim=r;aspf=r"
_submission._tcp.$CHATMAIL_DOMAIN. SRV 0 1 587 $CHATMAIL_DOMAIN.
_submissions._tcp.$CHATMAIL_DOMAIN. SRV 0 1 465 $CHATMAIL_DOMAIN.
_imap._tcp.$CHATMAIL_DOMAIN. SRV 0 1 143 $CHATMAIL_DOMAIN.
_imaps._tcp.$CHATMAIL_DOMAIN. SRV 0 1 993 $CHATMAIL_DOMAIN.
$CHATMAIL_DOMAIN. IN CAA 0 issue "letsencrypt.org; accounturi=$ACME_ACCOUNT_URL"
EOF
$SSH opendkim-genzone -F | sed 's/^;.*$//;/^$/d'

View File

@@ -11,4 +11,3 @@ conn.login(f"imapcapa", "pass")
status, res = conn.capability() status, res = conn.capability()
for capa in sorted(res[0].decode().split()): for capa in sorted(res[0].decode().split()):
print(capa) print(capa)

View File

@@ -1,8 +1,13 @@
#!/bin/sh #!/bin/sh
set -e set -e
python3 -m venv venv python3 -m venv deploy-chatmail/venv
pip=venv/bin/pip deploy-chatmail/venv/bin/pip install pyinfra pytest
deploy-chatmail/venv/bin/pip install -e deploy-chatmail
deploy-chatmail/venv/bin/pip install -e chatmaild
$pip install pyinfra pytest build 'setuptools>=68' tox deltachat python3 -m venv chatmaild/venv
$pip install -e deploy-chatmail chatmaild/venv/bin/pip install --upgrade pytest build 'setuptools>=68'
$pip install -e chatmaild chatmaild/venv/bin/pip install -e chatmaild
python3 -m venv online-tests/venv
online-tests/venv/bin/pip install pytest pytest-timeout pdbpp deltachat

View File

@@ -5,7 +5,7 @@ import imaplib
domain = os.environ.get("CHATMAIL_DOMAIN", "c3.testrun.org") domain = os.environ.get("CHATMAIL_DOMAIN", "c3.testrun.org")
NUM_CONNECTIONS=10 NUM_CONNECTIONS = 10
conns = [] conns = []
@@ -16,7 +16,7 @@ for i in range(NUM_CONNECTIONS):
conns.append(conn) conns.append(conn)
tlsdone = time.time() tlsdone = time.time()
duration = tlsdone-start duration = tlsdone - start
print(f"{duration}: TLS connections opening TLS connections") print(f"{duration}: TLS connections opening TLS connections")
for i, conn in enumerate(conns): for i, conn in enumerate(conns):

View File

@@ -1,4 +1,3 @@
#!/bin/bash #!/bin/bash
venv/bin/tox -c chatmaild chatmaild/venv/bin/pytest chatmaild/ $@
venv/bin/tox -c deploy-chatmail online-tests/venv/bin/pytest online-tests/ -vrx --durations=5 $@
venv/bin/pytest tests/online -vrx --durations=5 $@

View File

@@ -0,0 +1,9 @@
import pytest
from chatmaild.database import Database
@pytest.fixture()
def db(tmpdir):
db_path = tmpdir / "passdb.sqlite"
print("database path:", db_path)
return Database(db_path)

View File

@@ -1,44 +1,40 @@
import os import os
import json
import pytest import pytest
import chatmaild.dictproxy import chatmaild.dictproxy
from chatmaild.dictproxy import get_user_data, lookup_passdb, handle_dovecot_request from chatmaild.dictproxy import DictProxy
from chatmaild.database import Database, DBError from chatmaild.database import DBError
@pytest.fixture() @pytest.fixture
def db(tmpdir): def dictproxy(db, maildomain):
db_path = tmpdir / "passdb.sqlite" return DictProxy(db, maildomain)
print("database path:", db_path)
return Database(db_path)
def test_basic(dictproxy, tmpdir, monkeypatch):
def test_basic(db): monkeypatch.setattr(
lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u") chatmaild.dictproxy, "NOCREATE_FILE", tmpdir.join("nocreate").strpath
data = get_user_data(db, "link2xt@c1.testrun.org") )
assert data dictproxy.lookup_passdb("link2xt@c1.testrun.org", "asdf")
data2 = lookup_passdb(db, "link2xt@c1.testrun.org", "Pieg9aeToe3eghuthe5u") assert dictproxy.get_user_data("link2xt@c1.testrun.org")
assert data == data2
def test_dont_overwrite_password_on_wrong_login(db): def test_dont_overwrite_password_on_wrong_login(dictproxy):
"""Test that logging in with a different password doesn't create a new user""" """Test that logging in with a different password doesn't create a new user"""
res = lookup_passdb(db, "newuser1@something.org", "kajdlkajsldk12l3kj1983") res = dictproxy.lookup_passdb("newuser1@something.org", "kajdlkajsldk12l3kj1983")
assert res["password"] assert res["password"]
res2 = lookup_passdb(db, "newuser1@something.org", "kajdlqweqwe") res2 = dictproxy.lookup_passdb("newuser1@something.org", "kajdlqweqwe")
# this function always returns a password hash, which is actually compared by dovecot. # this function always returns a password hash, which is actually compared by dovecot.
assert res["password"] == res2["password"] assert res["password"] == res2["password"]
def test_nocreate_file(db, monkeypatch, tmpdir): def test_nocreate_file(dictproxy, tmpdir, monkeypatch):
p = tmpdir.join("nocreate") nocreate = tmpdir.join("nocreate")
p.write("") monkeypatch.setattr(chatmaild.dictproxy, "NOCREATE_FILE", str(nocreate))
monkeypatch.setattr(chatmaild.dictproxy, "NOCREATE_FILE", str(p)) nocreate.write("")
lookup_passdb(db, "newuser1@something.org", "zequ0Aimuchoodaechik") dictproxy.lookup_passdb("newuser1@something.org", "kajdlqweqwe")
assert not get_user_data(db, "newuser1@something.org") assert not dictproxy.get_user_data("newuser1@something.org")
def test_db_version(db): def test_db_version(db):
@@ -50,15 +46,3 @@ def test_too_high_db_version(db):
conn.execute("PRAGMA user_version=%s;" % (999,)) conn.execute("PRAGMA user_version=%s;" % (999,))
with pytest.raises(DBError): with pytest.raises(DBError):
db.ensure_tables() db.ensure_tables()
def test_handle_dovecot_request(db):
msg = ('Lshared/passdb/laksjdlaksjdlaksjdlk12j3l1k2j3123/'
'some42@c3.testrun.org\tsome42@c3.testrun.org')
res = handle_dovecot_request(msg, db, "c3.testrun.org")
assert res
assert res[0] == "O" and res.endswith("\n")
userdata = json.loads(res[1:].strip())
assert userdata["home"] == "/home/vmail/some42@c3.testrun.org"
assert userdata["uid"] == userdata["gid"] == "vmail"
assert userdata["password"].startswith("{SHA512-CRYPT}")

View File

@@ -1,13 +1,7 @@
from chatmaild.filtermail import check_encrypted, check_DATA, SendRateLimiter, check_mdn from chatmaild.filtermail import check_encrypted, check_DATA, SendRateLimiter
import pytest import pytest
@pytest.fixture
def maildomain():
# let's not depend on a real chatmail instance for the offline tests below
return "chatmail.example.org"
def test_reject_forged_from(maildata, gencreds): def test_reject_forged_from(maildata, gencreds):
class env: class env:
mail_from = gencreds()[0] mail_from = gencreds()[0]
@@ -41,33 +35,8 @@ def test_filtermail_encryption_detection(maildata):
assert not check_encrypted(msg) assert not check_encrypted(msg)
def test_filtermail_is_mdn(maildata, gencreds): def test_filtermail_mdn_is_not_encrypted(maildata):
from_addr = gencreds()[0] assert not check_encrypted(maildata("mdn.eml"))
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 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(): def test_send_rate_limiter():

View File

@@ -195,8 +195,8 @@ def gencreds(maildomain):
num = next(count) num = next(count)
alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890" alphanumeric = "abcdefghijklmnopqrstuvwxyz1234567890"
user = "".join(random.choices(alphanumeric, k=10)) user = "".join(random.choices(alphanumeric, k=10))
user = f"ac{num}_{user}"[:9] user = f"ac{num}_{user}"
password = "".join(random.choices(alphanumeric, k=12)) password = "".join(random.choices(alphanumeric, k=10))
yield f"{user}@{domain}", f"{password}" yield f"{user}@{domain}", f"{password}"
return lambda domain=None: next(gen(domain)) return lambda domain=None: next(gen(domain))
@@ -290,7 +290,7 @@ class Remote:
def maildata(request, gencreds): def maildata(request, gencreds):
datadir = conftestdir.joinpath("mail-data") datadir = conftestdir.joinpath("mail-data")
def maildata(name, from_addr=None, to_addr=None): def maildata(name, parsed=True, from_addr=None, to_addr=None):
if from_addr is None: if from_addr is None:
from_addr = gencreds()[0] from_addr = gencreds()[0]
if to_addr is None: if to_addr is None:

View File

@@ -1,6 +1,6 @@
Subject: Message opened Subject: Message opened
From: <{from_addr}> From: <barbaz@c2.testrun.org>
To: <{to_addr}> To: <foobar@c2.testrun.org>
Date: Sun, 15 Oct 2023 16:43:25 +0000 Date: Sun, 15 Oct 2023 16:43:25 +0000
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org> Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
Auto-Submitted: auto-replied Auto-Submitted: auto-replied

View File

@@ -23,11 +23,6 @@ def test_login_basic_functioning(imap_or_smtp, gencreds, lp):
with pytest.raises(imap_or_smtp.AuthError): with pytest.raises(imap_or_smtp.AuthError):
imap_or_smtp.login(user, password + "wrong") imap_or_smtp.login(user, password + "wrong")
lp.sec(f"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): def test_login_same_password(imap_or_smtp, gencreds):
"""Test two different users logging in with the same password """Test two different users logging in with the same password

View File

@@ -1,4 +1,3 @@
import time
import random import random
import pytest import pytest
@@ -82,29 +81,3 @@ class TestEndToEndDeltaChat:
ch = ac2.qr_setup_contact(qr) ch = ac2.qr_setup_contact(qr)
assert ch.id >= 10 assert ch.id >= 10
ac1._evtracker.wait_securejoin_inviter_progress(1000) 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)
msg = ac2.wait_next_incoming_message()
assert "verified" in msg.text
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)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 163 KiB

View File

@@ -1,61 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>nine.testrun.org - Experimenting with the Future of Email</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
.wrapper {
width: 100%;
max-width: 596px;
margin: 0 auto;
}
.section {
width: 100%;
max-width: 596px;
}
.text {
box-sizing: border-box;
padding: 9px;
font-size: 18px;
font-family: "Courier New", monospace;
color: white;
background-position: left top;
background-image: url(collage-bg.png);
background-repeat: no-repeat;
background-size: 100% 100%;
}
h1, h2, h3 {
font-size: 16px;
font-weight: bold;
}
</style>
</head>
<body>
<div class="wrapper">
<img class="section" src="collage-top.png" />
<div class="section text">
<h1>welcome to nine.testrun.org</h1>
<p>
to get an account,
invent a word with <i>exactly</i> nine characters
and append @nine.testrun.org to it.
eg. <b>hellofits@nine.testrun.org</b>
</p>
<p>
if the email address is not yet taken, you'll get that account.
the first login sets your password.
that's it.
</p>
</div>
<img class="section" src="collage-down.png" />
<div class="section text">
<h1>faq</h1>
<p><i>why are other email providers 1000 times more complicated?</i></p>
<p>because they want to for $reasons</p>
</div>
</div>
</body>
</html>