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