summaryrefslogtreecommitdiff
path: root/plugin.md
blob: 7bdb9dba4d68aaf201c4452337787d8aed6333b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# PGPMailman plugin

## Structure

  * `pgpmailman` - A Core plugin.
     - `styles` - Both styles generate a list keypair based on plugin settings on list creation as well as set other attributes for an encrypted mailing list.
        - `EncryptedDefaultStyle`
        - `EncryptedAnnounceStyle`

     - `pgp` - Module that handles lower-level pgp related stuff. Such as the GPG keyrings, lookup of keys, encryption of messages, decryption, etc...

     - `commands`
        - `KeyEmailCommand` - Handles user key management through the `key` command.
        - `KeyCLICommand`

     - `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...

     - `archivers`
        - `EncryptedHyperKittyArchiver` - Fetches list archive public keys from `pgphyperkitty`, uses them to send messages to archive encrypted, for encrypted lists.

     - `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.


## Instalation

 * A setuptools package that needs to be installed into the same virtualenv as the Mailman 3 instance.

## Configuration

 * Custom runners, archivers and other site configuration options would need to be set.