Revision: miles@gnu.org--gnu-2005/gnus--devo--0--patch-182
[gnus] / lisp / pgg-pgp.el
1 ;;; pgg-pgp.el --- PGP 2.* and 6.* support for PGG.
2
3 ;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
4 ;;   2005 Free Software Foundation, Inc.
5
6 ;; Author: Daiki Ueno <ueno@unixuser.org>
7 ;; Created: 1999/11/02
8 ;; Keywords: PGP, OpenPGP
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26
27 ;;; Code:
28
29 (eval-when-compile
30   (require 'cl)                         ; for pgg macros
31   (require 'pgg))
32
33 (defgroup pgg-pgp ()
34   "PGP 2.* and 6.* interface."
35   :group 'pgg)
36
37 (defcustom pgg-pgp-program "pgp"
38   "PGP 2.* and 6.* executable."
39   :group 'pgg-pgp
40   :type 'string)
41
42 (defcustom pgg-pgp-shell-file-name "/bin/sh"
43   "File name to load inferior shells from.
44 Bourne shell or its equivalent \(not tcsh) is needed for \"2>\"."
45   :group 'pgg-pgp
46   :type 'string)
47
48 (defcustom pgg-pgp-shell-command-switch "-c"
49   "Switch used to have the shell execute its command line argument."
50   :group 'pgg-pgp
51   :type 'string)
52
53 (defcustom pgg-pgp-extra-args nil
54   "Extra arguments for every PGP invocation."
55   :group 'pgg-pgp
56   :type '(choice
57           (const :tag "None" nil)
58           (string :tag "Arguments")))
59
60 (defvar pgg-pgp-user-id nil
61   "PGP ID of your default identity.")
62
63 (defun pgg-pgp-process-region (start end passphrase program args)
64   (let* ((errors-file-name (pgg-make-temp-file "pgg-errors"))
65          (args
66           (append args
67                   pgg-pgp-extra-args
68                   (list (concat "2>" errors-file-name))))
69          (shell-file-name pgg-pgp-shell-file-name)
70          (shell-command-switch pgg-pgp-shell-command-switch)
71          (process-environment process-environment)
72          (output-buffer pgg-output-buffer)
73          (errors-buffer pgg-errors-buffer)
74          (process-connection-type nil)
75          process status exit-status)
76     (with-current-buffer (get-buffer-create output-buffer)
77       (buffer-disable-undo)
78       (erase-buffer))
79     (when passphrase
80       (setenv "PGPPASSFD" "0"))
81     (unwind-protect
82         (progn
83           (let ((coding-system-for-read 'binary)
84                 (coding-system-for-write 'binary))
85             (setq process
86                   (apply #'funcall
87                          #'start-process-shell-command "*PGP*" output-buffer
88                          program args)))
89           (set-process-sentinel process #'ignore)
90           (when passphrase
91             (process-send-string process (concat passphrase "\n")))
92           (process-send-region process start end)
93           (process-send-eof process)
94           (while (eq 'run (process-status process))
95             (accept-process-output process 5))
96           (setq status (process-status process)
97                 exit-status (process-exit-status process))
98           (delete-process process)
99           (with-current-buffer output-buffer
100             (pgg-convert-lbt-region (point-min)(point-max) 'LF)
101
102             (if (memq status '(stop signal))
103                 (error "%s exited abnormally: '%s'" program exit-status))
104             (if (= 127 exit-status)
105                 (error "%s could not be found" program))
106
107             (set-buffer (get-buffer-create errors-buffer))
108             (buffer-disable-undo)
109             (erase-buffer)
110             (insert-file-contents errors-file-name)))
111       (if (and process (eq 'run (process-status process)))
112           (interrupt-process process))
113       (condition-case nil
114           (delete-file errors-file-name)
115         (file-error nil)))))
116
117 (defun pgg-pgp-lookup-key (string &optional type)
118   "Search keys associated with STRING."
119   (let ((args (list "+batchmode" "+language=en" "-kv" string)))
120     (with-current-buffer (get-buffer-create pgg-output-buffer)
121       (buffer-disable-undo)
122       (erase-buffer)
123       (apply #'call-process pgg-pgp-program nil t nil args)
124       (goto-char (point-min))
125       (cond
126        ((re-search-forward "^pub\\s +[0-9]+/" nil t);PGP 2.*
127         (buffer-substring (point)(+ 8 (point))))
128        ((re-search-forward "^Type" nil t);PGP 6.*
129         (beginning-of-line 2)
130         (substring
131          (nth 2 (split-string
132                  (buffer-substring (point)(progn (end-of-line) (point)))))
133          2))))))
134
135 (defun pgg-pgp-encrypt-region (start end recipients)
136   "Encrypt the current region between START and END."
137   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
138          (args
139           `("+encrypttoself=off +verbose=1" "+batchmode"
140             "+language=us" "-fate"
141             ,@(if recipients
142                   (mapcar (lambda (rcpt) (concat "\"" rcpt "\""))
143                           (append recipients
144                                   (if pgg-encrypt-for-me
145                                       (list pgg-pgp-user-id))))))))
146     (pgg-pgp-process-region start end nil pgg-pgp-program args)
147     (pgg-process-when-success nil)))
148
149 (defun pgg-pgp-decrypt-region (start end)
150   "Decrypt the current region between START and END."
151   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
152          (key (pgg-pgp-lookup-key pgg-pgp-user-id 'encrypt))
153          (passphrase
154           (pgg-read-passphrase
155            (format "PGP passphrase for %s: " pgg-pgp-user-id) key))
156          (args
157           '("+verbose=1" "+batchmode" "+language=us" "-f")))
158     (pgg-pgp-process-region start end passphrase pgg-pgp-program args)
159     (pgg-process-when-success
160       (if pgg-cache-passphrase
161           (pgg-add-passphrase-cache key passphrase)))))
162
163 (defun pgg-pgp-sign-region (start end &optional clearsign)
164   "Make detached signature from text between START and END."
165   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
166          (passphrase
167           (pgg-read-passphrase
168            (format "PGP passphrase for %s: " pgg-pgp-user-id)
169            (pgg-pgp-lookup-key pgg-pgp-user-id 'sign)))
170          (args
171           (list (if clearsign "-fast" "-fbast")
172                 "+verbose=1" "+language=us" "+batchmode"
173                 "-u" pgg-pgp-user-id)))
174     (pgg-pgp-process-region start end passphrase pgg-pgp-program args)
175     (pgg-process-when-success
176       (goto-char (point-min))
177       (when (re-search-forward "^-+BEGIN PGP" nil t);XXX
178         (let ((packet
179                (cdr (assq 2 (pgg-parse-armor-region
180                              (progn (beginning-of-line 2)
181                                     (point))
182                              (point-max))))))
183           (if pgg-cache-passphrase
184               (pgg-add-passphrase-cache
185                (cdr (assq 'key-identifier packet))
186                passphrase)))))))
187
188 (defun pgg-pgp-verify-region (start end &optional signature)
189   "Verify region between START and END as the detached signature SIGNATURE."
190   (let* ((orig-file (pgg-make-temp-file "pgg"))
191          (args '("+verbose=1" "+batchmode" "+language=us"))
192          (orig-mode (default-file-modes)))
193     (unwind-protect
194         (progn
195           (set-default-file-modes 448)
196           (let ((coding-system-for-write 'binary)
197                 jka-compr-compression-info-list jam-zcat-filename-list)
198             (write-region start end orig-file)))
199       (set-default-file-modes orig-mode))
200     (if (stringp signature)
201         (progn
202           (copy-file signature (setq signature (concat orig-file ".asc")))
203           (setq args (append args (list signature orig-file))))
204       (setq args (append args (list orig-file))))
205     (pgg-pgp-process-region (point)(point) nil pgg-pgp-program args)
206     (delete-file orig-file)
207     (if signature (delete-file signature))
208     (pgg-process-when-success
209       (goto-char (point-min))
210       (let ((case-fold-search t))
211         (while (re-search-forward "^warning: " nil t)
212           (delete-region (match-beginning 0)
213                          (progn (beginning-of-line 2) (point)))))
214       (goto-char (point-min))
215       (when (re-search-forward "^\\.$" nil t)
216         (delete-region (point-min)
217                        (progn (beginning-of-line 2)
218                               (point)))))))
219
220 (defun pgg-pgp-insert-key ()
221   "Insert public key at point."
222   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
223          (args
224           (list "+verbose=1" "+batchmode" "+language=us" "-kxaf"
225                 (concat "\"" pgg-pgp-user-id "\""))))
226     (pgg-pgp-process-region (point)(point) nil pgg-pgp-program args)
227     (insert-buffer-substring pgg-output-buffer)))
228
229 (defun pgg-pgp-snarf-keys-region (start end)
230   "Add all public keys in region between START and END to the keyring."
231   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
232          (key-file (pgg-make-temp-file "pgg"))
233          (args
234           (list "+verbose=1" "+batchmode" "+language=us" "-kaf"
235                 key-file)))
236     (let ((coding-system-for-write 'raw-text-dos))
237       (write-region start end key-file))
238     (pgg-pgp-process-region start end nil pgg-pgp-program args)
239     (delete-file key-file)
240     (pgg-process-when-success nil)))
241
242 (provide 'pgg-pgp)
243
244 ;;; arch-tag: 076b7801-37b2-49a6-97c3-218fdecde33c
245 ;;; pgg-pgp.el ends here