From 1ff38b354bdcf8f6e83ddbf9cef7b6374d8b9afe Mon Sep 17 00:00:00 2001 From: J08nY Date: Tue, 30 May 2017 00:51:32 +0200 Subject: plugin: REST routes and database --- plugin.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'plugin.md') diff --git a/plugin.md b/plugin.md index a2447b1..fae6199 100644 --- a/plugin.md +++ b/plugin.md @@ -13,6 +13,13 @@ - `KeyEmailCommand` - Handles user key management through the `key` command. - `KeyCLICommand` + - `database` - Plugin needs to store the user/address <-> user-key fingerprint mapping somehow, attached to Mailman's userobject would be the best but otherwise a custom data storage needs to be setup. + + - `rest` - Module that exposes plugin-specific REST api, which will be used by the `django-pgpmailman` app. With `/plugins/pgpmailman/` root. + - `/list//key` - For getting the list-key. + - `/list//settings` - For seting per-list configuration options: bounce/discard non-signed, bounce/discard non-encrypted. + - `/user//key` - For getting, setting and revoking the user-key. + - `runners` - `EncryptedIncomingRunner` - Decrypts incoming messages for encrypted mailing lists and checks their signatures before passing them to the default IncomingRunner. Messages to ordinary lists are passed to the default IncomingRunner wthout change. - `EncryptedOutgoingRunner` - Encrypts and optionally signs for configured lists. This is a runner and not a Pipeline since we need to encrypt all outgoing messages, so digests, virgin messages, posts... @@ -23,7 +30,12 @@ - `initialize()` - A callable to be setup in a Mailman hook, to setup everything necessary for pgpmailman to run. Such as adding the `listname-key`@ subaddress, creating keyrings if not found, subscribing to events if necessary. + - `tearDown()` - A callable to be setup in a Mailman exit hook. + * `django-pgpmailman` - A Django app that extends Postorius and HyperKitty, also with an associated example_project that combines Postorius, HyperKitty while extending their templates and views seamlessly. + - `api` + - `/list//key` - For getting the list-archive public key. + - `templates` - Will have custom templates as well as templates overwriting and extending certain Postorius and HyperKitty templates. ## Instalation @@ -43,4 +55,8 @@ Custom runners, archivers and other site configuration options would need to be ### Django app -As any of Mailman's Django apps, will be packaged with an example_project with default configuration. \ No newline at end of file +As any of Mailman's Django apps, will be packaged with an example_project with default configuration. + +## Documentation + +In order for site admins and users to use encrypted mailing lists responsibly, quite some amount of documentation is required, since misusing encrypted lists will make them uneffective. \ No newline at end of file -- cgit v1.2.3-70-g09d2