Upgrade dependencies

fixes #4

Reviewed-on: #5

Makefile

@@ -32,7 +32,7 @@ requirements.txt: Pipfile.lock
 	pipenv requirements > requirements.txt
 
 format:
-	black mail4one/*py
+	black mail4one/*py tests/*py
 
 build-dev: requirements.txt build
 

Pipfile.lock

@@ -18,20 +18,20 @@
     "default": {
         "aiosmtpd": {
             "hashes": [
-                "sha256:f821fe424b703b2ea391dc2df11d89d2afd728af27393e13cf1a3530f19fdc5e",
+                "sha256:78d7b14f859ad0e6de252b47f9cf1ca6f1c82a8b0f10a9e39bec7e915a6aa5fe",
-                "sha256:f9243b7dfe00aaf567da8728d891752426b51392174a34d2cf5c18053b63dcbc"
+                "sha256:a196922f1903e54c4d37c53415b7613056d39e2b1e8249f324b9ee7a439be0f1"
             ],
             "index": "pypi",
-            "markers": "python_version ~= '3.7'",
+            "markers": "python_version >= '3.8'",
-            "version": "==1.4.4.post2"
+            "version": "==1.4.5"
         },
         "atpublic": {
             "hashes": [
-                "sha256:0f40433219e124edf115c6c363808ca6f0e1cfa7d160d86b2fb94793086d1294",
+                "sha256:d1c8cd931af7461f6d18bc6063383e8654d9e9ef19d58ee6dc01e8515bbf55df",
-                "sha256:80057c55641253b86dcb68b524f82328172371b6547d4c7462a9127fbfbbabfc"
+                "sha256:df90de1162b1a941ee486f484691dc7c33123ee638ea5d6ca604061306e0fdde"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==4.0"
+            "version": "==4.1.0"
         },
         "attrs": {
             "hashes": [

deploy_configs/README.md

@@ -81,15 +81,16 @@ systemctl status mail4one
 Above command should fail as the TLS certificates don't exist yet.
 
 ## Setup TLS certificates 
-Install [certbot](https://certbot.eff.org/) and run below command. Follow instructions to create TLS certificates. Usually you want certificate for domain name like `mail.example.com`
+Install [certbot](https://certbot.eff.org/) and run below command. Follow instructions to create TLS certificates. Usually you want certificate for domain name like `mail.mydomain.com`
 ```sh
 sudo certbot certonly
-sudo cp /etc/letsencrypt/live/mail.example.com/{fullchain,privkey}.pem  /var/lib/mail4one/certs/
-sudo chown mail4one:mail4one /var/lib/mail4one/certs/{fullchain,privkey}.pem
 
-# Edit mail4one_cert_copy.sh to update your domain name
+# **Edit** mail4one_cert_copy.sh to update your domain name
 sudo cp mail4one_cert_copy.sh /etc/letsencrypt/renewal-hooks/deploy/
 sudo chmod +x /etc/letsencrypt/renewal-hooks/deploy/mail4one_cert_copy.sh
+
+# This will create and copy the certificates to the right path with correct permissions and ownership
+sudo certbot certonly -d mail.mydomain.com --run-deploy-hooks --dry-run
 ```
 ## Restart service and check logs
 ```sh
@@ -109,6 +110,6 @@ python3 -m http.server 25
 In local machine or a browser
 You should see file listing a, b, c. Repeat for port 465, 995 to make sure firewall rules and dns is working
 ```sh
-curl http://mail.example.com:25
+curl http://mail.mydomain.com:25
 ```
 If not working, refer to VPS settings and OS firewall settings.

deploy_configs/mail4one_cert_copy.sh

@@ -7,13 +7,21 @@
 #  This file is supposed to be copied to /etc/letsencrypt/renewal-hooks/deploy/
 #  Change the mail domain to the one on MX record
 
+set -eu
+
 if [ "$RENEWED_DOMAINS" = "mail.mydomain.com" ]
 then
-		mkdir -p /var/lib/mail4one/certs
+	app=mail4one
-		chmod 750 /var/lib/mail4one/certs
+	appuser=$app
-		chown mail4one:mail4one /var/lib/mail4one/certs
+	certpath="/var/lib/$app/certs"
-		cp "$RENEWED_LINEAGE/fullchain.pem" /var/lib/mail4one/certs/
+
-		cp "$RENEWED_LINEAGE/privkey.pem" /var/lib/mail4one/certs/
+	mkdir -p "$certpath"
-		systemctl restart mail4one.service
+	chmod 750 "$certpath"
-		echo "$(date) Renewed and deployed certificates for mail4one" >> /var/log/mail4one-cert-renew.log
+
+	chown $appuser:$appuser "$certpath"
+	install -o "$appuser" -g "$appuser" -m 444 "$RENEWED_LINEAGE/fullchain.pem" -t "$certpath"
+	install -o "$appuser" -g "$appuser" -m 400 "$RENEWED_LINEAGE/privkey.pem" -t "$certpath"
+
+	systemctl restart $app.service
+	echo "$(date) Renewed and deployed certificates for $app" >> /var/log/cert-renew.log
 fi

mail4one/pop3.py

@@ -29,7 +29,7 @@ from .poputils import (
     end,
     Request,
     MailEntry,
-    get_mail,
+    get_mail_fp,
     get_mails_list,
     MailList,
 )
@@ -217,7 +217,12 @@ def trans_command_retr(mails: MailList, req: Request) -> None:
     entry = mails.get(req.arg1)
     if entry:
         write(ok("Contents follow"))
-        write(get_mail(entry))
+        with get_mail_fp(entry) as fp:
+            for line in fp:
+                if line.startswith(b"."):
+                    write(b".")  # prepend dot
+                write(line)
+        # write(get_mail(entry)) # no prepend dot
         write(end())
         mails.delete(req.arg1)
     else:
@@ -386,13 +391,14 @@ def debug_main():
     logging.basicConfig(level=logging.DEBUG)
 
     import sys
+    from .pwhash import gen_pwhash
 
-    _, mails_path, port, password = sys.argv
+    _, mails_path, mbox = sys.argv
 
     mails_path = Path(mails_path)
-    port = int(port)
+    users = [User(username="dummy", password_hash=gen_pwhash("dummy"), mbox=mbox)]
 
-    asyncio.run(a_main(mails_path, port, password_hash=password_hash))
+    asyncio.run(a_main("127.0.0.1", 1101, mails_path, users=users))
 
 
 if __name__ == "__main__":

mail4one/poputils.py

@@ -2,6 +2,7 @@ import os
 from dataclasses import dataclass
 from enum import Enum, auto
 from pathlib import Path
+from contextlib import contextmanager
 
 
 class ClientError(Exception):
@@ -124,6 +125,12 @@ def set_nid(entries: list[MailEntry]):
         entry.nid = i
 
 
+@contextmanager
+def get_mail_fp(entry: MailEntry):
+    with open(entry.path, mode="rb") as fp:
+        yield fp
+
+
 def get_mail(entry: MailEntry) -> bytes:
     with open(entry.path, mode="rb") as fp:
         return fp.read()

requirements.txt

@@ -1,5 +1,5 @@
 -i https://pypi.org/simple
-aiosmtpd==1.4.4.post2; python_version ~= '3.7'
+aiosmtpd==1.4.5; python_version >= '3.8'
-atpublic==4.0; python_version >= '3.8'
+atpublic==4.1.0; python_version >= '3.8'
 attrs==23.2.0; python_version >= '3.7'
 python-jata==1.2; python_version >= '3.8'

tests/test_config.py

@@ -67,10 +67,11 @@ class TestConfig(unittest.TestCase):
     def test_get_mboxes(self) -> None:
         cfg = config.Config(TEST_CONFIG)
         rules = config.parse_checkers(cfg)
-        self.assertEqual(config.get_mboxes("foo@bar.com", rules), ['spam'])
+        self.assertEqual(config.get_mboxes("foo@bar.com", rules), ["spam"])
-        self.assertEqual(config.get_mboxes("foo@mydomain.com", rules), ['all'])
+        self.assertEqual(config.get_mboxes("foo@mydomain.com", rules), ["all"])
-        self.assertEqual(config.get_mboxes("first.last@mydomain.com", rules),
+        self.assertEqual(
-                         ['important', 'all'])
+            config.get_mboxes("first.last@mydomain.com", rules), ["important", "all"]
+        )
 
 
 if __name__ == "__main__":

tests/test_pop.py

@@ -4,20 +4,29 @@ import logging
 import tempfile
 import time
 import os
+import poplib
 from mail4one.pop3 import create_pop_server
 from mail4one.config import User
 from pathlib import Path
 
-TEST_HASH = "".join(c for c in """
+TEST_HASH = "".join(
+    """
 AFTY5EVN7AX47ZL7UMH3BETYWFBTAV3XHR73CEFAJBPN2NIHPWD
 ZHV2UQSMSPHSQQ2A2BFQBNC77VL7F2UKATQNJZGYLCSU6C43UQD
 AQXWXSWNGAEPGIMG2F3QDKBXL3MRHY6K2BPID64ZR6LABLPVSF
-""" if not c.isspace())
+""".split()
+)
 
-TEST_USER = 'foobar'
+TEST_USER = "foobar"
-TEST_MBOX = 'foobar_mails'
+TEST_MBOX = "foobar_mails"
 
-USERS = [User(username=TEST_USER, password_hash=TEST_HASH, mbox=TEST_MBOX)]
+TEST_USER2 = "foo2"
+TEST_MBOX2 = "foo2mails"
+
+USERS = [
+    User(username=TEST_USER, password_hash=TEST_HASH, mbox=TEST_MBOX),
+    User(username=TEST_USER2, password_hash=TEST_HASH, mbox=TEST_MBOX2),
+]
 
 MAILS_PATH: Path
 
@@ -38,7 +47,8 @@ Hello bro\r
 IlzVOJqu9Zp7twFAtzcV\r
 yQVk36B0mGU2gtWxXLr\r
 PeF0RtbI0mAuVPLQDHCi\r
-\r\n"""
+\r
+"""
 
 
 def setUpModule() -> None:
@@ -47,13 +57,21 @@ def setUpModule() -> None:
     td = tempfile.TemporaryDirectory(prefix="m41.pop.")
     unittest.addModuleCleanup(td.cleanup)
     MAILS_PATH = Path(td.name)
-    os.mkdir(MAILS_PATH / TEST_MBOX)
+    for mbox in (TEST_MBOX, TEST_MBOX2):
-    for md in ('new', 'cur', 'tmp'):
+        os.mkdir(MAILS_PATH / mbox)
-        os.mkdir(MAILS_PATH / TEST_MBOX / md)
+        for md in ("new", "cur", "tmp"):
-    with open(MAILS_PATH / TEST_MBOX/ 'new/msg1.eml', 'wb') as f:
+            os.mkdir(MAILS_PATH / mbox / md)
+    with open(MAILS_PATH / TEST_MBOX / "new/msg1.eml", "wb") as f:
         f.write(TESTMAIL)
-    with open(MAILS_PATH / TEST_MBOX/ 'new/msg2.eml', 'wb') as f:
+    with open(MAILS_PATH / TEST_MBOX / "new/msg2.eml", "wb") as f:
         f.write(TESTMAIL)
+    with open(MAILS_PATH / TEST_MBOX2 / "new/msg1.eml", "wb") as f:
+        f.write(TESTMAIL)
+        f.write(b"More lines to follow\r\n")
+        f.write(b".Line starts with a dot\r\n")
+        f.write(b"some more lines\r\n")
+        f.write(b".\r\n")
+        f.write(b"Previous line just has a dot\r\n")
     logging.debug(MAILS_PATH)
 
 
@@ -65,13 +83,11 @@ class TestPop3(unittest.IsolatedAsyncioTestCase):
 
     async def asyncSetUp(self) -> None:
         logging.debug("at asyncSetUp")
-        pop_server = await create_pop_server(host='127.0.0.1',
+        pop_server = await create_pop_server(
-                                             port=7995,
+            host="127.0.0.1", port=7995, mails_path=MAILS_PATH, users=USERS
-                                             mails_path=MAILS_PATH,
+        )
-                                             users=USERS)
         self.task = asyncio.create_task(pop_server.serve_forever())
-        self.reader, self.writer = await asyncio.open_connection(
+        self.reader, self.writer = await asyncio.open_connection("127.0.0.1", 7995)
-            '127.0.0.1', 7995)
 
     async def test_QUIT(self) -> None:
         dialog = """
@@ -115,8 +131,8 @@ class TestPop3(unittest.IsolatedAsyncioTestCase):
         await self.dialog_checker(dialog)
 
     async def test_dupe_AUTH(self) -> None:
-        r1, w1 = await asyncio.open_connection('127.0.0.1', 7995)
+        r1, w1 = await asyncio.open_connection("127.0.0.1", 7995)
-        r2, w2 = await asyncio.open_connection('127.0.0.1', 7995)
+        r2, w2 = await asyncio.open_connection("127.0.0.1", 7995)
         dialog = """
         S: +OK Server Ready
         C: USER foobar
@@ -197,6 +213,22 @@ class TestPop3(unittest.IsolatedAsyncioTestCase):
         """
         await self.dialog_checker(dialog)
 
+    async def test_poplib(self) -> None:
+        def run_poplib():
+            pc = poplib.POP3("127.0.0.1", 7995)
+            try:
+                self.assertEqual(b"+OK Server Ready", pc.getwelcome())
+                self.assertEqual(b"+OK Welcome", pc.user("foo2"))
+                self.assertEqual(b"+OK Login successful", pc.pass_("helloworld"))
+                _, eml, oc = pc.retr(1)
+                self.assertIn(b"Previous line just has a dot", eml)
+                self.assertIn(b".Line starts with a dot", eml)
+                self.assertIn(b".", eml)
+            finally:
+                pc.quit()
+
+        await asyncio.to_thread(run_poplib)
+
     async def asyncTearDown(self) -> None:
         logging.debug("at teardown")
         self.writer.close()
@@ -206,9 +238,9 @@ class TestPop3(unittest.IsolatedAsyncioTestCase):
     async def dialog_checker(self, dialog: str) -> None:
         await self.dialog_checker_impl(self.reader, self.writer, dialog)
 
-    async def dialog_checker_impl(self, reader: asyncio.StreamReader,
+    async def dialog_checker_impl(
-                                  writer: asyncio.StreamWriter,
+        self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter, dialog: str
-                                  dialog: str) -> None:
+    ) -> None:
         for line in dialog.splitlines():
             line = line.strip()
             if not line:
@@ -222,5 +254,5 @@ class TestPop3(unittest.IsolatedAsyncioTestCase):
                 self.assertEqual(data, resp)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()

tests/test_pwhash.py

@@ -10,27 +10,31 @@ class TestPWHash(unittest.TestCase):
         pwinfo = parse_hash(pwhash)
         self.assertEqual(len(pwinfo.salt), SALT_LEN)
         self.assertEqual(len(pwinfo.scrypt_hash), KEY_LEN)
-        self.assertTrue(check_pass(password, pwinfo),
+        self.assertTrue(
-                        "check pass with correct password")
+            check_pass(password, pwinfo), "check pass with correct password"
-        self.assertFalse(check_pass("foobar", pwinfo),
+        )
-                         "check pass with wrong password")
+        self.assertFalse(check_pass("foobar", pwinfo), "check pass with wrong password")
 
     def test_hardcoded_hash(self):
-        test_hash = "".join(c for c in """
+        test_hash = "".join(
+            c
+            for c in """
         AFTY5EVN7AX47ZL7UMH3BETYWFBTAV3XHR73CEFAJBPN2NIHPWD
         ZHV2UQSMSPHSQQ2A2BFQBNC77VL7F2UKATQNJZGYLCSU6C43UQD
         AQXWXSWNGAEPGIMG2F3QDKBXL3MRHY6K2BPID64ZR6LABLPVSF
-        """ if not c.isspace())
+        """
+            if not c.isspace()
+        )
         pwinfo = parse_hash(test_hash)
-        self.assertTrue(check_pass("helloworld", pwinfo),
+        self.assertTrue(
-                        "check pass with correct password")
+            check_pass("helloworld", pwinfo), "check pass with correct password"
-        self.assertFalse(check_pass("foobar", pwinfo),
+        )
-                         "check pass with wrong password")
+        self.assertFalse(check_pass("foobar", pwinfo), "check pass with wrong password")
 
     def test_invalid_hash(self):
         with self.assertRaises(Exception):
             parse_hash("sdlfkjdsklfjdsk")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()

tests/test_smtp.py

@@ -10,7 +10,7 @@ from pathlib import Path
 
 from mail4one.smtp import create_smtp_server
 
-TEST_MBOX = 'foobar_mails'
+TEST_MBOX = "foobar_mails"
 MAILS_PATH: Path
 
 
@@ -21,7 +21,7 @@ def setUpModule() -> None:
     unittest.addModuleCleanup(td.cleanup)
     MAILS_PATH = Path(td.name)
     os.mkdir(MAILS_PATH / TEST_MBOX)
-    for md in ('new', 'cur', 'tmp'):
+    for md in ("new", "cur", "tmp"):
         os.mkdir(MAILS_PATH / TEST_MBOX / md)
 
 
@@ -32,7 +32,8 @@ class TestSMTP(unittest.IsolatedAsyncioTestCase):
             host="127.0.0.1",
             port=7996,
             mails_path=MAILS_PATH,
-            mbox_finder=lambda addr: [TEST_MBOX])
+            mbox_finder=lambda addr: [TEST_MBOX],
+        )
         self.task = asyncio.create_task(smtp_server.serve_forever())
 
     async def test_send_mail(self) -> None:
@@ -45,8 +46,9 @@ class TestSMTP(unittest.IsolatedAsyncioTestCase):
         msg = b"".join(l.strip() + b"\r\n" for l in msg.splitlines())
 
         def send_mail():
-            with contextlib.closing(smtplib.SMTP(host="127.0.0.1",
+            with contextlib.closing(
-                                                 port=7996)) as client:
+                smtplib.SMTP(host="127.0.0.1", port=7996)
+            ) as client:
                 client.sendmail("foo@sender.com", "foo@bar.com", msg)
                 _, local_port = client.sock.getsockname()
                 return local_port
@@ -62,7 +64,7 @@ class TestSMTP(unittest.IsolatedAsyncioTestCase):
         Byee
         """
         expected = "".join(l.strip() + "\r\n" for l in expected.splitlines())
-        mails = list((MAILS_PATH / TEST_MBOX / 'new').glob("*"))
+        mails = list((MAILS_PATH / TEST_MBOX / "new").glob("*"))
         self.assertEqual(len(mails), 1)
         self.assertEqual(mails[0].read_bytes(), expected.encode())