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