1 ;;; epa.el --- the EasyPG Assistant
2 ;; Copyright (C) 2006 Daiki Ueno
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: PGP, GnuPG
7 ;; This file is part of EasyPG.
9 ;; This program is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; This program is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 ;; Boston, MA 02110-1301, USA.
29 (eval-when-compile (require 'wid-edit))
32 "The EasyPG Assistant"
35 (defcustom epa-armor nil
36 "If non-nil, epa commands create ASCII armored output."
40 (defcustom epa-textmode nil
41 "If non-nil, epa commands treat input files as text."
45 (defgroup epa-faces nil
49 (defface epa-validity-high-face
50 '((((class color) (background dark))
51 (:foreground "PaleTurquoise" :bold t))
54 "Face used for displaying the high validity."
56 (defvar epa-validity-high-face 'epa-validity-high-face)
58 (defface epa-validity-medium-face
59 '((((class color) (background dark))
60 (:foreground "PaleTurquoise" :italic t))
63 "Face used for displaying the medium validity."
65 (defvar epa-validity-medium-face 'epa-validity-medium-face)
67 (defface epa-validity-low-face
70 "Face used for displaying the low validity."
72 (defvar epa-validity-low-face 'epa-validity-low-face)
74 (defface epa-validity-disabled-face
76 (:italic t :inverse-video t)))
77 "Face used for displaying the disabled validity."
79 (defvar epa-validity-disabled-face 'epa-validity-disabled-face)
81 (defface epa-string-face
84 (:foreground "lightyellow"))
87 (:foreground "blue4"))
90 "Face used for displaying the string."
92 (defvar epa-string-face 'epa-string-face)
94 (defface epa-mark-face
95 '((((class color) (background dark))
96 (:foreground "orange" :bold t))
98 (:foreground "red" :bold t)))
99 "Face used for displaying the high validity."
101 (defvar epa-mark-face 'epa-mark-face)
103 (defface epa-field-name-face
104 '((((class color) (background dark))
105 (:foreground "PaleTurquoise" :bold t))
107 "Face for the name of the attribute field."
109 (defvar epa-field-name-face 'epa-field-name-face)
111 (defface epa-field-body-face
112 '((((class color) (background dark))
113 (:foreground "turquoise" :italic t))
115 "Face for the body of the attribute field."
117 (defvar epa-field-body-face 'epa-field-body-face)
119 (defcustom epa-validity-face-alist
120 '((unknown . epa-validity-disabled-face)
121 (invalid . epa-validity-disabled-face)
122 (disabled . epa-validity-disabled-face)
123 (revoked . epa-validity-disabled-face)
124 (expired . epa-validity-disabled-face)
125 (none . epa-validity-low-face)
126 (undefined . epa-validity-low-face)
127 (never . epa-validity-low-face)
128 (marginal . epa-validity-medium-face)
129 (full . epa-validity-high-face)
130 (ultimate . epa-validity-high-face))
131 "An alist mapping validity values to faces."
135 (defcustom epa-font-lock-keywords
138 ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
139 (1 epa-field-name-face)
140 (2 epa-field-body-face)))
141 "Default expressions to addon in epa-mode."
142 :type '(repeat (list string))
145 (defconst epa-pubkey-algorithm-letter-alist
153 (defvar epa-keys-buffer nil)
154 (defvar epa-key-buffer-alist nil)
156 (defvar epa-list-keys-arguments nil)
158 (defvar epa-keys-mode-map
159 (let ((keymap (make-sparse-keymap)))
160 (define-key keymap "m" 'epa-mark)
161 (define-key keymap "u" 'epa-unmark)
162 (define-key keymap "d" 'epa-decrypt-file)
163 (define-key keymap "v" 'epa-verify-file)
164 (define-key keymap "s" 'epa-sign-file)
165 (define-key keymap "S" 'epa-sign-keys)
166 (define-key keymap "e" 'epa-encrypt-file)
167 (define-key keymap "r" 'epa-delete-keys)
168 (define-key keymap "i" 'epa-import-keys)
169 (define-key keymap "o" 'epa-export-keys)
170 (define-key keymap "g" 'epa-list-keys)
171 (define-key keymap "n" 'next-line)
172 (define-key keymap "p" 'previous-line)
173 (define-key keymap " " 'scroll-up)
174 (define-key keymap [delete] 'scroll-down)
175 (define-key keymap "q" 'epa-exit-buffer)
178 (defvar epa-exit-buffer-function #'bury-buffer)
180 (define-widget 'epa-key 'push-button
181 "Button for representing a epg-key object."
183 :button-face-get 'epa-key-widget-button-face-get
184 :value-create 'epa-key-widget-value-create
185 :action 'epa-key-widget-action
186 :help-echo 'epa-key-widget-help-echo)
188 (defun epa-key-widget-action (widget &optional event)
189 (epa-show-key (widget-get widget :value)))
191 (defun epa-key-widget-value-create (widget)
192 (let* ((key (widget-get widget :value))
193 (primary-sub-key (car (epg-key-sub-key-list key)))
194 (primary-user-id (car (epg-key-user-id-list key))))
195 (insert (format "%c "
196 (if (epg-sub-key-validity primary-sub-key)
197 (car (rassq (epg-sub-key-validity primary-sub-key)
198 epg-key-validity-alist))
200 (epg-sub-key-id primary-sub-key)
202 (if (stringp (epg-user-id-string primary-user-id))
203 (epg-user-id-string primary-user-id)
204 (epg-decode-dn (epg-user-id-string primary-user-id))))))
206 (defun epa-key-widget-button-face-get (widget)
207 (let ((validity (epg-sub-key-validity (car (epg-key-sub-key-list
208 (widget-get widget :value))))))
210 (cdr (assq validity epa-validity-face-alist))
213 (defun epa-key-widget-help-echo (widget)
215 (epg-sub-key-id (car (epg-key-sub-key-list
216 (widget-get widget :value))))))
218 (defun epa-keys-mode ()
219 "Major mode for `epa-list-keys'."
220 (kill-all-local-variables)
221 (buffer-disable-undo)
222 (setq major-mode 'epa-keys-mode
226 (use-local-map epa-keys-mode-map)
227 (set-keymap-parent (current-local-map) widget-keymap)
228 (make-local-variable 'font-lock-defaults)
229 (setq font-lock-defaults '(epa-font-lock-keywords t))
230 ;; In XEmacs, auto-initialization of font-lock is not effective
231 ;; if buffer-file-name is not set.
232 (font-lock-set-defaults)
234 (make-local-variable 'epa-exit-buffer-function)
235 (run-hooks 'epa-keys-mode-hook))
237 (defvar epa-key-mode-map
238 (let ((keymap (make-sparse-keymap)))
239 (define-key keymap "q" 'bury-buffer)
242 (defun epa-key-mode ()
243 "Major mode for `epa-show-key'."
244 (kill-all-local-variables)
245 (buffer-disable-undo)
246 (setq major-mode 'epa-key-mode
250 (use-local-map epa-key-mode-map)
251 (make-local-variable 'font-lock-defaults)
252 (setq font-lock-defaults '(epa-font-lock-keywords t))
253 ;; In XEmacs, auto-initialization of font-lock is not effective
254 ;; if buffer-file-name is not set.
255 (font-lock-set-defaults)
256 (make-local-variable 'epa-exit-buffer-function)
257 (run-hooks 'epa-key-mode-hook))
260 (defun epa-list-keys (&optional name mode protocol)
262 (if current-prefix-arg
263 (let ((name (read-string "Pattern: "
264 (if epa-list-keys-arguments
265 (car epa-list-keys-arguments)))))
266 (list (if (equal name "") nil name)
267 (y-or-n-p "Secret keys? ")
268 (intern (completing-read "Protocol? "
269 '(("OpenPGP") ("CMS"))
271 (or epa-list-keys-arguments (list nil nil nil))))
272 (unless (and epa-keys-buffer
273 (buffer-live-p epa-keys-buffer))
274 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
275 (set-buffer epa-keys-buffer)
276 (let ((inhibit-read-only t)
279 (context (epg-make-context protocol)))
280 (unless (get-text-property point 'epa-list-keys)
281 (setq point (next-single-property-change point 'epa-list-keys)))
284 (or (next-single-property-change point 'epa-list-keys)
287 (epa-insert-keys context name mode)
289 (make-local-variable 'epa-list-keys-arguments)
290 (setq epa-list-keys-arguments (list name mode protocol))
291 (goto-char (point-min))
292 (pop-to-buffer (current-buffer)))
294 (defun epa-insert-keys (context name mode)
297 (narrow-to-region (point) (point))
298 (let ((keys (epg-list-keys context name mode))
303 (put-text-property point (point) 'epa-key (car keys))
304 (widget-create 'epa-key :value (car keys))
306 (setq keys (cdr keys))))
307 (put-text-property (point-min) (point-max) 'epa-list-keys t))))
309 (defun epa-marked-keys ()
311 (set-buffer epa-keys-buffer)
312 (goto-char (point-min))
314 (while (re-search-forward "^\\*" nil t)
315 (if (setq key (get-text-property (match-beginning 0)
317 (setq keys (cons key keys))))
321 (let ((key (get-text-property (point) 'epa-key)))
326 (defun epa-select-keys (context prompt &optional names secret)
327 "Display a user's keyring and ask him to select keys.
328 CONTEXT is an epg-context.
329 PROMPT is a string to prompt with.
330 NAMES is a list of strings to be matched with keys. If it is nil, all
332 If SECRET is non-nil, list secret keys instead of public keys."
334 (unless (and epa-keys-buffer
335 (buffer-live-p epa-keys-buffer))
336 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
337 (let ((inhibit-read-only t)
340 (set-buffer epa-keys-buffer)
344 :notify (lambda (&rest ignore) (abort-recursive-edit))
346 (substitute-command-keys
347 "Click here or \\[abort-recursive-edit] to cancel")
350 :notify (lambda (&rest ignore) (exit-recursive-edit))
352 (substitute-command-keys
353 "Click here or \\[exit-recursive-edit] to finish")
359 (epa-insert-keys context (car names) secret)
362 (goto-char (point-max))
363 (setq names (cdr names)))
364 (epa-insert-keys context nil secret))
366 (setq epa-exit-buffer-function #'abort-recursive-edit)
367 (goto-char (point-min))
368 (pop-to-buffer (current-buffer)))
373 (if (get-buffer-window epa-keys-buffer)
374 (delete-window (get-buffer-window epa-keys-buffer)))
375 (kill-buffer epa-keys-buffer))))
377 (defun epa-show-key (key)
378 (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
379 (entry (assoc (epg-sub-key-id primary-sub-key)
380 epa-key-buffer-alist))
381 (inhibit-read-only t)
385 (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
386 epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
387 (unless (and (cdr entry)
388 (buffer-live-p (cdr entry)))
389 (setcdr entry (generate-new-buffer
390 (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
391 (set-buffer (cdr entry))
392 (make-local-variable 'epa-key)
395 (setq pointer (epg-key-user-id-list key))
398 (if (epg-user-id-validity (car pointer))
400 (car (rassq (epg-user-id-validity (car pointer))
401 epg-key-validity-alist)))
404 (if (stringp (epg-user-id-string (car pointer)))
405 (epg-user-id-string (car pointer))
406 (epg-decode-dn (epg-user-id-string (car pointer))))
408 (setq pointer (cdr pointer)))
409 (setq pointer (epg-key-sub-key-list key))
412 (if (epg-sub-key-validity (car pointer))
414 (car (rassq (epg-sub-key-validity (car pointer))
415 epg-key-validity-alist)))
418 (epg-sub-key-id (car pointer))
421 (epg-sub-key-length (car pointer)))
423 (cdr (assq (epg-sub-key-algorithm (car pointer))
424 epg-pubkey-algorithm-alist))
426 (epg-sub-key-creation-time (car pointer))
427 (if (epg-sub-key-expiration-time (car pointer))
428 (format "\n\tExpires: %s" (epg-sub-key-expiration-time
432 (mapconcat #'symbol-name
433 (epg-sub-key-capability (car pointer))
436 (epg-sub-key-fingerprint (car pointer))
438 (setq pointer (cdr pointer)))
439 (goto-char (point-min))
440 (pop-to-buffer (current-buffer))
443 (defun epa-show-key-notify (widget &rest ignore)
444 (epa-show-key (widget-get widget :value)))
446 (defun epa-mark (&optional arg)
447 "Mark the current line.
448 If ARG is non-nil, unmark the current line."
450 (let ((inhibit-read-only t)
454 (setq properties (text-properties-at (point)))
456 (insert (if arg " " "*"))
457 (set-text-properties (1- (point)) (point) properties)
460 (defun epa-unmark (&optional arg)
461 "Unmark the current line.
462 If ARG is non-nil, mark the current line."
464 (epa-mark (not arg)))
466 (defun epa-exit-buffer ()
467 "Exit the current buffer.
468 `epa-exit-buffer-function' is called if it is set."
470 (funcall epa-exit-buffer-function))
473 (defun epa-decrypt-file (file)
475 (interactive "fFile: ")
476 (let* ((default-name (file-name-sans-extension file))
477 (plain (expand-file-name
479 (concat "To file (default "
480 (file-name-nondirectory default-name)
482 (file-name-directory default-name)
484 (context (epg-make-context)))
485 (message "Decrypting %s..." (file-name-nondirectory file))
486 (epg-decrypt-file context file plain)
487 (message "Decrypting %s...done" (file-name-nondirectory file))
488 (if (epg-context-result-for context 'verify)
490 (epg-verify-result-to-string
491 (epg-context-result-for context 'verify))))))
494 (defun epa-verify-file (file)
496 (interactive "fFile: ")
497 (let* ((context (epg-make-context))
498 (plain (if (equal (file-name-extension file) "sig")
499 (file-name-sans-extension file))))
500 (message "Verifying %s..." (file-name-nondirectory file))
501 (epg-verify-file context file plain)
502 (message "Verifying %s...done" (file-name-nondirectory file))
504 (epg-verify-result-to-string
505 (epg-context-result-for context 'verify)))))
508 (defun epa-sign-file (file signers mode)
509 "Sign FILE by SIGNERS keys selected."
511 (list (expand-file-name (read-file-name "File: "))
512 (epa-select-keys (epg-make-context) "Select keys for signing.
513 If no one is selected, default secret key is used. "
515 (if (y-or-n-p "Make a detached signature? ")
517 (if (y-or-n-p "Make a cleartext signature? ")
519 (let ((signature (concat file
521 (not (memq mode '(nil t normal detached))))
523 (if (memq mode '(t detached))
526 (context (epg-make-context)))
527 (epg-context-set-armor context epa-armor)
528 (epg-context-set-textmode context epa-textmode)
529 (epg-context-set-signers context signers)
530 (message "Signing %s..." (file-name-nondirectory file))
531 (epg-sign-file context file signature mode)
532 (message "Signing %s...done" (file-name-nondirectory file))))
535 (defun epa-encrypt-file (file recipients)
536 "Encrypt FILE for RECIPIENTS."
538 (list (expand-file-name (read-file-name "File: "))
539 (epa-select-keys (epg-make-context) "Select recipents for encryption.
540 If no one is selected, symmetric encryption will be performed. ")))
541 (let ((cipher (concat file (if epa-armor ".asc" ".gpg")))
542 (context (epg-make-context)))
543 (epg-context-set-armor context epa-armor)
544 (epg-context-set-textmode context epa-textmode)
545 (message "Encrypting %s..." (file-name-nondirectory file))
546 (epg-encrypt-file context file recipients cipher)
547 (message "Encrypting %s...done" (file-name-nondirectory file))))
550 (defun epa-decrypt-region (start end)
551 "Decrypt the current region between START and END.
553 Don't use this command in Lisp programs!"
556 (let ((context (epg-make-context))
558 (message "Decrypting...")
559 (setq plain (epg-decrypt-string context (buffer-substring start end)))
560 (message "Decrypting...done")
561 (delete-region start end)
563 (insert (decode-coding-string plain coding-system-for-read))
564 (if (epg-context-result-for context 'verify)
566 (epg-verify-result-to-string
567 (epg-context-result-for context 'verify)))))))
570 (defun epa-decrypt-armor-in-region (start end)
571 "Decrypt OpenPGP armors in the current region between START and END.
573 Don't use this command in Lisp programs!"
577 (narrow-to-region start end)
579 (let (armor-start armor-end charset coding-system)
580 (while (re-search-forward "-----BEGIN PGP MESSAGE-----$" nil t)
581 (setq armor-start (match-beginning 0)
582 armor-end (re-search-forward "^-----END PGP MESSAGE-----$"
585 (error "No armor tail"))
586 (goto-char armor-start)
587 (if (re-search-forward "^Charset: \\(.*\\)" armor-end t)
588 (setq charset (match-string 1)))
589 (if coding-system-for-read
590 (setq coding-system coding-system-for-read)
592 (setq coding-system (intern (downcase charset)))
593 (setq coding-system 'utf-8)))
594 (let ((coding-system-for-read coding-system))
595 (epa-decrypt-region start end)))))))
598 (defun epa-verify-region (start end)
599 "Verify the current region between START and END.
601 Don't use this command in Lisp programs!"
603 (let ((context (epg-make-context)))
604 (epg-verify-string context
605 (encode-coding-string
606 (buffer-substring start end)
607 coding-system-for-write))
609 (epg-verify-result-to-string
610 (epg-context-result-for context 'verify)))))
613 (defun epa-verify-armor-in-region (start end)
614 "Verify OpenPGP armors in the current region between START and END.
616 Don't use this command in Lisp programs!"
620 (narrow-to-region start end)
622 (let (armor-start armor-end)
623 (while (re-search-forward "-----BEGIN PGP\\( SIGNED\\)? MESSAGE-----$"
625 (setq armor-start (match-beginning 0))
626 (if (match-beginning 1) ;cleartext signed message
628 (unless (re-search-forward "^-----BEGIN PGP SIGNATURE-----$"
630 (error "Invalid cleartext signed message"))
631 (setq armor-end (re-search-forward
632 "^-----END PGP SIGNATURE-----$"
634 (setq armor-end (re-search-forward
635 "^-----END PGP MESSAGE-----$"
638 (error "No armor tail"))
639 (epa-verify-region armor-start armor-end))))))
642 (defun epa-sign-region (start end signers mode)
643 "Sign the current region between START and END by SIGNERS keys selected.
645 Don't use this command in Lisp programs!"
647 (list (region-beginning) (region-end)
648 (epa-select-keys (epg-make-context) "Select keys for signing.
649 If no one is selected, default secret key is used. "
651 (if (y-or-n-p "Make a detached signature? ")
653 (if (y-or-n-p "Make a cleartext signature? ")
656 (let ((context (epg-make-context))
658 (epg-context-set-armor context epa-armor)
659 (epg-context-set-textmode context epa-textmode)
660 (epg-context-set-signers context signers)
661 (message "Signing...")
662 (setq signature (epg-sign-string context
663 (encode-coding-string
664 (buffer-substring start end)
665 coding-system-for-write)
667 (message "Signing...done")
668 (delete-region start end)
669 (insert (decode-coding-string signature coding-system-for-read)))))
672 (defun epa-encrypt-region (start end recipients)
673 "Encrypt the current region between START and END for RECIPIENTS.
675 Don't use this command in Lisp programs!"
677 (list (region-beginning) (region-end)
678 (epa-select-keys (epg-make-context) "Select recipents for encryption.
679 If no one is selected, symmetric encryption will be performed. ")))
681 (let ((context (epg-make-context))
683 (epg-context-set-armor context epa-armor)
684 (epg-context-set-textmode context epa-textmode)
685 (message "Encrypting...")
686 (setq cipher (epg-encrypt-string context
687 (encode-coding-string
688 (buffer-substring start end)
689 coding-system-for-write)
691 (message "Encrypting...done")
692 (delete-region start end)
696 (defun epa-delete-keys (keys &optional allow-secret)
697 "Delete selected KEYS."
699 (let ((keys (epa-marked-keys)))
701 (error "No keys selected"))
703 (eq (nth 1 epa-list-keys-arguments) t))))
704 (let ((context (epg-make-context)))
705 (message "Deleting...")
706 (epg-delete-keys context keys allow-secret)
707 (message "Deleting...done")
708 (apply #'epa-list-keys epa-list-keys-arguments)))
711 (defun epa-import-keys (file)
712 "Import keys from FILE."
713 (interactive "fFile: ")
714 (let ((context (epg-make-context)))
715 (message "Importing %s..." (file-name-nondirectory file))
716 (epg-import-keys-from-file context (expand-file-name file))
717 (message "Importing %s...done" (file-name-nondirectory file))
718 (apply #'epa-list-keys epa-list-keys-arguments)))
721 (defun epa-export-keys (keys file)
722 "Export selected KEYS to FILE."
724 (let ((keys (epa-marked-keys))
727 (error "No keys selected"))
730 (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
731 (if epa-armor ".asc" ".gpg"))
736 (concat "To file (default "
737 (file-name-nondirectory default-name)
739 (file-name-directory default-name)
741 (let ((context (epg-make-context)))
742 (epg-context-set-armor context epa-armor)
743 (message "Exporting to %s..." (file-name-nondirectory file))
744 (epg-export-keys-to-file context keys file)
745 (message "Exporting to %s...done" (file-name-nondirectory file))))
748 (defun epa-sign-keys (keys &optional local)
750 If LOCAL is non-nil, the signature is marked as non exportable."
752 (let ((keys (epa-marked-keys)))
754 (error "No keys selected"))
755 (list keys current-prefix-arg)))
756 (let ((context (epg-make-context)))
757 (message "Signing keys...")
758 (epg-sign-keys context keys local)
759 (message "Signing keys...done")))