1 ;;; pgg.el --- glue for the various PGP implementations.
3 ;; Copyright (C) 1999 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)
52 ((memq (cdr s-field) field-value)
55 (define-calist-field-match-method 'signature-version
56 #'pgg-field-match-method-with-containment)
58 (define-calist-field-match-method 'symmetric-key-algorithm
59 #'pgg-field-match-method-with-containment)
61 (define-calist-field-match-method 'public-key-algorithm
62 #'pgg-field-match-method-with-containment)
64 (define-calist-field-match-method 'hash-algorithm
65 #'pgg-field-match-method-with-containment)
67 (defvar pgg-verify-condition nil
68 "Condition-tree about which PGP implementation is used for verifying.")
70 (defvar pgg-decrypt-condition nil
71 "Condition-tree about which PGP implementation is used for decrypting.")
73 (ctree-set-calist-strictly
75 '((signature-version 3)(public-key-algorithm RSA)(hash-algorithm MD5)
78 (ctree-set-calist-strictly
79 'pgg-decrypt-condition
80 '((public-key-algorithm RSA)(symmetric-key-algorithm IDEA)
83 (ctree-set-calist-strictly
85 '((signature-version 3 4)
86 (public-key-algorithm RSA ELG DSA)
87 (hash-algorithm MD5 SHA1 RIPEMD160)
90 (ctree-set-calist-strictly
91 'pgg-decrypt-condition
92 '((public-key-algorithm RSA ELG DSA)
93 (symmetric-key-algorithm 3DES CAST5 IDEA)
96 (ctree-set-calist-strictly
98 '((signature-version 3 4)
99 (public-key-algorithm ELG-E DSA ELG)
100 (hash-algorithm MD5 SHA1 RIPEMD160)
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)
109 ;;; @ definition of the implementation scheme
113 (luna-define-class pgg-scheme ())
115 (luna-define-internal-accessors 'pgg-scheme)
118 (luna-define-generic lookup-key-string (scheme string &optional type)
119 "Search keys associated with STRING")
121 (luna-define-generic encrypt-region (scheme start end recipients)
122 "Encrypt the current region between START and END.")
124 (luna-define-generic decrypt-region (scheme start end)
125 "Decrypt the current region between START and END.")
127 (luna-define-generic sign-region (scheme start end &optional cleartext)
128 "Make detached signature from text between START and END.")
130 (luna-define-generic verify-region (scheme start end &optional signature)
131 "Verify region between START and END
132 as the detached signature SIGNATURE.")
134 (luna-define-generic insert-key (scheme)
135 "Insert public key at point.")
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.")
141 ;;; @ utility functions
144 (defvar pgg-fetch-key-function (function pgg-fetch-key-with-w3))
146 (defmacro pgg-make-scheme (scheme)
148 (require (intern (format "pgg-%s" ,scheme)))
149 (funcall (intern (format "pgg-make-scheme-%s"
152 (put 'pgg-save-coding-system 'lisp-indent-function 2)
154 (defmacro pgg-save-coding-system (start end &rest body)
156 (let ((buffer (current-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)))
167 (narrow-to-region ,start ,end)
170 (defun pgg-temp-buffer-show-function (buffer)
171 (if (one-window-p (selected-window))
172 (let ((window (split-window-vertically
174 (/ (window-height) 5)))))
175 (set-window-buffer window buffer))
176 (display-buffer buffer)))
178 (defun pgg-display-output-buffer (start end status)
181 (delete-region start end)
182 (insert-buffer-substring pgg-output-buffer)
183 (decode-coding-region start (point) buffer-file-coding-system)
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)))
192 (defvar pgg-passphrase-cache-expiry 16)
193 (defvar pgg-passphrase-cache (make-vector 7 0))
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)))
209 (defun pgg-add-passphrase-cache (key passphrase)
210 (setq key (pgg-truncate-key-identifier key))
211 (set (intern key pgg-passphrase-cache)
213 (run-at-time pgg-passphrase-cache-expiry nil
214 #'pgg-remove-passphrase-cache
217 (defun pgg-remove-passphrase-cache (key)
218 (let ((passphrase (symbol-value (intern key pgg-passphrase-cache))))
219 (fillarray passphrase ?_)
220 (unintern key pgg-passphrase-cache)))
222 (defmacro pgg-convert-lbt-region (start end lbt)
223 `(let ((pgg-conversion-end (set-marker (make-marker) ,end)))
229 (> (marker-position pgg-conversion-end) (point)))
233 (while (re-search-forward "\r$" pgg-conversion-end t)
234 (replace-match ""))))
237 (put 'pgg-as-lbt 'lisp-indent-function 3)
239 (defmacro pgg-as-lbt (start end lbt &rest body)
240 `(let ((inhibit-read-only t)
243 (pgg-convert-lbt-region ,start ,end ,lbt)
244 (let ((,end (point)))
246 (push nil buffer-undo-list)
247 (ignore-errors (undo))))
249 (put 'pgg-process-when-success 'lisp-indent-function 0)
251 (defmacro pgg-process-when-success (&rest body)
252 `(with-current-buffer pgg-output-buffer
253 (if (zerop (buffer-size)) nil ,@body t)))
256 ;;; @ interface functions
260 (defun pgg-encrypt-region (start end rcpts)
261 "Encrypt the current region between START and END for RCPTS."
263 (list (region-beginning)(region-end)
264 (split-string (read-string "Recipients: ") "[ \t,]+")))
265 (let* ((entity (pgg-make-scheme pgg-default-scheme))
266 (status (pgg-save-coding-system start end
267 (luna-send entity 'encrypt-region entity
268 (point-min)(point-max) rcpts))))
269 (when (interactive-p)
270 (pgg-display-output-buffer start end status))
274 (defun pgg-decrypt-region (start end)
275 "Decrypt the current region between START and END."
277 (let* ((packet (cdr (assq 1 (pgg-parse-armor-region start end))))
282 (in-calist-package 'pgg)
283 (ctree-match-calist pgg-decrypt-condition
286 (entity (pgg-make-scheme scheme))
287 (status (pgg-save-coding-system start end
288 (luna-send entity 'decrypt-region entity
289 (point-min)(point-max)))))
290 (when (interactive-p)
291 (pgg-display-output-buffer start end status))
295 (defun pgg-sign-region (start end &optional cleartext)
296 "Make the signature from text between START and END.
297 If the optional 3rd argument CLEARTEXT is non-nil, it does not create
298 a detached signature."
300 (let* ((entity (pgg-make-scheme pgg-default-scheme))
301 (status (pgg-save-coding-system start end
302 (luna-send entity 'sign-region entity
303 (point-min)(point-max)
304 (or (interactive-p) cleartext)))))
305 (when (interactive-p)
306 (pgg-display-output-buffer start end status))
310 (defun pgg-verify-region (start end &optional signature fetch)
311 "Verify the current region between START and END.
312 If the optional 3rd argument SIGNATURE is non-nil, it is treated as
313 the detached signature of the current region.
315 If the optional 4th argument FETCH is non-nil, we attempt to fetch the
316 signer's public key from `pgg-default-keyserver-address'."
319 (if (null signature) nil
321 (buffer-disable-undo)
322 (set-buffer-multibyte nil)
323 (insert-file-contents signature)
324 (cdr (assq 2 (pgg-decode-armor-region (point-min)(point-max))))
330 (in-calist-package 'pgg)
331 (ctree-match-calist pgg-verify-condition
334 (entity (pgg-make-scheme scheme))
335 (key (cdr (assq 'key-identifier packet)))
338 (setq key (concat "0x" (pgg-truncate-key-identifier key)))
339 (null (let ((pgg-scheme scheme))
340 (pgg-lookup-key-string key)))
341 (or fetch (interactive-p))
342 (y-or-n-p (format "Key %s not found; attempt to fetch? " key))
344 (or (cdr (assq 'preferred-key-server packet))
345 pgg-default-keyserver-address))
346 (pgg-fetch-key keyserver key))
347 (setq status (pgg-save-coding-system start end
348 (luna-send entity 'verify-region entity
349 (point-min)(point-max) signature)))
350 (when (interactive-p)
351 (let ((temp-buffer-show-function
352 (function pgg-temp-buffer-show-function)))
353 (with-output-to-temp-buffer pgg-echo-buffer
354 (set-buffer standard-output)
355 (insert-buffer-substring (if status pgg-output-buffer
361 (defun pgg-insert-key ()
362 "Insert the ASCII armored public key."
364 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
365 (luna-send entity 'insert-key entity)))
368 (defun pgg-snarf-keys-region (start end)
369 "Import public keys in the current region between START and END."
371 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
372 (pgg-save-coding-system start end
373 (luna-send entity 'snarf-keys-region entity start end))))
375 (defun pgg-lookup-key-string (string &optional type)
376 (let ((entity (pgg-make-scheme (or pgg-scheme pgg-default-scheme))))
377 (luna-send entity 'lookup-key-string entity string type)))
379 (defvar pgg-insert-url-function (function pgg-insert-url-with-w3))
381 (defun pgg-insert-url-with-w3 (url)
384 (let (buffer-file-name)
385 (url-insert-file-contents url)))
387 (defvar pgg-insert-url-extra-arguments nil)
388 (defvar pgg-insert-url-program nil)
390 (defun pgg-insert-url-with-program (url)
391 (let ((args (copy-sequence pgg-insert-url-extra-arguments))
396 (apply #'start-process " *PGG url*" (current-buffer)
397 pgg-insert-url-program (nconc args (list url))))
398 (set-process-sentinel process #'ignore)
399 (while (eq 'run (process-status process))
400 (accept-process-output process 5))
401 (delete-process process)
402 (if (and process (eq 'run (process-status process)))
403 (interrupt-process process))
407 (defun pgg-fetch-key (keyserver key)
408 "Attempt to fetch a KEY from KEYSERVER for addition to PGP or GnuPG keyring."
409 (with-current-buffer (get-buffer-create pgg-output-buffer)
410 (buffer-disable-undo)
412 (let ((proto (if (string-match "^[a-zA-Z\\+\\.\\\\-]+:" keyserver)
413 (substring keyserver 0 (1- (match-end 0))))))
415 (funcall pgg-insert-url-function
417 (format "http://%s:11371/pks/lookup?op=get&search=%s"
419 (when (re-search-forward "^-+BEGIN" nil 'last)
420 (delete-region (point-min) (match-beginning 0))
421 (when (re-search-forward "^-+END" nil t)
422 (delete-region (progn (end-of-line) (point))
426 (insert-buffer-substring pgg-output-buffer)
427 (pgg-snarf-keys-region (point-min)(point-max))))