pgg.el

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