Handle gpg errors better when trying to display PGP key image.
[gnus] / lisp / mml2015.el
index f966e5e..f8f0a56 100644 (file)
@@ -1,7 +1,6 @@
 ;;; mml2015.el --- MIME Security with Pretty Good Privacy (PGP)
 
-;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
-;;   2008, 2009, 2010 Free Software Foundation, Inc.
+;; Copyright (C) 2000-2012 Free Software Foundation, Inc.
 
 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
 ;; Keywords: PGP MIME MML
@@ -28,8 +27,8 @@
 
 ;;; Code:
 
-;; For Emacs < 22.2.
 (eval-and-compile
+  ;; For Emacs <22.2 and XEmacs.
   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r)))
 
   (if (locate-library "password-cache")
                           'epg)
                       (error))
                     (progn
-                      (ignore-errors
-                       ;; Avoid the "Recursive load suspected" error
-                       ;; in Emacs 21.1.
-                       (let ((recursive-load-depth-limit 100))
-                         (require 'pgg)))
-                      (and (fboundp 'pgg-sign-region)
-                           'pgg))
+                      (let ((abs-file (locate-library "pgg")))
+                        ;; Don't load PGG if it is marked as obsolete
+                        ;; (Emacs 24).
+                        (when (and abs-file
+                                   (not (string-match "/obsolete/[^/]*\\'"
+                                                      abs-file)))
+                          (ignore-errors (require 'pgg))
+                          (and (fboundp 'pgg-sign-region)
+                               'pgg))))
                     (progn (ignore-errors
                              (load "mc-toplev"))
                            (and (fboundp 'mc-encrypt-generic)
@@ -121,10 +122,17 @@ Whether the passphrase is cached at all is controlled by
   :type 'integer)
 
 (defcustom mml2015-signers nil
-  "A list of your own key ID which will be used to sign a message."
+  "A list of your own key ID(s) which will be used to sign a message.
+If set, it overrides the setting of `mml2015-sign-with-sender'."
   :group 'mime-security
   :type '(repeat (string :tag "Key ID")))
 
+(defcustom mml2015-sign-with-sender nil
+  "If t, use message sender so find a key to sign with."
+  :group 'mime-security
+  :type 'boolean
+  :version "24.1")
+
 (defcustom mml2015-encrypt-to-self nil
   "If t, add your own key ID to recipient list when encryption."
   :group 'mime-security
@@ -223,6 +231,25 @@ Whether the passphrase is cached at all is controlled by
          handles
        (list handles)))))
 
+(defun mml2015-gpg-pretty-print-fpr (fingerprint)
+  (let* ((result "")
+        (fpr-length (string-width fingerprint))
+        (n-slice 0)
+        slice)
+    (setq fingerprint (string-to-list fingerprint))
+    (while fingerprint
+      (setq fpr-length (- fpr-length 4))
+      (setq slice (butlast fingerprint fpr-length))
+      (setq fingerprint (nthcdr 4 fingerprint))
+      (setq n-slice (1+ n-slice))
+      (setq result
+           (concat
+            result
+            (case n-slice
+              (1  slice)
+              (otherwise (concat " " slice))))))
+    result))
+
 (defun mml2015-gpg-extract-signature-details ()
   (goto-char (point-min))
   (let* ((expired (re-search-forward
@@ -708,6 +735,7 @@ Whether the passphrase is cached at all is controlled by
 
 (defvar epg-user-id-alist)
 (defvar epg-digest-algorithm-alist)
+(defvar epg-gpg-program)
 (defvar inhibit-redisplay)
 
 (autoload 'epg-make-context "epg")
@@ -716,7 +744,6 @@ Whether the passphrase is cached at all is controlled by
 (autoload 'epg-context-set-signers "epg")
 (autoload 'epg-context-result-for "epg")
 (autoload 'epg-new-signature-digest-algorithm "epg")
-(autoload 'epg-verify-result-to-string "epg")
 (autoload 'epg-list-keys "epg")
 (autoload 'epg-decrypt-string "epg")
 (autoload 'epg-verify-string "epg")
@@ -727,6 +754,9 @@ Whether the passphrase is cached at all is controlled by
 (autoload 'epg-key-sub-key-list "epg")
 (autoload 'epg-sub-key-capability "epg")
 (autoload 'epg-sub-key-validity "epg")
+(autoload 'epg-sub-key-fingerprint "epg")
+(autoload 'epg-signature-key-id "epg")
+(autoload 'epg-signature-to-string "epg")
 (autoload 'epg-configuration "epg-config")
 (autoload 'epg-expand-group "epg-config")
 (autoload 'epa-select-keys "epa")
@@ -760,15 +790,65 @@ Whether the passphrase is cached at all is controlled by
   (catch 'found
     (while keys
       (let ((pointer (epg-key-sub-key-list (car keys))))
-       (while pointer
-         (if (and (memq usage (epg-sub-key-capability (car pointer)))
-                  (not (memq 'disabled (epg-sub-key-capability (car pointer))))
-                  (not (memq (epg-sub-key-validity (car pointer))
-                             '(revoked expired))))
-             (throw 'found (car keys)))
-         (setq pointer (cdr pointer))))
+       ;; The primary key will be marked as disabled, when the entire
+       ;; key is disabled (see 12 Field, Format of colon listings, in
+       ;; gnupg/doc/DETAILS)
+       (unless (memq 'disabled (epg-sub-key-capability (car pointer)))
+         (while pointer
+           (if (and (memq usage (epg-sub-key-capability (car pointer)))
+                    (not (memq (epg-sub-key-validity (car pointer))
+                               '(revoked expired))))
+               (throw 'found (car keys)))
+           (setq pointer (cdr pointer)))))
       (setq keys (cdr keys)))))
 
+;; XXX: since gpg --list-secret-keys does not return validity of each
+;; key, `mml2015-epg-find-usable-key' defined above is not enough for
+;; secret keys.  The function `mml2015-epg-find-usable-secret-key'
+;; below looks at appropriate public keys to check usability.
+(defun mml2015-epg-find-usable-secret-key (context name usage)
+  (let ((secret-keys (epg-list-keys context name t))
+       secret-key)
+    (while (and (not secret-key) secret-keys)
+      (if (mml2015-epg-find-usable-key
+          (epg-list-keys context (epg-sub-key-fingerprint
+                                  (car (epg-key-sub-key-list
+                                        (car secret-keys)))))
+          usage)
+         (setq secret-key (car secret-keys)
+               secret-keys nil)
+       (setq secret-keys (cdr secret-keys))))
+    secret-key))
+
+(defun mml2015-epg-key-image (key-id)
+  "Return the image of a key, if any"
+  (with-temp-buffer
+    (mm-set-buffer-multibyte nil)
+    (let* ((coding-system-for-write 'binary)
+           (coding-system-for-read 'binary)
+           (data (shell-command-to-string
+                  (format "%s --list-options no-show-photos --attribute-fd 3 --list-keys %s 3>&1 >/dev/null 2>&1"
+                          epg-gpg-program key-id))))
+      (when (> (length data) 0)
+        (insert (substring data 16))
+        (create-image (buffer-string) nil t)))))
+
+(defun mml2015-epg-key-image-to-string (key-id)
+  "Return a string with the image of a key, if any"
+  (let* ((result "")
+         (key-image (mml2015-epg-key-image key-id)))
+    (when key-image
+      (setq result "  ")
+      (put-text-property 1 2 'display key-image result))
+    result))
+
+(defun mml2015-epg-signature-to-string (signature)
+  (concat (epg-signature-to-string signature)
+         (mml2015-epg-key-image-to-string (epg-signature-key-id signature))))
+
+(defun mml2015-epg-verify-result-to-string (verify-result)
+  (mapconcat #'mml2015-epg-signature-to-string verify-result "\n"))
+
 (defun mml2015-epg-decrypt (handle ctl)
   (catch 'error
     (let ((inhibit-redisplay t)
@@ -811,7 +891,7 @@ Whether the passphrase is cached at all is controlled by
            (mm-set-handle-multipart-parameter
             mm-security-handle 'gnus-info
             (concat "OK\n"
-                    (epg-verify-result-to-string
+                    (mml2015-epg-verify-result-to-string
                      (epg-context-result-for context 'verify))))
          (mm-set-handle-multipart-parameter
           mm-security-handle 'gnus-info "OK"))
@@ -859,7 +939,7 @@ Whether the passphrase is cached at all is controlled by
       (if (epg-context-result-for context 'verify)
          (mm-set-handle-multipart-parameter
           mm-security-handle 'gnus-details
-          (epg-verify-result-to-string
+          (mml2015-epg-verify-result-to-string
            (epg-context-result-for context 'verify)))))))
 
 (defun mml2015-epg-verify (handle ctl)
@@ -877,7 +957,7 @@ Whether the passphrase is cached at all is controlled by
        (mm-set-handle-multipart-parameter
         mm-security-handle 'gnus-info "Corrupted")
        (throw 'error handle))
-      (setq part (mm-replace-in-string part "\n" "\r\n" t)
+      (setq part (mm-replace-in-string part "\n" "\r\n")
            signature (mm-get-part signature)
            context (epg-make-context))
       (condition-case error
@@ -893,7 +973,8 @@ Whether the passphrase is cached at all is controlled by
         (throw 'error handle)))
       (mm-set-handle-multipart-parameter
        mm-security-handle 'gnus-info
-       (epg-verify-result-to-string (epg-context-result-for context 'verify)))
+       (mml2015-epg-verify-result-to-string
+       (epg-context-result-for context 'verify)))
       handle)))
 
 (defun mml2015-epg-clear-verify ()
@@ -916,7 +997,7 @@ Whether the passphrase is cached at all is controlled by
        (progn
          (mm-set-handle-multipart-parameter
           mm-security-handle 'gnus-info
-          (epg-verify-result-to-string
+          (mml2015-epg-verify-result-to-string
            (epg-context-result-for context 'verify)))
          (delete-region (point-min) (point-max))
          (insert (mm-decode-coding-string plain coding-system-for-read)))
@@ -926,6 +1007,10 @@ Whether the passphrase is cached at all is controlled by
   (let* ((inhibit-redisplay t)
         (context (epg-make-context))
         (boundary (mml-compute-boundary cont))
+        (sender (message-options-get 'message-sender))
+        (signer-names (or mml2015-signers
+                          (if (and mml2015-sign-with-sender sender)
+                              (list (concat "<" sender ">")))))
         signer-key
         (signers
          (or (message-options-get 'mml2015-epg-signers)
@@ -935,14 +1020,15 @@ Whether the passphrase is cached at all is controlled by
                   (epa-select-keys context "\
 Select keys for signing.
 If no one is selected, default secret key is used.  "
-                                   mml2015-signers t)
-                (if mml2015-signers
+                                   signer-names
+                                   t)
+                (if (or sender mml2015-signers)
                     (delq nil
                           (mapcar
                            (lambda (signer)
-                             (setq signer-key (mml2015-epg-find-usable-key
-                                               (epg-list-keys context signer t)
-                                               'sign))
+                             (setq signer-key
+                                   (mml2015-epg-find-usable-secret-key
+                                    context signer 'sign))
                              (unless (or signer-key
                                          (y-or-n-p
                                           (format
@@ -950,7 +1036,7 @@ If no one is selected, default secret key is used.  "
                                            signer)))
                                (error "No secret key for %s" signer))
                              signer-key)
-                           mml2015-signers)))))))
+                           signer-names)))))))
         signature micalg)
     (epg-context-set-armor context t)
     (epg-context-set-textmode context t)
@@ -990,13 +1076,18 @@ If no one is selected, default secret key is used.  "
     (goto-char (point-max))))
 
 (defun mml2015-epg-encrypt (cont &optional sign)
-  (let ((inhibit-redisplay t)
-       (context (epg-make-context))
-       (config (epg-configuration))
-       (recipients (message-options-get 'mml2015-epg-recipients))
-       cipher signers
-       (boundary (mml-compute-boundary cont))
-       recipient-key signer-key)
+  (let* ((inhibit-redisplay t)
+        (context (epg-make-context))
+        (boundary (mml-compute-boundary cont))
+        (config (epg-configuration))
+        (recipients (message-options-get 'mml2015-epg-recipients))
+        cipher
+        (sender (message-options-get 'message-sender))
+        (signer-names (or mml2015-signers
+                          (if (and mml2015-sign-with-sender sender)
+                              (list (concat "<" sender ">")))))
+        signers
+        recipient-key signer-key)
     (unless recipients
       (setq recipients
            (apply #'nconc
@@ -1010,9 +1101,9 @@ If no one is selected, default secret key is used.  "
                                              (read-string "Recipients: ")))
                     "[ \f\t\n\r\v,]+"))))
       (when mml2015-encrypt-to-self
-       (unless mml2015-signers
-         (error "mml2015-signers not set"))
-       (setq recipients (nconc recipients mml2015-signers)))
+       (unless signer-names
+         (error "Neither message sender nor mml2015-signers are set"))
+       (setq recipients (nconc recipients signer-names)))
       (if (eq mm-encrypt-option 'guided)
          (setq recipients
                (epa-select-keys context "\
@@ -1045,14 +1136,15 @@ If no one is selected, symmetric encryption will be performed.  "
                     (epa-select-keys context "\
 Select keys for signing.
 If no one is selected, default secret key is used.  "
-                                     mml2015-signers t)
-                  (if mml2015-signers
+                                     signer-names
+                                     t)
+                  (if (or sender mml2015-signers)
                       (delq nil
                             (mapcar
                              (lambda (signer)
-                               (setq signer-key (mml2015-epg-find-usable-key
-                                                 (epg-list-keys context signer t)
-                                                 'sign))
+                               (setq signer-key
+                                     (mml2015-epg-find-usable-secret-key
+                                      context signer 'sign))
                                (unless (or signer-key
                                            (y-or-n-p
                                             (format
@@ -1060,7 +1152,7 @@ If no one is selected, default secret key is used.  "
                                              signer)))
                                  (error "No secret key for %s" signer))
                                signer-key)
-                             mml2015-signers)))))))
+                             signer-names)))))))
       (epg-context-set-signers context signers))
     (epg-context-set-armor context t)
     (epg-context-set-textmode context t)