paul@11 | 1 | Introduction
|
paul@11 | 2 | ------------
|
paul@11 | 3 |
|
paul@11 | 4 | MoinMessage provides a library for creating, signing, encrypting, decrypting,
|
paul@12 | 5 | and verifying PGP/GPG content in Python along with mechanisms for updating
|
paul@51 | 6 | MoinMoin wiki instances with such content such that contributors can be
|
paul@11 | 7 | identified from their PGP signatures and such details used to authenticate
|
paul@63 | 8 | their contributions. It also permits PGP/GPG content to be stored in dedicated
|
paul@63 | 9 | message stores when received, enabling further processing of received content
|
paul@63 | 10 | and other means of perusal of such content.
|
paul@11 | 11 |
|
paul@11 | 12 | Configuring GPG for a Wiki
|
paul@11 | 13 | --------------------------
|
paul@11 | 14 |
|
paul@37 | 15 | Initialise a homedir for GPG and configure it using filesystem ACL (access
|
paul@37 | 16 | control list) properties:
|
paul@11 | 17 |
|
paul@12 | 18 | ./scripts/init_wiki_keyring.sh WIKI WEBUSER
|
paul@12 | 19 |
|
paul@51 | 20 | Here, WIKI should be replaced by the top-level wiki instance directory, and
|
paul@12 | 21 | WEBUSER should be the name of the user under which the Web server operates.
|
paul@12 | 22 |
|
paul@12 | 23 | Note that this script may need re-running after the homedir has been changed
|
paul@12 | 24 | by gpg operations as gpg likes to remove permissions from various files.
|
paul@11 | 25 |
|
paul@11 | 26 | To be in any way useful, signing keys must be made available within this
|
paul@11 | 27 | homedir so that incoming messages can have their senders verified.
|
paul@11 | 28 |
|
paul@11 | 29 | To see the keys available to you in your own environment:
|
paul@11 | 30 |
|
paul@11 | 31 | gpg --list-keys --with-fingerprint
|
paul@11 | 32 |
|
paul@51 | 33 | The full fingerprints are used when defining a user mapping in the wiki, and
|
paul@11 | 34 | the --with-fingerprint option is used to show them. Otherwise, only the last
|
paul@11 | 35 | eight characters of the fingerprints are shown.
|
paul@11 | 36 |
|
paul@11 | 37 | Export the public key used when signing messages from your own environment:
|
paul@11 | 38 |
|
paul@11 | 39 | gpg --armor --output 1C1AAF83.asc --export 1C1AAF83
|
paul@11 | 40 |
|
paul@51 | 41 | Import the key into the wiki's GPG homedir:
|
paul@11 | 42 |
|
paul@11 | 43 | gpg --homedir wiki/gnupg --import 1C1AAF83.asc
|
paul@11 | 44 |
|
paul@51 | 45 | For the wiki to receive encrypted data, a key for the wiki must be created:
|
paul@11 | 46 |
|
paul@11 | 47 | gpg --homedir wiki/gnupg --gen-key
|
paul@11 | 48 |
|
paul@51 | 49 | For the wiki environment to be able to use the key, password access must be
|
paul@12 | 50 | disabled. This can be done by either not specifying a password or by removing
|
paul@59 | 51 | it later using the --edit-key option:
|
paul@59 | 52 |
|
paul@59 | 53 | gpg --homedir wiki/gnupg --edit-key 0891463A
|
paul@59 | 54 | passwd
|
paul@12 | 55 |
|
paul@51 | 56 | Export the wiki's key for encrypting messages sent to the wiki:
|
paul@11 | 57 |
|
paul@11 | 58 | gpg --homedir wiki/gnupg --armor --output 0891463A.asc --export 0891463A
|
paul@11 | 59 |
|
paul@11 | 60 | This exported key can now be imported into your own environment:
|
paul@11 | 61 |
|
paul@11 | 62 | gpg --import 0891463A.asc
|
paul@11 | 63 |
|
paul@11 | 64 | Configuring the Wiki
|
paul@11 | 65 | --------------------
|
paul@11 | 66 |
|
paul@51 | 67 | In the wiki configuration, define the following settings:
|
paul@11 | 68 |
|
paul@11 | 69 | moinmessage_gpg_homedir
|
paul@11 | 70 | This sets the path to the homedir initialised above.
|
paul@11 | 71 |
|
paul@11 | 72 | moinmessage_gpg_users_page (optional, default is MoinMessageUserDict)
|
paul@11 | 73 | This provides a mapping from key fingerprints to Moin usernames.
|
paul@11 | 74 |
|
paul@12 | 75 | moinmessage_gpg_signing_users_page (optional, default is MoinMessageSigningUserDict)
|
paul@12 | 76 | This provides a mapping from Moin usernames to key fingerprints.
|
paul@12 | 77 |
|
paul@12 | 78 | moinmessage_gpg_recipients_page (optional, default is MoinMessageRecipientsDict)
|
paul@12 | 79 | This provides a mapping from recipients to remote URLs and key fingerprints.
|
paul@37 | 80 | Each user can define the named page as a subpage of their own home page.
|
paul@37 | 81 | If no such personal mapping exists, a common mapping exists relative to the
|
paul@37 | 82 | site root.
|
paul@12 | 83 |
|
paul@20 | 84 | moinmessage_reject_messages_without_dates (optional, default is True)
|
paul@51 | 85 | This causes messages sent to a wiki using the PostMessage action to be
|
paul@20 | 86 | rejected if date information is missing.
|
paul@20 | 87 |
|
paul@40 | 88 | moinmessage_static_files (optional, may refer to the built-in htdocs directory)
|
paul@40 | 89 | This explicitly defines the path to static resources used by Moin, enabling
|
paul@40 | 90 | such resources to be attached to messages. When set, the path must refer to
|
paul@40 | 91 | the htdocs directory (possibly renamed) containing the different theme
|
paul@40 | 92 | resource directories, together with the robots.txt and favicon.ico files.)
|
paul@40 | 93 |
|
paul@38 | 94 | For signature verification to function, the following needs to be added:
|
paul@38 | 95 |
|
paul@38 | 96 | from MoinMoin.auth.pgp import PGPAuth
|
paul@38 | 97 |
|
paul@38 | 98 | This should import an authentication handler installed when the MoinMessage
|
paul@38 | 99 | software is installed as an extension package.
|
paul@38 | 100 |
|
paul@38 | 101 | Within the configuration class itself, the auth setting needs to be updated to
|
paul@38 | 102 | include PGPAuth in the list of registered handlers. For example:
|
paul@38 | 103 |
|
paul@38 | 104 | auth = [MoinAuth(), PGPAuth()]
|
paul@38 | 105 |
|
paul@38 | 106 | This would permit the traditional Moin authentication and add signature-based
|
paul@51 | 107 | authentication so that messages can be accepted by the wiki.
|
paul@38 | 108 |
|
paul@12 | 109 | Fingerprints and Keys
|
paul@12 | 110 | ---------------------
|
paul@12 | 111 |
|
paul@12 | 112 | All fingerprints mentioned in the various configuration pages must exclude
|
paul@12 | 113 | space characters - that is, the letters and digits must appear together in a
|
paul@51 | 114 | continuous block of text - and refer to keys available in the wiki homedir.
|
paul@12 | 115 |
|
paul@11 | 116 | The Fingerprint-to-Username Mapping
|
paul@11 | 117 | -----------------------------------
|
paul@11 | 118 |
|
paul@12 | 119 | The mapping from fingerprints to usernames typically defined by the
|
paul@12 | 120 | MoinMessageUserDict page is a WikiDict having the following general format:
|
paul@11 | 121 |
|
paul@11 | 122 | fingerprint:: username
|
paul@11 | 123 |
|
paul@12 | 124 | Each fingerprint corresponds to a key used by a person wanting to send
|
paul@51 | 125 | messages to the wiki to sign such messages.
|
paul@11 | 126 |
|
paul@51 | 127 | Each username must correspond to a registered user in the wiki.
|
paul@11 | 128 |
|
paul@12 | 129 | The Username-to-Signing Key Mapping
|
paul@12 | 130 | -----------------------------------
|
paul@12 | 131 |
|
paul@12 | 132 | The mapping from usernames to fingerprints typically defined by the
|
paul@12 | 133 | MoinMessageSigningUserDict page is a WikiDict having the following general
|
paul@12 | 134 | format:
|
paul@12 | 135 |
|
paul@12 | 136 | username:: fingerprint
|
paul@12 | 137 |
|
paul@51 | 138 | Each fingerprint corresponds to a key available in the wiki's GPG homedir
|
paul@12 | 139 | generated for the purpose of signing the specified user's messages. Such a key
|
paul@51 | 140 | is not the same as one used by a person to send messages to the wiki since
|
paul@51 | 141 | only the public key is available to the wiki when verifying such messages,
|
paul@51 | 142 | whereas the signing of messages requires access to a private key. Thus, the
|
paul@51 | 143 | signing process employs a special private key known to the wiki for a user.
|
paul@12 | 144 |
|
paul@12 | 145 | The Recipients Mapping
|
paul@12 | 146 | ----------------------
|
paul@12 | 147 |
|
paul@12 | 148 | The mapping from recipients to remote URLs and fingerprints typically defined
|
paul@12 | 149 | by the MoinMessageRecipientsDict page is a WikiDict having the following
|
paul@12 | 150 | general format:
|
paul@12 | 151 |
|
paul@43 | 152 | recipient:: type location [ fingerprint ]
|
paul@27 | 153 |
|
paul@43 | 154 | Where the type is "page", the accompanying location must be a page name
|
paul@28 | 155 | indicating a page that provides a message store that will accept messages.
|
paul@63 | 156 | The affected page resides on the same wiki and is thus a bare page name, not
|
paul@63 | 157 | the URL of a page on the same or another wiki.
|
paul@12 | 158 |
|
paul@43 | 159 | Where the type is "url", the accompanying location must be a URL that must
|
paul@43 | 160 | itself refer to a resource that can accept MoinMessage content.
|
paul@12 | 161 |
|
paul@43 | 162 | Where a type of "url" has been given, a fingerprint must accompany this
|
paul@43 | 163 | information in order to encrypt messages sent to the specified resource.
|
paul@27 | 164 |
|
paul@51 | 165 | Each fingerprint corresponds to a key used by the wiki to encrypt messages and
|
paul@27 | 166 | by the remote site (as identified by the URL) to decrypt messages.
|
paul@12 | 167 |
|
paul@55 | 168 | Each wiki user can have their own recipients mapping by making a page, called
|
paul@55 | 169 | MoinMessageRecipientsDict unless overridden by the configuration, as a subpage
|
paul@55 | 170 | of their own home page.
|
paul@55 | 171 |
|
paul@11 | 172 | Quick Start: Signing, Encrypting and Sending Messages
|
paul@11 | 173 | -----------------------------------------------------
|
paul@11 | 174 |
|
paul@11 | 175 | To send a message signed and encrypted to a resource on localhost:
|
paul@11 | 176 |
|
paul@12 | 177 | python tests/test_send.py 1C1AAF83 0891463A http://localhost/wiki/ShareTest \
|
paul@51 | 178 | collection update 'An update to the wiki.' 'Another update.'
|
paul@11 | 179 |
|
paul@11 | 180 | Here, the first identifier is a reference to the signing key (over which you
|
paul@11 | 181 | have complete control), and the second identifier is a reference to the
|
paul@51 | 182 | encryption key (which is a public key published for the wiki).
|
paul@11 | 183 |
|
paul@11 | 184 | This needs password protection to be removed from the secret key in the Web
|
paul@12 | 185 | server environment. It also uses a modified trust model when invoking gpg in
|
paul@12 | 186 | order to avoid complaints about the identity of the sender during encryption.
|
paul@11 | 187 |
|
paul@45 | 188 | To sign the encrypted message for forwarding, the above command is modified:
|
paul@45 | 189 |
|
paul@45 | 190 | python tests/test_send.py 1C1AAF83 0891463A --forward 1C1AAF83 \
|
paul@45 | 191 | http://localhost/wiki/ShareTest \
|
paul@51 | 192 | collection update 'An update to the wiki.' 'Another update.'
|
paul@45 | 193 |
|
paul@11 | 194 | Below, the mechanisms employed are illustrated through the use of the other
|
paul@11 | 195 | test programs.
|
paul@11 | 196 |
|
paul@11 | 197 | Signing
|
paul@11 | 198 | -------
|
paul@11 | 199 |
|
paul@11 | 200 | Prepare a message signed with a "detached signature" (note that this does not
|
paul@11 | 201 | seem to be what gpg calls a detached signature with the --detach-sig option):
|
paul@11 | 202 |
|
paul@51 | 203 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 204 | 'Another update.' \
|
paul@11 | 205 | | python tests/test_sign.py 1C1AAF83
|
paul@11 | 206 |
|
paul@11 | 207 | The complicated recipe based on the individual operations is as follows:
|
paul@11 | 208 |
|
paul@51 | 209 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 210 | 'Another update.' \
|
paul@11 | 211 | > test.txt \
|
paul@11 | 212 | && cat test.txt \
|
paul@11 | 213 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@11 | 214 | | python tests/test_sign_wrap.py test.txt
|
paul@11 | 215 |
|
paul@11 | 216 | Encryption
|
paul@11 | 217 | ----------
|
paul@11 | 218 |
|
paul@11 | 219 | Prepare a message with an encrypted payload using the above key:
|
paul@11 | 220 |
|
paul@51 | 221 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 222 | 'Another update.' \
|
paul@11 | 223 | | python tests/test_encrypt.py 0891463A
|
paul@11 | 224 |
|
paul@11 | 225 | The complicated recipe based on the individual operations is as follows:
|
paul@11 | 226 |
|
paul@51 | 227 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 228 | 'Another update.' \
|
paul@11 | 229 | > test.txt \
|
paul@11 | 230 | && cat test.txt \
|
paul@11 | 231 | | gpg --armor -r 0891463A --encrypt --trust-model always \
|
paul@11 | 232 | | python tests/test_encrypt_wrap.py
|
paul@11 | 233 |
|
paul@11 | 234 | Note that "--trust-model always" is used only to avoid prompting issues.
|
paul@11 | 235 |
|
paul@11 | 236 | Signing and Encrypting
|
paul@11 | 237 | ----------------------
|
paul@11 | 238 |
|
paul@12 | 239 | Sign and encrypt a message:
|
paul@11 | 240 |
|
paul@51 | 241 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 242 | 'Another update.' \
|
paul@11 | 243 | | python tests/test_sign.py 1C1AAF83 \
|
paul@11 | 244 | | python tests/test_encrypt.py 0891463A
|
paul@11 | 245 |
|
paul@11 | 246 | The complicated recipe based on the individual operations is as follows:
|
paul@11 | 247 |
|
paul@51 | 248 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 249 | 'Another update.' \
|
paul@11 | 250 | > test.txt \
|
paul@11 | 251 | && cat test.txt \
|
paul@11 | 252 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@11 | 253 | | python tests/test_sign_wrap.py test.txt \
|
paul@11 | 254 | | gpg --armor -r 0891463A --encrypt --trust-model always \
|
paul@11 | 255 | | python tests/test_encrypt_wrap.py
|
paul@11 | 256 |
|
paul@45 | 257 | Signing and Encrypting then Signing
|
paul@45 | 258 | -----------------------------------
|
paul@45 | 259 |
|
paul@45 | 260 | Where a message is to be forwarded and not decrypted, it will be signed by the
|
paul@45 | 261 | author, encrypted, but then signed by the forwarder (perhaps initially the
|
paul@45 | 262 | author):
|
paul@45 | 263 |
|
paul@51 | 264 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@45 | 265 | 'Another update.' \
|
paul@45 | 266 | | python tests/test_sign.py 1C1AAF83 \
|
paul@45 | 267 | | python tests/test_encrypt.py 0891463A \
|
paul@45 | 268 | | python tests/test_sign.py 1C1AAF83
|
paul@45 | 269 |
|
paul@45 | 270 | The complicated recipe based on the individual operations is as follows:
|
paul@45 | 271 |
|
paul@51 | 272 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@45 | 273 | 'Another update.' \
|
paul@45 | 274 | > test.txt \
|
paul@45 | 275 | && cat test.txt \
|
paul@45 | 276 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@45 | 277 | | python tests/test_sign_wrap.py test.txt \
|
paul@45 | 278 | | gpg --armor -r 0891463A --encrypt --trust-model always \
|
paul@45 | 279 | | python tests/test_encrypt_wrap.py \
|
paul@45 | 280 | > test2.txt \
|
paul@45 | 281 | && cat test2.txt \
|
paul@45 | 282 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@45 | 283 | | python tests/test_sign_wrap.py test2.txt
|
paul@45 | 284 |
|
paul@11 | 285 | Posting a Message
|
paul@11 | 286 | -----------------
|
paul@11 | 287 |
|
paul@11 | 288 | To post a signed and/or encrypted message, output from the above activities
|
paul@11 | 289 | can be piped into the following command:
|
paul@11 | 290 |
|
paul@12 | 291 | python tests/test_post.py http://localhost/wiki/ShareTest
|
paul@11 | 292 |
|
paul@11 | 293 | Here, the resource "/wiki/ShareTest" on localhost is presented with the
|
paul@11 | 294 | message.
|
paul@16 | 295 |
|
paul@32 | 296 | Fetching Messages
|
paul@32 | 297 | -----------------
|
paul@32 | 298 |
|
paul@32 | 299 | To fetch messages from a message store associated with a page, the following
|
paul@32 | 300 | command can be used:
|
paul@32 | 301 |
|
paul@32 | 302 | python tests/test_fetch.py 1C1AAF83 0891463A http://localhost/wiki/ShareTest \
|
paul@32 | 303 | RETR
|
paul@32 | 304 |
|
paul@32 | 305 | This should retrieve all messages from the store associated with the
|
paul@32 | 306 | "/wiki/ShareTest" resource on localhost.
|
paul@32 | 307 |
|
paul@16 | 308 | The Message Format
|
paul@16 | 309 | ------------------
|
paul@16 | 310 |
|
paul@16 | 311 | Messages are MIME-encoded and consist of one or more update fragments. Where
|
paul@16 | 312 | the "Update-Type" header is present and set to a value of "collection", a
|
paul@16 | 313 | multipart message describes as many updates as there are parts. Otherwise,
|
paul@16 | 314 | only a single update is described by the message.
|
paul@16 | 315 |
|
paul@16 | 316 | For each update, the "Update-Action" header indicates the action to be taken
|
paul@16 | 317 | with the update content. Where it is absent, the content is inserted into the
|
paul@51 | 318 | wiki page specified in the request; where it is present and set to "replace",
|
paul@51 | 319 | the content replaces all content on the wiki page; where it is set to "store",
|
paul@51 | 320 | the content is stored in a message store associated with the wiki page.
|
paul@16 | 321 |
|
paul@16 | 322 | Each update may describe multiple representations of some content by employing
|
paul@44 | 323 | a multipart/alternative section containing parts for each of the
|
paul@44 | 324 | representations. Alternatively, a single message part may describe a single
|
paul@44 | 325 | representation.
|
paul@44 | 326 |
|
paul@44 | 327 | HTTP Methods
|
paul@44 | 328 | ------------
|
paul@44 | 329 |
|
paul@44 | 330 | Since MoinMoin seems to reserve POST methods for request/entity bodies that
|
paul@44 | 331 | contain HTML form data, it is necessary to use alternative methods to post
|
paul@44 | 332 | messages to a site served by MoinMoin and to fetch messages from such a site.
|
paul@57 | 333 | Consequently, MoinMessage uses PUT to post and fetch messages. Unfortunately,
|
paul@57 | 334 | MoinMoin 1.9 prevents the use of GET with request/entity bodies, and so the
|
paul@57 | 335 | natural usage of GET to fetch messages cannot be employed.
|
paul@54 | 336 |
|
paul@54 | 337 | Contact, Copyright and Licence Information
|
paul@54 | 338 | ------------------------------------------
|
paul@54 | 339 |
|
paul@54 | 340 | See the following Web page for more information about this work:
|
paul@54 | 341 |
|
paul@54 | 342 | http://moinmo.in/ActionMarket/MoinMessage
|
paul@54 | 343 |
|
paul@54 | 344 | The author can be contacted at the following e-mail address:
|
paul@54 | 345 |
|
paul@54 | 346 | paul@boddie.org.uk
|
paul@54 | 347 |
|
paul@54 | 348 | Copyright and licence information can be found in the docs directory - see
|
paul@54 | 349 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@54 | 350 |
|
paul@54 | 351 | Dependencies
|
paul@54 | 352 | ------------
|
paul@54 | 353 |
|
paul@54 | 354 | MoinMessage has the following basic dependencies:
|
paul@54 | 355 |
|
paul@54 | 356 | Packages Release Information
|
paul@54 | 357 | -------- -------------------
|
paul@54 | 358 |
|
paul@54 | 359 | MoinSupport Tested with 0.4
|
paul@54 | 360 | Source: http://hgweb.boddie.org.uk/MoinSupport
|