version 4: Retrieve GPG keys asynchronously.

classic Classic list List threaded Threaded
6 messages Options
Daniel Kahn Gillmor Daniel Kahn Gillmor
Reply | Threaded
Open this post in threaded view
|

version 4: Retrieve GPG keys asynchronously.

In id:[hidden email], bremner identified two of my edits
breaking dme's series that permits asynchronous retrieval of OpenPGP
keys.

This is a revision of that series that should apply to the current
master, taking into account my earlier fixes.

dme, if you could review i would appreciate it.  I think i've done
what you would have done, but as usual my elisp skills are weaker than
yours, so i welcome your feedback.  The test suite passes for me at
least :)

Sorry for contributing to the collision earlier!

      --dkg



_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch
Daniel Kahn Gillmor Daniel Kahn Gillmor
Reply | Threaded
Open this post in threaded view
|

[PATCH v4 1/4] emacs: Asynchronous retrieval of GPG keys

From: David Edmondson <[hidden email]>

Rather than blocking emacs while gpg does its' thing, by default run
key retrieval asynchronously, possibly updating the display of the
message on successful completion.
---
 emacs/notmuch-crypto.el | 85 +++++++++++++++++++++++++++++++++++------
 1 file changed, 74 insertions(+), 11 deletions(-)

diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el
index 4216f583..0ab85f4b 100644
--- a/emacs/notmuch-crypto.el
+++ b/emacs/notmuch-crypto.el
@@ -43,6 +43,11 @@ mode."
   :package-version '(notmuch . "0.25")
   :group 'notmuch-crypto)
 
+(defcustom notmuch-crypto-get-keys-asynchronously t
+  "Retrieve gpg keys asynchronously."
+  :type 'boolean
+  :group 'notmuch-crypto)
+
 (defface notmuch-crypto-part-header
   '((((class color)
       (background dark))
@@ -114,7 +119,7 @@ mode."
       (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
  (setq label (concat "Unknown key ID " keyid " or unsupported algorithm"))
  (setq button-action 'notmuch-crypto-sigstatus-error-callback)
- (setq help-msg (concat "Click to retrieve key ID " keyid " from keyserver and redisplay."))))
+ (setq help-msg (concat "Click to retrieve key ID " keyid " from keyserver."))))
      ((string= status "bad")
       (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
  (setq label (concat "Bad signature (claimed key ID " keyid ")"))
@@ -148,19 +153,77 @@ mode."
  (call-process epg-gpg-program nil t t "--batch" "--no-tty" "--list-keys" fingerprint))
       (recenter -1))))
 
+(defun notmuch-crypto--async-key-sentinel (process event)
+  "When the user asks for a GPG key to be retrieved
+asynchronously, handle completion of that task.
+
+If the retrieval is successful, the thread where the retrieval
+was initiated is still displayed and the cursor has not moved,
+redisplay the thread."
+  (let ((status (process-status process))
+ (exit-status (process-exit-status process))
+ (keyid (process-get process :gpg-key-id)))
+    (when (memq status '(exit signal))
+      (message "Getting the GPG key %s asynchronously...%s."
+       keyid
+       (if (= exit-status 0)
+   "completed"
+ "failed"))
+      ;; If the original buffer is still alive and point didn't move
+      ;; (i.e. the user didn't move on or away), refresh the buffer to
+      ;; show the updated signature status.
+      (let ((show-buffer (process-get process :notmuch-show-buffer))
+    (show-point (process-get process :notmuch-show-point)))
+ (when (and (bufferp show-buffer)
+   (buffer-live-p show-buffer)
+   (= show-point
+      (with-current-buffer show-buffer
+ (point))))
+  (with-current-buffer show-buffer
+    (notmuch-show-refresh-view)))))))
+
+(defun notmuch-crypto--set-button-label (button label)
+  "Set the text displayed in BUTTON to LABEL."
+  (save-excursion
+    (let ((inhibit-read-only t))
+      ;; This knows rather too much about how we typically format
+      ;; buttons.
+      (goto-char (button-start button))
+      (forward-char 2)
+      (delete-region (point) (- (button-end button) 2))
+      (insert label))))
+
 (defun notmuch-crypto-sigstatus-error-callback (button)
   (let* ((sigstatus (button-get button :notmuch-sigstatus))
  (keyid (concat "0x" (plist-get sigstatus :keyid)))
- (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
- (window (display-buffer buffer t nil)))
-    (with-selected-window window
-      (with-current-buffer buffer
- (goto-char (point-max))
- (call-process epg-gpg-program nil t t "--batch" "--no-tty" "--recv-keys" keyid)
- (insert "\n")
- (call-process epg-gpg-program nil t t "--batch" "--no-tty" "--list-keys" keyid))
-      (recenter -1))
-    (notmuch-show-refresh-view)))
+ (buffer (get-buffer-create "*notmuch-crypto-gpg-out*")))
+    (if notmuch-crypto-get-keys-asynchronously
+ (progn
+  (notmuch-crypto--set-button-label
+   button (format "Retrieving key %s asynchronously..." keyid))
+  (let ((p (make-process :name "notmuch GPG key retrieval"
+ :buffer buffer
+ :command (list epg-gpg-program "--recv-keys" keyid)
+ :connection-type 'pipe
+ :sentinel #'notmuch-crypto--async-key-sentinel
+ ;; Create the process stopped so that
+ ;; we have time to store the key id,
+ ;; etc. on it.
+ :stop t)))
+    (process-put p :gpg-key-id keyid)
+    (process-put p :notmuch-show-buffer (current-buffer))
+    (process-put p :notmuch-show-point (point))
+    (message "Getting the GPG key %s asynchronously..." keyid)
+    (continue-process p)))
+      (let ((window (display-buffer buffer t nil)))
+ (with-selected-window window
+  (with-current-buffer buffer
+    (goto-char (point-max))
+    (call-process epg-gpg-program nil t t "--recv-keys" keyid)
+    (insert "\n")
+    (call-process epg-gpg-program nil t t "--list-keys" keyid))
+  (recenter -1))
+ (notmuch-show-refresh-view)))))
 
 (defun notmuch-crypto-insert-encstatus-button (encstatus)
   (let* ((status (plist-get encstatus :status))
--
2.23.0

_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch
Daniel Kahn Gillmor Daniel Kahn Gillmor
Reply | Threaded
Open this post in threaded view
|

[PATCH v4 2/4] emacs: Minor refactoring of crypto code

In reply to this post by Daniel Kahn Gillmor
From: David Edmondson <[hidden email]>

---
 emacs/notmuch-crypto.el | 91 +++++++++++++++++++++--------------------
 1 file changed, 47 insertions(+), 44 deletions(-)

diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el
index 0ab85f4b..457c821c 100644
--- a/emacs/notmuch-crypto.el
+++ b/emacs/notmuch-crypto.el
@@ -96,34 +96,37 @@ mode."
   :supertype 'notmuch-button-type)
 
 (defun notmuch-crypto-insert-sigstatus-button (sigstatus from)
+  "Insert a button describing the signature status SIGSTATUS sent
+by user FROM."
   (let* ((status (plist-get sigstatus :status))
- (help-msg nil)
  (show-button t)
- (label nil)
  (face 'notmuch-crypto-signature-unknown)
- (button-action (lambda (button) (message (button-get button 'help-echo)))))
+ (button-action (lambda (button) (message (button-get button 'help-echo))))
+ (keyid (concat "0x" (plist-get sigstatus :keyid)))
+ label help-msg)
     (cond
      ((string= status "good")
-      (let ((fingerprint (concat "0x" (plist-get sigstatus :fingerprint))))
- ;; if userid present, userid has full or greater validity
- (if (plist-member sigstatus :userid)
-    (let ((userid (plist-get sigstatus :userid)))
-      (setq label (concat "Good signature by: " userid))
-      (setq face 'notmuch-crypto-signature-good))
-  (progn
-    (setq label (concat "Good signature by key: " fingerprint))
-    (setq face 'notmuch-crypto-signature-good-key)))
- (setq button-action 'notmuch-crypto-sigstatus-good-callback)
- (setq help-msg (concat "Click to list key ID 0x" fingerprint "."))))
+      (let ((fingerprint (concat "0x" (plist-get sigstatus :fingerprint)))
+    (userid (plist-get sigstatus :userid)))
+ ;; If userid is present it has full or greater validity.
+ (if userid
+    (setq label (concat "Good signature by: " userid)
+  face 'notmuch-crypto-signature-good)
+  (setq label (concat "Good signature by key: " fingerprint)
+ face 'notmuch-crypto-signature-good-key))
+ (setq button-action 'notmuch-crypto-sigstatus-good-callback
+      help-msg (concat "Click to list key ID 0x" fingerprint "."))))
+
      ((string= status "error")
-      (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
- (setq label (concat "Unknown key ID " keyid " or unsupported algorithm"))
- (setq button-action 'notmuch-crypto-sigstatus-error-callback)
- (setq help-msg (concat "Click to retrieve key ID " keyid " from keyserver."))))
+      (setq label (concat "Unknown key ID " keyid " or unsupported algorithm")
+    button-action 'notmuch-crypto-sigstatus-error-callback
+    help-msg (concat "Click to retrieve key ID " keyid
+     " from keyserver.")))
+
      ((string= status "bad")
-      (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
- (setq label (concat "Bad signature (claimed key ID " keyid ")"))
- (setq face 'notmuch-crypto-signature-bad)))
+      (setq label (concat "Bad signature (claimed key ID " keyid ")")
+    face 'notmuch-crypto-signature-bad))
+
      (status
       (setq label (concat "Unknown signature status: " status)))
      (t
@@ -140,19 +143,19 @@ mode."
        :notmuch-from from)
       (insert "\n"))))
 
-(declare-function notmuch-show-refresh-view "notmuch-show" (&optional reset-state))
-
 (defun notmuch-crypto-sigstatus-good-callback (button)
   (let* ((sigstatus (button-get button :notmuch-sigstatus))
  (fingerprint (concat "0x" (plist-get sigstatus :fingerprint)))
  (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
- (window (display-buffer buffer t nil)))
+ (window (display-buffer buffer)))
     (with-selected-window window
       (with-current-buffer buffer
  (goto-char (point-max))
  (call-process epg-gpg-program nil t t "--batch" "--no-tty" "--list-keys" fingerprint))
       (recenter -1))))
 
+(declare-function notmuch-show-refresh-view "notmuch-show" (&optional reset-state))
+
 (defun notmuch-crypto--async-key-sentinel (process event)
   "When the user asks for a GPG key to be retrieved
 asynchronously, handle completion of that task.
@@ -194,6 +197,8 @@ redisplay the thread."
       (insert label))))
 
 (defun notmuch-crypto-sigstatus-error-callback (button)
+  "When signature validation has failed, try to retrieve the
+corresponding key when the status button is pressed."
   (let* ((sigstatus (button-get button :notmuch-sigstatus))
  (keyid (concat "0x" (plist-get sigstatus :keyid)))
  (buffer (get-buffer-create "*notmuch-crypto-gpg-out*")))
@@ -215,7 +220,7 @@ redisplay the thread."
     (process-put p :notmuch-show-point (point))
     (message "Getting the GPG key %s asynchronously..." keyid)
     (continue-process p)))
-      (let ((window (display-buffer buffer t nil)))
+      (let ((window (display-buffer buffer)))
  (with-selected-window window
   (with-current-buffer buffer
     (goto-char (point-max))
@@ -226,25 +231,23 @@ redisplay the thread."
  (notmuch-show-refresh-view)))))
 
 (defun notmuch-crypto-insert-encstatus-button (encstatus)
-  (let* ((status (plist-get encstatus :status))
- (help-msg nil)
- (label "Decryption not attempted")
- (face 'notmuch-crypto-decryption))
-    (cond
-     ((string= status "good")
-      (setq label "Decryption successful"))
-     ((string= status "bad")
-      (setq label "Decryption error"))
-     (t
-      (setq label (concat "Unknown encryption status"
-  (if status (concat ": " status))))))
-    (insert-button
-     (concat "[ " label " ]")
-     :type 'notmuch-crypto-status-button-type
-     'help-echo help-msg
-     'face face
-     'mouse-face face)
-    (insert "\n")))
+  "Insert a button describing the encryption status ENCSTATUS."
+  (insert-button
+   (concat "[ "
+   (let ((status (plist-get encstatus :status)))
+     (cond
+      ((string= status "good")
+       "Decryption successful")
+      ((string= status "bad")
+       "Decryption error")
+      (t
+       (concat "Unknown encryption status"
+       (if status (concat ": " status))))))
+   " ]")
+   :type 'notmuch-crypto-status-button-type
+   'face 'notmuch-crypto-decryption
+   'mouse-face 'notmuch-crypto-decryption)
+  (insert "\n"))
 
 ;;
 
--
2.23.0

_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch
Daniel Kahn Gillmor Daniel Kahn Gillmor
Reply | Threaded
Open this post in threaded view
|

[PATCH v4 3/4] emacs: Add notmuch-crypto-gpg-program and use it

In reply to this post by Daniel Kahn Gillmor
From: David Edmondson <[hidden email]>

Allow the user to specify the gpg program to use when retrieving keys,
etc., defaulting to the value of `epg-gpg-program'.
---
 emacs/notmuch-crypto.el | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el
index 457c821c..9b615a0f 100644
--- a/emacs/notmuch-crypto.el
+++ b/emacs/notmuch-crypto.el
@@ -48,6 +48,11 @@ mode."
   :type 'boolean
   :group 'notmuch-crypto)
 
+(defcustom notmuch-crypto-gpg-program epg-gpg-program
+  "The gpg executable."
+  :type 'string
+  :group 'notmuch-crypto)
+
 (defface notmuch-crypto-part-header
   '((((class color)
       (background dark))
@@ -151,7 +156,7 @@ by user FROM."
     (with-selected-window window
       (with-current-buffer buffer
  (goto-char (point-max))
- (call-process epg-gpg-program nil t t "--batch" "--no-tty" "--list-keys" fingerprint))
+ (call-process notmuch-crypto-gpg-program nil t t "--batch" "--no-tty" "--list-keys" fingerprint))
       (recenter -1))))
 
 (declare-function notmuch-show-refresh-view "notmuch-show" (&optional reset-state))
@@ -208,7 +213,7 @@ corresponding key when the status button is pressed."
    button (format "Retrieving key %s asynchronously..." keyid))
   (let ((p (make-process :name "notmuch GPG key retrieval"
  :buffer buffer
- :command (list epg-gpg-program "--recv-keys" keyid)
+ :command (list notmuch-crypto-gpg-program "--recv-keys" keyid)
  :connection-type 'pipe
  :sentinel #'notmuch-crypto--async-key-sentinel
  ;; Create the process stopped so that
@@ -220,13 +225,14 @@ corresponding key when the status button is pressed."
     (process-put p :notmuch-show-point (point))
     (message "Getting the GPG key %s asynchronously..." keyid)
     (continue-process p)))
+
       (let ((window (display-buffer buffer)))
  (with-selected-window window
   (with-current-buffer buffer
     (goto-char (point-max))
-    (call-process epg-gpg-program nil t t "--recv-keys" keyid)
+    (call-process notmuch-crypto-gpg-program nil t t "--recv-keys" keyid)
     (insert "\n")
-    (call-process epg-gpg-program nil t t "--list-keys" keyid))
+    (call-process notmuch-crypto-gpg-program nil t t "--list-keys" keyid))
   (recenter -1))
  (notmuch-show-refresh-view)))))
 
--
2.23.0

_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch
Daniel Kahn Gillmor Daniel Kahn Gillmor
Reply | Threaded
Open this post in threaded view
|

[PATCH v4 4/4] emacs: Improve the reporting of key activity

In reply to this post by Daniel Kahn Gillmor
From: David Edmondson <[hidden email]>

Improve the information provided about key retrieval and key validity.
---
 emacs/notmuch-crypto.el | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el
index 9b615a0f..f4585d5e 100644
--- a/emacs/notmuch-crypto.el
+++ b/emacs/notmuch-crypto.el
@@ -149,13 +149,16 @@ by user FROM."
       (insert "\n"))))
 
 (defun notmuch-crypto-sigstatus-good-callback (button)
-  (let* ((sigstatus (button-get button :notmuch-sigstatus))
+  (let* ((id (notmuch-show-get-message-id))
+ (sigstatus (button-get button :notmuch-sigstatus))
  (fingerprint (concat "0x" (plist-get sigstatus :fingerprint)))
  (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
  (window (display-buffer buffer)))
     (with-selected-window window
       (with-current-buffer buffer
  (goto-char (point-max))
+ (insert (format "-- Key %s in message %s:\n"
+ fingerprint id))
  (call-process notmuch-crypto-gpg-program nil t t "--batch" "--no-tty" "--list-keys" fingerprint))
       (recenter -1))))
 
@@ -211,10 +214,14 @@ corresponding key when the status button is pressed."
  (progn
   (notmuch-crypto--set-button-label
    button (format "Retrieving key %s asynchronously..." keyid))
+  (with-current-buffer buffer
+    (goto-char (point-max))
+    (insert (format "--- Retrieving key %s:\n" keyid)))
   (let ((p (make-process :name "notmuch GPG key retrieval"
+ :connection-type 'pipe
  :buffer buffer
+ :stderr buffer
  :command (list notmuch-crypto-gpg-program "--recv-keys" keyid)
- :connection-type 'pipe
  :sentinel #'notmuch-crypto--async-key-sentinel
  ;; Create the process stopped so that
  ;; we have time to store the key id,
@@ -230,6 +237,7 @@ corresponding key when the status button is pressed."
  (with-selected-window window
   (with-current-buffer buffer
     (goto-char (point-max))
+    (insert (format "--- Retrieving key %s:\n" keyid))
     (call-process notmuch-crypto-gpg-program nil t t "--recv-keys" keyid)
     (insert "\n")
     (call-process notmuch-crypto-gpg-program nil t t "--list-keys" keyid))
--
2.23.0

_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch
Tomi Ollila-2 Tomi Ollila-2
Reply | Threaded
Open this post in threaded view
|

Re: version 4: Retrieve GPG keys asynchronously.

In reply to this post by Daniel Kahn Gillmor
On Wed, Sep 11 2019, Daniel Kahn Gillmor wrote:

> In id:[hidden email], bremner identified two of my edits
> breaking dme's series that permits asynchronous retrieval of OpenPGP
> keys.
>
> This is a revision of that series that should apply to the current
> master, taking into account my earlier fixes.
>
> dme, if you could review i would appreciate it.  I think i've done
> what you would have done, but as usual my elisp skills are weaker than
> yours, so i welcome your feedback.  The test suite passes for me at
> least :)
>
> Sorry for contributing to the collision earlier!


This series looks good to me. I did not (take time to look how to) test,
but I trust dkg has basically executed all changed code :D. Some of the
code was just style change w/o functional change (one let* context puzzled
me for a while) -- for better which is good!

>
>       --dkg
>

Tomi
_______________________________________________
notmuch mailing list
[hidden email]
https://notmuchmail.org/mailman/listinfo/notmuch