1 ;;; pgg.el --- glue for the various PGP implementations.
3 ;; Copyright (C) 1999,2000 Free Software Foundation, Inc.
5 ;; Author: Daiki Ueno <ueno@unixuser.org>
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)))
169 (set-window-buffer window buffer)
170 (shrink-window-if-larger-than-buffer window)))
172 (defun pgg-display-output-buffer (start end status)
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)))))
184 (defvar pgg-passphrase-cache-expiry 16)
185 (defvar pgg-passphrase-cache (make-vector 7 0))
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)))
201 (defun pgg-add-passphrase-cache (key passphrase)
202 (setq key (pgg-truncate-key-identifier key))
203 (set (intern key pgg-passphrase-cache)
205 (run-at-time pgg-passphrase-cache-expiry nil
206 #'pgg-remove-passphrase-cache
209 (defun pgg-remove-passphrase-cache (key)
210 (let ((passphrase (symbol-value (intern-soft key pgg-passphrase-cache))))
212 (fillarray passphrase ?_)
213 (unintern key pgg-passphrase-cache))))
215 (defmacro pgg-convert-lbt-region (start end lbt)
216 `(let ((pgg-conversion-end (set-marker (make-marker) ,end)))
222 (> (marker-position pgg-conversion-end) (point)))
226 (while (re-search-forward "\r$" pgg-conversion-end t)
227 (replace-match ""))))))
229 (put 'pgg-as-lbt 'lisp-indent-function 3)
231 (defmacro pgg-as-lbt (start end lbt &rest body)
232 `(let ((inhibit-read-only t)
235 (pgg-convert-lbt-region ,start ,end ,lbt)
236 (let ((,end (point)))
238 (push nil buffer-undo-list)
239 (ignore-errors (undo))))
241 (put 'pgg-process-when-success 'lisp-indent-function 0)
243 (defmacro pgg-process-when-success (&rest body)
244 `(with-current-buffer pgg-output-buffer
245 (if (zerop (buffer-size)) nil ,@body t)))
248 ;;; @ interface functions
252 (defun pgg-encrypt-region (start end rcpts)
253 "Encrypt the current region between START and END for RCPTS."
255 (list (region-beginning)(region-end)
256 (split-string (read-string "Recipients: ") "[ \t,]+")))
257 (let* ((entity (pgg-make-scheme pgg-default-scheme))
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))
266 (defun pgg-decrypt-region (start end)
267 "Decrypt the current region between START and END."
269 (let* ((packet (cdr (assq 1 (pgg-parse-armor-region start end))))
274 (in-calist-package 'pgg)
275 (ctree-match-calist pgg-decrypt-condition
278 (entity (pgg-make-scheme scheme))
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))
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."
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))
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.
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'."
310 (if (null signature) nil
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)))))))
321 (in-calist-package 'pgg)
322 (ctree-match-calist pgg-verify-condition
325 (entity (pgg-make-scheme scheme))
326 (key (cdr (assq 'key-identifier packet)))
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))
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)
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)))))
351 (defun pgg-insert-key ()
352 "Insert the ASCII armored public key."
354 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
355 (pgg-scheme-insert-key entity)))
358 (defun pgg-snarf-keys-region (start end)
359 "Import public keys in the current region between START and END."
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))))
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)))
369 (defvar pgg-insert-url-function (function pgg-insert-url-with-w3))
371 (defun pgg-insert-url-with-w3 (url)
374 (let (buffer-file-name)
375 (url-insert-file-contents url)))
377 (defvar pgg-insert-url-extra-arguments nil)
378 (defvar pgg-insert-url-program nil)
380 (defun pgg-insert-url-with-program (url)
381 (let ((args (copy-sequence pgg-insert-url-extra-arguments))
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))
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)
401 (let ((proto (if (string-match "^[a-zA-Z\\+\\.\\\\-]+:" keyserver)
402 (substring keyserver 0 (1- (match-end 0))))))
404 (funcall pgg-insert-url-function
406 (format "http://%s:11371/pks/lookup?op=get&search=%s"
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))
415 (insert-buffer-substring pgg-output-buffer)
416 (pgg-snarf-keys-region (point-min)(point-max)))))))