Commit | Line | Data |
---|---|---|
0bec96d6 | 1 | #! /usr/bin/env python3 |
ff4136c7 | 2 | # -*- coding: utf-8 -*- |
0bec96d6 AE |
3 | """********************************************************************* |
4 | * Edward is free software: you can redistribute it and/or modify * | |
5 | * it under the terms of the GNU Affero Public License as published by * | |
6 | * the Free Software Foundation, either version 3 of the License, or * | |
7 | * (at your option) any later version. * | |
8 | * * | |
9 | * Edward is distributed in the hope that it will be useful, * | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of * | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * | |
12 | * GNU Affero Public License for more details. * | |
13 | * * | |
14 | * You should have received a copy of the GNU Affero Public License * | |
15 | * along with Edward. If not, see <http://www.gnu.org/licenses/>. * | |
16 | * * | |
17 | * Copyright (C) 2014-2015 Andrew Engelbrecht (AGPLv3+) * | |
18 | * Copyright (C) 2014 Josh Drake (AGPLv3+) * | |
19 | * Copyright (C) 2014 Lisa Marie Maginnis (AGPLv3+) * | |
8bdfb6d4 AE |
20 | * Copyright (C) 2009-2015 Tails developers <tails@boum.org> ( GPLv3+) * |
21 | * Copyright (C) 2009 W. Trevor King <wking@drexel.edu> ( GPLv2+) * | |
0bec96d6 AE |
22 | * * |
23 | * Special thanks to Josh Drake for writing the original edward bot! :) * | |
24 | * * | |
25 | ************************************************************************ | |
26 | ||
a5385c04 | 27 | Code sourced from these projects: |
0bec96d6 | 28 | |
8bdfb6d4 AE |
29 | * http://agpl.fsf.org/emailselfdefense.fsf.org/edward/CURRENT/edward.tar.gz |
30 | * https://git-tails.immerda.ch/whisperback/tree/whisperBack/encryption.py?h=feature/python3 | |
31 | * http://www.physics.drexel.edu/~wking/code/python/send_pgp_mime | |
0bec96d6 AE |
32 | """ |
33 | ||
0bec96d6 AE |
34 | import re |
35 | import io | |
40c37ab3 | 36 | import os |
2f4ce2b2 | 37 | import sys |
0fd3389f | 38 | import enum |
2f4ce2b2 | 39 | import gpgme |
adcef2f7 | 40 | import importlib |
60ccbaf4 | 41 | import subprocess |
0bec96d6 | 42 | |
8bdfb6d4 AE |
43 | import email.parser |
44 | import email.message | |
45 | import email.encoders | |
46 | ||
e5dd6f23 | 47 | from email.mime.text import MIMEText |
8bdfb6d4 AE |
48 | from email.mime.multipart import MIMEMultipart |
49 | from email.mime.application import MIMEApplication | |
50 | from email.mime.nonmultipart import MIMENonMultipart | |
51 | ||
40c37ab3 | 52 | import edward_config |
c96f3837 | 53 | |
01ceaec3 | 54 | langs = ["de", "el", "en", "es", "fr", "it", "ja", "pt-br", "ro", "ru", "tr"] |
adcef2f7 | 55 | |
def9196c AE |
56 | """This list contains the abbreviated names of reply languages available to |
57 | edward.""" | |
58 | ||
0fd3389f AE |
59 | class TxtType (enum.Enum): |
60 | text = 0 | |
61 | message = 1 | |
62 | pubkey = 2 | |
63 | detachedsig = 3 | |
64 | signature = 4 | |
def9196c | 65 | |
0fd3389f | 66 | |
2f4102b9 | 67 | match_pairs = [(TxtType.message, |
56578eaf | 68 | '-----BEGIN PGP MESSAGE-----.*?-----END PGP MESSAGE-----'), |
0fd3389f | 69 | (TxtType.pubkey, |
56578eaf | 70 | '-----BEGIN PGP PUBLIC KEY BLOCK-----.*?-----END PGP PUBLIC KEY BLOCK-----'), |
0fd3389f | 71 | (TxtType.detachedsig, |
38738401 | 72 | '-----BEGIN PGP SIGNATURE-----.*?-----END PGP SIGNATURE-----')] |
56578eaf | 73 | |
def9196c AE |
74 | """This list of tuples matches query names with re.search() queries used |
75 | to find GPG data for edward to process.""" | |
76 | ||
56578eaf AE |
77 | |
78 | class EddyMsg (object): | |
def9196c AE |
79 | """ |
80 | The EddyMsg class represents relevant parts of a mime message. | |
81 | ||
82 | The represented message can be single-part or multi-part. | |
83 | ||
84 | 'multipart' is set to True if there are multiple mime parts. | |
85 | ||
86 | 'subparts' points to a list of mime sub-parts if it is a multi-part | |
87 | message. Otherwise it points to an empty list. | |
88 | ||
6d8faaa7 AE |
89 | 'payload_bytes' is a binary representation of the mime part before header |
90 | removal and message decoding. | |
def9196c AE |
91 | |
92 | 'payload_pieces' is a list of objects containing strings that when strung | |
93 | together form the fully-decoded string representation of the mime part. | |
94 | ||
def9196c AE |
95 | The 'filename', 'content_type' and 'description_list' come from the mime |
96 | part parameters. | |
97 | """ | |
98 | ||
7d0b91d2 AE |
99 | multipart = False |
100 | subparts = [] | |
56578eaf | 101 | |
7d0b91d2 AE |
102 | payload_bytes = None |
103 | payload_pieces = [] | |
56578eaf | 104 | |
7d0b91d2 AE |
105 | filename = None |
106 | content_type = None | |
107 | description_list = None | |
56578eaf AE |
108 | |
109 | ||
110 | class PayloadPiece (object): | |
def9196c AE |
111 | """ |
112 | PayloadPiece represents a complte or sub-section of a mime part. | |
113 | ||
114 | Instances of this class are often strung together within one or more arrays | |
115 | pointed to by each instance of the EddyMsg class. | |
116 | ||
0fd3389f AE |
117 | 'piece_type' refers to an enum whose value describes the content of |
118 | 'string'. Examples include TxtType.pubkey, for public keys, and | |
119 | TxtType.message, for encrypted data (or armored signatures until they are | |
120 | known to be such.) Some of the names derive from the header and footer of | |
121 | each of these ascii-encoded gpg blocks. | |
def9196c AE |
122 | |
123 | 'string' contains some string of text, such as non-GPG text, an encrypted | |
124 | block of text, a signature, or a public key. | |
125 | ||
126 | 'gpg_data' points to any instances of GPGData that have been created based | |
127 | on the contents of 'string'. | |
128 | """ | |
129 | ||
7d0b91d2 AE |
130 | piece_type = None |
131 | string = None | |
132 | gpg_data = None | |
56578eaf AE |
133 | |
134 | ||
38738401 | 135 | class GPGData (object): |
def9196c AE |
136 | """ |
137 | GPGData holds info from decryption, sig. verification, and/or pub. keys. | |
138 | ||
139 | Instances of this class contain decrypted information, signature | |
140 | fingerprints and/or fingerprints of processed and imported public keys. | |
141 | ||
142 | 'decrypted' is set to True if 'plainobj' was created from encrypted data. | |
143 | ||
144 | 'plainobj' points to any decrypted, or signed part of, a GPG signature. It | |
145 | is intended to be an instance of the EddyMsg class. | |
146 | ||
147 | 'sigs' is a list of fingerprints of keys used to sign the data in plainobj. | |
148 | ||
b4c116d5 AE |
149 | 'sigkey_missing' is set to True if edward doesn't have the key it needs to |
150 | verify the signature on a block of text. | |
9af26cb8 | 151 | |
def9196c AE |
152 | 'keys' is a list of fingerprints of keys obtained in public key blocks. |
153 | """ | |
154 | ||
7d0b91d2 AE |
155 | decrypted = False |
156 | ||
157 | plainobj = None | |
158 | sigs = [] | |
b4c116d5 | 159 | sigkey_missing = False |
7d0b91d2 | 160 | keys = [] |
38738401 | 161 | |
38738401 | 162 | |
d873ff48 | 163 | class ReplyInfo (object): |
def9196c AE |
164 | """ |
165 | ReplyInfo contains details that edward uses in generating its reply. | |
166 | ||
167 | Instances of this class contain information about whether a message was | |
168 | successfully encrypted or signed, and whether a public key was attached, or | |
169 | retrievable, from the local GPG store. It stores the fingerprints of | |
170 | potential encryption key candidates and the message (if any at all) to | |
171 | quote in edward's reply. | |
172 | ||
173 | 'replies' points one of the dictionaries of translated replies. | |
174 | ||
175 | 'target_key' refers to the fingerprint of a key used to sign encrypted | |
176 | data. This is the preferred key, if it is set, and if is available. | |
177 | ||
178 | 'fallback_target_key' referst to the fingerprint of a key used to sign | |
179 | unencrypted data; alternatively it may be a public key attached to the | |
180 | message. | |
181 | ||
ca37d0cb AE |
182 | 'encrypt_to_key' the key object to use when encrypting edward's reply |
183 | ||
def9196c AE |
184 | 'msg_to_quote' refers to the part of a message which edward should quote in |
185 | his reply. This should remain as None if there was no encrypted and singed | |
186 | part. This is to avoid making edward a service for decrypting other | |
187 | people's messages to edward. | |
188 | ||
b4c116d5 | 189 | 'decrypt_success' is set to True if edward could decrypt part of the |
def9196c AE |
190 | message. |
191 | ||
def9196c AE |
192 | 'sig_success' is set to True if edward could to some extent verify the |
193 | signature of a signed part of the message to edward. | |
194 | ||
32a8996f AE |
195 | 'sig_failure' is set to True if edward could not verify a siganture. |
196 | ||
b4c116d5 AE |
197 | 'pubkey_success' is set to True if edward successfully imported a public |
198 | key. | |
199 | ||
200 | 'sigkey_missing' is set to True if edward doesn't have the public key | |
201 | needed for signature verification. | |
202 | ||
203 | 'have_repy_key' is set to True if edward has a public key to encrypt its | |
204 | reply to. | |
def9196c AE |
205 | """ |
206 | ||
7d0b91d2 | 207 | replies = None |
6906d46d | 208 | |
7d0b91d2 AE |
209 | target_key = None |
210 | fallback_target_key = None | |
ca37d0cb | 211 | encrypt_to_key = None |
7d0b91d2 | 212 | msg_to_quote = "" |
d873ff48 | 213 | |
b4c116d5 | 214 | decrypt_success = False |
7d0b91d2 | 215 | sig_success = False |
b4c116d5 AE |
216 | pubkey_success = False |
217 | ||
4e2c66f7 | 218 | decrypt_failure = False |
32a8996f | 219 | sig_failure = False |
b4c116d5 | 220 | sigkey_missing = False |
371911ad | 221 | |
b4c116d5 | 222 | have_reply_key = False |
d873ff48 | 223 | |
38738401 | 224 | |
0bec96d6 AE |
225 | def main (): |
226 | ||
def9196c AE |
227 | """ |
228 | This is the main function for edward, a GPG reply bot. | |
229 | ||
230 | Edward responds to GPG-encrypted and signed mail, encrypting and signing | |
231 | the response if the user's public key is, or was, included in the message. | |
232 | ||
233 | Args: | |
234 | None | |
235 | ||
236 | Returns: | |
a3d6aff8 | 237 | Nothing |
def9196c AE |
238 | |
239 | Pre: | |
240 | Mime or plaintext email passing in through standard input. Portions of | |
241 | the email may be encrypted. If the To: address contains the text | |
242 | "edward-ja", then the reply will contain a reply written in the | |
243 | Japanese language. There are other languages as well. The default | |
244 | language is English. | |
245 | ||
246 | Post: | |
247 | A reply email will be printed to standard output. The contents of the | |
248 | reply email depends on whether the original email was encrypted or not, | |
249 | has or doesn't have a signature, whether a public key used in the | |
250 | original message is provided or locally stored, and the language | |
251 | implied by the To: address in the original email. | |
252 | """ | |
253 | ||
60ccbaf4 | 254 | print_reply_only = handle_args() |
0bec96d6 | 255 | |
0a064403 AE |
256 | gpgme_ctx = get_gpg_context(edward_config.gnupghome, |
257 | edward_config.sign_with_key) | |
258 | ||
85a829fc AE |
259 | email_bytes = sys.stdin.buffer.read() |
260 | email_struct = parse_pgp_mime(email_bytes, gpgme_ctx) | |
adcef2f7 | 261 | |
85a829fc | 262 | email_to, email_from, email_subject = email_to_from_subject(email_bytes) |
60ccbaf4 | 263 | lang, reply_from = import_lang_pick_address(email_to, edward_config.hostname) |
fafa21c3 | 264 | |
d873ff48 AE |
265 | replyinfo_obj = ReplyInfo() |
266 | replyinfo_obj.replies = lang.replies | |
267 | ||
268 | prepare_for_reply(email_struct, replyinfo_obj) | |
ca37d0cb | 269 | get_key_from_fp(replyinfo_obj, gpgme_ctx) |
d873ff48 | 270 | reply_plaintext = write_reply(replyinfo_obj) |
adcef2f7 | 271 | |
2007103e | 272 | reply_mime = generate_encrypted_mime(reply_plaintext, email_from, \ |
ca37d0cb | 273 | email_subject, replyinfo_obj.encrypt_to_key, |
2007103e | 274 | gpgme_ctx) |
1fccb295 | 275 | |
60ccbaf4 AE |
276 | if print_reply_only == True: |
277 | print(reply_mime) | |
278 | else: | |
279 | send_reply(reply_mime, email_subject, email_from, reply_from) | |
c96f3837 | 280 | |
0bec96d6 | 281 | |
0a064403 | 282 | def get_gpg_context (gnupghome, sign_with_key_fp): |
a3d6aff8 AE |
283 | """ |
284 | This function returns the GPG context needed for encryption and signing. | |
285 | ||
286 | The context is needed by other functions which use GPG functionality. | |
287 | ||
288 | Args: | |
289 | gnupghome: The path to "~/.gnupg/" or its alternative. | |
290 | sign_with_key: The fingerprint of the key to sign with | |
291 | ||
292 | Returns: | |
293 | A gpgme context to be used for GPG functions. | |
294 | ||
295 | Post: | |
296 | the 'armor' flag is set to True and the list of signing keys contains | |
297 | the single specified key | |
298 | """ | |
0a064403 AE |
299 | |
300 | os.environ['GNUPGHOME'] = gnupghome | |
301 | ||
302 | gpgme_ctx = gpgme.Context() | |
303 | gpgme_ctx.armor = True | |
304 | ||
305 | try: | |
306 | sign_with_key = gpgme_ctx.get_key(sign_with_key_fp) | |
5f6f32b1 | 307 | except gpgme.GpgmeError: |
0a064403 AE |
308 | error("unable to load signing key. is the gnupghome " |
309 | + "and signing key properly set in the edward_config.py?") | |
310 | exit(1) | |
311 | ||
312 | gpgme_ctx.signers = [sign_with_key] | |
313 | ||
314 | return gpgme_ctx | |
315 | ||
316 | ||
85a829fc | 317 | def parse_pgp_mime (email_bytes, gpgme_ctx): |
a3d6aff8 AE |
318 | """Parses the email for mime payloads and decrypts/verfies signatures. |
319 | ||
320 | This function creates a representation of a mime or plaintext email with | |
321 | the EddyMsg class. It then splits each mime payload into one or more pieces | |
322 | which may be plain text or GPG data. It then decrypts encrypted parts and | |
323 | does some very basic signature verification on those parts. | |
324 | ||
325 | Args: | |
85a829fc | 326 | email_bytes: an email message in byte string format |
a3d6aff8 AE |
327 | gpgme_ctx: a gpgme context |
328 | ||
329 | Returns: | |
330 | A message as an instance of EddyMsg | |
331 | ||
332 | Post: | |
333 | the returned EddyMsg instance has split, decrypted, verified and pubkey | |
334 | imported payloads | |
335 | """ | |
394a1476 | 336 | |
85a829fc | 337 | email_struct = email.parser.BytesParser().parsebytes(email_bytes) |
394a1476 | 338 | |
928e3819 AE |
339 | eddymsg_obj = parse_mime(email_struct) |
340 | split_payloads(eddymsg_obj) | |
341 | gpg_on_payloads(eddymsg_obj, gpgme_ctx) | |
8bb4b0d5 | 342 | |
928e3819 | 343 | return eddymsg_obj |
0bec96d6 | 344 | |
0bec96d6 | 345 | |
56578eaf | 346 | def parse_mime(msg_struct): |
a3d6aff8 AE |
347 | """Translates python's email.parser format into an EddyMsg format |
348 | ||
349 | If the message is multi-part, then a recursive object is created, where | |
350 | each sub-part is also a EddyMsg instance. | |
351 | ||
352 | Args: | |
353 | msg_struct: an email parsed with email.parser.Parser(), which can be | |
354 | multi-part | |
355 | ||
356 | Returns: | |
357 | an instance of EddyMsg, potentially a recursive one. | |
358 | """ | |
0bec96d6 | 359 | |
928e3819 | 360 | eddymsg_obj = EddyMsg() |
8bb4b0d5 | 361 | |
56578eaf AE |
362 | if msg_struct.is_multipart() == True: |
363 | payloads = msg_struct.get_payload() | |
0bec96d6 | 364 | |
928e3819 AE |
365 | eddymsg_obj.multipart = True |
366 | eddymsg_obj.subparts = list(map(parse_mime, payloads)) | |
dd11a483 | 367 | |
56578eaf | 368 | else: |
928e3819 | 369 | eddymsg_obj = get_subpart_data(msg_struct) |
394a1476 | 370 | |
928e3819 | 371 | return eddymsg_obj |
c267c233 | 372 | |
80119cab | 373 | |
2f4102b9 | 374 | def scan_and_split (payload_piece, match_name, pattern): |
a3d6aff8 AE |
375 | """This splits the payloads of an EddyMsg object into GPG and text parts. |
376 | ||
377 | An EddyMsg object's payload_pieces starts off as a list containing a single | |
378 | PayloadPiece object. This function returns a list of these objects which | |
379 | have been split into GPG data and regular text, if such splits need to be/ | |
380 | can be made. | |
381 | ||
382 | Args: | |
383 | payload_piece: a single payload or a split part of a payload | |
2f4102b9 | 384 | match_name: the type of data to try to spit out from the payload piece |
a3d6aff8 AE |
385 | pattern: the search pattern to be used for finding that type of data |
386 | ||
387 | Returns: | |
388 | a list of objects of the PayloadPiece class, in the order that the | |
389 | string part of payload_piece originally was, broken up according to | |
390 | matches specified by 'pattern'. | |
391 | """ | |
cf75de65 | 392 | |
a5d37d44 | 393 | # don't try to re-split pieces containing gpg data |
0fd3389f | 394 | if payload_piece.piece_type != TxtType.text: |
a5d37d44 AE |
395 | return [payload_piece] |
396 | ||
56578eaf AE |
397 | flags = re.DOTALL | re.MULTILINE |
398 | matches = re.search("(?P<beginning>.*?)(?P<match>" + pattern + | |
399 | ")(?P<rest>.*)", payload_piece.string, flags=flags) | |
86663388 | 400 | |
56578eaf AE |
401 | if matches == None: |
402 | pieces = [payload_piece] | |
c96f3837 | 403 | |
56578eaf | 404 | else: |
d437f8b2 | 405 | |
56578eaf AE |
406 | beginning = PayloadPiece() |
407 | beginning.string = matches.group('beginning') | |
408 | beginning.piece_type = payload_piece.piece_type | |
d437f8b2 | 409 | |
56578eaf AE |
410 | match = PayloadPiece() |
411 | match.string = matches.group('match') | |
2f4102b9 | 412 | match.piece_type = match_name |
d437f8b2 | 413 | |
56578eaf AE |
414 | rest = PayloadPiece() |
415 | rest.string = matches.group('rest') | |
416 | rest.piece_type = payload_piece.piece_type | |
d437f8b2 | 417 | |
2f4102b9 | 418 | more_pieces = scan_and_split(rest, match_name, pattern) |
4615b156 | 419 | pieces = [beginning, match ] + more_pieces |
d437f8b2 | 420 | |
56578eaf | 421 | return pieces |
d437f8b2 | 422 | |
d437f8b2 | 423 | |
56578eaf | 424 | def get_subpart_data (part): |
a3d6aff8 AE |
425 | """This function grabs information from a single part mime object. |
426 | ||
427 | It copies needed data from a single part email.parser.Parser() object over | |
428 | to an EddyMsg object. | |
429 | ||
430 | Args: | |
431 | part: a non-multi-part mime.parser.Parser() object | |
432 | ||
433 | Returns: | |
434 | a single-part EddyMsg() object | |
435 | """ | |
0bec96d6 | 436 | |
6d8faaa7 | 437 | obj = EddyMsg() |
56578eaf | 438 | |
84ff9773 AE |
439 | mime_decoded_bytes = part.get_payload(decode=True) |
440 | charset = part.get_content_charset() | |
56578eaf AE |
441 | |
442 | # your guess is as good as a-myy-ee-ine... | |
6d8faaa7 AE |
443 | if charset == None: |
444 | charset = 'utf-8' | |
56578eaf | 445 | |
84ff9773 AE |
446 | payload_string = part.as_string() |
447 | if payload_string != None: | |
448 | obj.payload_bytes = payload_string.encode(charset) | |
449 | ||
450 | obj.filename = part.get_filename() | |
451 | obj.content_type = part.get_content_type() | |
452 | obj.description_list = part['content-description'] | |
453 | ||
6d8faaa7 | 454 | if mime_decoded_bytes != None: |
0eb75d9c AE |
455 | try: |
456 | payload = PayloadPiece() | |
6d8faaa7 | 457 | payload.string = mime_decoded_bytes.decode(charset) |
0fd3389f | 458 | payload.piece_type = TxtType.text |
0eb75d9c AE |
459 | |
460 | obj.payload_pieces = [payload] | |
461 | except UnicodeDecodeError: | |
462 | pass | |
56578eaf AE |
463 | |
464 | return obj | |
465 | ||
466 | ||
928e3819 | 467 | def do_to_eddys_pieces (function_to_do, eddymsg_obj, data): |
a3d6aff8 AE |
468 | """A function which maps another function onto a message's subparts. |
469 | ||
470 | This is a higer-order function which recursively performs a specified | |
471 | function on each subpart of a multi-part message. Each single-part sub-part | |
472 | has the function applied to it. This function also works if the part passed | |
473 | in is single-part. | |
474 | ||
475 | Args: | |
476 | function_to_do: function to perform on sub-parts | |
477 | eddymsg_obj: a single part or multi-part EddyMsg object | |
478 | data: a second argument to pass to 'function_to_do' | |
479 | ||
480 | Returns: | |
481 | Nothing | |
482 | ||
483 | Post: | |
484 | The passed-in EddyMsg object is transformed recursively on its | |
485 | sub-parts according to 'function_to_do'. | |
486 | """ | |
56578eaf | 487 | |
928e3819 AE |
488 | if eddymsg_obj.multipart == True: |
489 | for sub in eddymsg_obj.subparts: | |
d873ff48 | 490 | do_to_eddys_pieces(function_to_do, sub, data) |
394a1476 | 491 | else: |
928e3819 | 492 | function_to_do(eddymsg_obj, data) |
dd11a483 AE |
493 | |
494 | ||
928e3819 | 495 | def split_payloads (eddymsg_obj): |
a3d6aff8 AE |
496 | """Splits all (sub-)payloads of a message into GPG data and regular text. |
497 | ||
498 | Recursively performs payload splitting on all sub-parts of an EddyMsg | |
499 | object into the various GPG data types, such as GPG messages, public key | |
500 | blocks and signed text. | |
501 | ||
502 | Args: | |
503 | eddymsg_obj: an instance of EddyMsg | |
504 | ||
505 | Returns: | |
506 | Nothing | |
507 | ||
508 | Pre: | |
509 | The EddyMsg object has payloads that are unsplit (by may be split).. | |
510 | ||
511 | Post: | |
512 | The EddyMsg object's payloads are all split into GPG and non-GPG parts. | |
513 | """ | |
a5d37d44 | 514 | |
2f4102b9 AE |
515 | for match_pair in match_pairs: |
516 | do_to_eddys_pieces(split_payload_pieces, eddymsg_obj, match_pair) | |
a5d37d44 | 517 | |
a5d37d44 | 518 | |
2f4102b9 | 519 | def split_payload_pieces (eddymsg_obj, match_pair): |
a3d6aff8 AE |
520 | """A helper function for split_payloads(); works on PayloadPiece objects. |
521 | ||
522 | This function splits up PayloadPiece objects into multipe PayloadPiece | |
523 | objects and replaces the EddyMsg object's previous list of payload pieces | |
524 | with the new split up one. | |
525 | ||
526 | Args: | |
527 | eddymsg_obj: a single-part EddyMsg object. | |
2f4102b9 | 528 | match_pair: a tuple from the match_pairs list, which specifies a match |
a3d6aff8 AE |
529 | name and a match pattern. |
530 | ||
531 | Returns: | |
532 | Nothing | |
533 | ||
534 | Pre: | |
535 | The payload piece(s) of an EddyMsg object may be already split or | |
536 | unsplit. | |
537 | ||
538 | Post: | |
539 | The EddyMsg object's payload piece(s) are split into a list of pieces | |
2f4102b9 | 540 | if matches of the match_pair are found. |
a3d6aff8 | 541 | """ |
a5d37d44 | 542 | |
2f4102b9 | 543 | (match_name, pattern) = match_pair |
a5d37d44 AE |
544 | |
545 | new_pieces_list = [] | |
928e3819 | 546 | for piece in eddymsg_obj.payload_pieces: |
a5d37d44 AE |
547 | new_pieces_list += scan_and_split(piece, match_name, pattern) |
548 | ||
928e3819 | 549 | eddymsg_obj.payload_pieces = new_pieces_list |
a5d37d44 AE |
550 | |
551 | ||
928e3819 | 552 | def gpg_on_payloads (eddymsg_obj, gpgme_ctx, prev_parts=[]): |
a3d6aff8 AE |
553 | """Performs GPG operations on the GPG parts of the message |
554 | ||
555 | This function decrypts text, verifies signatures, and imports public keys | |
556 | included in an email. | |
557 | ||
558 | Args: | |
559 | eddymsg_obj: an EddyMsg object with its payload_pieces split into GPG | |
560 | and non-GPG sections by split_payloads() | |
561 | gpgme_ctx: a gpgme context | |
562 | ||
563 | prev_parts: a list of mime parts that occur before the eddymsg_obj | |
564 | part, under the same multi-part mime part. This is used for | |
565 | verifying detached signatures. For the root mime part, this should | |
566 | be an empty list, which is the default value if this paramater is | |
567 | omitted. | |
568 | ||
569 | Return: | |
570 | Nothing | |
571 | ||
572 | Pre: | |
573 | eddymsg_obj should have its payloads split into gpg and non-gpg pieces. | |
574 | ||
575 | Post: | |
576 | Decryption, verification and key imports occur. the gpg_data member of | |
577 | PayloadPiece objects get filled in with GPGData objects. | |
578 | """ | |
38738401 | 579 | |
928e3819 | 580 | if eddymsg_obj.multipart == True: |
101d54a8 | 581 | prev_parts=[] |
928e3819 | 582 | for sub in eddymsg_obj.subparts: |
101d54a8 AE |
583 | gpg_on_payloads (sub, gpgme_ctx, prev_parts) |
584 | prev_parts += [sub] | |
38738401 | 585 | |
d873ff48 | 586 | return |
38738401 | 587 | |
928e3819 | 588 | for piece in eddymsg_obj.payload_pieces: |
38738401 | 589 | |
0fd3389f | 590 | if piece.piece_type == TxtType.text: |
38738401 AE |
591 | # don't transform the plaintext. |
592 | pass | |
593 | ||
0fd3389f | 594 | elif piece.piece_type == TxtType.message: |
b4c116d5 AE |
595 | piece.gpg_data = GPGData() |
596 | ||
85a829fc | 597 | (plaintext_b, sigs, sigkey_missing) = decrypt_block(piece.string, gpgme_ctx) |
b4c116d5 AE |
598 | |
599 | piece.gpg_data.sigkey_missing = sigkey_missing | |
38738401 | 600 | |
85a829fc | 601 | if plaintext_b: |
b23e171d | 602 | piece.gpg_data.decrypted = True |
38738401 AE |
603 | piece.gpg_data.sigs = sigs |
604 | # recurse! | |
85a829fc | 605 | piece.gpg_data.plainobj = parse_pgp_mime(plaintext_b, gpgme_ctx) |
3a753fd0 AE |
606 | continue |
607 | ||
608 | # if not encrypted, check to see if this is an armored signature. | |
85a829fc | 609 | (plaintext_b, sigs, sigkey_missing) = verify_sig_message(piece.string, gpgme_ctx) |
b4c116d5 AE |
610 | |
611 | piece.gpg_data.sigkey_missing = sigkey_missing | |
3a753fd0 | 612 | |
85a829fc | 613 | if plaintext_b: |
0fd3389f | 614 | piece.piece_type = TxtType.signature |
3a753fd0 AE |
615 | piece.gpg_data.sigs = sigs |
616 | # recurse! | |
85a829fc | 617 | piece.gpg_data.plainobj = parse_pgp_mime(plaintext_b, gpgme_ctx) |
129543c3 | 618 | |
0fd3389f | 619 | elif piece.piece_type == TxtType.pubkey: |
f8ee6bd3 | 620 | key_fps = add_gpg_key(piece.string, gpgme_ctx) |
8f61c66a | 621 | |
f8ee6bd3 | 622 | if key_fps != []: |
8f61c66a | 623 | piece.gpg_data = GPGData() |
f8ee6bd3 | 624 | piece.gpg_data.keys = key_fps |
129543c3 | 625 | |
0fd3389f | 626 | elif piece.piece_type == TxtType.detachedsig: |
b4c116d5 AE |
627 | piece.gpg_data = GPGData() |
628 | ||
101d54a8 | 629 | for prev in prev_parts: |
b4c116d5 AE |
630 | (sig_fps, sigkey_missing) = verify_detached_signature(piece.string, prev.payload_bytes, gpgme_ctx) |
631 | ||
632 | piece.gpg_data.sigkey_missing = sigkey_missing | |
101d54a8 | 633 | |
6d240f68 | 634 | if sig_fps != []: |
6d240f68 AE |
635 | piece.gpg_data.sigs = sig_fps |
636 | piece.gpg_data.plainobj = prev | |
637 | break | |
7e18f14d | 638 | |
38738401 AE |
639 | else: |
640 | pass | |
641 | ||
642 | ||
928e3819 | 643 | def prepare_for_reply (eddymsg_obj, replyinfo_obj): |
67691346 AE |
644 | """Updates replyinfo_obj with info on the message's GPG success/failures |
645 | ||
646 | This function marks replyinfo_obj with information about whether encrypted | |
647 | text in eddymsg_obj was successfully decrypted, signatures were verified | |
648 | and whether a public key was found or not. | |
649 | ||
650 | Args: | |
651 | eddymsg_obj: a message in the EddyMsg format | |
652 | replyinfo_obj: an instance of ReplyInfo | |
653 | ||
654 | Returns: | |
655 | Nothing | |
656 | ||
657 | Pre: | |
658 | eddymsg_obj has had its gpg_data created by gpg_on_payloads | |
659 | ||
660 | Post: | |
661 | replyinfo_obj has been updated with info about decryption/sig | |
662 | verififcation status, etc. However the desired key isn't imported until | |
663 | later, so the success or failure of that updates the values set here. | |
664 | """ | |
dd11a483 | 665 | |
928e3819 | 666 | do_to_eddys_pieces(prepare_for_reply_pieces, eddymsg_obj, replyinfo_obj) |
56578eaf | 667 | |
928e3819 | 668 | def prepare_for_reply_pieces (eddymsg_obj, replyinfo_obj): |
67691346 AE |
669 | """A helper function for prepare_for_reply |
670 | ||
671 | It updates replyinfo_obj with GPG success/failure information, when | |
672 | supplied a single-part EddyMsg object. | |
673 | ||
674 | Args: | |
675 | eddymsg_obj: a single-part message in the EddyMsg format | |
676 | replyinfo_obj: an object which holds information about the message's | |
677 | GPG status | |
678 | ||
679 | Returns: | |
680 | Nothing | |
681 | ||
682 | Pre: | |
683 | eddymsg_obj is a single-part message. (it may be a part of a multi-part | |
684 | message.) It has had its gpg_data created by gpg_on_payloads if it has | |
685 | gpg data. | |
686 | ||
687 | Post: | |
688 | replyinfo_obj has been updated with gpg success/failure information | |
689 | """ | |
56578eaf | 690 | |
928e3819 | 691 | for piece in eddymsg_obj.payload_pieces: |
0fd3389f | 692 | if piece.piece_type == TxtType.text: |
d873ff48 AE |
693 | # don't quote the plaintext part. |
694 | pass | |
695 | ||
0fd3389f | 696 | elif piece.piece_type == TxtType.message: |
05683768 | 697 | prepare_for_reply_message(piece, replyinfo_obj) |
d873ff48 | 698 | |
0fd3389f | 699 | elif piece.piece_type == TxtType.pubkey: |
05683768 | 700 | prepare_for_reply_pubkey(piece, replyinfo_obj) |
6906d46d | 701 | |
0fd3389f AE |
702 | elif (piece.piece_type == TxtType.detachedsig) \ |
703 | or (piece.piece_type == TxtType.signature): | |
05683768 | 704 | prepare_for_reply_sig(piece, replyinfo_obj) |
d873ff48 | 705 | |
d873ff48 | 706 | |
05683768 | 707 | def prepare_for_reply_message (piece, replyinfo_obj): |
67691346 AE |
708 | """Helper function for prepare_for_reply() |
709 | ||
710 | This function is called when the piece_type of a payload piece is | |
9af26cb8 AE |
711 | TxtType.message, or GPG Message block. This should be encrypted text. If |
712 | the encryted block is correclty signed, a sig will be attached to | |
713 | .target_key unless there is already one there. | |
67691346 AE |
714 | |
715 | Args: | |
716 | piece: a PayloadPiece object. | |
717 | replyinfo_obj: object which gets updated with decryption status, etc. | |
718 | ||
67691346 AE |
719 | Returns: |
720 | Nothing | |
721 | ||
722 | Pre: | |
0fd3389f | 723 | the piece.payload_piece value should be TxtType.message. |
67691346 AE |
724 | |
725 | Post: | |
b4c116d5 AE |
726 | replyinfo_obj gets updated with decryption status, signing status, a |
727 | potential signing key, and posession status of the public key for the | |
728 | signature. | |
67691346 | 729 | """ |
44fe39b7 | 730 | |
b4c116d5 | 731 | if piece.gpg_data == None or piece.gpg_data.plainobj == None: |
4e2c66f7 | 732 | replyinfo_obj.decrypt_failure = True |
05683768 AE |
733 | return |
734 | ||
b4c116d5 | 735 | replyinfo_obj.decrypt_success = True |
05683768 AE |
736 | |
737 | # we already have a key (and a message) | |
738 | if replyinfo_obj.target_key != None: | |
739 | return | |
740 | ||
741 | if piece.gpg_data.sigs != []: | |
742 | replyinfo_obj.target_key = piece.gpg_data.sigs[0] | |
59003069 | 743 | replyinfo_obj.sig_success = True |
05683768 | 744 | get_signed_part = False |
b4c116d5 | 745 | |
05683768 | 746 | else: |
b4c116d5 AE |
747 | if piece.gpg_data.sigkey_missing == True: |
748 | replyinfo_obj.sigkey_missing = True | |
9af26cb8 | 749 | |
05683768 AE |
750 | # only include a signed message in the reply. |
751 | get_signed_part = True | |
752 | ||
8c3e5397 | 753 | flatten_decrypted_payloads(piece.gpg_data.plainobj, replyinfo_obj, get_signed_part) |
05683768 AE |
754 | |
755 | # to catch public keys in encrypted blocks | |
756 | prepare_for_reply(piece.gpg_data.plainobj, replyinfo_obj) | |
757 | ||
758 | ||
759 | def prepare_for_reply_pubkey (piece, replyinfo_obj): | |
67691346 AE |
760 | """Helper function for prepare_for_reply(). Marks pubkey import status. |
761 | ||
762 | Marks replyinfo_obj with pub key import status. | |
763 | ||
764 | Args: | |
765 | piece: a PayloadPiece object | |
766 | replyinfo_obj: a ReplyInfo object | |
767 | ||
768 | Pre: | |
0fd3389f | 769 | piece.piece_type should be set to TxtType.pubkey . |
67691346 AE |
770 | |
771 | Post: | |
772 | replyinfo_obj has its fields updated. | |
773 | """ | |
05683768 AE |
774 | |
775 | if piece.gpg_data == None or piece.gpg_data.keys == []: | |
b4c116d5 | 776 | pass |
05683768 | 777 | else: |
b4c116d5 | 778 | replyinfo_obj.pubkey_success = True |
05683768 | 779 | |
3ceb92e5 AE |
780 | # prefer public key as a fallback for the encrypted reply |
781 | replyinfo_obj.fallback_target_key = piece.gpg_data.keys[0] | |
05683768 AE |
782 | |
783 | ||
784 | def prepare_for_reply_sig (piece, replyinfo_obj): | |
67691346 AE |
785 | """Helper function for prepare_for_reply(). Marks sig verification status. |
786 | ||
787 | Marks replyinfo_obj with signature verification status. | |
788 | ||
789 | Args: | |
790 | piece: a PayloadPiece object | |
791 | replyinfo_obj: a ReplyInfo object | |
792 | ||
793 | Pre: | |
0fd3389f AE |
794 | piece.piece_type should be set to TxtType.signature, or |
795 | TxtType.detachedsig . | |
67691346 AE |
796 | |
797 | Post: | |
798 | replyinfo_obj has its fields updated. | |
799 | """ | |
05683768 AE |
800 | |
801 | if piece.gpg_data == None or piece.gpg_data.sigs == []: | |
32a8996f | 802 | replyinfo_obj.sig_failure = True |
b4c116d5 AE |
803 | |
804 | if piece.gpg_data.sigkey_missing == True: | |
805 | replyinfo_obj.sigkey_missing = True | |
806 | ||
05683768 AE |
807 | else: |
808 | replyinfo_obj.sig_success = True | |
809 | ||
810 | if replyinfo_obj.fallback_target_key == None: | |
811 | replyinfo_obj.fallback_target_key = piece.gpg_data.sigs[0] | |
6906d46d AE |
812 | |
813 | ||
8c3e5397 AE |
814 | def flatten_decrypted_payloads (eddymsg_obj, replyinfo_obj, get_signed_part): |
815 | """For creating a string representation of a signed, encrypted part. | |
39e2c525 | 816 | |
8c3e5397 AE |
817 | When given a decrypted payload, it will add either the plaintext or signed |
818 | plaintext to the reply message, depeding on 'get_signed_part'. This is | |
819 | useful for ensuring that the reply message only comes from a signed and | |
820 | ecrypted GPG message. It also sets the target_key for encrypting the reply | |
821 | if it's told to get signed text only. | |
39e2c525 AE |
822 | |
823 | Args: | |
824 | eddymsg_obj: the message in EddyMsg format created by decrypting GPG | |
825 | text | |
8c3e5397 AE |
826 | replyinfo_obj: a ReplyInfo object for holding the message to quote and |
827 | the target_key to encrypt to. | |
39e2c525 AE |
828 | get_signed_part: True if we should only include text that contains a |
829 | further signature. If False, then include plain text. | |
830 | ||
831 | Returns: | |
8c3e5397 | 832 | Nothing |
39e2c525 AE |
833 | |
834 | Pre: | |
835 | The EddyMsg instance passed in should be a piece.gpg_data.plainobj | |
836 | which represents decrypted text. It may or may not be signed on that | |
837 | level. | |
d873ff48 | 838 | |
8c3e5397 AE |
839 | Post: |
840 | the ReplyInfo instance may have a new 'target_key' set and its | |
841 | 'msg_to_quote' will be updated with (possibly signed) plaintext, if any | |
842 | could be found. | |
843 | """ | |
d873ff48 | 844 | |
0aa88c27 | 845 | if eddymsg_obj == None: |
8c3e5397 | 846 | return |
0aa88c27 | 847 | |
0402995a | 848 | # recurse on multi-part mime |
928e3819 AE |
849 | if eddymsg_obj.multipart == True: |
850 | for sub in eddymsg_obj.subparts: | |
8c3e5397 | 851 | flatten_decrypted_payloads(sub, replyinfo_obj, get_signed_part) |
d873ff48 | 852 | |
928e3819 | 853 | for piece in eddymsg_obj.payload_pieces: |
0402995a | 854 | if (get_signed_part): |
0fd3389f AE |
855 | if ((piece.piece_type == TxtType.detachedsig) \ |
856 | or (piece.piece_type == TxtType.signature)) \ | |
b4c116d5 AE |
857 | and (piece.gpg_data != None) \ |
858 | and (piece.gpg_data.plainobj != None): | |
8c3e5397 AE |
859 | flatten_decrypted_payloads(piece.gpg_data.plainobj, replyinfo_obj, False) |
860 | replyinfo_obj.target_key = piece.gpg_data.sigs[0] | |
c3d417bf AE |
861 | break |
862 | else: | |
0fd3389f | 863 | if piece.piece_type == TxtType.text: |
8c3e5397 | 864 | replyinfo_obj.msg_to_quote += piece.string |
d873ff48 AE |
865 | |
866 | ||
013f7cb8 | 867 | def get_key_from_fp (replyinfo_obj, gpgme_ctx): |
39e2c525 AE |
868 | """Obtains a public key object from a key fingerprint |
869 | ||
ca37d0cb AE |
870 | If the .target_key is not set, then we use .fallback_target_key, if |
871 | available. | |
39e2c525 AE |
872 | |
873 | Args: | |
874 | replyinfo_obj: ReplyInfo instance | |
875 | gpgme_ctx: the gpgme context | |
876 | ||
877 | Return: | |
878 | The key object of the key of either the target_key or the fallback one | |
879 | if .target_key is not set. If the key cannot be loaded, then return | |
880 | None. | |
881 | ||
882 | Pre: | |
883 | Loading a key requires that we have the public key imported. This | |
884 | requires that they email contains the pub key block, or that it was | |
885 | previously sent to edward. | |
886 | ||
887 | Post: | |
ca37d0cb AE |
888 | If the key can be loaded, then replyinfo_obj.reply_to_key points to the |
889 | public key object. If the key cannot be loaded, then the replyinfo_obj | |
890 | is marked as having no public key available. | |
39e2c525 | 891 | """ |
013f7cb8 | 892 | |
ca37d0cb AE |
893 | for key in (replyinfo_obj.target_key, replyinfo_obj.fallback_target_key): |
894 | if key != None: | |
895 | try: | |
896 | encrypt_to_key = gpgme_ctx.get_key(key) | |
897 | replyinfo_obj.encrypt_to_key = encrypt_to_key | |
b4c116d5 | 898 | replyinfo_obj.have_reply_key = True |
ca37d0cb | 899 | return |
013f7cb8 | 900 | |
ca37d0cb AE |
901 | except gpgme.GpgmeError: |
902 | pass | |
013f7cb8 | 903 | |
013f7cb8 | 904 | |
d873ff48 | 905 | def write_reply (replyinfo_obj): |
39e2c525 AE |
906 | """Write the reply email body about the GPG successes/failures. |
907 | ||
908 | The reply is about whether decryption, sig verification and key | |
909 | import/loading was successful or failed. If text was successfully decrypted | |
910 | and verified, then the first instance of such text will be included in | |
911 | quoted form. | |
912 | ||
913 | Args: | |
914 | replyinfo_obj: contains details of GPG processing status | |
915 | ||
916 | Returns: | |
917 | the plaintext message to be sent to the user | |
918 | ||
919 | Pre: | |
920 | replyinfo_obj should be populated with info about GPG processing status. | |
921 | """ | |
d873ff48 AE |
922 | |
923 | reply_plain = "" | |
924 | ||
cfcc211c AE |
925 | if (replyinfo_obj.pubkey_success == True): |
926 | reply_plain += replyinfo_obj.replies['greeting'] | |
927 | reply_plain += "\n\n" | |
928 | ||
371911ad | 929 | |
b4c116d5 | 930 | if replyinfo_obj.decrypt_success == True: |
234f607b | 931 | debug('decrypt success') |
d873ff48 | 932 | reply_plain += replyinfo_obj.replies['success_decrypt'] |
2694709a | 933 | |
b4c116d5 | 934 | if (replyinfo_obj.sig_success == True) and (replyinfo_obj.have_reply_key == True): |
234f607b | 935 | debug('message quoted') |
cfcc211c AE |
936 | reply_plain += replyinfo_obj.replies['space'] |
937 | reply_plain += replyinfo_obj.replies['quote_follows'] | |
938 | reply_plain += "\n\n" | |
2694709a AE |
939 | quoted_text = email_quote_text(replyinfo_obj.msg_to_quote) |
940 | reply_plain += quoted_text | |
cfcc211c AE |
941 | |
942 | reply_plain += "\n\n" | |
d873ff48 | 943 | |
4e2c66f7 | 944 | elif replyinfo_obj.decrypt_failure == True: |
234f607b | 945 | debug('decrypt failure') |
d873ff48 | 946 | reply_plain += replyinfo_obj.replies['failed_decrypt'] |
b4c116d5 | 947 | reply_plain += "\n\n" |
d873ff48 | 948 | |
371911ad | 949 | |
d873ff48 | 950 | if replyinfo_obj.sig_success == True: |
234f607b | 951 | debug('signature success') |
d873ff48 | 952 | reply_plain += replyinfo_obj.replies['sig_success'] |
b4c116d5 | 953 | reply_plain += "\n\n" |
d873ff48 | 954 | |
32a8996f | 955 | elif replyinfo_obj.sig_failure == True: |
234f607b | 956 | debug('signature failure') |
d873ff48 | 957 | reply_plain += replyinfo_obj.replies['sig_failure'] |
b4c116d5 | 958 | reply_plain += "\n\n" |
d873ff48 | 959 | |
371911ad | 960 | |
b4c116d5 | 961 | if (replyinfo_obj.pubkey_success == True): |
234f607b | 962 | debug('public key received') |
b4c116d5 | 963 | reply_plain += replyinfo_obj.replies['public_key_received'] |
d873ff48 | 964 | reply_plain += "\n\n" |
d873ff48 | 965 | |
b4c116d5 | 966 | elif (replyinfo_obj.sigkey_missing == True): |
234f607b | 967 | debug('no public key') |
b4c116d5 | 968 | reply_plain += replyinfo_obj.replies['no_public_key'] |
d873ff48 | 969 | reply_plain += "\n\n" |
d873ff48 AE |
970 | |
971 | ||
4e2c66f7 AE |
972 | if (reply_plain == ""): |
973 | debug('plaintext message') | |
974 | reply_plain += replyinfo_obj.replies['failed_decrypt'] | |
975 | reply_plain += "\n\n" | |
976 | ||
977 | ||
d873ff48 | 978 | reply_plain += replyinfo_obj.replies['signature'] |
b4c116d5 | 979 | reply_plain += "\n\n" |
56578eaf | 980 | |
d873ff48 | 981 | return reply_plain |
56578eaf AE |
982 | |
983 | ||
8f61c66a | 984 | def add_gpg_key (key_block, gpgme_ctx): |
39e2c525 AE |
985 | """Adds a GPG pubkey to the local keystore |
986 | ||
987 | This adds keys received through email into the key store so they can be | |
988 | used later. | |
989 | ||
990 | Args: | |
991 | key_block: the string form of the ascii-armored public key block | |
992 | gpgme_ctx: the gpgme context | |
993 | ||
994 | Returns: | |
995 | the fingerprint(s) of the imported key(s) | |
996 | """ | |
c267c233 | 997 | |
8f61c66a | 998 | fp = io.BytesIO(key_block.encode('ascii')) |
c267c233 | 999 | |
89c08329 AE |
1000 | try: |
1001 | result = gpgme_ctx.import_(fp) | |
1002 | imports = result.imports | |
1003 | except gpgme.GpgmeError: | |
1004 | imports = [] | |
c267c233 | 1005 | |
f8ee6bd3 | 1006 | key_fingerprints = [] |
c267c233 | 1007 | |
8f61c66a AE |
1008 | if imports != []: |
1009 | for import_ in imports: | |
1010 | fingerprint = import_[0] | |
f8ee6bd3 | 1011 | key_fingerprints += [fingerprint] |
c267c233 | 1012 | |
e49673aa | 1013 | debug("added gpg key: " + fingerprint) |
ec1e779a | 1014 | |
f8ee6bd3 | 1015 | return key_fingerprints |
ec1e779a AE |
1016 | |
1017 | ||
3a753fd0 | 1018 | def verify_sig_message (msg_block, gpgme_ctx): |
39e2c525 AE |
1019 | """Verifies the signature of a signed, ascii-armored block of text. |
1020 | ||
1021 | It encodes the string into ascii, since binary GPG files are currently | |
1022 | unsupported, and alternative, the ascii-armored format is encodable into | |
1023 | ascii. | |
1024 | ||
1025 | Args: | |
1026 | msg_block: a GPG Message block in string form. It may be encrypted or | |
1027 | not. If it is encrypted, it will return empty results. | |
1028 | gpgme_ctx: the gpgme context | |
1029 | ||
1030 | Returns: | |
85a829fc | 1031 | A tuple containing the plaintext bytes of the signed part, the list of |
9af26cb8 | 1032 | fingerprints of keys signing the data, and a boolean marking whether |
b4c116d5 AE |
1033 | edward is missing all public keys for validating any of the signatures. |
1034 | If verification failed, perhaps because the message was also encrypted, | |
1035 | then empty results are returned. | |
39e2c525 | 1036 | """ |
3a753fd0 AE |
1037 | |
1038 | block_b = io.BytesIO(msg_block.encode('ascii')) | |
1039 | plain_b = io.BytesIO() | |
1040 | ||
1041 | try: | |
1042 | sigs = gpgme_ctx.verify(block_b, None, plain_b) | |
5f6f32b1 | 1043 | except gpgme.GpgmeError: |
b4c116d5 | 1044 | return ("",[],False) |
3a753fd0 | 1045 | |
85a829fc | 1046 | plaintext_b = plain_b.getvalue() |
3a753fd0 | 1047 | |
b4c116d5 | 1048 | sigkey_missing = False |
3a753fd0 AE |
1049 | fingerprints = [] |
1050 | for sig in sigs: | |
8f011cc9 | 1051 | if (sig.summary == 0) or (sig.summary & gpgme.SIGSUM_VALID != 0) or (sig.summary & gpgme.SIGSUM_GREEN != 0): |
9af26cb8 | 1052 | fingerprints += [sig.fpr] |
b4c116d5 AE |
1053 | sigkey_missing = False |
1054 | break | |
9af26cb8 | 1055 | else: |
b4c116d5 AE |
1056 | if (sig.summary & gpgme.SIGSUM_KEY_MISSING != 0): |
1057 | sigkey_missing = True | |
9af26cb8 | 1058 | |
85a829fc | 1059 | return (plaintext_b, fingerprints, sigkey_missing) |
3a753fd0 AE |
1060 | |
1061 | ||
101d54a8 | 1062 | def verify_detached_signature (detached_sig, plaintext_bytes, gpgme_ctx): |
39e2c525 AE |
1063 | """Verifies the signature of a detached signature. |
1064 | ||
1065 | This requires the signature part and the signed part as separate arguments. | |
1066 | ||
1067 | Args: | |
1068 | detached_sig: the signature part of the detached signature | |
1069 | plaintext_bytes: the byte form of the message being signed. | |
1070 | gpgme_ctx: the gpgme context | |
1071 | ||
1072 | Returns: | |
9af26cb8 | 1073 | A tuple containging a list of signing fingerprints if the signature |
b4c116d5 AE |
1074 | verification was sucessful, and a boolean marking whether edward is |
1075 | missing all public keys for validating any of the signatures. | |
1076 | Otherwise, a tuple containing an empty list and True are returned. | |
39e2c525 | 1077 | """ |
101d54a8 AE |
1078 | |
1079 | detached_sig_fp = io.BytesIO(detached_sig.encode('ascii')) | |
1080 | plaintext_fp = io.BytesIO(plaintext_bytes) | |
101d54a8 | 1081 | |
ff7aeb3d AE |
1082 | try: |
1083 | result = gpgme_ctx.verify(detached_sig_fp, plaintext_fp, None) | |
1084 | except gpgme.GpgmeError: | |
b4c116d5 | 1085 | return ([],False) |
101d54a8 | 1086 | |
b4c116d5 | 1087 | sigkey_missing = False |
101d54a8 AE |
1088 | sig_fingerprints = [] |
1089 | for res_ in result: | |
8f011cc9 | 1090 | if (res_.summary == 0) or (res_.summary & gpgme.SIGSUM_VALID != 0) or (res_.summary & gpgme.SIGSUM_GREEN != 0): |
9af26cb8 | 1091 | sig_fingerprints += [res_.fpr] |
b4c116d5 AE |
1092 | sigkey_missing = False |
1093 | break | |
9af26cb8 | 1094 | else: |
b4c116d5 AE |
1095 | if (res_.summary & gpgme.SIGSUM_KEY_MISSING != 0): |
1096 | sigkey_missing = True | |
101d54a8 | 1097 | |
b4c116d5 | 1098 | return (sig_fingerprints, sigkey_missing) |
101d54a8 AE |
1099 | |
1100 | ||
5b3053c1 | 1101 | def decrypt_block (msg_block, gpgme_ctx): |
9af26cb8 | 1102 | """Decrypts a block of GPG text and verifies any included sigatures. |
39e2c525 AE |
1103 | |
1104 | Some encypted messages have embeded signatures, so those are verified too. | |
1105 | ||
1106 | Args: | |
1107 | msg_block: the encrypted(/signed) text | |
1108 | gpgme_ctx: the gpgme context | |
1109 | ||
1110 | Returns: | |
85a829fc | 1111 | A tuple containing plaintext bytes, signatures (if the decryption and |
9af26cb8 | 1112 | signature verification were successful, respectively), and a boolean |
b4c116d5 AE |
1113 | marking whether edward is missing all public keys for validating any of |
1114 | the signatures. | |
39e2c525 | 1115 | """ |
0bec96d6 | 1116 | |
5b3053c1 | 1117 | block_b = io.BytesIO(msg_block.encode('ascii')) |
0bec96d6 AE |
1118 | plain_b = io.BytesIO() |
1119 | ||
afc1f64c AE |
1120 | try: |
1121 | sigs = gpgme_ctx.decrypt_verify(block_b, plain_b) | |
5f6f32b1 | 1122 | except gpgme.GpgmeError: |
b4c116d5 | 1123 | return ("",[],False) |
0bec96d6 | 1124 | |
85a829fc | 1125 | plaintext_b = plain_b.getvalue() |
cbdf22c1 | 1126 | |
b4c116d5 | 1127 | sigkey_missing = False |
cbdf22c1 AE |
1128 | fingerprints = [] |
1129 | for sig in sigs: | |
8f011cc9 | 1130 | if (sig.summary == 0) or (sig.summary & gpgme.SIGSUM_VALID != 0) or (sig.summary & gpgme.SIGSUM_GREEN != 0): |
9af26cb8 | 1131 | fingerprints += [sig.fpr] |
b4c116d5 AE |
1132 | sigkey_missing = False |
1133 | break | |
9af26cb8 | 1134 | else: |
b4c116d5 AE |
1135 | if (sig.summary & gpgme.SIGSUM_KEY_MISSING != 0): |
1136 | sigkey_missing = True | |
9af26cb8 | 1137 | |
85a829fc | 1138 | return (plaintext_b, fingerprints, sigkey_missing) |
0bec96d6 AE |
1139 | |
1140 | ||
85a829fc | 1141 | def email_to_from_subject (email_bytes): |
dd2b62d7 | 1142 | """Returns the values of the email's To:, From: and Subject: fields |
fafa21c3 | 1143 | |
dd2b62d7 | 1144 | Returns this information from an email. |
fafa21c3 | 1145 | |
dd2b62d7 | 1146 | Args: |
85a829fc | 1147 | email_bytes: the byte string form of the email |
fafa21c3 | 1148 | |
dd2b62d7 AE |
1149 | Returns: |
1150 | the email To:, From:, and Subject: fields as strings | |
1151 | """ | |
d65993b8 | 1152 | |
85a829fc | 1153 | email_struct = email.parser.BytesParser().parsebytes(email_bytes) |
d65993b8 AE |
1154 | |
1155 | email_to = email_struct['To'] | |
1156 | email_from = email_struct['From'] | |
1157 | email_subject = email_struct['Subject'] | |
1158 | ||
1159 | return email_to, email_from, email_subject | |
1160 | ||
1161 | ||
bb27d257 AE |
1162 | def import_lang_pick_address(email_to, hostname): |
1163 | """Imports language file for i18n support; makes reply from address | |
dd2b62d7 AE |
1164 | |
1165 | The language imported depends on the To: address of the email received by | |
1166 | edward. an -en ending implies the English language, whereas a -ja ending | |
1167 | implies Japanese. The list of supported languages is listed in the 'langs' | |
bb27d257 AE |
1168 | list at the beginning of the program. This function also chooses the |
1169 | language-dependent address which can be used as the From address in the | |
1170 | reply email. | |
dd2b62d7 AE |
1171 | |
1172 | Args: | |
1173 | email_to: the string containing the email address that the mail was | |
bb27d257 AE |
1174 | sent to. |
1175 | hostname: the hostname part of the reply email's from address | |
dd2b62d7 AE |
1176 | |
1177 | Returns: | |
1178 | the reference to the imported language module. The only variable in | |
1179 | this file is the 'replies' dictionary. | |
1180 | """ | |
adcef2f7 | 1181 | |
bb27d257 AE |
1182 | # default |
1183 | use_lang = "en" | |
daed5f10 | 1184 | |
5250b3b8 AE |
1185 | if email_to != None: |
1186 | for lang in langs: | |
1187 | if "edward-" + lang in email_to: | |
bb27d257 AE |
1188 | use_lang = lang |
1189 | break | |
adcef2f7 | 1190 | |
bb27d257 AE |
1191 | lang_mod_name = "lang." + re.sub('-', '_', use_lang) |
1192 | lang_module = importlib.import_module(lang_mod_name) | |
1193 | ||
60ccbaf4 | 1194 | reply_from = "edward-" + use_lang + "@" + hostname |
bb27d257 | 1195 | |
60ccbaf4 | 1196 | return lang_module, reply_from |
adcef2f7 AE |
1197 | |
1198 | ||
cfb03389 | 1199 | def generate_encrypted_mime (plaintext, email_to, email_subject, encrypt_to_key, |
0a064403 | 1200 | gpgme_ctx): |
dd2b62d7 AE |
1201 | """This function creates the mime email reply. It can encrypt the email. |
1202 | ||
1203 | If the encrypt_key is included, then the email is encrypted and signed. | |
1204 | Otherwise it is unencrypted. | |
1205 | ||
1206 | Args: | |
1207 | plaintext: the plaintext body of the message to create. | |
cfb03389 | 1208 | email_to: the email address to reply to |
dd2b62d7 AE |
1209 | email_subject: the subject to use in reply |
1210 | encrypt_to_key: the key object to use for encrypting the email. (or | |
1211 | None) | |
1212 | gpgme_ctx: the gpgme context | |
1213 | ||
1214 | Returns | |
1215 | A string version of the mime message, possibly encrypted and signed. | |
1216 | """ | |
1da9b527 | 1217 | |
e5dd6f23 | 1218 | if (encrypt_to_key != None): |
8bdfb6d4 | 1219 | |
66a125ef AE |
1220 | plaintext_mime = MIMEText(plaintext) |
1221 | plaintext_mime.set_charset('utf-8') | |
8bdfb6d4 AE |
1222 | |
1223 | encrypted_text = encrypt_sign_message(plaintext_mime.as_string(), | |
1224 | encrypt_to_key, | |
40c37ab3 | 1225 | gpgme_ctx) |
8bdfb6d4 | 1226 | |
e5dd6f23 AE |
1227 | control_mime = MIMEApplication("Version: 1", |
1228 | _subtype='pgp-encrypted', | |
1229 | _encoder=email.encoders.encode_7or8bit) | |
1230 | control_mime['Content-Description'] = 'PGP/MIME version identification' | |
1231 | control_mime.set_charset('us-ascii') | |
8bdfb6d4 | 1232 | |
e5dd6f23 AE |
1233 | encoded_mime = MIMEApplication(encrypted_text, |
1234 | _subtype='octet-stream; name="encrypted.asc"', | |
1235 | _encoder=email.encoders.encode_7or8bit) | |
1236 | encoded_mime['Content-Description'] = 'OpenPGP encrypted message' | |
1237 | encoded_mime['Content-Disposition'] = 'inline; filename="encrypted.asc"' | |
1238 | encoded_mime.set_charset('us-ascii') | |
8bdfb6d4 | 1239 | |
e5dd6f23 AE |
1240 | message_mime = MIMEMultipart(_subtype="encrypted", protocol="application/pgp-encrypted") |
1241 | message_mime.attach(control_mime) | |
1242 | message_mime.attach(encoded_mime) | |
1243 | message_mime['Content-Disposition'] = 'inline' | |
216708e9 | 1244 | |
e5dd6f23 AE |
1245 | else: |
1246 | message_mime = MIMEText(plaintext) | |
66a125ef | 1247 | message_mime.set_charset('utf-8') |
2007103e | 1248 | |
cfb03389 | 1249 | message_mime['To'] = email_to |
2007103e AE |
1250 | message_mime['Subject'] = email_subject |
1251 | ||
1252 | reply = message_mime.as_string() | |
1da9b527 AE |
1253 | |
1254 | return reply | |
1255 | ||
1256 | ||
60ccbaf4 AE |
1257 | def send_reply(email_txt, subject, reply_to, reply_from): |
1258 | ||
1259 | email_bytes = email_txt.encode('ascii') | |
1260 | ||
1261 | p = subprocess.Popen(["/usr/sbin/sendmail", "-f", reply_from, "-F", "Edward, GPG Bot", "-i", reply_to], stdin=subprocess.PIPE) | |
1262 | ||
1263 | (stdout, stderr) = p.communicate(email_bytes) | |
1264 | ||
1265 | if stdout != None: | |
1266 | debug("sendmail stdout: " + str(stdout)) | |
1267 | if stderr != None: | |
1268 | error("sendmail stderr: " + str(stderr)) | |
1269 | ||
1270 | ||
f87041f8 | 1271 | def email_quote_text (text): |
dd2b62d7 AE |
1272 | """Quotes input text by inserting "> "s |
1273 | ||
1274 | This is useful for quoting a text for the reply message. It inserts "> " | |
1275 | strings at the beginning of lines. | |
1276 | ||
1277 | Args: | |
1278 | text: plain text to quote | |
1279 | ||
1280 | Returns: | |
1281 | Quoted text | |
1282 | """ | |
f87041f8 AE |
1283 | |
1284 | quoted_message = re.sub(r'^', r'> ', text, flags=re.MULTILINE) | |
1285 | ||
1286 | return quoted_message | |
1287 | ||
1288 | ||
0a064403 | 1289 | def encrypt_sign_message (plaintext, encrypt_to_key, gpgme_ctx): |
dd2b62d7 AE |
1290 | """Encrypts and signs plaintext |
1291 | ||
1292 | This encrypts and signs a message. | |
1293 | ||
1294 | Args: | |
1295 | plaintext: text to sign and ecrypt | |
1296 | encrypt_to_key: the key object to encrypt to | |
1297 | gpgme_ctx: the gpgme context | |
1298 | ||
1299 | Returns: | |
1300 | An encrypted and signed string of text | |
1301 | """ | |
897cbaf6 | 1302 | |
b33f601b | 1303 | # the plaintext should be mime encoded in an ascii-compatible form |
6aa41372 | 1304 | plaintext_bytes = io.BytesIO(plaintext.encode('ascii')) |
1da9b527 AE |
1305 | encrypted_bytes = io.BytesIO() |
1306 | ||
897cbaf6 | 1307 | gpgme_ctx.encrypt_sign([encrypt_to_key], gpgme.ENCRYPT_ALWAYS_TRUST, |
1da9b527 AE |
1308 | plaintext_bytes, encrypted_bytes) |
1309 | ||
6aa41372 | 1310 | encrypted_txt = encrypted_bytes.getvalue().decode('ascii') |
1da9b527 AE |
1311 | return encrypted_txt |
1312 | ||
1313 | ||
0a064403 | 1314 | def error (error_msg): |
dd2b62d7 AE |
1315 | """Write an error message to stdout |
1316 | ||
1317 | The error message includes the program name. | |
1318 | ||
1319 | Args: | |
1320 | error_msg: the message to print | |
1321 | ||
1322 | Returns: | |
1323 | Nothing | |
1324 | ||
1325 | Post: | |
1326 | An error message is printed to stdout | |
1327 | """ | |
0a064403 | 1328 | |
e4fb2ab2 | 1329 | sys.stderr.write(progname + ": " + str(error_msg) + "\n") |
0a064403 AE |
1330 | |
1331 | ||
5e8f9094 | 1332 | def debug (debug_msg): |
dd2b62d7 AE |
1333 | """Writes a debug message to stdout if debug == True |
1334 | ||
1335 | If the debug option is set in edward_config.py, then the passed message | |
1336 | gets printed to stdout. | |
1337 | ||
1338 | Args: | |
1339 | debug_msg: the message to print to stdout | |
1340 | ||
1341 | Returns: | |
1342 | Nothing | |
1343 | ||
1344 | Post: | |
1345 | A debug message is printed to stdout | |
1346 | """ | |
5e8f9094 AE |
1347 | |
1348 | if edward_config.debug == True: | |
0a064403 | 1349 | error(debug_msg) |
5e8f9094 AE |
1350 | |
1351 | ||
20f6e7c5 | 1352 | def handle_args (): |
60ccbaf4 | 1353 | """Sets the progname variable and processes optional argument |
dd2b62d7 | 1354 | |
60ccbaf4 AE |
1355 | If there are more than two arguments then edward complains and quits. An |
1356 | single "-p" argument sets the print_reply_only option, which makes edward | |
1357 | print email replies instead of mailing them. | |
dd2b62d7 AE |
1358 | |
1359 | Args: | |
1360 | None | |
1361 | ||
1362 | Returns: | |
60ccbaf4 AE |
1363 | True if edward should print arguments instead of mailing them, |
1364 | otherwise it returns False. | |
dd2b62d7 AE |
1365 | |
1366 | Post: | |
60ccbaf4 AE |
1367 | Exits with error 1 if there are more than two arguments, otherwise |
1368 | returns the print_reply_only option. | |
dd2b62d7 | 1369 | """ |
20f6e7c5 | 1370 | |
a51cdb72 AE |
1371 | global progname |
1372 | progname = sys.argv[0] | |
1373 | ||
60ccbaf4 AE |
1374 | print_reply_only = False |
1375 | ||
1376 | if len(sys.argv) > 2: | |
1377 | print(progname + " usage: " + progname + " [-p]\n\n" \ | |
1378 | + " -p print reply message to stdout, do not mail it\n", \ | |
1379 | file=sys.stderr) | |
a51cdb72 | 1380 | exit(1) |
20f6e7c5 | 1381 | |
60ccbaf4 AE |
1382 | elif (len(sys.argv) == 2) and (sys.argv[1] == "-p"): |
1383 | print_reply_only = True | |
1384 | ||
1385 | return print_reply_only | |
1386 | ||
20f6e7c5 | 1387 | |
a51cdb72 | 1388 | if __name__ == "__main__": |
dd2b62d7 | 1389 | """Executes main if this file is not loaded interactively""" |
20f6e7c5 | 1390 | |
a51cdb72 | 1391 | main() |
0bec96d6 | 1392 |