pgg.el

   1 ;;; pgg.el --- glue for the various PGP implementations.
   2
   3 ;; Copyright (C) 1999 Daiki Ueno
   4
   5 ;; Author: Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
   6 ;; Created: 1999/10/28
   7 ;; Keywords: PGP
   8
   9 ;; This file is part of SEMI (Secure Emacs MIME Interface).
  10
  11 ;; This program is free software; you can redistribute it and/or
  12 ;; modify it under the terms of the GNU General Public License as
  13 ;; published by the Free Software Foundation; either version 2, or (at
  14 ;; your option) any later version.
  15
  16 ;; This program is distributed in the hope that it will be useful, but
  17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 ;; General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26
  27 ;;; Commentary:
  28 ;;
  29
  30 ;;; Code:
  31
  32 (require 'calist)
  33
  34 (eval-and-compile (require 'luna))
  35
  36 (require 'pgg-def)
  37 (require 'pgg-parse)
  38
  39 (eval-when-compile
  40   (ignore-errors
  41     (require 'w3)
  42     (require 'url)))
  43
  44 (in-calist-package 'pgg)
  45
  46 (defun pgg-field-match-method-with-containment
  47   (calist field-type field-value)
  48   (let ((s-field (assq field-type calist)))
  49     (cond ((null s-field)
  50            (cons (cons field-type field-value) calist)
  51            )
  52           ((memq (cdr s-field) field-value)
  53            calist))))
  54
  55 (define-calist-field-match-method 'signature-version
  56   #'pgg-field-match-method-with-containment)
  57
  58 (define-calist-field-match-method 'symmetric-key-algorithm
  59   #'pgg-field-match-method-with-containment)
  60
  61 (define-calist-field-match-method 'public-key-algorithm
  62   #'pgg-field-match-method-with-containment)
  63
  64 (define-calist-field-match-method 'hash-algorithm
  65   #'pgg-field-match-method-with-containment)
  66
  67 (defvar pgg-verify-condition nil
  68   "Condition-tree about which PGP implementation is used for verifying.")
  69
  70 (defvar pgg-decrypt-condition nil
  71   "Condition-tree about which PGP implementation is used for decrypting.")
  72
  73 (ctree-set-calist-strictly
  74  'pgg-verify-condition
  75  '((signature-version 3)(public-key-algorithm RSA)(hash-algorithm MD5)
  76    (scheme . pgp)))
  77
  78 (ctree-set-calist-strictly
  79  'pgg-decrypt-condition
  80  '((public-key-algorithm RSA)(symmetric-key-algorithm IDEA)
  81    (scheme . pgp)))
  82
  83 (ctree-set-calist-strictly
  84  'pgg-verify-condition
  85  '((signature-version 3 4)
  86    (public-key-algorithm RSA ELG DSA)
  87    (hash-algorithm MD5 SHA1 RIPEMD160)
  88    (scheme . pgp5)))
  89
  90 (ctree-set-calist-strictly
  91  'pgg-decrypt-condition
  92  '((public-key-algorithm RSA ELG DSA)
  93    (symmetric-key-algorithm 3DES CAST5 IDEA)
  94    (scheme . pgp5)))
  95
  96 (ctree-set-calist-strictly
  97  'pgg-verify-condition
  98  '((signature-version 3 4)
  99    (public-key-algorithm ELG-E DSA ELG)
 100    (hash-algorithm MD5 SHA1 RIPEMD160)
 101    (scheme . gpg)))
 102
 103 (ctree-set-calist-strictly
 104  'pgg-decrypt-condition
 105  '((public-key-algorithm ELG-E DSA ELG)
 106    (symmetric-key-algorithm 3DES CAST5 BLOWFISH TWOFISH)
 107    (scheme . gpg)))
 108
 109 ;;; @ definition of the implementation scheme
 110 ;;;
 111
 112 (eval-and-compile
 113   (luna-define-class pgg-scheme ())
 114
 115   (luna-define-internal-accessors 'pgg-scheme)
 116   )
 117
 118 (luna-define-generic lookup-key-string (scheme string &optional type)
 119   "Search keys associated with STRING")
 120
 121 (luna-define-generic encrypt-region (scheme start end recipients)
 122   "Encrypt the current region between START and END.")
 123
 124 (luna-define-generic decrypt-region (scheme start end)
 125   "Decrypt the current region between START and END.")
 126
 127 (luna-define-generic sign-region (scheme start end &optional cleartext)
 128   "Make detached signature from text between START and END.")
 129
 130 (luna-define-generic verify-region (scheme start end &optional signature)
 131   "Verify region between START and END
 132 as the detached signature SIGNATURE.")
 133
 134 (luna-define-generic insert-key (scheme)
 135   "Insert public key at point.")
 136
 137 (luna-define-generic snarf-keys-region (scheme start end)
 138   "Add all public keys in region between START
 139 and END to the keyring.")
 140
 141 ;;; @ utility functions
 142 ;;;
 143
 144 (defvar pgg-fetch-key-function (function pgg-fetch-key-with-w3))
 145
 146 (defmacro pgg-make-scheme (scheme)
 147   `(progn
 148      (require (intern (format "pgg-%s" ,scheme)))
 149      (funcall (intern (format "pgg-make-scheme-%s"
 150                               ,scheme)))))
 151
 152 (put 'pgg-save-coding-system 'lisp-indent-function 2)
 153
 154 (defmacro pgg-save-coding-system (start end &rest body)
 155   `(if (interactive-p)
 156        (let ((buffer (current-buffer)))
 157          (with-temp-buffer
 158            (let (buffer-undo-list)
 159              (insert-buffer-substring buffer ,start ,end)
 160              (encode-coding-region (point-min)(point-max)
 161                                    buffer-file-coding-system)
 162              (prog1 (save-excursion ,@body)
 163                (push nil buffer-undo-list)
 164                (ignore-errors (undo)))
 165              )))
 166      (save-restriction
 167        (narrow-to-region ,start ,end)
 168        ,@body)))
 169
 170 (defun pgg-temp-buffer-show-function (buffer)
 171   (if (one-window-p (selected-window))
 172       (let ((window (split-window-vertically
 173                      (- (window-height)
 174                         (/ (window-height) 5)))))
 175         (set-window-buffer window buffer))
 176     (display-buffer buffer)))
 177
 178 (defun pgg-display-output-buffer (start end status)
 179   (if status
 180       (progn
 181         (delete-region start end)
 182         (insert-buffer-substring pgg-output-buffer)
 183         (decode-coding-region start (point) buffer-file-coding-system)
 184         )
 185     (let ((temp-buffer-show-function
 186            (function pgg-temp-buffer-show-function)))
 187       (with-output-to-temp-buffer pgg-echo-buffer
 188         (set-buffer standard-output)
 189         (insert-buffer-substring pgg-errors-buffer)))
 190     ))
 191
 192 (defvar pgg-passphrase-cache-expiry 16)
 193 (defvar pgg-passphrase-cache (make-vector 7 0))
 194
 195 (defvar pgg-read-passphrase nil)
 196 (defun pgg-read-passphrase (prompt &optional key)
 197   (if (not pgg-read-passphrase)
 198       (if (functionp 'read-passwd)
 199           (setq pgg-read-passphrase 'read-passwd)
 200         (if (load "passwd" t)
 201             (setq pgg-read-passphrase 'read-passwd)
 202           (autoload 'ange-ftp-read-passwd "ange-ftp")
 203           (setq pgg-read-passphrase 'ange-ftp-read-passwd))))
 204   (or (and pgg-cache-passphrase
 205            key (setq key (pgg-truncate-key-identifier key))
 206            (symbol-value (intern-soft key pgg-passphrase-cache)))
 207       (funcall pgg-read-passphrase prompt)))
 208
 209 (defun pgg-add-passphrase-cache (key passphrase)
 210   (setq key (pgg-truncate-key-identifier key))
 211   (set (intern key pgg-passphrase-cache)
 212        passphrase)
 213   (run-at-time pgg-passphrase-cache-expiry nil
 214                #'pgg-remove-passphrase-cache
 215                key))
 216
 217 (defun pgg-remove-passphrase-cache (key)
 218   (let ((passphrase (symbol-value (intern key pgg-passphrase-cache))))
 219     (fillarray passphrase ?_)
 220     (let ((obarray pgg-passphrase-cache))
 221       (makunbound key))
 222     (unintern key pgg-passphrase-cache)))
 223
 224 (defmacro pgg-convert-lbt-region (start end lbt)
 225   `(let ((pgg-conversion-end (set-marker (make-marker) ,end)))
 226      (goto-char ,start)
 227      (case ,lbt
 228        (CRLF
 229         (while (progn
 230                  (end-of-line)
 231                  (> (marker-position pgg-conversion-end) (point)))
 232           (insert "\r")
 233           (forward-line 1)))
 234        (LF
 235         (while (re-search-forward "\r$" pgg-conversion-end t)
 236           (replace-match ""))))
 237      ))
 238
 239 (put 'pgg-as-lbt 'lisp-indent-function 3)
 240
 241 (defmacro pgg-as-lbt (start end lbt &rest body)
 242   `(let ((inhibit-read-only t)
 243          buffer-read-only
 244          buffer-undo-list)
 245      (pgg-convert-lbt-region ,start ,end ,lbt)
 246      (let ((,end (point)))
 247        ,@body)
 248      (push nil buffer-undo-list)
 249      (ignore-errors (undo))))
 250
 251 (put 'pgg-process-when-success 'lisp-indent-function 0)
 252
 253 (defmacro pgg-process-when-success (&rest body)
 254   `(with-current-buffer pgg-output-buffer
 255      (if (zerop (buffer-size)) nil ,@body t)))
 256
 257
 258 ;;; @ interface functions
 259 ;;;
 260
 261 ;;;###autoload
 262 (defun pgg-encrypt-region (start end rcpts)
 263   "Encrypt the current region between START and END for RCPTS."
 264   (interactive
 265    (list (region-beginning)(region-end)
 266          (split-string (read-string "Recipients: ") "[ \t,]+")))
 267   (let* ((entity (pgg-make-scheme pgg-default-scheme))
 268          (status (pgg-save-coding-system start end
 269                    (luna-send entity 'encrypt-region entity
 270                               (point-min)(point-max) rcpts))))
 271     (when (interactive-p)
 272       (pgg-display-output-buffer start end status))
 273     status))
 274
 275 ;;;###autoload
 276 (defun pgg-decrypt-region (start end)
 277   "Decrypt the current region between START and END."
 278   (interactive "r")
 279   (let* ((packet (cdr (assq 1 (pgg-parse-armor-region start end))))
 280          (scheme
 281           (or pgg-scheme
 282               (cdr (assq 'scheme
 283                          (progn
 284                            (in-calist-package 'pgg)
 285                            (ctree-match-calist pgg-decrypt-condition
 286                                                packet))))
 287               pgg-default-scheme))
 288          (entity (pgg-make-scheme scheme))
 289          (status (pgg-save-coding-system start end
 290                    (luna-send entity 'decrypt-region entity
 291                               (point-min)(point-max)))))
 292     (when (interactive-p)
 293       (pgg-display-output-buffer start end status))
 294     status))
 295
 296 ;;;###autoload
 297 (defun pgg-sign-region (start end &optional cleartext)
 298   "Make the signature from text between START and END.
 299 If the optional 3rd argument CLEARTEXT is non-nil, it does not create
 300 a detached signature."
 301   (interactive "r")
 302   (let* ((entity (pgg-make-scheme pgg-default-scheme))
 303          (status (pgg-save-coding-system start end
 304                    (luna-send entity 'sign-region entity
 305                               (point-min)(point-max)
 306                               (or (interactive-p) cleartext)))))
 307     (when (interactive-p)
 308       (pgg-display-output-buffer start end status))
 309     status))
 310
 311 ;;;###autoload
 312 (defun pgg-verify-region (start end &optional signature fetch)
 313   "Verify the current region between START and END.
 314 If the optional 3rd argument SIGNATURE is non-nil, it is treated as
 315 the detached signature of the current region.
 316
 317 If the optional 4th argument FETCH is non-nil, we attempt to fetch the
 318 signer's public key from `pgg-default-keyserver-address'."
 319   (interactive "r")
 320   (let* ((packet
 321           (if (null signature) nil
 322             (with-temp-buffer
 323               (buffer-disable-undo)
 324               (set-buffer-multibyte nil)
 325               (insert-file-contents signature)
 326               (cdr (assq 2 (pgg-decode-armor-region (point-min)(point-max))))
 327               )))
 328          (scheme
 329           (or pgg-scheme
 330               (cdr (assq 'scheme
 331                          (progn
 332                            (in-calist-package 'pgg)
 333                            (ctree-match-calist pgg-verify-condition
 334                                                packet))))
 335               pgg-default-scheme))
 336          (entity (pgg-make-scheme scheme))
 337          (key (cdr (assq 'key-identifier packet)))
 338          status keyserver)
 339     (and (stringp key)
 340          (setq key (concat "0x" (pgg-truncate-key-identifier key)))
 341          (null (let ((pgg-scheme scheme))
 342                  (pgg-lookup-key-string key)))
 343          (or fetch (interactive-p))
 344          (y-or-n-p (format "Key %s not found; attempt to fetch? " key))
 345          (setq keyserver
 346                (or (cdr (assq 'preferred-key-server packet))
 347                    pgg-default-keyserver-address))
 348          (pgg-fetch-key keyserver key))
 349     (setq status (pgg-save-coding-system start end
 350                    (luna-send entity 'verify-region entity
 351                               (point-min)(point-max) signature)))
 352     (when (interactive-p)
 353       (let ((temp-buffer-show-function
 354              (function pgg-temp-buffer-show-function)))
 355         (with-output-to-temp-buffer pgg-echo-buffer
 356           (set-buffer standard-output)
 357           (insert-buffer-substring (if status pgg-output-buffer
 358                                      pgg-errors-buffer))
 359           )))
 360     status))
 361
 362 ;;;###autoload
 363 (defun pgg-insert-key ()
 364   "Insert the ASCII armored public key."
 365   (interactive)
 366   (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
 367     (luna-send entity 'insert-key entity)))
 368
 369 ;;;###autoload
 370 (defun pgg-snarf-keys-region (start end)
 371   "Import public keys in the current region between START and END."
 372   (interactive "r")
 373   (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
 374     (pgg-save-coding-system start end
 375       (luna-send entity 'snarf-keys-region entity start end))))
 376
 377 (defun pgg-lookup-key-string (string &optional type)
 378   (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
 379     (luna-send entity 'lookup-key-string entity string type)))
 380
 381 (defvar pgg-insert-url-function  (function pgg-insert-url-with-w3))
 382
 383 (defun pgg-insert-url-with-w3 (url)
 384   (require 'w3)
 385   (require 'url)
 386   (let (buffer-file-name)
 387     (url-insert-file-contents url)))
 388
 389 (defvar pgg-insert-url-extra-arguments nil)
 390 (defvar pgg-insert-url-program nil)
 391
 392 (defun pgg-insert-url-with-program (url)
 393   (let ((args (copy-sequence pgg-insert-url-extra-arguments))
 394         process)
 395     (insert
 396      (with-temp-buffer
 397        (setq process
 398              (apply #'start-process " *PGG url*" (current-buffer)
 399                     pgg-insert-url-program (nconc args (list url))))
 400        (set-process-sentinel process #'ignore)
 401        (while (eq 'run (process-status process))
 402          (accept-process-output process 5))
 403        (delete-process process)
 404        (if (and process (eq 'run (process-status process)))
 405            (interrupt-process process))
 406        (buffer-string)))
 407     ))
 408
 409 (defun pgg-fetch-key (keyserver key)
 410   "Attempt to fetch a KEY from KEYSERVER for addition to PGP or GnuPG keyring."
 411   (with-current-buffer (get-buffer-create pgg-output-buffer)
 412     (buffer-disable-undo)
 413     (erase-buffer)
 414     (let ((proto (if (string-match "^[a-zA-Z\\+\\.\\\\-]+:" keyserver)
 415                      (substring keyserver 0 (1- (match-end 0))))))
 416       (save-excursion
 417         (funcall pgg-insert-url-function
 418                  (if proto keyserver
 419                    (format "http://%s:11371/pks/lookup?op=get&search=%s"
 420                            keyserver key))))
 421       (when (re-search-forward "^-+BEGIN" nil 'last)
 422         (delete-region (point-min) (match-beginning 0))
 423         (when (re-search-forward "^-+END" nil t)
 424           (delete-region (progn (end-of-line) (point))
 425                          (point-max)))
 426         (insert "\n")
 427         (with-temp-buffer
 428           (insert-buffer-substring pgg-output-buffer)
 429           (pgg-snarf-keys-region (point-min)(point-max))))
 430       )))
 431
 432
 433 (provide 'pgg)
 434
 435 ;;; pgg.el ends here