1 ;;; gpg.el --- Interface to GNU Privacy Guard
3 ;; Copyright (C) 2000 RUS-CERT, University Of Stuttgart
5 ;; Author: Florian Weimer <Florian.Weimer@RUS.Uni-Stuttgart.DE>
6 ;; Maintainer: Florian Weimer <Florian.Weimer@RUS.Uni-Stuttgart.DE>
10 ;; $Id: gpg.el,v 1.19 2003/05/01 16:03:41 larsi Exp $
12 ;; This file is NOT (yet?) part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
31 ;; ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA
32 ;; ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA
34 ;; This code is not well-tested. BE CAREFUL!
36 ;; ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA
37 ;; ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA ALPHA
39 ;; Implemented features which can be tested:
41 ;; * Customization for all flavors of PGP is possible.
42 ;; * The main operations (verify, decrypt, sign, encrypt, sign &
43 ;; encrypt) are implemented.
44 ;; * Optionally, Gero Treuner's gpg-2comp script is supported,
45 ;; to generate data which is compatible with PGP 2.6.3.
47 ;; Customizing external programs
48 ;; =============================
50 ;; The customization are very similar to those of others programs,
51 ;; only the C-ish "%" constructs have been replaced by more Lisp-like
54 ;; First, you have to adjust the default executable paths
55 ;; (`gpg-command-default-alist', customization group `gpg-options',
56 ;; "Controlling GnuPG invocation."). After that, you should
57 ;; change the configuration options which control how specific
58 ;; command line flags are built (`gpg-command-flag-sign-with-key',
59 ;; (`gpg-command-flag-recipient'). The elements of these lists are
60 ;; concatenated without spaces, and a new argument is only started
61 ;; where indicated. The `gpg-command-flag-recipient' list is special:
62 ;; it consists of two parts, the first one remains at the beginning
63 ;; of the argument, the second one is repeated for each recipient.
64 ;; Finally, `gpg-command-passphrase-env' has to be changed if there's
65 ;; no command line flag to force the external program to read the data
66 ;; from standard input before the message.
68 ;; In customization group `gpg-commands', "Controlling GnuPG
69 ;; invocation.", you have to supply the actual syntax for external
70 ;; program calls. Each variable consists of a pair of a program
71 ;; specification (if a Lisp symbol is given here, it is translated
72 ;; via `gpg-command-default-alist') and a list of program arguments
73 ;; with placeholders. Please read the documentation of each variable
74 ;; before making your adjustments and try to match the given
75 ;; requirements as closely as possible!
77 ;; The `gpg-commands-key' group, "GnuPG Key Management Commands.",
78 ;; specifies key management commands. The syntax of these variables
79 ;; is like those in the `gpg-commands' group. Note that the output
80 ;; format of some of these external programs has to match very close
81 ;; that of GnuPG. Additional tools (Thomas Roessler's "pgpring.c")
82 ;; are available if your favorite implementation of OpenPGP cannot
83 ;; output the this format.
85 ;; Security considerations
86 ;; =======================
88 ;; On a typical multiuser UNIX system, the memory image of the
89 ;; Emacs process is not locked, therefore it can be swapped to disk
90 ;; at any time. As a result, the passphrase might show up in the
91 ;; swap space (even if you don't use the passphrase cache, i.e. if
92 ;; `gpg-passphrase-timeout' is 0). If someone is able to run `gdb' or
93 ;; another debugger on your Emacs process, he might be able to recover
94 ;; the passphrase as well. Unfortunately, nothing can be done in
95 ;; order to prevent this at the moment.
97 ;; BE CAREFUL: If you use the passphrase cache feature, the passphrase
98 ;; is stored in the variable `gpg-passphrase' -- and it is NOT
99 ;; encrypted in any way. (This is a conceptual problem because the
100 ;; nature of the passphrase cache requires that Emacs is able to
101 ;; decrypt automatically, so only a very weak protection could be
104 ;; In addition, if you use an unpatched Emacs 20 (and earlier
105 ;; versions), passwords show up in the output of the `view-lossage'
106 ;; function (bound to `C-h l' by default).
112 (eval-when-compile (require 'cl))
115 (defalias 'gpg-point-at-eol
116 (if (fboundp 'point-at-eol)
118 'line-end-position)))
122 ;;; Customization: Groups:
125 "GNU Privacy Guard interface."
129 (defgroup gpg-options nil
130 "Controlling GnuPG invocation."
134 (defgroup gpg-commands nil
135 "Primary GnuPG Operations."
136 :tag "GnuPG Commands"
139 (defgroup gpg-commands-key nil
140 "Commands for GnuPG key management."
141 :tag "GnuPG Key Commands"
142 :group 'gpg-commands)
144 ;;; Customization: Widgets:
146 (if (get 'alist 'widget-type)
147 (define-widget 'gpg-command-alist 'alist
148 "An association list for GnuPG command names."
149 :key-type '(symbol :tag "Abbreviation")
150 :value-type '(string :tag "Program name")
151 :convert-widget 'widget-alist-convert-widget
153 (define-widget 'gpg-command-alist 'repeat
154 "An association list for GnuPG command names."
155 :args '((cons :format "%v"
156 (symbol :tag "Abbreviation")
157 (string :tag "Program name")))
160 (define-widget 'gpg-command-program 'choice
161 "Widget for entering the name of a program (mostly the GnuPG binary)."
163 :args '((const :tag "Default GnuPG program."
165 (const :tag "GnuPG compatibility wrapper."
167 (const :tag "Disabled"
169 (string :tag "Custom program" :format "%v")))
171 (define-widget 'gpg-command-sign-options 'cons
172 "Widget for entering signing options."
173 :args '(gpg-command-program
177 :format "%[Type%] %v"
178 (const :tag "Insert armor option here if necessary."
180 (const :tag "Insert text mode option here if necessary."
182 (const :tag "Insert the sign with key option here if necessary."
183 :value sign-with-key)
184 (string :format "%v")))))
186 (define-widget 'gpg-command-key-options 'cons
187 "Widget for entering key command options."
188 :args '(gpg-command-program
192 :format "%[Type%] %v"
193 (const :tag "Insert key ID here."
195 (string :format "%v")))))
197 ;;; Customization: Variables:
199 ;;; Customization: Variables: Paths and Flags:
201 (defcustom gpg-passphrase-timeout
203 "Timeout (in seconds) for the passphrase cache.
204 The passphrase cache is cleared after is hasn't been used for this
205 many seconds. The values 0 means that the passphrase is not cached at
207 :tag "Passphrase Timeout"
211 (defcustom gpg-default-key-id
213 "Default key/user ID used for signatures."
214 :tag "Default Key ID"
216 (const :tag "Use GnuPG default." :value nil)
220 (defcustom gpg-temp-directory
221 (expand-file-name "~/tmp")
222 "Directory for temporary files.
223 If you are running Emacs 20, this directory must have mode 0700."
224 :tag "Temp directory"
228 (defcustom gpg-command-default-alist
231 "Default paths for some GnuPG-related programs.
232 Modify this variable if you have to change the paths to the
233 executables required by the GnuPG interface. You can enter \"gpg-2comp\"
234 for `gpg-2comp' if you have obtained this script, in order to gain
235 PGP 2.6.x compatibility."
236 :tag "GnuPG programs"
237 :type 'gpg-command-alist
240 (defcustom gpg-command-all-arglist
242 "List of arguments to add to all GPG commands."
243 :tag "All command args"
246 (defcustom gpg-command-flag-textmode "--textmode"
247 "The flag to indicate canonical text mode to GnuPG."
248 :tag "Text mode flag"
252 (defcustom gpg-command-flag-armor "--armor"
253 "The flag to request ASCII-armoring output from GnuPG."
258 (defcustom gpg-command-flag-sign-with-key '("--local-user=" sign-with-key)
259 "String to include to specify the signing key ID.
260 The elements are concatenated (without spaces) to form a command line
262 :tag "Sign with key flag"
263 :type '(repeat :tag "Argument parts"
264 (choice :format "%[Type%] %v"
265 (const :tag "Start next argument." :value next-argument)
266 (const :tag "Insert signing key ID here." :value sign-with-key)
270 (defcustom gpg-command-flag-recipient
271 '(nil . ("-r" next-argument recipient next-argument))
272 "Format of a recipient specification.
273 The elements are concatenated (without spaces) to form a command line
274 option. The second part is repeated for each recipient."
275 :tag "Recipients Flag"
277 (repeat :tag "Common prefix"
278 (choice :format "%[Type%] %v"
279 (const :tag "Start next argument." :value next-argument)
281 (repeat :tag "For each recipient"
282 (choice :format "%[Type%] %v"
283 (const :tag "Start next argument." :value next-argument)
284 (const :tag "Insert recipient key ID here." :value recipient)
288 (defcustom gpg-command-passphrase-env
290 "Environment variable to set when a passphrase is required, or nil.
291 If an operation is invoked which requires a passphrase, this
292 environment variable is set before calling the external program to
293 indicate that it should read the passphrase from standard input."
294 :tag "Passphrase environment"
296 (const :tag "Disabled" :value nil)
298 (string :tag "Variable")
299 (string :tag "Value")))
302 ;;; Customization: Variables: GnuPG Commands:
304 (defcustom gpg-command-verify
305 '(gpg . ("--status-fd" "1" "--batch" "--verbose" "--verify" signature-file message-file))
306 "Command to verify a detached signature.
307 The invoked program has to read the signed message and the signature
308 from the given files. It should write human-readable information to
309 standard output and/or standard error. The program shall not convert
310 charsets or line endings; the input data shall be treated as binary."
311 :tag "Verify Command"
317 :format "%[Type%] %v"
318 (const :tag "Insert name of file containing the message here."
320 (const :tag "Insert name of file containing the signature here."
321 :value signature-file)
322 (string :format "%v"))))
323 :group 'gpg-commands)
325 (defcustom gpg-command-verify-cleartext
326 '(gpg . ("--status-fd" "1" "--batch" "--verbose" "--verify" message-file))
327 "Command to verify a message.
328 The invoked program has to read the signed message from the given
329 file. It should write human-readable information to standard output
330 and/or standard error. The program shall not convert charsets or line
331 endings; the input data shall be treated as binary."
332 :tag "Cleartext Verify Command"
338 :format "%[Type%] %v"
339 (const :tag "Insert name of file containing the message here."
341 (string :format "%v"))))
342 :group 'gpg-commands)
344 (defcustom gpg-command-decrypt
345 '(gpg . ("--status-fd" "2" "--decrypt" "--batch" "--passphrase-fd=0"))
346 "Command to decrypt a message.
347 The invoked program has to read the passphrase from standard
348 input, followed by the encrypted message. It writes the decrypted
349 message to standard output, and human-readable diagnostic messages to
351 :tag "Decrypt Command"
357 :format "%[Type%] %v"
358 (const :tag "Insert name of file containing the message here."
360 (string :format "%v"))))
361 :group 'gpg-commands)
363 (defcustom gpg-command-sign-cleartext
364 '(gpg-2comp . ("--batch" "--passphrase-fd=0" "--output=-"
365 armor textmode "--clearsign"
367 "Command to create a \"clearsign\" text file.
368 The invoked program has to read the passphrase from standard input,
369 followed by the message to sign. It should write the ASCII-amored
370 signed text message to standard output, and diagnostic messages to
372 :tag "Clearsign Command"
373 :type 'gpg-command-sign-options
374 :group 'gpg-commands)
376 (defcustom gpg-command-sign-detached
377 '(gpg-2comp . ("--batch" "--passphrase-fd=0" "--output=-"
378 armor textmode "--detach-sign"
380 "Command to create a detached signature.
381 The invoked program has to read the passphrase from standard input,
382 followed by the message to sign. It should write the ASCII-amored
383 detached signature to standard output, and diagnostic messages to
384 standard error. The program shall not convert charsets or line
385 endings; the input data shall be treated as binary."
386 :tag "Sign Detached Command"
387 :type 'gpg-command-sign-options
388 :group 'gpg-commands)
390 (defcustom gpg-command-sign-encrypt
391 '(gpg-2comp . ("--batch" "--passphrase-fd=0" "--output=-"
392 armor textmode "--always-trust" sign-with-key recipients
393 "--sign" "--encrypt" plaintext-file))
394 "Command to sign and encrypt a file.
395 The invoked program has to read the passphrase from standard input,
396 followed by the message to sign and encrypt if there is no
397 `plaintext-file' placeholder. It should write the ASCII-amored
398 encrypted message to standard output, and diagnostic messages to
400 :tag "Sign And Encrypt Command"
406 :format "%[Type%] %v"
407 (const :tag "Insert the `sign with key' option here if necessary."
408 :value sign-with-key)
409 (const :tag "Insert list of recipients here."
411 (const :tag "Insert here name of file with plaintext."
412 :value plaintext-file)
413 (string :format "%v"))))
414 :group 'gpg-commands)
416 (defcustom gpg-command-encrypt
417 '(gpg-2comp . ("--batch" "--output=-" armor textmode "--always-trust"
418 "--encrypt" recipients plaintext-file))
419 "Command to encrypt a file.
420 The invoked program has to read the message to encrypt from standard
421 input or from the plaintext file (if the `plaintext-file' placeholder
422 is present). It should write the ASCII-amored encrypted message to
423 standard output, and diagnostic messages to standard error."
429 :format "%[Type%] %v"
430 (const :tag "Insert list of recipients here."
432 (const :tag "Insert here name of file with plaintext."
433 :value plaintext-file)
434 (string :format "%v"))))
435 :group 'gpg-commands)
437 ;;; Customization: Variables: Key Management Commands:
439 (defcustom gpg-command-key-import
440 '(gpg . ("--import" "--verbose" message-file))
441 "Command to import a public key from a file."
442 :tag "Import Command"
448 :format "%[Type%] %v"
449 (const :tag "Insert name of file containing the key here."
451 (string :format "%v"))))
452 :group 'gpg-commands-key)
454 (defcustom gpg-command-key-export
455 '(gpg . ("--no-verbose" "--armor" "--export" key-id))
456 "Command to export a public key from the key ring.
457 The key should be written to standard output using ASCII armor."
458 :tag "Export Command"
459 :type 'gpg-command-key-options
460 :group 'gpg-commands-key)
462 (defcustom gpg-command-key-verify
463 '(gpg . ("--no-verbose" "--batch" "--fingerprint" "--check-sigs" key-id))
464 "Command to verify a public key."
465 :tag "Verification Command"
466 :type 'gpg-command-key-options
467 :group 'gpg-commands-key)
469 (defcustom gpg-command-key-public-ring
470 '(gpg . ("--no-verbose" "--batch" "--with-colons" "--list-keys" key-id))
471 "Command to list the contents of the public key ring."
472 :tag "List Public Key Ring Command"
473 :type 'gpg-command-key-options
474 :group 'gpg-commands-key)
476 (defcustom gpg-command-key-secret-ring
477 '(gpg . ("--no-verbose" "--batch" "--with-colons"
478 "--list-secret-keys" key-id))
479 "Command to list the contents of the secret key ring."
480 :tag "List Secret Key Ring Command"
481 :type 'gpg-command-key-options
482 :group 'gpg-commands-key)
484 (defcustom gpg-command-key-retrieve
485 '(gpg . ("--batch" "--recv-keys" key-id))
486 "Command to retrieve public keys."
487 :tag "Retrieve Keys Command"
488 :type 'gpg-command-key-options
489 :group 'gpg-commands-key)
492 ;;;; Helper functions for GnuPG invocation:
494 ;;; Build the GnuPG command line:
496 (defun gpg-build-argument (template substitutions &optional pass-start)
497 "Build command line argument(s) by substituting placeholders.
498 TEMPLATE is a list of strings and symbols. The placeholder symbols in
499 it are replaced by SUBSTITUTIONS, the elements between
500 `next-argument' symbols are concatenated without spaces and are
503 SUBSTITIONS is a list of (SYMBOL . SEXP) pairs, where SEXP is either
504 a string (which is inserted literally), a list of strings (which are
505 inserted as well), or nil, which means to insert nothing.
507 If PASS-START is t, `next-argument' is also inserted into the result,
508 and symbols without a proper substitution are retained in the output,
509 otherwise, an untranslated symbol results in an error.
511 This function does not handle empty arguments reliably."
512 (let ((current-arg "")
515 (let* ((templ (pop template))
516 (repl (assoc templ substitutions))
517 (new (if repl (cdr repl) templ)))
519 ((eq templ 'next-argument)
520 ;; If the current argument is not empty, start a new one.
521 (unless (equal current-arg "")
522 (setq arglist (nconc arglist
524 (list current-arg 'next-argument)
525 (list current-arg))))
526 (setq current-arg "")))
527 ((null new) nil) ; Drop it.
528 ((and (not (stringp templ)) (null repl))
529 ;; Retain an untranslated symbol in the output if
530 ;; `pass-start' is true.
532 (error "No replacement for `%s'" templ))
533 (setq arglist (nconc arglist (list current-arg templ)))
534 (setq current-arg ""))
537 (setq new (list new)))
538 (setq current-arg (concat current-arg
539 (apply 'concat new)))))))
540 (unless (equal current-arg "")
541 (setq arglist (nconc arglist (list current-arg))))
544 (defun gpg-build-arg-list (template substitutions)
545 "Build command line by substituting placeholders.
546 TEMPLATE is a list of strings and symbols. The placeholder symbols in
547 it are replaced by SUBSTITUTIONS.
549 SUBSTITIONS is a list of (SYMBOL . SEXP) pairs, where SEXP is either a
550 string (which is inserted literally), a list of strings (which are
551 inserted as well), or nil, which means to insert nothing."
552 (let ((arglist (copy-sequence gpg-command-all-arglist)))
554 (let* ((templ (pop template))
555 (repl (assoc templ substitutions))
556 (new (if repl (cdr repl) templ)))
558 ((and (symbolp templ) (null repl))
559 (error "No replacement for `%s'" templ))
560 ((null new) nil) ; Drop it.
563 (setq new (list new)))
564 (setq arglist (nconc arglist new))))))
567 (defun gpg-build-flag-recipients-one (recipient)
568 "Build argument for one RECIPIENT."
569 (gpg-build-argument (cdr gpg-command-flag-recipient)
570 `((recipient . ,recipient)) t))
572 (defun gpg-build-flag-recipients (recipients)
573 "Build list of RECIPIENTS using `gpg-command-flag-recipient'."
575 (apply 'append (car gpg-command-flag-recipient)
576 (mapcar 'gpg-build-flag-recipients-one
580 (defun gpg-read-recipients ()
581 "Query the user for several recipients."
585 (setq r (read-string "Enter recipient ID [RET when no more]: "))
588 (setq recipients (nconc recipients (list r)))))
591 (defun gpg-build-flag-sign-with-key (key)
592 "Build sign with key flag using `gpg-command-flag-sign-with-key'."
594 (if gpg-default-key-id gpg-default-key-id
597 (gpg-build-argument gpg-command-flag-sign-with-key
598 (list (cons 'sign-with-key k)))
601 (defmacro gpg-with-passphrase-env (&rest body)
602 "Adjust the process environment and evaluate BODY.
603 During the evaluation of the body forms, the process environment is
604 adjust according to `gpg-command-passphrase-env'."
605 (let ((env-value (make-symbol "env-value")))
609 (when gpg-command-passphrase-env
610 (setq ,env-value (getenv (car gpg-command-passphrase-env)))
611 (setenv (car gpg-command-passphrase-env)
612 (cdr gpg-command-passphrase-env)))
614 (when gpg-command-passphrase-env
615 ;; This will clear the variable if it wasn't set before.
616 (setenv (car gpg-command-passphrase-env) ,env-value))))))
617 (put 'gpg-with-passphrase-env 'lisp-indent-function 0)
618 (put 'gpg-with-passphrase-env 'edebug-form-spec '(body))
622 (defun gpg-make-temp-file ()
623 "Create a temporary file in a safe way"
624 (let ((name ;; User may use "~/"
625 (expand-file-name "gnupg" gpg-temp-directory)))
626 (if (fboundp 'make-temp-file)
627 ;; If we've got make-temp-file, we are on the save side.
628 (make-temp-file name)
629 ;; make-temp-name doesn't create the file, and an ordinary
630 ;; write-file operation is prone to nasty symlink attacks if the
631 ;; temporary file resides in a world-writable directory.
632 (unless (or (memq system-type '(windows-nt cygwin32 win32 w32 mswindows))
633 (eq (file-modes gpg-temp-directory) 448)) ; mode 0700
634 (error "Directory for temporary files (%s) must have mode 0700" gpg-temp-directory))
635 (setq name (make-temp-name name))
636 (let ((mode (default-file-modes)))
639 (set-default-file-modes 384) ; mode 0600
640 (with-temp-file name))
641 (set-default-file-modes mode)))
644 (defvar gpg-temp-files nil
645 "List of temporary files used by the GnuPG interface.
646 Do not set this variable. Call `gpg-with-temp-files' if you need
649 (defun gpg-with-temp-files-create (count)
650 "Do not call this function. Used internally by `gpg-with-temp-files'."
652 (setq gpg-temp-files (cons (gpg-make-temp-file) gpg-temp-files))
653 (setq count (1- count))))
655 (defun gpg-with-temp-files-delete ()
656 "Do not call this function. Used internally by `gpg-with-temp-files'."
657 (while gpg-temp-files
658 (let ((file (pop gpg-temp-files)))
663 (defmacro gpg-with-temp-files (count &rest body)
664 "Create COUNT temporary files, USE them, and delete them.
665 The function USE is called with the names of all temporary files as
667 `(let ((gpg-temp-files))
670 ;; Create the temporary files.
671 (gpg-with-temp-files-create ,count)
673 (gpg-with-temp-files-delete))))
674 (put 'gpg-with-temp-files 'lisp-indent-function 1)
675 (put 'gpg-with-temp-files 'edebug-form-spec '(body))
677 ;;; Making subprocesses:
679 (defun gpg-exec-path (option)
680 "Return the program name for OPTION.
681 OPTION is of the form (PROGRAM . ARGLIST). This functions returns
682 PROGRAM, but takes default values into account."
683 (let* ((prg (car option))
684 (path (assq prg gpg-command-default-alist)))
686 (path (if (null (cdr path))
687 (error "Command `%s' is not available" prg)
689 ((null prg) (error "Command is disabled"))
692 (defun gpg-call-process (cmd args stdin stdout stderr &optional passphrase)
693 "Invoke external program CMD with ARGS on buffer STDIN.
694 Standard output is insert before point in STDOUT, standard error in
695 STDERR. If PASSPHRASE is given, send it before STDIN. PASSPHRASE
696 should not end with a line feed (\"\\n\").
698 If `stdin-file' is present in ARGS, it is replaced by the name of a
699 temporary file. Before invoking CMD, the contents of STDIN is written
701 (gpg-with-temp-files 2
702 (let* ((coding-system-for-read 'no-conversion)
703 (coding-system-for-write 'no-conversion)
704 (have-stdin-file (memq 'stdin-file args))
705 (stdin-file (nth 0 gpg-temp-files))
706 (stderr-file (nth 1 gpg-temp-files))
709 (,stdout ,stderr-file)
711 ;; Replace `stdin-file'.
712 ,@(gpg-build-arg-list
713 args (list (cons 'stdin-file stdin-file)))))
715 (when have-stdin-file
716 (with-temp-file stdin-file
717 (buffer-disable-undo)
718 (insert-buffer-substring stdin)))
722 (buffer-disable-undo)
723 (insert passphrase "\n")
724 (unless have-stdin-file
725 (apply 'insert-buffer-substring
726 (if (listp stdin) stdin (list stdin))))
727 (apply 'call-process-region (point-min) (point-max) cpr-args)
728 ;; Wipe out passphrase.
729 (goto-char (point-min))
730 (translate-region (point) (gpg-point-at-eol)
731 (make-string 256 ? )))
733 (with-current-buffer (car stdin)
734 (apply 'call-process-region
736 (if have-stdin-file (cadr stdin) (caddr stdin))
738 (with-current-buffer stdin
739 (apply 'call-process-region
741 (if have-stdin-file (point-min) (point-max))
743 (with-current-buffer stderr
744 (insert-file-contents-literally stderr-file))
745 (if (or (stringp res) (> res 0))
746 ;; Signal or abnormal exit.
747 (with-current-buffer stderr
748 (goto-char (point-max))
749 (insert (format "\nCommand exit status: %s\n" res))
753 (defvar gpg-result-buffer nil
754 "The result of a GnuPG operation is stored in this buffer.
755 Never set this variable directly, use `gpg-show-result' instead.")
757 (defun gpg-show-result-buffer (always-show result)
758 "Called by `gpg-show-results' to actually show the buffer."
759 (with-current-buffer gpg-result-buffer
760 ;; Only proceed if the buffer is non-empty.
761 (when (and (/= (point-min) (point-max))
762 (or always-show (not result)))
763 (save-window-excursion
764 (display-buffer (current-buffer))
765 (unless (y-or-n-p "Continue? ")
766 (error "GnuPG operation aborted"))))))
768 (defmacro gpg-show-result (always-show &rest body)
769 "Show GnuPG result to user for confirmation.
770 This macro binds `gpg-result-buffer' to a temporary buffer and
771 evaluates BODY, like `progn'. If BODY evaluates to `nil' (or
772 `always-show' is not nil), the user is asked for confirmation."
773 `(let ((gpg-result-buffer (get-buffer-create
774 (generate-new-buffer-name "*GnuPG Output*"))))
776 (gpg-show-result-buffer ,always-show (progn ,@body))
777 (kill-buffer gpg-result-buffer))))
778 (put 'gpg-show-result 'lisp-indent-function 1)
779 (put 'gpg-show-result 'edebug-form-spec '(body))
781 ;;; Passphrase handling:
783 (defvar gpg-passphrase-timer
785 "This timer will clear the passphrase cache periodically.")
787 (defvar gpg-passphrase
789 "The (unencrypted) passphrase cache.")
791 (defun gpg-passphrase-clear-string (str)
792 "Erases STR by overwriting all characters."
800 (defun gpg-passphrase-forget ()
801 "Forget stored passphrase."
804 (cancel-timer gpg-passphrase-timer)
805 (setq gpg-passphrase-timer nil)
806 (gpg-passphrase-clear-string gpg-passphrase)
807 (setq gpg-passphrase nil)))
809 (defun gpg-passphrase-store (passphrase)
810 "Store PASSPHRASE in cache.
811 Updates the timeout for clearing the cache to `gpg-passphrase-timeout'."
812 (unless (equal gpg-passphrase-timeout 0)
813 (if (null gpg-passphrase-timer)
814 (setq gpg-passphrase-timer (timer-create)))
815 (timer-set-time gpg-passphrase-timer
816 (timer-relative-time (current-time)
817 gpg-passphrase-timeout))
818 (timer-set-function gpg-passphrase-timer 'gpg-passphrase-forget)
819 (unless (and (fboundp 'itimer-live-p)
820 (itimer-live-p gpg-passphrase-timer))
821 (timer-activate gpg-passphrase-timer))
822 (setq gpg-passphrase passphrase))
825 (defun gpg-passphrase-read ()
826 "Read a passphrase and remember it for some time."
829 ;; This reinitializes the timer.
830 (gpg-passphrase-store gpg-passphrase)
831 (let ((pp (read-passwd "Enter passphrase: ")))
832 (gpg-passphrase-store pp))))
835 ;;;; Main operations:
838 (defun gpg-verify (message signature result)
839 "Verify buffer MESSAGE against detached SIGNATURE buffer.
840 Returns t if everything worked out well, nil otherwise. Consult
841 buffer RESULT for details."
842 (interactive "bBuffer containing message: \nbBuffer containing signature: \nbBuffor for result: ")
843 (gpg-with-temp-files 2
844 (let* ((sig-file (nth 0 gpg-temp-files))
845 (msg-file (nth 1 gpg-temp-files))
846 (cmd (gpg-exec-path gpg-command-verify))
847 (args (gpg-build-arg-list (cdr gpg-command-verify)
848 `((signature-file . ,sig-file)
849 (message-file . ,msg-file))))
851 (with-temp-file sig-file
852 (buffer-disable-undo)
853 (apply 'insert-buffer-substring (if (listp signature)
856 (with-temp-file msg-file
857 (buffer-disable-undo)
858 (apply 'insert-buffer-substring (if (listp message)
861 (setq res (apply 'call-process-region
862 (point-min) (point-min) ; no data
868 (if (or (stringp res) (> res 0))
869 ;; Signal or abnormal exit.
870 (with-current-buffer result
871 (insert (format "\nCommand exit status: %s\n" res))
876 (defun gpg-verify-cleartext (message result)
877 "Verify message in buffer MESSAGE.
878 Returns t if everything worked out well, nil otherwise. Consult
879 buffer RESULT for details.
881 NOTE: Use of this function is deprecated."
882 (interactive "bBuffer containing message: \nbBuffor for result: ")
883 (gpg-with-temp-files 1
884 (let* ((msg-file (nth 0 gpg-temp-files))
885 (cmd (gpg-exec-path gpg-command-verify-cleartext))
886 (args (gpg-build-arg-list (cdr gpg-command-verify-cleartext)
887 `((message-file . ,msg-file))))
889 (with-temp-file msg-file
890 (buffer-disable-undo)
891 (apply 'insert-buffer-substring (if (listp message)
894 (setq res (apply 'call-process-region
895 (point-min) (point-min) ; no data
901 (if (or (stringp res) (> res 0))
902 ;; Signal or abnormal exit.
903 (with-current-buffer result
904 (insert (format "\nCommand exit status: %s\n" res))
909 (defun gpg-decrypt (ciphertext plaintext result &optional passphrase)
910 "Decrypt buffer CIPHERTEXT to buffer PLAINTEXT.
911 Returns t if everything worked out well, nil otherwise. Consult
912 buffer RESULT for details. Reads a missing PASSPHRASE using
913 `gpg-passphrase-read'."
914 (interactive "bBuffer containing ciphertext: \nbBuffer for plaintext: \nbBuffor for decryption status: ")
915 (gpg-call-process (gpg-exec-path gpg-command-decrypt)
916 (gpg-build-arg-list (cdr gpg-command-decrypt) nil)
917 ciphertext plaintext result
918 (if passphrase passphrase (gpg-passphrase-read)))
920 (gpg-passphrase-clear-string passphrase)))
923 (defun gpg-sign-cleartext
924 (plaintext signed-text result &optional passphrase sign-with-key)
925 "Sign buffer PLAINTEXT, and store PLAINTEXT with signature in
927 Reads a missing PASSPHRASE using `gpg-passphrase-read'. Uses key ID
928 SIGN-WITH-KEY if given, otherwise the default key ID. Returns t if
929 everything worked out well, nil otherwise. Consult buffer RESULT for
932 NOTE: Use of this function is deprecated."
933 (interactive "bBuffer containing plaintext: \nbBuffer for text with signature: \nbBuffer for status information: ")
934 (let ((subst (list (cons 'sign-with-key
935 (gpg-build-flag-sign-with-key sign-with-key))
936 (cons 'armor gpg-command-flag-armor)
937 (cons 'textmode gpg-command-flag-textmode))))
938 (gpg-call-process (gpg-exec-path gpg-command-sign-cleartext)
939 (gpg-build-arg-list (cdr gpg-command-sign-cleartext)
941 plaintext signed-text result
942 (if passphrase passphrase (gpg-passphrase-read))))
944 (gpg-passphrase-clear-string passphrase)))
947 (defun gpg-sign-detached
948 (plaintext signature result &optional passphrase sign-with-key
950 "Sign buffer PLAINTEXT, and store SIGNATURE in that buffer.
951 Reads a missing PASSPHRASE using `gpg-passphrase-read'. Uses key ID
952 SIGN-WITH-KEY if given, otherwise the default key ID. Returns t if
953 everything worked out well, nil otherwise. Consult buffer RESULT for
954 details. ARMOR the result and activate canonical TEXTMODE if
956 (interactive "bBuffer containing plaintext: \nbBuffer for text with signature: \nbBuffer for status information: ")
957 (let ((subst (list (cons 'sign-with-key
958 (gpg-build-flag-sign-with-key sign-with-key))
959 (cons 'armor (if armor gpg-command-flag-armor))
960 (cons 'textmode (if armor gpg-command-flag-textmode)))))
961 (gpg-call-process (gpg-exec-path gpg-command-sign-detached)
962 (gpg-build-arg-list (cdr gpg-command-sign-detached)
964 plaintext signature result
965 (if passphrase passphrase (gpg-passphrase-read))))
967 (gpg-passphrase-clear-string passphrase)))
971 (defun gpg-sign-encrypt
972 (plaintext ciphertext result recipients &optional passphrase sign-with-key
974 "Sign buffer PLAINTEXT, and store SIGNATURE in that buffer.
975 RECIPIENTS is a list of key IDs used for encryption. This function
976 reads a missing PASSPHRASE using `gpg-passphrase-read', and uses key
977 ID SIGN-WITH-KEY for the signature if given, otherwise the default key
978 ID. Returns t if everything worked out well, nil otherwise. Consult
979 buffer RESULT for details. ARMOR the result and activate canonical
980 TEXTMODE if requested."
982 (read-buffer "Buffer containing plaintext: " nil t)
983 (read-buffer "Buffer for ciphertext: " nil t)
984 (read-buffer "Buffer for status informationt: " nil t)
985 (gpg-read-recipients)))
986 (let ((subst `((sign-with-key . ,(gpg-build-flag-sign-with-key
988 (plaintext-file . stdin-file)
989 (recipients . ,(gpg-build-flag-recipients recipients))
990 (armor ,(if armor gpg-command-flag-armor))
991 (textmode ,(if armor gpg-command-flag-textmode)))))
992 (gpg-call-process (gpg-exec-path gpg-command-sign-encrypt)
993 (gpg-build-arg-list (cdr gpg-command-sign-encrypt)
995 plaintext ciphertext result
996 (if passphrase passphrase (gpg-passphrase-read))))
998 (gpg-passphrase-clear-string passphrase)))
1003 (plaintext ciphertext result recipients &optional passphrase armor textmode)
1004 "Encrypt buffer PLAINTEXT, and store CIPHERTEXT in that buffer.
1005 RECIPIENTS is a list of key IDs used for encryption. Returns t if
1006 everything worked out well, nil otherwise. Consult buffer RESULT for
1007 details. ARMOR the result and activate canonical
1008 TEXTMODE if requested."
1010 (read-buffer "Buffer containing plaintext: " nil t)
1011 (read-buffer "Buffer for ciphertext: " nil t)
1012 (read-buffer "Buffer for status informationt: " nil t)
1013 (gpg-read-recipients)))
1014 (let ((subst `((plaintext-file . stdin-file)
1015 (recipients . ,(gpg-build-flag-recipients recipients))
1016 (armor ,(if armor gpg-command-flag-armor))
1017 (textmode ,(if armor gpg-command-flag-textmode)))))
1018 (gpg-call-process (gpg-exec-path gpg-command-encrypt)
1019 (gpg-build-arg-list (cdr gpg-command-encrypt) subst)
1020 plaintext ciphertext result nil))
1022 (gpg-passphrase-clear-string passphrase)))
1027 ;;; ADT: OpenPGP Key
1029 (defun gpg-key-make (user-id key-id unique-id length algorithm
1030 creation-date expire-date validity trust)
1031 "Create a new key object (for internal use only)."
1034 user-id key-id unique-id length algorithm
1036 creation-date expire-date validity trust))
1039 (defun gpg-key-p (key)
1040 "Return t if KEY is a key specification."
1041 (and (arrayp key) (equal (length key) 9) key))
1043 (defmacro gpg-key-primary-user-id (key)
1044 "The primary user ID for KEY (human-readable).
1045 DO NOT USE this ID for selecting recipients. It is probably not
1047 (list 'car (list 'aref key 0)))
1049 (defmacro gpg-key-user-ids (key)
1050 "A list of additional user IDs for KEY (human-readable).
1051 DO NOT USE these IDs for selecting recipients. They are probably not
1053 (list 'cdr (list 'aref key 0)))
1055 (defmacro gpg-key-id (key)
1057 DO NOT USE this ID for selecting recipients. It is not guaranteed to
1061 (defun gpg-short-key-id (key)
1062 "The short key ID of KEY."
1063 (let* ((id (gpg-key-id key))
1066 (substring id (- len 8))
1069 (defmacro gpg-key-unique-id (key)
1070 "A non-standard ID of KEY which is only valid locally.
1071 This ID can be used to specify recipients in a safe manner. Note,
1072 even this ID might not be unique unless GnuPG is used."
1075 (defmacro gpg-key-unique-id-list (key-list)
1076 "Like `gpg-key-unique-id', but operate on a list."
1077 `(mapcar (lambda (key) (gpg-key-unique-id key))
1080 (defmacro gpg-key-length (key)
1081 "Returns the key length."
1084 (defmacro gpg-key-algorithm (key)
1085 "The encryption algorithm used by KEY.
1086 One of the symbols `rsa', `rsa-encrypt', `rsa-sign', `elgamal',
1087 `elgamal-encrypt', `dsa'."
1090 (defmacro gpg-key-creation-date (key)
1091 "A string with the creation date of KEY in ISO format."
1094 (defmacro gpg-key-expire-date (key)
1095 "A string with the expiration date of KEY in ISO format."
1098 (defmacro gpg-key-validity (key)
1099 "The calculated validity of KEY.
1100 One of the symbols `not-known', `disabled', `revoked', `expired',
1101 `undefined', `trust-none', `trust-marginal', `trust-full',
1102 `trust-ultimate' (see the GnuPG documentation for details)."
1105 (defmacro gpg-key-trust (key)
1106 "The assigned trust for KEY.
1107 One of the symbols `not-known', `undefined', `trust-none',
1108 `trust-marginal', `trust-full' (see the GnuPG
1109 documentation for details)."
1112 (defun gpg-key-lessp (a b)
1113 "Returns t if primary user ID of A is less than B."
1114 (string-lessp (gpg-key-primary-user-id a) (gpg-key-primary-user-id b) ))
1116 ;;; Accessing the key database:
1118 ;; Internal functions:
1120 (defmacro gpg-key-list-keys-skip-field ()
1121 '(search-forward ":" eol 'move))
1123 (defmacro gpg-key-list-keys-get-field ()
1124 '(buffer-substring (point) (if (gpg-key-list-keys-skip-field)
1127 (defmacro gpg-key-list-keys-string-field ()
1128 '(gpg-key-list-keys-get-field))
1130 (defmacro gpg-key-list-keys-read-field ()
1131 (let ((field (make-symbol "field")))
1132 `(let ((,field (gpg-key-list-keys-get-field)))
1133 (if (equal (length ,field) 0)
1137 (defun gpg-key-list-keys-parse-line ()
1138 "Parse the line in the current buffer and return a vector of fields."
1139 (let* ((eol (gpg-point-at-eol))
1143 (gpg-key-list-keys-read-field) ; type
1144 (gpg-key-list-keys-get-field) ; trust
1145 (gpg-key-list-keys-read-field) ; key length
1146 (gpg-key-list-keys-read-field) ; algorithm
1147 (gpg-key-list-keys-get-field) ; key ID
1148 (gpg-key-list-keys-get-field) ; creation data
1149 (gpg-key-list-keys-get-field) ; expire
1150 (gpg-key-list-keys-get-field) ; unique (local) ID
1151 (gpg-key-list-keys-get-field) ; ownertrust
1152 (gpg-key-list-keys-string-field) ; user ID
1157 (error "Too many fields in GnuPG key database"))
1160 (defconst gpg-pubkey-algo-alist
1162 (2 . rsa-encrypt-only)
1164 (16 . elgamal-encrypt-only)
1167 "Alist mapping OpenPGP public key algorithm numbers to symbols.")
1169 (defconst gpg-trust-alist
1175 (?q . trust-undefined)
1177 (?m . trust-marginal)
1179 (?u . trust-ultimate))
1180 "Alist mapping GnuPG trust value short forms to long symbols.")
1182 (defconst gpg-unabbrev-trust-alist
1183 '(("TRUST_UNDEFINED" . trust-undefined)
1184 ("TRUST_NEVER" . trust-none)
1185 ("TRUST_MARGINAL" . trust-marginal)
1186 ("TRUST_FULLY" . trust-full)
1187 ("TRUST_ULTIMATE" . trust-ultimate))
1188 "Alist mapping capitalized GnuPG trust values to long symbols.")
1190 (defmacro gpg-key-list-keys-in-buffer-store ()
1191 '(when primary-user-id
1192 (sort user-id 'string-lessp)
1193 (push (gpg-key-make (cons primary-user-id user-id)
1194 key-id unique-id key-length
1195 algorithm creation-date
1196 expire-date validity trust)
1199 (defun gpg-key-list-keys-in-buffer (&optional buffer)
1200 "Return a list of keys for BUFFER.
1201 If BUFFER is omitted, use current buffer."
1202 (with-current-buffer (if buffer buffer (current-buffer))
1203 (goto-char (point-min))
1204 ;; Skip key ring filename written by GnuPG.
1205 (search-forward "\n---------------------------\n" nil t)
1206 ;; Loop over all lines in buffer and analyze them.
1207 (let (primary-user-id user-id key-id unique-id ; current key components
1208 key-length algorithm creation-date expire-date validity trust
1209 line ; fields in current line
1210 key-list) ; keys gather so far
1212 (while (setq line (gpg-key-list-keys-parse-line))
1214 ;; Public or secret key.
1215 ((memq (aref line 0) '(pub sec))
1216 ;; Store previous key, if any.
1217 (gpg-key-list-keys-in-buffer-store)
1218 ;; Record field values.
1219 (setq primary-user-id (aref line 9))
1221 (setq key-id (aref line 4))
1222 ;; We use the key ID if no unique ID is available.
1223 (setq unique-id (if (> (length (aref line 7)) 0)
1224 (concat "#" (aref line 7))
1225 (concat "0x" key-id)))
1226 (setq key-length (aref line 2))
1227 (setq algorithm (assq (aref line 3) gpg-pubkey-algo-alist))
1229 (setq algorithm (cdr algorithm))
1230 (error "Unknown algorithm %s" (aref line 3)))
1231 (setq creation-date (if (> (length (aref line 5)) 0)
1233 (setq expire-date (if (> (length (aref line 6)) 0)
1235 (setq validity (assq (aref (aref line 1) 0) gpg-trust-alist))
1237 (setq validity (cdr validity))
1238 (error "Unknown validity specification %S" (aref line 1)))
1239 (setq trust (assq (aref (aref line 8) 0) gpg-trust-alist))
1241 (setq trust (cdr trust))
1242 (error "Unknown trust specification %S" (aref line 8))))
1244 ;; Additional user ID
1245 ((eq 'uid (aref line 0))
1246 (setq user-id (cons (aref line 9) user-id)))
1248 ;; Subkeys are ignored for now.
1249 ((memq (aref line 0) '(sub ssb))
1251 (t (error "Unknown record type %S" (aref line 0)))))
1253 ;; Store the key retrieved last.
1254 (gpg-key-list-keys-in-buffer-store)
1255 ;; Sort the keys according to the primary user ID.
1256 (sort key-list 'gpg-key-lessp))))
1258 (defun gpg-key-list-keyspec (command &optional keyspec stderr ignore-error)
1259 "Insert the output of COMMAND before point in current buffer."
1260 (let* ((cmd (gpg-exec-path command))
1261 (key (if (equal keyspec "") nil keyspec))
1262 (args (gpg-build-arg-list (cdr command) `((key-id . ,key))))
1265 (apply 'call-process-region
1266 (point-min) (point-min) ; no data
1269 (if stderr t '(t nil))
1272 (unless (or ignore-error (equal exit-status 0))
1273 (error "GnuPG command exited unsuccessfully"))))
1276 (defun gpg-key-list-keyspec-parse (command &optional keyspec)
1277 "Return a list of keys matching KEYSPEC.
1278 COMMAND is used to obtain the key list. The usual substring search
1279 for keys is performed."
1281 (buffer-disable-undo)
1282 (gpg-key-list-keyspec command keyspec)
1283 (gpg-key-list-keys-in-buffer)))
1286 (defun gpg-key-list-keys (&optional keyspec)
1287 "A list of public keys matching KEYSPEC.
1288 The usual substring search for keys is performed."
1289 (gpg-key-list-keyspec-parse gpg-command-key-public-ring keyspec))
1292 (defun gpg-key-list-secret-keys (&optional keyspec)
1293 "A list of secret keys matching KEYSPEC.
1294 The usual substring search for keys is performed."
1295 (gpg-key-list-keyspec-parse gpg-command-key-secret-ring keyspec))
1298 (defun gpg-key-insert-public-key (key)
1299 "Inserts the public key(s) matching KEYSPEC.
1300 The ASCII-armored key is inserted before point into current buffer."
1301 (gpg-key-list-keyspec gpg-command-key-export key))
1304 (defun gpg-key-insert-information (key)
1305 "Insert human-readable information (including fingerprint) on KEY.
1306 Insertion takes place in current buffer before point."
1307 (gpg-key-list-keyspec gpg-command-key-verify key))
1310 (defun gpg-key-retrieve (key)
1311 "Fetch KEY from default key server.
1312 KEY is a key ID or a list of key IDs. Status information about this
1313 operation is inserted into the current buffer before point."
1314 (gpg-key-list-keyspec gpg-command-key-retrieve key t t))
1317 (defun gpg-key-add-to-ring (key result)
1318 "Adds key in buffer KEY to the GnuPG key ring.
1319 Human-readable information on the RESULT is stored in buffer RESULT
1324 ;;; gpg.el ends here