From: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
To: Notmuch Mail <notmuch@notmuchmail.org>
Subject: [PATCH v2 05/10] crypto: index encrypted parts when indexopts try_decrypt is set.
Date: Fri, 15 Sep 2017 01:53:54 -0400 [thread overview]
Message-ID: <20170915055359.24123-6-dkg@fifthhorseman.net> (raw)
In-Reply-To: <20170915055359.24123-1-dkg@fifthhorseman.net>
If we see index options that ask us to decrypt when indexing a
message, and we encounter an encrypted part, we'll try to descend into
it.
If we can decrypt, we add the property index-decryption=success.
If we can't decrypt (or recognize the encrypted type of mail), we add
the property index-decryption=failure.
Note that a single message may have both values of the
"index-decryption" property: "success" and "failure". For example,
consider a message that includes multiple layers of encryption. If we
manage to decrypt the outer layer ("index-decryption=success"), but
fail on the inner layer ("index-decryption=failure").
Before re-indexing, we wipe this automatically-added property, so that
it will subsequently correspond to the actual semantics of the stored
index.
---
lib/add-message.cc | 2 +-
lib/index.cc | 103 +++++++++++++++++++++++++++++++++++++++++++++-----
lib/message.cc | 14 ++++++-
lib/notmuch-private.h | 1 +
4 files changed, 107 insertions(+), 13 deletions(-)
diff --git a/lib/add-message.cc b/lib/add-message.cc
index 1fd91c14..66eb0a1f 100644
--- a/lib/add-message.cc
+++ b/lib/add-message.cc
@@ -544,7 +544,7 @@ notmuch_database_index_file (notmuch_database_t *notmuch,
if (!indexopts)
indexopts = def_indexopts = notmuch_database_get_default_indexopts (notmuch);
- ret = _notmuch_message_index_file (message, message_file);
+ ret = _notmuch_message_index_file (message, indexopts, message_file);
if (ret)
goto DONE;
diff --git a/lib/index.cc b/lib/index.cc
index ceb444df..285928f7 100644
--- a/lib/index.cc
+++ b/lib/index.cc
@@ -364,9 +364,17 @@ _index_content_type (notmuch_message_t *message, GMimeObject *part)
}
}
+static void
+_index_encrypted_mime_part (notmuch_message_t *message, notmuch_indexopts_t *indexopts,
+#if (GMIME_MAJOR_VERSION < 3)
+ GMimeContentType *content_type,
+#endif
+ GMimeMultipartEncrypted *part);
+
/* Callback to generate terms for each mime part of a message. */
static void
_index_mime_part (notmuch_message_t *message,
+ notmuch_indexopts_t *indexopts,
GMimeObject *part)
{
GMimeStream *stream, *filter;
@@ -409,17 +417,26 @@ _index_mime_part (notmuch_message_t *message,
}
}
if (GMIME_IS_MULTIPART_ENCRYPTED (multipart)) {
- /* Don't index encrypted parts, but index their content type. */
- _index_content_type (message,
- g_mime_multipart_get_part (multipart, i));
- if ((i != GMIME_MULTIPART_ENCRYPTED_VERSION) &&
- (i != GMIME_MULTIPART_ENCRYPTED_CONTENT)) {
- _notmuch_database_log (_notmuch_message_database (message),
- "Warning: Unexpected extra parts of multipart/encrypted.\n");
+ if (i == GMIME_MULTIPART_ENCRYPTED_CONTENT) {
+ _index_encrypted_mime_part(message, indexopts,
+#if (GMIME_MAJOR_VERSION < 3)
+ content_type,
+#endif
+ GMIME_MULTIPART_ENCRYPTED (part));
+ } else {
+ /* Don't index the non-content parts of an
+ * encrypted message, but do index their content
+ * type. */
+ _index_content_type (message,
+ g_mime_multipart_get_part (multipart, i));
+ if (i != GMIME_MULTIPART_ENCRYPTED_VERSION) {
+ _notmuch_database_log (_notmuch_message_database (message),
+ "Warning: Unexpected extra parts of multipart/encrypted.\n");
+ }
}
continue;
}
- _index_mime_part (message,
+ _index_mime_part (message, indexopts,
g_mime_multipart_get_part (multipart, i));
}
return;
@@ -430,7 +447,7 @@ _index_mime_part (notmuch_message_t *message,
mime_message = g_mime_message_part_get_message (GMIME_MESSAGE_PART (part));
- _index_mime_part (message, g_mime_message_get_mime_part (mime_message));
+ _index_mime_part (message, indexopts, g_mime_message_get_mime_part (mime_message));
return;
}
@@ -502,8 +519,74 @@ _index_mime_part (notmuch_message_t *message,
}
}
+/* descend (if desired) into the cleartext part of an encrypted MIME
+ * part while indexing. */
+static void
+_index_encrypted_mime_part (notmuch_message_t *message,
+ notmuch_indexopts_t *indexopts,
+#if (GMIME_MAJOR_VERSION < 3)
+ GMimeContentType *content_type,
+#endif
+ GMimeMultipartEncrypted *encrypted_data)
+{
+ notmuch_status_t status;
+#if (GMIME_MAJOR_VERSION < 3)
+ GMimeCryptoContext* crypto_ctx = NULL;
+ const char *protocol = NULL;
+#endif
+ GError *err = NULL;
+ notmuch_database_t * notmuch = NULL;
+ GMimeObject *clear = NULL;
+
+ if (!indexopts || !notmuch_indexopts_get_try_decrypt (indexopts))
+ return;
+
+ notmuch = _notmuch_message_database (message);
+
+#if (GMIME_MAJOR_VERSION < 3)
+ protocol = g_mime_content_type_get_parameter (content_type, "protocol");
+ status = _notmuch_crypto_get_gmime_ctx_for_protocol (&(indexopts->crypto),
+ protocol, &crypto_ctx);
+ if (status) {
+ _notmuch_database_log (notmuch, "Warning: setup failed for decrypting "
+ "during indexing. (%d)\n", status);
+ status = notmuch_message_add_property (message, "index-decryption", "failure");
+ if (status)
+ _notmuch_database_log (notmuch, "failed to add index-decryption "
+ "property (%d)\n", status);
+ return;
+ }
+#endif
+ /* we don't need the GMimeDecryptResult, because we're not looking
+ * at validating signatures, and we don't care about indexing who
+ * the message was ostensibly encrypted to.
+ */
+ clear = g_mime_multipart_encrypted_decrypt(encrypted_data, crypto_ctx,
+ NULL, &err);
+ if (err) {
+ _notmuch_database_log (notmuch, "Failed to decrypt during indexing. (%d:%d) [%s]\n",
+ err->domain, err->code, err->message);
+ g_error_free(err);
+ /* Indicate that we failed to decrypt during indexing */
+ status = notmuch_message_add_property (message, "index-decryption", "failure");
+ if (status)
+ _notmuch_database_log (notmuch, "failed to add index-decryption "
+ "property (%d)\n", status);
+ return;
+ }
+ _index_mime_part (message, indexopts, clear);
+ g_object_unref (clear);
+
+ status = notmuch_message_add_property (message, "index-decryption", "success");
+ if (status)
+ _notmuch_database_log (notmuch, "failed to add index-decryption "
+ "property (%d)\n", status);
+
+}
+
notmuch_status_t
_notmuch_message_index_file (notmuch_message_t *message,
+ notmuch_indexopts_t *indexopts,
notmuch_message_file_t *message_file)
{
GMimeMessage *mime_message;
@@ -531,7 +614,7 @@ _notmuch_message_index_file (notmuch_message_t *message,
subject = g_mime_message_get_subject (mime_message);
_notmuch_message_gen_terms (message, "subject", subject);
- _index_mime_part (message, g_mime_message_get_mime_part (mime_message));
+ _index_mime_part (message, indexopts, g_mime_message_get_mime_part (mime_message));
return NOTMUCH_STATUS_SUCCESS;
}
diff --git a/lib/message.cc b/lib/message.cc
index 0e3b5a4f..2ffa25a3 100644
--- a/lib/message.cc
+++ b/lib/message.cc
@@ -1961,7 +1961,7 @@ _notmuch_message_frozen (notmuch_message_t *message)
notmuch_status_t
notmuch_message_reindex (notmuch_message_t *message,
- notmuch_indexopts_t unused (*indexopts))
+ notmuch_indexopts_t *indexopts)
{
notmuch_database_t *notmuch = NULL;
notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
@@ -1969,6 +1969,7 @@ notmuch_message_reindex (notmuch_message_t *message,
notmuch_filenames_t *orig_filenames = NULL;
const char *orig_thread_id = NULL;
notmuch_message_file_t *message_file = NULL;
+ const char *autoproperties[] = { "index-decryption" };
int found = 0;
@@ -1999,6 +2000,15 @@ notmuch_message_reindex (notmuch_message_t *message,
goto DONE;
}
+ /* all automatically-added properties should be removed before re-indexing */
+ for (size_t i = 0; i < ARRAY_SIZE (autoproperties); i++) {
+ ret = notmuch_message_remove_all_properties (message, autoproperties[i]);
+ if (ret) {
+ INTERNAL_ERROR ("failed to remove automatically-added property '%s'", autoproperties[i]);
+ goto DONE;
+ }
+ }
+
/* re-add the filenames with the associated indexopts */
for (; notmuch_filenames_valid (orig_filenames);
notmuch_filenames_move_to_next (orig_filenames)) {
@@ -2038,7 +2048,7 @@ notmuch_message_reindex (notmuch_message_t *message,
if (found == 0)
_notmuch_message_set_header_values (message, date, from, subject);
- ret = _notmuch_message_index_file (message, message_file);
+ ret = _notmuch_message_index_file (message, indexopts, message_file);
if (ret == NOTMUCH_STATUS_FILE_ERROR)
continue;
diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h
index 3168cf3c..362106c8 100644
--- a/lib/notmuch-private.h
+++ b/lib/notmuch-private.h
@@ -447,6 +447,7 @@ _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
notmuch_status_t
_notmuch_message_index_file (notmuch_message_t *message,
+ notmuch_indexopts_t *indexopts,
notmuch_message_file_t *message_file);
/* messages.c */
--
2.14.1
next prev parent reply other threads:[~2017-09-15 5:54 UTC|newest]
Thread overview: 67+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-12 23:01 [PATCH 01/10] reorganize indexing of multipart/signed and multipart/encrypted Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 02/10] crypto: Move crypto.c into libutil Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 03/10] crypto: make shared crypto code behave library-like Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 04/10] tests: prepare for more crypto tests (using add_gnupg_home) Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 05/10] index: implement notmuch_indexopts_t with try_decrypt Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 06/10] crypto: index encrypted parts when indexopts try_decrypt is set Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 07/10] Define new config option index.try_decrypt Daniel Kahn Gillmor
2017-09-12 23:29 ` Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 08/10] add --try-decrypt=(true|false) to notmuch new Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 09/10] add --try-decrypt=(true|false) to notmuch insert Daniel Kahn Gillmor
2017-09-12 23:01 ` [PATCH 10/10] add --try-decrypt=(true|false) to notmuch reindex Daniel Kahn Gillmor
2017-09-15 5:53 ` cleartext-indexing Daniel Kahn Gillmor
2017-09-15 5:53 ` [PATCH v2 01/10] crypto: Move crypto.c into libutil Daniel Kahn Gillmor
2017-09-23 15:23 ` Jani Nikula
2017-09-15 5:53 ` [PATCH v2 02/10] crypto: make shared crypto code behave library-like Daniel Kahn Gillmor
2017-09-23 15:36 ` Jani Nikula
2017-10-10 3:33 ` Daniel Kahn Gillmor
2017-09-15 5:53 ` [PATCH v2 03/10] tests: prepare for more crypto tests (using add_gnupg_home) Daniel Kahn Gillmor
2017-09-23 15:38 ` Jani Nikula
2017-09-15 5:53 ` [PATCH v2 04/10] index: implement notmuch_indexopts_t with try_decrypt Daniel Kahn Gillmor
2017-09-23 16:10 ` Jani Nikula
2017-10-10 3:45 ` Daniel Kahn Gillmor
2017-10-14 12:40 ` Jani Nikula
2017-09-15 5:53 ` Daniel Kahn Gillmor [this message]
2017-09-23 16:05 ` [PATCH v2 05/10] crypto: index encrypted parts when indexopts try_decrypt is set Jani Nikula
2017-10-10 4:27 ` Daniel Kahn Gillmor
2017-09-15 5:53 ` [PATCH v2 06/10] config: indexing defaults will be stored in the database Daniel Kahn Gillmor
2017-09-15 5:53 ` [PATCH v2 07/10] config: define new option index.try_decrypt Daniel Kahn Gillmor
2017-09-23 16:17 ` Jani Nikula
2017-09-15 5:53 ` [PATCH v2 08/10] cli/new: add --try-decrypt=(true|false) Daniel Kahn Gillmor
2017-09-23 16:46 ` Jani Nikula
2017-09-15 5:53 ` [PATCH v2 09/10] cli/insert: " Daniel Kahn Gillmor
2017-09-15 5:53 ` [PATCH v2 10/10] cli/reindex: " Daniel Kahn Gillmor
2017-10-10 5:49 ` cleartext indexing, round 3 Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 01/15] crypto: rename notmuch_crypto_t to _notmuch_crypto_t Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 02/15] crypto: drop pretense of notmuch_crypto_context_t Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 03/15] crypto: _notmuch_crypto_cleanup should return void Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 04/15] crypto: move into libutil Daniel Kahn Gillmor
2017-10-12 10:54 ` David Bremner
2017-10-12 14:07 ` Daniel Kahn Gillmor
2017-10-12 21:07 ` David Bremner
2017-10-10 5:49 ` [PATCH v3 05/15] gmime-extra: remove duplicate GMimeAddressType typedef Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 06/15] crypto: make shared crypto code behave library-like Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 07/15] tests: prepare for more crypto tests (using add_gnupg_home) Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 08/15] index: implement notmuch_indexopts_t with try_decrypt Daniel Kahn Gillmor
2017-10-11 0:29 ` avoid double typedef Daniel Kahn Gillmor
2017-10-11 0:30 ` [PATCH v4 08/15] index: implement notmuch_indexopts_t with try_decrypt Daniel Kahn Gillmor
2017-10-12 11:18 ` David Bremner
2017-10-12 14:30 ` Daniel Kahn Gillmor
2017-10-11 6:22 ` avoid double typedef Tomi Ollila
2017-10-10 5:49 ` [PATCH v3 09/15] gmime-extra: drop compat layer for g_mime_multipart_encrypted_decrypt Daniel Kahn Gillmor
2017-10-14 14:02 ` David Bremner
2017-10-10 5:49 ` [PATCH v3 10/15] crypto: index encrypted parts when indexopts try_decrypt is set Daniel Kahn Gillmor
2017-10-13 1:08 ` David Bremner
2017-10-13 14:35 ` Daniel Kahn Gillmor
2017-10-13 15:19 ` David Bremner
2017-10-14 11:15 ` David Bremner
2017-10-10 5:49 ` [PATCH v3 11/15] config: indexing defaults will be stored in the database Daniel Kahn Gillmor
2017-10-14 18:08 ` David Bremner
2017-10-15 6:28 ` Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 12/15] config: define new option index.try_decrypt Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 13/15] cli/new: add --try-decrypt=(true|false) Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 14/15] cli/insert: " Daniel Kahn Gillmor
2017-10-10 5:49 ` [PATCH v3 15/15] cli/reindex: " Daniel Kahn Gillmor
2017-10-10 15:50 ` cleartext indexing, round 3 Jameson Graef Rollins
2017-10-10 16:47 ` Daniel Kahn Gillmor
2017-10-13 1:28 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170915055359.24123-6-dkg@fifthhorseman.net \
--to=dkg@fifthhorseman.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).