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-field-name-face
  85   '((((class color) (background dark))
  86      (:foreground "PaleTurquoise" :bold t))
  87     (t (:bold t)))
  88   "Face for the name of the attribute field."
  89   :group 'epa)
  90 (defvar epa-field-name-face 'epa-field-name-face)
  91
  92 (defface epa-field-body-face
  93   '((((class color) (background dark))
  94      (:foreground "turquoise" :italic t))
  95     (t (:italic t)))
  96   "Face for the body of the attribute field."
  97   :group 'epa)
  98 (defvar epa-field-body-face 'epa-field-body-face)
  99
 100 (defcustom epa-validity-face-alist
 101   '((?o . epa-validity-disabled-face)
 102     (?i . epa-validity-disabled-face)
 103     (?d . epa-validity-disabled-face)
 104     (?r . epa-validity-disabled-face)
 105     (?e . epa-validity-disabled-face)
 106     (?- . epa-validity-low-face)
 107     (?q . epa-validity-low-face)
 108     (?n . epa-validity-low-face)
 109     (?m . epa-validity-medium-face)
 110     (?f . epa-validity-high-face)
 111     (?u . epa-validity-high-face))
 112   "An alist mapping marks on epa-keys-buffer to faces."
 113   :type 'list
 114   :group 'epa)
 115
 116 (defcustom epa-font-lock-keywords
 117   '(("^[* ]\\(\\([oidreqnmfu-]\\) .*\\)"
 118      (1 (cdr (assq (aref (match-string 2) 0)
 119                    epa-validity-face-alist))))
 120     ("^\t\\([^\t:]+:\\)[ \t]*\\(.*\\)$"
 121      (1 epa-field-name-face)
 122      (2 epa-field-body-face)))
 123   "Default expressions to addon in epa-mode."
 124   :type '(repeat (list string))
 125   :group 'epa)
 126
 127 (defconst epa-pubkey-algorithm-letter-alist
 128   '((1 . ?R)
 129     (2 . ?r)
 130     (3 . ?s)
 131     (16 . ?g)
 132     (17 . ?D)
 133     (20 . ?G)))
 134
 135 (defvar epa-keys-buffer nil)
 136 (defvar epa-key-buffer-alist nil)
 137 (defvar epa-key nil)
 138
 139 (defvar epa-keys-mode-map
 140   (let ((keymap (make-sparse-keymap)))
 141     (define-key keymap "m" 'epa-mark)
 142     (define-key keymap "u" 'epa-unmark)
 143     (define-key keymap "d" 'epa-decrypt-file)
 144     (define-key keymap "v" 'epa-verify-file)
 145     (define-key keymap "s" 'epa-sign-file)
 146     (define-key keymap "e" 'epa-encrypt-file)
 147     (define-key keymap "n" 'next-line)
 148     (define-key keymap "p" 'previous-line)
 149     (define-key keymap " " 'scroll-up)
 150     (define-key keymap [delete] 'scroll-down)
 151     (define-key keymap "q" 'bury-buffer)
 152     keymap))
 153
 154 (defun epa-keys-mode ()
 155   "Major mode for `epa-list-keys'."
 156   (kill-all-local-variables)
 157   (buffer-disable-undo)
 158   (setq major-mode 'epa-keys-mode
 159         mode-name "Keys"
 160         truncate-lines t
 161         buffer-read-only t)
 162   (use-local-map epa-keys-mode-map)
 163   (set-keymap-parent (current-local-map) widget-keymap)
 164   (make-local-variable 'font-lock-defaults)
 165   (setq font-lock-defaults '(epa-font-lock-keywords t))
 166   ;; In XEmacs, auto-initialization of font-lock is not effective
 167   ;; if buffer-file-name is not set.
 168   (font-lock-set-defaults)
 169   (widget-setup)
 170   (run-hooks 'epa-keys-mode-hook))
 171
 172 (defvar epa-key-mode-map
 173   (let ((keymap (make-sparse-keymap)))
 174     (define-key keymap "q" 'bury-buffer)
 175     keymap))
 176
 177 (defun epa-key-mode ()
 178   "Major mode for `epa-show-key'."
 179   (kill-all-local-variables)
 180   (buffer-disable-undo)
 181   (setq major-mode 'epa-key-mode
 182         mode-name "Key"
 183         truncate-lines t
 184         buffer-read-only t)
 185   (use-local-map epa-key-mode-map)
 186   (make-local-variable 'font-lock-defaults)
 187   (setq font-lock-defaults '(epa-font-lock-keywords t))
 188   ;; In XEmacs, auto-initialization of font-lock is not effective
 189   ;; if buffer-file-name is not set.
 190   (font-lock-set-defaults)
 191   (run-hooks 'epa-key-mode-hook))
 192
 193 ;;;###autoload
 194 (defun epa-list-keys (&optional name)
 195   (interactive "sPattern: ")
 196   (unless (and epa-keys-buffer
 197                (buffer-live-p epa-keys-buffer))
 198     (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
 199   (set-buffer epa-keys-buffer)
 200   (erase-buffer)
 201   (epa-list-keys-1 name)
 202   (epa-keys-mode)
 203   (goto-char (point-min))
 204   (pop-to-buffer (current-buffer)))
 205
 206 (defun epa-list-keys-1 (name)
 207   (let ((inhibit-read-only t)
 208         buffer-read-only
 209         keys point primary-sub-key primary-user-id)
 210     (setq keys (epg-list-keys name))
 211     (while keys
 212       (setq point (point)
 213             primary-sub-key (car (epg-key-sub-key-list (car keys)))
 214             primary-user-id (car (epg-key-user-id-list (car keys))))
 215       (insert " " (or (char-to-string
 216                        (car (rassq (epg-sub-key-validity primary-sub-key)
 217                                    epg-key-validity-alist)))
 218                       " ") " ")
 219       (widget-create 'link
 220                      :tag (epg-sub-key-id primary-sub-key)
 221                      :notify 'epa-show-key-notify
 222                      :help-echo
 223                      (format "Show key %s"
 224                              (epg-sub-key-id primary-sub-key))
 225                      (car keys))
 226       (insert " " (epg-user-id-name primary-user-id) "\n")
 227       (put-text-property point (point) 'epa-key (car keys))
 228       (setq keys (cdr keys)))))
 229
 230 (defun epa-select-keys (prompt &optional names)
 231   (save-excursion
 232     (unless (and epa-keys-buffer
 233                  (buffer-live-p epa-keys-buffer))
 234       (setq epa-keys-buffer (generate-new-buffer "*Keys*")))
 235     (let ((inhibit-read-only t)
 236           buffer-read-only
 237           point)
 238       (set-buffer epa-keys-buffer)
 239       (erase-buffer)
 240       (insert prompt "\n")
 241       (widget-create 'link
 242                      :notify (lambda (&rest ignore) (exit-recursive-edit))
 243                      :help-echo
 244                      (substitute-command-keys
 245                       "Click here or \\[exit-recursive-edit] to finish")
 246                      "OK")
 247       (insert "\n\n")
 248       (if names
 249           (while names
 250             (setq point (point))
 251             (epa-list-keys-1 (car names))
 252             (goto-char point)
 253             (epa-mark)
 254             (goto-char (point-max))
 255             (setq names (cdr names)))
 256         (epa-list-keys-1 nil))
 257       (epa-keys-mode)
 258       (goto-char (point-min))
 259       (pop-to-buffer (current-buffer))
 260       (unwind-protect
 261           (progn
 262             (recursive-edit)
 263             (save-excursion
 264               (set-buffer epa-keys-buffer)
 265               (goto-char (point-min))
 266               (let (keys key)
 267                 (while (re-search-forward "^\\*" nil t)
 268                   (if (setq key (get-text-property (match-beginning 0)
 269                                                    'epa-key))
 270                       (setq keys (cons key keys))))
 271                 (nreverse keys))))
 272         (if (get-buffer-window epa-keys-buffer)
 273             (delete-window (get-buffer-window epa-keys-buffer)))
 274         (kill-buffer epa-keys-buffer)))))
 275
 276 (defun epa-show-key (key)
 277   (let* ((primary-sub-key (car (epg-key-sub-key-list key)))
 278          (entry (assoc (epg-sub-key-id primary-sub-key)
 279                        epa-key-buffer-alist))
 280          (inhibit-read-only t)
 281          buffer-read-only
 282          pointer)
 283     (unless entry
 284       (setq entry (cons (epg-sub-key-id primary-sub-key) nil)
 285             epa-key-buffer-alist (cons entry epa-key-buffer-alist)))
 286     (unless (and (cdr entry)
 287                  (buffer-live-p (cdr entry)))
 288       (setcdr entry (generate-new-buffer
 289                      (format "*Key*%s" (epg-sub-key-id primary-sub-key)))))
 290     (set-buffer (cdr entry))
 291     (make-local-variable 'epa-key)
 292     (setq epa-key key)
 293     (erase-buffer)
 294     (setq pointer (epg-key-user-id-list key))
 295     (while pointer
 296       (insert " "
 297               (char-to-string
 298                (car (rassq (epg-user-id-validity (car pointer))
 299                            epg-key-validity-alist)))
 300               " "
 301               (epg-user-id-name (car pointer))
 302               "\n")
 303       (setq pointer (cdr pointer)))
 304     (setq pointer (epg-key-sub-key-list key))
 305     (while pointer
 306       (insert " "
 307               (char-to-string
 308                (car (rassq (epg-sub-key-validity (car pointer))
 309                            epg-key-validity-alist)))
 310               " "
 311               (epg-sub-key-id (car pointer))
 312               " "
 313               (format "%dbits"
 314                       (epg-sub-key-length (car pointer)))
 315               " "
 316               (cdr (assq (epg-sub-key-algorithm (car pointer))
 317                          epg-pubkey-algorithm-alist))
 318               "\n\tCreated: "
 319               (epg-sub-key-creation-time (car pointer))
 320               (if (epg-sub-key-expiration-time (car pointer))
 321                   (format "\n\tExpires: %s" (epg-sub-key-expiration-time
 322                                                   (car pointer)))
 323                 "")
 324               "\n\tCapabilities: "
 325               (mapconcat #'symbol-name
 326                          (epg-sub-key-capability (car pointer))
 327                          " ")
 328               "\n\tFingerprint: "
 329               (epg-sub-key-fingerprint (car pointer))
 330               "\n")
 331       (setq pointer (cdr pointer)))
 332     (goto-char (point-min))
 333     (pop-to-buffer (current-buffer))
 334     (epa-key-mode)))
 335
 336 (defun epa-show-key-notify (widget &rest ignore)
 337   (epa-show-key (widget-value widget)))
 338
 339 (defun epa-mark (&optional arg)
 340   "Mark the current line."
 341   (interactive "P")
 342   (let ((inhibit-read-only t)
 343         buffer-read-only
 344         properties)
 345     (beginning-of-line)
 346     (setq properties (text-properties-at (point)))
 347     (delete-char 1)
 348     (insert (if arg " " "*"))
 349     (set-text-properties (1- (point)) (point) properties)
 350     (forward-line)))
 351
 352 (defun epa-unmark (&optional arg)
 353   "Unmark the current line."
 354   (interactive "P")
 355   (epa-mark (not arg)))
 356
 357 (defun epa-decrypt-file (file)
 358   (interactive "fFile: ")
 359   (let* ((default-name (file-name-sans-extension file))
 360          (plain (read-file-name
 361                  (concat "To file (default "
 362                          (file-name-nondirectory default-name)
 363                          ") ")
 364                  (file-name-directory default-name)
 365                  default-name))
 366          (context (epg-make-context)))
 367     (message "Decrypting %s..." (file-name-nondirectory file))
 368     (epg-decrypt-file context file plain)
 369     (message "Decrypting %s...done" (file-name-nondirectory file))))
 370
 371 (defun epa-verify-file (file)
 372   (interactive "fFile: ")
 373   (let* ((context (epg-make-context))
 374          (plain (if (equal (file-name-extension file) "sig")
 375                     (file-name-sans-extension file)))
 376          signature)
 377     (message "Verifying %s..." (file-name-nondirectory file))
 378     (epg-verify-file context file plain)
 379     (setq signature (reverse (epg-context-result-for context 'verify)))
 380     (with-output-to-temp-buffer "*epa-verify-file*"
 381       (set-buffer standard-output)
 382       (while signature
 383         (insert (format "%s: %s %s %s\n"
 384                         (epg-signature-status (car signature))
 385                         (epg-signature-key-id (car signature))
 386                         (epg-signature-user-id (car signature))
 387                         (epg-signature-validity (car signature))))
 388         (setq signature (cdr signature))))
 389     (shrink-window-if-larger-than-buffer
 390      (get-buffer-window "*epa-verify-file*"))
 391     (message "Verifying %s...done" (file-name-nondirectory file))))
 392
 393 (defun epa-sign-file (file detached)
 394   (interactive
 395    (list (expand-file-name (read-file-name "File: "))
 396          current-prefix-arg))
 397   (let ((signature (concat file (if detached ".sig" ".gpg")))
 398         (context (epg-make-context)))
 399     (message "Signing %s..." (file-name-nondirectory file))
 400     (epg-sign-file context file signature)
 401     (message "Signing %s...done" (file-name-nondirectory file))))
 402
 403 (defun epa-encrypt-file (file recipients)
 404   (interactive
 405    (list (expand-file-name (read-file-name "File: "))
 406          (mapcar (lambda (key)
 407                  (epg-sub-key-id
 408                   (car (epg-key-sub-key-list key))))
 409                  (epa-select-keys "Select recipents for encryption.
 410 If no one is selected, symmetric encryption will be performed.  "))))
 411   (let ((cipher (concat file ".gpg"))
 412         (context (epg-make-context)))
 413     (message "Encrypting %s..." (file-name-nondirectory file))
 414     (epg-encrypt-file context
 415                       file
 416                       recipients
 417                       cipher)
 418     (message "Encrypting %s...done" (file-name-nondirectory file))))
 419
 420 (provide 'epa)
 421
 422 ;;; epa.el ends here