mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 16:34:39 +00:00
Compare commits
9 Commits
chatmail-i
...
cgi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
aa3f12b2a0 | ||
|
|
1be1580454 | ||
|
|
bf8b69ae68 | ||
|
|
4708533a0d | ||
|
|
466e92ab37 | ||
|
|
0f15a9d095 | ||
|
|
9ef53806d5 | ||
|
|
ab2cc5a687 | ||
|
|
b8cf5da37f |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -3,11 +3,6 @@ __pycache__/
|
|||||||
*.py[cod]
|
*.py[cod]
|
||||||
*$py.class
|
*$py.class
|
||||||
*.swp
|
*.swp
|
||||||
www/privacy.html*
|
|
||||||
www/index.html*
|
|
||||||
www/info.html*
|
|
||||||
*qr-*.png
|
|
||||||
|
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
*.so
|
*.so
|
||||||
|
|||||||
50
README.md
50
README.md
@@ -1,6 +1,3 @@
|
|||||||
|
|
||||||
<img width="800px" src="www/src/collage-top.png"/>
|
|
||||||
|
|
||||||
# Chatmail instances optimized for Delta Chat apps
|
# Chatmail instances optimized for Delta Chat apps
|
||||||
|
|
||||||
This repository helps to setup a ready-to-use chatmail instance
|
This repository helps to setup a ready-to-use chatmail instance
|
||||||
@@ -25,53 +22,28 @@ after which the initially specified password is required for using them.
|
|||||||
|
|
||||||
export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host
|
export CHATMAIL_DOMAIN=c1.testrun.org # replace with your host
|
||||||
|
|
||||||
4. Fill in privacy contact data into the `chatmail.ini` file
|
4. Deploy the chat mail instance to your chatmail server:
|
||||||
|
|
||||||
5. Deploy the chat mail instance to your chatmail server:
|
|
||||||
|
|
||||||
scripts/deploy.sh
|
scripts/deploy.sh
|
||||||
|
|
||||||
This script remotely sets up packages and configures the chatmail provider.
|
This script uses `pyinfra` and `ssh` to setup packages and configure
|
||||||
|
the chatmail instance on your remote server.
|
||||||
|
|
||||||
6. Run `scripts/generate-dns-zone.sh` and
|
5. Run `scripts/generate-dns-zone.sh` and
|
||||||
transfer the generated DNS records at your DNS provider
|
transfer the generated DNS records at your DNS provider
|
||||||
|
|
||||||
|
|
||||||
### Home page and getting started for users
|
### Home page and getting started for users
|
||||||
|
|
||||||
The `deploy.sh` script deploys
|
- The `deploy.sh` script deploys a default `index.html`
|
||||||
|
along with a QR code that users can click to
|
||||||
|
create accounts on the chatmail provider.
|
||||||
|
|
||||||
- a default `index.html` along with a QR code that users can click to
|
- Start a Delta Chat app and create a new account
|
||||||
create accounts on your chatmail provider,
|
by typing an e-mail address with an arbitrary username
|
||||||
|
and `@<your-chatmail-domain>` appended.
|
||||||
|
Use an at least 10-character random password.
|
||||||
|
|
||||||
- a default `info.html` that is linked from the home page,
|
|
||||||
|
|
||||||
- a default `policy.html` that is linked from the home page.
|
|
||||||
|
|
||||||
All files are generated by the according markdown `.md` file in the `www` directory.
|
|
||||||
|
|
||||||
|
|
||||||
### Refining the web pages
|
|
||||||
|
|
||||||
The `scripts/webdev.sh` script supports live development of the chatmail web presence:
|
|
||||||
|
|
||||||
```
|
|
||||||
scripts/init.sh # to locally initialize python virtual environments etc.
|
|
||||||
scripts/webdev.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
- uses the `www/src/page-layout.html` file for producing html documents
|
|
||||||
from `www/src/*.md` files.
|
|
||||||
|
|
||||||
- continously builds the web presence reading files from `www/src` directory
|
|
||||||
and generating html files and copying assets to the `www/build` directory.
|
|
||||||
|
|
||||||
- Starts a browser window automatically where you can "refresh" as needed.
|
|
||||||
|
|
||||||
Note that this script is not needed for running `scripts/deploy.sh"
|
|
||||||
which deploys the whole chatmail setup remotely.
|
|
||||||
The code that generates the web pages is identical
|
|
||||||
which means that `webdev.sh` gives a pretty good preview.
|
|
||||||
|
|
||||||
### Ports
|
### Ports
|
||||||
|
|
||||||
|
|||||||
32
chatmail.ini
32
chatmail.ini
@@ -1,32 +0,0 @@
|
|||||||
|
|
||||||
[params]
|
|
||||||
|
|
||||||
# how many mails a user can send out per minute
|
|
||||||
max_user_send_per_minute = 60
|
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
|
||||||
passthrough_recipients = privacy@testrun.org xstore@testrun.org
|
|
||||||
|
|
||||||
# where the filtermail SMTP service listens
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
|
|
||||||
# to which port to re-inject messages after they passed filtermail
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
|
|
||||||
|
|
||||||
[privacy:testrun]
|
|
||||||
|
|
||||||
# the settings in this section are only applied
|
|
||||||
# if the instantiated mail domain shell-matches the 'domain' setting
|
|
||||||
domain = *.testrun.org
|
|
||||||
privacy_postal =
|
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
|
||||||
Reichgrafen Str. 20, 79102 Freiburg, Germany
|
|
||||||
|
|
||||||
privacy_mail = delta-privacy@merlinux.eu
|
|
||||||
privacy_pdo =
|
|
||||||
Prof. Dr. Fabian Schmieder, lexICT UG (limited), Ostfeldstr. 49, 30559 Hannover.
|
|
||||||
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
|
||||||
privacy_supervisor =
|
|
||||||
State Commissioner for Data Protection and Freedom of Information of
|
|
||||||
Baden-Württemberg in 70173 Stuttgart, Germany.
|
|
||||||
@@ -4,10 +4,9 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "chatmaild"
|
name = "chatmaild"
|
||||||
version = "0.2"
|
version = "0.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
from fnmatch import fnmatch
|
|
||||||
import iniconfig
|
|
||||||
|
|
||||||
system_mailname_path = Path("/etc/mailname")
|
|
||||||
|
|
||||||
|
|
||||||
def read_config(inipath, mailname=None):
|
|
||||||
if mailname is None:
|
|
||||||
with open(system_mailname_path) as f:
|
|
||||||
mailname = f.read().strip()
|
|
||||||
|
|
||||||
ini = iniconfig.IniConfig(inipath)
|
|
||||||
privacy = {}
|
|
||||||
for section in ini:
|
|
||||||
if section.name.startswith("privacy:"):
|
|
||||||
domain = section["domain"]
|
|
||||||
if fnmatch(mailname, domain):
|
|
||||||
privacy = section
|
|
||||||
break
|
|
||||||
|
|
||||||
return Config(inipath, mailname, privacy, params=ini.sections["params"])
|
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
|
||||||
def __init__(self, inipath, mailname, privacy, params):
|
|
||||||
self._inipath = inipath
|
|
||||||
self.mailname = mailname
|
|
||||||
self.privacy_postal = privacy.get("privacy_postal")
|
|
||||||
self.privacy_mail = privacy.get("privacy_mail")
|
|
||||||
self.privacy_pdo = privacy.get("privacy_pdo")
|
|
||||||
self.privacy_supervisor = privacy.get("privacy_supervisor")
|
|
||||||
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
|
||||||
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
|
||||||
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].split()
|
|
||||||
|
|
||||||
def _getbytefile(self):
|
|
||||||
return open(self._inipath, "rb")
|
|
||||||
@@ -28,8 +28,8 @@ def is_allowed_to_create(user, cleartext_password) -> bool:
|
|||||||
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
logging.warning(f"blocked account creation because {NOCREATE_FILE!r} exists.")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
if len(cleartext_password) < 9:
|
if len(cleartext_password) < 10:
|
||||||
logging.warning("Password needs to be at least 9 characters long")
|
logging.warning("Password needs to be at least 10 characters long")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
parts = user.split("@")
|
parts = user.split("@")
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
Description=Dict authentication proxy for dovecot
|
Description=Dict authentication proxy for dovecot
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite
|
ExecStart=/usr/local/bin/doveauth /run/dovecot/doveauth.socket vmail /home/vmail/passdb.sqlite
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
|
|
||||||
@@ -11,8 +11,6 @@ from aiosmtpd.smtp import SMTP
|
|||||||
from aiosmtpd.controller import Controller
|
from aiosmtpd.controller import Controller
|
||||||
from smtplib import SMTP as SMTPClient
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
from .config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def check_encrypted(message):
|
def check_encrypted(message):
|
||||||
"""Check that the message is an OpenPGP-encrypted message."""
|
"""Check that the message is an OpenPGP-encrypted message."""
|
||||||
@@ -64,21 +62,19 @@ def check_mdn(message, envelope):
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
async def asyncmain_beforequeue(config):
|
class SMTPController(Controller):
|
||||||
port = config.filtermail_smtp_port
|
def factory(self):
|
||||||
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
return SMTP(self.handler, **self.SMTP_kwargs)
|
||||||
|
|
||||||
|
|
||||||
class BeforeQueueHandler:
|
class BeforeQueueHandler:
|
||||||
def __init__(self, config):
|
def __init__(self):
|
||||||
self.config = config
|
|
||||||
self.send_rate_limiter = SendRateLimiter()
|
self.send_rate_limiter = SendRateLimiter()
|
||||||
|
|
||||||
async def handle_MAIL(self, server, session, envelope, address, mail_options):
|
async def handle_MAIL(self, server, session, envelope, address, mail_options):
|
||||||
logging.info(f"handle_MAIL from {address}")
|
logging.info(f"handle_MAIL from {address}")
|
||||||
envelope.mail_from = address
|
envelope.mail_from = address
|
||||||
max_sent = self.config.max_user_send_per_minute
|
if not self.send_rate_limiter.is_sending_allowed(address):
|
||||||
if not self.send_rate_limiter.is_sending_allowed(address, max_sent):
|
|
||||||
return f"450 4.7.1: Too much mail from {address}"
|
return f"450 4.7.1: Too much mail from {address}"
|
||||||
|
|
||||||
parts = envelope.mail_from.split("@")
|
parts = envelope.mail_from.split("@")
|
||||||
@@ -89,58 +85,62 @@ class BeforeQueueHandler:
|
|||||||
|
|
||||||
async def handle_DATA(self, server, session, envelope):
|
async def handle_DATA(self, server, session, envelope):
|
||||||
logging.info("handle_DATA before-queue")
|
logging.info("handle_DATA before-queue")
|
||||||
error = self.check_DATA(envelope)
|
error = check_DATA(envelope)
|
||||||
if error:
|
if error:
|
||||||
return error
|
return error
|
||||||
logging.info("re-injecting the mail that passed checks")
|
logging.info("re-injecting the mail that passed checks")
|
||||||
client = SMTPClient("localhost", self.config.postfix_reinject_port)
|
client = SMTPClient("localhost", "10025")
|
||||||
client.sendmail(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
client.sendmail(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
||||||
return "250 OK"
|
return "250 OK"
|
||||||
|
|
||||||
def check_DATA(self, envelope):
|
|
||||||
"""the central filtering function for e-mails."""
|
|
||||||
logging.info(f"Processing DATA message from {envelope.mail_from}")
|
|
||||||
|
|
||||||
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
async def asyncmain_beforequeue(port):
|
||||||
mail_encrypted = check_encrypted(message)
|
Controller(BeforeQueueHandler(), hostname="127.0.0.1", port=port).start()
|
||||||
|
|
||||||
_, from_addr = parseaddr(message.get("from").strip())
|
|
||||||
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
|
||||||
if envelope.mail_from.lower() != from_addr.lower():
|
|
||||||
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
|
||||||
|
|
||||||
if not mail_encrypted and check_mdn(message, envelope):
|
def check_DATA(envelope):
|
||||||
return
|
"""the central filtering function for e-mails."""
|
||||||
|
logging.info(f"Processing DATA message from {envelope.mail_from}")
|
||||||
|
|
||||||
passthrough_recipients = self.config.passthrough_recipients
|
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
||||||
envelope_from_domain = from_addr.split("@").pop()
|
mail_encrypted = check_encrypted(message)
|
||||||
for recipient in envelope.rcpt_tos:
|
|
||||||
if envelope.mail_from == recipient:
|
|
||||||
# Always allow sending emails to self.
|
|
||||||
continue
|
|
||||||
if recipient in passthrough_recipients:
|
|
||||||
continue
|
|
||||||
res = recipient.split("@")
|
|
||||||
if len(res) != 2:
|
|
||||||
return f"500 Invalid address <{recipient}>"
|
|
||||||
_recipient_addr, recipient_domain = res
|
|
||||||
|
|
||||||
is_outgoing = recipient_domain != envelope_from_domain
|
_, from_addr = parseaddr(message.get("from").strip())
|
||||||
if is_outgoing and not mail_encrypted:
|
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
||||||
is_securejoin = message.get("secure-join") in ["vc-request", "vg-request"]
|
if envelope.mail_from.lower() != from_addr.lower():
|
||||||
if not is_securejoin:
|
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
||||||
return f"500 Invalid unencrypted mail to <{recipient}>"
|
|
||||||
|
if not mail_encrypted and check_mdn(message, envelope):
|
||||||
|
return
|
||||||
|
|
||||||
|
envelope_from_domain = from_addr.split("@").pop()
|
||||||
|
for recipient in envelope.rcpt_tos:
|
||||||
|
if envelope.mail_from == recipient:
|
||||||
|
# Always allow sending emails to self.
|
||||||
|
continue
|
||||||
|
res = recipient.split("@")
|
||||||
|
if len(res) != 2:
|
||||||
|
return f"500 Invalid address <{recipient}>"
|
||||||
|
_recipient_addr, recipient_domain = res
|
||||||
|
|
||||||
|
is_outgoing = recipient_domain != envelope_from_domain
|
||||||
|
if is_outgoing and not mail_encrypted:
|
||||||
|
is_securejoin = message.get("secure-join") in ["vc-request", "vg-request"]
|
||||||
|
if not is_securejoin:
|
||||||
|
return f"500 Invalid unencrypted mail to <{recipient}>"
|
||||||
|
|
||||||
|
|
||||||
class SendRateLimiter:
|
class SendRateLimiter:
|
||||||
|
MAX_USER_SEND_PER_MINUTE = 80
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.addr2timestamps = {}
|
self.addr2timestamps = {}
|
||||||
|
|
||||||
def is_sending_allowed(self, mail_from, max_send_per_minute):
|
def is_sending_allowed(self, mail_from):
|
||||||
last = self.addr2timestamps.setdefault(mail_from, [])
|
last = self.addr2timestamps.setdefault(mail_from, [])
|
||||||
now = time.time()
|
now = time.time()
|
||||||
last[:] = [ts for ts in last if ts >= (now - 60)]
|
last[:] = [ts for ts in last if ts >= (now - 60)]
|
||||||
if len(last) <= max_send_per_minute:
|
if len(last) <= self.MAX_USER_SEND_PER_MINUTE:
|
||||||
last.append(now)
|
last.append(now)
|
||||||
return True
|
return True
|
||||||
return False
|
return False
|
||||||
@@ -149,10 +149,9 @@ class SendRateLimiter:
|
|||||||
def main():
|
def main():
|
||||||
args = sys.argv[1:]
|
args = sys.argv[1:]
|
||||||
assert len(args) == 1
|
assert len(args) == 1
|
||||||
config = read_config(args[0])
|
|
||||||
logging.basicConfig(level=logging.WARN)
|
logging.basicConfig(level=logging.WARN)
|
||||||
loop = asyncio.new_event_loop()
|
loop = asyncio.new_event_loop()
|
||||||
asyncio.set_event_loop(loop)
|
asyncio.set_event_loop(loop)
|
||||||
task = asyncmain_beforequeue(config)
|
task = asyncmain_beforequeue(port=int(args[0]))
|
||||||
loop.create_task(task)
|
loop.create_task(task)
|
||||||
loop.run_forever()
|
loop.run_forever()
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
Description=Chatmail Postfix BeforeQeue filter
|
Description=Chatmail Postfix BeforeQeue filter
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
ExecStart={execpath} {config_path}
|
ExecStart=/usr/local/bin/filtermail 10080
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
|
|
||||||
@@ -7,9 +7,7 @@ name = "deploy-chatmail"
|
|||||||
version = "0.1"
|
version = "0.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"pyinfra",
|
"pyinfra",
|
||||||
"pillow",
|
|
||||||
"qrcode",
|
"qrcode",
|
||||||
"markdown",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
|
|||||||
@@ -1,117 +1,76 @@
|
|||||||
"""
|
"""
|
||||||
Chat Mail pyinfra deploy.
|
Chat Mail pyinfra deploy.
|
||||||
"""
|
"""
|
||||||
import sys
|
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
import subprocess
|
|
||||||
import shutil
|
|
||||||
import io
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from pyinfra import host
|
from pyinfra import host
|
||||||
from pyinfra.operations import apt, files, server, systemd, pip
|
from pyinfra.operations import apt, files, server, systemd
|
||||||
from pyinfra.facts.files import File
|
from pyinfra.facts.files import File
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
from .acmetool import deploy_acmetool
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
import chatmaild.filtermail
|
from .genqr import gen_qr_png_data
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def _build_chatmaild(dist_dir) -> None:
|
def _install_chatmaild() -> None:
|
||||||
dist_dir = Path(dist_dir).resolve()
|
chatmaild_filename = "chatmaild-0.1.tar.gz"
|
||||||
if dist_dir.exists():
|
chatmaild_path = importlib.resources.files(__package__).joinpath(
|
||||||
shutil.rmtree(dist_dir)
|
f"../../../dist/{chatmaild_filename}"
|
||||||
dist_dir.mkdir()
|
|
||||||
subprocess.check_output(
|
|
||||||
[sys.executable, "-m", "build", "-n"]
|
|
||||||
+ ["--sdist", "chatmaild", "--outdir", str(dist_dir)]
|
|
||||||
)
|
)
|
||||||
entries = list(dist_dir.iterdir())
|
remote_path = f"/tmp/{chatmaild_filename}"
|
||||||
assert len(entries) == 1
|
if Path(str(chatmaild_path)).exists():
|
||||||
return entries[0]
|
|
||||||
|
|
||||||
|
|
||||||
def remove_legacy_artifacts():
|
|
||||||
# disable legacy doveauth-dictproxy.service
|
|
||||||
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Disable legacy doveauth-dictproxy.service",
|
|
||||||
service="doveauth-dictproxy.service",
|
|
||||||
running=False,
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _install_remote_venv_with_chatmaild(config) -> None:
|
|
||||||
remove_legacy_artifacts()
|
|
||||||
dist_file = _build_chatmaild(dist_dir=Path("chatmaild/dist"))
|
|
||||||
remote_base_dir = "/usr/local/lib/chatmaild"
|
|
||||||
remote_dist_file = f"{remote_base_dir}/dist/{dist_file.name}"
|
|
||||||
remote_venv_dir = f"{remote_base_dir}/venv"
|
|
||||||
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
|
||||||
root_owned = dict(user="root", group="root", mode="644")
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="apt install python3-virtualenv",
|
|
||||||
packages=["python3-virtualenv"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="Upload chatmaild source package",
|
|
||||||
src=dist_file.open("rb"),
|
|
||||||
dest=remote_dist_file,
|
|
||||||
create_remote_dir=True,
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name=f"Upload {remote_chatmail_inipath}",
|
|
||||||
src=config._getbytefile(),
|
|
||||||
dest=remote_chatmail_inipath,
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
pip.virtualenv(
|
|
||||||
name=f"chatmaild virtualenv {remote_venv_dir}",
|
|
||||||
path=remote_venv_dir,
|
|
||||||
always_copy=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name=f"forced pip-install {dist_file.name}",
|
|
||||||
commands=[
|
|
||||||
f"{remote_venv_dir}/bin/pip install --force-reinstall {remote_dist_file}"
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
# install systemd units
|
|
||||||
for fn in (
|
|
||||||
"doveauth",
|
|
||||||
"filtermail",
|
|
||||||
):
|
|
||||||
params = dict(
|
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
|
||||||
config_path=remote_chatmail_inipath,
|
|
||||||
)
|
|
||||||
source_path = importlib.resources.files("chatmaild").joinpath(f"{fn}.service.f")
|
|
||||||
content = source_path.read_text().format(**params).encode()
|
|
||||||
|
|
||||||
files.put(
|
files.put(
|
||||||
name=f"Upload {fn}.service",
|
name="Upload chatmaild source package",
|
||||||
src=io.BytesIO(content),
|
src=chatmaild_path.open("rb"),
|
||||||
dest=f"/etc/systemd/system/{fn}.service",
|
dest=remote_path,
|
||||||
**root_owned,
|
|
||||||
)
|
)
|
||||||
systemd.service(
|
|
||||||
name=f"Setup {fn} service",
|
apt.packages(
|
||||||
service=f"{fn}.service",
|
name="apt install python3-aiosmtpd python3-pip python3-venv",
|
||||||
running=True,
|
packages=["python3-aiosmtpd", "python3-pip", "python3-venv"],
|
||||||
enabled=True,
|
|
||||||
restarted=True,
|
|
||||||
daemon_reload=True,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# --no-deps because aiosmtplib is installed with `apt`.
|
||||||
|
server.shell(
|
||||||
|
name="install chatmaild with pip",
|
||||||
|
commands=[f"pip install --break-system-packages {remote_path}"],
|
||||||
|
)
|
||||||
|
|
||||||
|
# disable legacy doveauth-dictproxy.service
|
||||||
|
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
||||||
|
systemd.service(
|
||||||
|
name="Disable legacy doveauth-dictproxy.service",
|
||||||
|
service="doveauth-dictproxy.service",
|
||||||
|
running=False,
|
||||||
|
enabled=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
# install systemd units
|
||||||
|
|
||||||
|
for fn in (
|
||||||
|
"doveauth",
|
||||||
|
"filtermail",
|
||||||
|
):
|
||||||
|
files.put(
|
||||||
|
name=f"Upload {fn}.service",
|
||||||
|
src=importlib.resources.files("chatmaild")
|
||||||
|
.joinpath(f"{fn}.service")
|
||||||
|
.open("rb"),
|
||||||
|
dest=f"/etc/systemd/system/{fn}.service",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name=f"Setup {fn} service",
|
||||||
|
service=f"{fn}.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=True,
|
||||||
|
daemon_reload=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
def _configure_opendkim(domain: str, dkim_selector: str) -> bool:
|
||||||
"""Configures OpenDKIM"""
|
"""Configures OpenDKIM"""
|
||||||
@@ -216,7 +175,7 @@ def _install_mta_sts_daemon() -> bool:
|
|||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def _configure_postfix(config: chatmaild.config.Config, debug: bool = False) -> bool:
|
def _configure_postfix(domain: str, debug: bool = False) -> bool:
|
||||||
"""Configures Postfix SMTP server."""
|
"""Configures Postfix SMTP server."""
|
||||||
need_restart = False
|
need_restart = False
|
||||||
|
|
||||||
@@ -226,7 +185,7 @@ def _configure_postfix(config: chatmaild.config.Config, debug: bool = False) ->
|
|||||||
user="root",
|
user="root",
|
||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
config=config,
|
config={"domain_name": domain},
|
||||||
)
|
)
|
||||||
need_restart |= main_config.changed
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
@@ -237,7 +196,6 @@ def _configure_postfix(config: chatmaild.config.Config, debug: bool = False) ->
|
|||||||
group="root",
|
group="root",
|
||||||
mode="644",
|
mode="644",
|
||||||
debug=debug,
|
debug=debug,
|
||||||
config=config,
|
|
||||||
)
|
)
|
||||||
need_restart |= master_config.changed
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
@@ -344,21 +302,20 @@ def _configure_nginx(domain: str, debug: bool = False) -> bool:
|
|||||||
mode="755",
|
mode="755",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
qr_data = gen_qr_png_data(domain)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name="Upload QR code for account creation",
|
||||||
|
src=qr_data,
|
||||||
|
dest="/var/www/html/qrcode.png",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
return need_restart
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
def check_config(config):
|
|
||||||
mailname = config.mailname
|
|
||||||
if mailname != "testrun.org" and not mailname.endswith(".testrun.org"):
|
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
|
||||||
for value in config.__dict__.values():
|
|
||||||
if any(x in value for x in blocked_words):
|
|
||||||
raise ValueError(
|
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
|
||||||
)
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
@@ -366,7 +323,6 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
:param mail_server: the DNS name under which your mail server is reachable
|
:param mail_server: the DNS name under which your mail server is reachable
|
||||||
:param dkim_selector:
|
:param dkim_selector:
|
||||||
"""
|
"""
|
||||||
from .www import build_webpages
|
|
||||||
|
|
||||||
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)
|
||||||
@@ -411,25 +367,30 @@ def deploy_chatmail(mail_domain: str, mail_server: str, dkim_selector: str) -> N
|
|||||||
packages=["fcgiwrap"],
|
packages=["fcgiwrap"],
|
||||||
)
|
)
|
||||||
|
|
||||||
pkg_root = importlib.resources.files(__package__)
|
_install_chatmaild()
|
||||||
chatmail_ini = pkg_root.joinpath("../../../chatmail.ini").resolve()
|
|
||||||
config = read_config(chatmail_ini, mailname=mail_domain)
|
|
||||||
check_config(config)
|
|
||||||
www_path = pkg_root.joinpath("../../../www").resolve()
|
|
||||||
|
|
||||||
build_dir = www_path.joinpath("build")
|
|
||||||
src_dir = www_path.joinpath("src")
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
|
|
||||||
|
|
||||||
_install_remote_venv_with_chatmaild(config)
|
|
||||||
debug = False
|
debug = False
|
||||||
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
dovecot_need_restart = _configure_dovecot(mail_server, debug=debug)
|
||||||
postfix_need_restart = _configure_postfix(config, 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)
|
||||||
mta_sts_need_restart = _install_mta_sts_daemon()
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
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"])
|
||||||
|
else:
|
||||||
|
index_path = www_path.parent.joinpath("default/index.html.j2")
|
||||||
|
files.template(
|
||||||
|
src=index_path,
|
||||||
|
dest="/var/www/html/index.html",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"mail_domain": mail_domain},
|
||||||
|
)
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Start and enable OpenDKIM",
|
name="Start and enable OpenDKIM",
|
||||||
service="opendkim.service",
|
service="opendkim.service",
|
||||||
|
|||||||
@@ -18,8 +18,7 @@ def gen_qr(maildomain, url):
|
|||||||
# taken and modified from
|
# taken and modified from
|
||||||
# https://github.com/deltachat/mailadm/blob/master/src/mailadm/gen_qr.py
|
# https://github.com/deltachat/mailadm/blob/master/src/mailadm/gen_qr.py
|
||||||
|
|
||||||
# info = f"{maildomain} invite code"
|
info = f"{maildomain} invite code"
|
||||||
info = ""
|
|
||||||
|
|
||||||
# load QR code
|
# load QR code
|
||||||
qr = qrcode.QRCode(
|
qr = qrcode.QRCode(
|
||||||
@@ -44,32 +43,28 @@ def gen_qr(maildomain, url):
|
|||||||
font_size = 16
|
font_size = 16
|
||||||
font = ImageFont.truetype(font=ttf_path, size=font_size)
|
font = ImageFont.truetype(font=ttf_path, size=font_size)
|
||||||
|
|
||||||
num_lines = ((info).count("\n") + 1) if info else 0
|
num_lines = (info).count("\n") + 1
|
||||||
|
|
||||||
size = width = 384
|
size = width = 384
|
||||||
qr_padding = 6
|
qr_padding = 6
|
||||||
text_height = font_size * num_lines
|
text_height = font_size * num_lines
|
||||||
height = size + text_height
|
height = size + text_height + qr_padding * 2
|
||||||
|
|
||||||
image = Image.new("RGBA", (width, height), "white")
|
image = Image.new("RGBA", (width, height), "white")
|
||||||
|
|
||||||
|
draw = ImageDraw.Draw(image)
|
||||||
|
|
||||||
qr_final_size = width - (qr_padding * 2)
|
qr_final_size = width - (qr_padding * 2)
|
||||||
|
|
||||||
if num_lines:
|
# draw text
|
||||||
draw = ImageDraw.Draw(image)
|
if hasattr(font, "getsize"):
|
||||||
|
info_pos = (width - font.getsize(info.strip())[0]) // 2
|
||||||
|
else:
|
||||||
|
info_pos = (width - font.getbbox(info.strip())[3]) // 2
|
||||||
|
|
||||||
# draw text
|
draw.multiline_text(
|
||||||
if hasattr(font, "getsize"):
|
(info_pos, size - qr_padding // 2), info, font=font, fill="black", align="right"
|
||||||
info_pos = (width - font.getsize(info.strip())[0]) // 2
|
)
|
||||||
else:
|
|
||||||
info_pos = (width - font.getbbox(info.strip())[3]) // 2
|
|
||||||
|
|
||||||
draw.multiline_text(
|
|
||||||
(info_pos, size - qr_padding // 2),
|
|
||||||
info,
|
|
||||||
font=font,
|
|
||||||
fill="black",
|
|
||||||
align="right",
|
|
||||||
)
|
|
||||||
|
|
||||||
# paste QR code
|
# paste QR code
|
||||||
image.paste(
|
image.paste(
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
myorigin = {{ config.mailname }}
|
myorigin = {{ config.domain_name }}
|
||||||
|
|
||||||
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
smtpd_banner = $myhostname ESMTP $mail_name (Debian/GNU)
|
||||||
biff = no
|
biff = no
|
||||||
@@ -16,8 +16,8 @@ readme_directory = no
|
|||||||
compatibility_level = 2
|
compatibility_level = 2
|
||||||
|
|
||||||
# TLS parameters
|
# TLS parameters
|
||||||
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mailname }}/fullchain
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.domain_name }}/fullchain
|
||||||
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mailname }}/privkey
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.domain_name }}/privkey
|
||||||
smtpd_tls_security_level=may
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
@@ -26,7 +26,7 @@ smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
|||||||
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
||||||
|
|
||||||
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
smtpd_relay_restrictions = permit_mynetworks permit_sasl_authenticated defer_unauth_destination
|
||||||
myhostname = {{ config.mailname }}
|
myhostname = {{ config.domain_name }}
|
||||||
alias_maps = hash:/etc/aliases
|
alias_maps = hash:/etc/aliases
|
||||||
alias_database = hash:/etc/aliases
|
alias_database = hash:/etc/aliases
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ inet_interfaces = all
|
|||||||
inet_protocols = all
|
inet_protocols = all
|
||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
virtual_mailbox_domains = {{ config.mailname }}
|
virtual_mailbox_domains = {{ config.domain_name }}
|
||||||
|
|
||||||
smtpd_milters = unix:opendkim/opendkim.sock
|
smtpd_milters = unix:opendkim/opendkim.sock
|
||||||
non_smtpd_milters = $smtpd_milters
|
non_smtpd_milters = $smtpd_milters
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ submission inet n - y - - smtpd
|
|||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:10080
|
||||||
smtps inet n - y - - smtpd
|
smtps inet n - y - - smtpd
|
||||||
-o syslog_name=postfix/smtps
|
-o syslog_name=postfix/smtps
|
||||||
-o smtpd_tls_wrappermode=yes
|
-o smtpd_tls_wrappermode=yes
|
||||||
@@ -49,7 +49,7 @@ smtps inet n - y - - smtpd
|
|||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:10080
|
||||||
#628 inet n - y - - qmqpd
|
#628 inet n - y - - qmqpd
|
||||||
pickup unix n - y 60 1 pickup
|
pickup unix n - y 60 1 pickup
|
||||||
cleanup unix n - y - 0 cleanup
|
cleanup unix n - y - 0 cleanup
|
||||||
@@ -78,5 +78,5 @@ scache unix - - y - 1 scache
|
|||||||
postlog unix-dgram n - n - 1 postlogd
|
postlog unix-dgram n - n - 1 postlogd
|
||||||
filter unix - n n - - lmtp
|
filter unix - n n - - lmtp
|
||||||
# Local SMTP server for reinjecting filered mail.
|
# Local SMTP server for reinjecting filered mail.
|
||||||
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
localhost:10025 inet n - n - 10 smtpd
|
||||||
-o syslog_name=postfix/reinject
|
-o syslog_name=postfix/reinject
|
||||||
|
|||||||
@@ -1,110 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
import webbrowser
|
|
||||||
import hashlib
|
|
||||||
import time
|
|
||||||
import traceback
|
|
||||||
|
|
||||||
import markdown
|
|
||||||
from jinja2 import Template
|
|
||||||
from .genqr import gen_qr_png_data
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def snapshot_dir_stats(somedir):
|
|
||||||
d = {}
|
|
||||||
for path in somedir.iterdir():
|
|
||||||
if path.is_file() and path.name[0] != "." and path.suffix != ".swp":
|
|
||||||
mtime = path.stat().st_mtime
|
|
||||||
hash = hashlib.md5(path.read_bytes()).hexdigest()
|
|
||||||
d[path] = (mtime, hash)
|
|
||||||
return d
|
|
||||||
|
|
||||||
|
|
||||||
def prepare_template(source):
|
|
||||||
assert source.exists(), source
|
|
||||||
render_vars = {}
|
|
||||||
render_vars["pagename"] = "home" if source.stem == "index" else source.stem
|
|
||||||
render_vars["markdown_html"] = markdown.markdown(source.read_text())
|
|
||||||
page_layout = source.with_name("page-layout.html").read_text()
|
|
||||||
return render_vars, page_layout
|
|
||||||
|
|
||||||
|
|
||||||
def build_webpages(src_dir, build_dir, config):
|
|
||||||
try:
|
|
||||||
_build_webpages(src_dir, build_dir, config)
|
|
||||||
except Exception:
|
|
||||||
print(traceback.format_exc())
|
|
||||||
|
|
||||||
|
|
||||||
def _build_webpages(src_dir, build_dir, config):
|
|
||||||
mail_domain = config.mailname
|
|
||||||
assert src_dir.exists(), src_dir
|
|
||||||
if not build_dir.exists():
|
|
||||||
build_dir.mkdir()
|
|
||||||
|
|
||||||
qr_path = build_dir.joinpath(f"qr-chatmail-invite-{mail_domain}.png")
|
|
||||||
qr_path.write_bytes(gen_qr_png_data(mail_domain).read())
|
|
||||||
|
|
||||||
for path in src_dir.iterdir():
|
|
||||||
if path.suffix == ".md":
|
|
||||||
render_vars, content = prepare_template(path)
|
|
||||||
target = build_dir.joinpath(path.stem + ".html")
|
|
||||||
|
|
||||||
# recursive jinja2 rendering
|
|
||||||
while 1:
|
|
||||||
new = Template(content).render(config=config, **render_vars)
|
|
||||||
if new == content:
|
|
||||||
break
|
|
||||||
content = new
|
|
||||||
|
|
||||||
with target.open("w") as f:
|
|
||||||
f.write(content)
|
|
||||||
elif path.name != "page-layout.html":
|
|
||||||
target = build_dir.joinpath(path.name)
|
|
||||||
target.write_bytes(path.read_bytes())
|
|
||||||
return build_dir
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
chatmail_domain = "example.testrun.org"
|
|
||||||
path = importlib.resources.files(__package__)
|
|
||||||
reporoot = path.joinpath("../../../").resolve()
|
|
||||||
inipath = reporoot.joinpath("chatmail.ini")
|
|
||||||
config = read_config(inipath, mailname=chatmail_domain)
|
|
||||||
config["webdev"] = True
|
|
||||||
www_path = reporoot.joinpath("www")
|
|
||||||
src_path = www_path.joinpath("src")
|
|
||||||
stats = None
|
|
||||||
build_dir = www_path.joinpath("build")
|
|
||||||
src_dir = www_path.joinpath("src")
|
|
||||||
index_path = build_dir.joinpath("index.html")
|
|
||||||
|
|
||||||
# start web page generation, open a browser and wait for changes
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
webbrowser.open(str(index_path))
|
|
||||||
stats = snapshot_dir_stats(src_path)
|
|
||||||
print(f"\nOpened URL: file://{index_path.resolve()}\n")
|
|
||||||
print(f"watching {src_path} directory for changes")
|
|
||||||
|
|
||||||
changenum = 0
|
|
||||||
for count in range(0, 1000000):
|
|
||||||
newstats = snapshot_dir_stats(src_path)
|
|
||||||
if newstats == stats and count % 60 != 0:
|
|
||||||
count += 1
|
|
||||||
time.sleep(1.0)
|
|
||||||
continue
|
|
||||||
|
|
||||||
for key in newstats:
|
|
||||||
if stats[key] != newstats[key]:
|
|
||||||
print(f"*** CHANGED: {key}")
|
|
||||||
changenum += 1
|
|
||||||
|
|
||||||
stats = newstats
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
print(f"[{changenum}] regenerated web pages at: {index_path}")
|
|
||||||
print(f"URL: file://{index_path.resolve()}\n\n")
|
|
||||||
count = 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -4,5 +4,12 @@ echo -----------------------------------------
|
|||||||
echo deploying to $CHATMAIL_DOMAIN
|
echo deploying to $CHATMAIL_DOMAIN
|
||||||
echo -----------------------------------------
|
echo -----------------------------------------
|
||||||
|
|
||||||
|
echo WARNING: in five seconds deploy to $CHATMAIL_DOMAIN starts
|
||||||
|
sleep 5
|
||||||
|
|
||||||
|
venv/bin/python3 -m build -n --sdist chatmaild --outdir dist
|
||||||
|
|
||||||
venv/bin/pyinfra --ssh-user root "$CHATMAIL_DOMAIN" \
|
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/
|
||||||
|
|||||||
@@ -3,6 +3,6 @@ set -e
|
|||||||
python3 -m venv venv
|
python3 -m venv venv
|
||||||
pip=venv/bin/pip
|
pip=venv/bin/pip
|
||||||
|
|
||||||
$pip install pyinfra pytest build 'setuptools>=68' tox
|
$pip install pyinfra pytest build 'setuptools>=68' tox deltachat
|
||||||
$pip install -e deploy-chatmail
|
$pip install -e deploy-chatmail
|
||||||
$pip install -e chatmaild
|
$pip install -e chatmaild
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
echo -----------------------------------------
|
|
||||||
echo starting local webdev
|
|
||||||
echo -----------------------------------------
|
|
||||||
|
|
||||||
venv/bin/python3 -m deploy_chatmail.www
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
from chatmaild.config import read_config
|
|
||||||
import chatmaild.config
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_without_mailname(tmp_path, create_ini, monkeypatch):
|
|
||||||
mailname_path = tmp_path.joinpath("mailname")
|
|
||||||
mailname_path.write_text("something.example.org")
|
|
||||||
monkeypatch.setattr(chatmaild.config, "system_mailname_path", mailname_path)
|
|
||||||
|
|
||||||
inipath = create_ini(
|
|
||||||
"""
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 40
|
|
||||||
filtermail_smtp_port = 9875
|
|
||||||
postfix_reinject_port = 9999
|
|
||||||
passthrough_recipients =
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
config = read_config(inipath)
|
|
||||||
assert config.mailname == "something.example.org"
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_without_privacy_policy(tmp_path, create_ini):
|
|
||||||
inipath = create_ini(
|
|
||||||
"""
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 40
|
|
||||||
filtermail_smtp_port = 9875
|
|
||||||
postfix_reinject_port = 9999
|
|
||||||
passthrough_recipients =
|
|
||||||
|
|
||||||
[privacy:testrun]
|
|
||||||
domain = *.example.org
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
config = read_config(inipath, "something.example.org")
|
|
||||||
assert config.mailname == "something.example.org"
|
|
||||||
assert config.max_user_send_per_minute == 40
|
|
||||||
assert config.filtermail_smtp_port == 9875
|
|
||||||
assert config.postfix_reinject_port == 9999
|
|
||||||
assert config.passthrough_recipients == []
|
|
||||||
assert not config.privacy_postal
|
|
||||||
assert not config.privacy_mail
|
|
||||||
assert not config.privacy_pdo
|
|
||||||
assert not config.privacy_supervisor
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config(create_ini):
|
|
||||||
inipath = create_ini(
|
|
||||||
"""
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 40
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
passthrough_recipients = x@example.org y@example.org
|
|
||||||
|
|
||||||
[privacy:testrun]
|
|
||||||
domain = *.testrun.org
|
|
||||||
|
|
||||||
privacy_postal =
|
|
||||||
Postal Ltd
|
|
||||||
|
|
||||||
privacy_mail = privacy@merlinux.eu
|
|
||||||
|
|
||||||
privacy_pdo =
|
|
||||||
Postal PDO
|
|
||||||
You can contact him at *delta-privacy@merlinux.eu* (Keyword: DPO)
|
|
||||||
|
|
||||||
privacy_supervisor =
|
|
||||||
line1
|
|
||||||
line2 with space
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
|
|
||||||
config = read_config(inipath, "something.testrun.org")
|
|
||||||
|
|
||||||
assert config.mailname == "something.testrun.org"
|
|
||||||
assert config.filtermail_smtp_port == 10080
|
|
||||||
assert config.postfix_reinject_port == 10025
|
|
||||||
assert config.passthrough_recipients == ["x@example.org", "y@example.org"]
|
|
||||||
assert config.privacy_postal == "Postal Ltd"
|
|
||||||
assert config.privacy_mail == "privacy@merlinux.eu"
|
|
||||||
lines = config.privacy_pdo.split("\n")
|
|
||||||
assert lines[0] == "Postal PDO"
|
|
||||||
assert lines[1].startswith("You can ")
|
|
||||||
lines = config.privacy_supervisor.split("\n")
|
|
||||||
assert lines[0] == "line1"
|
|
||||||
assert lines[1] == "line2 with space"
|
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import json
|
import json
|
||||||
|
import sys
|
||||||
import pytest
|
import pytest
|
||||||
import threading
|
import threading
|
||||||
import queue
|
import queue
|
||||||
@@ -6,7 +7,7 @@ import traceback
|
|||||||
|
|
||||||
import chatmaild.doveauth
|
import chatmaild.doveauth
|
||||||
from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_request
|
from chatmaild.doveauth import get_user_data, lookup_passdb, handle_dovecot_request
|
||||||
from chatmaild.database import DBError
|
from chatmaild.database import Database, DBError
|
||||||
|
|
||||||
|
|
||||||
def test_basic(db):
|
def test_basic(db):
|
||||||
|
|||||||
@@ -1,12 +1,4 @@
|
|||||||
from chatmaild.filtermail import (
|
from chatmaild.filtermail import check_encrypted, check_DATA, SendRateLimiter, check_mdn
|
||||||
check_encrypted,
|
|
||||||
BeforeQueueHandler,
|
|
||||||
SendRateLimiter,
|
|
||||||
check_mdn,
|
|
||||||
)
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
@@ -16,25 +8,18 @@ def maildomain():
|
|||||||
return "chatmail.example.org"
|
return "chatmail.example.org"
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
def test_reject_forged_from(maildata, gencreds):
|
||||||
def handler(create_ini, maildomain):
|
|
||||||
config = read_config(create_ini(), maildomain)
|
|
||||||
return BeforeQueueHandler(config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_reject_forged_from(maildata, gencreds, handler):
|
|
||||||
class env:
|
class env:
|
||||||
mail_from = gencreds()[0]
|
mail_from = gencreds()[0]
|
||||||
rcpt_tos = [gencreds()[0]]
|
rcpt_tos = [gencreds()[0]]
|
||||||
|
|
||||||
# test that the filter lets good mail through
|
# test that the filter lets good mail through
|
||||||
env.content = maildata("plain.eml", from_addr=env.mail_from).as_bytes()
|
env.content = maildata("plain.eml", from_addr=env.mail_from).as_bytes()
|
||||||
|
assert not check_DATA(envelope=env)
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
# test that the filter rejects forged mail
|
# test that the filter rejects forged mail
|
||||||
env.content = maildata("plain.eml", from_addr="forged@c3.testrun.org").as_bytes()
|
env.content = maildata("plain.eml", from_addr="forged@c3.testrun.org").as_bytes()
|
||||||
error = handler.check_DATA(envelope=env)
|
error = check_DATA(envelope=env)
|
||||||
assert "500" in error
|
assert "500" in error
|
||||||
|
|
||||||
|
|
||||||
@@ -56,7 +41,7 @@ def test_filtermail_encryption_detection(maildata):
|
|||||||
assert not check_encrypted(msg)
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_is_mdn(maildata, gencreds, handler):
|
def test_filtermail_is_mdn(maildata, gencreds):
|
||||||
from_addr = gencreds()[0]
|
from_addr = gencreds()[0]
|
||||||
to_addr = gencreds()[0] + ".other"
|
to_addr = gencreds()[0] + ".other"
|
||||||
msg = maildata("mdn.eml", from_addr, to_addr)
|
msg = maildata("mdn.eml", from_addr, to_addr)
|
||||||
@@ -68,8 +53,7 @@ def test_filtermail_is_mdn(maildata, gencreds, handler):
|
|||||||
|
|
||||||
assert check_mdn(msg, env)
|
assert check_mdn(msg, env)
|
||||||
print(msg.as_string())
|
print(msg.as_string())
|
||||||
|
assert not check_DATA(env)
|
||||||
assert not handler.check_DATA(env)
|
|
||||||
|
|
||||||
|
|
||||||
def test_filtermail_to_multiple_recipients_no_mdn(maildata, gencreds):
|
def test_filtermail_to_multiple_recipients_no_mdn(maildata, gencreds):
|
||||||
@@ -89,35 +73,10 @@ def test_filtermail_to_multiple_recipients_no_mdn(maildata, gencreds):
|
|||||||
def test_send_rate_limiter():
|
def test_send_rate_limiter():
|
||||||
limiter = SendRateLimiter()
|
limiter = SendRateLimiter()
|
||||||
for i in range(100):
|
for i in range(100):
|
||||||
if limiter.is_sending_allowed("some@example.org", 10):
|
if limiter.is_sending_allowed("some@example.org"):
|
||||||
if i <= 10:
|
if i <= SendRateLimiter.MAX_USER_SEND_PER_MINUTE:
|
||||||
continue
|
continue
|
||||||
pytest.fail("limiter didn't work")
|
pytest.fail("limiter didn't work")
|
||||||
else:
|
else:
|
||||||
assert i == 11
|
assert i == SendRateLimiter.MAX_USER_SEND_PER_MINUTE + 1
|
||||||
break
|
break
|
||||||
|
|
||||||
|
|
||||||
def test_excempt_privacy(maildata, gencreds, handler):
|
|
||||||
from_addr = gencreds()[0]
|
|
||||||
to_addr = "privacy@testrun.org"
|
|
||||||
false_to = "privacy@tstrn.org"
|
|
||||||
false_to2 = "prvcy@testrun.org"
|
|
||||||
assert to_addr in handler.config.passthrough_recipients
|
|
||||||
|
|
||||||
msg = maildata("plain.eml", from_addr, to_addr)
|
|
||||||
|
|
||||||
class env:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
# assert that None/no error is returned
|
|
||||||
assert not handler.check_DATA(envelope=env)
|
|
||||||
|
|
||||||
class env2:
|
|
||||||
mail_from = from_addr
|
|
||||||
rcpt_tos = [to_addr, false_to, false_to2]
|
|
||||||
content = msg.as_bytes()
|
|
||||||
|
|
||||||
assert "500" in handler.check_DATA(envelope=env2)
|
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ import json
|
|||||||
import chatmaild
|
import chatmaild
|
||||||
from chatmaild.newemail import create_newemail_dict, print_new_account
|
from chatmaild.newemail import create_newemail_dict, print_new_account
|
||||||
|
|
||||||
|
|
||||||
def test_create_newemail_dict():
|
def test_create_newemail_dict():
|
||||||
ac1 = create_newemail_dict(domain="example.org")
|
ac1 = create_newemail_dict(domain="example.org")
|
||||||
assert "@" in ac1["email"]
|
assert "@" in ac1["email"]
|
||||||
|
|||||||
@@ -3,10 +3,8 @@ import io
|
|||||||
import time
|
import time
|
||||||
import random
|
import random
|
||||||
import subprocess
|
import subprocess
|
||||||
import textwrap
|
|
||||||
import imaplib
|
import imaplib
|
||||||
import smtplib
|
import smtplib
|
||||||
import importlib.resources
|
|
||||||
import itertools
|
import itertools
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
from email import policy
|
from email import policy
|
||||||
@@ -39,14 +37,6 @@ def pytest_runtest_setup(item):
|
|||||||
pytest.skip("skipping slow test, use --slow to run")
|
pytest.skip("skipping slow test, use --slow to run")
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def inipath():
|
|
||||||
dpath = importlib.resources.files("chatmaild")
|
|
||||||
inipath = dpath.joinpath("../../../chatmail.ini").resolve()
|
|
||||||
assert inipath.exists()
|
|
||||||
return inipath
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildomain():
|
def maildomain():
|
||||||
domain = os.environ.get("CHATMAIL_DOMAIN")
|
domain = os.environ.get("CHATMAIL_DOMAIN")
|
||||||
@@ -288,13 +278,11 @@ class ChatmailTestProcess:
|
|||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def cmfactory(request, gencreds, tmpdir, maildomain):
|
def cmfactory(request, gencreds, tmpdir, data, maildomain):
|
||||||
# cloned from deltachat.testplugin.amfactory
|
# cloned from deltachat.testplugin.amfactory
|
||||||
pytest.importorskip("deltachat")
|
pytest.importorskip("deltachat")
|
||||||
from deltachat.testplugin import ACFactory
|
from deltachat.testplugin import ACFactory
|
||||||
|
|
||||||
data = request.getfixturevalue("data")
|
|
||||||
|
|
||||||
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
testproc = ChatmailTestProcess(request.config, maildomain, gencreds)
|
||||||
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
am = ACFactory(request=request, tmpdir=tmpdir, testprocess=testproc, data=data)
|
||||||
|
|
||||||
@@ -338,18 +326,6 @@ class Remote:
|
|||||||
break
|
break
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def lp(request):
|
|
||||||
class LP:
|
|
||||||
def sec(self, msg):
|
|
||||||
print(f"---- {msg} ----")
|
|
||||||
|
|
||||||
def indent(self, msg):
|
|
||||||
print(f" {msg}")
|
|
||||||
|
|
||||||
return LP()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def maildata(request, gencreds):
|
def maildata(request, gencreds):
|
||||||
datadir = conftestdir.joinpath("mail-data")
|
datadir = conftestdir.joinpath("mail-data")
|
||||||
@@ -412,16 +388,3 @@ class CMUser:
|
|||||||
imap.login(self.addr, self.password)
|
imap.login(self.addr, self.password)
|
||||||
self._imap = imap
|
self._imap = imap
|
||||||
return self._imap
|
return self._imap
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def create_ini(tmp_path, inipath):
|
|
||||||
def create_ini_func(source=None):
|
|
||||||
if source is None:
|
|
||||||
source = inipath.read_text()
|
|
||||||
p = tmp_path.joinpath("chatmail.ini")
|
|
||||||
assert not p.exists(), p
|
|
||||||
p.write_text(textwrap.dedent(source))
|
|
||||||
return p
|
|
||||||
|
|
||||||
return create_ini_func
|
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
from deploy_chatmail.genqr import gen_qr_png_data
|
|
||||||
|
|
||||||
|
|
||||||
def test_gen_qr_png_data(maildomain):
|
|
||||||
data = gen_qr_png_data(maildomain)
|
|
||||||
assert data
|
|
||||||
@@ -54,7 +54,7 @@ def test_exceed_rate_limit(cmsetup, gencreds, maildata):
|
|||||||
try:
|
try:
|
||||||
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
user1.smtp.sendmail(user1.addr, [user2.addr], mail)
|
||||||
except smtplib.SMTPException as e:
|
except smtplib.SMTPException as e:
|
||||||
if i < 60:
|
if i < 80:
|
||||||
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
pytest.fail(f"rate limit was exceeded too early with msg {i}")
|
||||||
outcome = e.recipients[user2.addr]
|
outcome = e.recipients[user2.addr]
|
||||||
assert outcome[0] == 450
|
assert outcome[0] == 450
|
||||||
|
|||||||
@@ -1,48 +0,0 @@
|
|||||||
import textwrap
|
|
||||||
import importlib.resources
|
|
||||||
|
|
||||||
from deploy_chatmail.www import build_webpages
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
|
|
||||||
def make_config(create_ini, domain="example.org"):
|
|
||||||
inipath = create_ini(
|
|
||||||
textwrap.dedent(
|
|
||||||
f"""\
|
|
||||||
[params]
|
|
||||||
max_user_send_per_minute = 60
|
|
||||||
filtermail_smtp_port = 10080
|
|
||||||
postfix_reinject_port = 10025
|
|
||||||
passthrough_recipients =
|
|
||||||
|
|
||||||
[privacy:{domain}]
|
|
||||||
domain = example.org
|
|
||||||
privacy_postal =
|
|
||||||
address-line1
|
|
||||||
address-line2
|
|
||||||
|
|
||||||
privacy_mail = privacy@{domain}
|
|
||||||
|
|
||||||
privacy_pdo =
|
|
||||||
address-line3
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
)
|
|
||||||
return read_config(inipath, domain)
|
|
||||||
|
|
||||||
|
|
||||||
def test_build_webpages(tmp_path, create_ini):
|
|
||||||
pkgroot = importlib.resources.files("deploy_chatmail")
|
|
||||||
src_dir = pkgroot.joinpath("../../../www/src").resolve()
|
|
||||||
assert src_dir.exists(), src_dir
|
|
||||||
config = make_config(create_ini, "example.org")
|
|
||||||
build_dir = tmp_path.joinpath("build")
|
|
||||||
build_webpages(src_dir, build_dir, config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_get_settings(tmp_path, create_ini):
|
|
||||||
config = make_config(create_ini, "example.org")
|
|
||||||
assert config.privacy_postal == "address-line1\naddress-line2"
|
|
||||||
assert config.privacy_mail == "privacy@example.org"
|
|
||||||
assert config.privacy_pdo == "address-line3"
|
|
||||||
assert config.mailname == "example.org"
|
|
||||||
31
www/default/index.html.j2
Normal file
31
www/default/index.html.j2
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<title>chatmail instance</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>Welcome to {{ config.mail_domain }}!</h1>
|
||||||
|
<h2>Getting started</h2>
|
||||||
|
<ol>
|
||||||
|
<li>Install <a href="https://get.delta.chat">https://get.delta.chat</a></li>
|
||||||
|
<li>Scan or Tap on the invite QR code</li>
|
||||||
|
<li>Choose Nickname and Avatar</li>
|
||||||
|
<li>Setup contact with others using <a href="https://delta.chat/en/help#howtoe2ee">
|
||||||
|
guaranteed end-to-end encryption via QR code scans</a>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<a href="DCACCOUNT:https://{{ config.mail_domain }}/cgi-bin/newemail.py">
|
||||||
|
<img class="section" src="qrcode.png" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<h2>Constraints</h2>
|
||||||
|
<ul>
|
||||||
|
<li>You can only send encrypted mails to anyone outside {{config.mail_domain }} </li>
|
||||||
|
<li>You may send up to 60 messages per minute</li>
|
||||||
|
<li>Messages are unconditionally removed 40 days after arrival</li>
|
||||||
|
<li>Max storage per user is 100MB</li>
|
||||||
|
</ul>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
BIN
www/nine.testrun.org/collage-bg.png
Normal file
BIN
www/nine.testrun.org/collage-bg.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
BIN
www/nine.testrun.org/collage-down.png
Normal file
BIN
www/nine.testrun.org/collage-down.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
BIN
www/nine.testrun.org/collage-top.png
Normal file
BIN
www/nine.testrun.org/collage-top.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 163 KiB |
81
www/nine.testrun.org/index.html
Normal file
81
www/nine.testrun.org/index.html
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
<!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: "Swansea", "Helvetica", sans-serif;
|
||||||
|
color: black;
|
||||||
|
}
|
||||||
|
a {
|
||||||
|
color: black;
|
||||||
|
}
|
||||||
|
h1, h2, h3 {
|
||||||
|
font-size: 18px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="wrapper">
|
||||||
|
<img class="section" src="collage-top.png" />
|
||||||
|
<div class="section text">
|
||||||
|
<h1>Dear Delta Chat users and newcomers,</h1>
|
||||||
|
<p>
|
||||||
|
welcome to the first public "chat-mail instance",
|
||||||
|
a small and lean e-mail provider for smooth chatting.
|
||||||
|
Install Delta Chat and then
|
||||||
|
Tap or scan this QR code to obtain a random e-mail address:
|
||||||
|
<a href="DCACCOUNT:https://nine.testrun.org/cgi-bin/newemail.py">
|
||||||
|
<img with=300 src="qrcode.png" /></a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Alternatively, you can manually invent an e-mail address:
|
||||||
|
<ul>
|
||||||
|
<li>Tap "LOG INTO YOUR E-MAIL ACCOUNT".</li>
|
||||||
|
<li>Address: invent a word with <i>exactly</i> nine characters
|
||||||
|
and append @nine.testrun.org to it.</li>
|
||||||
|
<li>Password: invent at least 10 characters. The first login sets your password.</li>
|
||||||
|
</ul>
|
||||||
|
If the e-mail address is not yet taken, you'll get that account.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<img class="section" src="collage-down.png" />
|
||||||
|
|
||||||
|
<h2>What's behind it, how does it operate?</h2>
|
||||||
|
<p>nine.testrun.org is run
|
||||||
|
by a small group of devs and sysadmins, reachable via root@.
|
||||||
|
They want to keep this instance running at least until end 2024.
|
||||||
|
Current limits:
|
||||||
|
<ul>
|
||||||
|
<li>Un-encrypted mails can not leave the chat-mail instance.</li>
|
||||||
|
<li>Use <a href="https://delta.chat/en/help#howtoe2ee">
|
||||||
|
guaranteed end-to-end encryption via QR code scans</a>
|
||||||
|
to setup contact with users outside of the chat-mail instance.
|
||||||
|
</li>
|
||||||
|
<li>You may send up to 60 messages per minute.</li>
|
||||||
|
<li>Messages are unconditionally removed 40 days after arrival.</li>
|
||||||
|
<li>Max storage per user is 100MB.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Why are other email providers 1000 times more complicated?</h2>
|
||||||
|
<p>¯\_(ツ)_/¯</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 50 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB |
@@ -1,19 +0,0 @@
|
|||||||
|
|
||||||
<img width="800px" src="collage-top.png"/>
|
|
||||||
|
|
||||||
## Dear [Delta Chat](https://get.delta.chat) users and newcomers,
|
|
||||||
|
|
||||||
Welcome to instant, interoperable and [privacy-preserving](privacy.html) messaging :)
|
|
||||||
|
|
||||||
👉 **Tap** or scan this QR code to get a random `@{{config.mail_domain}}` e-mail address
|
|
||||||
|
|
||||||
<a href="DCACCOUNT:https://{{ config.mail_domain }}/cgi-bin/newemail.py">
|
|
||||||
<img width=300 style="float: none;" src="qr-chatmail-invite-{{config.mail_domain}}.png" /></a>
|
|
||||||
|
|
||||||
🐣 **Choose** your Avatar and Name
|
|
||||||
|
|
||||||
💬 **Start** chatting with any Delta Chat contacts using [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
|
||||||
|
|
||||||
|
|
||||||
## ⚡ Note: this is an experimental service ⚡
|
|
||||||
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
|
|
||||||
<img width="800px" src="collage-info.png"/>
|
|
||||||
|
|
||||||
## More information
|
|
||||||
|
|
||||||
### Choosing a chatmail address instead of using a random one
|
|
||||||
|
|
||||||
In the Delta Chat account setup
|
|
||||||
you may tap `LOG INTO YOUR E-MAIL ACCOUNT`
|
|
||||||
and fill the two fields like this:
|
|
||||||
|
|
||||||
- `Address`: invent a word with *exactly* nine characters
|
|
||||||
and append `@{{config.mail_domain}}` to it.
|
|
||||||
|
|
||||||
- `Password`: invent at least 9 characters.
|
|
||||||
|
|
||||||
If the e-mail address is not yet taken, you'll get that account.
|
|
||||||
The first login sets your password.
|
|
||||||
|
|
||||||
|
|
||||||
### Rate and storage limits
|
|
||||||
|
|
||||||
- Un-encrypted messages are blocked to recipients outside
|
|
||||||
{{config.mail_domain}} but setting up contact via [QR invite codes](https://delta.chat/en/help#howtoe2ee)
|
|
||||||
allows your messages to pass freely to any outside recipients.
|
|
||||||
|
|
||||||
- You may send up to 60 messages per minute
|
|
||||||
|
|
||||||
- Messages are unconditionally removed 40 days after arriving on the server
|
|
||||||
|
|
||||||
- You can store up to [100MB messages on the server](https://delta.chat/en/help#what-happens-if-i-turn-on-delete-old-messages-from-server)
|
|
||||||
|
|
||||||
|
|
||||||
### Who are the operators? Which software is running?
|
|
||||||
|
|
||||||
This chatmail provider is run by a small voluntary group of devs and sysadmins,
|
|
||||||
who [publically develop chatmail provider setups](https://github.com/deltachat/chatmail).
|
|
||||||
Chatmail setups aim to be very low-maintenance, resource efficient and
|
|
||||||
interoperable with any other standards-compliant e-mail service.
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
{% if config.webdev %}
|
|
||||||
<meta http-equiv="refresh" content="3">
|
|
||||||
{% endif %}
|
|
||||||
<title>{{ config.mail_domain }} {{ pagename }}</title>
|
|
||||||
<link rel="stylesheet" href="./water.css">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
{{ markdown_html }}
|
|
||||||
<footer>
|
|
||||||
<a href="index.html">home</a> |
|
|
||||||
<a href="info.html">more info</a> |
|
|
||||||
<a href="privacy.html">privacy</a> |
|
|
||||||
<a href="https://github.com/deltachat/chatmail">-> public development </a>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,321 +0,0 @@
|
|||||||
<img width="800px" src="collage-privacy.png"/>
|
|
||||||
|
|
||||||
# Privacy Policy for {{ config.mail_domain }}
|
|
||||||
|
|
||||||
We want to show you in a fair and transparent way
|
|
||||||
what personal data is processed by us.
|
|
||||||
We follow a strict privacy-by-design approach
|
|
||||||
and try to avoid processing your data in the first place,
|
|
||||||
but as you may know,
|
|
||||||
the internet,
|
|
||||||
and in particular sending e-mail messages,
|
|
||||||
does not work without data.
|
|
||||||
Still,
|
|
||||||
it's only fair that you know at all times
|
|
||||||
what personal data is processed
|
|
||||||
when you use our service.
|
|
||||||
|
|
||||||
If you have any remaining questions about data protection, please contact us.
|
|
||||||
|
|
||||||
## 1. Name and contact information
|
|
||||||
|
|
||||||
Responsible for the processing of your personal data is:
|
|
||||||
```
|
|
||||||
{{ config.privacy_postal }}
|
|
||||||
```
|
|
||||||
|
|
||||||
E-mail: {{ config.privacy_mail }}
|
|
||||||
|
|
||||||
We have appointed a data protection officer:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ config.privacy_pdo }}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 2. Processing when using chat e-mail services
|
|
||||||
|
|
||||||
We provide e-mail services optimized for the use from [Delta Chat](https://delta.chat) apps
|
|
||||||
and process only the data necessary
|
|
||||||
for the setup and technical execution of the e-mail dispatch.
|
|
||||||
The purpose of the processing is to
|
|
||||||
read, write, manage, delete, send, and receive emails.
|
|
||||||
For this purpose,
|
|
||||||
we operate server-side software
|
|
||||||
that enables us to send and receive e-mail messages.
|
|
||||||
Allowing the use of the e-mail service,
|
|
||||||
we process the following data and details:
|
|
||||||
|
|
||||||
- Outgoing and incoming messages (SMTP) are stored for transit
|
|
||||||
on behalf of their users until the message can be delivered.
|
|
||||||
|
|
||||||
- E-Mail-Messages are stored for the recipient and made accessible via IMAP protocols,
|
|
||||||
until explicitly deleted by the user or until a fixed time period is exceeded,
|
|
||||||
(*usually 4-8 weeks*).
|
|
||||||
|
|
||||||
- IMAP and SMTP protocols are password protected with unique credentials for each account.
|
|
||||||
|
|
||||||
- Users can retrieve or delete all stored messages
|
|
||||||
without intervention from the operators using standard IMAP client tools.
|
|
||||||
|
|
||||||
### 3.1 Account setup
|
|
||||||
|
|
||||||
Creating an account happens in one of two ways on our mail servers:
|
|
||||||
|
|
||||||
- with a QR invitation token
|
|
||||||
which is scanned using the DeltaChat app
|
|
||||||
and then the account is created.
|
|
||||||
|
|
||||||
- by letting Delta Chat otherwise create an account
|
|
||||||
and register it with a {{ config.mail_domain }} mail server.
|
|
||||||
|
|
||||||
In either case, we process the newly created email address.
|
|
||||||
No phone numbers,
|
|
||||||
other email addresses,
|
|
||||||
or other identifiable data
|
|
||||||
is currently required.
|
|
||||||
The legal basis for the processing is
|
|
||||||
Art. 6 (1) lit. b GDPR,
|
|
||||||
as you have a usage contract with us
|
|
||||||
by using our services.
|
|
||||||
|
|
||||||
## 3.2 Processing of E-Mail-Messages
|
|
||||||
|
|
||||||
In addition,
|
|
||||||
we will process data
|
|
||||||
to keep the server infrastructure operational
|
|
||||||
for purposes of e-mail dispatch
|
|
||||||
and abuse prevention.
|
|
||||||
|
|
||||||
- Therefore,
|
|
||||||
it is necessary to process the content and/or metadata
|
|
||||||
(e.g., headers of the email as well as smtp chatter)
|
|
||||||
of E-Mail-Messages in transit.
|
|
||||||
|
|
||||||
- We will keep logs of messages in transit for a limited time.
|
|
||||||
These logs are used to debug delivery problems and software bugs.
|
|
||||||
|
|
||||||
In addition,
|
|
||||||
we process data to protect the systems from excessive use.
|
|
||||||
Therefore, limits are enforced:
|
|
||||||
|
|
||||||
- rate limits
|
|
||||||
|
|
||||||
- storage limits
|
|
||||||
|
|
||||||
- message size limits
|
|
||||||
|
|
||||||
- any other limit neccessary for the whole server to function in a healthy way
|
|
||||||
and to prevent abuse.
|
|
||||||
|
|
||||||
The processing and use of the above permissions
|
|
||||||
are performed to provide the service.
|
|
||||||
The data processing is necessary for the use of our services,
|
|
||||||
therefore the legal basis of the processing is
|
|
||||||
Art. 6 (1) lit. b GDPR,
|
|
||||||
as you have a usage contract with us
|
|
||||||
by using our services.
|
|
||||||
The legal basis for the data processing
|
|
||||||
for the purposes of security and abuse prevention is
|
|
||||||
Art. 6 (1) lit. f GDPR.
|
|
||||||
Our legitimate interest results
|
|
||||||
from the aforementioned purposes.
|
|
||||||
We will not use the collected data
|
|
||||||
for the purpose of drawing conclusions
|
|
||||||
about your person.
|
|
||||||
|
|
||||||
|
|
||||||
## 3. Processing when using our Website
|
|
||||||
|
|
||||||
When you visit our website,
|
|
||||||
the browser used on your end device
|
|
||||||
automatically sends information to the server of our website.
|
|
||||||
This information is temporarily stored in a so-called log file.
|
|
||||||
The following information is collected and stored
|
|
||||||
until it is automatically deleted
|
|
||||||
(*usually 7 days*):
|
|
||||||
|
|
||||||
- used type of browser,
|
|
||||||
|
|
||||||
- used operating system,
|
|
||||||
|
|
||||||
- access date and time as well as
|
|
||||||
|
|
||||||
- country of origin and IP address,
|
|
||||||
|
|
||||||
- the requested file name or HTTP resource,
|
|
||||||
|
|
||||||
- the amount of data transferred,
|
|
||||||
|
|
||||||
- the access status (file transferred, file not found, etc.) and
|
|
||||||
|
|
||||||
- the page from which the file was requested.
|
|
||||||
|
|
||||||
This website is hosted by an external service provider (hoster).
|
|
||||||
The personal data collected on this website is stored
|
|
||||||
on the hoster's servers.
|
|
||||||
Our hoster will process your data
|
|
||||||
only to the extent necessary to fulfill its obligations
|
|
||||||
to perform under our instructions.
|
|
||||||
In order to ensure data protection-compliant processing,
|
|
||||||
we have concluded a data processing agreement with our hoster.
|
|
||||||
|
|
||||||
The aforementioned data is processed by us for the following purposes:
|
|
||||||
|
|
||||||
- Ensuring a reliable connection setup of the website,
|
|
||||||
|
|
||||||
- ensuring a convenient use of our website,
|
|
||||||
|
|
||||||
- checking and ensuring system security and stability, and
|
|
||||||
|
|
||||||
- for other administrative purposes.
|
|
||||||
|
|
||||||
The legal basis for the data processing is
|
|
||||||
Art. 6 (1) lit. f GDPR.
|
|
||||||
Our legitimate interest results
|
|
||||||
from the aforementioned purposes of data collection.
|
|
||||||
We will not use the collected data
|
|
||||||
for the purpose of drawing conclusions about your person.
|
|
||||||
|
|
||||||
## 4. Transfer of Data
|
|
||||||
|
|
||||||
Your personal data
|
|
||||||
will not be transferred to third parties
|
|
||||||
for purposes other than those listed below:
|
|
||||||
|
|
||||||
a) you have given your express consent
|
|
||||||
in accordance with Art. 6 para. 1 sentence 1 lit. a GDPR,
|
|
||||||
|
|
||||||
b) the disclosure is necessary for the assertion, exercise or defence of legal claims
|
|
||||||
pursuant to Art. 6 (1) sentence 1 lit. f GDPR
|
|
||||||
and there is no reason to assume that you have
|
|
||||||
an overriding interest worthy of protection
|
|
||||||
in the non-disclosure of your data,
|
|
||||||
|
|
||||||
c) in the event that there is a legal obligation to disclose your data
|
|
||||||
pursuant to Art. 6 para. 1 sentence 1 lit. c GDPR,
|
|
||||||
as well as
|
|
||||||
|
|
||||||
d) this is legally permissible and necessary
|
|
||||||
in accordance with Art. 6 Para. 1 S. 1 lit. b GDPR
|
|
||||||
for the processing of contractual relationships with you,
|
|
||||||
|
|
||||||
e) this is carried out by a service provider
|
|
||||||
acting on our behalf and on our exclusive instructions,
|
|
||||||
whom we have carefully selected (Art. 28 (1) GDPR)
|
|
||||||
and with whom we have concluded a corresponding contract on commissioned processing (Art. 28 (3) GDPR),
|
|
||||||
which obliges our contractor,
|
|
||||||
among other things,
|
|
||||||
to implement appropriate security measures
|
|
||||||
and grants us comprehensive control powers.
|
|
||||||
|
|
||||||
## 5. Rights of the data subject
|
|
||||||
|
|
||||||
The rights arise from Articles 12 to 23 GDPR.
|
|
||||||
Since no personal data is stored on our servers,
|
|
||||||
even in encrypted form,
|
|
||||||
there is no need to provide information
|
|
||||||
on these or possible objections.
|
|
||||||
A deletion can be made
|
|
||||||
directly in the Delta Chat email messenger.
|
|
||||||
|
|
||||||
a) request information about your personal data processed by us
|
|
||||||
in accordance with Art. 15 GDPR.
|
|
||||||
In particular,
|
|
||||||
you can request information about the processing purposes,
|
|
||||||
the category of personal data,
|
|
||||||
the categories of recipients to whom your data have been or will be disclosed,
|
|
||||||
the planned storage period,
|
|
||||||
the existence of a right to rectification, erasure, restriction of processing or objection,
|
|
||||||
the existence of a right of complaint,
|
|
||||||
the origin of your data if it has not been collected by us,
|
|
||||||
as well as the existence of automated decision-making including profiling
|
|
||||||
and, if applicable,
|
|
||||||
meaningful information about its details;
|
|
||||||
|
|
||||||
b) in accordance with Art. 16 of the GDPR,
|
|
||||||
immediately request the correction
|
|
||||||
of inaccurate or incomplete personal data stored by us;
|
|
||||||
|
|
||||||
c) pursuant to Article 17 of the GDPR,
|
|
||||||
to request the erasure of your personal data stored by us,
|
|
||||||
unless the processing is necessary
|
|
||||||
for the exercise of the right to freedom of expression and information,
|
|
||||||
for compliance with a legal obligation,
|
|
||||||
for reasons of public interest,
|
|
||||||
or for the establishment, exercise or defence of legal claims;
|
|
||||||
|
|
||||||
d) pursuant to Art. 18 GDPR,
|
|
||||||
to request the restriction of the processing of your personal data,
|
|
||||||
insofar as the accuracy of the data is disputed by you,
|
|
||||||
the processing is unlawful,
|
|
||||||
but you object to its erasure
|
|
||||||
and we no longer require the data,
|
|
||||||
but you need it for the assertion, exercise or defence of legal claims
|
|
||||||
or you have objected to the processing pursuant to Art. 21 GDPR;
|
|
||||||
|
|
||||||
e) pursuant to Art. 20 GDPR,
|
|
||||||
to receive your personal data that you have provided to us
|
|
||||||
in a structured, common and machine-readable format
|
|
||||||
or to request that it be transferred to another controller;
|
|
||||||
|
|
||||||
f) in accordance with Art. 7 (3) of the GDPR,
|
|
||||||
to revoke your consent given to us at any time.
|
|
||||||
This has the consequence that we may no longer continue the data processing
|
|
||||||
based on this consent in the future; and
|
|
||||||
|
|
||||||
g) complain to a supervisory authority
|
|
||||||
in accordance with Article 77 of the GDPR.
|
|
||||||
As a rule,
|
|
||||||
you can contact the supervisory authority of your usual place of residence
|
|
||||||
or workplace
|
|
||||||
or our registered office for this purpose.
|
|
||||||
The supervisory authority responsible for our place of business
|
|
||||||
is the `{{ config.privacy_supervisor }}`.
|
|
||||||
|
|
||||||
If you have any questions or complaints, please feel free to contact us by email:
|
|
||||||
{{ config.privacy_mail }}
|
|
||||||
|
|
||||||
|
|
||||||
### 5.1 Right to object
|
|
||||||
|
|
||||||
If your personal data is processed on the basis of our legitimate interests
|
|
||||||
in accordance with Art. 6 (1) lit. f GDPR,
|
|
||||||
you have the right to object to the processing of your personal data
|
|
||||||
in accordance with Art. 21 GDPR,
|
|
||||||
provided that there are grounds for this based on your particular situation
|
|
||||||
or the objection is directed against direct advertising.
|
|
||||||
In the latter case,
|
|
||||||
you have a general right of objection,
|
|
||||||
which will be implemented by us
|
|
||||||
without specifying a particular situation.
|
|
||||||
|
|
||||||
If you wish to exercise your right of objection,
|
|
||||||
simply send an e-mail to: {{ config.privacy_mail }}
|
|
||||||
|
|
||||||
### 5.2 Right to withdraw
|
|
||||||
|
|
||||||
If your personal data is processed on the basis of your consent
|
|
||||||
in accordance with Art. 6 (1) lit. a GDPR
|
|
||||||
(e.g. via the mailing list),
|
|
||||||
you can withdraw your consent at any time
|
|
||||||
and without any disadvantages.
|
|
||||||
As a result,
|
|
||||||
we may no longer continue the data processing
|
|
||||||
that was based on this consent for the future.
|
|
||||||
However,
|
|
||||||
the withdrawal of your consent
|
|
||||||
does not affect the lawfulness of the processing
|
|
||||||
carried out on the basis of the consent until the withdrawal.
|
|
||||||
|
|
||||||
If you wish to make use of your right of withdrawal,
|
|
||||||
simply send an e-mail to: {{ config.privacy_mail }}
|
|
||||||
|
|
||||||
## 6. Validity of this privacy policy
|
|
||||||
|
|
||||||
This data protection declaration is valid
|
|
||||||
as of *December 2023*.
|
|
||||||
Due to the further development of our service and offers
|
|
||||||
or due to changed legal or official requirements,
|
|
||||||
it may become necessary to revise this data protection declaration from time to time.
|
|
||||||
|
|
||||||
|
|
||||||
1690
www/src/water.css
1690
www/src/water.css
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user