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@110 | 6 | MoinMoin wiki instances with such content in such a way that contributors can
|
paul@110 | 7 | be 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@110 | 12 | A MoinMessage as understood by this software consists of content that is first
|
paul@110 | 13 | signed and then optionally encrypted, where this latter encryption step is
|
paul@110 | 14 | used to limit the audience of a message to its recipient and thus to restrict
|
paul@110 | 15 | knowledge of the message's author to the recipient. An extra signing step may
|
paul@110 | 16 | be employed to authenticate the sender of the message for the recipient, thus
|
paul@110 | 17 | providing a way of propagating encrypted messages between parties who trust
|
paul@110 | 18 | each other without any decryption of the content or access to details about
|
paul@110 | 19 | the author of the content.
|
paul@110 | 20 |
|
paul@11 | 21 | Configuring GPG for a Wiki
|
paul@11 | 22 | --------------------------
|
paul@11 | 23 |
|
paul@37 | 24 | Initialise a homedir for GPG and configure it using filesystem ACL (access
|
paul@37 | 25 | control list) properties:
|
paul@11 | 26 |
|
paul@12 | 27 | ./scripts/init_wiki_keyring.sh WIKI WEBUSER
|
paul@12 | 28 |
|
paul@51 | 29 | Here, WIKI should be replaced by the top-level wiki instance directory, and
|
paul@12 | 30 | WEBUSER should be the name of the user under which the Web server operates.
|
paul@12 | 31 |
|
paul@12 | 32 | Note that this script may need re-running after the homedir has been changed
|
paul@12 | 33 | by gpg operations as gpg likes to remove permissions from various files.
|
paul@11 | 34 |
|
paul@66 | 35 | Configuring GPG: Signing Keys
|
paul@66 | 36 | -----------------------------
|
paul@66 | 37 |
|
paul@67 | 38 | For a wiki to be able to receive content, signing keys must be made available
|
paul@67 | 39 | within the wiki's GPG homedir so that incoming messages can have their senders
|
paul@67 | 40 | verified.
|
paul@11 | 41 |
|
paul@67 | 42 | Consider the need to send content to a wiki yourself. To see the keys
|
paul@67 | 43 | available to you in your own environment:
|
paul@11 | 44 |
|
paul@11 | 45 | gpg --list-keys --with-fingerprint
|
paul@11 | 46 |
|
paul@51 | 47 | The full fingerprints are used when defining a user mapping in the wiki, and
|
paul@11 | 48 | the --with-fingerprint option is used to show them. Otherwise, only the last
|
paul@11 | 49 | eight characters of the fingerprints are shown.
|
paul@11 | 50 |
|
paul@11 | 51 | Export the public key used when signing messages from your own environment:
|
paul@11 | 52 |
|
paul@11 | 53 | gpg --armor --output 1C1AAF83.asc --export 1C1AAF83
|
paul@11 | 54 |
|
paul@51 | 55 | Import the key into the wiki's GPG homedir:
|
paul@11 | 56 |
|
paul@65 | 57 | gpg --homedir WIKI/gnupg --import 1C1AAF83.asc
|
paul@11 | 58 |
|
paul@67 | 59 | Signing keys can also be used in the authoring of messages within a wiki, and
|
paul@67 | 60 | this is discussed in "The Username-to-Signing-Key Mapping" section below.
|
paul@67 | 61 |
|
paul@66 | 62 | Configuring GPG: Encryption Keys
|
paul@66 | 63 | --------------------------------
|
paul@66 | 64 |
|
paul@66 | 65 | For the wiki to receive and decrypt encrypted data, a key for the wiki must be
|
paul@66 | 66 | created:
|
paul@11 | 67 |
|
paul@65 | 68 | gpg --homedir WIKI/gnupg --gen-key
|
paul@11 | 69 |
|
paul@51 | 70 | For the wiki environment to be able to use the key, password access must be
|
paul@12 | 71 | disabled. This can be done by either not specifying a password or by removing
|
paul@59 | 72 | it later using the --edit-key option:
|
paul@59 | 73 |
|
paul@65 | 74 | gpg --homedir WIKI/gnupg --edit-key 0891463A
|
paul@59 | 75 | passwd
|
paul@12 | 76 |
|
paul@51 | 77 | Export the wiki's key for encrypting messages sent to the wiki:
|
paul@11 | 78 |
|
paul@65 | 79 | gpg --homedir WIKI/gnupg --armor --output 0891463A.asc --export 0891463A
|
paul@11 | 80 |
|
paul@11 | 81 | This exported key can now be imported into your own environment:
|
paul@11 | 82 |
|
paul@11 | 83 | gpg --import 0891463A.asc
|
paul@11 | 84 |
|
paul@72 | 85 | This key can also be used to sign relayed messages within the wiki, and this
|
paul@72 | 86 | is described in more detail in "The Username-to-Signing-Key Mapping" section
|
paul@72 | 87 | below.
|
paul@66 | 88 |
|
paul@11 | 89 | Configuring the Wiki
|
paul@11 | 90 | --------------------
|
paul@11 | 91 |
|
paul@51 | 92 | In the wiki configuration, define the following settings:
|
paul@11 | 93 |
|
paul@11 | 94 | moinmessage_gpg_homedir
|
paul@11 | 95 | This sets the path to the homedir initialised above.
|
paul@11 | 96 |
|
paul@11 | 97 | moinmessage_gpg_users_page (optional, default is MoinMessageUserDict)
|
paul@11 | 98 | This provides a mapping from key fingerprints to Moin usernames.
|
paul@11 | 99 |
|
paul@12 | 100 | moinmessage_gpg_signing_users_page (optional, default is MoinMessageSigningUserDict)
|
paul@12 | 101 | This provides a mapping from Moin usernames to key fingerprints.
|
paul@12 | 102 |
|
paul@65 | 103 | moinmessage_gpg_relaying_user (optional)
|
paul@65 | 104 | This specifies the username of a special user who will sign relayed
|
paul@65 | 105 | messages. Partner wikis will need to record the details of this user in
|
paul@65 | 106 | their fingerprint-to-user mapping (see moinmessage_gpg_users_page) to be
|
paul@65 | 107 | able to receive messages from this wiki.
|
paul@65 | 108 |
|
paul@68 | 109 | moinmessage_gpg_relays_page (optional, default is MoinMessageRelayDict)
|
paul@68 | 110 | Where message relaying is specified for a recipient, the relay name will be
|
paul@68 | 111 | looked up in the dictionary provided by this page.
|
paul@68 | 112 |
|
paul@12 | 113 | moinmessage_gpg_recipients_page (optional, default is MoinMessageRecipientsDict)
|
paul@12 | 114 | This provides a mapping from recipients to remote URLs and key fingerprints.
|
paul@37 | 115 | Each user can define the named page as a subpage of their own home page.
|
paul@37 | 116 | If no such personal mapping exists, a common mapping exists relative to the
|
paul@37 | 117 | site root.
|
paul@12 | 118 |
|
paul@20 | 119 | moinmessage_reject_messages_without_dates (optional, default is True)
|
paul@51 | 120 | This causes messages sent to a wiki using the PostMessage action to be
|
paul@20 | 121 | rejected if date information is missing.
|
paul@20 | 122 |
|
paul@40 | 123 | moinmessage_static_files (optional, may refer to the built-in htdocs directory)
|
paul@40 | 124 | This explicitly defines the path to static resources used by Moin, enabling
|
paul@40 | 125 | such resources to be attached to messages. When set, the path must refer to
|
paul@40 | 126 | the htdocs directory (possibly renamed) containing the different theme
|
paul@65 | 127 | resource directories, together with the robots.txt and favicon.ico files.
|
paul@40 | 128 |
|
paul@38 | 129 | For signature verification to function, the following needs to be added:
|
paul@38 | 130 |
|
paul@38 | 131 | from MoinMoin.auth.pgp import PGPAuth
|
paul@38 | 132 |
|
paul@38 | 133 | This should import an authentication handler installed when the MoinMessage
|
paul@38 | 134 | software is installed as an extension package.
|
paul@38 | 135 |
|
paul@38 | 136 | Within the configuration class itself, the auth setting needs to be updated to
|
paul@38 | 137 | include PGPAuth in the list of registered handlers. For example:
|
paul@38 | 138 |
|
paul@38 | 139 | auth = [MoinAuth(), PGPAuth()]
|
paul@38 | 140 |
|
paul@38 | 141 | This would permit the traditional Moin authentication and add signature-based
|
paul@51 | 142 | authentication so that messages can be accepted by the wiki.
|
paul@38 | 143 |
|
paul@12 | 144 | Fingerprints and Keys
|
paul@12 | 145 | ---------------------
|
paul@12 | 146 |
|
paul@12 | 147 | All fingerprints mentioned in the various configuration pages must exclude
|
paul@12 | 148 | space characters - that is, the letters and digits must appear together in a
|
paul@51 | 149 | continuous block of text - and refer to keys available in the wiki homedir.
|
paul@12 | 150 |
|
paul@11 | 151 | The Fingerprint-to-Username Mapping
|
paul@11 | 152 | -----------------------------------
|
paul@11 | 153 |
|
paul@12 | 154 | The mapping from fingerprints to usernames typically defined by the
|
paul@12 | 155 | MoinMessageUserDict page is a WikiDict having the following general format:
|
paul@11 | 156 |
|
paul@11 | 157 | fingerprint:: username
|
paul@11 | 158 |
|
paul@12 | 159 | Each fingerprint corresponds to a key used by a person wanting to send
|
paul@51 | 160 | messages to the wiki to sign such messages.
|
paul@11 | 161 |
|
paul@51 | 162 | Each username must correspond to a registered user in the wiki.
|
paul@11 | 163 |
|
paul@65 | 164 | If a wiki is to perform message relaying, receiving messages from partner
|
paul@65 | 165 | wikis and sending them on, a user is required for this purpose. You could
|
paul@65 | 166 | create such a user as follows:
|
paul@65 | 167 |
|
paul@66 | 168 | moin --config-dir=WIKI account create --name=RelayingUser --email=messagerelay
|
paul@65 | 169 |
|
paul@65 | 170 | (You may need to run this command as the Web server user to be able to change
|
paul@65 | 171 | the wiki installation, as well as indicating the full path to the moin program
|
paul@65 | 172 | either as the program name or by setting the PATH.)
|
paul@65 | 173 |
|
paul@65 | 174 | After doing this, you could define an entry for the relaying user as follows:
|
paul@65 | 175 |
|
paul@66 | 176 | fingerprint:: RelayingUser
|
paul@65 | 177 |
|
paul@65 | 178 | Here, "fingerprint" should be substituted for a key fingerprint used by a
|
paul@65 | 179 | partner wiki to sign messages that it then sends to this wiki. See the next
|
paul@65 | 180 | section for more information on signing keys and identities.
|
paul@65 | 181 |
|
paul@65 | 182 | It may very well be the case that more than one partner wiki will be sending
|
paul@65 | 183 | messages to this wiki: the signing key fingerprint of each partner wiki can be
|
paul@65 | 184 | added to this mapping and specify the same relaying user; there is no
|
paul@65 | 185 | restriction on each fingerprint needing to map to a different user.
|
paul@65 | 186 |
|
paul@85 | 187 | The Username-to-Actions Mapping
|
paul@85 | 188 | -------------------------------
|
paul@85 | 189 |
|
paul@85 | 190 | Each user may have a set of permitted actions defined for them so that they
|
paul@85 | 191 | may perform these actions by sending an incoming message to the wiki. This
|
paul@85 | 192 | mapping is typically defined by the MoinMessageUserActionsDict page as a
|
paul@85 | 193 | WikiDict having the following general format:
|
paul@85 | 194 |
|
paul@85 | 195 | username:: permitted-action ...
|
paul@85 | 196 |
|
paul@85 | 197 | To add content to a page, an entry of the following form would be used:
|
paul@85 | 198 |
|
paul@85 | 199 | username:: Update:SomePage
|
paul@85 | 200 |
|
paul@85 | 201 | Similarly, to allow an incoming message to replace a page's content, the
|
paul@85 | 202 | following would be used:
|
paul@85 | 203 |
|
paul@85 | 204 | username:: Replace:SomePage
|
paul@85 | 205 |
|
paul@85 | 206 | And to be able to add messages to a page's message store, the following would
|
paul@85 | 207 | be used:
|
paul@85 | 208 |
|
paul@85 | 209 | username:: Store:SomePage
|
paul@85 | 210 |
|
paul@85 | 211 | Multiple actions can be given in a space-separated list, with shell-like
|
paul@85 | 212 | quoting used for names containing spaces (and quote characters). For example:
|
paul@85 | 213 |
|
paul@85 | 214 | username:: Store:"Some user's special page"
|
paul@85 | 215 |
|
paul@85 | 216 | Without an entry in this mapping, messages may not perform content
|
paul@85 | 217 | modification or storage actions in the wiki.
|
paul@85 | 218 |
|
paul@67 | 219 | The Username-to-Signing-Key Mapping
|
paul@12 | 220 | -----------------------------------
|
paul@12 | 221 |
|
paul@12 | 222 | The mapping from usernames to fingerprints typically defined by the
|
paul@12 | 223 | MoinMessageSigningUserDict page is a WikiDict having the following general
|
paul@12 | 224 | format:
|
paul@12 | 225 |
|
paul@12 | 226 | username:: fingerprint
|
paul@12 | 227 |
|
paul@51 | 228 | Each fingerprint corresponds to a key available in the wiki's GPG homedir
|
paul@12 | 229 | generated for the purpose of signing the specified user's messages. Such a key
|
paul@51 | 230 | is not the same as one used by a person to send messages to the wiki since
|
paul@51 | 231 | only the public key is available to the wiki when verifying such messages,
|
paul@51 | 232 | whereas the signing of messages requires access to a private key. Thus, the
|
paul@51 | 233 | signing process employs a special private key known to the wiki for a user.
|
paul@12 | 234 |
|
paul@67 | 235 | To create such a key, the following command can be used:
|
paul@67 | 236 |
|
paul@67 | 237 | gpg --homedir WIKI/gnupg --gen-key
|
paul@67 | 238 |
|
paul@67 | 239 | This is just like creating a key for the wiki itself (see "Configuring GPG for
|
paul@67 | 240 | a Wiki" above), but you will label the key appropriately for the user and
|
paul@67 | 241 | associate the key with the user in the mapping described above. Remember to
|
paul@67 | 242 | remove the passphrase so that the wiki can access the key.
|
paul@67 | 243 |
|
paul@65 | 244 | If a wiki is to perform message relaying, the special relaying user must be
|
paul@65 | 245 | defined in this mapping together with an appropriate key fingerprint. You can
|
paul@65 | 246 | use the key generated during the wiki's configuration (see "Configuring GPG
|
paul@65 | 247 | for a Wiki" above) for this purpose. This fingerprint can then be used by
|
paul@65 | 248 | partner wikis in their fingerprint-to-user mapping in order to verify incoming
|
paul@65 | 249 | messages and to process them as relayed messages.
|
paul@65 | 250 |
|
paul@72 | 251 | All signing keys must be made available in their public form to partner and
|
paul@72 | 252 | recipient wikis so that they are able to verify signed content. This can be
|
paul@72 | 253 | done as follows:
|
paul@72 | 254 |
|
paul@72 | 255 | gpg --homedir=WIKI/gnupg --armor --output 3FDDF29E.asc --export 3FDDF29E
|
paul@72 | 256 |
|
paul@72 | 257 | They are imported into partner and recipient wikis as follows:
|
paul@72 | 258 |
|
paul@72 | 259 | gpg --homedir=WIKI/gnupg --import 3FDDF29E.asc
|
paul@72 | 260 |
|
paul@12 | 261 | The Recipients Mapping
|
paul@12 | 262 | ----------------------
|
paul@12 | 263 |
|
paul@12 | 264 | The mapping from recipients to remote URLs and fingerprints typically defined
|
paul@12 | 265 | by the MoinMessageRecipientsDict page is a WikiDict having the following
|
paul@12 | 266 | general format:
|
paul@12 | 267 |
|
paul@43 | 268 | recipient:: type location [ fingerprint ]
|
paul@27 | 269 |
|
paul@43 | 270 | Where the type is "page", the accompanying location must be a page name
|
paul@28 | 271 | indicating a page that provides a message store that will accept messages.
|
paul@63 | 272 | The affected page resides on the same wiki and is thus a bare page name, not
|
paul@63 | 273 | the URL of a page on the same or another wiki.
|
paul@12 | 274 |
|
paul@43 | 275 | Where the type is "url", the accompanying location must be a URL that must
|
paul@43 | 276 | itself refer to a resource that can accept MoinMessage content.
|
paul@12 | 277 |
|
paul@68 | 278 | Where the type is "relay", the accompanying location is an identifier that
|
paul@68 | 279 | must be defined in the relays mapping (see below) and yield a URL that can
|
paul@68 | 280 | accept MoinMessage content.
|
paul@68 | 281 |
|
paul@84 | 282 | Where the type is "none" or omitted completely, the recipient is any user that
|
paul@84 | 283 | is allowed to fetch messages from the wiki.
|
paul@84 | 284 |
|
paul@84 | 285 | Where a type of "url", "relay" or "none" has been given (or if the type is
|
paul@84 | 286 | omitted), a fingerprint must accompany this information in order to encrypt
|
paul@84 | 287 | messages sent to the specified resource.
|
paul@27 | 288 |
|
paul@51 | 289 | Each fingerprint corresponds to a key used by the wiki to encrypt messages and
|
paul@27 | 290 | by the remote site (as identified by the URL) to decrypt messages.
|
paul@12 | 291 |
|
paul@55 | 292 | Each wiki user can have their own recipients mapping by making a page, called
|
paul@55 | 293 | MoinMessageRecipientsDict unless overridden by the configuration, as a subpage
|
paul@55 | 294 | of their own home page.
|
paul@55 | 295 |
|
paul@68 | 296 | The Relays Mapping
|
paul@68 | 297 | ------------------
|
paul@68 | 298 |
|
paul@68 | 299 | The mapping from relay identifiers to remote URLs defined by the
|
paul@68 | 300 | MoinMessageRelayDict page is a WikiDict having the following general format:
|
paul@68 | 301 |
|
paul@68 | 302 | relay:: url
|
paul@68 | 303 |
|
paul@68 | 304 | The URL must be able to accept MoinMessage content, and it will typically be
|
paul@68 | 305 | configured so that the user or entity accepting relayed content on the remote
|
paul@68 | 306 | site can store such content for later propagation or retrieval.
|
paul@68 | 307 |
|
paul@11 | 308 | Quick Start: Signing, Encrypting and Sending Messages
|
paul@11 | 309 | -----------------------------------------------------
|
paul@11 | 310 |
|
paul@11 | 311 | To send a message signed and encrypted to a resource on localhost:
|
paul@11 | 312 |
|
paul@12 | 313 | python tests/test_send.py 1C1AAF83 0891463A http://localhost/wiki/ShareTest \
|
paul@51 | 314 | collection update 'An update to the wiki.' 'Another update.'
|
paul@11 | 315 |
|
paul@11 | 316 | Here, the first identifier is a reference to the signing key (over which you
|
paul@11 | 317 | have complete control), and the second identifier is a reference to the
|
paul@51 | 318 | encryption key (which is a public key published for the wiki).
|
paul@11 | 319 |
|
paul@11 | 320 | This needs password protection to be removed from the secret key in the Web
|
paul@12 | 321 | server environment. It also uses a modified trust model when invoking gpg in
|
paul@12 | 322 | order to avoid complaints about the identity of the sender during encryption.
|
paul@11 | 323 |
|
paul@45 | 324 | To sign the encrypted message for forwarding, the above command is modified:
|
paul@45 | 325 |
|
paul@45 | 326 | python tests/test_send.py 1C1AAF83 0891463A --forward 1C1AAF83 \
|
paul@45 | 327 | http://localhost/wiki/ShareTest \
|
paul@51 | 328 | collection update 'An update to the wiki.' 'Another update.'
|
paul@45 | 329 |
|
paul@83 | 330 | Explicit recipient information can be provided for routing purposes:
|
paul@83 | 331 |
|
paul@83 | 332 | python tests/test_send.py 1C1AAF83 0891463A --to PaulBoddie \
|
paul@83 | 333 | --forward 1C1AAF83 \
|
paul@83 | 334 | http://localhost/wiki/ShareTest \
|
paul@83 | 335 | collection update 'An update to the wiki.' 'Another update.'
|
paul@83 | 336 |
|
paul@11 | 337 | Below, the mechanisms employed are illustrated through the use of the other
|
paul@11 | 338 | test programs.
|
paul@11 | 339 |
|
paul@11 | 340 | Signing
|
paul@11 | 341 | -------
|
paul@11 | 342 |
|
paul@11 | 343 | Prepare a message signed with a "detached signature" (note that this does not
|
paul@11 | 344 | seem to be what gpg calls a detached signature with the --detach-sig option):
|
paul@11 | 345 |
|
paul@51 | 346 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 347 | 'Another update.' \
|
paul@11 | 348 | | python tests/test_sign.py 1C1AAF83
|
paul@11 | 349 |
|
paul@11 | 350 | The complicated recipe based on the individual operations is as follows:
|
paul@11 | 351 |
|
paul@51 | 352 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 353 | 'Another update.' \
|
paul@11 | 354 | > test.txt \
|
paul@11 | 355 | && cat test.txt \
|
paul@11 | 356 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@11 | 357 | | python tests/test_sign_wrap.py test.txt
|
paul@11 | 358 |
|
paul@11 | 359 | Encryption
|
paul@11 | 360 | ----------
|
paul@11 | 361 |
|
paul@11 | 362 | Prepare a message with an encrypted payload using the above key:
|
paul@11 | 363 |
|
paul@51 | 364 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 365 | 'Another update.' \
|
paul@11 | 366 | | python tests/test_encrypt.py 0891463A
|
paul@11 | 367 |
|
paul@11 | 368 | The complicated recipe based on the individual operations is as follows:
|
paul@11 | 369 |
|
paul@51 | 370 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 371 | 'Another update.' \
|
paul@11 | 372 | > test.txt \
|
paul@11 | 373 | && cat test.txt \
|
paul@11 | 374 | | gpg --armor -r 0891463A --encrypt --trust-model always \
|
paul@11 | 375 | | python tests/test_encrypt_wrap.py
|
paul@11 | 376 |
|
paul@11 | 377 | Note that "--trust-model always" is used only to avoid prompting issues.
|
paul@11 | 378 |
|
paul@11 | 379 | Signing and Encrypting
|
paul@11 | 380 | ----------------------
|
paul@11 | 381 |
|
paul@12 | 382 | Sign and encrypt a message:
|
paul@11 | 383 |
|
paul@51 | 384 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 385 | 'Another update.' \
|
paul@11 | 386 | | python tests/test_sign.py 1C1AAF83 \
|
paul@11 | 387 | | python tests/test_encrypt.py 0891463A
|
paul@11 | 388 |
|
paul@11 | 389 | The complicated recipe based on the individual operations is as follows:
|
paul@11 | 390 |
|
paul@51 | 391 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@16 | 392 | 'Another update.' \
|
paul@11 | 393 | > test.txt \
|
paul@11 | 394 | && cat test.txt \
|
paul@11 | 395 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@11 | 396 | | python tests/test_sign_wrap.py test.txt \
|
paul@11 | 397 | | gpg --armor -r 0891463A --encrypt --trust-model always \
|
paul@11 | 398 | | python tests/test_encrypt_wrap.py
|
paul@11 | 399 |
|
paul@45 | 400 | Signing and Encrypting then Signing
|
paul@45 | 401 | -----------------------------------
|
paul@45 | 402 |
|
paul@45 | 403 | Where a message is to be forwarded and not decrypted, it will be signed by the
|
paul@45 | 404 | author, encrypted, but then signed by the forwarder (perhaps initially the
|
paul@45 | 405 | author):
|
paul@45 | 406 |
|
paul@51 | 407 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@45 | 408 | 'Another update.' \
|
paul@45 | 409 | | python tests/test_sign.py 1C1AAF83 \
|
paul@45 | 410 | | python tests/test_encrypt.py 0891463A \
|
paul@45 | 411 | | python tests/test_sign.py 1C1AAF83
|
paul@45 | 412 |
|
paul@45 | 413 | The complicated recipe based on the individual operations is as follows:
|
paul@45 | 414 |
|
paul@51 | 415 | python tests/test_message.py collection update 'An update to the wiki.' \
|
paul@45 | 416 | 'Another update.' \
|
paul@45 | 417 | > test.txt \
|
paul@45 | 418 | && cat test.txt \
|
paul@45 | 419 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@45 | 420 | | python tests/test_sign_wrap.py test.txt \
|
paul@45 | 421 | | gpg --armor -r 0891463A --encrypt --trust-model always \
|
paul@45 | 422 | | python tests/test_encrypt_wrap.py \
|
paul@45 | 423 | > test2.txt \
|
paul@45 | 424 | && cat test2.txt \
|
paul@45 | 425 | | gpg --armor -u 1C1AAF83 --detach-sig \
|
paul@45 | 426 | | python tests/test_sign_wrap.py test2.txt
|
paul@45 | 427 |
|
paul@11 | 428 | Posting a Message
|
paul@11 | 429 | -----------------
|
paul@11 | 430 |
|
paul@11 | 431 | To post a signed and/or encrypted message, output from the above activities
|
paul@11 | 432 | can be piped into the following command:
|
paul@11 | 433 |
|
paul@12 | 434 | python tests/test_post.py http://localhost/wiki/ShareTest
|
paul@11 | 435 |
|
paul@11 | 436 | Here, the resource "/wiki/ShareTest" on localhost is presented with the
|
paul@11 | 437 | message.
|
paul@16 | 438 |
|
paul@32 | 439 | Fetching Messages
|
paul@32 | 440 | -----------------
|
paul@32 | 441 |
|
paul@32 | 442 | To fetch messages from a message store associated with a page, the following
|
paul@32 | 443 | command can be used:
|
paul@32 | 444 |
|
paul@32 | 445 | python tests/test_fetch.py 1C1AAF83 0891463A http://localhost/wiki/ShareTest \
|
paul@32 | 446 | RETR
|
paul@32 | 447 |
|
paul@32 | 448 | This should retrieve all messages from the store associated with the
|
paul@32 | 449 | "/wiki/ShareTest" resource on localhost.
|
paul@32 | 450 |
|
paul@76 | 451 | Exporting and Sending Keys
|
paul@76 | 452 | --------------------------
|
paul@76 | 453 |
|
paul@76 | 454 | To export a public key, the following command can be used:
|
paul@76 | 455 |
|
paul@76 | 456 | python tests/text_export.py 1C1AAF83
|
paul@76 | 457 |
|
paul@76 | 458 | This will output a public key block in a MIME message part suitable for
|
paul@76 | 459 | incorporation into a larger message or signing. Signing a message containing
|
paul@76 | 460 | such a key can be done as follows:
|
paul@76 | 461 |
|
paul@76 | 462 | python tests/text_export.py 1C1AAF83 \
|
paul@76 | 463 | | python tests/test_sign.py 1C1AAF83
|
paul@76 | 464 |
|
paul@76 | 465 | Obviously, this does not provide any additional reassurance about the nature
|
paul@76 | 466 | of the exported key other than the originator was able to sign it with the
|
paul@76 | 467 | same keypair information.
|
paul@76 | 468 |
|
paul@16 | 469 | The Message Format
|
paul@16 | 470 | ------------------
|
paul@16 | 471 |
|
paul@16 | 472 | Messages are MIME-encoded and consist of one or more update fragments. Where
|
paul@16 | 473 | the "Update-Type" header is present and set to a value of "collection", a
|
paul@16 | 474 | multipart message describes as many updates as there are parts. Otherwise,
|
paul@16 | 475 | only a single update is described by the message.
|
paul@16 | 476 |
|
paul@16 | 477 | For each update, the "Update-Action" header indicates the action to be taken
|
paul@16 | 478 | with the update content. Where it is absent, the content is inserted into the
|
paul@51 | 479 | wiki page specified in the request; where it is present and set to "replace",
|
paul@51 | 480 | the content replaces all content on the wiki page; where it is set to "store",
|
paul@51 | 481 | the content is stored in a message store associated with the wiki page.
|
paul@16 | 482 |
|
paul@16 | 483 | Each update may describe multiple representations of some content by employing
|
paul@44 | 484 | a multipart/alternative section containing parts for each of the
|
paul@44 | 485 | representations. Alternatively, a single message part may describe a single
|
paul@44 | 486 | representation.
|
paul@44 | 487 |
|
paul@113 | 488 | The Message Fetching Request and Response Formats
|
paul@113 | 489 | -------------------------------------------------
|
paul@113 | 490 |
|
paul@113 | 491 | Requests made to fetch or manipulate messages via the FetchMessages action or
|
paul@113 | 492 | equivalent service should have the text/x-moinmessage-fetch content type and
|
paul@113 | 493 | contain a newline separated sequence of commands resembling those described in
|
paul@113 | 494 | the POP3 specification (RFC 1939). However, the actual commands supported are
|
paul@113 | 495 | as follows:
|
paul@113 | 496 |
|
paul@113 | 497 | STAT return the number of accessible messages
|
paul@113 | 498 |
|
paul@113 | 499 | RETR [ <number to retrieve> ] retrieve the given number of messages
|
paul@113 | 500 | (starting from the first message in the store)
|
paul@113 | 501 | or all messages if the number is omitted
|
paul@113 | 502 |
|
paul@113 | 503 | DELE [ <number to delete> ] delete the given number of messages (starting
|
paul@113 | 504 | from the first message in the store) or all
|
paul@113 | 505 | messages if the number is omitted
|
paul@113 | 506 |
|
paul@113 | 507 | Additional commands may be implemented in future. Note that the transactional
|
paul@113 | 508 | commands in POP3 are not supported since the protocol is not intended to be
|
paul@113 | 509 | used interactively and there is no notion of a session that is preserved over
|
paul@113 | 510 | many requests.
|
paul@113 | 511 |
|
paul@113 | 512 | Requests should be signed and encrypted in order to preserve the privacy of
|
paul@113 | 513 | the requester and the nature of their request.
|
paul@113 | 514 |
|
paul@113 | 515 | Responses to such requests should have the text/x-moinmessage-fetch-response
|
paul@113 | 516 | content type and contain a complete message in the response body that should
|
paul@113 | 517 | be the result of signing and encrypting a response message. (The inclusion of
|
paul@113 | 518 | an entire message in the body is intended to work around HTTP limitations,
|
paul@113 | 519 | even though HTTP should really be - or have been - MIME compatible.)
|
paul@113 | 520 |
|
paul@113 | 521 | The response message (before signing and encryption) is a multipart/mixed
|
paul@113 | 522 | message constructed similarly to collections of message updates. Each part of
|
paul@113 | 523 | this multipart message contains either a command result or a retrieved
|
paul@113 | 524 | message.
|
paul@113 | 525 |
|
paul@113 | 526 | Command results should have the text/x-moinmessage-fetch-result content type
|
paul@113 | 527 | providing the following headers:
|
paul@113 | 528 |
|
paul@113 | 529 | Request-Type the command that was provided
|
paul@113 | 530 | Request-Status the status of the command (OK or ERR)
|
paul@113 | 531 |
|
paul@113 | 532 | Any specific result value may be provided as the payload of the command result
|
paul@113 | 533 | message part.
|
paul@113 | 534 |
|
paul@113 | 535 | Retrieved messages should have the multipart/mixed content type and provide a
|
paul@113 | 536 | retrieved message in each part, where such messages may themselves be signed
|
paul@113 | 537 | or encrypted message representations.
|
paul@113 | 538 |
|
paul@44 | 539 | HTTP Methods
|
paul@44 | 540 | ------------
|
paul@44 | 541 |
|
paul@44 | 542 | Since MoinMoin seems to reserve POST methods for request/entity bodies that
|
paul@44 | 543 | contain HTML form data, it is necessary to use alternative methods to post
|
paul@44 | 544 | messages to a site served by MoinMoin and to fetch messages from such a site.
|
paul@57 | 545 | Consequently, MoinMessage uses PUT to post and fetch messages. Unfortunately,
|
paul@57 | 546 | MoinMoin 1.9 prevents the use of GET with request/entity bodies, and so the
|
paul@57 | 547 | natural usage of GET to fetch messages cannot be employed.
|
paul@54 | 548 |
|
paul@54 | 549 | Contact, Copyright and Licence Information
|
paul@54 | 550 | ------------------------------------------
|
paul@54 | 551 |
|
paul@54 | 552 | See the following Web page for more information about this work:
|
paul@54 | 553 |
|
paul@54 | 554 | http://moinmo.in/ActionMarket/MoinMessage
|
paul@54 | 555 |
|
paul@54 | 556 | The author can be contacted at the following e-mail address:
|
paul@54 | 557 |
|
paul@54 | 558 | paul@boddie.org.uk
|
paul@54 | 559 |
|
paul@54 | 560 | Copyright and licence information can be found in the docs directory - see
|
paul@54 | 561 | docs/COPYING.txt and docs/LICENCE.txt for more information.
|
paul@54 | 562 |
|
paul@54 | 563 | Dependencies
|
paul@54 | 564 | ------------
|
paul@54 | 565 |
|
paul@54 | 566 | MoinMessage has the following basic dependencies:
|
paul@54 | 567 |
|
paul@54 | 568 | Packages Release Information
|
paul@54 | 569 | -------- -------------------
|
paul@54 | 570 |
|
paul@74 | 571 | MoinSupport Tested with 0.5
|
paul@54 | 572 | Source: http://hgweb.boddie.org.uk/MoinSupport
|