1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
4 * Copyright © 2009 Keith Packard
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.
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.
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/ .
19 * Authors: Carl Worth <cworth@cworth.org>
20 * Keith Packard <keithp@keithp.com>
21 * Austin Clements <aclements@csail.mit.edu>
24 #include <sys/types.h>
28 #include "notmuch-client.h"
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
36 GMimeMessage *mime_message;
37 _notmuch_message_crypto_t *msg_crypto;
39 /* repaired/unmangled parts that will need to be cleaned up */
40 GSList *repaired_parts;
42 /* Context provided by the caller. */
43 _notmuch_crypto_t *crypto;
44 } mime_node_context_t;
47 _mime_node_context_free (mime_node_context_t *res)
49 if (res->mime_message)
50 g_object_unref (res->mime_message);
53 g_object_unref (res->parser);
56 g_object_unref (res->stream);
58 if (res->repaired_parts)
59 g_slist_free_full (res->repaired_parts, g_object_unref);
64 /* keep track of objects that need to be destroyed when the mime node
65 * context goes away. */
67 _mime_node_context_track_repaired_part (mime_node_context_t *ctx, GMimeObject *part)
70 ctx->repaired_parts = g_slist_prepend (ctx->repaired_parts, part);
73 const _notmuch_message_crypto_t *
74 mime_node_get_message_crypto_status (mime_node_t *node)
76 return node->ctx->msg_crypto;
80 mime_node_open (const void *ctx, notmuch_message_t *message,
82 _notmuch_crypto_t *crypto, mime_node_t **root_out)
84 const char *filename = notmuch_message_get_filename (message);
85 mime_node_context_t *mctx;
87 notmuch_status_t status;
90 root = talloc_zero (ctx, mime_node_t);
92 fprintf (stderr, "Out of memory.\n");
93 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
97 /* Create the tree-wide context */
98 mctx = talloc_zero (root, mime_node_context_t);
100 fprintf (stderr, "Out of memory.\n");
101 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
104 talloc_set_destructor (mctx, _mime_node_context_free);
108 fd = open (filename, O_RDONLY);
110 /* Slow path - Either we are trying to open a specific file, or
111 * for some reason the first file in the list is
112 * not available anymore. The latter is clearly a problem in the
113 * database, but we are not going to let this problem be a
115 notmuch_filenames_t *filenames;
118 for (filenames = notmuch_message_get_filenames (message);
119 notmuch_filenames_valid (filenames);
120 notmuch_filenames_move_to_next (filenames), i++) {
121 if (i >= duplicate) {
122 filename = notmuch_filenames_get (filenames);
123 fd = open (filename, O_RDONLY);
128 fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
129 status = NOTMUCH_STATUS_FILE_ERROR;
136 talloc_free (filenames);
139 fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
140 status = NOTMUCH_STATUS_FILE_ERROR;
145 mctx->stream = g_mime_stream_gzfile_new (fd);
146 if (! mctx->stream) {
147 fprintf (stderr, "Out of memory.\n");
148 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
152 mctx->parser = g_mime_parser_new_with_stream (mctx->stream);
153 if (! mctx->parser) {
154 fprintf (stderr, "Out of memory.\n");
155 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
159 mctx->mime_message = g_mime_parser_construct_message (mctx->parser, NULL);
160 if (! mctx->mime_message) {
161 fprintf (stderr, "Failed to parse %s\n", filename);
162 status = NOTMUCH_STATUS_FILE_ERROR;
166 mctx->msg_crypto = _notmuch_message_crypto_new (mctx);
168 mctx->crypto = crypto;
170 /* Create the root node */
171 root->part = GMIME_OBJECT (mctx->mime_message);
172 root->envelope_file = message;
178 root->next_child = 0;
179 root->next_part_num = 1;
182 return NOTMUCH_STATUS_SUCCESS;
189 /* Signature list destructor */
191 _signature_list_free (GMimeSignatureList **proxy)
193 g_object_unref (*proxy);
197 /* Set up signature list destructor */
199 set_signature_list_destructor (mime_node_t *node)
201 GMimeSignatureList **proxy = talloc (node, GMimeSignatureList *);
204 *proxy = node->sig_list;
205 talloc_set_destructor (proxy, _signature_list_free);
209 /* Unwrapped MIME part destructor */
211 _unwrapped_child_free (GMimeObject **proxy)
213 g_object_unref (*proxy);
217 /* Set up unwrapped MIME part destructor */
219 set_unwrapped_child_destructor (mime_node_t *node)
221 GMimeObject **proxy = talloc (node, GMimeObject *);
224 *proxy = node->unwrapped_child;
225 talloc_set_destructor (proxy, _unwrapped_child_free);
229 /* Verify a signed mime node */
231 node_verify (mime_node_t *node, GMimeObject *part)
234 notmuch_status_t status;
236 node->verify_attempted = true;
237 if (GMIME_IS_APPLICATION_PKCS7_MIME (part))
238 node->sig_list = g_mime_application_pkcs7_mime_verify (
239 GMIME_APPLICATION_PKCS7_MIME (part), GMIME_VERIFY_NONE, &node->unwrapped_child, &err);
241 node->sig_list = g_mime_multipart_signed_verify (
242 GMIME_MULTIPART_SIGNED (part), GMIME_VERIFY_NONE, &err);
244 if (node->unwrapped_child) {
246 set_unwrapped_child_destructor (node);
250 set_signature_list_destructor (node);
252 fprintf (stderr, "Failed to verify signed part: %s\n",
253 err ? err->message : "no error explanation given");
258 status = _notmuch_message_crypto_potential_sig_list (node->ctx->msg_crypto, node->sig_list);
259 if (status) /* this is a warning, not an error */
260 fprintf (stderr, "Warning: failed to note signature status: %s.\n", notmuch_status_to_string (
264 /* Decrypt and optionally verify an encrypted mime node */
266 node_decrypt_and_verify (mime_node_t *node, GMimeObject *part)
269 GMimeDecryptResult *decrypt_result = NULL;
270 notmuch_status_t status;
271 notmuch_message_t *message = NULL;
273 if (! node->unwrapped_child) {
274 for (mime_node_t *parent = node; parent; parent = parent->parent)
275 if (parent->envelope_file) {
276 message = parent->envelope_file;
280 node->unwrapped_child = _notmuch_crypto_decrypt (&node->decrypt_attempted,
281 node->ctx->crypto->decrypt,
283 part, &decrypt_result, &err);
284 if (node->unwrapped_child)
285 set_unwrapped_child_destructor (node);
287 if (! node->unwrapped_child) {
288 fprintf (stderr, "Failed to decrypt part: %s\n",
289 err ? err->message : "no error explanation given");
293 node->decrypt_success = true;
294 status = _notmuch_message_crypto_successful_decryption (node->ctx->msg_crypto);
295 if (status) /* this is a warning, not an error */
296 fprintf (stderr, "Warning: failed to note decryption status: %s.\n",
297 notmuch_status_to_string (status));
299 if (decrypt_result) {
300 /* This may be NULL if the part is not signed. */
301 node->sig_list = g_mime_decrypt_result_get_signatures (decrypt_result);
302 if (node->sig_list) {
303 node->verify_attempted = true;
304 g_object_ref (node->sig_list);
305 set_signature_list_destructor (node);
306 status = _notmuch_message_crypto_potential_sig_list (node->ctx->msg_crypto,
308 if (status) /* this is a warning, not an error */
309 fprintf (stderr, "Warning: failed to note signature status: %s.\n",
310 notmuch_status_to_string (status));
313 if (node->ctx->crypto->decrypt == NOTMUCH_DECRYPT_TRUE && message) {
314 notmuch_database_t *db = notmuch_message_get_database (message);
315 const char *session_key = g_mime_decrypt_result_get_session_key (decrypt_result);
316 if (db && session_key)
317 print_status_message ("Failed to stash session key in the database",
319 notmuch_message_add_property (message, "session-key",
322 g_object_unref (decrypt_result);
331 _mime_node_set_up_part (mime_node_t *node, GMimeObject *part, int numchild);
334 _mime_node_create (mime_node_t *parent, GMimeObject *part, int numchild)
336 mime_node_t *node = talloc_zero (parent, mime_node_t);
338 /* Set basic node properties */
339 node->ctx = parent->ctx;
340 if (! talloc_reference (node, node->ctx)) {
341 fprintf (stderr, "Out of memory.\n");
345 node->parent = parent;
346 node->part_num = node->next_part_num = -1;
347 node->next_child = 0;
349 if (_mime_node_set_up_part (node, part, numchild))
355 /* associate a MIME part with a node. */
357 _mime_node_set_up_part (mime_node_t *node, GMimeObject *part, int numchild)
359 /* Deal with the different types of parts */
360 if (GMIME_IS_PART (part)) {
363 } else if (GMIME_IS_MULTIPART (part)) {
364 GMimeObject *repaired_part = _notmuch_repair_mixed_up_mangled (part);
366 /* This was likely "Mixed Up" in transit! We replace it
367 * with the more likely-to-be-correct variant. */
368 _mime_node_context_track_repaired_part (node->ctx, repaired_part);
369 part = repaired_part;
372 node->nchildren = g_mime_multipart_get_count (GMIME_MULTIPART (part));
373 } else if (GMIME_IS_MESSAGE_PART (part)) {
374 /* Promote part to an envelope and open it */
375 GMimeMessagePart *message_part = GMIME_MESSAGE_PART (part);
376 GMimeMessage *message = g_mime_message_part_get_message (message_part);
377 node->envelope_part = message_part;
378 node->part = GMIME_OBJECT (message);
381 fprintf (stderr, "Warning: Unknown mime part type: %s.\n",
382 g_type_name (G_OBJECT_TYPE (part)));
386 /* Handle PGP/MIME parts (by definition not cryptographic payload parts) */
387 if (GMIME_IS_MULTIPART_ENCRYPTED (part) && (node->ctx->crypto->decrypt !=
388 NOTMUCH_DECRYPT_FALSE)) {
389 if (node->nchildren != 2) {
390 /* this violates RFC 3156 section 4, so we won't bother with it. */
391 fprintf (stderr, "Error: %d part(s) for a multipart/encrypted "
392 "message (must be exactly 2)\n",
395 node_decrypt_and_verify (node, part);
397 } else if (GMIME_IS_MULTIPART_SIGNED (part) && node->ctx->crypto->verify) {
398 if (node->nchildren != 2) {
399 /* this violates RFC 3156 section 5, so we won't bother with it. */
400 fprintf (stderr, "Error: %d part(s) for a multipart/signed message "
401 "(must be exactly 2)\n",
404 node_verify (node, part);
406 } else if (GMIME_IS_APPLICATION_PKCS7_MIME (part) &&
407 GMIME_SECURE_MIME_TYPE_SIGNED_DATA == g_mime_application_pkcs7_mime_get_smime_type (
408 GMIME_APPLICATION_PKCS7_MIME (part))) {
409 /* If node->ctx->crypto->verify is false, it would be better
410 * to just unwrap (instead of verifying), but
411 * https://github.com/jstedfast/gmime/issues/67 */
412 node_verify (node, part);
413 } else if (GMIME_IS_APPLICATION_PKCS7_MIME (part) &&
414 GMIME_SECURE_MIME_TYPE_ENVELOPED_DATA == g_mime_application_pkcs7_mime_get_smime_type (
415 GMIME_APPLICATION_PKCS7_MIME (part)) &&
416 (node->ctx->crypto->decrypt != NOTMUCH_DECRYPT_FALSE)) {
417 node_decrypt_and_verify (node, part);
418 if (node->unwrapped_child && node->nchildren == 0)
421 if (_notmuch_message_crypto_potential_payload (node->ctx->msg_crypto, part, node->parent ?
422 node->parent->part : NULL, numchild) &&
423 node->ctx->msg_crypto->decryption_status == NOTMUCH_MESSAGE_DECRYPTED_FULL) {
424 GMimeObject *clean_payload = _notmuch_repair_crypto_payload_skip_legacy_display (part);
425 if (clean_payload != part) {
426 /* only one layer of recursion is possible here
427 * because there can be only a single cryptographic
429 return _mime_node_set_up_part (node, clean_payload, numchild);
438 mime_node_child (mime_node_t *parent, int child)
443 if (! parent || ! parent->part || child < 0 || child >= parent->nchildren)
446 if (GMIME_IS_MULTIPART (parent->part)) {
447 if (child == GMIME_MULTIPART_ENCRYPTED_CONTENT && parent->unwrapped_child)
448 sub = parent->unwrapped_child;
450 sub = g_mime_multipart_get_part (
451 GMIME_MULTIPART (parent->part), child);
452 } else if (GMIME_IS_MESSAGE (parent->part)) {
453 sub = g_mime_message_get_mime_part (GMIME_MESSAGE (parent->part));
454 } else if (GMIME_IS_APPLICATION_PKCS7_MIME (parent->part) &&
455 parent->unwrapped_child &&
457 sub = parent->unwrapped_child;
459 /* This should have been caught by _mime_node_set_up_part */
460 INTERNAL_ERROR ("Unexpected GMimeObject type: %s",
461 g_type_name (G_OBJECT_TYPE (parent->part)));
463 node = _mime_node_create (parent, sub, child);
465 if (child == parent->next_child && parent->next_part_num != -1) {
466 /* We're traversing in depth-first order. Record the child's
467 * depth-first numbering. */
468 node->part_num = parent->next_part_num;
469 node->next_part_num = node->part_num + 1;
471 /* Prepare the parent for its next depth-first child. */
472 parent->next_child++;
473 parent->next_part_num = -1;
475 if (node->nchildren == 0) {
476 /* We've reached a leaf, so find the parent that has more
477 * children and set it up to number its next child. */
478 mime_node_t *iter = node->parent;
479 while (iter && iter->next_child == iter->nchildren)
482 iter->next_part_num = node->part_num + 1;
490 _mime_node_seek_dfs_walk (mime_node_t *node, int *n)
498 for (i = 0; i < node->nchildren; i++) {
499 mime_node_t *child = mime_node_child (node, i);
500 mime_node_t *ret = _mime_node_seek_dfs_walk (child, n);
510 mime_node_seek_dfs (mime_node_t *node, int n)
514 return _mime_node_seek_dfs_walk (node, &n);