c2ee858d3c89b9aefa2e4ebd132371a9fb3b42c6
[notmuch] / mime-node.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  * Copyright © 2009 Keith Packard
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see https://www.gnu.org/licenses/ .
18  *
19  * Authors: Carl Worth <cworth@cworth.org>
20  *          Keith Packard <keithp@keithp.com>
21  *          Austin Clements <aclements@csail.mit.edu>
22  */
23
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <fcntl.h>
27
28 #include "notmuch-client.h"
29
30 /* Context that gets inherited from the root node. */
31 typedef struct mime_node_context {
32     /* Per-message resources.  These are allocated internally and must
33      * be destroyed. */
34     GMimeStream *stream;
35     GMimeParser *parser;
36     GMimeMessage *mime_message;
37     _notmuch_message_crypto_t *msg_crypto;
38
39     /* repaired/unmangled parts that will need to be cleaned up */
40     GSList *repaired_parts;
41
42     /* Context provided by the caller. */
43     _notmuch_crypto_t *crypto;
44 } mime_node_context_t;
45
46 static int
47 _mime_node_context_free (mime_node_context_t *res)
48 {
49     if (res->mime_message)
50         g_object_unref (res->mime_message);
51
52     if (res->parser)
53         g_object_unref (res->parser);
54
55     if (res->stream)
56         g_object_unref (res->stream);
57
58     if (res->repaired_parts)
59         g_slist_free_full (res->repaired_parts, g_object_unref);
60
61     return 0;
62 }
63
64 /* keep track of objects that need to be destroyed when the mime node
65  * context goes away. */
66 static void
67 _mime_node_context_track_repaired_part (mime_node_context_t *ctx, GMimeObject *part)
68 {
69     if (part)
70         ctx->repaired_parts = g_slist_prepend (ctx->repaired_parts, part);
71 }
72
73 const _notmuch_message_crypto_t *
74 mime_node_get_message_crypto_status (mime_node_t *node)
75 {
76     return node->ctx->msg_crypto;
77 }
78
79 notmuch_status_t
80 mime_node_open (const void *ctx, notmuch_message_t *message,
81                 _notmuch_crypto_t *crypto, mime_node_t **root_out)
82 {
83     const char *filename = notmuch_message_get_filename (message);
84     mime_node_context_t *mctx;
85     mime_node_t *root;
86     notmuch_status_t status;
87     int fd;
88
89     root = talloc_zero (ctx, mime_node_t);
90     if (root == NULL) {
91         fprintf (stderr, "Out of memory.\n");
92         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
93         goto DONE;
94     }
95
96     /* Create the tree-wide context */
97     mctx = talloc_zero (root, mime_node_context_t);
98     if (mctx == NULL) {
99         fprintf (stderr, "Out of memory.\n");
100         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
101         goto DONE;
102     }
103     talloc_set_destructor (mctx, _mime_node_context_free);
104
105     /* Fast path */
106     fd = open (filename, O_RDONLY);
107     if (fd == -1) {
108         /* Slow path - for some reason the first file in the list is
109          * not available anymore. This is clearly a problem in the
110          * database, but we are not going to let this problem be a
111          * show stopper */
112         notmuch_filenames_t *filenames;
113         for (filenames = notmuch_message_get_filenames (message);
114              notmuch_filenames_valid (filenames);
115              notmuch_filenames_move_to_next (filenames)) {
116             filename = notmuch_filenames_get (filenames);
117             fd = open (filename, O_RDONLY);
118             if (fd != -1)
119                 break;
120         }
121
122         talloc_free (filenames);
123         if (fd == -1) {
124             /* Give up */
125             fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
126             status = NOTMUCH_STATUS_FILE_ERROR;
127             goto DONE;
128         }
129     }
130
131     mctx->stream = g_mime_stream_gzfile_new (fd);
132     if (! mctx->stream) {
133         fprintf (stderr, "Out of memory.\n");
134         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
135         goto DONE;
136     }
137
138     mctx->parser = g_mime_parser_new_with_stream (mctx->stream);
139     if (! mctx->parser) {
140         fprintf (stderr, "Out of memory.\n");
141         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
142         goto DONE;
143     }
144
145     mctx->mime_message = g_mime_parser_construct_message (mctx->parser, NULL);
146     if (! mctx->mime_message) {
147         fprintf (stderr, "Failed to parse %s\n", filename);
148         status = NOTMUCH_STATUS_FILE_ERROR;
149         goto DONE;
150     }
151
152     mctx->msg_crypto = _notmuch_message_crypto_new (mctx);
153
154     mctx->crypto = crypto;
155
156     /* Create the root node */
157     root->part = GMIME_OBJECT (mctx->mime_message);
158     root->envelope_file = message;
159     root->nchildren = 1;
160     root->ctx = mctx;
161
162     root->parent = NULL;
163     root->part_num = 0;
164     root->next_child = 0;
165     root->next_part_num = 1;
166
167     *root_out = root;
168     return NOTMUCH_STATUS_SUCCESS;
169
170   DONE:
171     talloc_free (root);
172     return status;
173 }
174
175 /* Signature list destructor */
176 static int
177 _signature_list_free (GMimeSignatureList **proxy)
178 {
179     g_object_unref (*proxy);
180     return 0;
181 }
182
183 /* Set up signature list destructor */
184 static void
185 set_signature_list_destructor (mime_node_t *node)
186 {
187     GMimeSignatureList **proxy = talloc (node, GMimeSignatureList *);
188
189     if (proxy) {
190         *proxy = node->sig_list;
191         talloc_set_destructor (proxy, _signature_list_free);
192     }
193 }
194
195 /* Unwrapped MIME part destructor */
196 static int
197 _unwrapped_child_free (GMimeObject **proxy)
198 {
199     g_object_unref (*proxy);
200     return 0;
201 }
202
203 /* Set up unwrapped MIME part destructor */
204 static void
205 set_unwrapped_child_destructor (mime_node_t *node)
206 {
207     GMimeObject **proxy = talloc (node, GMimeObject *);
208
209     if (proxy) {
210         *proxy = node->unwrapped_child;
211         talloc_set_destructor (proxy, _unwrapped_child_free);
212     }
213 }
214
215 /* Verify a signed mime node */
216 static void
217 node_verify (mime_node_t *node, GMimeObject *part)
218 {
219     GError *err = NULL;
220     notmuch_status_t status;
221
222     node->verify_attempted = true;
223     if (GMIME_IS_APPLICATION_PKCS7_MIME (part))
224         node->sig_list = g_mime_application_pkcs7_mime_verify (
225             GMIME_APPLICATION_PKCS7_MIME (part), GMIME_VERIFY_NONE, &node->unwrapped_child, &err);
226     else
227         node->sig_list = g_mime_multipart_signed_verify (
228             GMIME_MULTIPART_SIGNED (part), GMIME_VERIFY_NONE, &err);
229
230     if (node->unwrapped_child) {
231         node->nchildren = 1;
232         set_unwrapped_child_destructor (node);
233     }
234
235     if (node->sig_list)
236         set_signature_list_destructor (node);
237     else
238         fprintf (stderr, "Failed to verify signed part: %s\n",
239                  err ? err->message : "no error explanation given");
240
241     if (err)
242         g_error_free (err);
243
244     status = _notmuch_message_crypto_potential_sig_list (node->ctx->msg_crypto, node->sig_list);
245     if (status) /* this is a warning, not an error */
246         fprintf (stderr, "Warning: failed to note signature status: %s.\n", notmuch_status_to_string (status));
247 }
248
249 /* Decrypt and optionally verify an encrypted mime node */
250 static void
251 node_decrypt_and_verify (mime_node_t *node, GMimeObject *part)
252 {
253     GError *err = NULL;
254     GMimeDecryptResult *decrypt_result = NULL;
255     notmuch_status_t status;
256     notmuch_message_t *message = NULL;
257
258     if (! node->unwrapped_child) {
259         for (mime_node_t *parent = node; parent; parent = parent->parent)
260             if (parent->envelope_file) {
261                 message = parent->envelope_file;
262                 break;
263             }
264
265         node->unwrapped_child = _notmuch_crypto_decrypt (&node->decrypt_attempted,
266                                                          node->ctx->crypto->decrypt,
267                                                          message,
268                                                          part, &decrypt_result, &err);
269         if (node->unwrapped_child)
270             set_unwrapped_child_destructor (node);
271     }
272     if (! node->unwrapped_child) {
273         fprintf (stderr, "Failed to decrypt part: %s\n",
274                  err ? err->message : "no error explanation given");
275         goto DONE;
276     }
277
278     node->decrypt_success = true;
279     status = _notmuch_message_crypto_successful_decryption (node->ctx->msg_crypto);
280     if (status) /* this is a warning, not an error */
281         fprintf (stderr, "Warning: failed to note decryption status: %s.\n", notmuch_status_to_string (status));
282
283     if (decrypt_result) {
284         /* This may be NULL if the part is not signed. */
285         node->sig_list = g_mime_decrypt_result_get_signatures (decrypt_result);
286         if (node->sig_list) {
287             node->verify_attempted = true;
288             g_object_ref (node->sig_list);
289             set_signature_list_destructor (node);
290             status = _notmuch_message_crypto_potential_sig_list (node->ctx->msg_crypto, node->sig_list);
291             if (status) /* this is a warning, not an error */
292                 fprintf (stderr, "Warning: failed to note signature status: %s.\n", notmuch_status_to_string (status));
293         }
294
295         if (node->ctx->crypto->decrypt == NOTMUCH_DECRYPT_TRUE && message) {
296             notmuch_database_t *db = notmuch_message_get_database (message);
297             const char *session_key = g_mime_decrypt_result_get_session_key (decrypt_result);
298             if (db && session_key)
299                 print_status_message ("Failed to stash session key in the database",
300                                       message,
301                                       notmuch_message_add_property (message, "session-key",
302                                                                     session_key));
303         }
304         g_object_unref (decrypt_result);
305     }
306
307   DONE:
308     if (err)
309         g_error_free (err);
310 }
311
312 static bool
313 _mime_node_set_up_part (mime_node_t *node, GMimeObject *part, int numchild);
314
315 static mime_node_t *
316 _mime_node_create (mime_node_t *parent, GMimeObject *part, int numchild)
317 {
318     mime_node_t *node = talloc_zero (parent, mime_node_t);
319
320     /* Set basic node properties */
321     node->ctx = parent->ctx;
322     if (! talloc_reference (node, node->ctx)) {
323         fprintf (stderr, "Out of memory.\n");
324         talloc_free (node);
325         return NULL;
326     }
327     node->parent = parent;
328     node->part_num = node->next_part_num = -1;
329     node->next_child = 0;
330
331     if (_mime_node_set_up_part (node, part, numchild))
332         return node;
333     talloc_free (node);
334     return NULL;
335 }
336
337 /* associate a MIME part with a node. */
338 static bool
339 _mime_node_set_up_part (mime_node_t *node, GMimeObject *part, int numchild)
340 {
341     /* Deal with the different types of parts */
342     if (GMIME_IS_PART (part)) {
343         node->part = part;
344         node->nchildren = 0;
345     } else if (GMIME_IS_MULTIPART (part)) {
346         GMimeObject *repaired_part = _notmuch_repair_mixed_up_mangled (part);
347         if (repaired_part) {
348             /* This was likely "Mixed Up" in transit!  We replace it
349              * with the more likely-to-be-correct variant. */
350             _mime_node_context_track_repaired_part (node->ctx, repaired_part);
351             part = repaired_part;
352         }
353         node->part = part;
354         node->nchildren = g_mime_multipart_get_count (GMIME_MULTIPART (part));
355     } else if (GMIME_IS_MESSAGE_PART (part)) {
356         /* Promote part to an envelope and open it */
357         GMimeMessagePart *message_part = GMIME_MESSAGE_PART (part);
358         GMimeMessage *message = g_mime_message_part_get_message (message_part);
359         node->envelope_part = message_part;
360         node->part = GMIME_OBJECT (message);
361         node->nchildren = 1;
362     } else {
363         fprintf (stderr, "Warning: Unknown mime part type: %s.\n",
364                  g_type_name (G_OBJECT_TYPE (part)));
365         return false;
366     }
367
368     /* Handle PGP/MIME parts (by definition not cryptographic payload parts) */
369     if (GMIME_IS_MULTIPART_ENCRYPTED (part) && (node->ctx->crypto->decrypt != NOTMUCH_DECRYPT_FALSE)) {
370         if (node->nchildren != 2) {
371             /* this violates RFC 3156 section 4, so we won't bother with it. */
372             fprintf (stderr, "Error: %d part(s) for a multipart/encrypted "
373                      "message (must be exactly 2)\n",
374                      node->nchildren);
375         } else {
376             node_decrypt_and_verify (node, part);
377         }
378     } else if (GMIME_IS_MULTIPART_SIGNED (part) && node->ctx->crypto->verify) {
379         if (node->nchildren != 2) {
380             /* this violates RFC 3156 section 5, so we won't bother with it. */
381             fprintf (stderr, "Error: %d part(s) for a multipart/signed message "
382                      "(must be exactly 2)\n",
383                      node->nchildren);
384         } else {
385             node_verify (node, part);
386         }
387     } else if (GMIME_IS_APPLICATION_PKCS7_MIME (part) &&
388                GMIME_SECURE_MIME_TYPE_SIGNED_DATA == g_mime_application_pkcs7_mime_get_smime_type (GMIME_APPLICATION_PKCS7_MIME (part))) {
389         /* If node->ctx->crypto->verify is false, it would be better
390          * to just unwrap (instead of verifying), but
391          * https://github.com/jstedfast/gmime/issues/67 */
392         node_verify (node, part);
393     } else {
394         if (_notmuch_message_crypto_potential_payload (node->ctx->msg_crypto, part, node->parent ? node->parent->part : NULL, numchild) &&
395             node->ctx->msg_crypto->decryption_status == NOTMUCH_MESSAGE_DECRYPTED_FULL) {
396             GMimeObject *clean_payload = _notmuch_repair_crypto_payload_skip_legacy_display (part);
397             if (clean_payload != part) {
398                 /* only one layer of recursion is possible here
399                  * because there can be only a single cryptographic
400                  * payload: */
401                 return _mime_node_set_up_part (node, clean_payload, numchild);
402             }
403         }
404     }
405
406     return true;
407 }
408
409 mime_node_t *
410 mime_node_child (mime_node_t *parent, int child)
411 {
412     GMimeObject *sub;
413     mime_node_t *node;
414
415     if (! parent || ! parent->part || child < 0 || child >= parent->nchildren)
416         return NULL;
417
418     if (GMIME_IS_MULTIPART (parent->part)) {
419         if (child == GMIME_MULTIPART_ENCRYPTED_CONTENT && parent->unwrapped_child)
420             sub = parent->unwrapped_child;
421         else
422             sub = g_mime_multipart_get_part (
423                 GMIME_MULTIPART (parent->part), child);
424     } else if (GMIME_IS_MESSAGE (parent->part)) {
425         sub = g_mime_message_get_mime_part (GMIME_MESSAGE (parent->part));
426     } else if (GMIME_IS_APPLICATION_PKCS7_MIME (parent->part) &&
427                parent->unwrapped_child &&
428                child == 0) {
429         sub = parent->unwrapped_child;
430     } else {
431         /* This should have been caught by _mime_node_set_up_part */
432         INTERNAL_ERROR ("Unexpected GMimeObject type: %s",
433                         g_type_name (G_OBJECT_TYPE (parent->part)));
434     }
435     node = _mime_node_create (parent, sub, child);
436
437     if (child == parent->next_child && parent->next_part_num != -1) {
438         /* We're traversing in depth-first order.  Record the child's
439          * depth-first numbering. */
440         node->part_num = parent->next_part_num;
441         node->next_part_num = node->part_num + 1;
442
443         /* Prepare the parent for its next depth-first child. */
444         parent->next_child++;
445         parent->next_part_num = -1;
446
447         if (node->nchildren == 0) {
448             /* We've reached a leaf, so find the parent that has more
449              * children and set it up to number its next child. */
450             mime_node_t *iter = node->parent;
451             while (iter && iter->next_child == iter->nchildren)
452                 iter = iter->parent;
453             if (iter)
454                 iter->next_part_num = node->part_num + 1;
455         }
456     }
457
458     return node;
459 }
460
461 static mime_node_t *
462 _mime_node_seek_dfs_walk (mime_node_t *node, int *n)
463 {
464     int i;
465
466     if (*n == 0)
467         return node;
468
469     *n -= 1;
470     for (i = 0; i < node->nchildren; i++) {
471         mime_node_t *child = mime_node_child (node, i);
472         mime_node_t *ret = _mime_node_seek_dfs_walk (child, n);
473         if (ret)
474             return ret;
475
476         talloc_free (child);
477     }
478     return NULL;
479 }
480
481 mime_node_t *
482 mime_node_seek_dfs (mime_node_t *node, int n)
483 {
484     if (n < 0)
485         return NULL;
486     return _mime_node_seek_dfs_walk (node, &n);
487 }