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    (list (expand-file-name (read-file-name "File: "))
 686          (if current-prefix-arg
 687              (epa-select-keys (epg-make-context epa-protocol)
 688                               "Select keys for signing.
 689 If no one is selected, default secret key is used.  "
 690                               nil t))
 691          (if current-prefix-arg
 692              (epa--read-signature-type)
 693            'clear)))
 694   (let ((signature (concat file
 695                            (if (eq epa-protocol 'OpenPGP)
 696                                (if (or epa-armor
 697                                        (not (memq mode
 698                                                   '(nil t normal detached))))
 699                                    ".asc"
 700                                  (if (memq mode '(t detached))
 701                                      ".sig"
 702                                    ".gpg"))
 703                              (if (memq mode '(t detached))
 704                                  ".p7s"
 705                                ".p7m"))))
 706         (context (epg-make-context epa-protocol)))
 707     (epg-context-set-armor context epa-armor)
 708     (epg-context-set-textmode context epa-textmode)
 709     (epg-context-set-signers context signers)
 710     (epg-context-set-passphrase-callback context
 711                                          #'epa-passphrase-callback-function)
 712     (epg-context-set-progress-callback context
 713                                        #'epa-progress-callback-function
 714                                        (format "Signing %s..."
 715                                                (file-name-nondirectory file)))
 716     (message "Signing %s..." (file-name-nondirectory file))
 717     (epg-sign-file context file signature mode)
 718     (message "Signing %s...wrote %s" (file-name-nondirectory file)
 719              (file-name-nondirectory signature))))
 720
 721 ;;;###autoload
 722 (defun epa-encrypt-file (file recipients)
 723   "Encrypt FILE for RECIPIENTS."
 724   (interactive
 725    (list (expand-file-name (read-file-name "File: "))
 726          (epa-select-keys (epg-make-context epa-protocol)
 727                           "Select recipients for encryption.
 728 If no one is selected, symmetric encryption will be performed.  ")))
 729   (let ((cipher (concat file (if (eq epa-protocol 'OpenPGP)
 730                                  (if epa-armor ".asc" ".gpg")
 731                                ".p7m")))
 732         (context (epg-make-context epa-protocol)))
 733     (epg-context-set-armor context epa-armor)
 734     (epg-context-set-textmode context epa-textmode)
 735     (epg-context-set-passphrase-callback context
 736                                          #'epa-passphrase-callback-function)
 737     (epg-context-set-progress-callback context
 738                                        #'epa-progress-callback-function
 739                                        (format "Encrypting %s..."
 740                                                (file-name-nondirectory file)))
 741     (message "Encrypting %s..." (file-name-nondirectory file))
 742     (epg-encrypt-file context file recipients cipher)
 743     (message "Encrypting %s...wrote %s" (file-name-nondirectory file)
 744              (file-name-nondirectory cipher))))
 745
 746 ;;;###autoload
 747 (defun epa-decrypt-region (start end)
 748   "Decrypt the current region between START and END.
 749
 750 Don't use this command in Lisp programs!"
 751   (interactive "r")
 752   (save-excursion
 753     (let ((context (epg-make-context epa-protocol))
 754           plain)
 755       (epg-context-set-passphrase-callback context
 756                                            #'epa-passphrase-callback-function)
 757       (epg-context-set-progress-callback context
 758                                          #'epa-progress-callback-function
 759                                          "Decrypting...")
 760       (message "Decrypting...")
 761       (setq plain (epg-decrypt-string context (buffer-substring start end)))
 762       (message "Decrypting...done")
 763       (setq plain (epa--decode-coding-string
 764                    plain
 765                    (or coding-system-for-read
 766                        (get-text-property start 'epa-coding-system-used))))
 767       (if (y-or-n-p "Replace the original text? ")
 768           (let ((inhibit-read-only t)
 769                 buffer-read-only)
 770             (delete-region start end)
 771             (goto-char start)
 772             (insert plain))
 773         (let ((epa-popup-info-window t))
 774           (epa-display-info plain)))
 775       (if (epg-context-result-for context 'verify)
 776           (epa-display-info (epg-verify-result-to-string
 777                              (epg-context-result-for context 'verify)))))))
 778
 779 (defun epa--find-coding-system-for-mime-charset (mime-charset)
 780   (if (featurep 'xemacs)
 781       (if (fboundp 'find-coding-system)
 782           (find-coding-system mime-charset))
 783     (let ((pointer (coding-system-list)))
 784       (while (and pointer
 785                   (eq (coding-system-get (car pointer) 'mime-charset)
 786                       mime-charset))
 787         (setq pointer (cdr pointer)))
 788       pointer)))
 789
 790 ;;;###autoload
 791 (defun epa-decrypt-armor-in-region (start end)
 792   "Decrypt OpenPGP armors in the current region between START and END.
 793
 794 Don't use this command in Lisp programs!"
 795   (interactive "r")
 796   (save-excursion
 797     (save-restriction
 798       (narrow-to-region start end)
 799       (goto-char start)
 800       (let (armor-start armor-end)
 801         (while (re-search-forward "-----BEGIN PGP MESSAGE-----$" nil t)
 802           (setq armor-start (match-beginning 0)
 803                 armor-end (re-search-forward "^-----END PGP MESSAGE-----$"
 804                                              nil t))
 805           (unless armor-end
 806             (error "No armor tail"))
 807           (goto-char armor-start)
 808           (let ((coding-system-for-read
 809                  (or coding-system-for-read
 810                      (if (re-search-forward "^Charset: \\(.*\\)" armor-end t)
 811                          (epa--find-coding-system-for-mime-charset
 812                           (intern (downcase (match-string 1))))))))
 813             (epa-decrypt-region armor-start armor-end)))))))
 814
 815 ;;;###autoload
 816 (defun epa-decrypt ()
 817   "Decrypt OpenPGP armors in the current buffer.
 818
 819 Don't use this command in Lisp programs!"
 820   (interactive)
 821   (epa-decrypt-armor-in-region (point-min) (point-max)))
 822
 823 (if (fboundp 'select-safe-coding-system)
 824     (defalias 'epa--select-safe-coding-system 'select-safe-coding-system)
 825   (defun epa--select-safe-coding-system (from to)
 826     buffer-file-coding-system))
 827
 828 ;;;###autoload
 829 (defun epa-verify-region (start end)
 830   "Verify the current region between START and END.
 831
 832 Don't use this command in Lisp programs!"
 833   (interactive "r")
 834   (let ((context (epg-make-context epa-protocol)))
 835     (epg-context-set-progress-callback context
 836                                        #'epa-progress-callback-function
 837                                        "Verifying...")
 838     (epg-verify-string context
 839                        (epa--encode-coding-string
 840                         (buffer-substring start end)
 841                         (or coding-system-for-write
 842                             (get-text-property start
 843                                                'epa-coding-system-used))))
 844     (if (epg-context-result-for context 'verify)
 845         (epa-display-info (epg-verify-result-to-string
 846                            (epg-context-result-for context 'verify))))))
 847
 848 ;;;###autoload
 849 (defun epa-verify-cleartext-in-region (start end)
 850   "Verify OpenPGP cleartext signed messages in the current region
 851 between START and END.
 852
 853 Don't use this command in Lisp programs!"
 854   (interactive "r")
 855   (save-excursion
 856     (save-restriction
 857       (narrow-to-region start end)
 858       (goto-char start)
 859       (let (armor-start armor-end)
 860         (while (re-search-forward "-----BEGIN PGP SIGNED MESSAGE-----$"
 861                                   nil t)
 862           (setq armor-start (match-beginning 0))
 863           (unless (re-search-forward "^-----BEGIN PGP SIGNATURE-----$"
 864                                            nil t)
 865             (error "Invalid cleartext signed message"))
 866           (setq armor-end (re-search-forward
 867                            "^-----END PGP SIGNATURE-----$"
 868                            nil t))
 869           (unless armor-end
 870             (error "No armor tail"))
 871           (epa-verify-region armor-start armor-end))))))
 872
 873 ;;;###autoload
 874 (defun epa-verify ()
 875   "Verify OpenPGP cleartext signed messages in the current buffer.
 876
 877 Don't use this command in Lisp programs!"
 878   (interactive)
 879   (epa-verify-cleartext-in-region (point-min) (point-max)))
 880
 881 ;;;###autoload
 882 (defun epa-sign-region (start end signers mode)
 883   "Sign the current region between START and END by SIGNERS keys selected.
 884
 885 Don't use this command in Lisp programs!"
 886   (interactive
 887    (progn
 888      (setq epa-last-coding-system-specified
 889            (or coding-system-for-write
 890                (epa--select-safe-coding-system
 891                 (region-beginning) (region-end))))
 892      (list (region-beginning) (region-end)
 893            (if current-prefix-arg
 894                (epa-select-keys (epg-make-context epa-protocol)
 895                                 "Select keys for signing.
 896 If no one is selected, default secret key is used.  "
 897                                 nil t))
 898            (if current-prefix-arg
 899                (epa--read-signature-type)
 900              'clear))))
 901   (save-excursion
 902     (let ((context (epg-make-context epa-protocol))
 903           signature)
 904       ;;(epg-context-set-armor context epa-armor)
 905       (epg-context-set-armor context t)
 906       ;;(epg-context-set-textmode context epa-textmode)
 907       (epg-context-set-textmode context t)
 908       (epg-context-set-signers context signers)
 909       (epg-context-set-passphrase-callback context
 910                                            #'epa-passphrase-callback-function)
 911       (epg-context-set-progress-callback context
 912                                          #'epa-progress-callback-function
 913                                          "Signing...")
 914       (message "Signing...")
 915       (setq signature (epg-sign-string context
 916                                        (epa--encode-coding-string
 917                                         (buffer-substring start end)
 918                                         epa-last-coding-system-specified)
 919                                        mode))
 920       (message "Signing...done")
 921       (delete-region start end)
 922       (goto-char start)
 923       (add-text-properties (point)
 924                            (progn
 925                              (insert (epa--decode-coding-string
 926                                       signature
 927                                       (or coding-system-for-read
 928                                           epa-last-coding-system-specified)))
 929                              (point))
 930                            (list 'epa-coding-system-used
 931                                  epa-last-coding-system-specified
 932                                  'front-sticky nil
 933                                  'rear-nonsticky t
 934                                  'start-open t
 935                                  'end-open t)))))
 936
 937 (if (fboundp 'derived-mode-p)
 938     (defalias 'epa--derived-mode-p 'derived-mode-p)
 939   (defun epa--derived-mode-p (&rest modes)
 940     "Non-nil if the current major mode is derived from one of MODES.
 941 Uses the `derived-mode-parent' property of the symbol to trace backwards."
 942     (let ((parent major-mode))
 943       (while (and (not (memq parent modes))
 944                   (setq parent (get parent 'derived-mode-parent))))
 945       parent)))
 946
 947 (defun epa--mail-mode-p ()
 948   (let ((pointer epa-mail-modes))
 949     (while (and pointer
 950                 (epa--derived-mode-p (car pointer)))
 951       (setq pointer (cdr pointer)))
 952     pointer))
 953
 954 ;;;###autoload
 955 (defun epa-sign (start end signers mode)
 956   "Sign the current buffer.
 957
 958 Don't use this command in Lisp programs!"
 959   (interactive
 960    (save-excursion
 961      (goto-char (point-min))
 962      (if (and (epa--mail-mode-p)
 963               (search-forward mail-header-separator nil t))
 964          (forward-line))
 965      (setq epa-last-coding-system-specified
 966            (or coding-system-for-write
 967                (epa--select-safe-coding-system (point) (point-max))))
 968      (list (point) (point-max)
 969            (if current-prefix-arg
 970                (epa-select-keys (epg-make-context epa-protocol)
 971                                 "Select keys for signing.
 972 If no one is selected, default secret key is used.  "
 973                                 nil t))
 974            (if current-prefix-arg
 975                (epa--read-signature-type)
 976              'clear))))
 977   (epa-sign-region start end signers mode))
 978
 979 ;;;###autoload
 980 (defun epa-encrypt-region (start end recipients)
 981   "Encrypt the current region between START and END for RECIPIENTS.
 982
 983 Don't use this command in Lisp programs!"
 984   (interactive
 985    (progn
 986      (setq epa-last-coding-system-specified
 987            (or coding-system-for-write
 988                (epa--select-safe-coding-system
 989                 (region-beginning) (region-end))))
 990      (list (region-beginning) (region-end)
 991            (epa-select-keys (epg-make-context epa-protocol)
 992                             "Select recipients for encryption.
 993 If no one is selected, symmetric encryption will be performed.  "))))
 994   (save-excursion
 995     (let ((context (epg-make-context epa-protocol))
 996           cipher)
 997       ;;(epg-context-set-armor context epa-armor)
 998       (epg-context-set-armor context t)
 999       ;;(epg-context-set-textmode context epa-textmode)
1000       (epg-context-set-textmode context t)
1001       (epg-context-set-passphrase-callback context
1002                                            #'epa-passphrase-callback-function)
1003       (epg-context-set-progress-callback context
1004                                          #'epa-progress-callback-function
1005                                          "Encrypting...")
1006       (message "Encrypting...")
1007       (setq cipher (epg-encrypt-string context
1008                                        (epa--encode-coding-string
1009                                         (buffer-substring start end)
1010                                         epa-last-coding-system-specified)
1011                                        recipients))
1012       (message "Encrypting...done")
1013       (delete-region start end)
1014       (goto-char start)
1015       (add-text-properties (point)
1016                            (progn
1017                              (insert cipher)
1018                              (point))
1019                            (list 'epa-coding-system-used
1020                                  epa-last-coding-system-specified
1021                                  'front-sticky nil
1022                                  'rear-nonsticky t
1023                                  'start-open t
1024                                  'end-open t)))))
1025
1026 ;;;###autoload
1027 (defun epa-encrypt (start end recipients)
1028   "Encrypt the current buffer.
1029
1030 Don't use this command in Lisp programs!"
1031   (interactive
1032    (save-excursion
1033      (let (recipients)
1034        (goto-char (point-min))
1035        (when (epa--mail-mode-p)
1036          (save-restriction
1037            (narrow-to-region (point)
1038                              (if (search-forward mail-header-separator nil 0)
1039                                  (match-beginning 0)
1040                                (point)))
1041            (setq recipients
1042                  (mail-strip-quoted-names
1043                   (mapconcat #'identity
1044                              (nconc (mail-fetch-field "to" nil nil t)
1045                                     (mail-fetch-field "cc" nil nil t)
1046                                     (mail-fetch-field "bcc" nil nil t))
1047                              ","))))
1048          (if recipients
1049              (setq recipients (delete ""
1050                                       (split-string recipients "[ \t\n]+"))))
1051          (goto-char (point-min))
1052          (if (search-forward mail-header-separator nil t)
1053              (forward-line)))
1054        (setq epa-last-coding-system-specified
1055              (or coding-system-for-write
1056                  (epa--select-safe-coding-system (point) (point-max))))
1057        (list (point) (point-max)
1058              (if current-prefix-arg
1059                  (epa-select-keys
1060                   (epg-make-context epa-protocol)
1061                   "Select recipients for encryption.
1062 If no one is selected, symmetric encryption will be performed.  "
1063                   recipients)
1064                (if recipients
1065                    (delq nil
1066                          (apply #'nconc
1067                                 (mapcar
1068                                  (lambda (recipient)
1069                                    (epg-list-keys
1070                                     (epg-make-context epa-protocol)
1071                                     (concat "<" recipient ">")))
1072                                  recipients)))))))))
1073   (epa-encrypt-region start end recipients))
1074
1075 ;;;###autoload
1076 (defun epa-delete-keys (keys &optional allow-secret)
1077   "Delete selected KEYS.
1078
1079 Don't use this command in Lisp programs!"
1080   (interactive
1081    (let ((keys (epa--marked-keys)))
1082      (unless keys
1083        (error "No keys selected"))
1084      (list keys
1085            (eq (nth 1 epa-list-keys-arguments) t))))
1086   (let ((context (epg-make-context epa-protocol)))
1087     (message "Deleting...")
1088     (epg-delete-keys context keys allow-secret)
1089     (message "Deleting...done")
1090     (apply #'epa-list-keys epa-list-keys-arguments)))
1091
1092 ;;;###autoload
1093 (defun epa-import-keys (file)
1094   "Import keys from FILE.
1095
1096 Don't use this command in Lisp programs!"
1097   (interactive "fFile: ")
1098   (setq file (expand-file-name file))
1099   (let ((context (epg-make-context epa-protocol)))
1100     (message "Importing %s..." (file-name-nondirectory file))
1101     (condition-case nil
1102         (progn
1103           (epg-import-keys-from-file context file)
1104           (message "Importing %s...done" (file-name-nondirectory file)))
1105       (error
1106        (message "Importing %s...failed" (file-name-nondirectory file))))
1107     (if (epg-context-result-for context 'import)
1108         (epa-display-info (epg-import-result-to-string
1109                            (epg-context-result-for context 'import))))
1110     (if (eq major-mode 'epa-keys-mode)
1111         (apply #'epa-list-keys epa-list-keys-arguments))))
1112
1113 ;;;###autoload
1114 (defun epa-import-keys-region (start end)
1115   "Import keys from the region.
1116
1117 Don't use this command in Lisp programs!"
1118   (interactive "r")
1119   (let ((context (epg-make-context epa-protocol)))
1120     (message "Importing...")
1121     (condition-case nil
1122         (progn
1123           (epg-import-keys-from-string context (buffer-substring start end))
1124           (message "Importing...done"))
1125       (error
1126        (message "Importing...failed")))
1127     (if (epg-context-result-for context 'import)
1128         (epa-display-info (epg-import-result-to-string
1129                            (epg-context-result-for context 'import))))))
1130
1131 ;;;###autoload
1132 (defun epa-import-armor-in-region (start end)
1133   "Import keys in the OpenPGP armor format in the current region
1134 between START and END.
1135
1136 Don't use this command in Lisp programs!"
1137   (interactive "r")
1138   (save-excursion
1139     (save-restriction
1140       (narrow-to-region start end)
1141       (goto-char start)
1142       (let (armor-start armor-end)
1143         (while (re-search-forward
1144                 "-----BEGIN \\(PGP \\(PUBLIC\\|PRIVATE\\) KEY BLOCK\\)-----$"
1145                 nil t)
1146           (setq armor-start (match-beginning 0)
1147                 armor-end (re-search-forward
1148                            (concat "^-----END " (match-string 1) "-----$")
1149                            nil t))
1150           (unless armor-end
1151             (error "No armor tail"))
1152           (epa-import-keys-region armor-start armor-end))))))
1153
1154 ;;;###autoload
1155 (defun epa-import ()
1156   "Import keys in the OpenPGP armor format in the current buffer.
1157
1158 Don't use this command in Lisp programs!"
1159   (interactive)
1160   (epa-import-armor-in-region (point-min) (point-max)))
1161
1162 ;;;###autoload
1163 (defun epa-export-keys (keys file)
1164   "Export selected KEYS to FILE.
1165
1166 Don't use this command in Lisp programs!"
1167   (interactive
1168    (let ((keys (epa--marked-keys))
1169          default-name)
1170      (unless keys
1171        (error "No keys selected"))
1172      (setq default-name
1173            (expand-file-name
1174             (concat (epg-sub-key-id (car (epg-key-sub-key-list (car keys))))
1175                     (if epa-armor ".asc" ".gpg"))
1176             default-directory))
1177      (list keys
1178            (expand-file-name
1179             (read-file-name
1180              (concat "To file (default "
1181                      (file-name-nondirectory default-name)
1182                      ") ")
1183              (file-name-directory default-name)
1184              default-name)))))
1185   (let ((context (epg-make-context epa-protocol)))
1186     (epg-context-set-armor context epa-armor)
1187     (message "Exporting to %s..." (file-name-nondirectory file))
1188     (epg-export-keys-to-file context keys file)
1189     (message "Exporting to %s...done" (file-name-nondirectory file))))
1190
1191 ;;;###autoload
1192 (defun epa-insert-keys (keys)
1193   "Insert selected KEYS after the point.
1194
1195 Don't use this command in Lisp programs!"
1196   (interactive
1197    (list (epa-select-keys (epg-make-context epa-protocol)
1198                           "Select keys to export.  ")))
1199   (let ((context (epg-make-context epa-protocol)))
1200     ;;(epg-context-set-armor context epa-armor)
1201     (epg-context-set-armor context t)
1202     (insert (epg-export-keys-to-string context keys))))
1203
1204 ;;;###autoload
1205 (defun epa-sign-keys (keys &optional local)
1206   "Sign selected KEYS.
1207 If a prefix-arg is specified, the signature is marked as non exportable.
1208
1209 Don't use this command in Lisp programs!"
1210   (interactive
1211    (let ((keys (epa--marked-keys)))
1212      (unless keys
1213        (error "No keys selected"))
1214      (list keys current-prefix-arg)))
1215   (let ((context (epg-make-context epa-protocol)))
1216     (epg-context-set-passphrase-callback context
1217                                          #'epa-passphrase-callback-function)
1218     (epg-context-set-progress-callback context
1219                                        #'epa-progress-callback-function
1220                                        "Signing keys...")
1221     (message "Signing keys...")
1222     (epg-sign-keys context keys local)
1223     (message "Signing keys...done")))
1224 (make-obsolete 'epa-sign-keys "Do not use.")
1225
1226 (provide 'epa)
1227
1228 ;;; epa.el ends here