crypto: actually stash session keys when decrypt=true
[notmuch] / doc / man7 / notmuch-properties.rst
1 ==================
2 notmuch-properties
3 ==================
4
5 SYNOPSIS
6 ========
7
8 **notmuch** **count** **property:**\ <*key*>=<*value*>
9
10 **notmuch** **search** **property:**\ <*key*>=<*value*>
11
12 **notmuch** **show** **property:**\ <*key*>=<*value*>
13
14 **notmuch** **reindex** **property:**\ <*key*>=<*value*>
15
16 **notmuch** **tag** +<*tag*> **property:**\ <*key*>=<*value*>
17
18
19 **notmuch** **dump** **--include=properties**
20
21 **notmuch** **restore** **--include=properties**
22
23 DESCRIPTION
24 ===========
25
26 Several notmuch commands can search for, modify, add or remove
27 properties associated with specific messages.  Properties are
28 key/value pairs, and a message can have more than one key/value pair
29 for the same key.
30
31 While users can select based on a specific property in their search
32 terms with the prefix **property:**, the notmuch command-line
33 interface does not provide mechanisms for modifying properties
34 directly to the user.
35
36 Instead, message properties are expected to be set and used
37 programmatically, according to logic in notmuch itself, or in
38 extensions to it.
39
40 Extensions to notmuch which make use of properties are encouraged to
41 report the specific properties used to the upstream notmuch project,
42 as a way of avoiding collisions in the property namespace.
43
44 CONVENTIONS
45 ===========
46
47 Any property with a key that starts with "index." will be removed (and
48 possibly re-set) upon reindexing (see **notmuch-reindex(1)**).
49
50 MESSAGE PROPERTIES
51 ==================
52
53 The following properties are set by notmuch internally in the course
54 of its normal activity.
55
56 **index.decryption**
57
58     If a message contains encrypted content, and notmuch tries to
59     decrypt that content during indexing, it will add the property
60     ``index.decryption=success`` when the cleartext was successfully
61     indexed.  If notmuch attempts to decrypt any part of a message
62     during indexing and that decryption attempt fails, it will add the
63     property ``index.decryption=failure`` to the message.
64
65     Note that it's possible for a single message to have both
66     ``index.decryption=success`` and ``index.decryption=failure``.
67     Consider an encrypted e-mail message that contains another
68     encrypted e-mail message as an attachment -- if the outer message
69     can be decrypted, but the attached part cannot, then both
70     properties will be set on the message as a whole.
71
72     If notmuch never tried to decrypt an encrypted message during
73     indexing (which is the default, see ``index.decrypt`` in
74     **notmuch-config(1)**), then this property will not be set on that
75     message.
76
77 **session-key**
78
79     When **notmuch-show(1)** or **nomtuch-reply** encounters a message
80     with an encrypted part, if notmuch finds a ``session-key``
81     property associated with the message, it will try that stashed
82     session key for decryption.
83
84     If you do not want to use any stashed session keys that might be
85     present, you should pass those programs ``--decrypt=false``.
86
87     Using a stashed session key with "notmuch show" will speed up
88     rendering of long encrypted threads.  It also allows the user to
89     destroy the secret part of any expired encryption-capable subkey
90     while still being able to read any retained messages for which
91     they have stashed the session key.  This enables truly deletable
92     e-mail, since (once the session key and asymmetric subkey are both
93     destroyed) there are no keys left that can be used to decrypt any
94     copy of the original message previously stored by an adversary.
95
96     However, access to the stashed session key for an encrypted message
97     permits full byte-for-byte reconstruction of the cleartext
98     message.  This includes attachments, cryptographic signatures, and
99     other material that cannot be reconstructed from the index alone.
100
101     See ``index.decrypt`` in **notmuch-config(1)** for more
102     details about how to set notmuch's policy on when to store session
103     keys.
104
105     The session key should be in the ASCII text form produced by
106     GnuPG.  For OpenPGP, that consists of a decimal representation of
107     the hash algorithm used (identified by number from RFC 4880,
108     e.g. 9 means AES-256) followed by a colon, followed by a
109     hexadecimal representation of the algorithm-specific key.  For
110     example, an AES-128 key might be stashed in a notmuch property as:
111     ``session-key=7:14B16AF65536C28AF209828DFE34C9E0``.
112
113 SEE ALSO
114 ========
115
116 **notmuch(1)**,
117 **notmuch-config(1)**,
118 **notmuch-dump(1)**,
119 **notmuch-insert(1)**,
120 **notmuch-new(1)**,
121 **notmuch-reindex(1)**,
122 **notmuch-reply(1)**,
123 **notmuch-restore(1)**,
124 **notmuch-show(1)**,
125 ***notmuch-search-terms(7)**