epa.el

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