diff options
| -rw-r--r-- | plugin.md | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -11,14 +11,18 @@ - `commands` - `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. + - `config` - For plugin specific configuration and parsing. + + - `database` - Plugin needs to store the user/address <-> user-key fingerprint mapping somehow, attached to Mailman's user object would be the best but otherwise a custom data storage needs to be setup. + + - `model` + - `EncryptedMailingList` - `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. + - `/lists/<list-id>` - For seting per-list configuration options: bounce/discard non-signed, bounce/discard non-encrypted. + - `/lists/<list-id>/key` - For getting the list-key. + - `/users/<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. @@ -28,9 +32,8 @@ - `EncryptedHyperKittyArchiver` - Fetches list archive public keys from `django-pgpmailman`, uses them to send messages to archive encrypted, for encrypted lists. - `EncryptedLocalArchiver` - Stores messages encrypted with list-key in maildir format. - - `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. - - - `tear_down()` - A callable to be setup in a Mailman exit hook. + - `plugin` + - `PGPMailman` - Main plugin class, has `pre_hook`, `post_hook` and `rest_object` methods necessary for the IPlugin interface it implements. * `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` |