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 ;;; Code:
  27
  28 (require 'calist)
  29
  30 (eval-and-compile (require 'luna))
  31
  32 (require 'pgg-def)
  33 (require 'pgg-parse)
  34
  35 (eval-when-compile
  36   (ignore-errors
  37     (require 'w3)
  38     (require 'url)))
  39
  40 (in-calist-package 'pgg)
  41
  42 (defun pgg-field-match-method-with-containment
  43   (calist field-type field-value)
  44   (let ((s-field (assq field-type calist)))
  45     (cond ((null s-field)
  46            (cons (cons field-type field-value) calist)
  47            )
  48           ((memq (cdr s-field) field-value)
  49            calist))))
  50
  51 (define-calist-field-match-method 'signature-version
  52   #'pgg-field-match-method-with-containment)
  53
  54 (define-calist-field-match-method 'symmetric-key-algorithm
  55   #'pgg-field-match-method-with-containment)
  56
  57 (define-calist-field-match-method 'public-key-algorithm
  58   #'pgg-field-match-method-with-containment)
  59
  60 (define-calist-field-match-method 'hash-algorithm
  61   #'pgg-field-match-method-with-containment)
  62
  63 (defvar pgg-verify-condition nil
  64   "Condition-tree about which PGP implementation is used for verifying.")
  65
  66 (defvar pgg-decrypt-condition nil
  67   "Condition-tree about which PGP implementation is used for decrypting.")
  68
  69 (ctree-set-calist-strictly
  70  'pgg-verify-condition
  71  '((signature-version 3)(public-key-algorithm RSA)(hash-algorithm MD5)
  72    (scheme . pgp)))
  73
  74 (ctree-set-calist-strictly
  75  'pgg-decrypt-condition
  76  '((public-key-algorithm RSA)(symmetric-key-algorithm IDEA)
  77    (scheme . pgp)))
  78
  79 (ctree-set-calist-strictly
  80  'pgg-verify-condition
  81  '((signature-version 3 4)
  82    (public-key-algorithm RSA ELG DSA)
  83    (hash-algorithm MD5 SHA1 RIPEMD160)
  84    (scheme . pgp5)))
  85
  86 (ctree-set-calist-strictly
  87  'pgg-decrypt-condition
  88  '((public-key-algorithm RSA ELG DSA)
  89    (symmetric-key-algorithm 3DES CAST5 IDEA)
  90    (scheme . pgp5)))
  91
  92 (ctree-set-calist-strictly
  93  'pgg-verify-condition
  94  '((signature-version 3 4)
  95    (public-key-algorithm ELG-E DSA ELG)
  96    (hash-algorithm MD5 SHA1 RIPEMD160)
  97    (scheme . gpg)))
  98
  99 (ctree-set-calist-strictly
 100  'pgg-decrypt-condition
 101  '((public-key-algorithm ELG-E DSA ELG)
 102    (symmetric-key-algorithm 3DES CAST5 BLOWFISH TWOFISH)
 103    (scheme . gpg)))
 104
 105 ;;; @ definition of the implementation scheme
 106 ;;;
 107
 108 (eval-and-compile
 109   (luna-define-class pgg-scheme ())
 110
 111   (luna-define-internal-accessors 'pgg-scheme)
 112   )
 113
 114 (luna-define-generic lookup-key-string (scheme string &optional type)
 115   "Search keys associated with STRING")
 116
 117 (luna-define-generic encrypt-region (scheme start end recipients)
 118   "Encrypt the current region between START and END.")
 119
 120 (luna-define-generic decrypt-region (scheme start end)
 121   "Decrypt the current region between START and END.")
 122
 123 (luna-define-generic sign-region (scheme start end &optional cleartext)
 124   "Make detached signature from text between START and END.")
 125
 126 (luna-define-generic verify-region (scheme start end &optional signature)
 127   "Verify region between START and END
 128 as the detached signature SIGNATURE.")
 129
 130 (luna-define-generic insert-key (scheme)
 131   "Insert public key at point.")
 132
 133 (luna-define-generic snarf-keys-region (scheme start end)
 134   "Add all public keys in region between START
 135 and END to the keyring.")
 136
 137 ;;; @ interface functions
 138 ;;;
 139
 140 (defvar pgg-fetch-key-function (function pgg-fetch-key-with-w3))
 141
 142 (defmacro pgg-make-scheme (scheme)
 143   `(progn
 144      (require (intern (format "pgg-%s" ,scheme)))
 145      (funcall (intern (format "pgg-make-scheme-%s"
 146                               ,scheme)))))
 147
 148 ;;;###autoload
 149 (defun pgg-encrypt-region (start end rcpts)
 150   (interactive
 151    (list (region-beginning)(region-end)
 152          (split-string (read-string "Recipients: ") "[ \t,]+")))
 153   (let* ((entity (pgg-make-scheme pgg-default-scheme))
 154          (status (luna-send entity 'encrypt-region
 155                             entity start end rcpts)))
 156     (when (interactive-p)
 157       (if status
 158           (progn
 159             (delete-region start end)
 160             (insert-buffer-substring pgg-output-buffer))
 161         (with-output-to-temp-buffer pgg-echo-buffer
 162           (set-buffer standard-output)
 163           (insert-buffer-substring pgg-errors-buffer))))
 164     status))
 165
 166 ;;;###autoload
 167 (defun pgg-decrypt-region (start end)
 168   (interactive "r")
 169   (let* ((packet (cdr (assq 1 (pgg-parse-armor-region start end))))
 170          (scheme
 171           (or pgg-scheme
 172               (cdr (assq 'scheme
 173                          (progn
 174                            (in-calist-package 'pgg)
 175                            (ctree-match-calist pgg-decrypt-condition
 176                                                packet))))
 177               pgg-default-scheme))
 178          (entity (pgg-make-scheme scheme))
 179          (status (luna-send entity 'decrypt-region entity start end)))
 180     (when (interactive-p)
 181       (if status
 182           (progn
 183             (delete-region start end)
 184             (insert-buffer-substring pgg-output-buffer))
 185         (with-output-to-temp-buffer pgg-echo-buffer
 186           (set-buffer standard-output)
 187           (insert-buffer-substring pgg-errors-buffer))))
 188     status))
 189
 190 ;;;###autoload
 191 (defun pgg-sign-region (start end)
 192   (interactive "r")
 193   (let* ((entity (pgg-make-scheme pgg-default-scheme))
 194          (status (luna-send entity 'sign-region
 195                             entity start end (interactive-p))))
 196     (when (interactive-p)
 197       (if status
 198           (progn
 199             (delete-region start end)
 200             (insert-buffer-substring pgg-output-buffer))
 201         (with-output-to-temp-buffer pgg-echo-buffer
 202           (set-buffer standard-output)
 203           (insert-buffer-substring pgg-errors-buffer))))
 204     status))
 205
 206 ;;;###autoload
 207 (defun pgg-verify-region (start end &optional signature fetch)
 208   (interactive "r")
 209   (let* ((packet
 210           (if (null signature) nil
 211             (with-temp-buffer
 212               (buffer-disable-undo)
 213               (set-buffer-multibyte nil)
 214               (insert-file-contents signature)
 215               (cdr (assq 2 (pgg-decode-armor-region (point-min)(point-max))))
 216               )))
 217          (scheme
 218           (or pgg-scheme
 219               (cdr (assq 'scheme
 220                          (progn
 221                            (in-calist-package 'pgg)
 222                            (ctree-match-calist pgg-verify-condition
 223                                                packet))))
 224               pgg-default-scheme))
 225          (entity (pgg-make-scheme scheme))
 226          (key (cdr (assq 'key-identifier packet)))
 227          keyserver
 228          status)
 229     (and (stringp key)
 230          (setq key (concat "0x" (pgg-truncate-key-identifier key)))
 231          (null (let ((pgg-scheme scheme))
 232                  (pgg-lookup-key-string key)))
 233          (or fetch (interactive-p))
 234          (y-or-n-p (format "Key %s not found; attempt to fetch? " key))
 235          (setq keyserver
 236                (or (cdr (assq 'preferred-key-server packet))
 237                    pgg-default-keyserver-address))
 238          (pgg-fetch-key keyserver key))
 239     (setq status (luna-send entity 'verify-region
 240                             entity start end signature))
 241     (when (interactive-p)
 242       (with-output-to-temp-buffer pgg-echo-buffer
 243         (set-buffer standard-output)
 244         (insert-buffer-substring
 245          (if status pgg-output-buffer pgg-errors-buffer))
 246         ))
 247     status))
 248
 249 ;;;###autoload
 250 (defun pgg-insert-key ()
 251   (interactive)
 252   (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
 253     (luna-send entity 'insert-key entity)))
 254
 255 ;;;###autoload
 256 (defun pgg-snarf-keys-region (start end)
 257   (interactive "r")
 258   (let* ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme)))
 259          (status (luna-send entity 'snarf-keys-region entity start end)))
 260     (when (interactive-p)
 261       (with-output-to-temp-buffer pgg-echo-buffer
 262         (set-buffer standard-output)
 263         (insert-buffer-substring
 264          (if status pgg-output-buffer pgg-errors-buffer))
 265         ))
 266     status))
 267
 268 (defun pgg-lookup-key-string (string &optional type)
 269   (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
 270     (luna-send entity 'lookup-key-string entity string type)))
 271
 272 (defvar pgg-insert-url-function  (function pgg-insert-url-with-w3))
 273
 274 (defun pgg-insert-url-with-w3 (url)
 275   (require 'w3)
 276   (require 'url)
 277   (let (buffer-file-name)
 278     (url-insert-file-contents url)))
 279
 280 (defvar pgg-insert-url-extra-arguments nil)
 281 (defvar pgg-insert-url-program nil)
 282
 283 (defun pgg-insert-url-with-program (url)
 284   (let ((args (copy-sequence pgg-insert-url-extra-arguments))
 285         process)
 286     (insert
 287      (with-temp-buffer
 288        (setq process
 289              (apply #'start-process " *PGG url*" (current-buffer)
 290                     pgg-insert-url-program (nconc args (list url))))
 291        (set-process-sentinel process #'ignore)
 292        (while (eq 'run (process-status process))
 293          (accept-process-output process 5))
 294        (delete-process process)
 295        (if (and process (eq 'run (process-status process)))
 296            (interrupt-process process))
 297        (buffer-string)))
 298     ))
 299
 300 (defun pgg-fetch-key (keyserver key)
 301   "Attempt to fetch a key for addition to PGP or GnuPG keyring."
 302   (with-current-buffer (get-buffer-create pgg-output-buffer)
 303     (buffer-disable-undo)
 304     (erase-buffer)
 305     (let ((proto (if (string-match "^[a-zA-Z\\+\\.\\\\-]+:" keyserver)
 306                      (substring keyserver 0 (1- (match-end 0))))))
 307       (save-excursion
 308         (funcall pgg-insert-url-function
 309                  (if proto keyserver
 310                    (format "http://%s:11371/pks/lookup?op=get&search=%s"
 311                            keyserver key))))
 312       (when (re-search-forward "^-+BEGIN" nil 'last)
 313         (delete-region (point-min) (match-beginning 0))
 314         (when (re-search-forward "^-+END" nil t)
 315           (delete-region (progn (end-of-line) (point))
 316                          (point-max)))
 317         (insert "\n")
 318         (with-temp-buffer
 319           (insert-buffer-substring pgg-output-buffer)
 320           (pgg-snarf-keys-region (point-min)(point-max))))
 321       )))
 322
 323
 324 ;;; @ utility functions
 325 ;;;
 326
 327 (defvar pgg-passphrase-cache-expiry 16)
 328 (defvar pgg-passphrase-cache (make-vector 7 0))
 329
 330 (defvar pgg-read-passphrase nil)
 331 (defun pgg-read-passphrase (prompt &optional key)
 332   (if (not pgg-read-passphrase)
 333       (if (functionp 'read-passwd)
 334           (setq pgg-read-passphrase 'read-passwd)
 335         (if (load "passwd" t)
 336             (setq pgg-read-passphrase 'read-passwd)
 337           (autoload 'ange-ftp-read-passwd "ange-ftp")
 338           (setq pgg-read-passphrase 'ange-ftp-read-passwd))))
 339   (or (and key (setq key (pgg-truncate-key-identifier key))
 340            (symbol-value (intern-soft key pgg-passphrase-cache)))
 341       (funcall pgg-read-passphrase prompt)))
 342
 343 (defun pgg-add-passphrase-cache (key passphrase)
 344   (setq key (pgg-truncate-key-identifier key))
 345   (set (intern key pgg-passphrase-cache)
 346        passphrase)
 347   (run-at-time pgg-passphrase-cache-expiry nil
 348                #'pgg-remove-passphrase-cache
 349                key))
 350
 351 (defun pgg-remove-passphrase-cache (key)
 352   (unintern key pgg-passphrase-cache))
 353
 354 (defmacro pgg-convert-lbt-region (start end lbt)
 355   `(let ((pgg-conversion-end (set-marker (make-marker) ,end)))
 356      (goto-char ,start)
 357      (case ,lbt
 358        (CRLF
 359         (while (progn
 360                  (end-of-line)
 361                  (> (marker-position pgg-conversion-end) (point)))
 362           (insert "\r")
 363           (forward-line 1)))
 364        (LF
 365         (while (re-search-forward "\r$" pgg-conversion-end t)
 366           (replace-match ""))))
 367      ))
 368
 369 (put 'pgg-as-lbt 'lisp-indent-function 3)
 370
 371 (defmacro pgg-as-lbt (start end lbt &rest body)
 372   `(let ((inhibit-read-only t)
 373          buffer-read-only
 374          buffer-undo-list)
 375      (pgg-convert-lbt-region ,start ,end ,lbt)
 376      (let ((,end (point)))
 377        ,@body)
 378      (push nil buffer-undo-list)
 379      (undo)))
 380
 381
 382 ;;; @ postprocess macros
 383 ;;;
 384
 385 (put 'pgg-process-when-success 'lisp-indent-function 0)
 386
 387 (defmacro pgg-process-when-success (&rest body)
 388   `(with-current-buffer pgg-output-buffer
 389      (if (zerop (buffer-size)) nil ,@body t)))
 390
 391 (provide 'pgg)
 392
 393 ;;; pgg.el ends here