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))
34 "The EasyPG Assistant"
37 (defcustom epa-protocol 'OpenPGP
38 "The default protocol."
39 :type '(choice (const :tag "OpenPGP" OpenPGP)
40 (const :tag "CMS" CMS))
43 (defcustom epa-armor nil
44 "If non-nil, epa commands create ASCII armored output."
48 (defcustom epa-textmode nil
49 "If non-nil, epa commands treat input files as text."
53 (defcustom epa-popup-info-window t
54 "If non-nil, status information from epa commands is displayed on
59 (defcustom epa-info-window-height 5
60 "Number of lines used to display status information."
64 (defcustom epa-mail-modes '(mail-mode message-mode)
65 "List of major-modes to compose mails."
69 (defgroup epa-faces nil
73 (defface epa-validity-high-face
74 '((((class color) (background dark))
75 (:foreground "PaleTurquoise" :bold t))
78 "Face used for displaying the high validity."
80 (defvar epa-validity-high-face 'epa-validity-high-face)
82 (defface epa-validity-medium-face
83 '((((class color) (background dark))
84 (:foreground "PaleTurquoise" :italic t))
87 "Face used for displaying the medium validity."
89 (defvar epa-validity-medium-face 'epa-validity-medium-face)
91 (defface epa-validity-low-face
94 "Face used for displaying the low validity."
96 (defvar epa-validity-low-face 'epa-validity-low-face)
98 (defface epa-validity-disabled-face
100 (:italic t :inverse-video t)))
101 "Face used for displaying the disabled validity."
103 (defvar epa-validity-disabled-face 'epa-validity-disabled-face)
105 (defface epa-string-face
108 (:foreground "lightyellow"))
111 (:foreground "blue4"))
114 "Face used for displaying the string."
116 (defvar epa-string-face 'epa-string-face)
118 (defface epa-mark-face
119 '((((class color) (background dark))
120 (:foreground "orange" :bold t))
122 (:foreground "red" :bold t)))
123 "Face used for displaying the high validity."
125 (defvar epa-mark-face 'epa-mark-face)
127 (defface epa-field-name-face
128 '((((class color) (background dark))
129 (:foreground "PaleTurquoise" :bold t))
131 "Face for the name of the attribute field."
133 (defvar epa-field-name-face 'epa-field-name-face)
135 (defface epa-field-body-face
136 '((((class color) (background dark))
137 (:foreground "turquoise" :italic t))
139 "Face for the body of the attribute field."
141 (defvar epa-field-body-face 'epa-field-body-face)
143 (defcustom epa-validity-face-alist
144 '((unknown . epa-validity-disabled-face)
145 (invalid . epa-validity-disabled-face)
146 (disabled . epa-validity-disabled-face)
147 (revoked . epa-validity-disabled-face)
148 (expired . epa-validity-disabled-face)
149 (none . epa-validity-low-face)
150 (undefined . epa-validity-low-face)
151 (never . epa-validity-low-face)
152 (marginal . epa-validity-medium-face)
153 (full . epa-validity-high-face)
154 (ultimate . epa-validity-high-face))
155 "An alist mapping validity values to faces."
159 (defcustom epa-font-lock-keywords
162 ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
163 (1 epa-field-name-face)
164 (2 epa-field-body-face)))
165 "Default expressions to addon in epa-mode."
166 :type '(repeat (list string))
169 (defconst epa-pubkey-algorithm-letter-alist
177 (defvar epa-keys-buffer nil)
178 (defvar epa-key-buffer-alist nil)
180 (defvar epa-list-keys-arguments nil)
181 (defvar epa-info-buffer nil)
182 (defvar epa-last-coding-system-specified nil)
184 (defvar epa-keys-mode-map
185 (let ((keymap (make-sparse-keymap)))
186 (define-key keymap "m" 'epa-mark)
187 (define-key keymap "u" 'epa-unmark)
188 (define-key keymap "d" 'epa-decrypt-file)
189 (define-key keymap "v" 'epa-verify-file)
190 (define-key keymap "s" 'epa-sign-file)
191 (define-key keymap "e" 'epa-encrypt-file)
192 (define-key keymap "r" 'epa-delete-keys)
193 (define-key keymap "i" 'epa-import-keys)
194 (define-key keymap "o" 'epa-export-keys)
195 (define-key keymap "g" 'epa-list-keys)
196 (define-key keymap "n" 'next-line)
197 (define-key keymap "p" 'previous-line)
198 (define-key keymap " " 'scroll-up)
199 (define-key keymap [delete] 'scroll-down)
200 (define-key keymap "q" 'epa-exit-buffer)
203 (defvar epa-key-mode-map
204 (let ((keymap (make-sparse-keymap)))
205 (define-key keymap "q" 'bury-buffer)
208 (defvar epa-info-mode-map
209 (let ((keymap (make-sparse-keymap)))
210 (define-key keymap "q" 'delete-window)
213 (defvar epa-exit-buffer-function #'bury-buffer)
215 (define-widget 'epa-key 'push-button
216 "Button for representing a epg-key object."
218 :button-face-get 'epa--key-widget-button-face-get
219 :value-create 'epa--key-widget-value-create
220 :action 'epa--key-widget-action
221 :help-echo 'epa--key-widget-help-echo)
223 (defun epa--key-widget-action (widget &optional event)
224 (epa--show-key (widget-get widget :value)))
226 (defun epa--key-widget-value-create (widget)
227 (let* ((key (widget-get widget :value))
228 (primary-sub-key (car (epg-key-sub-key-list key)))
229 (primary-user-id (car (epg-key-user-id-list key))))
230 (insert (format "%c "
231 (if (epg-sub-key-validity primary-sub-key)
232 (car (rassq (epg-sub-key-validity primary-sub-key)
233 epg-key-validity-alist))
235 (epg-sub-key-id primary-sub-key)
238 (if (stringp (epg-user-id-string primary-user-id))
239 (epg-user-id-string primary-user-id)
240 (epg-decode-dn (epg-user-id-string primary-user-id)))
243 (defun epa--key-widget-button-face-get (widget)
244 (let ((validity (epg-sub-key-validity (car (epg-key-sub-key-list
245 (widget-get widget :value))))))
247 (cdr (assq validity epa-validity-face-alist))
250 (defun epa--key-widget-help-echo (widget)
252 (epg-sub-key-id (car (epg-key-sub-key-list
253 (widget-get widget :value))))))
255 (if (fboundp 'encode-coding-string)
256 (defalias 'epa--encode-coding-string 'encode-coding-string)
257 (defalias 'epa--encode-coding-string 'identity))
259 (if (fboundp 'decode-coding-string)
260 (defalias 'epa--decode-coding-string 'decode-coding-string)
261 (defalias 'epa--decode-coding-string 'identity))
263 (defun epa-keys-mode ()
264 "Major mode for `epa-list-keys'."
265 (kill-all-local-variables)
266 (buffer-disable-undo)
267 (setq major-mode 'epa-keys-mode
271 (use-local-map epa-keys-mode-map)
272 (make-local-variable 'font-lock-defaults)
273 (setq font-lock-defaults '(epa-font-lock-keywords t))
274 ;; In XEmacs, auto-initialization of font-lock is not effective
275 ;; if buffer-file-name is not set.
276 (font-lock-set-defaults)
277 (make-local-variable 'epa-exit-buffer-function)
278 (run-hooks 'epa-keys-mode-hook))
280 (defun epa-key-mode ()
281 "Major mode for a key description."
282 (kill-all-local-variables)
283 (buffer-disable-undo)
284 (setq major-mode 'epa-key-mode
288 (use-local-map epa-key-mode-map)
289 (make-local-variable 'font-lock-defaults)
290 (setq font-lock-defaults '(epa-font-lock-keywords t))
291 ;; In XEmacs, auto-initialization of font-lock is not effective
292 ;; if buffer-file-name is not set.
293 (font-lock-set-defaults)
294 (make-local-variable 'epa-exit-buffer-function)
295 (run-hooks 'epa-key-mode-hook))
297 (defun epa-info-mode ()
298 "Major mode for `epa-info-buffer'."
299 (kill-all-local-variables)
300 (buffer-disable-undo)
301 (setq major-mode 'epa-info-mode
305 (use-local-map epa-info-mode-map)
306 (run-hooks 'epa-info-mode-hook))
308 (defun epa-mark (&optional arg)
309 "Mark the current line.
310 If ARG is non-nil, unmark the current line."
312 (let ((inhibit-read-only t)
316 (setq properties (text-properties-at (point)))
318 (insert (if arg " " "*"))
319 (set-text-properties (1- (point)) (point) properties)
322 (defun epa-unmark (&optional arg)
323 "Unmark the current line.
324 If ARG is non-nil, mark the current line."
326 (epa-mark (not arg)))
328 (defun epa-toggle-mark ()
329 "Toggle the mark the current line."
331 (epa-mark (eq (char-after (save-excursion (beginning-of-line) (point))) ?*)))
333 (defun epa-exit-buffer ()
334 "Exit the current buffer.
335 `epa-exit-buffer-function' is called if it is set."
337 (funcall epa-exit-buffer-function))
340 (defun epa-list-keys (&optional name mode)
341 "List all keys matched with NAME from the keyring.
342 If MODE is non-nil, it reads the private keyring. Otherwise, it
343 reads the public keyring."
345 (if current-prefix-arg
346 (let ((name (read-string "Pattern: "
347 (if epa-list-keys-arguments
348 (car epa-list-keys-arguments)))))
349 (list (if (equal name "") nil name)
350 (y-or-n-p "Secret keys? ")))
351 (or epa-list-keys-arguments (list nil nil))))
352 (unless (and epa-keys-buffer
353 (buffer-live-p epa-keys-buffer))
354 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
355 (set-buffer epa-keys-buffer)
356 (let ((inhibit-read-only t)
359 (context (epg-make-context epa-protocol)))
360 (unless (get-text-property point 'epa-list-keys)
361 (setq point (next-single-property-change point 'epa-list-keys)))
364 (or (next-single-property-change point 'epa-list-keys)
367 (epa--insert-keys context name mode)
370 (set-keymap-parent (current-local-map) widget-keymap))
371 (make-local-variable 'epa-list-keys-arguments)
372 (setq epa-list-keys-arguments (list name mode))
373 (goto-char (point-min))
374 (pop-to-buffer (current-buffer)))
376 (defun epa--insert-keys (context name mode)
379 (narrow-to-region (point) (point))
380 (let ((keys (epg-list-keys context name mode))
385 (add-text-properties point (point)
386 (list 'epa-key (car keys)
391 (widget-create 'epa-key :value (car keys))
393 (setq keys (cdr keys))))
394 (add-text-properties (point-min) (point-max)
395 (list 'epa-list-keys t
401 (defun epa--marked-keys ()
403 (set-buffer epa-keys-buffer)
404 (goto-char (point-min))
406 (while (re-search-forward "^\\*" nil t)
407 (if (setq key (get-text-property (match-beginning 0)
409 (setq keys (cons key keys))))
413 (let ((key (get-text-property (point) 'epa-key)))
418 (defun epa-select-keys (context prompt &optional names secret)
419 "Display a user's keyring and ask him to select keys.
420 CONTEXT is an epg-context.
421 PROMPT is a string to prompt with.
422 NAMES is a list of strings to be matched with keys. If it is nil, all
424 If SECRET is non-nil, list secret keys instead of public keys."
426 (unless (and epa-keys-buffer
427 (buffer-live-p epa-keys-buffer))
428 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
429 (let ((inhibit-read-only t)
431 (set-buffer epa-keys-buffer)
435 :notify (lambda (&rest ignore) (abort-recursive-edit))
437 (substitute-command-keys
438 "Click here or \\[abort-recursive-edit] to cancel")
441 :notify (lambda (&rest ignore) (exit-recursive-edit))
443 (substitute-command-keys
444 "Click here or \\[exit-recursive-edit] to finish")
449 (epa--insert-keys context (car names) secret)
450 (if (get-text-property (point) 'epa-list-keys)
452 (goto-char (point-max))
453 (setq names (cdr names)))
456 (epa--insert-keys context nil secret)
457 (if (get-text-property (point) 'epa-list-keys)
459 (epa--insert-keys context nil nil)))
462 (set-keymap-parent (current-local-map) widget-keymap)
463 (setq epa-exit-buffer-function #'abort-recursive-edit)
464 (goto-char (point-min))
465 (pop-to-buffer (current-buffer)))
470 (if (get-buffer-window epa-keys-buffer)
471 (delete-window (get-buffer-window epa-keys-buffer)))
472 (kill-buffer epa-keys-buffer))))
474 (defun epa--format-fingerprint-1 (fingerprint unit-size block-size)
478 (goto-char (point-min))
480 (goto-char (+ (point) unit-size))
482 (setq unit (1+ unit))
483 (insert (if (= (% unit block-size) 0) " " " ")))
486 (defun epa--format-fingerprint (fingerprint)
488 (if (= (length fingerprint) 40)
489 ;; 1234 5678 9ABC DEF0 1234 5678 9ABC DEF0 1234 5678
490 (epa--format-fingerprint-1 fingerprint 4 5)
491 ;; 12 34 56 78 9A BC DE F0 12 34 56 78 9A BC DE F0
492 (epa--format-fingerprint-1 fingerprint 2 8))))
494 (defun epa--show-key (key)
495 (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
496 (entry (assoc (epg-sub-key-id primary-sub-key)
497 epa-key-buffer-alist))
498 (inhibit-read-only t)
502 (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
503 epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
504 (unless (and (cdr entry)
505 (buffer-live-p (cdr entry)))
506 (setcdr entry (generate-new-buffer
507 (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
508 (set-buffer (cdr entry))
509 (make-local-variable 'epa-key)
512 (setq pointer (epg-key-user-id-list key))
516 (if (epg-user-id-validity (car pointer))
518 (car (rassq (epg-user-id-validity (car pointer))
519 epg-key-validity-alist)))
522 (if (stringp (epg-user-id-string (car pointer)))
523 (epg-user-id-string (car pointer))
524 (epg-decode-dn (epg-user-id-string (car pointer))))
526 (setq pointer (cdr pointer)))
527 (setq pointer (epg-key-sub-key-list key))
530 (if (epg-sub-key-validity (car pointer))
532 (car (rassq (epg-sub-key-validity (car pointer))
533 epg-key-validity-alist)))
536 (epg-sub-key-id (car pointer))
539 (epg-sub-key-length (car pointer)))
541 (cdr (assq (epg-sub-key-algorithm (car pointer))
542 epg-pubkey-algorithm-alist))
544 (format-time-string "%Y-%m-%d"
545 (epg-sub-key-creation-time (car pointer)))
546 (if (epg-sub-key-expiration-time (car pointer))
547 (format "\n\tExpires: %s"
548 (format-time-string "%Y-%m-%d"
549 (epg-sub-key-expiration-time
553 (mapconcat #'symbol-name
554 (epg-sub-key-capability (car pointer))
557 (epa--format-fingerprint (epg-sub-key-fingerprint (car pointer)))
559 (setq pointer (cdr pointer)))
560 (goto-char (point-min))
561 (pop-to-buffer (current-buffer))
564 (defun epa-display-info (info)
565 (if epa-popup-info-window
566 (save-selected-window
567 (unless epa-info-buffer
568 (setq epa-info-buffer (generate-new-buffer "*Info*")))
569 (if (get-buffer-window epa-info-buffer)
570 (delete-window (get-buffer-window epa-info-buffer)))
572 (set-buffer epa-info-buffer)
573 (let ((inhibit-read-only t)
578 (goto-char (point-min)))
579 (if (> (window-height)
580 epa-info-window-height)
581 (set-window-buffer (split-window nil (- (window-height)
582 epa-info-window-height))
584 (pop-to-buffer epa-info-buffer)
585 (if (> (window-height) epa-info-window-height)
586 (shrink-window (- (window-height) epa-info-window-height)))))
587 (message "%s" info)))
589 (defun epa-display-verify-result (verify-result)
590 (epa-display-info (epg-verify-result-to-string verify-result)))
591 (make-obsolete 'epa-display-verify-result 'epa-display-info)
593 (defun epa-passphrase-callback-function (context key-id handback)
595 (read-passwd "Passphrase for symmetric encryption: "
596 (eq (epg-context-operation context) 'encrypt))
599 "Passphrase for PIN: "
600 (let ((entry (assoc key-id epg-user-id-alist)))
602 (format "Passphrase for %s %s: " key-id (cdr entry))
603 (format "Passphrase for %s: " key-id)))))))
605 (defun epa-progress-callback-function (context what char current total
607 (message "%s%d%% (%d/%d)" (or handback
609 (if (> total 0) (floor (* (/ current (float total)) 100)) 0)
613 (defun epa-decrypt-file (file)
615 (interactive "fFile: ")
616 (setq file (expand-file-name file))
617 (let* ((default-name (file-name-sans-extension file))
618 (plain (expand-file-name
620 (concat "To file (default "
621 (file-name-nondirectory default-name)
623 (file-name-directory default-name)
625 (context (epg-make-context epa-protocol)))
626 (epg-context-set-passphrase-callback context
627 #'epa-passphrase-callback-function)
628 (epg-context-set-progress-callback context
629 #'epa-progress-callback-function
630 (format "Decrypting %s..."
631 (file-name-nondirectory file)))
632 (message "Decrypting %s..." (file-name-nondirectory file))
633 (epg-decrypt-file context file plain)
634 (message "Decrypting %s...wrote %s" (file-name-nondirectory file)
635 (file-name-nondirectory plain))
636 (if (epg-context-result-for context 'verify)
637 (epa-display-info (epg-verify-result-to-string
638 (epg-context-result-for context 'verify))))))
641 (defun epa-verify-file (file)
643 (interactive "fFile: ")
644 (setq file (expand-file-name file))
645 (let* ((context (epg-make-context epa-protocol))
646 (plain (if (equal (file-name-extension file) "sig")
647 (file-name-sans-extension file))))
648 (epg-context-set-progress-callback context
649 #'epa-progress-callback-function
650 (format "Verifying %s..."
651 (file-name-nondirectory file)))
652 (message "Verifying %s..." (file-name-nondirectory file))
653 (epg-verify-file context file plain)
654 (message "Verifying %s...done" (file-name-nondirectory file))
655 (if (epg-context-result-for context 'verify)
656 (epa-display-info (epg-verify-result-to-string
657 (epg-context-result-for context 'verify))))))
659 (defun epa--read-signature-type ()
662 (message "Signature type (n,c,d,?) ")
667 (setq type 'detached))
669 (with-output-to-temp-buffer "*Help*"
671 (set-buffer standard-output)
673 n - Create a normal signature
674 c - Create a cleartext signature
675 d - Create a detached signature
679 (setq type 'normal))))))
682 (defun epa-sign-file (file signers mode)
683 "Sign FILE by SIGNERS keys selected."
685 (let ((verbose current-prefix-arg))
686 (list (expand-file-name (read-file-name "File: "))
688 (epa-select-keys (epg-make-context epa-protocol)
689 "Select keys for signing.
690 If no one is selected, default secret key is used. "
693 (epa--read-signature-type)
695 (let ((signature (concat file
696 (if (eq epa-protocol 'OpenPGP)
699 '(nil t normal detached))))
701 (if (memq mode '(t detached))
704 (if (memq mode '(t detached))
707 (context (epg-make-context epa-protocol)))
708 (epg-context-set-armor context epa-armor)
709 (epg-context-set-textmode context epa-textmode)
710 (epg-context-set-signers context signers)
711 (epg-context-set-passphrase-callback context
712 #'epa-passphrase-callback-function)
713 (epg-context-set-progress-callback context
714 #'epa-progress-callback-function
715 (format "Signing %s..."
716 (file-name-nondirectory file)))
717 (message "Signing %s..." (file-name-nondirectory file))
718 (epg-sign-file context file signature mode)
719 (message "Signing %s...wrote %s" (file-name-nondirectory file)
720 (file-name-nondirectory signature))))
723 (defun epa-encrypt-file (file recipients)
724 "Encrypt FILE for RECIPIENTS."
726 (list (expand-file-name (read-file-name "File: "))
727 (epa-select-keys (epg-make-context epa-protocol)
728 "Select recipients for encryption.
729 If no one is selected, symmetric encryption will be performed. ")))
730 (let ((cipher (concat file (if (eq epa-protocol 'OpenPGP)
731 (if epa-armor ".asc" ".gpg")
733 (context (epg-make-context epa-protocol)))
734 (epg-context-set-armor context epa-armor)
735 (epg-context-set-textmode context epa-textmode)
736 (epg-context-set-passphrase-callback context
737 #'epa-passphrase-callback-function)
738 (epg-context-set-progress-callback context
739 #'epa-progress-callback-function
740 (format "Encrypting %s..."
741 (file-name-nondirectory file)))
742 (message "Encrypting %s..." (file-name-nondirectory file))
743 (epg-encrypt-file context file recipients cipher)
744 (message "Encrypting %s...wrote %s" (file-name-nondirectory file)
745 (file-name-nondirectory cipher))))
748 (defun epa-decrypt-region (start end)
749 "Decrypt the current region between START and END.
751 Don't use this command in Lisp programs!"
754 (let ((context (epg-make-context epa-protocol))
756 (epg-context-set-passphrase-callback context
757 #'epa-passphrase-callback-function)
758 (epg-context-set-progress-callback context
759 #'epa-progress-callback-function
761 (message "Decrypting...")
762 (setq plain (epg-decrypt-string context (buffer-substring start end)))
763 (message "Decrypting...done")
764 (setq plain (epa--decode-coding-string
766 (or coding-system-for-read
767 (get-text-property start 'epa-coding-system-used))))
768 (if (y-or-n-p "Replace the original text? ")
769 (let ((inhibit-read-only t)
771 (delete-region start end)
774 (with-output-to-temp-buffer "*Temp*"
775 (set-buffer standard-output)
778 (if (epg-context-result-for context 'verify)
779 (epa-display-info (epg-verify-result-to-string
780 (epg-context-result-for context 'verify)))))))
782 (defun epa--find-coding-system-for-mime-charset (mime-charset)
783 (if (featurep 'xemacs)
784 (if (fboundp 'find-coding-system)
785 (find-coding-system mime-charset))
786 (let ((pointer (coding-system-list)))
788 (eq (coding-system-get (car pointer) 'mime-charset)
790 (setq pointer (cdr pointer)))
794 (defun epa-decrypt-armor-in-region (start end)
795 "Decrypt OpenPGP armors in the current region between START and END.
797 Don't use this command in Lisp programs!"
801 (narrow-to-region start end)
803 (let (armor-start armor-end)
804 (while (re-search-forward "-----BEGIN PGP MESSAGE-----$" nil t)
805 (setq armor-start (match-beginning 0)
806 armor-end (re-search-forward "^-----END PGP MESSAGE-----$"
809 (error "No armor tail"))
810 (goto-char armor-start)
811 (let ((coding-system-for-read
812 (or coding-system-for-read
813 (if (re-search-forward "^Charset: \\(.*\\)" armor-end t)
814 (epa--find-coding-system-for-mime-charset
815 (intern (downcase (match-string 1))))))))
816 (goto-char armor-end)
817 (epa-decrypt-region armor-start armor-end)))))))
820 (defun epa-decrypt ()
821 "Decrypt OpenPGP armors in the current buffer.
823 Don't use this command in Lisp programs!"
825 (epa-decrypt-armor-in-region (point-min) (point-max)))
827 (if (fboundp 'select-safe-coding-system)
828 (defalias 'epa--select-safe-coding-system 'select-safe-coding-system)
829 (defun epa--select-safe-coding-system (from to)
830 buffer-file-coding-system))
833 (defun epa-verify-region (start end)
834 "Verify the current region between START and END.
836 Don't use this command in Lisp programs!"
838 (let ((context (epg-make-context epa-protocol)))
839 (epg-context-set-progress-callback context
840 #'epa-progress-callback-function
842 (epg-verify-string context
843 (epa--encode-coding-string
844 (buffer-substring start end)
845 (or coding-system-for-write
846 (get-text-property start
847 'epa-coding-system-used))))
848 (if (epg-context-result-for context 'verify)
849 (epa-display-info (epg-verify-result-to-string
850 (epg-context-result-for context 'verify))))))
853 (defun epa-verify-cleartext-in-region (start end)
854 "Verify OpenPGP cleartext signed messages in the current region
855 between START and END.
857 Don't use this command in Lisp programs!"
861 (narrow-to-region start end)
863 (let (armor-start armor-end)
864 (while (re-search-forward "-----BEGIN PGP SIGNED MESSAGE-----$"
866 (setq armor-start (match-beginning 0))
867 (unless (re-search-forward "^-----BEGIN PGP SIGNATURE-----$"
869 (error "Invalid cleartext signed message"))
870 (setq armor-end (re-search-forward
871 "^-----END PGP SIGNATURE-----$"
874 (error "No armor tail"))
875 (epa-verify-region armor-start armor-end))))))
879 "Verify OpenPGP cleartext signed messages in the current buffer.
881 Don't use this command in Lisp programs!"
883 (epa-verify-cleartext-in-region (point-min) (point-max)))
886 (defun epa-sign-region (start end signers mode)
887 "Sign the current region between START and END by SIGNERS keys selected.
889 Don't use this command in Lisp programs!"
891 (let ((verbose current-prefix-arg))
892 (setq epa-last-coding-system-specified
893 (or coding-system-for-write
894 (epa--select-safe-coding-system
895 (region-beginning) (region-end))))
896 (list (region-beginning) (region-end)
898 (epa-select-keys (epg-make-context epa-protocol)
899 "Select keys for signing.
900 If no one is selected, default secret key is used. "
903 (epa--read-signature-type)
906 (let ((context (epg-make-context epa-protocol))
908 ;;(epg-context-set-armor context epa-armor)
909 (epg-context-set-armor context t)
910 ;;(epg-context-set-textmode context epa-textmode)
911 (epg-context-set-textmode context t)
912 (epg-context-set-signers context signers)
913 (epg-context-set-passphrase-callback context
914 #'epa-passphrase-callback-function)
915 (epg-context-set-progress-callback context
916 #'epa-progress-callback-function
918 (message "Signing...")
919 (setq signature (epg-sign-string context
920 (epa--encode-coding-string
921 (buffer-substring start end)
922 epa-last-coding-system-specified)
924 (message "Signing...done")
925 (delete-region start end)
927 (add-text-properties (point)
929 (insert (epa--decode-coding-string
931 (or coding-system-for-read
932 epa-last-coding-system-specified)))
934 (list 'epa-coding-system-used
935 epa-last-coding-system-specified
941 (if (fboundp 'derived-mode-p)
942 (defalias 'epa--derived-mode-p 'derived-mode-p)
943 (defun epa--derived-mode-p (&rest modes)
944 "Non-nil if the current major mode is derived from one of MODES.
945 Uses the `derived-mode-parent' property of the symbol to trace backwards."
946 (let ((parent major-mode))
947 (while (and (not (memq parent modes))
948 (setq parent (get parent 'derived-mode-parent))))
951 (defun epa--mail-mode-p ()
952 (let ((pointer epa-mail-modes))
954 (epa--derived-mode-p (car pointer)))
955 (setq pointer (cdr pointer)))
959 (defun epa-sign (start end signers mode)
960 "Sign the current buffer.
962 Don't use this command in Lisp programs!"
965 (goto-char (point-min))
966 (if (and (epa--mail-mode-p)
967 (search-forward mail-header-separator nil t))
969 (setq epa-last-coding-system-specified
970 (or coding-system-for-write
971 (epa--select-safe-coding-system (point) (point-max))))
972 (let ((verbose current-prefix-arg))
973 (list (point) (point-max)
975 (epa-select-keys (epg-make-context epa-protocol)
976 "Select keys for signing.
977 If no one is selected, default secret key is used. "
980 (epa--read-signature-type)
982 (epa-sign-region start end signers mode))
985 (defun epa-encrypt-region (start end recipients sign signers)
986 "Encrypt the current region between START and END for RECIPIENTS.
988 Don't use this command in Lisp programs!"
990 (let ((verbose current-prefix-arg)
991 (context (epg-make-context epa-protocol))
993 (setq epa-last-coding-system-specified
994 (or coding-system-for-write
995 (epa--select-safe-coding-system
996 (region-beginning) (region-end))))
997 (list (region-beginning) (region-end)
998 (epa-select-keys context
999 "Select recipients for encryption.
1000 If no one is selected, symmetric encryption will be performed. ")
1001 (setq sign (if verbose (y-or-n-p "Sign? ")))
1003 (epa-select-keys context
1004 "Select keys for signing. ")))))
1006 (let ((context (epg-make-context epa-protocol))
1008 ;;(epg-context-set-armor context epa-armor)
1009 (epg-context-set-armor context t)
1010 ;;(epg-context-set-textmode context epa-textmode)
1011 (epg-context-set-textmode context t)
1013 (epg-context-set-signers context signers))
1014 (epg-context-set-passphrase-callback context
1015 #'epa-passphrase-callback-function)
1016 (epg-context-set-progress-callback context
1017 #'epa-progress-callback-function
1019 (message "Encrypting...")
1020 (setq cipher (epg-encrypt-string context
1021 (epa--encode-coding-string
1022 (buffer-substring start end)
1023 epa-last-coding-system-specified)
1026 (message "Encrypting...done")
1027 (delete-region start end)
1029 (add-text-properties (point)
1033 (list 'epa-coding-system-used
1034 epa-last-coding-system-specified
1041 (defun epa-encrypt (start end recipients sign signers)
1042 "Encrypt the current buffer.
1044 Don't use this command in Lisp programs!"
1047 (let ((verbose current-prefix-arg)
1048 (context (epg-make-context epa-protocol))
1050 (goto-char (point-min))
1051 (when (epa--mail-mode-p)
1053 (narrow-to-region (point)
1054 (if (search-forward mail-header-separator nil 0)
1058 (mail-strip-quoted-names
1059 (mapconcat #'identity
1060 (nconc (mail-fetch-field "to" nil nil t)
1061 (mail-fetch-field "cc" nil nil t)
1062 (mail-fetch-field "bcc" nil nil t))
1065 (setq recipients (delete ""
1066 (split-string recipients "[ \t\n]+"))))
1067 (goto-char (point-min))
1068 (if (search-forward mail-header-separator nil t)
1070 (setq epa-last-coding-system-specified
1071 (or coding-system-for-write
1072 (epa--select-safe-coding-system (point) (point-max))))
1073 (list (point) (point-max)
1077 "Select recipients for encryption.
1078 If no one is selected, symmetric encryption will be performed. "
1086 (epg-make-context epa-protocol)
1087 (concat "<" recipient ">")))
1089 (setq sign (if verbose (y-or-n-p "Sign? ")))
1091 (epa-select-keys context
1092 "Select keys for signing. "))))))
1093 (epa-encrypt-region start end recipients sign signers))
1096 (defun epa-delete-keys (keys &optional allow-secret)
1097 "Delete selected KEYS.
1099 Don't use this command in Lisp programs!"
1101 (let ((keys (epa--marked-keys)))
1103 (error "No keys selected"))
1105 (eq (nth 1 epa-list-keys-arguments) t))))
1106 (let ((context (epg-make-context epa-protocol)))
1107 (message "Deleting...")
1108 (epg-delete-keys context keys allow-secret)
1109 (message "Deleting...done")
1110 (apply #'epa-list-keys epa-list-keys-arguments)))
1113 (defun epa-import-keys (file)
1114 "Import keys from FILE.
1116 Don't use this command in Lisp programs!"
1117 (interactive "fFile: ")
1118 (setq file (expand-file-name file))
1119 (let ((context (epg-make-context epa-protocol)))
1120 (message "Importing %s..." (file-name-nondirectory file))
1123 (epg-import-keys-from-file context file)
1124 (message "Importing %s...done" (file-name-nondirectory file)))
1126 (message "Importing %s...failed" (file-name-nondirectory file))))
1127 (if (epg-context-result-for context 'import)
1128 (epa-display-info (epg-import-result-to-string
1129 (epg-context-result-for context 'import))))
1130 (if (eq major-mode 'epa-keys-mode)
1131 (apply #'epa-list-keys epa-list-keys-arguments))))
1134 (defun epa-import-keys-region (start end)
1135 "Import keys from the region.
1137 Don't use this command in Lisp programs!"
1139 (let ((context (epg-make-context epa-protocol)))
1140 (message "Importing...")
1143 (epg-import-keys-from-string context (buffer-substring start end))
1144 (message "Importing...done"))
1146 (message "Importing...failed")))
1147 (if (epg-context-result-for context 'import)
1148 (epa-display-info (epg-import-result-to-string
1149 (epg-context-result-for context 'import))))))
1152 (defun epa-import-armor-in-region (start end)
1153 "Import keys in the OpenPGP armor format in the current region
1154 between START and END.
1156 Don't use this command in Lisp programs!"
1160 (narrow-to-region start end)
1162 (let (armor-start armor-end)
1163 (while (re-search-forward
1164 "-----BEGIN \\(PGP \\(PUBLIC\\|PRIVATE\\) KEY BLOCK\\)-----$"
1166 (setq armor-start (match-beginning 0)
1167 armor-end (re-search-forward
1168 (concat "^-----END " (match-string 1) "-----$")
1171 (error "No armor tail"))
1172 (epa-import-keys-region armor-start armor-end))))))
1175 (defun epa-import ()
1176 "Import keys in the OpenPGP armor format in the current buffer.
1178 Don't use this command in Lisp programs!"
1180 (epa-import-armor-in-region (point-min) (point-max)))
1183 (defun epa-export-keys (keys file)
1184 "Export selected KEYS to FILE.
1186 Don't use this command in Lisp programs!"
1188 (let ((keys (epa--marked-keys))
1191 (error "No keys selected"))
1194 (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
1195 (if epa-armor ".asc" ".gpg"))
1200 (concat "To file (default "
1201 (file-name-nondirectory default-name)
1203 (file-name-directory default-name)
1205 (let ((context (epg-make-context epa-protocol)))
1206 (epg-context-set-armor context epa-armor)
1207 (message "Exporting to %s..." (file-name-nondirectory file))
1208 (epg-export-keys-to-file context keys file)
1209 (message "Exporting to %s...done" (file-name-nondirectory file))))
1212 (defun epa-insert-keys (keys)
1213 "Insert selected KEYS after the point.
1215 Don't use this command in Lisp programs!"
1217 (list (epa-select-keys (epg-make-context epa-protocol)
1218 "Select keys to export. ")))
1219 (let ((context (epg-make-context epa-protocol)))
1220 ;;(epg-context-set-armor context epa-armor)
1221 (epg-context-set-armor context t)
1222 (insert (epg-export-keys-to-string context keys))))
1225 (defun epa-sign-keys (keys &optional local)
1226 "Sign selected KEYS.
1227 If a prefix-arg is specified, the signature is marked as non exportable.
1229 Don't use this command in Lisp programs!"
1231 (let ((keys (epa--marked-keys)))
1233 (error "No keys selected"))
1234 (list keys current-prefix-arg)))
1235 (let ((context (epg-make-context epa-protocol)))
1236 (epg-context-set-passphrase-callback context
1237 #'epa-passphrase-callback-function)
1238 (epg-context-set-progress-callback context
1239 #'epa-progress-callback-function
1241 (message "Signing keys...")
1242 (epg-sign-keys context keys local)
1243 (message "Signing keys...done")))
1244 (make-obsolete 'epa-sign-keys "Do not use.")
1248 ;;; epa.el ends here