1 ;;; epa.el --- the EasyPG Assistant
2 ;; Copyright (C) 2006, 2007, 2008 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/>.
27 (eval-when-compile (require 'wid-edit
))
31 "The EasyPG Assistant"
35 (defcustom epa-popup-info-window t
36 "If non-nil, status information from epa commands is displayed on
41 (defcustom epa-info-window-height
5
42 "Number of lines used to display status information."
46 (defgroup epa-faces nil
51 (defface epa-validity-high
52 `((((class color
) (background dark
))
53 (:foreground
"PaleTurquoise"
54 ,@(if (assq ':weight custom-face-attributes
)
58 (,@(if (assq ':weight custom-face-attributes
)
61 "Face used for displaying the high validity."
64 (defface epa-validity-medium
65 `((((class color
) (background dark
))
66 (:foreground
"PaleTurquoise"
67 ,@(if (assq ':slant custom-face-attributes
)
71 (,@(if (assq ':slant custom-face-attributes
)
74 "Face used for displaying the medium validity."
77 (defface epa-validity-low
79 (,@(if (assq ':slant custom-face-attributes
)
82 "Face used for displaying the low validity."
85 (defface epa-validity-disabled
87 (,@(if (assq ':slant custom-face-attributes
)
91 "Face used for displaying the disabled validity."
95 '((((class color
) (background dark
))
96 (:foreground
"lightyellow"))
97 (((class color
) (background light
))
98 (:foreground
"blue4")))
99 "Face used for displaying the string."
103 `((((class color
) (background dark
))
104 (:foreground
"orange"
105 ,@(if (assq ':weight custom-face-attributes
)
108 (((class color
) (background light
))
110 ,@(if (assq ':weight custom-face-attributes
)
114 (,@(if (assq ':weight custom-face-attributes
)
117 "Face used for displaying the high validity."
120 (defface epa-field-name
121 `((((class color
) (background dark
))
122 (:foreground
"PaleTurquoise"
123 ,@(if (assq ':weight custom-face-attributes
)
127 (,@(if (assq ':weight custom-face-attributes
)
130 "Face for the name of the attribute field."
133 (defface epa-field-body
134 `((((class color
) (background dark
))
135 (:foreground
"turquoise"
136 ,@(if (assq ':slant custom-face-attributes
)
140 (,@(if (assq ':slant custom-face-attributes
)
143 "Face for the body of the attribute field."
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
))
162 (defvar epa-font-lock-keywords
165 ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
167 (2 'epa-field-body
)))
168 "Default expressions to addon in epa-mode.")
170 (defconst epa-pubkey-algorithm-letter-alist
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
)
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
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"))
251 (defvar epa-key-mode-map
252 (let ((keymap (make-sparse-keymap)))
253 (define-key keymap "q" 'epa-exit-buffer)
256 (defvar epa-info-mode-map
257 (let ((keymap (make-sparse-keymap)))
258 (define-key keymap "q" 'delete-window)
261 (defvar epa-exit-buffer-function #'bury-buffer)
263 (define-widget 'epa-key 'push-button
264 "Button for representing a epg-key object."
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))
284 (epg-sub-key-id primary-sub-key)
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)))
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))))))
296 (cdr (assq validity epa-validity-face-alist))
299 (defun epa--key-widget-help-echo (widget)
301 (epg-sub-key-id (car (epg-key-sub-key-list
302 (widget-get widget :value))))))
305 (if (fboundp 'encode-coding-string)
306 (defalias 'epa--encode-coding-string 'encode-coding-string)
307 (defalias 'epa--encode-coding-string 'identity)))
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
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
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
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."
365 (let ((inhibit-read-only t)
369 (unless (get-text-property (point) 'epa-key)
370 (error "No key on this line"))
371 (setq properties (text-properties-at (point)))
373 (insert (if arg " " "*"))
374 (set-text-properties (1- (point)) (point) properties)
377 (defun epa-unmark-key (&optional arg)
378 "Unmark a key on the current line.
379 If ARG is non-nil, mark the key."
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."
387 (funcall epa-exit-buffer-function))
389 (defun epa--insert-keys (keys)
392 (narrow-to-region (point) (point))
397 (add-text-properties point (point)
398 (list 'epa-key (car keys)
403 (widget-create 'epa-key :value (car keys))
405 (setq keys (cdr keys))))
406 (add-text-properties (point-min) (point-max)
407 (list 'epa-list-keys 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)
419 (let ((inhibit-read-only t)
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)))
427 (or (next-single-property-change point 'epa-list-keys)
430 (epa--insert-keys (epg-list-keys context name secret))
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)))
439 (defun epa-list-keys (&optional name)
440 "List all keys matched with NAME from the public keyring."
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)))
448 (epa--list-keys name nil))
451 (defun epa-list-secret-keys (&optional name)
452 "List all keys matched with NAME from the private keyring."
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)))
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 ()
467 (set-buffer epa-keys-buffer)
468 (goto-char (point-min))
470 (while (re-search-forward "^\\*" nil t)
471 (if (setq key (get-text-property (match-beginning 0)
473 (setq keys (cons key keys))))
477 (let ((key (get-text-property (point) 'epa-key)))
481 (defun epa--select-keys (prompt keys)
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)
488 (let ((inhibit-read-only t)
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"))
496 :notify (lambda (&rest ignore) (abort-recursive-edit))
498 (substitute-command-keys
499 "Click here or \\[abort-recursive-edit] to cancel")
502 :notify (lambda (&rest ignore) (exit-recursive-edit))
504 (substitute-command-keys
505 "Click here or \\[exit-recursive-edit] to finish")
508 (epa--insert-keys keys)
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)))
518 (if (get-buffer-window epa-keys-buffer)
519 (delete-window (get-buffer-window epa-keys-buffer)))
520 (kill-buffer epa-keys-buffer))))
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
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)
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))
549 (make-local-variable 'epa-key)
552 (setq pointer (epg-key-user-id-list key))
556 (if (epg-user-id-validity (car pointer))
558 (car (rassq (epg-user-id-validity (car pointer))
559 epg-key-validity-alist)))
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))))
566 (setq pointer (cdr pointer)))
567 (setq pointer (epg-key-sub-key-list key))
570 (if (epg-sub-key-validity (car pointer))
572 (car (rassq (epg-sub-key-validity (car pointer))
573 epg-key-validity-alist)))
576 (epg-sub-key-id (car pointer))
579 (epg-sub-key-length (car pointer)))
581 (cdr (assq (epg-sub-key-algorithm (car pointer))
582 epg-pubkey-algorithm-alist))
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 "\n\tExpires: %s"
591 (format-time-string "%Y-%m-%d"
592 (epg-sub-key-expiration-time
594 (error "????-??-??")))
597 (mapconcat #'symbol-name
598 (epg-sub-key-capability (car pointer))
601 (epg-sub-key-fingerprint (car pointer))
603 (setq pointer (cdr pointer)))
604 (goto-char (point-min))
605 (pop-to-buffer (current-buffer))))
607 (defun epa-display-info (info)
608 (if epa-popup-info-window
609 (save-selected-window
610 (unless (and epa-info-buffer (buffer-live-p epa-info-buffer))
611 (setq epa-info-buffer (generate-new-buffer "*Info*")))
612 (if (get-buffer-window epa-info-buffer)
613 (delete-window (get-buffer-window epa-info-buffer)))
615 (set-buffer epa-info-buffer)
616 (let ((inhibit-read-only t)
621 (goto-char (point-min)))
622 (if (> (window-height)
623 epa-info-window-height)
624 (set-window-buffer (split-window nil (- (window-height)
625 epa-info-window-height))
627 (pop-to-buffer epa-info-buffer)
628 (if (> (window-height) epa-info-window-height)
629 (shrink-window (- (window-height) epa-info-window-height)))))
630 (message "%s" info)))
632 (defun epa-display-verify-result (verify-result)
633 (epa-display-info (epg-verify-result-to-string verify-result)))
634 (make-obsolete 'epa-display-verify-result 'epa-display-info)
636 (defun epa-passphrase-callback-function (context key-id handback)
638 (read-passwd "Passphrase for symmetric encryption: "
639 (eq (epg-context-operation context) 'encrypt))
642 "Passphrase for PIN: "
643 (let ((entry (assoc key-id epg-user-id-alist)))
645 (format "Passphrase for %s %s: " key-id (cdr entry))
646 (format "Passphrase for %s: " key-id)))))))
648 (defun epa-progress-callback-function (context what char current total
650 (message "%s%d%% (%d/%d)" (or handback
652 (if (> total 0) (floor (* (/ current (float total)) 100)) 0)
656 (defun epa-decrypt-file (file)
658 (interactive "fFile: ")
659 (setq file (expand-file-name file))
660 (let* ((default-name (file-name-sans-extension file))
661 (plain (expand-file-name
663 (concat "To file (default "
664 (file-name-nondirectory default-name)
666 (file-name-directory default-name)
668 (context (epg-make-context epa-protocol)))
669 (epg-context-set-passphrase-callback context
670 #'epa-passphrase-callback-function)
671 (epg-context-set-progress-callback context
673 #'epa-progress-callback-function
674 (format "Decrypting %s..."
675 (file-name-nondirectory file))))
676 (message "Decrypting %s..." (file-name-nondirectory file))
677 (epg-decrypt-file context file plain)
678 (message "Decrypting %s...wrote %s" (file-name-nondirectory file)
679 (file-name-nondirectory plain))
680 (if (epg-context-result-for context 'verify)
681 (epa-display-info (epg-verify-result-to-string
682 (epg-context-result-for context 'verify))))))
685 (defun epa-verify-file (file)
687 (interactive "fFile: ")
688 (setq file (expand-file-name file))
689 (let* ((context (epg-make-context epa-protocol))
690 (plain (if (equal (file-name-extension file) "sig")
691 (file-name-sans-extension file))))
692 (epg-context-set-progress-callback context
694 #'epa-progress-callback-function
695 (format "Verifying %s..."
696 (file-name-nondirectory file))))
697 (message "Verifying %s..." (file-name-nondirectory file))
698 (epg-verify-file context file plain)
699 (message "Verifying %s...done" (file-name-nondirectory file))
700 (if (epg-context-result-for context 'verify)
701 (epa-display-info (epg-verify-result-to-string
702 (epg-context-result-for context 'verify))))))
704 (defun epa--read-signature-type ()
707 (message "Signature type (n,c,d,?) ")
712 (setq type 'detached))
714 (with-output-to-temp-buffer "*Help*"
716 (set-buffer standard-output)
718 n - Create a normal signature
719 c - Create a cleartext signature
720 d - Create a detached signature
724 (setq type 'normal))))))
727 (defun epa-sign-file (file signers mode)
728 "Sign FILE by SIGNERS keys selected."
730 (let ((verbose current-prefix-arg))
731 (list (expand-file-name (read-file-name "File: "))
733 (epa-select-keys (epg-make-context epa-protocol)
734 "Select keys for signing.
735 If no one is selected, default secret key is used. "
738 (epa--read-signature-type)
740 (let ((signature (concat file
741 (if (eq epa-protocol 'OpenPGP)
744 '(nil t normal detached))))
746 (if (memq mode '(t detached))
749 (if (memq mode '(t detached))
752 (context (epg-make-context epa-protocol)))
753 (epg-context-set-armor context epa-armor)
754 (epg-context-set-textmode context epa-textmode)
755 (epg-context-set-signers context signers)
756 (epg-context-set-passphrase-callback context
757 #'epa-passphrase-callback-function)
758 (epg-context-set-progress-callback context
760 #'epa-progress-callback-function
761 (format "Signing %s..."
762 (file-name-nondirectory file))))
763 (message "Signing %s..." (file-name-nondirectory file))
764 (epg-sign-file context file signature mode)
765 (message "Signing %s...wrote %s" (file-name-nondirectory file)
766 (file-name-nondirectory signature))))
769 (defun epa-encrypt-file (file recipients)
770 "Encrypt FILE for RECIPIENTS."
772 (list (expand-file-name (read-file-name "File: "))
773 (epa-select-keys (epg-make-context epa-protocol)
774 "Select recipients for encryption.
775 If no one is selected, symmetric encryption will be performed. ")))
776 (let ((cipher (concat file (if (eq epa-protocol 'OpenPGP)
777 (if epa-armor ".asc" ".gpg")
779 (context (epg-make-context epa-protocol)))
780 (epg-context-set-armor context epa-armor)
781 (epg-context-set-textmode context epa-textmode)
782 (epg-context-set-passphrase-callback context
783 #'epa-passphrase-callback-function)
784 (epg-context-set-progress-callback context
786 #'epa-progress-callback-function
787 (format "Encrypting %s..."
788 (file-name-nondirectory file))))
789 (message "Encrypting %s..." (file-name-nondirectory file))
790 (epg-encrypt-file context file recipients cipher)
791 (message "Encrypting %s...wrote %s" (file-name-nondirectory file)
792 (file-name-nondirectory cipher))))
795 (defun epa-decrypt-region (start end)
796 "Decrypt the current region between START and END.
798 Don't use this command in Lisp programs!
799 Since this function operates on regions, it does some tricks such
800 as coding-system detection and unibyte/multibyte conversion. If
801 you are sure how the data in the region should be treated, you
802 should consider using the string based counterpart
803 `epg-decrypt-string', or the file based counterpart
804 `epg-decrypt-file' instead.
808 \(let ((context (epg-make-context 'OpenPGP)))
809 (decode-coding-string
810 (epg-decrypt-string context (buffer-substring start end))
814 (let ((context (epg-make-context epa-protocol))
816 (epg-context-set-passphrase-callback context
817 #'epa-passphrase-callback-function)
818 (epg-context-set-progress-callback context
820 #'epa-progress-callback-function
822 (message "Decrypting...")
823 (setq plain (epg-decrypt-string context (buffer-substring start end)))
824 (message "Decrypting...done")
825 (setq plain (epa--decode-coding-string
827 (or coding-system-for-read
828 (get-text-property start 'epa-coding-system-used))))
829 (if (y-or-n-p "Replace the original text? ")
830 (let ((inhibit-read-only t)
832 (delete-region start end)
835 (with-output-to-temp-buffer "*Temp*"
836 (set-buffer standard-output)
839 (if (epg-context-result-for context 'verify)
840 (epa-display-info (epg-verify-result-to-string
841 (epg-context-result-for context 'verify)))))))
843 (defun epa--find-coding-system-for-mime-charset (mime-charset)
844 (if (featurep 'xemacs)
845 (if (fboundp 'find-coding-system)
846 (find-coding-system mime-charset))
847 (let ((pointer (coding-system-list)))
849 (eq (coding-system-get (car pointer) 'mime-charset)
851 (setq pointer (cdr pointer)))
855 (defun epa-decrypt-armor-in-region (start end)
856 "Decrypt OpenPGP armors in the current region between START and END.
858 Don't use this command in Lisp programs!
859 See the reason described in the `epa-decrypt-region' documentation."
863 (narrow-to-region start end)
865 (let (armor-start armor-end)
866 (while (re-search-forward "-----BEGIN PGP MESSAGE-----$" nil t)
867 (setq armor-start (match-beginning 0)
868 armor-end (re-search-forward "^-----END PGP MESSAGE-----$"
871 (error "No armor tail"))
872 (goto-char armor-start)
873 (let ((coding-system-for-read
874 (or coding-system-for-read
875 (if (re-search-forward "^Charset: \\(.*\\)" armor-end t)
876 (epa--find-coding-system-for-mime-charset
877 (intern (downcase (match-string 1))))))))
878 (goto-char armor-end)
879 (epa-decrypt-region armor-start armor-end)))))))
882 (defun epa-verify-region (start end)
883 "Verify the current region between START and END.
885 Don't use this command in Lisp programs!
886 Since this function operates on regions, it does some tricks such
887 as coding-system detection and unibyte/multibyte conversion. If
888 you are sure how the data in the region should be treated, you
889 should consider using the string based counterpart
890 `epg-verify-string', or the file based counterpart
891 `epg-verify-file' instead.
895 \(let ((context (epg-make-context 'OpenPGP)))
896 (decode-coding-string
897 (epg-verify-string context (buffer-substring start end))
900 (let ((context (epg-make-context epa-protocol))
902 (epg-context-set-progress-callback context
904 #'epa-progress-callback-function
906 (message "Verifying...")
907 (setq plain (epg-verify-string
909 (epa--encode-coding-string
910 (buffer-substring start end)
911 (or coding-system-for-write
912 (get-text-property start 'epa-coding-system-used)))))
913 (message "Verifying...done")
914 (setq plain (epa--decode-coding-string
916 (or coding-system-for-read
917 (get-text-property start 'epa-coding-system-used))))
918 (if (y-or-n-p "Replace the original text? ")
919 (let ((inhibit-read-only t)
921 (delete-region start end)
924 (with-output-to-temp-buffer "*Temp*"
925 (set-buffer standard-output)
928 (if (epg-context-result-for context 'verify)
929 (epa-display-info (epg-verify-result-to-string
930 (epg-context-result-for context 'verify))))))
933 (defun epa-verify-cleartext-in-region (start end)
934 "Verify OpenPGP cleartext signed messages in the current region
935 between START and END.
937 Don't use this command in Lisp programs!
938 See the reason described in the `epa-verify-region' documentation."
942 (narrow-to-region start end)
944 (let (cleartext-start cleartext-end)
945 (while (re-search-forward "-----BEGIN PGP SIGNED MESSAGE-----$"
947 (setq cleartext-start (match-beginning 0))
948 (unless (re-search-forward "^-----BEGIN PGP SIGNATURE-----$"
950 (error "Invalid cleartext signed message"))
951 (setq cleartext-end (re-search-forward
952 "^-----END PGP SIGNATURE-----$"
954 (unless cleartext-end
955 (error "No cleartext tail"))
956 (epa-verify-region cleartext-start cleartext-end))))))
959 (if (fboundp 'select-safe-coding-system)
960 (defalias 'epa--select-safe-coding-system 'select-safe-coding-system)
961 (defun epa--select-safe-coding-system (from to)
962 buffer-file-coding-system)))
965 (defun epa-sign-region (start end signers mode)
966 "Sign the current region between START and END by SIGNERS keys selected.
968 Don't use this command in Lisp programs!
969 Since this function operates on regions, it does some tricks such
970 as coding-system detection and unibyte/multibyte conversion. If
971 you are sure how the data should be treated, you should consider
972 using the string based counterpart `epg-sign-string', or the file
973 based counterpart `epg-sign-file' instead.
977 \(let ((context (epg-make-context 'OpenPGP)))
980 (encode-coding-string (buffer-substring start end) 'utf-8)))"
982 (let ((verbose current-prefix-arg))
983 (setq epa-last-coding-system-specified
984 (or coding-system-for-write
985 (epa--select-safe-coding-system
986 (region-beginning) (region-end))))
987 (list (region-beginning) (region-end)
989 (epa-select-keys (epg-make-context epa-protocol)
990 "Select keys for signing.
991 If no one is selected, default secret key is used. "
994 (epa--read-signature-type)
997 (let ((context (epg-make-context epa-protocol))
999 ;;(epg-context-set-armor context epa-armor)
1000 (epg-context-set-armor context t)
1001 ;;(epg-context-set-textmode context epa-textmode)
1002 (epg-context-set-textmode context t)
1003 (epg-context-set-signers context signers)
1004 (epg-context-set-passphrase-callback context
1005 #'epa-passphrase-callback-function)
1006 (epg-context-set-progress-callback context
1008 #'epa-progress-callback-function
1010 (message "Signing...")
1011 (setq signature (epg-sign-string context
1012 (epa--encode-coding-string
1013 (buffer-substring start end)
1014 epa-last-coding-system-specified)
1016 (message "Signing...done")
1017 (delete-region start end)
1019 (add-text-properties (point)
1021 (insert (epa--decode-coding-string
1023 (or coding-system-for-read
1024 epa-last-coding-system-specified)))
1026 (list 'epa-coding-system-used
1027 epa-last-coding-system-specified
1034 (if (fboundp 'derived-mode-p)
1035 (defalias 'epa--derived-mode-p 'derived-mode-p)
1036 (defun epa--derived-mode-p (&rest modes)
1037 "Non-nil if the current major mode is derived from one of MODES.
1038 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1039 (let ((parent major-mode))
1040 (while (and (not (memq parent modes))
1041 (setq parent (get parent 'derived-mode-parent))))
1045 (defun epa-encrypt-region (start end recipients sign signers)
1046 "Encrypt the current region between START and END for RECIPIENTS.
1048 Don't use this command in Lisp programs!
1049 Since this function operates on regions, it does some tricks such
1050 as coding-system detection and unibyte/multibyte conversion. If
1051 you are sure how the data should be treated, you should consider
1052 using the string based counterpart `epg-encrypt-string', or the
1053 file based counterpart `epg-encrypt-file' instead.
1057 \(let ((context (epg-make-context 'OpenPGP)))
1060 (encode-coding-string (buffer-substring start end) 'utf-8)
1063 (let ((verbose current-prefix-arg)
1064 (context (epg-make-context epa-protocol))
1066 (setq epa-last-coding-system-specified
1067 (or coding-system-for-write
1068 (epa--select-safe-coding-system
1069 (region-beginning) (region-end))))
1070 (list (region-beginning) (region-end)
1071 (epa-select-keys context
1072 "Select recipients for encryption.
1073 If no one is selected, symmetric encryption will be performed. ")
1074 (setq sign (if verbose (y-or-n-p "Sign? ")))
1076 (epa-select-keys context
1077 "Select keys for signing. ")))))
1079 (let ((context (epg-make-context epa-protocol))
1081 ;;(epg-context-set-armor context epa-armor)
1082 (epg-context-set-armor context t)
1083 ;;(epg-context-set-textmode context epa-textmode)
1084 (epg-context-set-textmode context t)
1086 (epg-context-set-signers context signers))
1087 (epg-context-set-passphrase-callback context
1088 #'epa-passphrase-callback-function)
1089 (epg-context-set-progress-callback context
1091 #'epa-progress-callback-function
1093 (message "Encrypting...")
1094 (setq cipher (epg-encrypt-string context
1095 (epa--encode-coding-string
1096 (buffer-substring start end)
1097 epa-last-coding-system-specified)
1100 (message "Encrypting...done")
1101 (delete-region start end)
1103 (add-text-properties (point)
1107 (list 'epa-coding-system-used
1108 epa-last-coding-system-specified
1115 (defun epa-delete-keys (keys &optional allow-secret)
1116 "Delete selected KEYS."
1118 (let ((keys (epa--marked-keys)))
1120 (error "No keys selected"))
1122 (eq (nth 1 epa-list-keys-arguments) t))))
1123 (let ((context (epg-make-context epa-protocol)))
1124 (message "Deleting...")
1125 (epg-delete-keys context keys allow-secret)
1126 (message "Deleting...done")
1127 (apply #'epa--list-keys epa-list-keys-arguments)))
1130 (defun epa-import-keys (file)
1131 "Import keys from FILE."
1132 (interactive "fFile: ")
1133 (setq file (expand-file-name file))
1134 (let ((context (epg-make-context epa-protocol)))
1135 (message "Importing %s..." (file-name-nondirectory file))
1138 (epg-import-keys-from-file context file)
1139 (message "Importing %s...done" (file-name-nondirectory file)))
1141 (message "Importing %s...failed" (file-name-nondirectory file))))
1142 (if (epg-context-result-for context 'import)
1143 (epa-display-info (epg-import-result-to-string
1144 (epg-context-result-for context 'import))))
1145 (if (eq major-mode 'epa-key-list-mode)
1146 (apply #'epa--list-keys epa-list-keys-arguments))))
1149 (defun epa-import-keys-region (start end)
1150 "Import keys from the region."
1152 (let ((context (epg-make-context epa-protocol)))
1153 (message "Importing...")
1156 (epg-import-keys-from-string context (buffer-substring start end))
1157 (message "Importing...done"))
1159 (message "Importing...failed")))
1160 (if (epg-context-result-for context 'import)
1161 (epa-display-info (epg-import-result-to-string
1162 (epg-context-result-for context 'import))))))
1165 (defun epa-import-armor-in-region (start end)
1166 "Import keys in the OpenPGP armor format in the current region
1167 between START and END."
1171 (narrow-to-region start end)
1173 (let (armor-start armor-end)
1174 (while (re-search-forward
1175 "-----BEGIN \\(PGP \\(PUBLIC\\|PRIVATE\\) KEY BLOCK\\)-----$"
1177 (setq armor-start (match-beginning 0)
1178 armor-end (re-search-forward
1179 (concat "^-----END " (match-string 1) "-----$")
1182 (error "No armor tail"))
1183 (epa-import-keys-region armor-start armor-end))))))
1186 (defun epa-export-keys (keys file)
1187 "Export selected KEYS to FILE."
1189 (let ((keys (epa--marked-keys))
1192 (error "No keys selected"))
1195 (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
1196 (if epa-armor ".asc" ".gpg"))
1201 (concat "To file (default "
1202 (file-name-nondirectory default-name)
1204 (file-name-directory default-name)
1206 (let ((context (epg-make-context epa-protocol)))
1207 (epg-context-set-armor context epa-armor)
1208 (message "Exporting to %s..." (file-name-nondirectory file))
1209 (epg-export-keys-to-file context keys file)
1210 (message "Exporting to %s...done" (file-name-nondirectory file))))
1213 (defun epa-insert-keys (keys)
1214 "Insert selected KEYS after the point."
1216 (list (epa-select-keys (epg-make-context epa-protocol)
1217 "Select keys to export. ")))
1218 (let ((context (epg-make-context epa-protocol)))
1219 ;;(epg-context-set-armor context epa-armor)
1220 (epg-context-set-armor context t)
1221 (insert (epg-export-keys-to-string context keys))))
1223 ;; (defun epa-sign-keys (keys &optional local)
1224 ;; "Sign selected KEYS.
1225 ;; If a prefix-arg is specified, the signature is marked as non exportable.
1227 ;; Don't use this command in Lisp programs!"
1229 ;; (let ((keys (epa--marked-keys)))
1231 ;; (error "No keys selected"))
1232 ;; (list keys current-prefix-arg)))
1233 ;; (let ((context (epg-make-context epa-protocol)))
1234 ;; (epg-context-set-passphrase-callback context
1235 ;; #'epa-passphrase-callback-function)
1236 ;; (epg-context-set-progress-callback context
1238 ;; #'epa-progress-callback-function
1239 ;; "Signing keys..."))
1240 ;; (message "Signing keys...")
1241 ;; (epg-sign-keys context keys local)
1242 ;; (message "Signing keys...done")))
1243 ;; (make-obsolete 'epa-sign-keys "Do not use.")
1247 ;; arch-tag: 38d20ced-20d5-4137-b17a-f206335423d7
1248 ;;; epa.el ends here