Mercurial > emacs
annotate lisp/epa-file.el @ 111502:df6573cbdd34
* lisp/emacs-lisp/pcase.el (pcase-let*, pcase-let): Add debug and
indentation specs.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Thu, 11 Nov 2010 20:35:06 -0500 |
parents | beddb591d182 |
children | c6bcd9fc6536 |
rev | line source |
---|---|
91647 | 1 ;;; epa-file.el --- the EasyPG Assistant, transparent file encryption |
106815 | 2 ;; Copyright (C) 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
91647 | 3 |
4 ;; Author: Daiki Ueno <ueno@unixuser.org> | |
5 ;; Keywords: PGP, GnuPG | |
110015
280c8ae2476d
Add "Package:" file headers to denote built-in packages.
Chong Yidong <cyd@stupidchicken.com>
parents:
109535
diff
changeset
|
6 ;; Package: epa |
91647 | 7 |
8 ;; This file is part of GNU Emacs. | |
9 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94512
diff
changeset
|
10 ;; GNU Emacs is free software: you can redistribute it and/or modify |
91647 | 11 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94512
diff
changeset
|
12 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94512
diff
changeset
|
13 ;; (at your option) any later version. |
91647 | 14 |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94512
diff
changeset
|
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
91647 | 22 |
23 ;;; Code: | |
24 | |
25 (require 'epa) | |
94755
14eda1195ec3
Provide/require epa-hook, not epa-file-hook.
Eli Zaretskii <eliz@gnu.org>
parents:
94678
diff
changeset
|
26 (require 'epa-hook) |
91647 | 27 |
28 (defcustom epa-file-cache-passphrase-for-symmetric-encryption nil | |
105120
e9b2a988e884
(epa-file-cache-passphrase-for-symmetric-encryption):
Daiki Ueno <ueno@unixuser.org>
parents:
103016
diff
changeset
|
29 "If non-nil, cache passphrase for symmetric encryption. |
e9b2a988e884
(epa-file-cache-passphrase-for-symmetric-encryption):
Daiki Ueno <ueno@unixuser.org>
parents:
103016
diff
changeset
|
30 |
e9b2a988e884
(epa-file-cache-passphrase-for-symmetric-encryption):
Daiki Ueno <ueno@unixuser.org>
parents:
103016
diff
changeset
|
31 For security reasons, this option is turned off by default and |
105121 | 32 not recommended to use. Instead, consider using public-key |
33 encryption with gpg-agent which does the same job in a safer | |
34 way." | |
91647 | 35 :type 'boolean |
36 :group 'epa-file) | |
37 | |
38 (defcustom epa-file-select-keys nil | |
39 "If non-nil, always asks user to select recipients." | |
40 :type 'boolean | |
41 :group 'epa-file) | |
42 | |
43 (defvar epa-file-passphrase-alist nil) | |
44 | |
45 (eval-and-compile | |
46 (if (fboundp 'encode-coding-string) | |
47 (defalias 'epa-file--encode-coding-string 'encode-coding-string) | |
48 (defalias 'epa-file--encode-coding-string 'identity))) | |
49 | |
50 (eval-and-compile | |
51 (if (fboundp 'decode-coding-string) | |
52 (defalias 'epa-file--decode-coding-string 'decode-coding-string) | |
53 (defalias 'epa-file--decode-coding-string 'identity))) | |
54 | |
55 (defun epa-file-passphrase-callback-function (context key-id file) | |
56 (if (and epa-file-cache-passphrase-for-symmetric-encryption | |
57 (eq key-id 'SYM)) | |
58 (progn | |
59 (setq file (file-truename file)) | |
60 (let ((entry (assoc file epa-file-passphrase-alist)) | |
61 passphrase) | |
62 (or (copy-sequence (cdr entry)) | |
63 (progn | |
64 (unless entry | |
65 (setq entry (list file) | |
66 epa-file-passphrase-alist | |
67 (cons entry | |
68 epa-file-passphrase-alist))) | |
69 (setq passphrase (epa-passphrase-callback-function context | |
110899 | 70 key-id |
71 file)) | |
91647 | 72 (setcdr entry (copy-sequence passphrase)) |
73 passphrase)))) | |
110899 | 74 (epa-passphrase-callback-function context key-id file))) |
91647 | 75 |
94512
d10cd2d8d9ae
* epa-file-hook.el: New file split from epa-file.el.
Daiki Ueno <ueno@unixuser.org>
parents:
94423
diff
changeset
|
76 ;;;###autoload |
91647 | 77 (defun epa-file-handler (operation &rest args) |
94423
3898a5665f50
Daiki Ueno <ueno at unixuser.org>
Glenn Morris <rgm@gnu.org>
parents:
94419
diff
changeset
|
78 (save-match-data |
3898a5665f50
Daiki Ueno <ueno at unixuser.org>
Glenn Morris <rgm@gnu.org>
parents:
94419
diff
changeset
|
79 (let ((op (get operation 'epa-file))) |
3898a5665f50
Daiki Ueno <ueno at unixuser.org>
Glenn Morris <rgm@gnu.org>
parents:
94419
diff
changeset
|
80 (if op |
3898a5665f50
Daiki Ueno <ueno at unixuser.org>
Glenn Morris <rgm@gnu.org>
parents:
94419
diff
changeset
|
81 (apply op args) |
3898a5665f50
Daiki Ueno <ueno at unixuser.org>
Glenn Morris <rgm@gnu.org>
parents:
94419
diff
changeset
|
82 (epa-file-run-real-handler operation args))))) |
3898a5665f50
Daiki Ueno <ueno at unixuser.org>
Glenn Morris <rgm@gnu.org>
parents:
94419
diff
changeset
|
83 |
91647 | 84 (defun epa-file-run-real-handler (operation args) |
85 (let ((inhibit-file-name-handlers | |
86 (cons 'epa-file-handler | |
87 (and (eq inhibit-file-name-operation operation) | |
88 inhibit-file-name-handlers))) | |
89 (inhibit-file-name-operation operation)) | |
90 (apply operation args))) | |
91 | |
92 (defun epa-file-decode-and-insert (string file visit beg end replace) | |
93 (if (fboundp 'decode-coding-inserted-region) | |
94 (save-restriction | |
95 (narrow-to-region (point) (point)) | |
103016
15551118906e
epa-file: fix garble with decode-coding-inserted-region
Daiki Ueno <ueno@unixuser.org>
parents:
100908
diff
changeset
|
96 (insert (if enable-multibyte-characters |
15551118906e
epa-file: fix garble with decode-coding-inserted-region
Daiki Ueno <ueno@unixuser.org>
parents:
100908
diff
changeset
|
97 (string-to-multibyte string) |
15551118906e
epa-file: fix garble with decode-coding-inserted-region
Daiki Ueno <ueno@unixuser.org>
parents:
100908
diff
changeset
|
98 string)) |
91647 | 99 (decode-coding-inserted-region |
100 (point-min) (point-max) | |
101 (substring file 0 (string-match epa-file-name-regexp file)) | |
103016
15551118906e
epa-file: fix garble with decode-coding-inserted-region
Daiki Ueno <ueno@unixuser.org>
parents:
100908
diff
changeset
|
102 visit beg end replace)) |
91647 | 103 (insert (epa-file--decode-coding-string string (or coding-system-for-read |
104 'undecided))))) | |
105 | |
109166
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
106 (defvar epa-file-error nil) |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
107 (defun epa-file--find-file-not-found-function () |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
108 (let ((error epa-file-error)) |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
109 (save-window-excursion |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
110 (kill-buffer)) |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
111 (signal 'file-error |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
112 (cons "Opening input file" (cdr error))))) |
b70c159d9e1e
Prevent find-file from opening empty buffer when decryptin failed (bug#6568).
Daiki Ueno <ueno@unixuser.org>
parents:
106815
diff
changeset
|
113 |
91647 | 114 (defvar last-coding-system-used) |
115 (defun epa-file-insert-file-contents (file &optional visit beg end replace) | |
116 (barf-if-buffer-read-only) | |
117 (if (and visit (or beg end)) | |
118 (error "Attempt to visit less than an entire file")) | |
119 (setq file (expand-file-name file)) | |
120 (let* ((local-copy | |
98409
cb5ef7767703
(epa-file-insert-file-contents): Fix typo.
Daiki Ueno <ueno@unixuser.org>
parents:
95478
diff
changeset
|
121 (condition-case nil |
91647 | 122 (epa-file-run-real-handler #'file-local-copy (list file)) |
123 (error))) | |
124 (local-file (or local-copy file)) | |
125 (context (epg-make-context)) | |
126 string length entry) | |
100456
e4798aef9a53
* epa-file.el (epa-file-insert-file-contents): Set
Daiki Ueno <ueno@unixuser.org>
parents:
100304
diff
changeset
|
127 (if visit |
e4798aef9a53
* epa-file.el (epa-file-insert-file-contents): Set
Daiki Ueno <ueno@unixuser.org>
parents:
100304
diff
changeset
|
128 (setq buffer-file-name file)) |
91647 | 129 (epg-context-set-passphrase-callback |
130 context | |
131 (cons #'epa-file-passphrase-callback-function | |
132 local-file)) | |
133 (epg-context-set-progress-callback context | |
134 #'epa-progress-callback-function) | |
135 (unwind-protect | |
136 (progn | |
137 (if replace | |
138 (goto-char (point-min))) | |
139 (condition-case error | |
140 (setq string (epg-decrypt-file context local-file nil)) | |
141 (error | |
142 (if (setq entry (assoc file epa-file-passphrase-alist)) | |
143 (setcdr entry nil)) | |
109535 | 144 ;; Hack to prevent find-file from opening empty buffer |
145 ;; when decryption failed (bug#6568). See the place | |
146 ;; where `find-file-not-found-functions' are called in | |
147 ;; `find-file-noselect-1'. | |
109534
52f611292230
Fix *.gpg file creation (bug#6723).
Daiki Ueno <ueno@unixuser.org>
parents:
109166
diff
changeset
|
148 (when (file-exists-p local-file) |
52f611292230
Fix *.gpg file creation (bug#6723).
Daiki Ueno <ueno@unixuser.org>
parents:
109166
diff
changeset
|
149 (make-local-variable 'epa-file-error) |
52f611292230
Fix *.gpg file creation (bug#6723).
Daiki Ueno <ueno@unixuser.org>
parents:
109166
diff
changeset
|
150 (setq epa-file-error error) |
52f611292230
Fix *.gpg file creation (bug#6723).
Daiki Ueno <ueno@unixuser.org>
parents:
109166
diff
changeset
|
151 (add-hook 'find-file-not-found-functions |
52f611292230
Fix *.gpg file creation (bug#6723).
Daiki Ueno <ueno@unixuser.org>
parents:
109166
diff
changeset
|
152 'epa-file--find-file-not-found-function |
52f611292230
Fix *.gpg file creation (bug#6723).
Daiki Ueno <ueno@unixuser.org>
parents:
109166
diff
changeset
|
153 nil t)) |
91647 | 154 (signal 'file-error |
155 (cons "Opening input file" (cdr error))))) | |
156 (make-local-variable 'epa-file-encrypt-to) | |
157 (setq epa-file-encrypt-to | |
158 (mapcar #'car (epg-context-result-for context 'encrypted-to))) | |
159 (if (or beg end) | |
160 (setq string (substring string (or beg 0) end))) | |
161 (save-excursion | |
110318
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
162 ;; If visiting, bind off buffer-file-name so that |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
163 ;; file-locking will not ask whether we should |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
164 ;; really edit the buffer. |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
165 (let ((buffer-file-name |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
166 (if visit nil buffer-file-name))) |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
167 (save-restriction |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
168 (narrow-to-region (point) (point)) |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
169 (epa-file-decode-and-insert string file visit beg end replace) |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
170 (setq length (- (point-max) (point-min)))) |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
171 (if replace |
3386110d149b
epa-file: suppress file-locking question on M-x revert-buffer
Daiki Ueno <ueno@unixuser.org>
parents:
110015
diff
changeset
|
172 (delete-region (point) (point-max)))) |
100456
e4798aef9a53
* epa-file.el (epa-file-insert-file-contents): Set
Daiki Ueno <ueno@unixuser.org>
parents:
100304
diff
changeset
|
173 (if visit |
e4798aef9a53
* epa-file.el (epa-file-insert-file-contents): Set
Daiki Ueno <ueno@unixuser.org>
parents:
100304
diff
changeset
|
174 (set-visited-file-modtime)))) |
91647 | 175 (if (and local-copy |
176 (file-exists-p local-copy)) | |
177 (delete-file local-copy))) | |
178 (list file length))) | |
179 (put 'insert-file-contents 'epa-file 'epa-file-insert-file-contents) | |
180 | |
181 (defun epa-file-write-region (start end file &optional append visit lockname | |
182 mustbenew) | |
183 (if append | |
105170 | 184 (error "Can't append to the file")) |
91647 | 185 (setq file (expand-file-name file)) |
186 (let* ((coding-system (or coding-system-for-write | |
187 (if (fboundp 'select-safe-coding-system) | |
188 ;; This is needed since Emacs 22 has | |
189 ;; no-conversion setting for *.gpg in | |
190 ;; `auto-coding-alist'. | |
191 (let ((buffer-file-name | |
192 (file-name-sans-extension file))) | |
193 (select-safe-coding-system | |
194 (point-min) (point-max))) | |
195 buffer-file-coding-system))) | |
196 (context (epg-make-context)) | |
197 (coding-system-for-write 'binary) | |
198 string entry | |
199 (recipients | |
200 (cond | |
201 ((listp epa-file-encrypt-to) epa-file-encrypt-to) | |
202 ((stringp epa-file-encrypt-to) (list epa-file-encrypt-to))))) | |
203 (epg-context-set-passphrase-callback | |
204 context | |
205 (cons #'epa-file-passphrase-callback-function | |
206 file)) | |
207 (epg-context-set-progress-callback context | |
208 #'epa-progress-callback-function) | |
209 (epg-context-set-armor context epa-armor) | |
210 (condition-case error | |
211 (setq string | |
212 (epg-encrypt-string | |
213 context | |
214 (if (stringp start) | |
215 (epa-file--encode-coding-string start coding-system) | |
95477
57f3dde2b9be
(epa-file-write-region): Write the entire buffer
Daiki Ueno <ueno@unixuser.org>
parents:
94755
diff
changeset
|
216 (unless start |
95478 | 217 (setq start (point-min) |
218 end (point-max))) | |
91647 | 219 (epa-file--encode-coding-string (buffer-substring start end) |
220 coding-system)) | |
221 (if (or epa-file-select-keys | |
222 (not (local-variable-p 'epa-file-encrypt-to | |
223 (current-buffer)))) | |
224 (epa-select-keys | |
225 context | |
226 "Select recipents for encryption. | |
227 If no one is selected, symmetric encryption will be performed. " | |
228 recipients) | |
229 (if epa-file-encrypt-to | |
230 (epg-list-keys context recipients))))) | |
231 (error | |
232 (if (setq entry (assoc file epa-file-passphrase-alist)) | |
233 (setcdr entry nil)) | |
234 (signal 'file-error (cons "Opening output file" (cdr error))))) | |
235 (epa-file-run-real-handler | |
236 #'write-region | |
237 (list string nil file append visit lockname mustbenew)) | |
238 (if (boundp 'last-coding-system-used) | |
239 (setq last-coding-system-used coding-system)) | |
240 (if (eq visit t) | |
241 (progn | |
242 (setq buffer-file-name file) | |
243 (set-visited-file-modtime)) | |
244 (if (stringp visit) | |
245 (progn | |
246 (set-visited-file-modtime) | |
247 (setq buffer-file-name visit)))) | |
248 (if (or (eq visit t) | |
249 (eq visit nil) | |
250 (stringp visit)) | |
251 (message "Wrote %s" buffer-file-name)))) | |
252 (put 'write-region 'epa-file 'epa-file-write-region) | |
253 | |
254 (defun epa-file-select-keys () | |
255 "Select recipients for encryption." | |
256 (interactive) | |
257 (make-local-variable 'epa-file-encrypt-to) | |
258 (setq epa-file-encrypt-to | |
93002
d876f5372472
EasyPG: Fix bug with C-x C-s after M-x epa-file-select-keys.
Michael Olson <mwolson@gnu.org>
parents:
91731
diff
changeset
|
259 (mapcar |
d876f5372472
EasyPG: Fix bug with C-x C-s after M-x epa-file-select-keys.
Michael Olson <mwolson@gnu.org>
parents:
91731
diff
changeset
|
260 (lambda (key) |
d876f5372472
EasyPG: Fix bug with C-x C-s after M-x epa-file-select-keys.
Michael Olson <mwolson@gnu.org>
parents:
91731
diff
changeset
|
261 (epg-sub-key-id (car (epg-key-sub-key-list key)))) |
91647 | 262 (epa-select-keys |
263 (epg-make-context) | |
264 "Select recipents for encryption. | |
93002
d876f5372472
EasyPG: Fix bug with C-x C-s after M-x epa-file-select-keys.
Michael Olson <mwolson@gnu.org>
parents:
91731
diff
changeset
|
265 If no one is selected, symmetric encryption will be performed. ")))) |
91647 | 266 |
267 ;;;###autoload | |
268 (defun epa-file-enable () | |
269 (interactive) | |
270 (if (memq epa-file-handler file-name-handler-alist) | |
271 (message "`epa-file' already enabled") | |
272 (setq file-name-handler-alist | |
273 (cons epa-file-handler file-name-handler-alist)) | |
94417
1a8916b995cf
* epa-file.el (auto-encryption-mode): Rename from epa-file-mode.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
93002
diff
changeset
|
274 (add-hook 'find-file-hook 'epa-file-find-file-hook) |
91647 | 275 (setq auto-mode-alist (cons epa-file-auto-mode-alist-entry auto-mode-alist)) |
276 (message "`epa-file' enabled"))) | |
277 | |
278 ;;;###autoload | |
279 (defun epa-file-disable () | |
280 (interactive) | |
281 (if (memq epa-file-handler file-name-handler-alist) | |
282 (progn | |
283 (setq file-name-handler-alist | |
284 (delq epa-file-handler file-name-handler-alist)) | |
94417
1a8916b995cf
* epa-file.el (auto-encryption-mode): Rename from epa-file-mode.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
93002
diff
changeset
|
285 (remove-hook 'find-file-hook 'epa-file-find-file-hook) |
91647 | 286 (setq auto-mode-alist (delq epa-file-auto-mode-alist-entry |
287 auto-mode-alist)) | |
288 (message "`epa-file' disabled")) | |
289 (message "`epa-file' already disabled"))) | |
290 | |
291 (provide 'epa-file) | |
292 | |
91687 | 293 ;; arch-tag: 5715152f-0eb1-4dbc-9008-07098775314d |
91647 | 294 ;;; epa-file.el ends here |