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
  31 (defgroup epa nil
  32   "The EasyPG Assistant"
  33   :group 'epg)
  34
  35 (defgroup epa-faces nil
  36   "Faces for epa-mode."
  37   :group 'epa)
  38
  39 (defface epa-validity-high-face
  40   '((((class color) (background dark))
  41      (:foreground "PaleTurquoise" :bold t))
  42     (t
  43      (:bold t)))
  44   "Face used for displaying the high validity."
  45   :group 'epa-faces)
  46 (defvar epa-validity-high-face 'epa-validity-high-face)
  47
  48 (defface epa-validity-medium-face
  49   '((((class color) (background dark))
  50      (:foreground "PaleTurquoise" :italic t))
  51     (t
  52      ()))
  53   "Face used for displaying the medium validity."
  54   :group 'epa-faces)
  55 (defvar epa-validity-medium-face 'epa-validity-medium-face)
  56
  57 (defface epa-validity-low-face
  58   '((t
  59      (:italic t)))
  60   "Face used for displaying the low validity."
  61   :group 'epa-faces)
  62 (defvar epa-validity-low-face 'epa-validity-low-face)
  63
  64 (defface epa-validity-disabled-face
  65   '((t
  66      (:italic t :inverse-video t)))
  67   "Face used for displaying the disabled validity."
  68   :group 'epa-faces)
  69 (defvar epa-validity-disabled-face 'epa-validity-disabled-face)
  70
  71 (defface epa-string-face
  72   '((((class color)
  73       (background dark))
  74      (:foreground "lightyellow"))
  75     (((class color)
  76       (background light))
  77      (:foreground "blue4"))
  78     (t
  79      ()))
  80   "Face used for displaying the string."
  81   :group 'epa-faces)
  82 (defvar epa-string-face 'epa-string-face)
  83
  84 (defface epa-mark-face
  85   '((((class color) (background dark))
  86      (:foreground "orange" :bold t))
  87     (t
  88      (:foreground "red" :bold t)))
  89   "Face used for displaying the high validity."
  90   :group 'epa-faces)
  91 (defvar epa-mark-face 'epa-mark-face)
  92
  93 (defface epa-field-name-face
  94   '((((class color) (background dark))
  95      (:foreground "PaleTurquoise" :bold t))
  96     (t (:bold t)))
  97   "Face for the name of the attribute field."
  98   :group 'epa)
  99 (defvar epa-field-name-face 'epa-field-name-face)
 100
 101 (defface epa-field-body-face
 102   '((((class color) (background dark))
 103      (:foreground "turquoise" :italic t))
 104     (t (:italic t)))
 105   "Face for the body of the attribute field."
 106   :group 'epa)
 107 (defvar epa-field-body-face 'epa-field-body-face)
 108
 109 (defcustom epa-validity-face-alist
 110   '((unknown . epa-validity-disabled-face)
 111     (invalid . epa-validity-disabled-face)
 112     (disabled . epa-validity-disabled-face)
 113     (revoked . epa-validity-disabled-face)
 114     (expired . epa-validity-disabled-face)
 115     (none . epa-validity-low-face)
 116     (undefined . epa-validity-low-face)
 117     (never . epa-validity-low-face)
 118     (marginal . epa-validity-medium-face)
 119     (full . epa-validity-high-face)
 120     (ultimate . epa-validity-high-face))
 121   "An alist mapping validity values to faces."
 122   :type 'list
 123   :group 'epa)
 124
 125 (defcustom epa-font-lock-keywords
 126   '(("^\\*"
 127      (0 epa-mark-face))
 128     ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
 129      (1 epa-field-name-face)
 130      (2 epa-field-body-face)))
 131   "Default expressions to addon in epa-mode."
 132   :type '(repeat (list string))
 133   :group 'epa)
 134
 135 (defconst epa-pubkey-algorithm-letter-alist
 136   '((1 . ?R)
 137     (2 . ?r)
 138     (3 . ?s)
 139     (16 . ?g)
 140     (17 . ?D)
 141     (20 . ?G)))
 142
 143 (defvar epa-keys-buffer nil)
 144 (defvar epa-key-buffer-alist nil)
 145 (defvar epa-key nil)
 146 (defvar epa-list-keys-arguments nil)
 147
 148 (defvar epa-keys-mode-map
 149   (let ((keymap (make-sparse-keymap)))
 150     (define-key keymap "m" 'epa-mark)
 151     (define-key keymap "u" 'epa-unmark)
 152     (define-key keymap "d" 'epa-decrypt-file)
 153     (define-key keymap "v" 'epa-verify-file)
 154     (define-key keymap "s" 'epa-sign-file)
 155     (define-key keymap "e" 'epa-encrypt-file)
 156     (define-key keymap "r" 'epa-delete-key)
 157     (define-key keymap "n" 'next-line)
 158     (define-key keymap "p" 'previous-line)
 159     (define-key keymap " " 'scroll-up)
 160     (define-key keymap [delete] 'scroll-down)
 161     (define-key keymap "q" 'bury-buffer)
 162     keymap))
 163
 164 (define-widget 'epa-key 'push-button
 165   "Button for representing a epg-key object."
 166   :format "%[%v%]"
 167   :button-face-get 'epa-key-widget-button-face-get
 168   :value-create 'epa-key-widget-value-create
 169   :action 'epa-key-widget-action
 170   :help-echo 'epa-key-widget-help-echo)
 171
 172 (defun epa-key-widget-action (widget &optional event)
 173   (epa-show-key (widget-get widget :value)))
 174
 175 (defun epa-key-widget-value-create (widget)
 176   (let* ((key (widget-get widget :value))
 177          (primary-sub-key (car (epg-key-sub-key-list key)))
 178          (primary-user-id (car (epg-key-user-id-list key))))
 179     (insert (format "%c "
 180                     (if (epg-sub-key-validity primary-sub-key)
 181                         (car (rassq (epg-sub-key-validity primary-sub-key)
 182                                     epg-key-validity-alist))
 183                       ? ))
 184             (epg-sub-key-id primary-sub-key)
 185             " "
 186             (epg-user-id-name primary-user-id))))
 187
 188 (defun epa-key-widget-button-face-get (widget)
 189   (let ((validity (epg-sub-key-validity (car (epg-key-sub-key-list
 190                                               (widget-get widget :value))))))
 191     (if validity
 192         (cdr (assq validity epa-validity-face-alist))
 193       'default)))
 194
 195 (defun epa-key-widget-help-echo (widget)
 196   (format "Show %s"
 197           (epg-sub-key-id (car (epg-key-sub-key-list
 198                                 (widget-get widget :value))))))
 199
 200 (defun epa-keys-mode ()
 201   "Major mode for `epa-list-keys'."
 202   (kill-all-local-variables)
 203   (buffer-disable-undo)
 204   (setq major-mode 'epa-keys-mode
 205         mode-name "Keys"
 206         truncate-lines t
 207         buffer-read-only t)
 208   (use-local-map epa-keys-mode-map)
 209   (set-keymap-parent (current-local-map) widget-keymap)
 210   (make-local-variable 'font-lock-defaults)
 211   (setq font-lock-defaults '(epa-font-lock-keywords t))
 212   ;; In XEmacs, auto-initialization of font-lock is not effective
 213   ;; if buffer-file-name is not set.
 214   (font-lock-set-defaults)
 215   (widget-setup)
 216   (run-hooks 'epa-keys-mode-hook))
 217
 218 (defvar epa-key-mode-map
 219   (let ((keymap (make-sparse-keymap)))
 220     (define-key keymap "q" 'bury-buffer)
 221     keymap))
 222
 223 (defun epa-key-mode ()
 224   "Major mode for `epa-show-key'."
 225   (kill-all-local-variables)
 226   (buffer-disable-undo)
 227   (setq major-mode 'epa-key-mode
 228         mode-name "Key"
 229         truncate-lines t
 230         buffer-read-only t)
 231   (use-local-map epa-key-mode-map)
 232   (make-local-variable 'font-lock-defaults)
 233   (setq font-lock-defaults '(epa-font-lock-keywords t))
 234   ;; In XEmacs, auto-initialization of font-lock is not effective
 235   ;; if buffer-file-name is not set.
 236   (font-lock-set-defaults)
 237   (run-hooks 'epa-key-mode-hook))
 238
 239 ;;;###autoload
 240 (defun epa-list-keys (&optional name mode)
 241   (interactive
 242    (let ((name (read-string "Pattern: ")))
 243      (list (if (equal name "") nil name)
 244            current-prefix-arg)))
 245   (unless (and epa-keys-buffer
 246                (buffer-live-p epa-keys-buffer))
 247     (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
 248   (set-buffer epa-keys-buffer)
 249   (let ((inhibit-read-only t)
 250         buffer-read-only)
 251     (erase-buffer)
 252     (epa-list-keys-1 name mode)
 253     (epa-keys-mode))
 254   (make-local-variable 'epa-list-keys-arguments)
 255   (setq epa-list-keys-arguments (list name mode))
 256   (goto-char (point-min))
 257   (pop-to-buffer (current-buffer)))
 258
 259 (defun epa-list-keys-1 (name mode)
 260   (let ((inhibit-read-only t)
 261         buffer-read-only
 262         (keys (epg-list-keys name mode))
 263         point)
 264     (while keys
 265       (setq point (point))
 266       (insert "  ")
 267       (put-text-property point (point) 'epa-key (car keys))
 268       (widget-create 'epa-key :value (car keys))
 269       (insert "\n")
 270       (setq keys (cdr keys)))))
 271
 272 (defun epa-select-keys (prompt &optional names)
 273   (save-excursion
 274     (unless (and epa-keys-buffer
 275                  (buffer-live-p epa-keys-buffer))
 276       (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
 277     (let ((inhibit-read-only t)
 278           buffer-read-only
 279           point)
 280       (set-buffer epa-keys-buffer)
 281       (erase-buffer)
 282       (insert prompt "\n")
 283       (widget-create 'link
 284                      :notify (lambda (&rest ignore) (exit-recursive-edit))
 285                      :help-echo
 286                      (substitute-command-keys
 287                       "Click here or \\[exit-recursive-edit] to finish")
 288                      "OK")
 289       (insert "\n\n")
 290       (if names
 291           (while names
 292             (setq point (point))
 293             (epa-list-keys-1 (car names) nil)
 294             (goto-char point)
 295             (epa-mark)
 296             (goto-char (point-max))
 297             (setq names (cdr names)))
 298         (epa-list-keys-1 nil nil))
 299       (epa-keys-mode)
 300       (goto-char (point-min))
 301       (pop-to-buffer (current-buffer))
 302       (unwind-protect
 303           (progn
 304             (recursive-edit)
 305             (save-excursion
 306               (set-buffer epa-keys-buffer)
 307               (goto-char (point-min))
 308               (let (keys key)
 309                 (while (re-search-forward "^\\*" nil t)
 310                   (if (setq key (get-text-property (match-beginning 0)
 311                                                    'epa-key))
 312                       (setq keys (cons key keys))))
 313                 (nreverse keys))))
 314         (if (get-buffer-window epa-keys-buffer)
 315             (delete-window (get-buffer-window epa-keys-buffer)))
 316         (kill-buffer epa-keys-buffer)))))
 317
 318 (defun epa-show-key (key)
 319   (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
 320          (entry (assoc (epg-sub-key-id primary-sub-key)
 321                        epa-key-buffer-alist))
 322          (inhibit-read-only t)
 323          buffer-read-only
 324          pointer)
 325     (unless entry
 326       (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
 327             epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
 328     (unless (and (cdr entry)
 329                  (buffer-live-p (cdr entry)))
 330       (setcdr entry (generate-new-buffer
 331                      (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
 332     (set-buffer (cdr entry))
 333     (make-local-variable 'epa-key)
 334     (setq epa-key key)
 335     (erase-buffer)
 336     (setq pointer (epg-key-user-id-list key))
 337     (while pointer
 338       (insert " "
 339               (if (epg-user-id-validity (car pointer))
 340                   (char-to-string
 341                    (car (rassq (epg-user-id-validity (car pointer))
 342                                epg-key-validity-alist)))
 343                 " ")
 344               " "
 345               (epg-user-id-name (car pointer))
 346               "\n")
 347       (setq pointer (cdr pointer)))
 348     (setq pointer (epg-key-sub-key-list key))
 349     (while pointer
 350       (insert " "
 351               (if (epg-sub-key-validity (car pointer))
 352                   (char-to-string
 353                    (car (rassq (epg-sub-key-validity (car pointer))
 354                                epg-key-validity-alist)))
 355                 " ")
 356               " "
 357               (epg-sub-key-id (car pointer))
 358               " "
 359               (format "%dbits"
 360                       (epg-sub-key-length (car pointer)))
 361               " "
 362               (cdr (assq (epg-sub-key-algorithm (car pointer))
 363                          epg-pubkey-algorithm-alist))
 364               "\n\tCreated: "
 365               (epg-sub-key-creation-time (car pointer))
 366               (if (epg-sub-key-expiration-time (car pointer))
 367                   (format "\n\tExpires: %s" (epg-sub-key-expiration-time
 368                                              (car pointer)))
 369                 "")
 370               "\n\tCapabilities: "
 371               (mapconcat #'symbol-name
 372                          (epg-sub-key-capability (car pointer))
 373                          " ")
 374               "\n\tFingerprint: "
 375               (epg-sub-key-fingerprint (car pointer))
 376               "\n")
 377       (setq pointer (cdr pointer)))
 378     (goto-char (point-min))
 379     (pop-to-buffer (current-buffer))
 380     (epa-key-mode)))
 381
 382 (defun epa-show-key-notify (widget &rest ignore)
 383   (epa-show-key (widget-get widget :value)))
 384
 385 (defun epa-mark (&optional arg)
 386   "Mark the current line."
 387   (interactive "P")
 388   (let ((inhibit-read-only t)
 389         buffer-read-only
 390         properties)
 391     (beginning-of-line)
 392     (setq properties (text-properties-at (point)))
 393     (delete-char 1)
 394     (insert (if arg " " "*"))
 395     (set-text-properties (1- (point)) (point) properties)
 396     (forward-line)))
 397
 398 (defun epa-unmark (&optional arg)
 399   "Unmark the current line."
 400   (interactive "P")
 401   (epa-mark (not arg)))
 402
 403 (defun epa-decrypt-file (file)
 404   (interactive "fFile: ")
 405   (let* ((default-name (file-name-sans-extension file))
 406          (plain (expand-file-name
 407                  (read-file-name
 408                   (concat "To file (default "
 409                           (file-name-nondirectory default-name)
 410                           ") ")
 411                   (file-name-directory default-name)
 412                   default-name)))
 413          (context (epg-make-context)))
 414     (message "Decrypting %s..." (file-name-nondirectory file))
 415     (epg-decrypt-file context file plain)
 416     (message "Decrypting %s...done" (file-name-nondirectory file))))
 417
 418 (defun epa-verify-file (file)
 419   (interactive "fFile: ")
 420   (let* ((context (epg-make-context))
 421          (plain (if (equal (file-name-extension file) "sig")
 422                     (file-name-sans-extension file)))
 423          signature)
 424     (message "Verifying %s..." (file-name-nondirectory file))
 425     (epg-verify-file context file plain)
 426     (setq signature (reverse (epg-context-result-for context 'verify)))
 427     (with-output-to-temp-buffer "*epa-verify-file*"
 428       (set-buffer standard-output)
 429       (while signature
 430         (insert (format "%s: %s %s %s\n"
 431                         (epg-signature-status (car signature))
 432                         (epg-signature-key-id (car signature))
 433                         (epg-signature-user-id (car signature))
 434                         (epg-signature-validity (car signature))))
 435         (setq signature (cdr signature))))
 436     (shrink-window-if-larger-than-buffer
 437      (get-buffer-window "*epa-verify-file*"))
 438     (message "Verifying %s...done" (file-name-nondirectory file))))
 439
 440 (defun epa-sign-file (file detached)
 441   (interactive
 442    (list (expand-file-name (read-file-name "File: "))
 443          (y-or-n-p "Make a detached signature? ")))
 444   (let ((signature (concat file (if detached ".sig" ".gpg")))
 445         (context (epg-make-context)))
 446     (message "Signing %s..." (file-name-nondirectory file))
 447     (epg-sign-file context file signature (not (null detached)))
 448     (message "Signing %s...done" (file-name-nondirectory file))))
 449
 450 (defun epa-encrypt-file (file recipients)
 451   (interactive
 452    (list (expand-file-name (read-file-name "File: "))
 453          (mapcar (lambda (key)
 454                  (epg-sub-key-id
 455                   (car (epg-key-sub-key-list key))))
 456                  (epa-select-keys "Select recipents for encryption.
 457 If no one is selected, symmetric encryption will be performed.  "))))
 458   (let ((cipher (concat file ".gpg"))
 459         (context (epg-make-context)))
 460     (message "Encrypting %s..." (file-name-nondirectory file))
 461     (epg-encrypt-file context
 462                       file
 463                       recipients
 464                       cipher)
 465     (message "Encrypting %s...done" (file-name-nondirectory file))))
 466
 467 (defun epa-delete-key (key)
 468   (interactive
 469    (list
 470     (save-excursion
 471       (beginning-of-line)
 472       (get-text-property (point) 'epa-key))))
 473   (let ((context (epg-make-context)))
 474     (message "Deleting %s..."
 475              (epg-sub-key-id (car (epg-key-sub-key-list key))))
 476     (epg-delete-key context key)
 477     (apply #'epa-list-keys epa-list-keys-arguments)
 478     (message "Deleting %s...done"
 479              (epg-sub-key-id (car (epg-key-sub-key-list key))))))
 480
 481 (provide 'epa)
 482
 483 ;;; epa.el ends here