diff options
Diffstat (limited to 'src/mailman_pgp/archivers')
| -rw-r--r-- | src/mailman_pgp/archivers/local.py | 32 | ||||
| -rw-r--r-- | src/mailman_pgp/archivers/local_maildir.py | 72 | ||||
| -rw-r--r-- | src/mailman_pgp/archivers/local_mbox.py | 72 | ||||
| -rw-r--r-- | src/mailman_pgp/archivers/tests/__init__.py | 0 | ||||
| -rw-r--r-- | src/mailman_pgp/archivers/tests/test_maildir.py | 82 | ||||
| -rw-r--r-- | src/mailman_pgp/archivers/tests/test_mbox.py | 82 |
6 files changed, 308 insertions, 32 deletions
diff --git a/src/mailman_pgp/archivers/local.py b/src/mailman_pgp/archivers/local.py deleted file mode 100644 index 04d9a22..0000000 --- a/src/mailman_pgp/archivers/local.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright (C) 2017 Jan Jancar -# -# This file is a part of the Mailman PGP plugin. -# -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free -# Software Foundation, either version 3 of the License, or (at your option) -# any later version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for -# more details. -# -# You should have received a copy of the GNU General Public License along with -# this program. If not, see <http://www.gnu.org/licenses/>. - -""" -Archives messages locally, encrypted (TBD how), -similar to Mailman's prototype archiver. -""" - -from mailman.interfaces.archiver import IArchiver -from public import public -from zope.interface import implementer - - -@public -@implementer(IArchiver) -class LocalArchiver: - """Local PGP enabled archiver.""" - pass diff --git a/src/mailman_pgp/archivers/local_maildir.py b/src/mailman_pgp/archivers/local_maildir.py new file mode 100644 index 0000000..4b7e75d --- /dev/null +++ b/src/mailman_pgp/archivers/local_maildir.py @@ -0,0 +1,72 @@ +# Copyright (C) 2017 Jan Jancar +# +# This file is a part of the Mailman PGP plugin. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# this program. If not, see <http://www.gnu.org/licenses/>. + +""" +Archives messages to a maildir, locally, encrypted (TBD how), +similar to Mailman's prototype archiver. +""" +import os +from mailbox import Maildir + +from flufl.lock import Lock +from mailman.interfaces.archiver import IArchiver +from public import public +from zope.interface import implementer + +from mailman_pgp.config import config, mm_config +from mailman_pgp.model.list import PGPMailingList +from mailman_pgp.pgp.mime import MIMEWrapper + + +@public +@implementer(IArchiver) +class LocalMaildirArchiver: + """Local PGP enabled archiver.""" + + name = 'pgp-maildir-local' + is_enabled = False + + @staticmethod + def list_url(mlist): + """See `IArchiver`.""" + return None + + @staticmethod + def permalink(mlist, msg): + """See `IArchiver`.""" + return None + + @staticmethod + def archive_message(mlist, msg): + """See `IArchiver`.""" + pgp_list = PGPMailingList.for_list(mlist) + if not pgp_list: + return None + maildir_dir = config.get_value('archiving', 'maildir_dir') + maildir_dir.mkdir(parents=True, exist_ok=True) + + list_dir = maildir_dir.joinpath(mlist.fqdn_listname) + maildir = Maildir(str(list_dir)) + lock_file = os.path.join(mm_config.LOCK_DIR, + '{}-{}.lock'.format(mlist.fqdn_listname, + LocalMaildirArchiver.name) + ) + wrapped = MIMEWrapper(msg) + encrypted = wrapped.encrypt(pgp_list.pubkey) + with Lock(lock_file): + maildir.add(encrypted) + return None diff --git a/src/mailman_pgp/archivers/local_mbox.py b/src/mailman_pgp/archivers/local_mbox.py new file mode 100644 index 0000000..99264c2 --- /dev/null +++ b/src/mailman_pgp/archivers/local_mbox.py @@ -0,0 +1,72 @@ +# Copyright (C) 2017 Jan Jancar +# +# This file is a part of the Mailman PGP plugin. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# this program. If not, see <http://www.gnu.org/licenses/>. + +""" +Archives messages to a mbox, locally, encrypted (TBD how), +similar to Mailman's prototype archiver. +""" +import os +from mailbox import mbox + +from flufl.lock import Lock +from mailman.interfaces.archiver import IArchiver +from public import public +from zope.interface import implementer + +from mailman_pgp.config import config, mm_config +from mailman_pgp.model.list import PGPMailingList +from mailman_pgp.pgp.mime import MIMEWrapper + + +@public +@implementer(IArchiver) +class LocalMailboxArchiver: + """Local PGP enabled archiver.""" + + name = 'pgp-mbox-local' + is_enabled = False + + @staticmethod + def list_url(mlist): + """See `IArchiver`.""" + return None + + @staticmethod + def permalink(mlist, msg): + """See `IArchiver`.""" + return None + + @staticmethod + def archive_message(mlist, msg): + """See `IArchiver`.""" + pgp_list = PGPMailingList.for_list(mlist) + if not pgp_list: + return None + mailbox_dir = config.get_value('archiving', 'mailbox_dir') + mailbox_dir.mkdir(parents=True, exist_ok=True) + + list_dir = mailbox_dir.joinpath(mlist.fqdn_listname) + mailbox = mbox(str(list_dir)) + lock_file = os.path.join(mm_config.LOCK_DIR, + '{}-{}.lock'.format(mlist.fqdn_listname, + LocalMailboxArchiver.name) + ) + wrapped = MIMEWrapper(msg) + encrypted = wrapped.encrypt(pgp_list.pubkey) + with Lock(lock_file): + mailbox.add(encrypted) + return None diff --git a/src/mailman_pgp/archivers/tests/__init__.py b/src/mailman_pgp/archivers/tests/__init__.py new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/src/mailman_pgp/archivers/tests/__init__.py diff --git a/src/mailman_pgp/archivers/tests/test_maildir.py b/src/mailman_pgp/archivers/tests/test_maildir.py new file mode 100644 index 0000000..bc810a7 --- /dev/null +++ b/src/mailman_pgp/archivers/tests/test_maildir.py @@ -0,0 +1,82 @@ +# Copyright (C) 2017 Jan Jancar +# +# This file is a part of the Mailman PGP plugin. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# this program. If not, see <http://www.gnu.org/licenses/>. + +"""""" +import os +import unittest +from mailbox import Maildir +from tempfile import TemporaryDirectory + +from mailman.app.lifecycle import create_list +from mailman.testing.helpers import specialized_message_from_string as mfs + +from mailman_pgp.archivers.local_maildir import LocalMaildirArchiver +from mailman_pgp.config import config +from mailman_pgp.database import mm_transaction +from mailman_pgp.model.list import PGPMailingList +from mailman_pgp.pgp.mime import MIMEWrapper +from mailman_pgp.testing.layers import PGPConfigLayer +from mailman_pgp.testing.pgp import load_key + + +class TestPGPMaildirArchiver(unittest.TestCase): + layer = PGPConfigLayer + + def setUp(self): + self.msg = mfs("""\ +To: test@example.com +From: anne@example.com +Subject: Testing the test list +Message-ID: <ant> +Message-ID-Hash: MS6QLWERIJLGCRF44J7USBFDELMNT2BW + +Tests are better than no tests +but the water deserves to be swum. +""") + with mm_transaction(): + self.mlist = create_list('test@example.com', + style_name='pgp-default') + self.pgp_list = PGPMailingList.for_list(self.mlist) + self.list_key = load_key('ecc_p256.priv.asc') + self.pgp_list.key = self.list_key + + def test_no_links(self): + self.assertIsNone(LocalMaildirArchiver.list_url(self.mlist)) + self.assertIsNone(LocalMaildirArchiver.permalink(self.mlist, self.msg)) + + def test_no_pgp_list(self): + with mm_transaction(): + ordinary = create_list('ordinary@example.com') + + LocalMaildirArchiver.archive_message(ordinary, self.msg) + + def test_archives(self): + with TemporaryDirectory() as maildir_dir: + config.set('archiving', 'maildir_dir', maildir_dir) + LocalMaildirArchiver.archive_message(self.mlist, self.msg) + + list_dir = os.path.join(maildir_dir, self.mlist.fqdn_listname) + + maildir = Maildir(list_dir) + messages = maildir.values() + self.assertEqual(len(messages), 1) + + message = messages[0] + wrapped = MIMEWrapper(message) + self.assertTrue(wrapped.is_encrypted()) + decrypted = wrapped.decrypt(self.list_key) + self.assertTrue(self.msg.as_string(), decrypted.as_string()) diff --git a/src/mailman_pgp/archivers/tests/test_mbox.py b/src/mailman_pgp/archivers/tests/test_mbox.py new file mode 100644 index 0000000..fde0e50 --- /dev/null +++ b/src/mailman_pgp/archivers/tests/test_mbox.py @@ -0,0 +1,82 @@ +# Copyright (C) 2017 Jan Jancar +# +# This file is a part of the Mailman PGP plugin. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# this program. If not, see <http://www.gnu.org/licenses/>. + +"""""" +import os +import unittest +from mailbox import mbox +from tempfile import TemporaryDirectory + +from mailman.app.lifecycle import create_list +from mailman.testing.helpers import specialized_message_from_string as mfs + +from mailman_pgp.archivers.local_mbox import LocalMailboxArchiver +from mailman_pgp.config import config +from mailman_pgp.database import mm_transaction +from mailman_pgp.model.list import PGPMailingList +from mailman_pgp.pgp.mime import MIMEWrapper +from mailman_pgp.testing.layers import PGPConfigLayer +from mailman_pgp.testing.pgp import load_key + + +class TestPGPMboxArchiver(unittest.TestCase): + layer = PGPConfigLayer + + def setUp(self): + self.msg = mfs("""\ +To: test@example.com +From: anne@example.com +Subject: Testing the test list +Message-ID: <ant> +Message-ID-Hash: MS6QLWERIJLGCRF44J7USBFDELMNT2BW + +Tests are better than no tests +but the water deserves to be swum. +""") + with mm_transaction(): + self.mlist = create_list('test@example.com', + style_name='pgp-default') + self.pgp_list = PGPMailingList.for_list(self.mlist) + self.list_key = load_key('ecc_p256.priv.asc') + self.pgp_list.key = self.list_key + + def test_no_links(self): + self.assertIsNone(LocalMailboxArchiver.list_url(self.mlist)) + self.assertIsNone(LocalMailboxArchiver.permalink(self.mlist, self.msg)) + + def test_no_pgp_list(self): + with mm_transaction(): + ordinary = create_list('ordinary@example.com') + + LocalMailboxArchiver.archive_message(ordinary, self.msg) + + def test_archives(self): + with TemporaryDirectory() as mailbox_dir: + config.set('archiving', 'mailbox_dir', mailbox_dir) + LocalMailboxArchiver.archive_message(self.mlist, self.msg) + + list_dir = os.path.join(mailbox_dir, self.mlist.fqdn_listname) + + mailbox = mbox(list_dir) + messages = mailbox.values() + self.assertEqual(len(messages), 1) + + message = messages[0] + wrapped = MIMEWrapper(message) + self.assertTrue(wrapped.is_encrypted()) + decrypted = wrapped.decrypt(self.list_key) + self.assertTrue(self.msg.as_string(), decrypted.as_string()) |