mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 08:24:37 +00:00
Compare commits
10 Commits
link2xt/py
...
link2xt/me
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a69cf72f80 | ||
|
|
1e229ad2de | ||
|
|
8baee557ee | ||
|
|
42e50b089f | ||
|
|
e6a3fab6aa | ||
|
|
ccd6e3e99c | ||
|
|
21778fa4f3 | ||
|
|
14342383cf | ||
|
|
926de76010 | ||
|
|
ee25d35db1 |
@@ -10,6 +10,7 @@ dependencies = [
|
|||||||
"iniconfig",
|
"iniconfig",
|
||||||
"deltachat-rpc-server",
|
"deltachat-rpc-server",
|
||||||
"deltachat-rpc-client",
|
"deltachat-rpc-client",
|
||||||
|
"requests",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -20,6 +21,7 @@ where = ['src']
|
|||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
|
chatmail-metadata = "chatmaild.metadata:main"
|
||||||
filtermail = "chatmaild.filtermail:main"
|
filtermail = "chatmaild.filtermail:main"
|
||||||
echobot = "chatmaild.echo:main"
|
echobot = "chatmaild.echo:main"
|
||||||
chatmail-metrics = "chatmaild.metrics:main"
|
chatmail-metrics = "chatmaild.metrics:main"
|
||||||
|
|||||||
10
chatmaild/src/chatmaild/chatmail-metadata.service.f
Normal file
10
chatmaild/src/chatmaild/chatmail-metadata.service.f
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Chatmail dict proxy for IMAP METADATA
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart={execpath} /run/dovecot/metadata.socket vmail {config_path}
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -58,17 +58,18 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
def get_user_data(db, user):
|
def get_user_data(db, config: Config, user):
|
||||||
with db.read_connection() as conn:
|
with db.read_connection() as conn:
|
||||||
result = conn.get_user(user)
|
result = conn.get_user(user)
|
||||||
if result:
|
if result:
|
||||||
|
result["home"] = f"/home/vmail/mail/{config.mail_domain}/{user}"
|
||||||
result["uid"] = "vmail"
|
result["uid"] = "vmail"
|
||||||
result["gid"] = "vmail"
|
result["gid"] = "vmail"
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
|
||||||
def lookup_userdb(db, user):
|
def lookup_userdb(db, config: Config, user):
|
||||||
return get_user_data(db, user)
|
return get_user_data(db, config, user)
|
||||||
|
|
||||||
|
|
||||||
def lookup_passdb(db, config: Config, user, cleartext_password):
|
def lookup_passdb(db, config: Config, user, cleartext_password):
|
||||||
@@ -80,6 +81,7 @@ def lookup_passdb(db, config: Config, user, cleartext_password):
|
|||||||
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
"UPDATE users SET last_login=? WHERE addr=?", (int(time.time()), user)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
userdata["home"] = f"/home/vmail/mail/{config.mail_domain}/{user}"
|
||||||
userdata["uid"] = "vmail"
|
userdata["uid"] = "vmail"
|
||||||
userdata["gid"] = "vmail"
|
userdata["gid"] = "vmail"
|
||||||
return userdata
|
return userdata
|
||||||
@@ -142,7 +144,7 @@ def handle_dovecot_request(msg, db, config: Config):
|
|||||||
if type == "userdb":
|
if type == "userdb":
|
||||||
user = args[0]
|
user = args[0]
|
||||||
if user.endswith(f"@{config.mail_domain}"):
|
if user.endswith(f"@{config.mail_domain}"):
|
||||||
res = lookup_userdb(db, user)
|
res = lookup_userdb(db, config, user)
|
||||||
if res:
|
if res:
|
||||||
reply_command = "O"
|
reply_command = "O"
|
||||||
else:
|
else:
|
||||||
|
|||||||
154
chatmaild/src/chatmaild/metadata.py
Normal file
154
chatmaild/src/chatmaild/metadata.py
Normal file
@@ -0,0 +1,154 @@
|
|||||||
|
import pwd
|
||||||
|
|
||||||
|
from queue import Queue
|
||||||
|
from threading import Thread
|
||||||
|
from socketserver import (
|
||||||
|
UnixStreamServer,
|
||||||
|
StreamRequestHandler,
|
||||||
|
ThreadingMixIn,
|
||||||
|
)
|
||||||
|
from .config import read_config
|
||||||
|
import sys
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import requests
|
||||||
|
|
||||||
|
|
||||||
|
DICTPROXY_LOOKUP_CHAR = "L"
|
||||||
|
DICTPROXY_ITERATE_CHAR = "I"
|
||||||
|
DICTPROXY_SET_CHAR = "S"
|
||||||
|
DICTPROXY_BEGIN_TRANSACTION_CHAR = "B"
|
||||||
|
DICTPROXY_COMMIT_TRANSACTION_CHAR = "C"
|
||||||
|
DICTPROXY_TRANSACTION_CHARS = "SBC"
|
||||||
|
|
||||||
|
|
||||||
|
class Notifier:
|
||||||
|
def __init__(self):
|
||||||
|
self.guid2token = {}
|
||||||
|
self.to_notify_queue = Queue()
|
||||||
|
|
||||||
|
def set_token(self, guid, token):
|
||||||
|
self.guid2token[guid] = token
|
||||||
|
|
||||||
|
def new_message_for_guid(self, guid):
|
||||||
|
self.to_notify_queue.put(guid)
|
||||||
|
|
||||||
|
def thread_run_loop(self):
|
||||||
|
requests_session = requests.Session()
|
||||||
|
while 1:
|
||||||
|
self.thread_run_one(requests_session)
|
||||||
|
|
||||||
|
def thread_run_one(self, requests_session):
|
||||||
|
guid = self.to_notify_queue.get()
|
||||||
|
token = self.guid2token.get(guid)
|
||||||
|
if token:
|
||||||
|
response = requests_session.post(
|
||||||
|
"https://notifications.delta.chat/notify",
|
||||||
|
data=token,
|
||||||
|
timeout=60,
|
||||||
|
)
|
||||||
|
if response.status_code == 410:
|
||||||
|
# 410 Gone status code
|
||||||
|
# means the token is no longer valid.
|
||||||
|
del self.guid2token[guid]
|
||||||
|
|
||||||
|
|
||||||
|
def handle_dovecot_protocol(rfile, wfile, notifier):
|
||||||
|
# HELLO message, ignored.
|
||||||
|
msg = rfile.readline().strip().decode()
|
||||||
|
|
||||||
|
transactions = {}
|
||||||
|
while True:
|
||||||
|
msg = rfile.readline().strip().decode()
|
||||||
|
if not msg:
|
||||||
|
break
|
||||||
|
|
||||||
|
res = handle_dovecot_request(msg, transactions, notifier)
|
||||||
|
if res:
|
||||||
|
wfile.write(res.encode("ascii"))
|
||||||
|
wfile.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def handle_dovecot_request(msg, transactions, notifier):
|
||||||
|
# see https://doc.dovecot.org/3.0/developer_manual/design/dict_protocol/
|
||||||
|
short_command = msg[0]
|
||||||
|
parts = msg[1:].split("\t")
|
||||||
|
if short_command == DICTPROXY_LOOKUP_CHAR:
|
||||||
|
return "N\n"
|
||||||
|
elif short_command == DICTPROXY_ITERATE_CHAR:
|
||||||
|
# Empty line means ITER_FINISHED.
|
||||||
|
# If we don't return empty line Dovecot will timeout.
|
||||||
|
return "\n"
|
||||||
|
|
||||||
|
if short_command not in (DICTPROXY_TRANSACTION_CHARS):
|
||||||
|
return
|
||||||
|
|
||||||
|
transaction_id = parts[0]
|
||||||
|
|
||||||
|
if short_command == DICTPROXY_BEGIN_TRANSACTION_CHAR:
|
||||||
|
transactions[transaction_id] = "O\n"
|
||||||
|
elif short_command == DICTPROXY_COMMIT_TRANSACTION_CHAR:
|
||||||
|
# returns whether it failed or succeeded.
|
||||||
|
return transactions.pop(transaction_id, "N\n")
|
||||||
|
elif short_command == DICTPROXY_SET_CHAR:
|
||||||
|
# See header of
|
||||||
|
# <https://github.com/dovecot/core/blob/5e7965632395793d9355eb906b173bf28d2a10ca/src/lib-storage/mailbox-attribute.h>
|
||||||
|
# for the documentation on the structure of the key.
|
||||||
|
|
||||||
|
# Request GETMETADATA "INBOX" /private/chatmail
|
||||||
|
# results in a query for
|
||||||
|
# priv/dd72550f05eadc65542a1200cac67ad7/chatmail
|
||||||
|
#
|
||||||
|
# Request GETMETADATA "" /private/chatmail
|
||||||
|
# results in
|
||||||
|
# priv/dd72550f05eadc65542a1200cac67ad7/vendor/vendor.dovecot/pvt/server/chatmail
|
||||||
|
|
||||||
|
keyname = parts[1].split("/")
|
||||||
|
value = parts[2] if len(parts) > 2 else ""
|
||||||
|
if keyname[0] == "priv" and keyname[2] == "devicetoken":
|
||||||
|
notifier.set_token(keyname[1], value)
|
||||||
|
elif keyname[0] == "priv" and keyname[2] == "messagenew":
|
||||||
|
notifier.new_message_for_guid(keyname[1])
|
||||||
|
else:
|
||||||
|
# Transaction failed.
|
||||||
|
transactions[transaction_id] = "F\n"
|
||||||
|
|
||||||
|
|
||||||
|
class ThreadedUnixStreamServer(ThreadingMixIn, UnixStreamServer):
|
||||||
|
request_queue_size = 100
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
socket, username, config = sys.argv[1:]
|
||||||
|
passwd_entry = pwd.getpwnam(username)
|
||||||
|
|
||||||
|
# XXX config is not currently used
|
||||||
|
config = read_config(config)
|
||||||
|
notifier = Notifier()
|
||||||
|
|
||||||
|
class Handler(StreamRequestHandler):
|
||||||
|
def handle(self):
|
||||||
|
try:
|
||||||
|
handle_dovecot_protocol(self.rfile, self.wfile, notifier)
|
||||||
|
except Exception:
|
||||||
|
logging.exception("Exception in the handler")
|
||||||
|
raise
|
||||||
|
|
||||||
|
try:
|
||||||
|
os.unlink(socket)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# start notifier thread for signalling new messages to
|
||||||
|
# Delta Chat notification server
|
||||||
|
|
||||||
|
t = Thread(target=notifier.thread_run_loop)
|
||||||
|
t.setDaemon(True)
|
||||||
|
t.start()
|
||||||
|
|
||||||
|
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,4 +1,6 @@
|
|||||||
import random
|
import random
|
||||||
|
from pathlib import Path
|
||||||
|
import os
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import itertools
|
import itertools
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
@@ -57,7 +59,12 @@ def db(tmpdir):
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildata(request):
|
def maildata(request):
|
||||||
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
try:
|
||||||
|
datadir = importlib.resources.files(__package__).joinpath("mail-data")
|
||||||
|
except TypeError:
|
||||||
|
# in python3.9 or lower, the above doesn't work, so we get datadir this way:
|
||||||
|
datadir = Path(os.getcwd()).joinpath("chatmaild/src/chatmaild/tests/mail-data")
|
||||||
|
|
||||||
assert datadir.exists(), datadir
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
def maildata(name, from_addr, to_addr):
|
def maildata(name, from_addr, to_addr):
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ from chatmaild.database import DBError
|
|||||||
|
|
||||||
def test_basic(db, example_config):
|
def test_basic(db, example_config):
|
||||||
lookup_passdb(db, example_config, "asdf12345@chat.example.org", "q9mr3faue")
|
lookup_passdb(db, example_config, "asdf12345@chat.example.org", "q9mr3faue")
|
||||||
data = get_user_data(db, "asdf12345@chat.example.org")
|
data = get_user_data(db, example_config, "asdf12345@chat.example.org")
|
||||||
assert data
|
assert data
|
||||||
data2 = lookup_passdb(
|
data2 = lookup_passdb(
|
||||||
db, example_config, "asdf12345@chat.example.org", "q9mr3jewvadsfaue"
|
db, example_config, "asdf12345@chat.example.org", "q9mr3jewvadsfaue"
|
||||||
@@ -43,7 +43,7 @@ def test_nocreate_file(db, monkeypatch, tmpdir, example_config):
|
|||||||
lookup_passdb(
|
lookup_passdb(
|
||||||
db, example_config, "newuser12@chat.example.org", "zequ0Aimuchoodaechik"
|
db, example_config, "newuser12@chat.example.org", "zequ0Aimuchoodaechik"
|
||||||
)
|
)
|
||||||
assert not get_user_data(db, "newuser12@chat.example.org")
|
assert not get_user_data(db, example_config, "newuser12@chat.example.org")
|
||||||
|
|
||||||
|
|
||||||
def test_db_version(db):
|
def test_db_version(db):
|
||||||
|
|||||||
147
chatmaild/src/chatmaild/tests/test_metadata.py
Normal file
147
chatmaild/src/chatmaild/tests/test_metadata.py
Normal file
@@ -0,0 +1,147 @@
|
|||||||
|
import io
|
||||||
|
|
||||||
|
from chatmaild.metadata import (
|
||||||
|
handle_dovecot_request,
|
||||||
|
handle_dovecot_protocol,
|
||||||
|
Notifier,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_request_lookup_fails():
|
||||||
|
notifier = Notifier()
|
||||||
|
res = handle_dovecot_request("Lpriv/123/chatmail", {}, notifier)
|
||||||
|
assert res == "N\n"
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_request_happy_path():
|
||||||
|
notifier = Notifier()
|
||||||
|
transactions = {}
|
||||||
|
|
||||||
|
# lookups return the same NOTFOUND result
|
||||||
|
res = handle_dovecot_request("Lpriv/123/chatmail", transactions, notifier)
|
||||||
|
assert res == "N\n"
|
||||||
|
assert not notifier.guid2token and not transactions
|
||||||
|
|
||||||
|
# set device token in a transaction
|
||||||
|
tx = "1111"
|
||||||
|
msg = f"B{tx}\tuser"
|
||||||
|
res = handle_dovecot_request(msg, transactions, notifier)
|
||||||
|
assert not res and not notifier.guid2token
|
||||||
|
assert transactions == {tx: "O\n"}
|
||||||
|
|
||||||
|
msg = f"S{tx}\tpriv/guid00/devicetoken\t01234"
|
||||||
|
res = handle_dovecot_request(msg, transactions, notifier)
|
||||||
|
assert not res
|
||||||
|
assert len(transactions) == 1
|
||||||
|
assert len(notifier.guid2token) == 1
|
||||||
|
assert notifier.guid2token["guid00"] == "01234"
|
||||||
|
|
||||||
|
msg = f"C{tx}"
|
||||||
|
res = handle_dovecot_request(msg, transactions, notifier)
|
||||||
|
assert res == "O\n"
|
||||||
|
assert len(transactions) == 0
|
||||||
|
assert notifier.guid2token["guid00"] == "01234"
|
||||||
|
|
||||||
|
# trigger notification for incoming message
|
||||||
|
assert handle_dovecot_request(f"B{tx}\tuser", transactions, notifier) is None
|
||||||
|
msg = f"S{tx}\tpriv/guid00/messagenew"
|
||||||
|
assert handle_dovecot_request(msg, transactions, notifier) is None
|
||||||
|
assert notifier.to_notify_queue.get() == "guid00"
|
||||||
|
assert notifier.to_notify_queue.qsize() == 0
|
||||||
|
assert handle_dovecot_request(f"C{tx}\tuser", transactions, notifier) == "O\n"
|
||||||
|
assert not transactions
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_protocol_set_devicetoken():
|
||||||
|
rfile = io.BytesIO(
|
||||||
|
b"\n".join(
|
||||||
|
[
|
||||||
|
b"HELLO",
|
||||||
|
b"Btx00\tuser",
|
||||||
|
b"Stx00\tpriv/guid00/devicetoken\t01234",
|
||||||
|
b"Ctx00",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
wfile = io.BytesIO()
|
||||||
|
notifier = Notifier()
|
||||||
|
handle_dovecot_protocol(rfile, wfile, notifier)
|
||||||
|
assert notifier.guid2token["guid00"] == "01234"
|
||||||
|
assert wfile.getvalue() == b"O\n"
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_protocol_iterate():
|
||||||
|
rfile = io.BytesIO(
|
||||||
|
b"\n".join(
|
||||||
|
[
|
||||||
|
b"H",
|
||||||
|
b"I9\t0\tpriv/5cbe730f146fea6535be0d003dd4fc98/\tci-2dzsrs@nine.testrun.org",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
wfile = io.BytesIO()
|
||||||
|
notifier = Notifier()
|
||||||
|
handle_dovecot_protocol(rfile, wfile, notifier)
|
||||||
|
assert wfile.getvalue() == b"\n"
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_protocol_messagenew():
|
||||||
|
rfile = io.BytesIO(
|
||||||
|
b"\n".join(
|
||||||
|
[
|
||||||
|
b"HELLO",
|
||||||
|
b"Btx01\tuser",
|
||||||
|
b"Stx01\tpriv/guid00/messagenew",
|
||||||
|
b"Ctx01",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
wfile = io.BytesIO()
|
||||||
|
notifier = Notifier()
|
||||||
|
handle_dovecot_protocol(rfile, wfile, notifier)
|
||||||
|
assert wfile.getvalue() == b"O\n"
|
||||||
|
assert notifier.to_notify_queue.get() == "guid00"
|
||||||
|
assert notifier.to_notify_queue.qsize() == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_notifier_thread_run():
|
||||||
|
requests = []
|
||||||
|
|
||||||
|
class ReqMock:
|
||||||
|
def post(self, url, data, timeout):
|
||||||
|
requests.append((url, data, timeout))
|
||||||
|
|
||||||
|
class Result:
|
||||||
|
status_code = 200
|
||||||
|
|
||||||
|
return Result()
|
||||||
|
|
||||||
|
notifier = Notifier()
|
||||||
|
notifier.set_token("guid00", "01234")
|
||||||
|
notifier.new_message_for_guid("guid00")
|
||||||
|
notifier.thread_run_one(ReqMock())
|
||||||
|
url, data, timeout = requests[0]
|
||||||
|
assert data == "01234"
|
||||||
|
assert len(notifier.guid2token) == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_notifier_thread_run_gone_removes_token():
|
||||||
|
requests = []
|
||||||
|
|
||||||
|
class ReqMock:
|
||||||
|
def post(self, url, data, timeout):
|
||||||
|
requests.append((url, data, timeout))
|
||||||
|
|
||||||
|
class Result:
|
||||||
|
status_code = 410
|
||||||
|
|
||||||
|
return Result()
|
||||||
|
|
||||||
|
notifier = Notifier()
|
||||||
|
notifier.set_token("guid00", "01234")
|
||||||
|
notifier.new_message_for_guid("guid00")
|
||||||
|
assert notifier.guid2token["guid00"] == "01234"
|
||||||
|
notifier.thread_run_one(ReqMock())
|
||||||
|
url, data, timeout = requests[0]
|
||||||
|
assert data == "01234"
|
||||||
|
assert len(notifier.guid2token) == 0
|
||||||
@@ -102,6 +102,7 @@ def _install_remote_venv_with_chatmaild(config) -> None:
|
|||||||
"doveauth",
|
"doveauth",
|
||||||
"filtermail",
|
"filtermail",
|
||||||
"echobot",
|
"echobot",
|
||||||
|
"chatmail-metadata",
|
||||||
):
|
):
|
||||||
params = dict(
|
params = dict(
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
@@ -337,6 +338,27 @@ def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
|||||||
mode="644",
|
mode="644",
|
||||||
)
|
)
|
||||||
need_restart |= auth_config.changed
|
need_restart |= auth_config.changed
|
||||||
|
lua_push_notification_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"dovecot/push_notification.lua"
|
||||||
|
),
|
||||||
|
dest="/etc/dovecot/push_notification.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= lua_push_notification_script.changed
|
||||||
|
|
||||||
|
sieve_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"dovecot/default.sieve"
|
||||||
|
),
|
||||||
|
dest="/etc/dovecot/default.sieve",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= sieve_script.changed
|
||||||
|
|
||||||
files.template(
|
files.template(
|
||||||
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
||||||
@@ -426,8 +448,9 @@ def check_config(config):
|
|||||||
mail_domain = config.mail_domain
|
mail_domain = config.mail_domain
|
||||||
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
for value in config.__dict__.values():
|
for key in config.__dict__:
|
||||||
if any(x in str(value) for x in blocked_words):
|
value = config.__dict__[key]
|
||||||
|
if key.startswith("privacy") and any(x in str(value) for x in blocked_words):
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
)
|
)
|
||||||
@@ -448,6 +471,10 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
server.group(name="Create vmail group", group="vmail", system=True)
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
apt.packages(
|
||||||
|
name="Install rsync",
|
||||||
|
packages=["rsync"],
|
||||||
|
)
|
||||||
|
|
||||||
# Run local DNS resolver `unbound`.
|
# Run local DNS resolver `unbound`.
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
@@ -483,7 +510,7 @@ def deploy_chatmail(config_path: Path) -> None:
|
|||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
name="Install Dovecot",
|
name="Install Dovecot",
|
||||||
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
packages=["dovecot-imapd", "dovecot-lmtpd", "dovecot-sieve"],
|
||||||
)
|
)
|
||||||
|
|
||||||
apt.packages(
|
apt.packages(
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ import importlib
|
|||||||
import subprocess
|
import subprocess
|
||||||
import datetime
|
import datetime
|
||||||
|
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
|
|
||||||
class DNS:
|
class DNS:
|
||||||
def __init__(self, out, mail_domain):
|
def __init__(self, out, mail_domain):
|
||||||
@@ -34,12 +36,11 @@ class DNS:
|
|||||||
cmd = "ip a | grep inet6 | grep 'scope global' | sed -e 's#/64 scope global##' | sed -e 's#inet6##'"
|
cmd = "ip a | grep inet6 | grep 'scope global' | sed -e 's#/64 scope global##' | sed -e 's#inet6##'"
|
||||||
return self.shell(cmd).strip()
|
return self.shell(cmd).strip()
|
||||||
|
|
||||||
def get(self, typ: str, domain: str) -> str | None:
|
def get(self, typ: str, domain: str) -> str:
|
||||||
"""Get a DNS entry"""
|
"""Get a DNS entry or empty string if there is none."""
|
||||||
dig_result = self.shell(f"dig -r -q {domain} -t {typ} +short")
|
dig_result = self.shell(f"dig -r -q {domain} -t {typ} +short")
|
||||||
line = dig_result.partition("\n")[0]
|
line = dig_result.partition("\n")[0]
|
||||||
if line:
|
return line
|
||||||
return line
|
|
||||||
|
|
||||||
def check_ptr_record(self, ip: str, mail_domain) -> bool:
|
def check_ptr_record(self, ip: str, mail_domain) -> bool:
|
||||||
"""Check the PTR record for an IPv4 or IPv6 address."""
|
"""Check the PTR record for an IPv4 or IPv6 address."""
|
||||||
@@ -54,22 +55,25 @@ def show_dns(args, out) -> int:
|
|||||||
ssh = f"ssh root@{mail_domain}"
|
ssh = f"ssh root@{mail_domain}"
|
||||||
dns = DNS(out, 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)
|
|
||||||
return "\n".join(lines)
|
|
||||||
|
|
||||||
print("Checking your DKIM keys and DNS entries...")
|
print("Checking your DKIM keys and DNS entries...")
|
||||||
try:
|
try:
|
||||||
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
acme_account_url = out.shell_output(f"{ssh} -- acmetool account-url")
|
||||||
except subprocess.CalledProcessError:
|
except subprocess.CalledProcessError:
|
||||||
print("Please run `cmdeploy run` first.")
|
print("Please run `cmdeploy run` first.")
|
||||||
return 1
|
return 1
|
||||||
dkim_entry = read_dkim_entries(out.shell_output(f"{ssh} -- opendkim-genzone -F"))
|
|
||||||
|
dkim_selector = "opendkim"
|
||||||
|
dkim_pubkey = out.shell_output(
|
||||||
|
ssh + f" -- openssl rsa -in /etc/dkimkeys/{dkim_selector}.private"
|
||||||
|
" -pubout 2>/dev/null | awk '/-/{next}{printf(\"%s\",$0)}'"
|
||||||
|
)
|
||||||
|
dkim_entry_value = f"v=DKIM1;k=rsa;p={dkim_pubkey};s=email;t=s"
|
||||||
|
dkim_entry_str = ""
|
||||||
|
while len(dkim_entry_value) >= 255:
|
||||||
|
dkim_entry_str += '"' + dkim_entry_value[:255] + '" '
|
||||||
|
dkim_entry_value = dkim_entry_value[255:]
|
||||||
|
dkim_entry_str += '"' + dkim_entry_value + '"'
|
||||||
|
dkim_entry = f"{dkim_selector}._domainkey.{mail_domain}. TXT {dkim_entry_str}"
|
||||||
|
|
||||||
ipv6 = dns.get_ipv6()
|
ipv6 = dns.get_ipv6()
|
||||||
reverse_ipv6 = dns.check_ptr_record(ipv6, mail_domain)
|
reverse_ipv6 = dns.check_ptr_record(ipv6, mail_domain)
|
||||||
@@ -97,7 +101,6 @@ def show_dns(args, out) -> int:
|
|||||||
return 0
|
return 0
|
||||||
except TypeError:
|
except TypeError:
|
||||||
pass
|
pass
|
||||||
started_dkim_parsing = False
|
|
||||||
for line in zonefile.splitlines():
|
for line in zonefile.splitlines():
|
||||||
line = line.format(
|
line = line.format(
|
||||||
acme_account_url=acme_account_url,
|
acme_account_url=acme_account_url,
|
||||||
@@ -124,28 +127,23 @@ def show_dns(args, out) -> int:
|
|||||||
current = dns.get("SRV", domain[:-1])
|
current = dns.get("SRV", domain[:-1])
|
||||||
if current != f"{prio} {weight} {port} {value}":
|
if current != f"{prio} {weight} {port} {value}":
|
||||||
to_print.append(line)
|
to_print.append(line)
|
||||||
if " TXT " in line:
|
if " TXT " in line:
|
||||||
domain, value = line.split(" TXT ")
|
domain, value = line.split(" TXT ")
|
||||||
current = dns.get("TXT", domain.strip()[:-1])
|
current = dns.get("TXT", domain.strip()[:-1])
|
||||||
if domain.startswith("_mta-sts."):
|
if domain.startswith("_mta-sts."):
|
||||||
if current:
|
if current:
|
||||||
if current.split("id=")[0] == value.split("id=")[0]:
|
if current.split("id=")[0] == value.split("id=")[0]:
|
||||||
continue
|
continue
|
||||||
if current != value:
|
|
||||||
|
# TXT records longer than 255 bytes
|
||||||
|
# are split into multiple <character-string>s.
|
||||||
|
# This typically happens with DKIM record
|
||||||
|
# which contains long RSA key.
|
||||||
|
#
|
||||||
|
# Removing `" "` before comparison
|
||||||
|
# to get back a single string.
|
||||||
|
if current.replace('" "', "") != value.replace('" "', ""):
|
||||||
to_print.append(line)
|
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.replace(";", "\\;") != data:
|
|
||||||
to_print.append(dkim_entry)
|
|
||||||
else:
|
|
||||||
to_print.append(dkim_entry)
|
|
||||||
|
|
||||||
exit_code = 0
|
exit_code = 0
|
||||||
if to_print:
|
if to_print:
|
||||||
|
|||||||
5
cmdeploy/src/cmdeploy/dovecot/default.sieve
Normal file
5
cmdeploy/src/cmdeploy/dovecot/default.sieve
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
require ["imap4flags"];
|
||||||
|
|
||||||
|
if header :is ["Auto-Submitted"] ["auto-replied", "auto-generated"] {
|
||||||
|
addflag "$Auto";
|
||||||
|
}
|
||||||
@@ -21,7 +21,7 @@ mail_plugins = quota
|
|||||||
# these are the capabilities Delta Chat cares about actually
|
# these are the capabilities Delta Chat cares about actually
|
||||||
# so let's keep the network overhead per login small
|
# so let's keep the network overhead per login small
|
||||||
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
# https://github.com/deltachat/deltachat-core-rust/blob/master/src/imap/capabilities.rs
|
||||||
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY METADATA
|
imap_capability = IMAP4rev1 IDLE MOVE QUOTA CONDSTORE NOTIFY METADATA XDELTAPUSH
|
||||||
|
|
||||||
|
|
||||||
# Authentication for system users.
|
# Authentication for system users.
|
||||||
@@ -71,6 +71,9 @@ mail_privileged_group = vmail
|
|||||||
## Mail processes
|
## Mail processes
|
||||||
##
|
##
|
||||||
|
|
||||||
|
# Pass all IMAP METADATA requests to the server implementing Dovecot's dict protocol.
|
||||||
|
mail_attribute_dict = proxy:/run/dovecot/metadata.socket:metadata
|
||||||
|
|
||||||
# Enable IMAP COMPRESS (RFC 4978).
|
# Enable IMAP COMPRESS (RFC 4978).
|
||||||
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
||||||
protocol imap {
|
protocol imap {
|
||||||
@@ -79,7 +82,21 @@ protocol imap {
|
|||||||
}
|
}
|
||||||
|
|
||||||
protocol lmtp {
|
protocol lmtp {
|
||||||
mail_plugins = $mail_plugins quota
|
# quota plugin documentation:
|
||||||
|
# <https://doc.dovecot.org/configuration_manual/quota_plugin/>
|
||||||
|
#
|
||||||
|
# notify plugin is a dependency of push_notification plugin:
|
||||||
|
# <https://doc.dovecot.org/settings/plugin/notify-plugin/>
|
||||||
|
#
|
||||||
|
# push_notification plugin documentation:
|
||||||
|
# <https://doc.dovecot.org/configuration_manual/push_notification/>
|
||||||
|
#
|
||||||
|
# mail_lua and push_notification_lua are needed for Lua push notification handler.
|
||||||
|
# <https://doc.dovecot.org/configuration_manual/push_notification/#configuration>
|
||||||
|
#
|
||||||
|
# Sieve to mark messages that should not be notified as \Seen
|
||||||
|
# <https://doc.dovecot.org/configuration_manual/sieve/configuration/>
|
||||||
|
mail_plugins = $mail_plugins quota mail_lua notify push_notification push_notification_lua sieve
|
||||||
}
|
}
|
||||||
|
|
||||||
plugin {
|
plugin {
|
||||||
@@ -95,7 +112,15 @@ plugin {
|
|||||||
# quota_over_flag_value = TRUE
|
# quota_over_flag_value = TRUE
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# push_notification configuration
|
||||||
|
plugin {
|
||||||
|
# <https://doc.dovecot.org/configuration_manual/push_notification/#lua-lua>
|
||||||
|
push_notification_driver = lua:file=/etc/dovecot/push_notification.lua
|
||||||
|
}
|
||||||
|
|
||||||
|
plugin {
|
||||||
|
sieve_default = file:/etc/dovecot/default.sieve
|
||||||
|
}
|
||||||
|
|
||||||
service lmtp {
|
service lmtp {
|
||||||
user=vmail
|
user=vmail
|
||||||
|
|||||||
32
cmdeploy/src/cmdeploy/dovecot/push_notification.lua
Normal file
32
cmdeploy/src/cmdeploy/dovecot/push_notification.lua
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
function dovecot_lua_notify_begin_txn(user)
|
||||||
|
return user
|
||||||
|
end
|
||||||
|
|
||||||
|
function contains(v, needle)
|
||||||
|
for _, keyword in ipairs(v) do
|
||||||
|
if keyword == needle then
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
function dovecot_lua_notify_event_message_new(user, event)
|
||||||
|
local mbox = user:mailbox(event.mailbox)
|
||||||
|
mbox:sync()
|
||||||
|
|
||||||
|
if user.username ~= event.from_address then
|
||||||
|
-- Incoming message
|
||||||
|
if not contains(event.keywords, "$Auto") then
|
||||||
|
-- Not an Auto-Submitted message, notifying.
|
||||||
|
|
||||||
|
-- Notify METADATA server about new message.
|
||||||
|
mbox:metadata_set("/private/messagenew", "")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
mbox:free()
|
||||||
|
end
|
||||||
|
|
||||||
|
function dovecot_lua_notify_end_txn(ctx, success)
|
||||||
|
end
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import pytest
|
import pytest
|
||||||
import threading
|
import threading
|
||||||
import queue
|
import queue
|
||||||
|
import socket
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
from chatmaild.config import read_config
|
||||||
from cmdeploy.cmdeploy import main
|
from cmdeploy.cmdeploy import main
|
||||||
@@ -78,3 +79,24 @@ def test_concurrent_logins_same_account(
|
|||||||
|
|
||||||
for _ in conns:
|
for _ in conns:
|
||||||
assert login_results.get()
|
assert login_results.get()
|
||||||
|
|
||||||
|
|
||||||
|
def test_no_vrfy(chatmail_config):
|
||||||
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
sock.connect((chatmail_config.mail_domain, 25))
|
||||||
|
banner = sock.recv(1024)
|
||||||
|
print(banner)
|
||||||
|
sock.send(b"VRFY wrongaddress@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
||||||
|
result = sock.recv(1024)
|
||||||
|
print(result)
|
||||||
|
sock.send(b"VRFY echo@%s\r\n" % (chatmail_config.mail_domain.encode(),))
|
||||||
|
result2 = sock.recv(1024)
|
||||||
|
print(result2)
|
||||||
|
assert result[0:10] == result2[0:10]
|
||||||
|
sock.send(b"VRFY wrongaddress\r\n")
|
||||||
|
result = sock.recv(1024)
|
||||||
|
print(result)
|
||||||
|
sock.send(b"VRFY echo\r\n")
|
||||||
|
result2 = sock.recv(1024)
|
||||||
|
print(result2)
|
||||||
|
assert result[0:10] == result2[0:10] == b"252 2.0.0 "
|
||||||
|
|||||||
Reference in New Issue
Block a user