summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJ08nY2017-05-30 00:51:32 +0200
committerJ08nY2017-05-30 00:51:32 +0200
commit1ff38b354bdcf8f6e83ddbf9cef7b6374d8b9afe (patch)
tree4af7cadcf59217e3b0021fa3442e32c538fcf062
parentd0891175a2cf636a98acaac2f8ae6e9d81f6d0df (diff)
downloadpgpmailman-proposal-1ff38b354bdcf8f6e83ddbf9cef7b6374d8b9afe.tar.gz
pgpmailman-proposal-1ff38b354bdcf8f6e83ddbf9cef7b6374d8b9afe.tar.bz2
pgpmailman-proposal-1ff38b354bdcf8f6e83ddbf9cef7b6374d8b9afe.zip
plugin: REST routes and database
-rw-r--r--plugin.md18
1 files changed, 17 insertions, 1 deletions
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/<list-id>/key` - For getting the list-key.
+ - `/list/<list-id>/settings` - For seting per-list configuration options: bounce/discard non-signed, bounce/discard non-encrypted.
+ - `/user/<user-id>/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/<list-id>/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