generalize remotelog to "remote" and offer remote.iter_output method

README.md

@@ -1,40 +1,60 @@
 # Chat Mail server configuration
 
-This repository setups a ready-to-go chatmail instance
-comprised of a minimal setup of the battle-tested 
-[postfix smtp server](https://www.postfix.org) and [dovecot imap server](https://www.dovecot.org).
+This package deploys Postfix and Dovecot servers, including OpenDKIM for DKIM signing.
+
+Postfix uses Dovecot for authentication as described in <https://www.postfix.org/SASL_README.html#server_dovecot>
 
 ## Getting started 
 
-1. prepare your local system:
+prepare:
 
-    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 
+    pip install -e chatmail-infra
 
 
-## Running tests and benchmarks (offline and online) 
+then run with pyinfra command line tool: 
 
-1. Set `CHATMAIL_SSH` so that `ssh root@$CHATMAIL_SSH` allows 
-   to login to the chatmail instance server. 
+    CHATMAIL_DOMAIN=c1.testrun.org pyinfra --ssh-user root c1.testrun.org deploy.py
 
-2. To run local and online tests: 
 
-    scripts/test.sh 
+## Structure (wip)
+```
 
-3. To run benchmarks against your chatmail instance: 
+# package doveauth tool and deploy chatmail server to a envvar-specified ssh-reachable host 
+deploy.py 
 
-    scripts/bench.sh 
+# chatmail pyinfra deploy package 
+chatmail-pyinfra 
+    pyproject.toml
+    chatmail/__init__ ...
 
-## Running tests (offline and online) 
+# doveauth tool used by dovecot's auth mechanism on the host system 
+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 
 
 ```
+
 ## Dovecot/Postfix configuration
 
 ### Ports
@@ -44,6 +64,4 @@ Dovecot listens on ports 143(imap) and 993 (imaps).
 
 ## DNS
 
-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. 
+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).

chatmaild/src/chatmaild/dictproxy.py

@@ -95,7 +95,7 @@ def main():
             while True:
                 msg = self.rfile.readline().strip().decode()
                 if not msg:
-                    break
+                    continue
                 res = handle_dovecot_request(msg, db)
                 if res:
                     print(f"sending result: {res!r}", file=sys.stderr)

chatmaild/src/chatmaild/filtermail.py

@@ -9,8 +9,9 @@ from aiosmtpd.controller import UnixSocketController
 from smtplib import SMTP as SMTPClient
 
 
-def check_encrypted(message):
+def check_encrypted(content):
     """Check that the message is an OpenPGP-encrypted message."""
+    message = BytesParser(policy=policy.default).parsebytes(content)
     if not message.is_multipart():
         return False
     if message.get("subject") != "...":
@@ -46,8 +47,7 @@ class ExampleHandler:
 
         valid_recipients = []
 
-        message = BytesParser(policy=policy.default).parsebytes(envelope.content)
-        mail_encrypted = check_encrypted(message)
+        mail_encrypted = check_encrypted(envelope.content)
 
         res = []
         for recipient in envelope.rcpt_tos:
@@ -68,13 +68,7 @@ class ExampleHandler:
                 continue
 
             is_outgoing = recipient_local_domain[1] != my_local_domain[1]
-
-            if (
-                is_outgoing
-                and not mail_encrypted
-                and message.get("secure-join") != "vc-request"
-                and message.get("secure-join") != "vg-request"
-            ):
+            if is_outgoing and not mail_encrypted:
                 res += ["500 Outgoing mail must be encrypted"]
                 continue
 

chatmaild/src/chatmaild/test_filtermail.py

@@ -1,16 +1,12 @@
+import pytest
+
 from .filtermail import check_encrypted
-from email.parser import BytesParser
-from email import policy
 
 
 def test_filtermail():
-    def check_encrypted_bstr(content):
-        message = BytesParser(policy=policy.default).parsebytes(content)
-        return check_encrypted(message)
+    assert not check_encrypted(b"foo")
 
-    assert not check_encrypted_bstr(b"foo")
-
-    assert not check_encrypted_bstr(
+    assert not check_encrypted(
         "\r\n".join(
             [
                 "Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
@@ -40,7 +36,7 @@ def test_filtermail():
         ).encode()
     )
 
-    assert not check_encrypted_bstr(
+    assert not check_encrypted(
         "\r\n".join(
             [
                 "Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
@@ -71,7 +67,7 @@ def test_filtermail():
     )
 
     # https://xkcd.com/1181/
-    assert not check_encrypted_bstr(
+    assert not check_encrypted(
         "\r\n".join(
             [
                 "Subject: =?utf-8?q?Message_from_foobar=40c2=2Etestrun=2Eorg?=",
@@ -103,7 +99,7 @@ def test_filtermail():
         ).encode()
     )
 
-    assert check_encrypted_bstr(
+    assert check_encrypted(
         "\r\n".join(
             [
                 "Subject: ...",
@@ -176,7 +172,7 @@ def test_filtermail():
         ).encode()
     )
 
-    assert not check_encrypted_bstr(
+    assert not check_encrypted(
         "\r\n".join(
             [
                 "Subject: Buy Penis Enlargement at www.malicious-domain.com",
@@ -249,7 +245,7 @@ def test_filtermail():
         ).encode()
     )
 
-    assert not check_encrypted_bstr(
+    assert not check_encrypted(
         "\r\n".join(
             [
                 "Subject: Message opened",

deploy-chatmail/src/deploy_chatmail/__init__.py

@@ -110,7 +110,7 @@ def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
     return need_restart
 
 
-def _configure_postfix(domain: str, debug: bool = False) -> bool:
+def _configure_postfix(domain: str) -> bool:
     """Configures Postfix SMTP server."""
     need_restart = False
 
@@ -124,20 +124,21 @@ def _configure_postfix(domain: str, debug: bool = False) -> bool:
     )
     need_restart |= main_config.changed
 
-    master_config = files.template(
-        src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"),
+    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",
-        debug=debug,
     )
     need_restart |= master_config.changed
 
     return need_restart
 
 
-def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
+def _configure_dovecot(mail_server: str) -> bool:
     """Configures Dovecot IMAP server."""
     need_restart = False
 
@@ -148,7 +149,6 @@ def _configure_dovecot(mail_server: str, debug: bool = False) -> bool:
         group="root",
         mode="644",
         config={"hostname": mail_server},
-        debug=debug,
     )
     need_restart |= main_config.changed
     auth_config = files.put(
@@ -215,9 +215,8 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
     )
 
     _install_chatmaild()
-    debug = False
-    dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
-    postfix_need_restart = _configure_postfix(mail_domain, debug=debug)
+    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(

deploy-chatmail/src/deploy_chatmail/dovecot/dovecot.conf.j2

@@ -4,17 +4,13 @@ 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
+mail_debug = yes
 
 # Authentication for system users.
 passdb {

deploy-chatmail/src/deploy_chatmail/postfix/master.cf

@@ -9,11 +9,7 @@
 # service type  private unpriv  chroot  wakeup  maxproc command + args
 #               (yes)   (yes)   (no)    (never) (100)
 # ==========================================================================
-{% if debug == true %}
-smtp      inet  n       -       y       -       -       smtpd -v
-{% else %}
-smtp      inet  n       -       y       -       -       smtpd 
-{% endif %}
+smtp      inet  n       -       y       -       -       smtpd -v 
 #smtp      inet  n       -       y       -       1       postscreen
 #smtpd     pass  -       -       y       -       -       smtpd
 #dnsblog   unix  -       -       y       -       0       dnsblog

online-tests/benchmark.py

@@ -1,34 +0,0 @@
-def test_tls_serialized_connect(benchmark, imap_or_smtp):
-    def connect():
-        imap_or_smtp.connect()
-
-    benchmark(connect)
-
-
-def test_login(benchmark, imap_or_smtp, gencreds):
-    cls = imap_or_smtp.__class__
-    conns = []
-    for i in range(20):
-        conn = cls(imap_or_smtp.host)
-        conn.connect()
-        conns.append(conn)
-
-    def login():
-        conn = conns.pop()
-        conn.login(*gencreds())
-
-    benchmark(login)
-
-
-def test_send_and_receive_10(benchmark, cmfactory, lp):
-    """send many messages between two accounts"""
-    ac1, ac2 = cmfactory.get_online_accounts(2)
-    chat = cmfactory.get_accepted_chat(ac1, ac2)
-
-    def send_10_receive_all():
-        for i in range(10):
-            chat.send_text(f"hello {i}")
-        for i in range(10):
-            ac2.wait_next_incoming_message()
-
-    benchmark(send_10_receive_all)

online-tests/test_1_deltachat.py

@@ -67,17 +67,3 @@ class TestEndToEndDeltaChat:
                     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)

plan.txt

@@ -8,6 +8,12 @@
 - 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
 
 - basic outgoing send rate/limits (depending on "account-rating")

scripts/bench.sh

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

scripts/deploy.sh

@@ -2,9 +2,8 @@
 : ${CHATMAIL_DOMAIN:=c1.testrun.org}
 export CHATMAIL_DOMAIN
 
-chatmaild/venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
+venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
 
-deploy-chatmail/venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" \
-    deploy-chatmail/src/deploy_chatmail/deploy.py
+deploy-chatmail/venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" deploy.py
 
 rm -r dist/

scripts/init.sh

@@ -6,8 +6,12 @@ deploy-chatmail/venv/bin/pip install -e deploy-chatmail
 deploy-chatmail/venv/bin/pip install -e chatmaild
 
 python3 -m venv chatmaild/venv
-chatmaild/venv/bin/pip install --upgrade pytest build 'setuptools>=68'
+chatmaild/venv/bin/pip install pytest
 chatmaild/venv/bin/pip install -e chatmaild
 
 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
+
+python3 -m venv venv
+venv/bin/pip install build
+venv/bin/pip install 'setuptools>=68'

scripts/remote-deploy.sh

@@ -2,7 +2,7 @@
 set -e
 
 : ${CHATMAIL_DOMAIN:=c1.testrun.org}
-: ${CHATMAIL_SSH:=$CHATMAIL_DOMAIN}
+: ${CHATMAIL_SSH_HOST:=$CHATMAIL_DOMAIN}
 
-rsync -avz . "root@$CHATMAIL_SSH:/root/chatmail" --exclude='/.git' --filter="dir-merge,- .gitignore"
-ssh "root@$CHATMAIL_SSH" "cd /root/chatmail; apt install -y python3-venv; python3 -m venv venv; venv/bin/pip install pyinfra build; venv/bin/python3 -m build -n --sdist chatmaild --outdir dist; venv/bin/pip install -e ./deploy-chatmail -e ./chatmaild; export CHATMAIL_DOMAIN=$CHATMAIL_DOMAIN; venv/bin/pyinfra @local deploy.py"
+rsync -avz . "root@$CHATMAIL_SSH_HOST:/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"

scripts/test.sh

@@ -4,4 +4,4 @@ pushd chatmaild/src/chatmaild
 ../../venv/bin/pytest
 popd
 
-online-tests/venv/bin/pytest online-tests/ -vrx --durations=5
+online-tests/venv/bin/pytest online-tests/ -vrx --durations=5 --slow