;;; pgg-gpg.el --- GnuPG support for PGG.
;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
-;; 2005, 2006 Free Software Foundation, Inc.
+;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
;; Author: Daiki Ueno <ueno@unixuser.org>
-;; Symmetric encryption support added by: Sascha Wilde <wilde@sha-bang.de>
+;; Symmetric encryption and gpg-agent support added by:
+;; Sascha Wilde <wilde@sha-bang.de>
;; Created: 1999/10/28
;; Keywords: PGP, OpenPGP, GnuPG
+;; Package: pgg
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Code:
(eval-when-compile
+ (require 'cl) ; for gpg macros
(require 'pgg))
(defgroup pgg-gpg ()
:type '(choice (const :tag "New `--recipient' option" "--recipient")
(const :tag "Old `--remote-user' option" "--remote-user")))
-(defcustom pgg-gpg-use-agent nil
+(defcustom pgg-gpg-use-agent t
"Whether to use gnupg agent for key caching."
:group 'pgg-gpg
:type 'boolean)
(defvar pgg-gpg-user-id nil
"GnuPG ID of your default identity.")
-(defvar pgg-gpg-user-id-alist nil
- "An alist mapping from key ID to user ID.")
-
-(defvar pgg-gpg-read-point nil)
-(defvar pgg-gpg-output-file-name nil)
-(defvar pgg-gpg-pending-status-list nil)
-(defvar pgg-gpg-key-id nil)
-(defvar pgg-gpg-passphrase nil)
-(defvar pgg-gpg-debug nil)
-
-(defun pgg-gpg-start-process (args)
- (let* ((output-file-name (pgg-make-temp-file "pgg-output"))
+(defun pgg-gpg-process-region (start end passphrase program args)
+ (let* ((use-agent (and (null passphrase) (pgg-gpg-use-agent-p)))
+ (output-file-name (pgg-make-temp-file "pgg-output"))
(args
- (append (list "--no-tty"
- "--status-fd" "1"
- "--command-fd" "0"
- "--yes" ; overwrite
- "--output" output-file-name)
- (if pgg-gpg-use-agent '("--use-agent"))
- pgg-gpg-extra-args
- args))
- (coding-system-for-write 'binary)
- (process-connection-type nil)
+ `("--status-fd" "2"
+ ,@(if use-agent '("--use-agent")
+ (if passphrase '("--passphrase-fd" "0")))
+ "--yes" ; overwrite
+ "--output" ,output-file-name
+ ,@pgg-gpg-extra-args ,@args))
+ (output-buffer pgg-output-buffer)
+ (errors-buffer pgg-errors-buffer)
(orig-mode (default-file-modes))
- (buffer (generate-new-buffer " *pgg-gpg*"))
- process)
- (with-current-buffer buffer
- (make-local-variable 'pgg-gpg-read-point)
- (setq pgg-gpg-read-point (point-min))
- (make-local-variable 'pgg-gpg-output-file-name)
- (setq pgg-gpg-output-file-name output-file-name)
- (make-local-variable 'pgg-gpg-pending-status-list)
- (setq pgg-gpg-pending-status-list nil)
- (make-local-variable 'pgg-gpg-key-id)
- (setq pgg-gpg-key-id nil)
- (make-local-variable 'pgg-gpg-passphrase)
- (setq pgg-gpg-passphrase nil))
+ (process-connection-type nil)
+ (inhibit-redisplay t)
+ process status exit-status
+ passphrase-with-newline
+ encoded-passphrase-with-new-line)
+ (with-current-buffer (get-buffer-create errors-buffer)
+ (buffer-disable-undo)
+ (erase-buffer))
(unwind-protect
(progn
(set-default-file-modes 448)
- (setq process
- (apply #'start-process "pgg-gpg" buffer pgg-gpg-program args)))
- (set-default-file-modes orig-mode))
- (set-process-filter process #'pgg-gpg-process-filter)
- (set-process-sentinel process #'pgg-gpg-process-sentinel)
- process))
-
-(defun pgg-gpg-process-filter (process input)
- (save-excursion
- (if pgg-gpg-debug
- (save-excursion
- (set-buffer (get-buffer-create " *pgg-gpg-debug*"))
- (goto-char (point-max))
- (insert input)))
- (set-buffer (process-buffer process))
- (goto-char (point-max))
- (insert input)
- (goto-char pgg-gpg-read-point)
- (beginning-of-line)
- (while (looking-at ".*\n") ;the input line is finished
- (save-excursion
- (if (looking-at "\\[GNUPG:] \\([A-Z_]+\\)\\>.*")
- (let* ((status (match-string 1))
- (symbol (intern-soft (concat "pgg-gpg-status-" status)))
- (entry (member status pgg-gpg-pending-status-list)))
- (if entry
- (setq pgg-gpg-pending-status-list
- (delq (car entry)
- pgg-gpg-pending-status-list)))
- (if (and symbol
- (fboundp symbol))
- (funcall symbol process (buffer-substring (match-beginning 1)
- (match-end 0)))))))
- (forward-line))
- (setq pgg-gpg-read-point (point))))
-
-(defun pgg-gpg-process-sentinel (process status)
- (set-process-filter process nil)
- (save-excursion
- ;; Copy the contents of process-buffer to pgg-errors-buffer.
- (set-buffer (get-buffer-create pgg-errors-buffer))
- (buffer-disable-undo)
- (erase-buffer)
- (when (buffer-live-p (process-buffer process))
- (insert-buffer-substring (process-buffer process))
- (goto-char (point-min))
- ;(delete-matching-lines "^\\[GNUPG:] ")
- (goto-char (point-min))
- (while (re-search-forward "^gpg: " nil t)
- (replace-match "")))
- ;; Read the contents of the output file to pgg-output-buffer.
- (set-buffer (get-buffer-create pgg-output-buffer))
- (buffer-disable-undo)
- (erase-buffer)
- (if (and (equal status "finished\n")
- (buffer-live-p (process-buffer process)))
- (let ((output-file-name (with-current-buffer (process-buffer process)
- pgg-gpg-output-file-name)))
- (when (file-exists-p output-file-name)
- (let ((coding-system-for-read (if pgg-text-mode
- 'raw-text
- 'binary)))
- (insert-file-contents output-file-name))
- (delete-file output-file-name))))))
-
-(defun pgg-gpg-wait-for-status (process status-list)
- (with-current-buffer (process-buffer process)
- (setq pgg-gpg-pending-status-list status-list)
- (while (and (eq (process-status process) 'run)
- pgg-gpg-pending-status-list)
- (accept-process-output process 1))))
-
-(defun pgg-gpg-wait-for-completion (process &optional status-list)
- (process-send-eof process)
- (while (eq (process-status process) 'run)
- (sit-for 0.1))
- (save-excursion
- (set-buffer (process-buffer process))
- (setq status-list (copy-sequence status-list))
- (let ((pointer status-list))
- (while pointer
+ (let ((coding-system-for-write 'binary))
+ (setq process
+ (apply #'start-process "*GnuPG*" errors-buffer
+ program args)))
+ (set-process-sentinel process #'ignore)
+ (when passphrase
+ (setq passphrase-with-newline (concat passphrase "\n"))
+ (if pgg-passphrase-coding-system
+ (progn
+ (setq encoded-passphrase-with-new-line
+ (encode-coding-string
+ passphrase-with-newline
+ (coding-system-change-eol-conversion
+ pgg-passphrase-coding-system 'unix)))
+ (pgg-clear-string passphrase-with-newline))
+ (setq encoded-passphrase-with-new-line passphrase-with-newline
+ passphrase-with-newline nil))
+ (process-send-string process encoded-passphrase-with-new-line))
+ (process-send-region process start end)
+ (process-send-eof process)
+ (while (eq 'run (process-status process))
+ (accept-process-output process 5))
+ ;; Accept any remaining pending output coming after the
+ ;; status change.
+ (accept-process-output process 5)
+ (setq status (process-status process)
+ exit-status (process-exit-status process))
+ (delete-process process)
+ (with-current-buffer (get-buffer-create output-buffer)
+ (buffer-disable-undo)
+ (erase-buffer)
+ (if (file-exists-p output-file-name)
+ (let ((coding-system-for-read (if pgg-text-mode
+ 'raw-text
+ 'binary)))
+ (insert-file-contents output-file-name)))
+ (set-buffer errors-buffer)
+ (if (memq status '(stop signal))
+ (error "%s exited abnormally: '%s'" program exit-status))
+ (if (= 127 exit-status)
+ (error "%s could not be found" program))))
+ (if passphrase-with-newline
+ (pgg-clear-string passphrase-with-newline))
+ (if encoded-passphrase-with-new-line
+ (pgg-clear-string encoded-passphrase-with-new-line))
+ (if (and process (eq 'run (process-status process)))
+ (interrupt-process process))
+ (if (file-exists-p output-file-name)
+ (delete-file output-file-name))
+ (set-default-file-modes orig-mode))))
+
+(defun pgg-gpg-possibly-cache-passphrase (passphrase &optional key notruncate)
+ (if (and passphrase
+ pgg-cache-passphrase
+ (progn
+ (goto-char (point-min))
+ (re-search-forward "^\\[GNUPG:] \\(GOOD_PASSPHRASE\\>\\)\\|\\(SIG_CREATED\\)" nil t)))
+ (pgg-add-passphrase-to-cache
+ (or key
+ (progn
+ (goto-char (point-min))
+ (if (re-search-forward
+ "^\\[GNUPG:] NEED_PASSPHRASE\\(_PIN\\)? \\w+ ?\\w*" nil t)
+ (substring (match-string 0) -8))))
+ passphrase
+ notruncate)))
+
+(defvar pgg-gpg-all-secret-keys 'unknown)
+
+(defun pgg-gpg-lookup-all-secret-keys ()
+ "Return all secret keys present in secret key ring."
+ (when (eq pgg-gpg-all-secret-keys 'unknown)
+ (setq pgg-gpg-all-secret-keys '())
+ (let ((args (list "--with-colons" "--no-greeting" "--batch"
+ "--list-secret-keys")))
+ (with-temp-buffer
+ (apply #'call-process pgg-gpg-program nil t nil args)
(goto-char (point-min))
- (unless (re-search-forward
- (concat "^\\[GNUPG:] " (car pointer) "\\>")
- nil t)
- (setq status-list (delq (car pointer) status-list)))
- (setq pointer (cdr pointer))))
- (kill-buffer (process-buffer process))
- status-list))
-
-(defun pgg-gpg-status-USERID_HINT (process line)
- (if (string-match "\\`USERID_HINT \\([^ ]+\\) \\(.*\\)" line)
- (let* ((key-id (match-string 1 line))
- (user-id (match-string 2 line))
- (entry (assoc key-id pgg-gpg-user-id-alist)))
- (if entry
- (setcdr entry user-id)
- (setq pgg-gpg-user-id-alist (cons (cons key-id user-id)
- pgg-gpg-user-id-alist))))))
-
-(defun pgg-gpg-status-NEED_PASSPHRASE (process line)
- (if (string-match "\\`NEED_PASSPHRASE \\([^ ]+\\)" line)
- (setq pgg-gpg-key-id (match-string 1 line))))
-
-(defun pgg-gpg-status-NEED_PASSPHRASE_SYM (process line)
- (setq pgg-gpg-key-id 'SYM))
-
-(defun pgg-gpg-status-NEED_PASSPHRASE_PIN (process line)
- (setq pgg-gpg-key-id 'PIN))
-
-(defun pgg-gpg-status-GET_HIDDEN (process line)
- (let ((entry (assoc pgg-gpg-key-id pgg-gpg-user-id-alist)))
- (if (setq pgg-gpg-passphrase
- (if (eq pgg-gpg-key-id 'SYM)
- (pgg-read-passphrase
- "GnuPG passphrase for symmetric encryption: ")
- (pgg-read-passphrase
- (format "GnuPG passphrase for %s: "
- (if entry
- (cdr entry)
- pgg-gpg-key-id))
- (if (eq pgg-gpg-key-id 'PIN)
- "PIN"
- pgg-gpg-key-id))))
- (process-send-string process (concat pgg-gpg-passphrase "\n")))))
-
-(defun pgg-gpg-status-GOOD_PASSPHRASE (process line)
- (when (and pgg-gpg-passphrase
- (stringp pgg-gpg-key-id))
- (pgg-add-passphrase-to-cache pgg-gpg-key-id pgg-gpg-passphrase)
- (setq pgg-gpg-passphrase nil)))
-
-(defun pgg-gpg-status-BAD_PASSPHRASE (process line)
- (when pgg-gpg-passphrase
- (fillarray pgg-gpg-passphrase 0)
- (setq pgg-gpg-passphrase nil)))
+ (while (re-search-forward
+ "^\\(sec\\|pub\\):[^:]*:[^:]*:[^:]*:\\([^:]*\\)" nil t)
+ (push (substring (match-string 2) 8)
+ pgg-gpg-all-secret-keys)))))
+ pgg-gpg-all-secret-keys)
(defun pgg-gpg-lookup-key (string &optional type)
"Search keys associated with STRING."
nil t)
(substring (match-string 2) 8)))))
+(defun pgg-gpg-lookup-key-owner (string &optional all)
+ "Search keys associated with STRING and return owner of identified key.
+
+The value may be just the bare key id, or it may be a combination of the
+user name associated with the key and the key id, with the key id enclosed
+in \"<...>\" angle brackets.
+
+Optional ALL non-nil means search all keys, including secret keys."
+ (let ((args (list "--with-colons" "--no-greeting" "--batch"
+ (if all "--list-secret-keys" "--list-keys")
+ string))
+ (key-regexp (concat "^\\(sec\\|pub\\|uid\\)"
+ ":[^:]*:[^:]*:[^:]*:\\([^:]*\\):[^:]*"
+ ":[^:]*:[^:]*:[^:]*:\\([^:]+\\):")))
+ (with-temp-buffer
+ (apply #'call-process pgg-gpg-program nil t nil args)
+ (goto-char (point-min))
+ (if (re-search-forward key-regexp
+ nil t)
+ (match-string 3)))))
+
+(defun pgg-gpg-key-id-from-key-owner (key-owner)
+ (cond ((not key-owner) nil)
+ ;; Extract bare key id from outermost paired angle brackets, if any:
+ ((string-match "[^<]*<\\(.+\\)>[^>]*" key-owner)
+ (substring key-owner (match-beginning 1)(match-end 1)))
+ (key-owner)))
+
(defun pgg-gpg-encrypt-region (start end recipients &optional sign passphrase)
"Encrypt the current region between START and END.
-If optional argument SIGN is non-nil, do a combined sign and encrypt."
+If optional argument SIGN is non-nil, do a combined sign and encrypt.
+
+If optional PASSPHRASE is not specified, it will be obtained from the
+passphrase cache or user."
(let* ((pgg-gpg-user-id (or pgg-gpg-user-id pgg-default-user-id))
+ (passphrase (or passphrase
+ (when (and sign (not (pgg-gpg-use-agent-p)))
+ (pgg-read-passphrase
+ (format "GnuPG passphrase for %s: "
+ pgg-gpg-user-id)
+ pgg-gpg-user-id))))
(args
(append
- '("--armor" "--always-trust" "--encrypt")
- (if pgg-text-mode '("--textmode"))
+ (list "--batch" "--armor" "--always-trust" "--encrypt")
+ (if pgg-text-mode (list "--textmode"))
(if sign (list "--sign" "--local-user" pgg-gpg-user-id))
- (if recipients
+ (if (or recipients pgg-encrypt-for-me)
(apply #'nconc
(mapcar (lambda (rcpt)
(list pgg-gpg-recipient-argument rcpt))
(append recipients
(if pgg-encrypt-for-me
- (list pgg-gpg-user-id))))))))
- (process (pgg-gpg-start-process args)))
- (if (and sign (not pgg-gpg-use-agent))
- (pgg-gpg-wait-for-status process '("GOOD_PASSPHRASE")))
- (process-send-region process start end)
- (pgg-gpg-wait-for-completion process '("SIG_CREATED" "END_ENCRYPTION"))))
+ (list pgg-gpg-user-id)))))))))
+ (pgg-gpg-process-region start end passphrase pgg-gpg-program args)
+ (when sign
+ (with-current-buffer pgg-errors-buffer
+ ;; Possibly cache passphrase under, e.g. "jas", for future sign.
+ (pgg-gpg-possibly-cache-passphrase passphrase pgg-gpg-user-id)
+ ;; Possibly cache passphrase under, e.g. B565716F, for future decrypt.
+ (pgg-gpg-possibly-cache-passphrase passphrase)))
+ (pgg-process-when-success)))
(defun pgg-gpg-encrypt-symmetric-region (start end &optional passphrase)
- "Encrypt&nbs
projects / gnus / blobdiff