(Info-bookmark-make-record): Document this function.
[emacs.git] / lisp / epa.el
blob541d26724d5403b5fadae94b13bb9ba36502357c
1 ;;; epa.el --- the EasyPG Assistant
2 ;; Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: PGP, GnuPG
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs 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 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs 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. If not, see <http://www.gnu.org/licenses/>.
22 ;;; Code:
24 (require 'epg)
25 (require 'font-lock)
26 (require 'widget)
27 (eval-when-compile (require 'wid-edit))
28 (require 'derived)
30 (defgroup epa nil
31 "The EasyPG Assistant"
32 :version "23.1"
33 :group 'epg)
35 (defcustom epa-popup-info-window t
36 "If non-nil, status information from epa commands is displayed on
37 the separate window."
38 :type 'boolean
39 :group 'epa)
41 (defcustom epa-info-window-height 5
42 "Number of lines used to display status information."
43 :type 'integer
44 :group 'epa)
46 (defgroup epa-faces nil
47 "Faces for epa-mode."
48 :version "23.1"
49 :group 'epa)
51 (defface epa-validity-high
52 `((((class color) (background dark))
53 (:foreground "PaleTurquoise"
54 ,@(if (assq ':weight custom-face-attributes)
55 '(:weight bold)
56 '(:bold t))))
58 (,@(if (assq ':weight custom-face-attributes)
59 '(:weight bold)
60 '(:bold t)))))
61 "Face used for displaying the high validity."
62 :group 'epa-faces)
64 (defface epa-validity-medium
65 `((((class color) (background dark))
66 (:foreground "PaleTurquoise"
67 ,@(if (assq ':slant custom-face-attributes)
68 '(:slant italic)
69 '(:italic t))))
71 (,@(if (assq ':slant custom-face-attributes)
72 '(:slant italic)
73 '(:italic t)))))
74 "Face used for displaying the medium validity."
75 :group 'epa-faces)
77 (defface epa-validity-low
78 `((t
79 (,@(if (assq ':slant custom-face-attributes)
80 '(:slant italic)
81 '(:italic t)))))
82 "Face used for displaying the low validity."
83 :group 'epa-faces)
85 (defface epa-validity-disabled
86 `((t
87 (,@(if (assq ':slant custom-face-attributes)
88 '(:slant italic)
89 '(:italic t))
90 :inverse-video t)))
91 "Face used for displaying the disabled validity."
92 :group 'epa-faces)
94 (defface epa-string
95 '((((class color) (background dark))
96 (:foreground "lightyellow"))
97 (((class color) (background light))
98 (:foreground "blue4")))
99 "Face used for displaying the string."
100 :group 'epa-faces)
102 (defface epa-mark
103 `((((class color) (background dark))
104 (:foreground "orange"
105 ,@(if (assq ':weight custom-face-attributes)
106 '(:weight bold)
107 '(:bold t))))
108 (((class color) (background light))
109 (:foreground "red"
110 ,@(if (assq ':weight custom-face-attributes)
111 '(:weight bold)
112 '(:bold t))))
114 (,@(if (assq ':weight custom-face-attributes)
115 '(:weight bold)
116 '(:bold t)))))
117 "Face used for displaying the high validity."
118 :group 'epa-faces)
120 (defface epa-field-name
121 `((((class color) (background dark))
122 (:foreground "PaleTurquoise"
123 ,@(if (assq ':weight custom-face-attributes)
124 '(:weight bold)
125 '(:bold t))))
127 (,@(if (assq ':weight custom-face-attributes)
128 '(:weight bold)
129 '(:bold t)))))
130 "Face for the name of the attribute field."
131 :group 'epa)
133 (defface epa-field-body
134 `((((class color) (background dark))
135 (:foreground "turquoise"
136 ,@(if (assq ':slant custom-face-attributes)
137 '(:slant italic)
138 '(:italic t))))
140 (,@(if (assq ':slant custom-face-attributes)
141 '(:slant italic)
142 '(:italic t)))))
143 "Face for the body of the attribute field."
144 :group 'epa)
146 (defcustom epa-validity-face-alist
147 '((unknown . epa-validity-disabled)
148 (invalid . epa-validity-disabled)
149 (disabled . epa-validity-disabled)
150 (revoked . epa-validity-disabled)
151 (expired . epa-validity-disabled)
152 (none . epa-validity-low)
153 (undefined . epa-validity-low)
154 (never . epa-validity-low)
155 (marginal . epa-validity-medium)
156 (full . epa-validity-high)
157 (ultimate . epa-validity-high))
158 "An alist mapping validity values to faces."
159 :type '(repeat (cons symbol face))
160 :group 'epa)
162 (defvar epa-font-lock-keywords
163 '(("^\\*"
164 (0 'epa-mark))
165 ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
166 (1 'epa-field-name)
167 (2 'epa-field-body)))
168 "Default expressions to addon in epa-mode.")
170 (defconst epa-pubkey-algorithm-letter-alist
171 '((1 . ?R)
172 (2 . ?r)
173 (3 . ?s)
174 (16 . ?g)
175 (17 . ?D)
176 (20 . ?G)))
178 (defvar epa-protocol 'OpenPGP
179 "*The default protocol.
180 The value can be either OpenPGP or CMS.
182 You should bind this variable with `let', but do not set it globally.")
184 (defvar epa-armor nil
185 "*If non-nil, epa commands create ASCII armored output.
187 You should bind this variable with `let', but do not set it globally.")
189 (defvar epa-textmode nil
190 "*If non-nil, epa commands treat input files as text.
192 You should bind this variable with `let', but do not set it globally.")
194 (defvar epa-keys-buffer nil)
195 (defvar epa-key-buffer-alist nil)
196 (defvar epa-key nil)
197 (defvar epa-list-keys-arguments nil)
198 (defvar epa-info-buffer nil)
199 (defvar epa-last-coding-system-specified nil)
201 (defvar epa-key-list-mode-map
202 (let ((keymap (make-sparse-keymap))
203 (menu-map (make-sparse-keymap)))
204 (define-key keymap "m" 'epa-mark-key)
205 (define-key keymap "u" 'epa-unmark-key)
206 (define-key keymap "d" 'epa-decrypt-file)
207 (define-key keymap "v" 'epa-verify-file)
208 (define-key keymap "s" 'epa-sign-file)
209 (define-key keymap "e" 'epa-encrypt-file)
210 (define-key keymap "r" 'epa-delete-keys)
211 (define-key keymap "i" 'epa-import-keys)
212 (define-key keymap "o" 'epa-export-keys)
213 (define-key keymap "g" 'revert-buffer)
214 (define-key keymap "n" 'next-line)
215 (define-key keymap "p" 'previous-line)
216 (define-key keymap " " 'scroll-up)
217 (define-key keymap [delete] 'scroll-down)
218 (define-key keymap "q" 'epa-exit-buffer)
219 (define-key keymap [menu-bar epa-key-list-mode] (cons "Keys" menu-map))
220 (define-key menu-map [epa-key-list-unmark-key]
221 '(menu-item "Unmark Key" epa-unmark-key
222 :help "Unmark a key"))
223 (define-key menu-map [epa-key-list-mark-key]
224 '(menu-item "Mark Key" epa-mark-key
225 :help "Mark a key"))
226 (define-key menu-map [separator-epa-file] '(menu-item "--"))
227 (define-key menu-map [epa-verify-file]
228 '(menu-item "Verify File..." epa-verify-file
229 :help "Verify FILE"))
230 (define-key menu-map [epa-sign-file]
231 '(menu-item "Sign File..." epa-sign-file
232 :help "Sign FILE by SIGNERS keys selected"))
233 (define-key menu-map [epa-decrypt-file]
234 '(menu-item "Decrypt File..." epa-decrypt-file
235 :help "Decrypt FILE"))
236 (define-key menu-map [epa-encrypt-file]
237 '(menu-item "Encrypt File..." epa-encrypt-file
238 :help "Encrypt FILE for RECIPIENTS"))
239 (define-key menu-map [separator-epa-key-list] '(menu-item "--"))
240 (define-key menu-map [epa-key-list-delete-keys]
241 '(menu-item "Delete keys" epa-delete-keys
242 :help "Delete Marked Keys"))
243 (define-key menu-map [epa-key-list-import-keys]
244 '(menu-item "Import Keys" epa-import-keys
245 :help "Import keys from a file"))
246 (define-key menu-map [epa-key-list-export-keys]
247 '(menu-item "Export Keys" epa-export-keys
248 :help "Export marked keys to a file"))
249 keymap))
251 (defvar epa-key-mode-map
252 (let ((keymap (make-sparse-keymap)))
253 (define-key keymap "q" 'epa-exit-buffer)
254 keymap))
256 (defvar epa-info-mode-map
257 (let ((keymap (make-sparse-keymap)))
258 (define-key keymap "q" 'delete-window)
259 keymap))
261 (defvar epa-exit-buffer-function #'bury-buffer)
263 (define-widget 'epa-key 'push-button
264 "Button for representing a epg-key object."
265 :format "%[%v%]"
266 :button-face-get 'epa--key-widget-button-face-get
267 :value-create 'epa--key-widget-value-create
268 :action 'epa--key-widget-action
269 :help-echo 'epa--key-widget-help-echo)
271 (defun epa--key-widget-action (widget &optional event)
272 (save-selected-window
273 (epa--show-key (widget-get widget :value))))
275 (defun epa--key-widget-value-create (widget)
276 (let* ((key (widget-get widget :value))
277 (primary-sub-key (car (epg-key-sub-key-list key)))
278 (primary-user-id (car (epg-key-user-id-list key))))
279 (insert (format "%c "
280 (if (epg-sub-key-validity primary-sub-key)
281 (car (rassq (epg-sub-key-validity primary-sub-key)
282 epg-key-validity-alist))
283 ? ))
284 (epg-sub-key-id primary-sub-key)
286 (if primary-user-id
287 (if (stringp (epg-user-id-string primary-user-id))
288 (epg-user-id-string primary-user-id)
289 (epg-decode-dn (epg-user-id-string primary-user-id)))
290 ""))))
292 (defun epa--key-widget-button-face-get (widget)
293 (let ((validity (epg-sub-key-validity (car (epg-key-sub-key-list
294 (widget-get widget :value))))))
295 (if validity
296 (cdr (assq validity epa-validity-face-alist))
297 'default)))
299 (defun epa--key-widget-help-echo (widget)
300 (format "Show %s"
301 (epg-sub-key-id (car (epg-key-sub-key-list
302 (widget-get widget :value))))))
304 (eval-and-compile
305 (if (fboundp 'encode-coding-string)
306 (defalias 'epa--encode-coding-string 'encode-coding-string)
307 (defalias 'epa--encode-coding-string 'identity)))
309 (eval-and-compile
310 (if (fboundp 'decode-coding-string)
311 (defalias 'epa--decode-coding-string 'decode-coding-string)
312 (defalias 'epa--decode-coding-string 'identity)))
314 (defun epa-key-list-mode ()
315 "Major mode for `epa-list-keys'."
316 (kill-all-local-variables)
317 (buffer-disable-undo)
318 (setq major-mode 'epa-key-list-mode
319 mode-name "Keys"
320 truncate-lines t
321 buffer-read-only t)
322 (use-local-map epa-key-list-mode-map)
323 (make-local-variable 'font-lock-defaults)
324 (setq font-lock-defaults '(epa-font-lock-keywords t))
325 ;; In XEmacs, auto-initialization of font-lock is not effective
326 ;; if buffer-file-name is not set.
327 (font-lock-set-defaults)
328 (make-local-variable 'epa-exit-buffer-function)
329 (make-local-variable 'revert-buffer-function)
330 (setq revert-buffer-function 'epa--key-list-revert-buffer)
331 (run-mode-hooks 'epa-key-list-mode-hook))
333 (defun epa-key-mode ()
334 "Major mode for a key description."
335 (kill-all-local-variables)
336 (buffer-disable-undo)
337 (setq major-mode 'epa-key-mode
338 mode-name "Key"
339 truncate-lines t
340 buffer-read-only t)
341 (use-local-map epa-key-mode-map)
342 (make-local-variable 'font-lock-defaults)
343 (setq font-lock-defaults '(epa-font-lock-keywords t))
344 ;; In XEmacs, auto-initialization of font-lock is not effective
345 ;; if buffer-file-name is not set.
346 (font-lock-set-defaults)
347 (make-local-variable 'epa-exit-buffer-function)
348 (run-mode-hooks 'epa-key-mode-hook))
350 (defun epa-info-mode ()
351 "Major mode for `epa-info-buffer'."
352 (kill-all-local-variables)
353 (buffer-disable-undo)
354 (setq major-mode 'epa-info-mode
355 mode-name "Info"
356 truncate-lines t
357 buffer-read-only t)
358 (use-local-map epa-info-mode-map)
359 (run-mode-hooks 'epa-info-mode-hook))
361 (defun epa-mark-key (&optional arg)
362 "Mark a key on the current line.
363 If ARG is non-nil, unmark the key."
364 (interactive "P")
365 (let ((inhibit-read-only t)
366 buffer-read-only
367 properties)
368 (beginning-of-line)
369 (unless (get-text-property (point) 'epa-key)
370 (error "No key on this line"))
371 (setq properties (text-properties-at (point)))
372 (delete-char 1)
373 (insert (if arg " " "*"))
374 (set-text-properties (1- (point)) (point) properties)
375 (forward-line)))
377 (defun epa-unmark-key (&optional arg)
378 "Unmark a key on the current line.
379 If ARG is non-nil, mark the key."
380 (interactive "P")
381 (epa-mark-key (not arg)))
383 (defun epa-exit-buffer ()
384 "Exit the current buffer.
385 `epa-exit-buffer-function' is called if it is set."
386 (interactive)
387 (funcall epa-exit-buffer-function))
389 (defun epa--insert-keys (keys)
390 (save-excursion
391 (save-restriction
392 (narrow-to-region (point) (point))
393 (let (point)
394 (while keys
395 (setq point (point))
396 (insert " ")
397 (add-text-properties point (point)
398 (list 'epa-key (car keys)
399 'front-sticky nil
400 'rear-nonsticky t
401 'start-open t
402 'end-open t))
403 (widget-create 'epa-key :value (car keys))
404 (insert "\n")
405 (setq keys (cdr keys))))
406 (add-text-properties (point-min) (point-max)
407 (list 'epa-list-keys t
408 'front-sticky nil
409 'rear-nonsticky t
410 'start-open t
411 'end-open t)))))
413 (defun epa--list-keys (name secret)
414 (unless (and epa-keys-buffer
415 (buffer-live-p epa-keys-buffer))
416 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
417 (set-buffer epa-keys-buffer)
418 (epa-key-list-mode)
419 (let ((inhibit-read-only t)
420 buffer-read-only
421 (point (point-min))
422 (context (epg-make-context epa-protocol)))
423 (unless (get-text-property point 'epa-list-keys)
424 (setq point (next-single-property-change point 'epa-list-keys)))
425 (when point
426 (delete-region point
427 (or (next-single-property-change point 'epa-list-keys)
428 (point-max)))
429 (goto-char point))
430 (epa--insert-keys (epg-list-keys context name secret))
431 (widget-setup)
432 (set-keymap-parent (current-local-map) widget-keymap))
433 (make-local-variable 'epa-list-keys-arguments)
434 (setq epa-list-keys-arguments (list name secret))
435 (goto-char (point-min))
436 (pop-to-buffer (current-buffer)))
438 ;;;###autoload
439 (defun epa-list-keys (&optional name)
440 "List all keys matched with NAME from the public keyring."
441 (interactive
442 (if current-prefix-arg
443 (let ((name (read-string "Pattern: "
444 (if epa-list-keys-arguments
445 (car epa-list-keys-arguments)))))
446 (list (if (equal name "") nil name)))
447 (list nil)))
448 (epa--list-keys name nil))
450 ;;;###autoload
451 (defun epa-list-secret-keys (&optional name)
452 "List all keys matched with NAME from the private keyring."
453 (interactive
454 (if current-prefix-arg
455 (let ((name (read-string "Pattern: "
456 (if epa-list-keys-arguments
457 (car epa-list-keys-arguments)))))
458 (list (if (equal name "") nil name)))
459 (list nil)))
460 (epa--list-keys name t))
462 (defun epa--key-list-revert-buffer (&optional ignore-auto noconfirm)
463 (apply #'epa--list-keys epa-list-keys-arguments))
465 (defun epa--marked-keys ()
466 (or (save-excursion
467 (set-buffer epa-keys-buffer)
468 (goto-char (point-min))
469 (let (keys key)
470 (while (re-search-forward "^\\*" nil t)
471 (if (setq key (get-text-property (match-beginning 0)
472 'epa-key))
473 (setq keys (cons key keys))))
474 (nreverse keys)))
475 (save-excursion
476 (beginning-of-line)
477 (let ((key (get-text-property (point) 'epa-key)))
478 (if key
479 (list key))))))
481 (defun epa--select-keys (prompt keys)
482 (save-excursion
483 (unless (and epa-keys-buffer
484 (buffer-live-p epa-keys-buffer))
485 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
486 (set-buffer epa-keys-buffer)
487 (epa-key-list-mode)
488 (let ((inhibit-read-only t)
489 buffer-read-only)
490 (erase-buffer)
491 (insert prompt "\n"
492 (substitute-command-keys "\
493 - `\\[epa-mark-key]' to mark a key on the line
494 - `\\[epa-unmark-key]' to unmark a key on the line\n"))
495 (widget-create 'link
496 :notify (lambda (&rest ignore) (abort-recursive-edit))
497 :help-echo
498 (substitute-command-keys
499 "Click here or \\[abort-recursive-edit] to cancel")
500 "Cancel")
501 (widget-create 'link
502 :notify (lambda (&rest ignore) (exit-recursive-edit))
503 :help-echo
504 (substitute-command-keys
505 "Click here or \\[exit-recursive-edit] to finish")
506 "OK")
507 (insert "\n\n")
508 (epa--insert-keys keys)
509 (widget-setup)
510 (set-keymap-parent (current-local-map) widget-keymap)
511 (setq epa-exit-buffer-function #'abort-recursive-edit)
512 (goto-char (point-min))
513 (pop-to-buffer (current-buffer)))
514 (unwind-protect
515 (progn
516 (recursive-edit)
517 (epa--marked-keys))
518 (if (get-buffer-window epa-keys-buffer)
519 (delete-window (get-buffer-window epa-keys-buffer)))
520 (kill-buffer epa-keys-buffer))))
522 ;;;###autoload
523 (defun epa-select-keys (context prompt &optional names secret)
524 "Display a user's keyring and ask him to select keys.
525 CONTEXT is an epg-context.
526 PROMPT is a string to prompt with.
527 NAMES is a list of strings to be matched with keys. If it is nil, all
528 the keys are listed.
529 If SECRET is non-nil, list secret keys instead of public keys."
530 (let ((keys (epg-list-keys context names secret)))
531 (epa--select-keys prompt keys)))
533 (defun epa--show-key (key)
534 (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
535 (entry (assoc (epg-sub-key-id primary-sub-key)
536 epa-key-buffer-alist))
537 (inhibit-read-only t)
538 buffer-read-only
539 pointer)
540 (unless entry
541 (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
542 epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
543 (unless (and (cdr entry)
544 (buffer-live-p (cdr entry)))
545 (setcdr entry (generate-new-buffer
546 (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
547 (set-buffer (cdr entry))
548 (epa-key-mode)
549 (make-local-variable 'epa-key)
550 (setq epa-key key)
551 (erase-buffer)
552 (setq pointer (epg-key-user-id-list key))
553 (while pointer
554 (if (car pointer)
555 (insert " "
556 (if (epg-user-id-validity (car pointer))
557 (char-to-string
558 (car (rassq (epg-user-id-validity (car pointer))
559 epg-key-validity-alist)))
560 " ")
562 (if (stringp (epg-user-id-string (car pointer)))
563 (epg-user-id-string (car pointer))
564 (epg-decode-dn (epg-user-id-string (car pointer))))
565 "\n"))
566 (setq pointer (cdr pointer)))
567 (setq pointer (epg-key-sub-key-list key))
568 (while pointer
569 (insert " "
570 (if (epg-sub-key-validity (car pointer))
571 (char-to-string
572 (car (rassq (epg-sub-key-validity (car pointer))
573 epg-key-validity-alist)))
574 " ")
576 (epg-sub-key-id (car pointer))
578 (format "%dbits"
579 (epg-sub-key-length (car pointer)))
581 (cdr (assq (epg-sub-key-algorithm (car pointer))
582 epg-pubkey-algorithm-alist))
583 "\n\tCreated: "
584 (condition-case nil
585 (format-time-string "%Y-%m-%d"
586 (epg-sub-key-creation-time (car pointer)))
587 (error "????-??-??"))
588 (if (epg-sub-key-expiration-time (car pointer))
589 (format (if (time-less-p (current-time)
590 (epg-sub-key-expiration-time
591 (car pointer)))
592 "\n\tExpires: %s"
593 "\n\tExpired: %s")
594 (condition-case nil
595 (format-time-string "%Y-%m-%d"
596 (epg-sub-key-expiration-time
597 (car pointer)))
598 (error "????-??-??")))
600 "\n\tCapabilities: "
601 (mapconcat #'symbol-name
602 (epg-sub-key-capability (car pointer))
603 " ")
604 "\n\tFingerprint: "
605 (epg-sub-key-fingerprint (car pointer))
606 "\n")
607 (setq pointer (cdr pointer)))
608 (goto-char (point-min))
609 (pop-to-buffer (current-buffer))))
611 (defun epa-display-info (info)
612 (if epa-popup-info-window
613 (save-selected-window
614 (unless (and epa-info-buffer (buffer-live-p epa-info-buffer))
615 (setq epa-info-buffer (generate-new-buffer "*Info*")))
616 (if (get-buffer-window epa-info-buffer)
617 (delete-window (get-buffer-window epa-info-buffer)))
618 (save-excursion
619 (set-buffer epa-info-buffer)
620 (let ((inhibit-read-only t)
621 buffer-read-only)
622 (erase-buffer)
623 (insert info))
624 (epa-info-mode)
625 (goto-char (point-min)))
626 (if (> (window-height)
627 epa-info-window-height)
628 (set-window-buffer (split-window nil (- (window-height)
629 epa-info-window-height))
630 epa-info-buffer)
631 (pop-to-buffer epa-info-buffer)
632 (if (> (window-height) epa-info-window-height)
633 (shrink-window (- (window-height) epa-info-window-height)))))
634 (message "%s" info)))
636 (defun epa-display-verify-result (verify-result)
637 (epa-display-info (epg-verify-result-to-string verify-result)))
638 (make-obsolete 'epa-display-verify-result 'epa-display-info "23.1")
640 (defun epa-passphrase-callback-function (context key-id handback)
641 (if (eq key-id 'SYM)
642 (read-passwd "Passphrase for symmetric encryption: "
643 (eq (epg-context-operation context) 'encrypt))
644 (read-passwd
645 (if (eq key-id 'PIN)
646 "Passphrase for PIN: "
647 (let ((entry (assoc key-id epg-user-id-alist)))
648 (if entry
649 (format "Passphrase for %s %s: " key-id (cdr entry))
650 (format "Passphrase for %s: " key-id)))))))
652 (defun epa-progress-callback-function (context what char current total
653 handback)
654 (message "%s%d%% (%d/%d)" (or handback
655 (concat what ": "))
656 (if (> total 0) (floor (* (/ current (float total)) 100)) 0)
657 current total))
659 ;;;###autoload
660 (defun epa-decrypt-file (file)
661 "Decrypt FILE."
662 (interactive "fFile: ")
663 (setq file (expand-file-name file))
664 (let* ((default-name (file-name-sans-extension file))
665 (plain (expand-file-name
666 (read-file-name
667 (concat "To file (default "
668 (file-name-nondirectory default-name)
669 ") ")
670 (file-name-directory default-name)
671 default-name)))
672 (context (epg-make-context epa-protocol)))
673 (epg-context-set-passphrase-callback context
674 #'epa-passphrase-callback-function)
675 (epg-context-set-progress-callback context
676 (cons
677 #'epa-progress-callback-function
678 (format "Decrypting %s..."
679 (file-name-nondirectory file))))
680 (message "Decrypting %s..." (file-name-nondirectory file))
681 (epg-decrypt-file context file plain)
682 (message "Decrypting %s...wrote %s" (file-name-nondirectory file)
683 (file-name-nondirectory plain))
684 (if (epg-context-result-for context 'verify)
685 (epa-display-info (epg-verify-result-to-string
686 (epg-context-result-for context 'verify))))))
688 ;;;###autoload
689 (defun epa-verify-file (file)
690 "Verify FILE."
691 (interactive "fFile: ")
692 (setq file (expand-file-name file))
693 (let* ((context (epg-make-context epa-protocol))
694 (plain (if (equal (file-name-extension file) "sig")
695 (file-name-sans-extension file))))
696 (epg-context-set-progress-callback context
697 (cons
698 #'epa-progress-callback-function
699 (format "Verifying %s..."
700 (file-name-nondirectory file))))
701 (message "Verifying %s..." (file-name-nondirectory file))
702 (epg-verify-file context file plain)
703 (message "Verifying %s...done" (file-name-nondirectory file))
704 (if (epg-context-result-for context 'verify)
705 (epa-display-info (epg-verify-result-to-string
706 (epg-context-result-for context 'verify))))))
708 (defun epa--read-signature-type ()
709 (let (type c)
710 (while (null type)
711 (message "Signature type (n,c,d,?) ")
712 (setq c (read-char))
713 (cond ((eq c ?c)
714 (setq type 'clear))
715 ((eq c ?d)
716 (setq type 'detached))
717 ((eq c ??)
718 (with-output-to-temp-buffer "*Help*"
719 (save-excursion
720 (set-buffer standard-output)
721 (insert "\
722 n - Create a normal signature
723 c - Create a cleartext signature
724 d - Create a detached signature
725 ? - Show this help
726 "))))
728 (setq type 'normal))))
729 type))
731 ;;;###autoload
732 (defun epa-sign-file (file signers mode)
733 "Sign FILE by SIGNERS keys selected."
734 (interactive
735 (let ((verbose current-prefix-arg))
736 (list (expand-file-name (read-file-name "File: "))
737 (if verbose
738 (epa-select-keys (epg-make-context epa-protocol)
739 "Select keys for signing.
740 If no one is selected, default secret key is used. "
741 nil t))
742 (if verbose
743 (epa--read-signature-type)
744 'clear))))
745 (let ((signature (concat file
746 (if (eq epa-protocol 'OpenPGP)
747 (if (or epa-armor
748 (not (memq mode
749 '(nil t normal detached))))
750 ".asc"
751 (if (memq mode '(t detached))
752 ".sig"
753 ".gpg"))
754 (if (memq mode '(t detached))
755 ".p7s"
756 ".p7m"))))
757 (context (epg-make-context epa-protocol)))
758 (epg-context-set-armor context epa-armor)
759 (epg-context-set-textmode context epa-textmode)
760 (epg-context-set-signers context signers)
761 (epg-context-set-passphrase-callback context
762 #'epa-passphrase-callback-function)
763 (epg-context-set-progress-callback context
764 (cons
765 #'epa-progress-callback-function
766 (format "Signing %s..."
767 (file-name-nondirectory file))))
768 (message "Signing %s..." (file-name-nondirectory file))
769 (epg-sign-file context file signature mode)
770 (message "Signing %s...wrote %s" (file-name-nondirectory file)
771 (file-name-nondirectory signature))))
773 ;;;###autoload
774 (defun epa-encrypt-file (file recipients)
775 "Encrypt FILE for RECIPIENTS."
776 (interactive
777 (list (expand-file-name (read-file-name "File: "))
778 (epa-select-keys (epg-make-context epa-protocol)
779 "Select recipients for encryption.
780 If no one is selected, symmetric encryption will be performed. ")))
781 (let ((cipher (concat file (if (eq epa-protocol 'OpenPGP)
782 (if epa-armor ".asc" ".gpg")
783 ".p7m")))
784 (context (epg-make-context epa-protocol)))
785 (epg-context-set-armor context epa-armor)
786 (epg-context-set-textmode context epa-textmode)
787 (epg-context-set-passphrase-callback context
788 #'epa-passphrase-callback-function)
789 (epg-context-set-progress-callback context
790 (cons
791 #'epa-progress-callback-function
792 (format "Encrypting %s..."
793 (file-name-nondirectory file))))
794 (message "Encrypting %s..." (file-name-nondirectory file))
795 (epg-encrypt-file context file recipients cipher)
796 (message "Encrypting %s...wrote %s" (file-name-nondirectory file)
797 (file-name-nondirectory cipher))))
799 ;;;###autoload
800 (defun epa-decrypt-region (start end)
801 "Decrypt the current region between START and END.
803 Don't use this command in Lisp programs!
804 Since this function operates on regions, it does some tricks such
805 as coding-system detection and unibyte/multibyte conversion. If
806 you are sure how the data in the region should be treated, you
807 should consider using the string based counterpart
808 `epg-decrypt-string', or the file based counterpart
809 `epg-decrypt-file' instead.
811 For example:
813 \(let ((context (epg-make-context 'OpenPGP)))
814 (decode-coding-string
815 (epg-decrypt-string context (buffer-substring start end))
816 'utf-8))"
817 (interactive "r")
818 (save-excursion
819 (let ((context (epg-make-context epa-protocol))
820 plain)
821 (epg-context-set-passphrase-callback context
822 #'epa-passphrase-callback-function)
823 (epg-context-set-progress-callback context
824 (cons
825 #'epa-progress-callback-function
826 "Decrypting..."))
827 (message "Decrypting...")
828 (setq plain (epg-decrypt-string context (buffer-substring start end)))
829 (message "Decrypting...done")
830 (setq plain (epa--decode-coding-string
831 plain
832 (or coding-system-for-read
833 (get-text-property start 'epa-coding-system-used)
834 'undecided)))
835 (if (y-or-n-p "Replace the original text? ")
836 (let ((inhibit-read-only t)
837 buffer-read-only)
838 (delete-region start end)
839 (goto-char start)
840 (insert plain))
841 (with-output-to-temp-buffer "*Temp*"
842 (set-buffer standard-output)
843 (insert plain)
844 (epa-info-mode)))
845 (if (epg-context-result-for context 'verify)
846 (epa-display-info (epg-verify-result-to-string
847 (epg-context-result-for context 'verify)))))))
849 (defun epa--find-coding-system-for-mime-charset (mime-charset)
850 (if (featurep 'xemacs)
851 (if (fboundp 'find-coding-system)
852 (find-coding-system mime-charset))
853 (let ((pointer (coding-system-list)))
854 (while (and pointer
855 (eq (coding-system-get (car pointer) 'mime-charset)
856 mime-charset))
857 (setq pointer (cdr pointer)))
858 pointer)))
860 ;;;###autoload
861 (defun epa-decrypt-armor-in-region (start end)
862 "Decrypt OpenPGP armors in the current region between START and END.
864 Don't use this command in Lisp programs!
865 See the reason described in the `epa-decrypt-region' documentation."
866 (interactive "r")
867 (save-excursion
868 (save-restriction
869 (narrow-to-region start end)
870 (goto-char start)
871 (let (armor-start armor-end)
872 (while (re-search-forward "-----BEGIN PGP MESSAGE-----$" nil t)
873 (setq armor-start (match-beginning 0)
874 armor-end (re-search-forward "^-----END PGP MESSAGE-----$"
875 nil t))
876 (unless armor-end
877 (error "No armor tail"))
878 (goto-char armor-start)
879 (let ((coding-system-for-read
880 (or coding-system-for-read
881 (if (re-search-forward "^Charset: \\(.*\\)" armor-end t)
882 (epa--find-coding-system-for-mime-charset
883 (intern (downcase (match-string 1))))))))
884 (goto-char armor-end)
885 (epa-decrypt-region armor-start armor-end)))))))
887 ;;;###autoload
888 (defun epa-verify-region (start end)
889 "Verify the current region between START and END.
891 Don't use this command in Lisp programs!
892 Since this function operates on regions, it does some tricks such
893 as coding-system detection and unibyte/multibyte conversion. If
894 you are sure how the data in the region should be treated, you
895 should consider using the string based counterpart
896 `epg-verify-string', or the file based counterpart
897 `epg-verify-file' instead.
899 For example:
901 \(let ((context (epg-make-context 'OpenPGP)))
902 (decode-coding-string
903 (epg-verify-string context (buffer-substring start end))
904 'utf-8))"
905 (interactive "r")
906 (let ((context (epg-make-context epa-protocol))
907 plain)
908 (epg-context-set-progress-callback context
909 (cons
910 #'epa-progress-callback-function
911 "Verifying..."))
912 (message "Verifying...")
913 (setq plain (epg-verify-string
914 context
915 (epa--encode-coding-string
916 (buffer-substring start end)
917 (or coding-system-for-write
918 (get-text-property start 'epa-coding-system-used)))))
919 (message "Verifying...done")
920 (setq plain (epa--decode-coding-string
921 plain
922 (or coding-system-for-read
923 (get-text-property start 'epa-coding-system-used)
924 'undecided)))
925 (if (y-or-n-p "Replace the original text? ")
926 (let ((inhibit-read-only t)
927 buffer-read-only)
928 (delete-region start end)
929 (goto-char start)
930 (insert plain))
931 (with-output-to-temp-buffer "*Temp*"
932 (set-buffer standard-output)
933 (insert plain)
934 (epa-info-mode)))
935 (if (epg-context-result-for context 'verify)
936 (epa-display-info (epg-verify-result-to-string
937 (epg-context-result-for context 'verify))))))
939 ;;;###autoload
940 (defun epa-verify-cleartext-in-region (start end)
941 "Verify OpenPGP cleartext signed messages in the current region
942 between START and END.
944 Don't use this command in Lisp programs!
945 See the reason described in the `epa-verify-region' documentation."
946 (interactive "r")
947 (save-excursion
948 (save-restriction
949 (narrow-to-region start end)
950 (goto-char start)
951 (let (cleartext-start cleartext-end)
952 (while (re-search-forward "-----BEGIN PGP SIGNED MESSAGE-----$"
953 nil t)
954 (setq cleartext-start (match-beginning 0))
955 (unless (re-search-forward "^-----BEGIN PGP SIGNATURE-----$"
956 nil t)
957 (error "Invalid cleartext signed message"))
958 (setq cleartext-end (re-search-forward
959 "^-----END PGP SIGNATURE-----$"
960 nil t))
961 (unless cleartext-end
962 (error "No cleartext tail"))
963 (epa-verify-region cleartext-start cleartext-end))))))
965 (eval-and-compile
966 (if (fboundp 'select-safe-coding-system)
967 (defalias 'epa--select-safe-coding-system 'select-safe-coding-system)
968 (defun epa--select-safe-coding-system (from to)
969 buffer-file-coding-system)))
971 ;;;###autoload
972 (defun epa-sign-region (start end signers mode)
973 "Sign the current region between START and END by SIGNERS keys selected.
975 Don't use this command in Lisp programs!
976 Since this function operates on regions, it does some tricks such
977 as coding-system detection and unibyte/multibyte conversion. If
978 you are sure how the data should be treated, you should consider
979 using the string based counterpart `epg-sign-string', or the file
980 based counterpart `epg-sign-file' instead.
982 For example:
984 \(let ((context (epg-make-context 'OpenPGP)))
985 (epg-sign-string
986 context
987 (encode-coding-string (buffer-substring start end) 'utf-8)))"
988 (interactive
989 (let ((verbose current-prefix-arg))
990 (setq epa-last-coding-system-specified
991 (or coding-system-for-write
992 (epa--select-safe-coding-system
993 (region-beginning) (region-end))))
994 (list (region-beginning) (region-end)
995 (if verbose
996 (epa-select-keys (epg-make-context epa-protocol)
997 "Select keys for signing.
998 If no one is selected, default secret key is used. "
999 nil t))
1000 (if verbose
1001 (epa--read-signature-type)
1002 'clear))))
1003 (save-excursion
1004 (let ((context (epg-make-context epa-protocol))
1005 signature)
1006 ;;(epg-context-set-armor context epa-armor)
1007 (epg-context-set-armor context t)
1008 ;;(epg-context-set-textmode context epa-textmode)
1009 (epg-context-set-textmode context t)
1010 (epg-context-set-signers context signers)
1011 (epg-context-set-passphrase-callback context
1012 #'epa-passphrase-callback-function)
1013 (epg-context-set-progress-callback context
1014 (cons
1015 #'epa-progress-callback-function
1016 "Signing..."))
1017 (message "Signing...")
1018 (setq signature (epg-sign-string context
1019 (epa--encode-coding-string
1020 (buffer-substring start end)
1021 epa-last-coding-system-specified)
1022 mode))
1023 (message "Signing...done")
1024 (delete-region start end)
1025 (goto-char start)
1026 (add-text-properties (point)
1027 (progn
1028 (insert (epa--decode-coding-string
1029 signature
1030 (or coding-system-for-read
1031 epa-last-coding-system-specified)))
1032 (point))
1033 (list 'epa-coding-system-used
1034 epa-last-coding-system-specified
1035 'front-sticky nil
1036 'rear-nonsticky t
1037 'start-open t
1038 'end-open t)))))
1040 (eval-and-compile
1041 (if (fboundp 'derived-mode-p)
1042 (defalias 'epa--derived-mode-p 'derived-mode-p)
1043 (defun epa--derived-mode-p (&rest modes)
1044 "Non-nil if the current major mode is derived from one of MODES.
1045 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1046 (let ((parent major-mode))
1047 (while (and (not (memq parent modes))
1048 (setq parent (get parent 'derived-mode-parent))))
1049 parent))))
1051 ;;;###autoload
1052 (defun epa-encrypt-region (start end recipients sign signers)
1053 "Encrypt the current region between START and END for RECIPIENTS.
1055 Don't use this command in Lisp programs!
1056 Since this function operates on regions, it does some tricks such
1057 as coding-system detection and unibyte/multibyte conversion. If
1058 you are sure how the data should be treated, you should consider
1059 using the string based counterpart `epg-encrypt-string', or the
1060 file based counterpart `epg-encrypt-file' instead.
1062 For example:
1064 \(let ((context (epg-make-context 'OpenPGP)))
1065 (epg-encrypt-string
1066 context
1067 (encode-coding-string (buffer-substring start end) 'utf-8)
1068 nil))"
1069 (interactive
1070 (let ((verbose current-prefix-arg)
1071 (context (epg-make-context epa-protocol))
1072 sign)
1073 (setq epa-last-coding-system-specified
1074 (or coding-system-for-write
1075 (epa--select-safe-coding-system
1076 (region-beginning) (region-end))))
1077 (list (region-beginning) (region-end)
1078 (epa-select-keys context
1079 "Select recipients for encryption.
1080 If no one is selected, symmetric encryption will be performed. ")
1081 (setq sign (if verbose (y-or-n-p "Sign? ")))
1082 (if sign
1083 (epa-select-keys context
1084 "Select keys for signing. ")))))
1085 (save-excursion
1086 (let ((context (epg-make-context epa-protocol))
1087 cipher)
1088 ;;(epg-context-set-armor context epa-armor)
1089 (epg-context-set-armor context t)
1090 ;;(epg-context-set-textmode context epa-textmode)
1091 (epg-context-set-textmode context t)
1092 (if sign
1093 (epg-context-set-signers context signers))
1094 (epg-context-set-passphrase-callback context
1095 #'epa-passphrase-callback-function)
1096 (epg-context-set-progress-callback context
1097 (cons
1098 #'epa-progress-callback-function
1099 "Encrypting..."))
1100 (message "Encrypting...")
1101 (setq cipher (epg-encrypt-string context
1102 (epa--encode-coding-string
1103 (buffer-substring start end)
1104 epa-last-coding-system-specified)
1105 recipients
1106 sign))
1107 (message "Encrypting...done")
1108 (delete-region start end)
1109 (goto-char start)
1110 (add-text-properties (point)
1111 (progn
1112 (insert cipher)
1113 (point))
1114 (list 'epa-coding-system-used
1115 epa-last-coding-system-specified
1116 'front-sticky nil
1117 'rear-nonsticky t
1118 'start-open t
1119 'end-open t)))))
1121 ;;;###autoload
1122 (defun epa-delete-keys (keys &optional allow-secret)
1123 "Delete selected KEYS."
1124 (interactive
1125 (let ((keys (epa--marked-keys)))
1126 (unless keys
1127 (error "No keys selected"))
1128 (list keys
1129 (eq (nth 1 epa-list-keys-arguments) t))))
1130 (let ((context (epg-make-context epa-protocol)))
1131 (message "Deleting...")
1132 (epg-delete-keys context keys allow-secret)
1133 (message "Deleting...done")
1134 (apply #'epa--list-keys epa-list-keys-arguments)))
1136 ;;;###autoload
1137 (defun epa-import-keys (file)
1138 "Import keys from FILE."
1139 (interactive "fFile: ")
1140 (setq file (expand-file-name file))
1141 (let ((context (epg-make-context epa-protocol)))
1142 (message "Importing %s..." (file-name-nondirectory file))
1143 (condition-case nil
1144 (progn
1145 (epg-import-keys-from-file context file)
1146 (message "Importing %s...done" (file-name-nondirectory file)))
1147 (error
1148 (message "Importing %s...failed" (file-name-nondirectory file))))
1149 (if (epg-context-result-for context 'import)
1150 (epa-display-info (epg-import-result-to-string
1151 (epg-context-result-for context 'import))))
1152 (if (eq major-mode 'epa-key-list-mode)
1153 (apply #'epa--list-keys epa-list-keys-arguments))))
1155 ;;;###autoload
1156 (defun epa-import-keys-region (start end)
1157 "Import keys from the region."
1158 (interactive "r")
1159 (let ((context (epg-make-context epa-protocol)))
1160 (message "Importing...")
1161 (condition-case nil
1162 (progn
1163 (epg-import-keys-from-string context (buffer-substring start end))
1164 (message "Importing...done"))
1165 (error
1166 (message "Importing...failed")))
1167 (if (epg-context-result-for context 'import)
1168 (epa-display-info (epg-import-result-to-string
1169 (epg-context-result-for context 'import))))))
1171 ;;;###autoload
1172 (defun epa-import-armor-in-region (start end)
1173 "Import keys in the OpenPGP armor format in the current region
1174 between START and END."
1175 (interactive "r")
1176 (save-excursion
1177 (save-restriction
1178 (narrow-to-region start end)
1179 (goto-char start)
1180 (let (armor-start armor-end)
1181 (while (re-search-forward
1182 "-----BEGIN \\(PGP \\(PUBLIC\\|PRIVATE\\) KEY BLOCK\\)-----$"
1183 nil t)
1184 (setq armor-start (match-beginning 0)
1185 armor-end (re-search-forward
1186 (concat "^-----END " (match-string 1) "-----$")
1187 nil t))
1188 (unless armor-end
1189 (error "No armor tail"))
1190 (epa-import-keys-region armor-start armor-end))))))
1192 ;;;###autoload
1193 (defun epa-export-keys (keys file)
1194 "Export selected KEYS to FILE."
1195 (interactive
1196 (let ((keys (epa--marked-keys))
1197 default-name)
1198 (unless keys
1199 (error "No keys selected"))
1200 (setq default-name
1201 (expand-file-name
1202 (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
1203 (if epa-armor ".asc" ".gpg"))
1204 default-directory))
1205 (list keys
1206 (expand-file-name
1207 (read-file-name
1208 (concat "To file (default "
1209 (file-name-nondirectory default-name)
1210 ") ")
1211 (file-name-directory default-name)
1212 default-name)))))
1213 (let ((context (epg-make-context epa-protocol)))
1214 (epg-context-set-armor context epa-armor)
1215 (message "Exporting to %s..." (file-name-nondirectory file))
1216 (epg-export-keys-to-file context keys file)
1217 (message "Exporting to %s...done" (file-name-nondirectory file))))
1219 ;;;###autoload
1220 (defun epa-insert-keys (keys)
1221 "Insert selected KEYS after the point."
1222 (interactive
1223 (list (epa-select-keys (epg-make-context epa-protocol)
1224 "Select keys to export. ")))
1225 (let ((context (epg-make-context epa-protocol)))
1226 ;;(epg-context-set-armor context epa-armor)
1227 (epg-context-set-armor context t)
1228 (insert (epg-export-keys-to-string context keys))))
1230 ;; (defun epa-sign-keys (keys &optional local)
1231 ;; "Sign selected KEYS.
1232 ;; If a prefix-arg is specified, the signature is marked as non exportable.
1234 ;; Don't use this command in Lisp programs!"
1235 ;; (interactive
1236 ;; (let ((keys (epa--marked-keys)))
1237 ;; (unless keys
1238 ;; (error "No keys selected"))
1239 ;; (list keys current-prefix-arg)))
1240 ;; (let ((context (epg-make-context epa-protocol)))
1241 ;; (epg-context-set-passphrase-callback context
1242 ;; #'epa-passphrase-callback-function)
1243 ;; (epg-context-set-progress-callback context
1244 ;; (cons
1245 ;; #'epa-progress-callback-function
1246 ;; "Signing keys..."))
1247 ;; (message "Signing keys...")
1248 ;; (epg-sign-keys context keys local)
1249 ;; (message "Signing keys...done")))
1250 ;; (make-obsolete 'epa-sign-keys "Do not use.")
1252 (provide 'epa)
1254 ;; arch-tag: 38d20ced-20d5-4137-b17a-f206335423d7
1255 ;;; epa.el ends here