1 ;;; pgg.el --- glue for the various PGP implementations.
3 ;; Copyright (C) 1999,2000 Daiki Ueno
5 ;; Author: Daiki Ueno <ueno@ueda.info.waseda.ac.jp>
9 ;; This file is part of SEMI (Secure Emacs MIME Interface).
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.
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.
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.
34 (eval-and-compile (require 'luna))
44 (in-calist-package 'pgg)
46 (defun pgg-field-match-method-with-containment
47 (calist field-type field-value)
48 (let ((s-field (assq field-type calist)))
50 (cons (cons field-type field-value) calist))
51 ((memq (cdr s-field) field-value)
54 (define-calist-field-match-method 'signature-version
55 #'pgg-field-match-method-with-containment)
57 (define-calist-field-match-method 'symmetric-key-algorithm
58 #'pgg-field-match-method-with-containment)
60 (define-calist-field-match-method 'public-key-algorithm
61 #'pgg-field-match-method-with-containment)
63 (define-calist-field-match-method 'hash-algorithm
64 #'pgg-field-match-method-with-containment)
66 (defvar pgg-verify-condition nil
67 "Condition-tree about which PGP implementation is used for verifying.")
69 (defvar pgg-decrypt-condition nil
70 "Condition-tree about which PGP implementation is used for decrypting.")
72 (ctree-set-calist-strictly
74 '((signature-version 3)(public-key-algorithm RSA)(hash-algorithm MD5)
77 (ctree-set-calist-strictly
78 'pgg-decrypt-condition
79 '((public-key-algorithm RSA)(symmetric-key-algorithm IDEA)
82 (ctree-set-calist-strictly
84 '((signature-version 3 4)
85 (public-key-algorithm RSA ELG DSA)
86 (hash-algorithm MD5 SHA1 RIPEMD160)
89 (ctree-set-calist-strictly
90 'pgg-decrypt-condition
91 '((public-key-algorithm RSA ELG DSA)
92 (symmetric-key-algorithm 3DES CAST5 IDEA)
95 (ctree-set-calist-strictly
97 '((signature-version 3 4)
98 (public-key-algorithm ELG-E DSA ELG)
99 (hash-algorithm MD5 SHA1 RIPEMD160)
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)
108 ;;; @ definition of the implementation scheme
112 (luna-define-class pgg-scheme ())
114 (luna-define-internal-accessors 'pgg-scheme))
116 (luna-define-generic pgg-scheme-lookup-key (scheme string &optional type)
117 "Search keys associated with STRING.")
119 (luna-define-generic pgg-scheme-encrypt-region (scheme start end recipients)
120 "Encrypt the current region between START and END.")
122 (luna-define-generic pgg-scheme-decrypt-region (scheme start end)
123 "Decrypt the current region between START and END.")
125 (luna-define-generic pgg-scheme-sign-region
126 (scheme start end &optional cleartext)
127 "Make detached signature from text between START and END.")
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.")
133 (luna-define-generic pgg-scheme-insert-key (scheme)
134 "Insert public key at point.")
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.")
139 ;;; @ utility functions
142 (defvar pgg-fetch-key-function (function pgg-fetch-key-with-w3))
144 (defmacro pgg-make-scheme (scheme)
146 (require (intern (format "pgg-%s" ,scheme)))
147 (funcall (intern (format "pgg-make-scheme-%s"
150 (put 'pgg-save-coding-system 'lisp-indent-function 2)
152 (defmacro pgg-save-coding-system (start end &rest body)
154 (let ((buffer (current-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))))))
164 (narrow-to-region ,start ,end)
167 (defun pgg-temp-buffer-show-function (buffer)
168 (let ((window (split-window-vertically
170 (/ (window-height) 5)))))
171 (set-window-buffer window buffer)))
173 (defun pgg-display-output-buffer (start end status)
176 (delete-region start end)
177 (insert-buffer-substring pgg-output-buffer)
178 (decode-coding-region start (point) buffer-file-coding-system))
179 (let ((temp-buffer-show-function
180 (function pgg-temp-buffer-show-function)))
181 (with-output-to-temp-buffer pgg-echo-buffer
182 (set-buffer standard-output)
183 (insert-buffer-substring pgg-errors-buffer)))))
185 (defvar pgg-passphrase-cache-expiry 16)
186 (defvar pgg-passphrase-cache (make-vector 7 0))
188 (defvar pgg-read-passphrase nil)
189 (defun pgg-read-passphrase (prompt &optional key)
190 (if (not pgg-read-passphrase)
191 (if (functionp 'read-passwd)
192 (setq pgg-read-passphrase 'read-passwd)
193 (if (load "passwd" t)
194 (setq pgg-read-passphrase 'read-passwd)
195 (autoload 'ange-ftp-read-passwd "ange-ftp")
196 (setq pgg-read-passphrase 'ange-ftp-read-passwd))))
197 (or (and pgg-cache-passphrase
198 key (setq key (pgg-truncate-key-identifier key))
199 (symbol-value (intern-soft key pgg-passphrase-cache)))
200 (funcall pgg-read-passphrase prompt)))
202 (defun pgg-add-passphrase-cache (key passphrase)
203 (setq key (pgg-truncate-key-identifier key))
204 (set (intern key pgg-passphrase-cache)
206 (run-at-time pgg-passphrase-cache-expiry nil
207 #'pgg-remove-passphrase-cache
210 (defun pgg-remove-passphrase-cache (key)
211 (let ((passphrase (symbol-value (intern-soft key pgg-passphrase-cache))))
213 (fillarray passphrase ?_)
214 (unintern key pgg-passphrase-cache))))
216 (defmacro pgg-convert-lbt-region (start end lbt)
217 `(let ((pgg-conversion-end (set-marker (make-marker) ,end)))
223 (> (marker-position pgg-conversion-end) (point)))
227 (while (re-search-forward "\r$" pgg-conversion-end t)
228 (replace-match ""))))))
230 (put 'pgg-as-lbt 'lisp-indent-function 3)
232 (defmacro pgg-as-lbt (start end lbt &rest body)
233 `(let ((inhibit-read-only t)
236 (pgg-convert-lbt-region ,start ,end ,lbt)
237 (let ((,end (point)))
239 (push nil buffer-undo-list)
240 (ignore-errors (undo))))
242 (put 'pgg-process-when-success 'lisp-indent-function 0)
244 (defmacro pgg-process-when-success (&rest body)
245 `(with-current-buffer pgg-output-buffer
246 (if (zerop (buffer-size)) nil ,@body t)))
249 ;;; @ interface functions
253 (defun pgg-encrypt-region (start end rcpts)
254 "Encrypt the current region between START and END for RCPTS."
256 (list (region-beginning)(region-end)
257 (split-string (read-string "Recipients: ") "[ \t,]+")))
258 (let* ((entity (pgg-make-scheme pgg-default-scheme))
260 (pgg-save-coding-system start end
261 (pgg-scheme-encrypt-region entity (point-min)(point-max) rcpts))))
262 (when (interactive-p)
263 (pgg-display-output-buffer start end status))
267 (defun pgg-decrypt-region (start end)
268 "Decrypt the current region between START and END."
270 (let* ((packet (cdr (assq 1 (pgg-parse-armor-region start end))))
275 (in-calist-package 'pgg)
276 (ctree-match-calist pgg-decrypt-condition
279 (entity (pgg-make-scheme scheme))
281 (pgg-save-coding-system start end
282 (pgg-scheme-decrypt-region entity (point-min)(point-max)))))
283 (when (interactive-p)
284 (pgg-display-output-buffer start end status))
288 (defun pgg-sign-region (start end &optional cleartext)
289 "Make the signature from text between START and END.
290 If the optional 3rd argument CLEARTEXT is non-nil, it does not create
291 a detached signature."
293 (let* ((entity (pgg-make-scheme pgg-default-scheme))
294 (status (pgg-save-coding-system start end
295 (pgg-scheme-sign-region entity (point-min)(point-max)
296 (or (interactive-p) cleartext)))))
297 (when (interactive-p)
298 (pgg-display-output-buffer start end status))
302 (defun pgg-verify-region (start end &optional signature fetch)
303 "Verify the current region between START and END.
304 If the optional 3rd argument SIGNATURE is non-nil, it is treated as
305 the detached signature of the current region.
307 If the optional 4th argument FETCH is non-nil, we attempt to fetch the
308 signer's public key from `pgg-default-keyserver-address'."
311 (if (null signature) nil
313 (buffer-disable-undo)
314 (set-buffer-multibyte nil)
315 (insert-file-contents signature)
316 (cdr (assq 2 (pgg-decode-armor-region
317 (point-min)(point-max)))))))
322 (in-calist-package 'pgg)
323 (ctree-match-calist pgg-verify-condition
326 (entity (pgg-make-scheme scheme))
327 (key (cdr (assq 'key-identifier packet)))
330 (setq key (concat "0x" (pgg-truncate-key-identifier key)))
331 (null (let ((pgg-scheme scheme))
332 (pgg-lookup-key key)))
333 (or fetch (interactive-p))
334 (y-or-n-p (format "Key %s not found; attempt to fetch? " key))
336 (or (cdr (assq 'preferred-key-server packet))
337 pgg-default-keyserver-address))
338 (pgg-fetch-key keyserver key))
339 (setq status (pgg-save-coding-system start end
340 (pgg-scheme-verify-region entity (point-min)(point-max)
342 (when (interactive-p)
343 (let ((temp-buffer-show-function
344 (function pgg-temp-buffer-show-function)))
345 (with-output-to-temp-buffer pgg-echo-buffer
346 (set-buffer standard-output)
347 (insert-buffer-substring (if status pgg-output-buffer
348 pgg-errors-buffer)))))
352 (defun pgg-insert-key ()
353 "Insert the ASCII armored public key."
355 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
356 (pgg-scheme-insert-key entity)))
359 (defun pgg-snarf-keys-region (start end)
360 "Import public keys in the current region between START and END."
362 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
363 (pgg-save-coding-system start end
364 (pgg-scheme-snarf-keys-region entity start end))))
366 (defun pgg-lookup-key (string &optional type)
367 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
368 (pgg-scheme-lookup-key entity string type)))
370 (defvar pgg-insert-url-function (function pgg-insert-url-with-w3))
372 (defun pgg-insert-url-with-w3 (url)
375 (let (buffer-file-name)
376 (url-insert-file-contents url)))
378 (defvar pgg-insert-url-extra-arguments nil)
379 (defvar pgg-insert-url-program nil)
381 (defun pgg-insert-url-with-program (url)
382 (let ((args (copy-sequence pgg-insert-url-extra-arguments))
387 (apply #'start-process " *PGG url*" (current-buffer)
388 pgg-insert-url-program (nconc args (list url))))
389 (set-process-sentinel process #'ignore)
390 (while (eq 'run (process-status process))
391 (accept-process-output process 5))
392 (delete-process process)
393 (if (and process (eq 'run (process-status process)))
394 (interrupt-process process))
397 (defun pgg-fetch-key (keyserver key)
398 "Attempt to fetch a KEY from KEYSERVER for addition to PGP or GnuPG keyring."
399 (with-current-buffer (get-buffer-create pgg-output-buffer)
400 (buffer-disable-undo)
402 (let ((proto (if (string-match "^[a-zA-Z\\+\\.\\\\-]+:" keyserver)
403 (substring keyserver 0 (1- (match-end 0))))))
405 (funcall pgg-insert-url-function
407 (format "http://%s:11371/pks/lookup?op=get&search=%s"
409 (when (re-search-forward "^-+BEGIN" nil 'last)
410 (delete-region (point-min) (match-beginning 0))
411 (when (re-search-forward "^-+END" nil t)
412 (delete-region (progn (end-of-line) (point))
416 (insert-buffer-substring pgg-output-buffer)
417 (pgg-snarf-keys-region (point-min)(point-max)))))))