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