(mml2015-epg-sign): Save the signing keys in
[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, 2006 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 &optional sign passphrase)
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          (passphrase (or passphrase
139                          (when sign
140                            (pgg-read-passphrase
141                             (format "PGP passphrase for %s: "
142                                     pgg-pgp-user-id)
143                             pgg-pgp-user-id))))
144          (args
145           (append
146            `("+encrypttoself=off +verbose=1" "+batchmode"
147              "+language=us" "-fate"
148              ,@(if recipients
149                    (mapcar (lambda (rcpt) (concat "\"" rcpt "\""))
150                            (append recipients
151                                    (if pgg-encrypt-for-me
152                                        (list pgg-pgp-user-id))))))
153            (if sign '("-s" "-u" pgg-pgp-user-id)))))
154     (pgg-pgp-process-region start end nil pgg-pgp-program args)
155     (pgg-process-when-success nil)))
156
157 (defun pgg-pgp-decrypt-region (start end &optional passphrase)
158   "Decrypt the current region between START and END.
159
160 If optional PASSPHRASE is not specified, it will be obtained from the
161 passphrase cache or user."
162   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
163          (key (pgg-pgp-lookup-key pgg-pgp-user-id 'encrypt))
164          (passphrase
165           (or passphrase
166               (pgg-read-passphrase
167                (format "PGP passphrase for %s: " pgg-pgp-user-id) key)))
168          (args
169           '("+verbose=1" "+batchmode" "+language=us" "-f")))
170     (pgg-pgp-process-region start end passphrase pgg-pgp-program args)
171     (pgg-process-when-success
172       (if pgg-cache-passphrase
173           (pgg-add-passphrase-to-cache key passphrase)))))
174
175 (defun pgg-pgp-sign-region (start end &optional clearsign passphrase)
176   "Make detached signature from text between START and END.
177
178 If optional PASSPHRASE is not specified, it will be obtained from the
179 passphrase cache or user."
180   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
181          (passphrase
182           (or passphrase
183               (pgg-read-passphrase
184                (format "PGP passphrase for %s: " pgg-pgp-user-id)
185                (pgg-pgp-lookup-key pgg-pgp-user-id 'sign))))
186          (args
187           (list (if clearsign "-fast" "-fbast")
188                 "+verbose=1" "+language=us" "+batchmode"
189                 "-u" pgg-pgp-user-id)))
190     (pgg-pgp-process-region start end passphrase pgg-pgp-program args)
191     (pgg-process-when-success
192       (goto-char (point-min))
193       (when (re-search-forward "^-+BEGIN PGP" nil t);XXX
194         (let ((packet
195                (cdr (assq 2 (pgg-parse-armor-region
196                              (progn (beginning-of-line 2)
197                                     (point))
198                              (point-max))))))
199           (if pgg-cache-passphrase
200               (pgg-add-passphrase-to-cache
201                (cdr (assq 'key-identifier packet))
202                passphrase)))))))
203
204 (defun pgg-pgp-verify-region (start end &optional signature)
205   "Verify region between START and END as the detached signature SIGNATURE."
206   (let* ((orig-file (pgg-make-temp-file "pgg"))
207          (args '("+verbose=1" "+batchmode" "+language=us"))
208          (orig-mode (default-file-modes)))
209     (unwind-protect
210         (progn
211           (set-default-file-modes 448)
212           (let ((coding-system-for-write 'binary)
213                 jka-compr-compression-info-list jam-zcat-filename-list)
214             (write-region start end orig-file)))
215       (set-default-file-modes orig-mode))
216     (if (stringp signature)
217         (progn
218           (copy-file signature (setq signature (concat orig-file ".asc")))
219           (setq args (append args (list signature orig-file))))
220       (setq args (append args (list orig-file))))
221     (pgg-pgp-process-region (point)(point) nil pgg-pgp-program args)
222     (delete-file orig-file)
223     (if signature (delete-file signature))
224     (pgg-process-when-success
225       (goto-char (point-min))
226       (let ((case-fold-search t))
227         (while (re-search-forward "^warning: " nil t)
228           (delete-region (match-beginning 0)
229                          (progn (beginning-of-line 2) (point)))))
230       (goto-char (point-min))
231       (when (re-search-forward "^\\.$" nil t)
232         (delete-region (point-min)
233                        (progn (beginning-of-line 2)
234                               (point)))))))
235
236 (defun pgg-pgp-insert-key ()
237   "Insert public key at point."
238   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
239          (args
240           (list "+verbose=1" "+batchmode" "+language=us" "-kxaf"
241                 (concat "\"" pgg-pgp-user-id "\""))))
242     (pgg-pgp-process-region (point)(point) nil pgg-pgp-program args)
243     (insert-buffer-substring pgg-output-buffer)))
244
245 (defun pgg-pgp-snarf-keys-region (start end)
246   "Add all public keys in region between START and END to the keyring."
247   (let* ((pgg-pgp-user-id (or pgg-pgp-user-id pgg-default-user-id))
248          (key-file (pgg-make-temp-file "pgg"))
249          (args
250           (list "+verbose=1" "+batchmode" "+language=us" "-kaf"
251                 key-file)))
252     (let ((coding-system-for-write 'raw-text-dos))
253       (write-region start end key-file))
254     (pgg-pgp-process-region start end nil pgg-pgp-program args)
255     (delete-file key-file)
256     (pgg-process-when-success nil)))
257
258 (provide 'pgg-pgp)
259
260 ;;; arch-tag: 076b7801-37b2-49a6-97c3-218fdecde33c
261 ;;; pgg-pgp.el ends here