;;; epg.el --- the EasyPG Library -*- lexical-binding: t -*-
-;; Copyright (C) 1999-2000, 2002-2011 Free Software Foundation, Inc.
+;; Copyright (C) 1999-2000, 2002-2013 Free Software Foundation, Inc.
;; Author: Daiki Ueno <ueno@unixuser.org>
;; Keywords: PGP, GnuPG
(defvar epg-key-id nil)
(defvar epg-context nil)
(defvar epg-debug-buffer nil)
+(defvar epg-agent-file nil)
+(defvar epg-agent-mtime nil)
;; from gnupg/include/cipher.h
(defconst epg-cipher-algorithm-alist
(defconst epg-invalid-recipients-reason-alist
'((0 . "No specific reason given")
(1 . "Not Found")
- (2 . "Ambigious specification")
+ (2 . "Ambiguous specification")
(3 . "Wrong key usage")
(4 . "Key revoked")
(5 . "Key expired")
(defconst epg-delete-problem-reason-alist
'((1 . "No such key")
(2 . "Must delete secret key first")
- (3 . "Ambigious specification")))
+ (3 . "Ambiguous specification")))
(defconst epg-import-ok-reason-alist
'((0 . "Not actually changed")
(defvar epg-prompt-alist nil)
(put 'epg-error 'error-conditions '(epg-error error))
+(put 'epg-error 'error-message "GPG error")
(defun epg-make-data-from-file (file)
"Make a data object from FILE."
PROGRESS-CALLBACK is either a function, or a cons-cell whose
car is a function and cdr is a callback data.
-The function gets five arguments: the context, the operation
+The function gets six arguments: the context, the operation
description, the character to display a progress unit, the
current amount done, the total amount to be done, and the
callback data (if any)."
"Convert SIGNATURE to a human readable string."
(let* ((user-id (cdr (assoc (epg-signature-key-id signature)
epg-user-id-alist)))
- (pubkey-algorithm (epg-signature-pubkey-algorithm signature)))
+ (pubkey-algorithm (epg-signature-pubkey-algorithm signature))
+ (key-id (epg-signature-key-id signature)))
(concat
(cond ((eq (epg-signature-status signature) 'good)
"Good signature from ")
"Signature made by revoked key ")
((eq (epg-signature-status signature) 'no-pubkey)
"No public key for "))
- (epg-signature-key-id signature)
+ key-id
(if user-id
(concat " "
(if (stringp user-id)
(format " secret keys unchanged: %d\n"
(epg-import-result-secret-unchanged import-result)))))
+(defun epg-error-to-string (error)
+ (cond
+ ((eq (car error) 'exit)
+ "Exit")
+ ((eq (car error) 'quit)
+ "Cancelled")
+ ((eq (car error) 'no-data)
+ (let ((entry (assq (cdr error) epg-no-data-reason-alist)))
+ (if entry
+ (format "No data (%s)" (downcase (cdr entry)))
+ "No data")))
+ ((eq (car error) 'unexpected)
+ (let ((entry (assq (cdr error) epg-unexpected-reason-alist)))
+ (if entry
+ (format "Unexpected (%s)" (downcase (cdr entry)))
+ "Unexpected")))
+ ((eq (car error) 'bad-armor)
+ "Bad armor")
+ ((memq (car error) '(invalid-recipient invalid-signer))
+ (concat
+ (if (eq (car error) 'invalid-recipient)
+ "Unusable public key"
+ "Unusable secret key")
+ (let ((entry (assq 'requested (cdr error))))
+ (if entry
+ (format ": %s" (cdr entry))
+ ": <unknown>"))
+ (let ((entry (assq 'reason (cdr error))))
+ (if (and entry
+ (> (cdr entry) 0) ;no specific reason given
+ (setq entry (assq (cdr entry)
+ epg-invalid-recipients-reason-alist)))
+ (format " (%s)" (downcase (cdr entry)))
+ ""))))
+ ((eq (car error) 'no-pubkey)
+ (format "No public key: %s" (cdr error)))
+ ((eq (car error) 'no-seckey)
+ (format "No secret key: %s" (cdr error)))
+ ((eq (car error) 'no-recipients)
+ "No recipients")
+ ((eq (car error) 'no-signers)
+ "No signers")
+ ((eq (car error) 'delete-problem)
+ (let ((entry (assq (cdr error) epg-delete-problem-reason-alist)))
+ (if entry
+ (format "Delete problem (%s)" (downcase (cdr entry)))
+ "Delete problem")))
+ ((eq (car error) 'key-not-created)
+ "Key not created")))
+
+(defun epg-errors-to-string (errors)
+ (mapconcat #'epg-error-to-string errors "; "))
+
(defun epg--start (context args)
"Start `epg-gpg-program' in a subprocess with given ARGS."
(if (and (epg-context-process context)
(if (eq (epg-context-protocol context) 'CMS)
epg-gpgsm-program
epg-gpg-program)))
- (let* ((args (append (list "--no-tty"
+ (let* ((agent-info (getenv "GPG_AGENT_INFO"))
+ (args (append (list "--no-tty"
"--status-fd" "1"
"--yes")
(if (and (not (eq (epg-context-protocol context) 'CMS))
- (string-match ":" (or (getenv "GPG_AGENT_INFO")
- "")))
+ (string-match ":" (or agent-info "")))
'("--use-agent"))
(if (and (not (eq (epg-context-protocol context) 'CMS))
(epg-context-progress-callback context))
(coding-system-for-write 'binary)
(coding-system-for-read 'binary)
process-connection-type
+ (process-environment process-environment)
(orig-mode (default-file-modes))
(buffer (generate-new-buffer " *epg*"))
- process)
+ process
+ terminal-name
+ agent-file
+ (agent-mtime '(0 0 0 0)))
+ ;; Set GPG_TTY and TERM for pinentry-curses. Note that we can't
+ ;; use `terminal-name' here to get the real pty name for the child
+ ;; process, though /dev/fd/0" is not portable.
+ (unless (memq system-type '(ms-dos windows-nt))
+ (with-temp-buffer
+ (condition-case nil
+ (when (= (call-process "tty" "/dev/fd/0" t) 0)
+ (delete-char -1)
+ (setq terminal-name (buffer-string)))
+ (file-error))))
+ (when terminal-name
+ (setq process-environment
+ (cons (concat "GPG_TTY=" terminal-name)
+ (cons "TERM=xterm" process-environment))))
+ ;; Record modified time of gpg-agent socket to restore the Emacs
+ ;; frame on text terminal in `epg-wait-for-completion'.
+ ;; See
+ ;; <http://lists.gnu.org/archive/html/emacs-devel/2007-02/msg00755.html>
+ ;; for more details.
+ (when (and agent-info (string-match "\\(.*\\):[0-9]+:[0-9]+" agent-info))
+ (setq agent-file (match-string 1 agent-info)
+ agent-mtime (or (nth 5 (file-attributes agent-file)) '(0 0 0 0))))
(if epg-debug
(save-excursion
(unless epg-debug-buffer
(setq epg-debug-buffer (generate-new-buffer " *epg-debug*")))
(set-buffer epg-debug-buffer)
(goto-char (point-max))
- (insert (format "%s %s\n"
+ (insert (if agent-info
+ (format "GPG_AGENT_INFO=%s\n" agent-info)
+ "GPG_AGENT_INFO is not set\n")
+ (format "%s %s\n"
(if (eq (epg-context-protocol context) 'CMS)
epg-gpgsm-program
epg-gpg-program)
(make-local-variable 'epg-key-id)
(setq epg-key-id nil)
(make-local-variable 'epg-context)
- (setq epg-context context))
+ (setq epg-context context)
+ (make-local-variable 'epg-agent-file)
+ (setq epg-agent-file agent-file)
+ (make-local-variable 'epg-agent-mtime)
+ (setq epg-agent-mtime agent-mtime))
(unwind-protect
(progn
(set-default-file-modes 448)
(if epg-pending-status-list
(epg-context-set-result-for
context 'error
- (cons (list 'exit)
+ (cons '(exit)
(epg-context-result-for context 'error))))))
(defun epg-wait-for-completion (context)
(while (eq (process-status (epg-context-process context)) 'run)
(accept-process-output (epg-context-process context) 1))
;; This line is needed to run the process-filter right now.
- (sleep-for 0.1))
+ (sleep-for 0.1)
+ ;; Restore Emacs frame on text terminal, when pinentry-curses has terminated.
+ (if (with-current-buffer (process-buffer (epg-context-process context))
+ (and epg-agent-file
+ (> (float-time (or (nth 5 (file-attributes epg-agent-file))
+ '(0 0 0 0)))
+ (float-time epg-agent-mtime))))
+ (redraw-frame (selected-frame)))
+ (epg-context-set-result-for
+ context 'error
+ (nreverse (epg-context-result-for context 'error))))
(defun epg-reset (context)
"Reset the CONTEXT."
(epg--status-*SIG context 'bad string))
(defun epg--status-NO_PUBKEY (context string)
- (let ((signature (car (epg-context-result-for context 'verify))))
- (if (and signature
- (eq (epg-signature-status signature) 'error)
- (equal (epg-signature-key-id signature) string))
- (epg-signature-set-status signature 'no-pubkey))))
+ (if (eq (epg-context-operation context) 'verify)
+ (let ((signature (car (epg-context-result-for context 'verify))))
+ (if (and signature
+ (eq (epg-signature-status signature) 'error)
+ (equal (epg-signature-key-id signature) string))
+ (epg-signature-set-status signature 'no-pubkey)))
+ (epg-context-set-result-for
+ context 'error
+ (cons (cons 'no-pubkey string)
+ (epg-context-result-for context 'error)))))
+
+(defun epg--status-NO_SECKEY (context string)
+ (epg-context-set-result-for
+ context 'error
+ (cons (cons 'no-seckey string)
+ (epg-context-result-for context 'error))))
(defun epg--time-from-seconds (seconds)
(let ((number-seconds (string-to-number (concat seconds ".0"))))
context 'key
(cons (list 'key-expired (cons 'expiration-time
(epg--time-from-seconds string)))
- (epg-context-result-for context 'error))))
+ (epg-context-result-for context 'key))))
(defun epg--status-KEYREVOKED (context _string)
(epg-context-set-result-for
context 'key
(cons '(key-revoked)
- (epg-context-result-for context 'error))))
+ (epg-context-result-for context 'key))))
(defun epg--status-BADARMOR (context _string)
(epg-context-set-result-for
(cons (list 'invalid-recipient
(cons 'reason
(string-to-number (match-string 1 string)))
- (cons 'requested-recipient
+ (cons 'requested
+ (match-string 2 string)))
+ (epg-context-result-for context 'error)))))
+
+(defun epg--status-INV_SGNR (context string)
+ (if (string-match "\\`\\([0-9]+\\) \\(.*\\)" string)
+ (epg-context-set-result-for
+ context 'error
+ (cons (list 'invalid-signer
+ (cons 'reason
+ (string-to-number (match-string 1 string)))
+ (cons 'requested
(match-string 2 string)))
(epg-context-result-for context 'error)))))
(cons '(no-recipients)
(epg-context-result-for context 'error))))
+(defun epg--status-NO_SGNR (context _string)
+ (epg-context-set-result-for
+ context 'error
+ (cons '(no-signers)
+ (epg-context-result-for context 'error))))
+
(defun epg--status-DELETE_PROBLEM (context string)
(if (string-match "\\`\\([0-9]+\\)" string)
(epg-context-set-result-for
(epg-context-set-result-for context 'import-status nil)))
(defun epg-passphrase-callback-function (context key-id _handback)
+ (declare (obsolete epa-passphrase-callback-function "23.1"))
(if (eq key-id 'SYM)
(read-passwd "Passphrase for symmetric encryption: "
(eq (epg-context-operation context) 'encrypt))
(format "Passphrase for %s %s: " key-id (cdr entry))
(format "Passphrase for %s: " key-id)))))))
-(make-obsolete 'epg-passphrase-callback-function
- 'epa-passphrase-callback-function "23.1")
-
(defun epg--list-keys-1 (context name mode)
(let ((args (append (if epg-gpg-home-directory
(list "--homedir" epg-gpg-home-directory))
of PREFIX, and expanding against `temporary-file-directory' if necessary),
is guaranteed to point to a newly created empty file.
You can then use `write-region' to write new data into the file."
- (let (tempdir tempfile)
+ (let ((orig-modes (default-file-modes))
+ tempdir tempfile)
(setq prefix (expand-file-name prefix
(if (featurep 'xemacs)
(temp-directory)
(unwind-protect
(let (file)
;; First, create a temporary directory.
+ (set-default-file-modes #o700)
(while (condition-case ()
(progn
(setq tempdir (make-temp-name
(make-directory tempdir))
;; let's try again.
(file-already-exists t)))
- (set-file-modes tempdir 448)
;; Second, create a temporary file in the tempdir.
;; There *is* a race condition between `make-temp-name'
;; and `write-region', but we don't care it since we are
;; in a private directory now.
(setq tempfile (make-temp-name (concat tempdir "/EMU")))
(write-region "" nil tempfile nil 'silent)
- (set-file-modes tempfile 384)
;; Finally, make a hard-link from the tempfile.
(while (condition-case ()
(progn
;; let's try again.
(file-already-exists t)))
file)
+ (set-default-file-modes orig-modes)
;; Cleanup the tempfile.
(and tempfile
(file-exists-p tempfile)
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-decrypt-file' or `epg-decrypt-string' instead."
(unless (epg-data-file cipher)
(epg-wait-for-status context '("BEGIN_DECRYPTION"))))
(defun epg--check-error-for-decrypt (context)
- (if (epg-context-result-for context 'decryption-failed)
- (signal 'epg-error (list "Decryption failed")))
- (if (epg-context-result-for context 'no-secret-key)
- (signal 'epg-error
- (list "No secret key"
- (epg-context-result-for context 'no-secret-key))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if (epg-context-result-for context 'decryption-failed)
+ (signal 'epg-error
+ (list "Decryption failed" (epg-errors-to-string errors))))
(unless (epg-context-result-for context 'decryption-okay)
- (let* ((error (epg-context-result-for context 'error)))
- (if (assq 'no-data error)
- (signal 'epg-error (list "No data")))
- (signal 'epg-error (list "Can't decrypt" error)))))
+ (signal 'epg-error
+ (list "Can't decrypt" (epg-errors-to-string errors))))))
(defun epg-decrypt-file (context cipher plain)
"Decrypt a file CIPHER and store the result to a file PLAIN.
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-verify-file' or `epg-verify-string' instead."
(epg-context-set-operation context 'verify)
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-sign-file' or `epg-sign-string' instead."
(epg-context-set-operation context 'sign)
(epg-start-sign context (epg-make-data-from-file plain) mode)
(epg-wait-for-completion context)
(unless (epg-context-result-for context 'sign)
- (if (epg-context-result-for context 'error)
- (error "Sign failed: %S"
- (epg-context-result-for context 'error))
- (error "Sign failed")))
+ (let ((errors (epg-context-result-for context 'error)))
+ (signal 'epg-error
+ (list "Sign failed" (epg-errors-to-string errors)))))
(unless signature
(epg-read-output context)))
(unless signature
(epg-wait-for-completion context)
(unless (epg-context-result-for context 'sign)
(if (epg-context-result-for context 'error)
- (error "Sign failed: %S"
- (epg-context-result-for context 'error))
- (error "Sign failed")))
+ (let ((errors (epg-context-result-for context 'error)))
+ (signal 'epg-error
+ (list "Sign failed" (epg-errors-to-string errors))))))
(epg-read-output context))
(epg-delete-output-file context)
(if input-file
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-encrypt-file' or `epg-encrypt-string' instead."
(epg-context-set-operation context 'encrypt)
(epg-start-encrypt context (epg-make-data-from-file plain)
recipients sign always-trust)
(epg-wait-for-completion context)
- (if (and sign
- (not (epg-context-result-for context 'sign)))
- (if (epg-context-result-for context 'error)
- (error "Sign failed: %S"
- (epg-context-result-for context 'error))
- (error "Sign failed")))
- (if (epg-context-result-for context 'error)
- (error "Encrypt failed: %S"
- (epg-context-result-for context 'error)))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if (and sign
+ (not (epg-context-result-for context 'sign)))
+ (signal 'epg-error
+ (list "Sign failed" (epg-errors-to-string errors))))
+ (if errors
+ (signal 'epg-error
+ (list "Encrypt failed" (epg-errors-to-string errors)))))
(unless cipher
(epg-read-output context)))
(unless cipher
(epg-make-data-from-string plain))
recipients sign always-trust)
(epg-wait-for-completion context)
- (if (and sign
- (not (epg-context-result-for context 'sign)))
- (if (epg-context-result-for context 'error)
- (error "Sign failed: %S"
- (epg-context-result-for context 'error))
- (error "Sign failed")))
- (if (epg-context-result-for context 'error)
- (error "Encrypt failed: %S"
- (epg-context-result-for context 'error)))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if (and sign
+ (not (epg-context-result-for context 'sign)))
+ (signal 'epg-error
+ (list "Sign failed" (epg-errors-to-string errors))))
+ (if errors
+ (signal 'epg-error
+ (list "Encrypt failed" (epg-errors-to-string errors)))))
(epg-read-output context))
(epg-delete-output-file context)
(if input-file
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-export-keys-to-file' or `epg-export-keys-to-string' instead."
(epg-context-set-operation context 'export-keys)
(epg--make-temp-file "epg-output")))
(epg-start-export-keys context keys)
(epg-wait-for-completion context)
- (if (epg-context-result-for context 'error)
- (error "Export keys failed: %S"
- (epg-context-result-for context 'error)))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Export keys failed"
+ (epg-errors-to-string errors)))))
(unless file
(epg-read-output context)))
(unless file
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-import-keys-from-file' or `epg-import-keys-from-string' instead."
(epg-context-set-operation context 'import-keys)
(progn
(epg-start-import-keys context keys)
(epg-wait-for-completion context)
- (if (epg-context-result-for context 'error)
- (error "Import keys failed: %S"
- (epg-context-result-for context 'error))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Import keys failed"
+ (epg-errors-to-string errors))))))
(epg-reset context)))
(defun epg-import-keys-from-file (context keys)
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-receive-keys' instead."
(epg-context-set-operation context 'receive-keys)
(progn
(epg-start-receive-keys context keys)
(epg-wait-for-completion context)
- (if (epg-context-result-for context 'error)
- (error "Receive keys failed: %S"
- (epg-context-result-for context 'error))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Receive keys failed"
+ (epg-errors-to-string errors))))))
(epg-reset context)))
(defalias 'epg-import-keys-from-server 'epg-receive-keys)
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-delete-keys' instead."
(epg-context-set-operation context 'delete-keys)
(progn
(epg-start-delete-keys context keys allow-secret)
(epg-wait-for-completion context)
- (let ((entry (assq 'delete-problem
- (epg-context-result-for context 'error))))
- (if entry
- (if (setq entry (assq (cdr entry)
- epg-delete-problem-reason-alist))
- (error "Delete keys failed: %s" (cdr entry))
- (error "Delete keys failed")))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Delete keys failed"
+ (epg-errors-to-string errors))))))
(epg-reset context)))
(defun epg-start-sign-keys (context keys &optional local)
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-sign-keys' instead."
+ (declare (obsolete nil "23.1"))
(epg-context-set-operation context 'sign-keys)
(epg-context-set-result context nil)
(epg--start context (cons (if local
(epg-sub-key-id
(car (epg-key-sub-key-list key))))
keys))))
-(make-obsolete 'epg-start-sign-keys "do not use." "23.1")
(defun epg-sign-keys (context keys &optional local)
"Sign KEYS from the key ring."
+ (declare (obsolete nil "23.1"))
(unwind-protect
(progn
(epg-start-sign-keys context keys local)
(epg-wait-for-completion context)
- (if (epg-context-result-for context 'error)
- (error "Sign keys failed: %S"
- (epg-context-result-for context 'error))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Sign keys failed"
+ (epg-errors-to-string errors))))))
(epg-reset context)))
-(make-obsolete 'epg-sign-keys "do not use." "23.1")
(defun epg-start-generate-key (context parameters)
"Initiate a key generation.
If you use this function, you will need to wait for the completion of
`epg-gpg-program' by using `epg-wait-for-completion' and call
-`epg-reset' to clear a temporaly output file.
+`epg-reset' to clear a temporary output file.
If you are unsure, use synchronous version of this function
`epg-generate-key-from-file' or `epg-generate-key-from-string' instead."
(epg-context-set-operation context 'generate-key)
(progn
(epg-start-generate-key context (epg-make-data-from-file parameters))
(epg-wait-for-completion context)
- (if (epg-context-result-for context 'error)
- (error "Generate key failed: %S"
- (epg-context-result-for context 'error))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Generate key failed"
+ (epg-errors-to-string errors))))))
(epg-reset context)))
(defun epg-generate-key-from-string (context parameters)
(progn
(epg-start-generate-key context (epg-make-data-from-string parameters))
(epg-wait-for-completion context)
- (if (epg-context-result-for context 'error)
- (error "Generate key failed: %S"
- (epg-context-result-for context 'error))))
+ (let ((errors (epg-context-result-for context 'error)))
+ (if errors
+ (signal 'epg-error
+ (list "Generate key failed"
+ (epg-errors-to-string errors))))))
(epg-reset context)))
(defun epg--decode-percent-escape (string)