emacs: Increase consistency of library headers
[notmuch] / emacs / notmuch-crypto.el
1 ;;; notmuch-crypto.el --- functions for handling display of cryptographic metadata
2 ;;
3 ;; Copyright © Jameson Rollins
4 ;;
5 ;; This file is part of Notmuch.
6 ;;
7 ;; Notmuch is free software: you can redistribute it and/or modify it
8 ;; under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
11 ;;
12 ;; Notmuch is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 ;; General Public License for more details.
16 ;;
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch.  If not, see <https://www.gnu.org/licenses/>.
19 ;;
20 ;; Authors: Jameson Rollins <jrollins@finestructure.net>
21
22 ;;; Code:
23
24 (require 'epg)
25 (require 'notmuch-lib)
26
27 (declare-function notmuch-show-get-message-id "notmuch-show" (&optional bare))
28
29 (defcustom notmuch-crypto-process-mime t
30   "Should cryptographic MIME parts be processed?
31
32 If this variable is non-nil signatures in multipart/signed
33 messages will be verified and multipart/encrypted parts will be
34 decrypted.  The result of the crypto operation will be displayed
35 in a specially colored header button at the top of the processed
36 part.  Signed parts will have variously colored headers depending
37 on the success or failure of the verification process and on the
38 validity of user ID of the signer.
39
40 The effect of setting this variable can be seen temporarily by
41 providing a prefix when viewing a signed or encrypted message, or
42 by providing a prefix when reloading the message in notmuch-show
43 mode."
44   :type 'boolean
45   :package-version '(notmuch . "0.25")
46   :group 'notmuch-crypto)
47
48 (defcustom notmuch-crypto-get-keys-asynchronously t
49   "Retrieve gpg keys asynchronously."
50   :type 'boolean
51   :group 'notmuch-crypto)
52
53 (defcustom notmuch-crypto-gpg-program epg-gpg-program
54   "The gpg executable."
55   :type 'string
56   :group 'notmuch-crypto)
57
58 (defface notmuch-crypto-part-header
59   '((((class color)
60       (background dark))
61      (:foreground "LightBlue1"))
62     (((class color)
63       (background light))
64      (:foreground "blue")))
65   "Face used for crypto parts headers."
66   :group 'notmuch-crypto
67   :group 'notmuch-faces)
68
69 (defface notmuch-crypto-signature-good
70   '((t (:background "green" :foreground "black")))
71   "Face used for good signatures."
72   :group 'notmuch-crypto
73   :group 'notmuch-faces)
74
75 (defface notmuch-crypto-signature-good-key
76   '((t (:background "orange" :foreground "black")))
77   "Face used for good signatures."
78   :group 'notmuch-crypto
79   :group 'notmuch-faces)
80
81 (defface notmuch-crypto-signature-bad
82   '((t (:background "red" :foreground "black")))
83   "Face used for bad signatures."
84   :group 'notmuch-crypto
85   :group 'notmuch-faces)
86
87 (defface notmuch-crypto-signature-unknown
88   '((t (:background "red" :foreground "black")))
89   "Face used for signatures of unknown status."
90   :group 'notmuch-crypto
91   :group 'notmuch-faces)
92
93 (defface notmuch-crypto-decryption
94   '((t (:background "purple" :foreground "black")))
95   "Face used for encryption/decryption status messages."
96   :group 'notmuch-crypto
97   :group 'notmuch-faces)
98
99 (define-button-type 'notmuch-crypto-status-button-type
100   'action (lambda (button) (message (button-get button 'help-echo)))
101   'follow-link t
102   'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts."
103   :supertype 'notmuch-button-type)
104
105 (defun notmuch-crypto-insert-sigstatus-button (sigstatus from)
106   "Insert a button describing the signature status SIGSTATUS sent
107 by user FROM."
108   (let* ((status (plist-get sigstatus :status))
109          (show-button t)
110          (face 'notmuch-crypto-signature-unknown)
111          (button-action (lambda (button) (message (button-get button 'help-echo))))
112          (keyid (concat "0x" (plist-get sigstatus :keyid)))
113          label help-msg)
114     (cond
115      ((string= status "good")
116       (let ((fingerprint (concat "0x" (plist-get sigstatus :fingerprint)))
117             (userid (plist-get sigstatus :userid)))
118         ;; If userid is present it has full or greater validity.
119         (if userid
120             (progn
121               (setq label (concat "Good signature by: " userid))
122               (setq face 'notmuch-crypto-signature-good))
123           (setq label (concat "Good signature by key: " fingerprint))
124           (setq face 'notmuch-crypto-signature-good-key))
125         (setq button-action 'notmuch-crypto-sigstatus-good-callback)
126         (setq help-msg (concat "Click to list key ID 0x" fingerprint "."))))
127      ((string= status "error")
128       (setq label (concat "Unknown key ID " keyid " or unsupported algorithm"))
129       (setq button-action 'notmuch-crypto-sigstatus-error-callback)
130       (setq help-msg (concat "Click to retrieve key ID " keyid
131                              " from keyserver.")))
132      ((string= status "bad")
133       (setq label (concat "Bad signature (claimed key ID " keyid ")"))
134       (setq face 'notmuch-crypto-signature-bad))
135      (status
136       (setq label (concat "Unknown signature status: " status)))
137      (t
138       (setq show-button nil)))
139     (when show-button
140       (insert-button
141        (concat "[ " label " ]")
142        :type 'notmuch-crypto-status-button-type
143        'help-echo help-msg
144        'face face
145        'mouse-face face
146        'action button-action
147        :notmuch-sigstatus sigstatus
148        :notmuch-from from)
149       (insert "\n"))))
150
151 (defun notmuch-crypto-sigstatus-good-callback (button)
152   (let* ((id (notmuch-show-get-message-id))
153          (sigstatus (button-get button :notmuch-sigstatus))
154          (fingerprint (concat "0x" (plist-get sigstatus :fingerprint)))
155          (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
156          (window (display-buffer buffer)))
157     (with-selected-window window
158       (with-current-buffer buffer
159         (goto-char (point-max))
160         (insert (format "-- Key %s in message %s:\n"
161                         fingerprint id))
162         (call-process notmuch-crypto-gpg-program nil t t
163                       "--batch" "--no-tty" "--list-keys" fingerprint))
164       (recenter -1))))
165
166 (declare-function notmuch-show-refresh-view "notmuch-show" (&optional reset-state))
167 (declare-function notmuch-show-get-message-id "notmuch-show" (&optional bare))
168
169 (defun notmuch-crypto--async-key-sentinel (process event)
170   "When the user asks for a GPG key to be retrieved
171 asynchronously, handle completion of that task.
172
173 If the retrieval is successful, the thread where the retrieval
174 was initiated is still displayed and the cursor has not moved,
175 redisplay the thread."
176   (let ((status (process-status process))
177         (exit-status (process-exit-status process))
178         (keyid (process-get process :gpg-key-id)))
179     (when (memq status '(exit signal))
180       (message "Getting the GPG key %s asynchronously...%s."
181                keyid
182                (if (= exit-status 0)
183                    "completed"
184                  "failed"))
185       ;; If the original buffer is still alive and point didn't move
186       ;; (i.e. the user didn't move on or away), refresh the buffer to
187       ;; show the updated signature status.
188       (let ((show-buffer (process-get process :notmuch-show-buffer))
189             (show-point (process-get process :notmuch-show-point)))
190         (when (and (bufferp show-buffer)
191                    (buffer-live-p show-buffer)
192                    (= show-point
193                       (with-current-buffer show-buffer
194                         (point))))
195           (with-current-buffer show-buffer
196             (notmuch-show-refresh-view)))))))
197
198 (defun notmuch-crypto--set-button-label (button label)
199   "Set the text displayed in BUTTON to LABEL."
200   (save-excursion
201     (let ((inhibit-read-only t))
202       ;; This knows rather too much about how we typically format
203       ;; buttons.
204       (goto-char (button-start button))
205       (forward-char 2)
206       (delete-region (point) (- (button-end button) 2))
207       (insert label))))
208
209 (defun notmuch-crypto-sigstatus-error-callback (button)
210   "When signature validation has failed, try to retrieve the
211 corresponding key when the status button is pressed."
212   (let* ((sigstatus (button-get button :notmuch-sigstatus))
213          (keyid (concat "0x" (plist-get sigstatus :keyid)))
214          (buffer (get-buffer-create "*notmuch-crypto-gpg-out*")))
215     (if notmuch-crypto-get-keys-asynchronously
216         (progn
217           (notmuch-crypto--set-button-label
218            button (format "Retrieving key %s asynchronously..." keyid))
219           (with-current-buffer buffer
220             (goto-char (point-max))
221             (insert (format "--- Retrieving key %s:\n" keyid)))
222           (let ((p (make-process
223                     :name "notmuch GPG key retrieval"
224                     :connection-type 'pipe
225                     :buffer buffer
226                     :stderr buffer
227                     :command (list notmuch-crypto-gpg-program "--recv-keys" keyid)
228                     :sentinel #'notmuch-crypto--async-key-sentinel)))
229             (process-put p :gpg-key-id keyid)
230             (process-put p :notmuch-show-buffer (current-buffer))
231             (process-put p :notmuch-show-point (point))
232             (message "Getting the GPG key %s asynchronously..." keyid)))
233       (let ((window (display-buffer buffer)))
234         (with-selected-window window
235           (with-current-buffer buffer
236             (goto-char (point-max))
237             (insert (format "--- Retrieving key %s:\n" keyid))
238             (call-process notmuch-crypto-gpg-program nil t t "--recv-keys" keyid)
239             (insert "\n")
240             (call-process notmuch-crypto-gpg-program nil t t "--list-keys" keyid))
241           (recenter -1))
242         (notmuch-show-refresh-view)))))
243
244 (defun notmuch-crypto-insert-encstatus-button (encstatus)
245   "Insert a button describing the encryption status ENCSTATUS."
246   (insert-button
247    (concat "[ "
248            (let ((status (plist-get encstatus :status)))
249              (cond
250               ((string= status "good")
251                "Decryption successful")
252               ((string= status "bad")
253                "Decryption error")
254               (t
255                (concat "Unknown encryption status"
256                        (and status (concat ": " status))))))
257            " ]")
258    :type 'notmuch-crypto-status-button-type
259    'face 'notmuch-crypto-decryption
260    'mouse-face 'notmuch-crypto-decryption)
261   (insert "\n"))
262
263 ;;
264
265 (provide 'notmuch-crypto)
266
267 ;;; notmuch-crypto.el ends here