paul@29 | 1 | # -*- coding: iso-8859-1 -*- |
paul@29 | 2 | """ |
paul@29 | 3 | MoinMoin - MoinMessageSupport library |
paul@29 | 4 | |
paul@29 | 5 | @copyright: 2012, 2013 by Paul Boddie <paul@boddie.org.uk> |
paul@29 | 6 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@29 | 7 | """ |
paul@29 | 8 | |
paul@29 | 9 | from MoinMoin.Page import Page |
paul@29 | 10 | from MoinMoin.log import getLogger |
paul@29 | 11 | from MoinMoin.user import User |
paul@30 | 12 | from MoinMoin import wikiutil |
paul@29 | 13 | from MoinSupport import ItemStore, getHeader, getMetadata, getWikiDict, writeHeaders |
paul@33 | 14 | from MoinMessage import GPG, Message, MoinMessageError, is_signed, is_encrypted |
paul@29 | 15 | from email.parser import Parser |
paul@30 | 16 | import time |
paul@29 | 17 | |
paul@29 | 18 | try: |
paul@29 | 19 | from cStringIO import StringIO |
paul@29 | 20 | except ImportError: |
paul@29 | 21 | from StringIO import StringIO |
paul@29 | 22 | |
paul@29 | 23 | Dependencies = ['pages'] |
paul@29 | 24 | |
paul@29 | 25 | class MoinMessageAction: |
paul@29 | 26 | |
paul@29 | 27 | "Common message handling support for actions." |
paul@29 | 28 | |
paul@29 | 29 | def __init__(self, pagename, request): |
paul@29 | 30 | |
paul@29 | 31 | """ |
paul@29 | 32 | On the page with the given 'pagename', use the given 'request' when |
paul@29 | 33 | reading posted messages, modifying the Wiki. |
paul@29 | 34 | """ |
paul@29 | 35 | |
paul@29 | 36 | self.pagename = pagename |
paul@29 | 37 | self.request = request |
paul@29 | 38 | self.page = Page(request, pagename) |
paul@29 | 39 | self.store = ItemStore(self.page, "messages", "message-locks") |
paul@29 | 40 | |
paul@29 | 41 | def do_action(self): |
paul@29 | 42 | request = self.request |
paul@29 | 43 | content_length = getHeader(request, "Content-Length", "HTTP") |
paul@29 | 44 | if content_length: |
paul@29 | 45 | content_length = int(content_length) |
paul@29 | 46 | |
paul@29 | 47 | self.handle_message_text(request.read(content_length)) |
paul@29 | 48 | |
paul@29 | 49 | def handle_message_text(self, message_text): |
paul@29 | 50 | |
paul@29 | 51 | "Handle the given 'message_text'." |
paul@29 | 52 | |
paul@29 | 53 | message = Parser().parse(StringIO(message_text)) |
paul@29 | 54 | self.handle_message(message) |
paul@29 | 55 | |
paul@29 | 56 | def handle_message(self, message): |
paul@29 | 57 | |
paul@29 | 58 | "Handle the given 'message'." |
paul@29 | 59 | |
paul@29 | 60 | # Detect PGP/GPG-encoded payloads. |
paul@29 | 61 | # See: http://tools.ietf.org/html/rfc3156 |
paul@29 | 62 | |
paul@33 | 63 | if is_signed(message): |
paul@29 | 64 | self.handle_signed_message(message) |
paul@33 | 65 | elif is_encrypted(message): |
paul@29 | 66 | self.handle_encrypted_message(message) |
paul@29 | 67 | |
paul@33 | 68 | # Reject unsigned and unencrypted payloads. |
paul@29 | 69 | |
paul@29 | 70 | else: |
paul@33 | 71 | request = self.request |
paul@29 | 72 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@29 | 73 | request.write("Only PGP/GPG-signed payloads are supported.") |
paul@29 | 74 | |
paul@29 | 75 | def handle_encrypted_message(self, message): |
paul@29 | 76 | |
paul@29 | 77 | "Handle the given encrypted 'message'." |
paul@29 | 78 | |
paul@29 | 79 | request = self.request |
paul@29 | 80 | |
paul@29 | 81 | homedir = self.get_homedir() |
paul@29 | 82 | if not homedir: |
paul@29 | 83 | return |
paul@29 | 84 | |
paul@29 | 85 | gpg = GPG(homedir) |
paul@29 | 86 | |
paul@33 | 87 | try: |
paul@33 | 88 | text = gpg.decryptMessage(message) |
paul@29 | 89 | |
paul@33 | 90 | # Reject messages without a declaration. |
paul@29 | 91 | |
paul@33 | 92 | except MoinMessageMissingPart: |
paul@33 | 93 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@33 | 94 | request.write("There must be a declaration and a content part for encrypted uploads.") |
paul@33 | 95 | return |
paul@33 | 96 | |
paul@33 | 97 | # Reject messages without appropriate content. |
paul@29 | 98 | |
paul@33 | 99 | except MoinMessageBadContent: |
paul@33 | 100 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@33 | 101 | request.write("Encrypted data must be provided as application/octet-stream.") |
paul@33 | 102 | return |
paul@29 | 103 | |
paul@33 | 104 | # Reject any unencryptable message. |
paul@29 | 105 | |
paul@29 | 106 | except MoinMessageError: |
paul@29 | 107 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@29 | 108 | request.write("The message could not be decrypted.") |
paul@33 | 109 | return |
paul@33 | 110 | |
paul@33 | 111 | # Log non-fatal errors. |
paul@33 | 112 | |
paul@33 | 113 | if gpg.errors: |
paul@33 | 114 | getLogger(__name__).warning(gpg.errors) |
paul@33 | 115 | |
paul@33 | 116 | # Handle the embedded message which may itself be a signed message. |
paul@33 | 117 | |
paul@33 | 118 | self.handle_message_text(text) |
paul@29 | 119 | |
paul@29 | 120 | def handle_signed_message(self, message): |
paul@29 | 121 | |
paul@29 | 122 | "Handle the given signed 'message'." |
paul@29 | 123 | |
paul@29 | 124 | request = self.request |
paul@29 | 125 | |
paul@33 | 126 | homedir = self.get_homedir() |
paul@33 | 127 | if not homedir: |
paul@33 | 128 | return |
paul@33 | 129 | |
paul@33 | 130 | gpg = GPG(homedir) |
paul@33 | 131 | |
paul@29 | 132 | # NOTE: RFC 3156 states that signed messages should employ a detached |
paul@29 | 133 | # NOTE: signature but then shows "BEGIN PGP MESSAGE" for signatures |
paul@29 | 134 | # NOTE: instead of "BEGIN PGP SIGNATURE". |
paul@29 | 135 | # NOTE: The "micalg" parameter is currently not supported. |
paul@29 | 136 | |
paul@29 | 137 | try: |
paul@33 | 138 | fingerprint, identity, content = gpg.verifyMessage(message) |
paul@33 | 139 | |
paul@33 | 140 | # Reject messages without a declaration. |
paul@33 | 141 | |
paul@33 | 142 | except MoinMessageMissingPart: |
paul@29 | 143 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@29 | 144 | request.write("There must be a content part and a signature for signed uploads.") |
paul@29 | 145 | return |
paul@29 | 146 | |
paul@33 | 147 | # Reject messages without appropriate content. |
paul@29 | 148 | |
paul@33 | 149 | except MoinMessageBadContent: |
paul@29 | 150 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@29 | 151 | request.write("Signature data must be provided in the second part as application/pgp-signature.") |
paul@29 | 152 | return |
paul@29 | 153 | |
paul@33 | 154 | # Reject any unverified message. |
paul@29 | 155 | |
paul@29 | 156 | except MoinMessageError: |
paul@29 | 157 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@29 | 158 | request.write("The message could not be verified.") |
paul@33 | 159 | return |
paul@33 | 160 | |
paul@33 | 161 | # Log non-fatal errors. |
paul@33 | 162 | |
paul@33 | 163 | if gpg.errors: |
paul@33 | 164 | getLogger(__name__).warning(gpg.errors) |
paul@33 | 165 | |
paul@33 | 166 | # Map the fingerprint to a Wiki user. |
paul@33 | 167 | |
paul@33 | 168 | old_user = None |
paul@33 | 169 | request = self.request |
paul@33 | 170 | |
paul@33 | 171 | try: |
paul@33 | 172 | if fingerprint: |
paul@33 | 173 | gpg_users = getWikiDict( |
paul@33 | 174 | getattr(request.cfg, "moinmessage_gpg_users_page", "MoinMessageUserDict"), |
paul@33 | 175 | request |
paul@33 | 176 | ) |
paul@33 | 177 | |
paul@33 | 178 | # With a user mapping and a fingerprint corresponding to a known |
paul@33 | 179 | # user, temporarily switch user in order to make the edit. |
paul@33 | 180 | |
paul@33 | 181 | if gpg_users and gpg_users.has_key(fingerprint): |
paul@33 | 182 | old_user = request.user |
paul@33 | 183 | request.user = User(request, auth_method="gpg", auth_username=gpg_users[fingerprint]) |
paul@33 | 184 | |
paul@33 | 185 | # Handle the embedded message. |
paul@33 | 186 | |
paul@33 | 187 | self.handle_message_content(content) |
paul@33 | 188 | |
paul@33 | 189 | # Restore any user identity. |
paul@33 | 190 | |
paul@33 | 191 | finally: |
paul@33 | 192 | if old_user: |
paul@33 | 193 | request.user = old_user |
paul@29 | 194 | |
paul@29 | 195 | def handle_message_content(self, content): |
paul@29 | 196 | |
paul@29 | 197 | "Handle the given message 'content'." |
paul@29 | 198 | |
paul@30 | 199 | request = self.request |
paul@30 | 200 | |
paul@30 | 201 | # Interpret the content as one or more updates. |
paul@30 | 202 | |
paul@30 | 203 | message = Message() |
paul@30 | 204 | message.handle_message(content) |
paul@30 | 205 | |
paul@30 | 206 | # Test any date against the page or message store. |
paul@30 | 207 | |
paul@30 | 208 | if message.date: |
paul@30 | 209 | store_date = time.gmtime(self.store.mtime()) |
paul@30 | 210 | page_date = time.gmtime(wikiutil.version2timestamp(self.page.mtime_usecs())) |
paul@30 | 211 | last_date = max(store_date, page_date) |
paul@30 | 212 | |
paul@30 | 213 | # Reject messages older than the page date. |
paul@30 | 214 | |
paul@30 | 215 | if message.date < last_date: |
paul@30 | 216 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@30 | 217 | request.write("The message is too old: %s versus %s." % (message.date, last_date)) |
paul@30 | 218 | return |
paul@30 | 219 | |
paul@30 | 220 | # Reject messages without dates if so configured. |
paul@30 | 221 | |
paul@30 | 222 | elif getattr(request.cfg, "moinmessage_reject_messages_without_dates", True): |
paul@30 | 223 | writeHeaders(request, "text/plain", getMetadata(self.page), "403 Forbidden") |
paul@30 | 224 | request.write("The message has no date information.") |
paul@30 | 225 | return |
paul@30 | 226 | |
paul@30 | 227 | # Handle the message as an object. |
paul@30 | 228 | |
paul@30 | 229 | self.handle_message_object(message) |
paul@29 | 230 | |
paul@29 | 231 | def get_homedir(self): |
paul@29 | 232 | |
paul@29 | 233 | "Locate the GPG home directory." |
paul@29 | 234 | |
paul@34 | 235 | request = self.request |
paul@34 | 236 | homedir = get_homedir(self.request) |
paul@34 | 237 | |
paul@29 | 238 | if not homedir: |
paul@29 | 239 | writeHeaders(request, "text/plain", getMetadata(self.page), "415 Unsupported Media Type") |
paul@29 | 240 | request.write("Encoded data cannot currently be understood. Please notify the site administrator.") |
paul@34 | 241 | |
paul@29 | 242 | return homedir |
paul@29 | 243 | |
paul@34 | 244 | def get_homedir(request): |
paul@34 | 245 | |
paul@34 | 246 | "Locate the GPG home directory." |
paul@34 | 247 | |
paul@34 | 248 | return getattr(request.cfg, "moinmessage_gpg_homedir") |
paul@34 | 249 | |
paul@29 | 250 | # vim: tabstop=4 expandtab shiftwidth=4 |