summaryrefslogtreecommitdiffstats
path: root/doc/man1
diff options
context:
space:
mode:
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>2017-12-08 01:24:00 -0500
committerDavid Bremner <david@tethera.net>2017-12-08 08:08:47 -0400
commit6a9626a2fdddf6115bcf97982fd10053bf48e942 (patch)
tree3c9170eb6a5ee966a9f348abcf60f1678364b778 /doc/man1
parent076f86025d519522cde5787def6c03fc308e8ebc (diff)
cli/reindex: destroy stashed session keys when --decrypt=false
There are some situations where the user wants to get rid of the cleartext index of a message. For example, if they're indexing encrypted messages normally, but suddenly they run across a message that they really don't want any trace of in their index. In that case, the natural thing to do is: notmuch reindex --decrypt=false id:whatever@example.biz But of course, clearing the cleartext index without clearing the stashed session key is just silly. So we do the expected thing and also destroy any stashed session keys while we're destroying the index of the cleartext. Note that stashed session keys are stored in the xapian database, but xapian does not currently allow safe deletion (see https://trac.xapian.org/ticket/742). As a workaround, after removing session keys and cleartext material from the database, the user probably should do something like "notmuch compact" to try to purge whatever recoverable data is left in the xapian freelist. This problem really needs to be addressed within xapian, though, if we want it fixed right.
Diffstat (limited to 'doc/man1')
-rw-r--r--doc/man1/notmuch-reindex.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/man1/notmuch-reindex.rst b/doc/man1/notmuch-reindex.rst
index d87e9d85..e8174f39 100644
--- a/doc/man1/notmuch-reindex.rst
+++ b/doc/man1/notmuch-reindex.rst
@@ -30,6 +30,9 @@ Supported options for **reindex** include
the user's secret keys. If decryption is successful, index
the cleartext itself.
+ If ``false``, notmuch reindex will also delete any stashed
+ session keys for all messages matching the search terms.
+
Be aware that the index is likely sufficient to reconstruct
the cleartext of the message itself, so please ensure that the
notmuch message index is adequately protected. DO NOT USE