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