[PATCH v3 11/16] add --try-decrypt to notmuch insert
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Sun, 31 Jan 2016 20:39:56 +0000 (15:39 +1900)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 23:20:58 +0000 (16:20 -0700)
1d/98e5a8af9aa200930c85c37e847dedf22bca1e [new file with mode: 0644]

diff --git a/1d/98e5a8af9aa200930c85c37e847dedf22bca1e b/1d/98e5a8af9aa200930c85c37e847dedf22bca1e
new file mode 100644 (file)
index 0000000..aae1bb3
--- /dev/null
@@ -0,0 +1,183 @@
+Return-Path: <dkg@fifthhorseman.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 4D8456DE1BA6\r
+ for <notmuch@notmuchmail.org>; Sun, 31 Jan 2016 12:40:24 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+ autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id 8a8Bg2AVcldU for <notmuch@notmuchmail.org>;\r
+ Sun, 31 Jan 2016 12:40:22 -0800 (PST)\r
+Received: from che.mayfirst.org (che.mayfirst.org [209.234.253.108])\r
+ by arlo.cworth.org (Postfix) with ESMTP id C84126DE1ADA\r
+ for <notmuch@notmuchmail.org>; Sun, 31 Jan 2016 12:40:09 -0800 (PST)\r
+Received: from fifthhorseman.net (ip-64-134-185-108.public.wayport.net\r
+ [64.134.185.108])\r
+ by che.mayfirst.org (Postfix) with ESMTPSA id DD782F9A2\r
+ for <notmuch@notmuchmail.org>; Sun, 31 Jan 2016 15:40:06 -0500 (EST)\r
+Received: by fifthhorseman.net (Postfix, from userid 1000)\r
+ id 548312106C; Sun, 31 Jan 2016 15:40:06 -0500 (EST)\r
+From: Daniel Kahn Gillmor <dkg@fifthhorseman.net>\r
+To: Notmuch Mail <notmuch@notmuchmail.org>\r
+Subject: [PATCH v3 11/16] add --try-decrypt to notmuch insert\r
+Date: Sun, 31 Jan 2016 15:39:56 -0500\r
+Message-Id: <1454272801-23623-12-git-send-email-dkg@fifthhorseman.net>\r
+X-Mailer: git-send-email 2.7.0.rc3\r
+In-Reply-To: <1454272801-23623-1-git-send-email-dkg@fifthhorseman.net>\r
+References: <1454272801-23623-1-git-send-email-dkg@fifthhorseman.net>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 31 Jan 2016 20:40:24 -0000\r
+\r
+allow an incoming message to be delivered while indexing the\r
+cleartext.\r
+\r
+This requires the secret keys for the message to be available.  For\r
+the moment, the most functional approach is to ensure that gpg-agent\r
+is running and knows about any secret keys that might be useful to\r
+decrypt incoming mail.\r
+\r
+Any additional recommendations for how to phrase the caveat for this\r
+option are welcome.\r
+\r
+If ~/.notmuch-config contains crypto.gpg_path, and gpg is needed for\r
+indexing, the configuration option will be used to find gpg.\r
+---\r
+ completion/notmuch-completion.bash |  2 +-\r
+ doc/man1/notmuch-insert.rst        | 11 +++++++++++\r
+ notmuch-insert.c                   | 32 +++++++++++++++++++++++++++++---\r
+ 3 files changed, 41 insertions(+), 4 deletions(-)\r
+\r
+diff --git a/completion/notmuch-completion.bash b/completion/notmuch-completion.bash\r
+index cc58392..4bc9040 100644\r
+--- a/completion/notmuch-completion.bash\r
++++ b/completion/notmuch-completion.bash\r
+@@ -224,7 +224,7 @@ _notmuch_insert()\r
+     ! $split &&\r
+     case "${cur}" in\r
+       --*)\r
+-          local options="--create-folder --folder= --keep --no-hooks ${_notmuch_shared_options}"\r
++          local options="--create-folder --folder= --keep --no-hooks --try-decrypt ${_notmuch_shared_options}"\r
+           compopt -o nospace\r
+           COMPREPLY=( $(compgen -W "$options" -- ${cur}) )\r
+           return\r
+diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst\r
+index 2c9c0d0..9c76b30 100644\r
+--- a/doc/man1/notmuch-insert.rst\r
++++ b/doc/man1/notmuch-insert.rst\r
+@@ -50,6 +50,17 @@ Supported options for **insert** include\r
+     ``--no-hooks``\r
+         Prevent hooks from being run.\r
\r
++    ``--try-decrypt``\r
++\r
++        If the message is encrypted, try to decrypt the message while\r
++        indexing.  If decryption is successful, index the cleartext\r
++        itself.  The message is stored to disk in its original form\r
++        (ciphertext).  Be aware that the index is likely sufficient to\r
++        reconstruct the cleartext of the message itself, so please\r
++        ensure that the notmuch message index is adequately\r
++        protected. DO NOT USE THIS FLAG without considering the\r
++        security of your index.\r
++\r
+ EXIT STATUS\r
+ ===========\r
\r
+diff --git a/notmuch-insert.c b/notmuch-insert.c\r
+index 5205c17..eae1ec5 100644\r
+--- a/notmuch-insert.c\r
++++ b/notmuch-insert.c\r
+@@ -378,12 +378,13 @@ FAIL:\r
+  */\r
+ static notmuch_status_t\r
+ add_file (notmuch_database_t *notmuch, const char *path, tag_op_list_t *tag_ops,\r
+-        notmuch_bool_t synchronize_flags, notmuch_bool_t keep)\r
++        notmuch_bool_t synchronize_flags, notmuch_bool_t keep,\r
++        notmuch_indexopts_t *indexopts)\r
+ {\r
+     notmuch_message_t *message;\r
+     notmuch_status_t status;\r
\r
+-    status = notmuch_database_add_message (notmuch, path, &message);\r
++    status = notmuch_database_add_message_with_indexopts (notmuch, path, indexopts, &message);\r
+     if (status == NOTMUCH_STATUS_SUCCESS) {\r
+       status = tag_op_list_apply (message, tag_ops, 0);\r
+       if (status) {\r
+@@ -455,17 +456,20 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])\r
+     notmuch_bool_t create_folder = FALSE;\r
+     notmuch_bool_t keep = FALSE;\r
+     notmuch_bool_t no_hooks = FALSE;\r
++    notmuch_bool_t try_decrypt = FALSE;\r
+     notmuch_bool_t synchronize_flags;\r
+     const char *maildir;\r
+     char *newpath;\r
+     int opt_index;\r
+     unsigned int i;\r
++    notmuch_indexopts_t *indexopts;\r
\r
+     notmuch_opt_desc_t options[] = {\r
+       { NOTMUCH_OPT_STRING, &folder, "folder", 0, 0 },\r
+       { NOTMUCH_OPT_BOOLEAN, &create_folder, "create-folder", 0, 0 },\r
+       { NOTMUCH_OPT_BOOLEAN, &keep, "keep", 0, 0 },\r
+       { NOTMUCH_OPT_BOOLEAN,  &no_hooks, "no-hooks", 'n', 0 },\r
++      { NOTMUCH_OPT_BOOLEAN,  &try_decrypt, "try-decrypt", 0, 0 },\r
+       { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },\r
+       { NOTMUCH_OPT_END, 0, 0, 0, 0 }\r
+     };\r
+@@ -545,8 +549,29 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])\r
+       return EXIT_FAILURE;\r
+     }\r
\r
++    indexopts = notmuch_indexopts_create ();\r
++    if (!indexopts) {\r
++      fprintf (stderr, "Error: could not create index options.\n");\r
++      return EXIT_FAILURE;\r
++    }\r
++    status = notmuch_indexopts_set_try_decrypt (indexopts, try_decrypt);\r
++    if (status != NOTMUCH_STATUS_SUCCESS) {\r
++      fprintf (stderr, "Error: Failed to set try_decrypt to %s. (%s)\n",\r
++               try_decrypt ? "True" : "False", notmuch_status_to_string (status));\r
++      notmuch_indexopts_destroy (indexopts);\r
++      return EXIT_FAILURE;\r
++    }\r
++    if (try_decrypt) {\r
++      const char* gpg_path = notmuch_config_get_crypto_gpg_path (config);\r
++      status = notmuch_indexopts_set_gpg_path (indexopts, gpg_path);\r
++      if (status)\r
++          fprintf (stderr, "Warning: failed to set database gpg_path to '%s' (%s)\n",\r
++                   gpg_path ? gpg_path : "(NULL)",\r
++                   notmuch_status_to_string (status));\r
++    }\r
++\r
+     /* Index the message. */\r
+-    status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep);\r
++    status = add_file (notmuch, newpath, tag_ops, synchronize_flags, keep, indexopts);\r
\r
+     /* Commit changes. */\r
+     close_status = notmuch_database_destroy (notmuch);\r
+@@ -577,5 +602,6 @@ notmuch_insert_command (notmuch_config_t *config, int argc, char *argv[])\r
+       notmuch_run_hook (db_path, "post-insert");\r
+     }\r
\r
++    notmuch_indexopts_destroy (indexopts);\r
+     return status ? EXIT_FAILURE : EXIT_SUCCESS;\r
+ }\r
+-- \r
+2.7.0.rc3\r
+\r