1 ;;; epa.el --- the EasyPG Assistant -*- lexical-binding: t -*-
3 ;; Copyright (C) 2006-2014 Free Software Foundation, Inc.
5 ;; Author: Daiki Ueno <ueno@unixuser.org>
6 ;; Keywords: PGP, GnuPG
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 (eval-when-compile (require 'wid-edit
))
32 "The EasyPG Assistant"
34 :link
'(custom-manual "(epa) Top")
37 (defcustom epa-popup-info-window t
38 "If non-nil, display status information from epa commands in another window."
42 (defcustom epa-info-window-height
5
43 "Number of lines used to display status information."
47 (defgroup epa-faces nil
52 (defcustom epa-mail-aliases nil
53 "Alist of aliases of email addresses that stand for encryption keys.
54 Each element is (ALIAS EXPANSIONS...).
55 It means that when a message is addressed to ALIAS,
56 instead of encrypting it for ALIAS, encrypt it for EXPANSIONS...
57 If EXPANSIONS is empty, ignore ALIAS as regards encryption.
58 That is a handy way to avoid warnings about addresses
59 that you don't have any key for."
60 :type
'(repeat (cons (string :tag
"Alias") (repeat '(string :tag
"Expansion"))))
64 (defface epa-validity-high
65 '((default :weight bold
)
66 (((class color
) (background dark
)) :foreground
"PaleTurquoise"))
67 "Face for high validity EPA information."
70 (defface epa-validity-medium
71 '((default :slant italic
)
72 (((class color
) (background dark
)) :foreground
"PaleTurquoise"))
73 "Face for medium validity EPA information."
76 (defface epa-validity-low
78 "Face used for displaying the low validity."
81 (defface epa-validity-disabled
82 '((t :slant italic
:inverse-video t
))
83 "Face used for displaying the disabled validity."
87 '((((class color
) (background dark
))
88 :foreground
"lightyellow")
89 (((class color
) (background light
))
91 "Face used for displaying the string."
95 '((default :weight bold
)
96 (((class color
) (background dark
)) :foreground
"orange")
97 (((class color
) (background light
)) :foreground
"red"))
98 "Face used for displaying the high validity."
101 (defface epa-field-name
102 '((default :weight bold
)
103 (((class color
) (background dark
)) :foreground
"PaleTurquoise"))
104 "Face for the name of the attribute field."
107 (defface epa-field-body
108 '((default :slant italic
)
109 (((class color
) (background dark
)) :foreground
"turquoise"))
110 "Face for the body of the attribute field."
113 (defcustom epa-validity-face-alist
114 '((unknown . epa-validity-disabled
)
115 (invalid . epa-validity-disabled
)
116 (disabled . epa-validity-disabled
)
117 (revoked . epa-validity-disabled
)
118 (expired . epa-validity-disabled
)
119 (none . epa-validity-low
)
120 (undefined . epa-validity-low
)
121 (never . epa-validity-low
)
122 (marginal . epa-validity-medium
)
123 (full . epa-validity-high
)
124 (ultimate . epa-validity-high
))
125 "An alist mapping validity values to faces."
126 :type
'(repeat (cons symbol face
))
129 (defvar epa-font-lock-keywords
132 ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
134 (2 'epa-field-body
)))
135 "Default expressions to addon in epa-mode.")
137 (defconst epa-pubkey-algorithm-letter-alist
145 (defvar epa-protocol
'OpenPGP
146 "The default protocol.
147 The value can be either OpenPGP or CMS.
149 You should bind this variable with `let', but do not set it globally.")
151 (defvar epa-armor nil
152 "If non-nil, epa commands create ASCII armored output.
154 You should bind this variable with `let', but do not set it globally.")
156 (defvar epa-textmode nil
157 "If non-nil, epa commands treat input files as text.
159 You should bind this variable with `let', but do not set it globally.")
161 (defvar epa-keys-buffer nil
)
162 (defvar epa-key-buffer-alist nil
)
164 (defvar epa-list-keys-arguments nil
)
165 (defvar epa-info-buffer nil
)
166 (defvar epa-last-coding-system-specified nil
)
168 (defvar epa-key-list-mode-map
169 (let ((keymap (make-sparse-keymap))
170 (menu-map (make-sparse-keymap)))
171 (define-key keymap
"m" 'epa-mark-key
)
172 (define-key keymap
"u" 'epa-unmark-key
)
173 (define-key keymap
"d" 'epa-decrypt-file
)
174 (define-key keymap
"v" 'epa-verify-file
)
175 (define-key keymap
"s" 'epa-sign-file
)
176 (define-key keymap
"e" 'epa-encrypt-file
)
177 (define-key keymap
"r" 'epa-delete-keys
)
178 (define-key keymap
"i" 'epa-import-keys
)
179 (define-key keymap
"o" 'epa-export-keys
)
180 (define-key keymap
"g" 'revert-buffer
)
181 (define-key keymap
"n" 'next-line
)
182 (define-key keymap
"p" 'previous-line
)
183 (define-key keymap
" " 'scroll-up-command
)
184 (define-key keymap
[?\S-\
] 'scroll-down-command
)
185 (define-key keymap
[delete] 'scroll-down-command)
186 (define-key keymap "q" 'epa-exit-buffer)
187 (define-key keymap [menu-bar epa-key-list-mode] (cons "Keys" menu-map))
188 (define-key menu-map [epa-key-list-unmark-key]
189 '(menu-item "Unmark Key" epa-unmark-key
190 :help "Unmark a key"))
191 (define-key menu-map [epa-key-list-mark-key]
192 '(menu-item "Mark Key" epa-mark-key
194 (define-key menu-map [separator-epa-file] '(menu-item "--"))
195 (define-key menu-map [epa-verify-file]
196 '(menu-item "Verify File..." epa-verify-file
197 :help "Verify FILE"))
198 (define-key menu-map [epa-sign-file]
199 '(menu-item "Sign File..." epa-sign-file
200 :help "Sign FILE by SIGNERS keys selected"))
201 (define-key menu-map [epa-decrypt-file]
202 '(menu-item "Decrypt File..." epa-decrypt-file
203 :help "Decrypt FILE"))
204 (define-key menu-map [epa-encrypt-file]
205 '(menu-item "Encrypt File..." epa-encrypt-file
206 :help "Encrypt FILE for RECIPIENTS"))
207 (define-key menu-map [separator-epa-key-list] '(menu-item "--"))
208 (define-key menu-map [epa-key-list-delete-keys]
209 '(menu-item "Delete Keys" epa-delete-keys
210 :help "Delete Marked Keys"))
211 (define-key menu-map [epa-key-list-import-keys]
212 '(menu-item "Import Keys" epa-import-keys
213 :help "Import keys from a file"))
214 (define-key menu-map [epa-key-list-export-keys]
215 '(menu-item "Export Keys" epa-export-keys
216 :help "Export marked keys to a file"))
219 (defvar epa-key-mode-map
220 (let ((keymap (make-sparse-keymap)))
221 (define-key keymap "q" 'epa-exit-buffer)
224 (defvar epa-info-mode-map
225 (let ((keymap (make-sparse-keymap)))
226 (define-key keymap "q" 'delete-window)
229 (defvar epa-exit-buffer-function #'bury-buffer)
231 (define-widget 'epa-key 'push-button
232 "Button for representing a epg-key object."
234 :button-face-get 'epa--key-widget-button-face-get
235 :value-create 'epa--key-widget-value-create
236 :action 'epa--key-widget-action
237 :help-echo 'epa--key-widget-help-echo)
239 (defun epa--key-widget-action (widget &optional _event)
240 (save-selected-window
241 (epa--show-key (widget-get widget :value))))
243 (defun epa--key-widget-value-create (widget)
244 (let* ((key (widget-get widget :value))
245 (primary-sub-key (car (epg-key-sub-key-list key)))
246 (primary-user-id (car (epg-key-user-id-list key))))
247 (insert (format "%c "
248 (if (epg-sub-key-validity primary-sub-key)
249 (car (rassq (epg-sub-key-validity primary-sub-key)
250 epg-key-validity-alist))
252 (epg-sub-key-id primary-sub-key)
255 (if (stringp (epg-user-id-string primary-user-id))
256 (epg-user-id-string primary-user-id)
257 (epg-decode-dn (epg-user-id-string primary-user-id)))
260 (defun epa--key-widget-button-face-get (widget)
261 (let ((validity (epg-sub-key-validity (car (epg-key-sub-key-list
262 (widget-get widget :value))))))
264 (cdr (assq validity epa-validity-face-alist))
267 (defun epa--key-widget-help-echo (widget)
269 (epg-sub-key-id (car (epg-key-sub-key-list
270 (widget-get widget :value))))))
272 (defalias 'epa--encode-coding-string
273 (if (fboundp 'encode-coding-string) #'encode-coding-string #'identity))
275 (defalias 'epa--decode-coding-string
276 (if (fboundp 'decode-coding-string) #'decode-coding-string #'identity))
278 (define-derived-mode epa-key-list-mode special-mode "Keys"
279 "Major mode for `epa-list-keys'."
280 (buffer-disable-undo)
281 (setq truncate-lines t
283 (setq-local font-lock-defaults '(epa-font-lock-keywords t))
284 ;; In XEmacs, auto-initialization of font-lock is not effective
285 ;; if buffer-file-name is not set.
286 (font-lock-set-defaults)
287 (make-local-variable 'epa-exit-buffer-function)
288 (setq-local revert-buffer-function #'epa--key-list-revert-buffer))
290 (define-derived-mode epa-key-mode special-mode "Key"
291 "Major mode for a key description."
292 (buffer-disable-undo)
293 (setq truncate-lines t
295 (setq-local font-lock-defaults '(epa-font-lock-keywords t))
296 ;; In XEmacs, auto-initialization of font-lock is not effective
297 ;; if buffer-file-name is not set.
298 (font-lock-set-defaults)
299 (make-local-variable 'epa-exit-buffer-function))
301 (define-derived-mode epa-info-mode special-mode "Info"
302 "Major mode for `epa-info-buffer'."
303 (buffer-disable-undo)
304 (setq truncate-lines t
307 (defun epa-mark-key (&optional arg)
308 "Mark a key on the current line.
309 If ARG is non-nil, unmark the key."
311 (let ((inhibit-read-only t)
315 (unless (get-text-property (point) 'epa-key)
316 (error "No key on this line"))
317 (setq properties (text-properties-at (point)))
319 (insert (if arg " " "*"))
320 (set-text-properties (1- (point)) (point) properties)
323 (defun epa-unmark-key (&optional arg)
324 "Unmark a key on the current line.
325 If ARG is non-nil, mark the key."
327 (epa-mark-key (not arg)))
329 (defun epa-exit-buffer ()
330 "Exit the current buffer.
331 `epa-exit-buffer-function' is called if it is set."
333 (funcall epa-exit-buffer-function))
335 (defun epa--insert-keys (keys)
338 (narrow-to-region (point) (point))
343 (add-text-properties point (point)
344 (list 'epa-key (car keys)
349 (widget-create 'epa-key :value (car keys))
351 (setq keys (cdr keys))))
352 (add-text-properties (point-min) (point-max)
353 (list 'epa-list-keys t
359 (defun epa--list-keys (name secret)
360 (unless (and epa-keys-buffer
361 (buffer-live-p epa-keys-buffer))
362 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
363 (set-buffer epa-keys-buffer)
365 (let ((inhibit-read-only t)
368 (context (epg-make-context epa-protocol)))
369 (unless (get-text-property point 'epa-list-keys)
370 (setq point (next-single-property-change point 'epa-list-keys)))
373 (or (next-single-property-change point 'epa-list-keys)
376 (epa--insert-keys (epg-list-keys context name secret))
378 (set-keymap-parent (current-local-map) widget-keymap))
379 (make-local-variable 'epa-list-keys-arguments)
380 (setq epa-list-keys-arguments (list name secret))
381 (goto-char (point-min))
382 (pop-to-buffer (current-buffer)))
385 (defun epa-list-keys (&optional name)
386 "List all keys matched with NAME from the public keyring."
388 (if current-prefix-arg
389 (let ((name (read-string "Pattern: "
390 (if epa-list-keys-arguments
391 (car epa-list-keys-arguments)))))
392 (list (if (equal name "") nil name)))
394 (epa--list-keys name nil))
397 (defun epa-list-secret-keys (&optional name)
398 "List all keys matched with NAME from the private keyring."
400 (if current-prefix-arg
401 (let ((name (read-string "Pattern: "
402 (if epa-list-keys-arguments
403 (car epa-list-keys-arguments)))))
404 (list (if (equal name "") nil name)))
406 (epa--list-keys name t))
408 (defun epa--key-list-revert-buffer (&optional _ignore-auto _noconfirm)
409 (apply #'epa--list-keys epa-list-keys-arguments))
411 (defun epa--marked-keys ()
412 (or (with-current-buffer epa-keys-buffer
413 (goto-char (point-min))
415 (while (re-search-forward "^\\*" nil t)
416 (if (setq key (get-text-property (match-beginning 0)
418 (setq keys (cons key keys))))
420 (let ((key (get-text-property (point-at-bol) 'epa-key)))
424 (defun epa--select-keys (prompt keys)
425 (unless (and epa-keys-buffer
426 (buffer-live-p epa-keys-buffer))
427 (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
428 (with-current-buffer epa-keys-buffer
430 ;; C-c C-c is the usual way to finish the selection (bug#11159).
431 (define-key (current-local-map) "\C-c\C-c" 'exit-recursive-edit)
432 (let ((inhibit-read-only t)
436 (substitute-command-keys "\
437 - `\\[epa-mark-key]' to mark a key on the line
438 - `\\[epa-unmark-key]' to unmark a key on the line\n"))
440 :notify (lambda (&rest _ignore) (abort-recursive-edit))
442 (substitute-command-keys
443 "Click here or \\[abort-recursive-edit] to cancel")
446 :notify (lambda (&rest _ignore) (exit-recursive-edit))
448 (substitute-command-keys
449 "Click here or \\[exit-recursive-edit] to finish")
452 (epa--insert-keys keys)
454 (set-keymap-parent (current-local-map) widget-keymap)
455 (setq epa-exit-buffer-function #'abort-recursive-edit)
456 (goto-char (point-min))
457 (let ((display-buffer-mark-dedicated 'soft))
458 (pop-to-buffer (current-buffer))))
463 (kill-buffer epa-keys-buffer))))
466 (defun epa-select-keys (context prompt &optional names secret)
467 "Display a user's keyring and ask him to select keys.
468 CONTEXT is an epg-context.
469 PROMPT is a string to prompt with.
470 NAMES is a list of strings to be matched with keys. If it is nil, all
472 If SECRET is non-nil, list secret keys instead of public keys."
473 (let ((keys (epg-list-keys context names secret)))
474 (epa--select-keys prompt keys)))
476 (defun epa--show-key (key)
477 (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
478 (entry (assoc (epg-sub-key-id primary-sub-key)
479 epa-key-buffer-alist))
480 (inhibit-read-only t)
484 (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
485 epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
486 (unless (and (cdr entry)
487 (buffer-live-p (cdr entry)))
488 (setcdr entry (generate-new-buffer
489 (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
490 (set-buffer (cdr entry))
492 (make-local-variable 'epa-key)
495 (setq pointer (epg-key-user-id-list key))
499 (if (epg-user-id-validity (car pointer))
501 (car (rassq (epg-user-id-validity (car pointer))
502 epg-key-validity-alist)))
505 (if (stringp (epg-user-id-string (car pointer)))
506 (epg-user-id-string (car pointer))
507 (epg-decode-dn (epg-user-id-string (car pointer))))
509 (setq pointer (cdr pointer)))
510 (setq pointer (epg-key-sub-key-list key))
513 (if (epg-sub-key-validity (car pointer))
515 (car (rassq (epg-sub-key-validity (car pointer))
516 epg-key-validity-alist)))
519 (epg-sub-key-id (car pointer))
522 (epg-sub-key-length (car pointer)))
524 (cdr (assq (epg-sub-key-algorithm (car pointer))
525 epg-pubkey-algorithm-alist))
528 (format-time-string "%Y-%m-%d"
529 (epg-sub-key-creation-time (car pointer)))
530 (error "????-??-??"))
531 (if (epg-sub-key-expiration-time (car pointer))
532 (format (if (time-less-p (current-time)
533 (epg-sub-key-expiration-time
538 (format-time-string "%Y-%m-%d"
539 (epg-sub-key-expiration-time
541 (error "????-??-??")))
544 (mapconcat #'symbol-name
545 (epg-sub-key-capability (car pointer))
548 (epg-sub-key-fingerprint (car pointer))
550 (setq pointer (cdr pointer)))
551 (goto-char (point-min))
552 (pop-to-buffer (current-buffer))))
554 (defun epa-display-info (info)
555 (if epa-popup-info-window
556 (save-selected-window
557 (unless (and epa-info-buffer (buffer-live-p epa-info-buffer))
558 (setq epa-info-buffer (generate-new-buffer "*Info*")))
559 (if (get-buffer-window epa-info-buffer)
560 (delete-window (get-buffer-window epa-info-buffer)))
561 (with-current-buffer epa-info-buffer
562 (let ((inhibit-read-only t)
567 (goto-char (point-min)))
568 (if (> (window-height)
569 epa-info-window-height)
570 (set-window-buffer (split-window nil (- (window-height)
571 epa-info-window-height))
573 (pop-to-buffer epa-info-buffer)
574 (if (> (window-height) epa-info-window-height)
575 (shrink-window (- (window-height) epa-info-window-height)))))
576 (message "%s" info)))
578 (defun epa-display-verify-result (verify-result)
579 (declare (obsolete epa-display-info "23.1"))
580 (epa-display-info (epg-verify-result-to-string verify-result)))
582 (defun epa-passphrase-callback-function (context key-id handback)
585 (format "Passphrase for symmetric encryption%s: "
586 ;; Add the file name to the prompt, if any.
587 (if (stringp handback)
588 (format " for %s" handback)
590 (eq (epg-context-operation context) 'encrypt))
593 "Passphrase for PIN: "
594 (let ((entry (assoc key-id epg-user-id-alist)))
596 (format "Passphrase for %s %s: " key-id (cdr entry))
597 (format "Passphrase for %s: " key-id)))))))
599 (defun epa-progress-callback-function (_context what _char current total
601 (let ((prompt (or handback
602 (format "Processing %s: " what))))
603 ;; According to gnupg/doc/DETAIL: a "total" of 0 indicates that
604 ;; the total amount is not known. The condition TOTAL && CUR ==
605 ;; TOTAL may be used to detect the end of an operation.
607 (if (= current total)
608 (message "%s...done" prompt)
609 (message "%s...%d%%" prompt
610 (floor (* (/ current (float total)) 100))))
611 (message "%s..." prompt))))
613 (defun epa-read-file-name (input)
614 "Interactively read an output file name based on INPUT file name."
615 (setq input (file-name-sans-extension (expand-file-name input)))
618 (concat "To file (default " (file-name-nondirectory input) ") ")
619 (file-name-directory input)
623 (defun epa-decrypt-file (decrypt-file &optional plain-file)
624 "Decrypt DECRYPT-FILE into PLAIN-FILE.
625 If you do not specify PLAIN-FILE, this functions prompts for the value to use."
627 (let* ((file (read-file-name "File to decrypt: "))
628 (plain (epa-read-file-name file)))
630 (or plain-file (setq plain-file (epa-read-file-name decrypt-file)))
631 (setq decrypt-file (expand-file-name decrypt-file))
632 (let ((context (epg-make-context epa-protocol)))
633 (epg-context-set-passphrase-callback context
634 #'epa-passphrase-callback-function)
635 (epg-context-set-progress-callback context
637 #'epa-progress-callback-function
638 (format "Decrypting %s..."
639 (file-name-nondirectory decrypt-file))))
640 (message "Decrypting %s..." (file-name-nondirectory decrypt-file))
641 (epg-decrypt-file context decrypt-file plain-file)
642 (message "Decrypting %s...wrote %s" (file-name-nondirectory decrypt-file)
643 (file-name-nondirectory plain-file))
644 (if (epg-context-result-for context 'verify)
645 (epa-display-info (epg-verify-result-to-string
646 (epg-context-result-for context 'verify))))))
649 (defun epa-verify-file (file)
651 (interactive "fFile: ")
652 (setq file (expand-file-name file))
653 (let* ((context (epg-make-context epa-protocol))
654 (plain (if (equal (file-name-extension file) "sig")
655 (file-name-sans-extension file))))
656 (epg-context-set-progress-callback context
658 #'epa-progress-callback-function
659 (format "Verifying %s..."
660 (file-name-nondirectory file))))
661 (message "Verifying %s..." (file-name-nondirectory file))
662 (epg-verify-file context file plain)
663 (message "Verifying %s...done" (file-name-nondirectory file))
664 (if (epg-context-result-for context 'verify)
665 (epa-display-info (epg-verify-result-to-string
666 (epg-context-result-for context 'verify))))))
668 (defun epa--read-signature-type ()
671 (message "Signature type (n,c,d,?) ")
676 (setq type 'detached))
678 (with-output-to-temp-buffer "*Help*"
679 (with-current-buffer standard-output
681 n - Create a normal signature
682 c - Create a cleartext signature
683 d - Create a detached signature
687 (setq type 'normal))))
691 (defun epa-sign-file (file signers mode)
692 "Sign FILE by SIGNERS keys selected."
694 (let ((verbose current-prefix-arg))
695 (list (expand-file-name (read-file-name "File: "))
697 (epa-select-keys (epg-make-context epa-protocol)
698 "Select keys for signing.
699 If no one is selected, default secret key is used. "
702 (epa--read-signature-type)
704 (let ((signature (concat file
705 (if (eq epa-protocol 'OpenPGP)
708 '(nil t normal detached))))
710 (if (memq mode '(t detached))
713 (if (memq mode '(t detached))
716 (context (epg-make-context epa-protocol)))
717 (epg-context-set-armor context epa-armor)
718 (epg-context-set-textmode context epa-textmode)
719 (epg-context-set-signers context signers)
720 (epg-context-set-passphrase-callback context
721 #'epa-passphrase-callback-function)
722 (epg-context-set-progress-callback context
724 #'epa-progress-callback-function
725 (format "Signing %s..."
726 (file-name-nondirectory file))))
727 (message "Signing %s..." (file-name-nondirectory file))
728 (epg-sign-file context file signature mode)
729 (message "Signing %s...wrote %s" (file-name-nondirectory file)
730 (file-name-nondirectory signature))))
733 (defun epa-encrypt-file (file recipients)
734 "Encrypt FILE for RECIPIENTS."
736 (list (expand-file-name (read-file-name "File: "))
737 (epa-select-keys (epg-make-context epa-protocol)
738 "Select recipients for encryption.
739 If no one is selected, symmetric encryption will be performed. ")))
740 (let ((cipher (concat file (if (eq epa-protocol 'OpenPGP)
741 (if epa-armor ".asc" ".gpg")
743 (context (epg-make-context epa-protocol)))
744 (epg-context-set-armor context epa-armor)
745 (epg-context-set-textmode context epa-textmode)
746 (epg-context-set-passphrase-callback context
747 #'epa-passphrase-callback-function)
748 (epg-context-set-progress-callback context
750 #'epa-progress-callback-function
751 (format "Encrypting %s..."
752 (file-name-nondirectory file))))
753 (message "Encrypting %s..." (file-name-nondirectory file))
754 (epg-encrypt-file context file recipients cipher)
755 (message "Encrypting %s...wrote %s" (file-name-nondirectory file)
756 (file-name-nondirectory cipher))))
759 (defun epa-decrypt-region (start end &optional make-buffer-function)
760 "Decrypt the current region between START and END.
762 If MAKE-BUFFER-FUNCTION is non-nil, call it to prepare an output buffer.
763 It should return that buffer. If it copies the input, it should
764 delete the text now being decrypted. It should leave point at the
765 proper place to insert the plaintext.
767 Be careful about using this command in Lisp programs!
768 Since this function operates on regions, it does some tricks such
769 as coding-system detection and unibyte/multibyte conversion. If
770 you are sure how the data in the region should be treated, you
771 should consider using the string based counterpart
772 `epg-decrypt-string', or the file based counterpart
773 `epg-decrypt-file' instead.
777 \(let ((context (epg-make-context 'OpenPGP)))
778 (decode-coding-string
779 (epg-decrypt-string context (buffer-substring start end))
783 (let ((context (epg-make-context epa-protocol))
785 (epg-context-set-passphrase-callback context
786 #'epa-passphrase-callback-function)
787 (epg-context-set-progress-callback context
789 #'epa-progress-callback-function
791 (message "Decrypting...")
792 (setq plain (epg-decrypt-string context (buffer-substring start end)))
793 (message "Decrypting...done")
794 (setq plain (epa--decode-coding-string
796 (or coding-system-for-read
797 (get-text-property start 'epa-coding-system-used)
799 (if make-buffer-function
800 (with-current-buffer (funcall make-buffer-function)
801 (let ((inhibit-read-only t))
803 (if (y-or-n-p "Replace the original text? ")
804 (let ((inhibit-read-only t))
805 (delete-region start end)
808 (with-output-to-temp-buffer "*Temp*"
809 (set-buffer standard-output)
812 (if (epg-context-result-for context 'verify)
813 (epa-display-info (epg-verify-result-to-string
814 (epg-context-result-for context 'verify)))))))
816 (defun epa--find-coding-system-for-mime-charset (mime-charset)
817 (if (featurep 'xemacs)
818 (if (fboundp 'find-coding-system)
819 (find-coding-system mime-charset))
820 ;; Find the first coding system which corresponds to MIME-CHARSET.
821 (let ((pointer (coding-system-list)))
823 (not (eq (coding-system-get (car pointer) 'mime-charset)
825 (setq pointer (cdr pointer)))
829 (defun epa-decrypt-armor-in-region (start end)
830 "Decrypt OpenPGP armors in the current region between START and END.
832 Don't use this command in Lisp programs!
833 See the reason described in the `epa-decrypt-region' documentation."
837 (narrow-to-region start end)
839 (let (armor-start armor-end)
840 (while (re-search-forward "-----BEGIN PGP MESSAGE-----$" nil t)
841 (setq armor-start (match-beginning 0)
842 armor-end (re-search-forward "^-----END PGP MESSAGE-----$"
845 (error "Encryption armor beginning has no matching end"))
846 (goto-char armor-start)
847 (let ((coding-system-for-read
848 (or coding-system-for-read
849 (if (re-search-forward "^Charset: \\(.*\\)" armor-end t)
850 (epa--find-coding-system-for-mime-charset
851 (intern (downcase (match-string 1))))))))
852 (goto-char armor-end)
853 (epa-decrypt-region armor-start armor-end)))))))
856 (defun epa-verify-region (start end)
857 "Verify the current region between START and END.
859 Don't use this command in Lisp programs!
860 Since this function operates on regions, it does some tricks such
861 as coding-system detection and unibyte/multibyte conversion. If
862 you are sure how the data in the region should be treated, you
863 should consider using the string based counterpart
864 `epg-verify-string', or the file based counterpart
865 `epg-verify-file' instead.
869 \(let ((context (epg-make-context 'OpenPGP)))
870 (decode-coding-string
871 (epg-verify-string context (buffer-substring start end))
874 (let ((context (epg-make-context epa-protocol))
876 (epg-context-set-progress-callback context
878 #'epa-progress-callback-function
880 (message "Verifying...")
881 (setq plain (epg-verify-string
883 (epa--encode-coding-string
884 (buffer-substring start end)
885 (or coding-system-for-write
886 (get-text-property start 'epa-coding-system-used)))))
887 (message "Verifying...done")
888 (setq plain (epa--decode-coding-string
890 (or coding-system-for-read
891 (get-text-property start 'epa-coding-system-used)
893 (if (y-or-n-p "Replace the original text? ")
894 (let ((inhibit-read-only t)
896 (delete-region start end)
899 (with-output-to-temp-buffer "*Temp*"
900 (set-buffer standard-output)
903 (if (epg-context-result-for context 'verify)
904 (epa-display-info (epg-verify-result-to-string
905 (epg-context-result-for context 'verify))))))
908 (defun epa-verify-cleartext-in-region (start end)
909 "Verify OpenPGP cleartext signed messages in the current region
910 between START and END.
912 Don't use this command in Lisp programs!
913 See the reason described in the `epa-verify-region' documentation."
917 (narrow-to-region start end)
919 (let (cleartext-start cleartext-end)
920 (while (re-search-forward "-----BEGIN PGP SIGNED MESSAGE-----$"
922 (setq cleartext-start (match-beginning 0))
923 (unless (re-search-forward "^-----BEGIN PGP SIGNATURE-----$"
925 (error "Invalid cleartext signed message"))
926 (setq cleartext-end (re-search-forward
927 "^-----END PGP SIGNATURE-----$"
929 (unless cleartext-end
930 (error "No cleartext tail"))
931 (epa-verify-region cleartext-start cleartext-end))))))
933 (defalias 'epa--select-safe-coding-system
934 (if (fboundp 'select-safe-coding-system)
935 #'select-safe-coding-system
937 buffer-file-coding-system)))
940 (defun epa-sign-region (start end signers mode)
941 "Sign the current region between START and END by SIGNERS keys selected.
943 Don't use this command in Lisp programs!
944 Since this function operates on regions, it does some tricks such
945 as coding-system detection and unibyte/multibyte conversion. If
946 you are sure how the data should be treated, you should consider
947 using the string based counterpart `epg-sign-string', or the file
948 based counterpart `epg-sign-file' instead.
952 \(let ((context (epg-make-context 'OpenPGP)))
955 (encode-coding-string (buffer-substring start end) 'utf-8)))"
957 (let ((verbose current-prefix-arg))
958 (setq epa-last-coding-system-specified
959 (or coding-system-for-write
960 (epa--select-safe-coding-system
961 (region-beginning) (region-end))))
962 (list (region-beginning) (region-end)
964 (epa-select-keys (epg-make-context epa-protocol)
965 "Select keys for signing.
966 If no one is selected, default secret key is used. "
969 (epa--read-signature-type)
972 (let ((context (epg-make-context epa-protocol))
974 ;;(epg-context-set-armor context epa-armor)
975 (epg-context-set-armor context t)
976 ;;(epg-context-set-textmode context epa-textmode)
977 (epg-context-set-textmode context t)
978 (epg-context-set-signers context signers)
979 (epg-context-set-passphrase-callback context
980 #'epa-passphrase-callback-function)
981 (epg-context-set-progress-callback context
983 #'epa-progress-callback-function
985 (message "Signing...")
986 (setq signature (epg-sign-string context
987 (epa--encode-coding-string
988 (buffer-substring start end)
989 epa-last-coding-system-specified)
991 (message "Signing...done")
992 (delete-region start end)
994 (add-text-properties (point)
996 (insert (epa--decode-coding-string
998 (or coding-system-for-read
999 epa-last-coding-system-specified)))
1001 (list 'epa-coding-system-used
1002 epa-last-coding-system-specified
1008 (defalias 'epa--derived-mode-p
1009 (if (fboundp 'derived-mode-p)
1011 (lambda (&rest modes)
1012 "Non-nil if the current major mode is derived from one of MODES.
1013 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1014 (let ((parent major-mode))
1015 (while (and (not (memq parent modes))
1016 (setq parent (get parent 'derived-mode-parent))))
1020 (defun epa-encrypt-region (start end recipients sign signers)
1021 "Encrypt the current region between START and END for RECIPIENTS.
1023 Don't use this command in Lisp programs!
1024 Since this function operates on regions, it does some tricks such
1025 as coding-system detection and unibyte/multibyte conversion. If
1026 you are sure how the data should be treated, you should consider
1027 using the string based counterpart `epg-encrypt-string', or the
1028 file based counterpart `epg-encrypt-file' instead.
1032 \(let ((context (epg-make-context 'OpenPGP)))
1035 (encode-coding-string (buffer-substring start end) 'utf-8)
1038 (let ((verbose current-prefix-arg)
1039 (context (epg-make-context epa-protocol))
1041 (setq epa-last-coding-system-specified
1042 (or coding-system-for-write
1043 (epa--select-safe-coding-system
1044 (region-beginning) (region-end))))
1045 (list (region-beginning) (region-end)
1046 (epa-select-keys context
1047 "Select recipients for encryption.
1048 If no one is selected, symmetric encryption will be performed. ")
1049 (setq sign (if verbose (y-or-n-p "Sign? ")))
1051 (epa-select-keys context
1052 "Select keys for signing. ")))))
1054 (let ((context (epg-make-context epa-protocol))
1056 ;;(epg-context-set-armor context epa-armor)
1057 (epg-context-set-armor context t)
1058 ;;(epg-context-set-textmode context epa-textmode)
1059 (epg-context-set-textmode context t)
1061 (epg-context-set-signers context signers))
1062 (epg-context-set-passphrase-callback context
1063 #'epa-passphrase-callback-function)
1064 (epg-context-set-progress-callback context
1066 #'epa-progress-callback-function
1068 (message "Encrypting...")
1069 (setq cipher (epg-encrypt-string context
1070 (epa--encode-coding-string
1071 (buffer-substring start end)
1072 epa-last-coding-system-specified)
1075 (message "Encrypting...done")
1076 (delete-region start end)
1078 (add-text-properties (point)
1082 (list 'epa-coding-system-used
1083 epa-last-coding-system-specified
1090 (defun epa-delete-keys (keys &optional allow-secret)
1091 "Delete selected KEYS."
1093 (let ((keys (epa--marked-keys)))
1095 (error "No keys selected"))
1097 (eq (nth 1 epa-list-keys-arguments) t))))
1098 (let ((context (epg-make-context epa-protocol)))
1099 (message "Deleting...")
1100 (epg-delete-keys context keys allow-secret)
1101 (message "Deleting...done")
1102 (apply #'epa--list-keys epa-list-keys-arguments)))
1105 (defun epa-import-keys (file)
1106 "Import keys from FILE."
1107 (interactive "fFile: ")
1108 (setq file (expand-file-name file))
1109 (let ((context (epg-make-context epa-protocol)))
1110 (message "Importing %s..." (file-name-nondirectory file))
1113 (epg-import-keys-from-file context file)
1114 (message "Importing %s...done" (file-name-nondirectory file)))
1116 (message "Importing %s...failed" (file-name-nondirectory file))))
1117 (if (epg-context-result-for context 'import)
1118 (epa-display-info (epg-import-result-to-string
1119 (epg-context-result-for context 'import))))
1120 ;; FIXME: Why not use the (otherwise unused) epa--derived-mode-p?
1121 (if (eq major-mode 'epa-key-list-mode)
1122 (apply #'epa--list-keys epa-list-keys-arguments))))
1125 (defun epa-import-keys-region (start end)
1126 "Import keys from the region."
1128 (let ((context (epg-make-context epa-protocol)))
1129 (message "Importing...")
1132 (epg-import-keys-from-string context (buffer-substring start end))
1133 (message "Importing...done"))
1135 (message "Importing...failed")))
1136 (if (epg-context-result-for context 'import)
1137 (epa-display-info (epg-import-result-to-string
1138 (epg-context-result-for context 'import))))))
1141 (defun epa-import-armor-in-region (start end)
1142 "Import keys in the OpenPGP armor format in the current region
1143 between START and END."
1147 (narrow-to-region start end)
1149 (let (armor-start armor-end)
1150 (while (re-search-forward
1151 "-----BEGIN \\(PGP \\(PUBLIC\\|PRIVATE\\) KEY BLOCK\\)-----$"
1153 (setq armor-start (match-beginning 0)
1154 armor-end (re-search-forward
1155 (concat "^-----END " (match-string 1) "-----$")
1158 (error "No armor tail"))
1159 (epa-import-keys-region armor-start armor-end))))))
1162 (defun epa-export-keys (keys file)
1163 "Export selected KEYS to FILE."
1165 (let ((keys (epa--marked-keys))
1168 (error "No keys selected"))
1171 (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
1172 (if epa-armor ".asc" ".gpg"))
1177 (concat "To file (default "
1178 (file-name-nondirectory default-name)
1180 (file-name-directory default-name)
1182 (let ((context (epg-make-context epa-protocol)))
1183 (epg-context-set-armor context epa-armor)
1184 (message "Exporting to %s..." (file-name-nondirectory file))
1185 (epg-export-keys-to-file context keys file)
1186 (message "Exporting to %s...done" (file-name-nondirectory file))))
1189 (defun epa-insert-keys (keys)
1190 "Insert selected KEYS after the point."
1192 (list (epa-select-keys (epg-make-context epa-protocol)
1193 "Select keys to export.
1194 If no one is selected, default public key is exported. ")))
1195 (let ((context (epg-make-context epa-protocol)))
1196 ;;(epg-context-set-armor context epa-armor)
1197 (epg-context-set-armor context t)
1198 (insert (epg-export-keys-to-string context keys))))
1200 ;; (defun epa-sign-keys (keys &optional local)
1201 ;; "Sign selected KEYS.
1202 ;; If a prefix-arg is specified, the signature is marked as non exportable.
1204 ;; Don't use this command in Lisp programs!"
1206 ;; (let ((keys (epa--marked-keys)))
1208 ;; (error "No keys selected"))
1209 ;; (list keys current-prefix-arg)))
1210 ;; (let ((context (epg-make-context epa-protocol)))
1211 ;; (epg-context-set-passphrase-callback context
1212 ;; #'epa-passphrase-callback-function)
1213 ;; (epg-context-set-progress-callback context
1215 ;; #'epa-progress-callback-function
1216 ;; "Signing keys..."))
1217 ;; (message "Signing keys...")
1218 ;; (epg-sign-keys context keys local)
1219 ;; (message "Signing keys...done")))
1220 ;; (make-obsolete 'epa-sign-keys "Do not use.")
1224 ;;; epa.el ends here