emacs: update notmuch-crypto-process-mime config variable documentation.
[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 <http://www.gnu.org/licenses/>.
19 ;;
20 ;; Authors: Jameson Rollins <jrollins@finestructure.net>
21
22 (defcustom notmuch-crypto-process-mime nil
23   "Should cryptographic MIME parts be processed?
24
25 If this variable is non-nil signatures in multipart/signed
26 messages will be verified and multipart/encrypted parts will be
27 decrypted.  The result of the crypto operation will be displayed
28 in a specially colored header button at the top of the processed
29 part.  Signed parts will have variously colored headers depending
30 on the success or failure of the verification process and on the
31 validity of user ID of the signer.
32
33 The effect of setting this variable can be seen temporarily by
34 providing a prefix when viewing a signed or encrypted message, or
35 by providing a prefix when reloading the message in notmuch-show
36 mode."
37   :group 'notmuch
38   :type 'boolean)
39
40 (defface notmuch-crypto-signature-good
41   '((t (:background "green" :foreground "black")))
42   "Face used for good signatures."
43   :group 'notmuch)
44
45 (defface notmuch-crypto-signature-good-key
46   '((t (:background "orange" :foreground "black")))
47   "Face used for good signatures."
48   :group 'notmuch)
49
50 (defface notmuch-crypto-signature-bad
51   '((t (:background "red" :foreground "black")))
52   "Face used for bad signatures."
53   :group 'notmuch)
54
55 (defface notmuch-crypto-signature-unknown
56   '((t (:background "red" :foreground "black")))
57   "Face used for signatures of unknown status."
58   :group 'notmuch)
59
60 (defface notmuch-crypto-decryption
61   '((t (:background "purple" :foreground "black")))
62   "Face used for encryption/decryption status messages."
63   :group 'notmuch)
64
65 (define-button-type 'notmuch-crypto-status-button-type
66   'action '(lambda (button) (message (button-get button 'help-echo)))
67   'follow-link t
68   'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")
69
70 (defun notmuch-crypto-insert-sigstatus-button (sigstatus from)
71   (let* ((status (plist-get sigstatus :status))
72          (help-msg nil)
73          (label "Signature not processed")
74          (face 'notmuch-crypto-signature-unknown)
75          (button-action '(lambda (button) (message (button-get button 'help-echo)))))
76     (cond
77      ((string= status "good")
78       (let ((fingerprint (concat "0x" (plist-get sigstatus :fingerprint))))
79         ;; if userid present, userid has full or greater validity
80         (if (plist-member sigstatus :userid)
81             (let ((userid (plist-get sigstatus :userid)))
82               (setq label (concat "Good signature by: " userid))
83               (setq face 'notmuch-crypto-signature-good))
84           (progn
85             (setq label (concat "Good signature by key: " fingerprint))
86             (setq face 'notmuch-crypto-signature-good-key)))
87         (setq button-action 'notmuch-crypto-sigstatus-good-callback)
88         (setq help-msg (concat "Click to list key ID 0x" fingerprint "."))))
89      ((string= status "error")
90       (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
91         (setq label (concat "Unknown key ID " keyid " or unsupported algorithm"))
92         (setq button-action 'notmuch-crypto-sigstatus-error-callback)
93         (setq help-msg (concat "Click to retreive key ID " keyid " from keyserver and redisplay."))))
94      ((string= status "bad")
95       (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
96         (setq label (concat "Bad signature (claimed key ID " keyid ")"))
97         (setq face 'notmuch-crypto-signature-bad)))
98      (t
99       (setq label "Unknown signature status")
100       (if status (setq label (concat label " \"" status "\"")))))
101     (insert-button
102      (concat "[ " label " ]")
103      :type 'notmuch-crypto-status-button-type
104      'help-echo help-msg
105      'face face
106      'mouse-face face
107      'action button-action
108      :notmuch-sigstatus sigstatus
109      :notmuch-from from)
110     (insert "\n")))
111
112 (declare-function notmuch-show-refresh-view "notmuch-show" (&optional crypto-switch))
113
114 (defun notmuch-crypto-sigstatus-good-callback (button)
115   (let* ((sigstatus (button-get button :notmuch-sigstatus))
116          (fingerprint (concat "0x" (plist-get sigstatus :fingerprint)))
117          (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
118          (window (display-buffer buffer t nil)))
119     (with-selected-window window
120       (with-current-buffer buffer
121         (call-process "gpg" nil t t "--list-keys" fingerprint))
122       (recenter -1))))
123
124 (defun notmuch-crypto-sigstatus-error-callback (button)
125   (let* ((sigstatus (button-get button :notmuch-sigstatus))
126          (keyid (concat "0x" (plist-get sigstatus :keyid)))
127          (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
128          (window (display-buffer buffer t nil)))
129     (with-selected-window window
130       (with-current-buffer buffer
131         (call-process "gpg" nil t t "--recv-keys" keyid)
132         (insert "\n")
133         (call-process "gpg" nil t t "--list-keys" keyid))
134       (recenter -1))
135     (notmuch-show-refresh-view)))
136
137 (defun notmuch-crypto-insert-encstatus-button (encstatus)
138   (let* ((status (plist-get encstatus :status))
139          (help-msg nil)
140          (label "Decryption not attempted")
141          (face 'notmuch-crypto-decryption))
142     (cond
143      ((string= status "good")
144       (setq label "Decryption successful"))
145      ((string= status "bad")
146       (setq label "Decryption error"))
147      (t
148       (setq label (concat "Unknown encstatus \"" status "\""))))
149     (insert-button
150      (concat "[ " label " ]")
151      :type 'notmuch-crypto-status-button-type
152      'help-echo help-msg
153      'face face
154      'mouse-face face)
155     (insert "\n")))
156
157 ;;
158
159 (provide 'notmuch-crypto)