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 (defgroup epa-faces nil
39 (defface epa-validity-high-face
40 '((((class color) (background dark))
41 (:foreground "PaleTurquoise" :bold t))
44 "Face used for displaying the high validity."
46 (defvar epa-validity-high-face 'epa-validity-high-face)
48 (defface epa-validity-medium-face
49 '((((class color) (background dark))
50 (:foreground "PaleTurquoise" :italic t))
53 "Face used for displaying the medium validity."
55 (defvar epa-validity-medium-face 'epa-validity-medium-face)
57 (defface epa-validity-low-face
60 "Face used for displaying the low validity."
62 (defvar epa-validity-low-face 'epa-validity-low-face)
64 (defface epa-validity-disabled-face
66 (:italic t :inverse-video t)))
67 "Face used for displaying the disabled validity."
69 (defvar epa-validity-disabled-face 'epa-validity-disabled-face)
71 (defface epa-string-face
74 (:foreground "lightyellow"))
77 (:foreground "blue4"))
80 "Face used for displaying the string."
82 (defvar epa-string-face 'epa-string-face)
84 (defface epa-mark-face
85 '((((class color) (background dark))
86 (:foreground "orange" :bold t))
88 (:foreground "red" :bold t)))
89 "Face used for displaying the high validity."
91 (defvar epa-mark-face 'epa-mark-face)
93 (defface epa-field-name-face
94 '((((class color) (background dark))
95 (:foreground "PaleTurquoise" :bold t))
97 "Face for the name of the attribute field."
99 (defvar epa-field-name-face 'epa-field-name-face)
101 (defface epa-field-body-face
102 '((((class color) (background dark))
103 (:foreground "turquoise" :italic t))
105 "Face for the body of the attribute field."
107 (defvar epa-field-body-face 'epa-field-body-face)
109 (defcustom epa-validity-face-alist
110 '((unknown . epa-validity-disabled-face)
111 (invalid . epa-validity-disabled-face)
112 (disabled . epa-validity-disabled-face)
113 (revoked . epa-validity-disabled-face)
114 (expired . epa-validity-disabled-face)
115 (none . epa-validity-low-face)
116 (undefined . epa-validity-low-face)
117 (never . epa-validity-low-face)
118 (marginal . epa-validity-medium-face)
119 (full . epa-validity-high-face)
120 (ultimate . epa-validity-high-face))
121 "An alist mapping validity values to faces."
125 (defcustom epa-font-lock-keywords
128 ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
129 (1 epa-field-name-face)
130 (2 epa-field-body-face)))
131 "Default expressions to addon in epa-mode."
132 :type '(repeat (list string))
135 (defconst epa-pubkey-algorithm-letter-alist
143 (defvar epa-keys-buffer nil)
144 (defvar epa-key-buffer-alist nil)
146 (defvar epa-list-keys-arguments nil)
148 (defvar epa-keys-mode-map
149 (let ((keymap (make-sparse-keymap)))
150 (define-key keymap "m" 'epa-mark)
151 (define-key keymap "u" 'epa-unmark)
152 (define-key keymap "d" 'epa-decrypt-file)
153 (define-key keymap "v" 'epa-verify-file)
154 (define-key keymap "s" 'epa-sign-file)
155 (define-key keymap "S" 'epa-sign-keys)
156 (define-key keymap "e" 'epa-encrypt-file)
157 (define-key keymap "r" 'epa-delete-keys)
158 (define-key keymap "i" 'epa-import-keys)
159 (define-key keymap "o" 'epa-export-keys)
160 (define-key keymap "g" 'epa-list-keys)
161 (define-key keymap "n" 'next-line)
162 (define-key keymap "p" 'previous-line)
163 (define-key keymap " " 'scroll-up)
164 (define-key keymap [delete] 'scroll-down)
165 (define-key keymap "q" 'epa-exit-buffer)
168 (defvar epa-exit-buffer-function #'bury-buffer)
170 (define-widget 'epa-key 'push-button
171 "Button for representing a epg-key object."
173 :button-face-get 'epa-key-widget-button-face-get
174 :value-create 'epa-key-widget-value-create
175 :action 'epa-key-widget-action
176 :help-echo 'epa-key-widget-help-echo)
178 (defun epa-key-widget-action (widget &optional event)
179 (epa-show-key (widget-get widget :value)))
181 (defun epa-key-widget-value-create (widget)
182 (let* ((key (widget-get widget :value))
183 (primary-sub-key (car (epg-key-sub-key-list key)))
184 (primary-user-id (car (epg-key-user-id-list key))))
185 (insert (format "%c "
186 (if (epg-sub-key-validity primary-sub-key)
187 (car (rassq (epg-sub-key-validity primary-sub-key)
188 epg-key-validity-alist))
190 (epg-sub-key-id primary-sub-key)
192 (if (stringp (epg-user-id-name primary-user-id))
193 (epg-user-id-name primary-user-id)
194 (epg-decode-dn (epg-user-id-name primary-user-id))))))
196 (defun epa-key-widget-button-face-get (widget)
197 (let ((validity (epg-sub-key-validity (car (epg-key-sub-key-list
198 (widget-get widget :value))))))
200 (cdr (assq validity epa-validity-face-alist))
203 (defun epa-key-widget-help-echo (widget)
205 (epg-sub-key-id (car (epg-key-sub-key-list
206 (widget-get widget :value))))))
208 (defun epa-keys-mode ()
209 "Major mode for `epa-list-keys'."
210 (kill-all-local-variables)
211 (buffer-disable-undo)
212 (setq major-mode 'epa-keys-mode
216 (use-local-map epa-keys-mode-map)
217 (set-keymap-parent (current-local-map) widget-keymap)
218 (make-local-variable 'font-lock-defaults)
219 (setq font-lock-defaults '(epa-font-lock-keywords t))
220 ;; In XEmacs, auto-initialization of font-lock is not effective
221 ;; if buffer-file-name is not set.
222 (font-lock-set-defaults)
224 (make-local-variable 'epa-exit-buffer-function)
225 (run-hooks 'epa-keys-mode-hook))
227 (defvar epa-key-mode-map
228 (let ((keymap (make-sparse-keymap)))
229 (define-key keymap "q" 'bury-buffer)
232 (defun epa-key-mode ()
233 "Major mode for `epa-show-key'."
234 (kill-all-local-variables)
235 (buffer-disable-undo)
236 (setq major-mode 'epa-key-mode
240 (use-local-map epa-key-mode-map)
241 (make-local-variable 'font-lock-defaults)
242 (setq font-lock-defaults '(epa-font-lock-keywords t))
243 ;; In XEmacs, auto-initialization of font-lock is not effective
244 ;; if buffer-file-name is not set.
245 (font-lock-set-defaults)
246 (make-local-variable 'epa-exit-buffer-function)
247 (run-hooks 'epa-key-mode-hook))
250 (defun epa-list-keys (&optional name mode protocol)
252 (if current-prefix-arg
253 (let ((name (read-string "Pattern: "
254 (if epa-list-keys-arguments
255 (car epa-list-keys-arguments)))))
256 (list (if (equal name "") nil name)
257 (y-or-n-p "Secret keys? ")
258 (intern (completing-read "Protocol? "
259 '(("OpenPGP") ("CMS"))
261 (or epa-list-keys-arguments (list nil nil nil))))
262 (unless (and epa-keys-buffer
263 (buffer-live-p epa-keys-buffer))
264 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
265 (set-buffer epa-keys-buffer)
266 (let ((inhibit-read-only t)
269 (context (epg-make-context protocol)))
270 (unless (get-text-property point 'epa-list-keys)
271 (setq point (next-single-property-change point 'epa-list-keys)))
274 (or (next-single-property-change point 'epa-list-keys)
277 (epa-list-keys-1 context name mode)
279 (make-local-variable 'epa-list-keys-arguments)
280 (setq epa-list-keys-arguments (list name mode protocol))
281 (goto-char (point-min))
282 (pop-to-buffer (current-buffer)))
284 (defun epa-list-keys-1 (context name mode)
286 (narrow-to-region (point) (point))
287 (let ((inhibit-read-only t)
289 (keys (epg-list-keys context name mode))
294 (put-text-property point (point) 'epa-key (car keys))
295 (widget-create 'epa-key :value (car keys))
297 (setq keys (cdr keys))))
298 (put-text-property (point-min) (point-max) 'epa-list-keys t)))
300 (defun epa-marked-keys ()
302 (set-buffer epa-keys-buffer)
303 (goto-char (point-min))
305 (while (re-search-forward "^\\*" nil t)
306 (if (setq key (get-text-property (match-beginning 0)
308 (setq keys (cons key keys))))
312 (let ((key (get-text-property (point) 'epa-key)))
316 (defun epa-select-keys (context prompt &optional names mode)
318 (unless (and epa-keys-buffer
319 (buffer-live-p epa-keys-buffer))
320 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
321 (let ((inhibit-read-only t)
324 (set-buffer epa-keys-buffer)
328 :notify (lambda (&rest ignore) (abort-recursive-edit))
330 (substitute-command-keys
331 "Click here or \\[abort-recursive-edit] to cancel")
334 :notify (lambda (&rest ignore) (exit-recursive-edit))
336 (substitute-command-keys
337 "Click here or \\[exit-recursive-edit] to finish")
343 (epa-list-keys-1 context (car names) mode)
346 (goto-char (point-max))
347 (setq names (cdr names)))
348 (epa-list-keys-1 context nil mode))
350 (setq epa-exit-buffer-function #'abort-recursive-edit)
351 (goto-char (point-min))
352 (pop-to-buffer (current-buffer))
357 (if (get-buffer-window epa-keys-buffer)
358 (delete-window (get-buffer-window epa-keys-buffer)))
359 (kill-buffer epa-keys-buffer)))))
361 (defun epa-show-key (key)
362 (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
363 (entry (assoc (epg-sub-key-id primary-sub-key)
364 epa-key-buffer-alist))
365 (inhibit-read-only t)
369 (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
370 epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
371 (unless (and (cdr entry)
372 (buffer-live-p (cdr entry)))
373 (setcdr entry (generate-new-buffer
374 (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
375 (set-buffer (cdr entry))
376 (make-local-variable 'epa-key)
379 (setq pointer (epg-key-user-id-list key))
382 (if (epg-user-id-validity (car pointer))
384 (car (rassq (epg-user-id-validity (car pointer))
385 epg-key-validity-alist)))
388 (if (stringp (epg-user-id-name (car pointer)))
389 (epg-user-id-name (car pointer))
390 (epg-decode-dn (epg-user-id-name (car pointer))))
392 (setq pointer (cdr pointer)))
393 (setq pointer (epg-key-sub-key-list key))
396 (if (epg-sub-key-validity (car pointer))
398 (car (rassq (epg-sub-key-validity (car pointer))
399 epg-key-validity-alist)))
402 (epg-sub-key-id (car pointer))
405 (epg-sub-key-length (car pointer)))
407 (cdr (assq (epg-sub-key-algorithm (car pointer))
408 epg-pubkey-algorithm-alist))
410 (epg-sub-key-creation-time (car pointer))
411 (if (epg-sub-key-expiration-time (car pointer))
412 (format "\n\tExpires: %s" (epg-sub-key-expiration-time
416 (mapconcat #'symbol-name
417 (epg-sub-key-capability (car pointer))
420 (epg-sub-key-fingerprint (car pointer))
422 (setq pointer (cdr pointer)))
423 (goto-char (point-min))
424 (pop-to-buffer (current-buffer))
427 (defun epa-show-key-notify (widget &rest ignore)
428 (epa-show-key (widget-get widget :value)))
430 (defun epa-mark (&optional arg)
431 "Mark the current line."
433 (let ((inhibit-read-only t)
437 (setq properties (text-properties-at (point)))
439 (insert (if arg " " "*"))
440 (set-text-properties (1- (point)) (point) properties)
443 (defun epa-unmark (&optional arg)
444 "Unmark the current line."
446 (epa-mark (not arg)))
448 (defun epa-exit-buffer ()
450 (funcall epa-exit-buffer-function))
452 (defun epa-decrypt-file (file)
453 (interactive "fFile: ")
454 (let* ((default-name (file-name-sans-extension file))
455 (plain (expand-file-name
457 (concat "To file (default "
458 (file-name-nondirectory default-name)
460 (file-name-directory default-name)
462 (context (epg-make-context)))
463 (message "Decrypting %s..." (file-name-nondirectory file))
464 (epg-decrypt-file context file plain)
465 (message "Decrypting %s...done" (file-name-nondirectory file))))
467 (defun epa-verify-file (file)
468 (interactive "fFile: ")
469 (let* ((context (epg-make-context))
470 (plain (if (equal (file-name-extension file) "sig")
471 (file-name-sans-extension file))))
472 (message "Verifying %s..." (file-name-nondirectory file))
473 (epg-verify-file context file plain)
474 (message "Verifying %s...done" (file-name-nondirectory file))
476 (epg-verify-result-to-string
477 (epg-context-result-for context 'verify)))))
479 (defun epa-sign-file (file detached)
481 (list (expand-file-name (read-file-name "File: "))
482 (y-or-n-p "Make a detached signature? ")))
483 (let ((signature (concat file (if detached ".sig" ".gpg")))
484 (context (epg-make-context)))
485 (message "Signing %s..." (file-name-nondirectory file))
486 (epg-sign-file context file signature (not (null detached)))
487 (message "Signing %s...done" (file-name-nondirectory file))))
489 (defun epa-encrypt-file (file recipients)
491 (list (expand-file-name (read-file-name "File: "))
492 (epa-select-keys (epg-make-context) "Select recipents for encryption.
493 If no one is selected, symmetric encryption will be performed. ")))
494 (let ((cipher (concat file ".gpg"))
495 (context (epg-make-context)))
496 (message "Encrypting %s..." (file-name-nondirectory file))
497 (epg-encrypt-file context file recipients cipher)
498 (message "Encrypting %s...done" (file-name-nondirectory file))))
500 (defun epa-delete-keys (keys)
502 (let ((keys (epa-marked-keys)))
504 (error "No keys selected"))
506 (let ((context (epg-make-context)))
507 (message "Deleting...")
508 (epg-delete-keys context keys)
509 (apply #'epa-list-keys epa-list-keys-arguments)
510 (message "Deleting...done")))
512 (defun epa-import-keys (file)
513 (interactive "fFile: ")
514 (let ((context (epg-make-context)))
515 (message "Importing %s..." (file-name-nondirectory file))
516 (epg-import-keys-from-file context (expand-file-name file))
517 (apply #'epa-list-keys epa-list-keys-arguments)
518 (message "Importing %s...done" (file-name-nondirectory file))))
520 (defun epa-export-keys (keys file)
522 (let ((keys (epa-marked-keys))
525 (error "No keys selected"))
528 (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
534 (concat "To file (default "
535 (file-name-nondirectory default-name)
537 (file-name-directory default-name)
539 (let ((context (epg-make-context)))
540 (message "Exporting to %s..." (file-name-nondirectory file))
541 (epg-export-keys-to-file context keys file)
542 (message "Exporting to %s...done" (file-name-nondirectory file))))
544 (defun epa-sign-keys (keys &optional local)
546 (let ((keys (epa-marked-keys)))
548 (error "No keys selected"))
549 (list keys current-prefix-arg)))
550 (let ((context (epg-make-context)))
551 (message "Signing keys...")
552 (epg-sign-keys context keys local)
553 (message "Signing keys...done")))