epa-file.el 11.4 KB
Newer Older
1
;;; epa-file.el --- the EasyPG Assistant, transparent file encryption -*- lexical-binding: t -*-
2
;; Copyright (C) 2006-2014 Free Software Foundation, Inc.
Michael Olson's avatar
Michael Olson committed
3 4 5

;; Author: Daiki Ueno <ueno@unixuser.org>
;; Keywords: PGP, GnuPG
6
;; Package: epa
Michael Olson's avatar
Michael Olson committed
7 8 9

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Michael Olson's avatar
Michael Olson committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Michael Olson's avatar
Michael Olson committed
14 15 16 17 18 19 20

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Michael Olson's avatar
Michael Olson committed
22 23 24 25

;;; Code:

(require 'epa)
26
(require 'epa-hook)
Michael Olson's avatar
Michael Olson committed
27 28

(defcustom epa-file-cache-passphrase-for-symmetric-encryption nil
29 30 31
  "If non-nil, cache passphrase for symmetric encryption.

For security reasons, this option is turned off by default and
32 33 34 35 36
not recommended to use.  Instead, consider using gpg-agent which
does the same job in a safer way.  See Info node `(epa) Caching
Passphrases' for more information.

Note that this option has no effect if you use GnuPG 2.0."
Michael Olson's avatar
Michael Olson committed
37 38 39
  :type 'boolean
  :group 'epa-file)

40
(defcustom epa-file-select-keys nil
41 42 43 44 45 46 47 48 49
  "Control whether or not to pop up the key selection dialog.

If t, always asks user to select recipients.
If nil, query user only when `epa-file-encrypt-to' is not set.
If neither t nor nil, doesn't ask user.  In this case, symmetric
encryption is used."
  :type '(choice (const :tag "Ask always" t)
		 (const :tag "Ask when recipients are not set" nil)
		 (const :tag "Don't ask" silent))
Michael Olson's avatar
Michael Olson committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
  :group 'epa-file)

(defvar epa-file-passphrase-alist nil)

(eval-and-compile
  (if (fboundp 'encode-coding-string)
      (defalias 'epa-file--encode-coding-string 'encode-coding-string)
    (defalias 'epa-file--encode-coding-string 'identity)))

(eval-and-compile
  (if (fboundp 'decode-coding-string)
      (defalias 'epa-file--decode-coding-string 'decode-coding-string)
    (defalias 'epa-file--decode-coding-string 'identity)))

(defun epa-file-passphrase-callback-function (context key-id file)
  (if (and epa-file-cache-passphrase-for-symmetric-encryption
	   (eq key-id 'SYM))
      (progn
	(setq file (file-truename file))
	(let ((entry (assoc file epa-file-passphrase-alist))
	      passphrase)
	  (or (copy-sequence (cdr entry))
	      (progn
		(unless entry
		  (setq entry (list file)
			epa-file-passphrase-alist
			(cons entry
			      epa-file-passphrase-alist)))
		(setq passphrase (epa-passphrase-callback-function context
79 80
								   key-id
								   file))
Michael Olson's avatar
Michael Olson committed
81 82
		(setcdr entry (copy-sequence passphrase))
		passphrase))))
83
    (epa-passphrase-callback-function context key-id file)))
Michael Olson's avatar
Michael Olson committed
84

85
;;;###autoload
Michael Olson's avatar
Michael Olson committed
86
(defun epa-file-handler (operation &rest args)
87 88 89 90 91 92
  (save-match-data
    (let ((op (get operation 'epa-file)))
      (if op
  	  (apply op args)
  	(epa-file-run-real-handler operation args)))))

Michael Olson's avatar
Michael Olson committed
93 94 95 96 97 98 99 100 101 102 103 104
(defun epa-file-run-real-handler (operation args)
  (let ((inhibit-file-name-handlers
	 (cons 'epa-file-handler
	       (and (eq inhibit-file-name-operation operation)
		    inhibit-file-name-handlers)))
	(inhibit-file-name-operation operation))
    (apply operation args)))

(defun epa-file-decode-and-insert (string file visit beg end replace)
  (if (fboundp 'decode-coding-inserted-region)
      (save-restriction
	(narrow-to-region (point) (point))
105 106 107
	(insert (if enable-multibyte-characters
		    (string-to-multibyte string)
		  string))
Daiki Ueno's avatar
Daiki Ueno committed
108 109 110
	(decode-coding-inserted-region
	 (point-min) (point-max)
	 (substring file 0 (string-match epa-file-name-regexp file))
111
	 visit beg end replace))
Michael Olson's avatar
Michael Olson committed
112 113 114
    (insert (epa-file--decode-coding-string string (or coding-system-for-read
						       'undecided)))))

115 116 117 118 119 120 121 122
(defvar epa-file-error nil)
(defun epa-file--find-file-not-found-function ()
  (let ((error epa-file-error))
    (save-window-excursion
      (kill-buffer))
    (signal 'file-error
	    (cons "Opening input file" (cdr error)))))

Michael Olson's avatar
Michael Olson committed
123 124 125 126 127 128 129
(defvar last-coding-system-used)
(defun epa-file-insert-file-contents (file &optional visit beg end replace)
  (barf-if-buffer-read-only)
  (if (and visit (or beg end))
      (error "Attempt to visit less than an entire file"))
  (setq file (expand-file-name file))
  (let* ((local-copy
130
	  (condition-case nil
Michael Olson's avatar
Michael Olson committed
131 132 133 134
	      (epa-file-run-real-handler #'file-local-copy (list file))
	    (error)))
	 (local-file (or local-copy file))
	 (context (epg-make-context))
135
         (buf (current-buffer))
Michael Olson's avatar
Michael Olson committed
136
	 string length entry)
137 138
    (if visit
	(setq buffer-file-name file))
Michael Olson's avatar
Michael Olson committed
139 140 141 142
    (epg-context-set-passphrase-callback
     context
     (cons #'epa-file-passphrase-callback-function
	   local-file))
143 144 145 146
    (epg-context-set-progress-callback
     context
     (cons #'epa-progress-callback-function
	   (format "Decrypting %s" file)))
147 148
    (if epa-pinentry-mode
	(setf (epg-context-pinentry-mode context) epa-pinentry-mode))
Michael Olson's avatar
Michael Olson committed
149 150 151 152 153 154 155 156 157
    (unwind-protect
	(progn
	  (if replace
	      (goto-char (point-min)))
	  (condition-case error
	      (setq string (epg-decrypt-file context local-file nil))
	    (error
	     (if (setq entry (assoc file epa-file-passphrase-alist))
		 (setcdr entry nil))
Daiki Ueno's avatar
Daiki Ueno committed
158 159 160 161 162 163 164 165
	     ;; If the decryption program can't be found,
	     ;; signal that as a non-file error
	     ;; so that find-file-noselect-1 won't handle it.
	     ;; Borrowed from jka-compr.el.
	     (if (and (eq (car error) 'file-error)
		      (equal (cadr error) "Searching for program"))
		 (error "Decryption program `%s' not found"
			(nth 3 error)))
166
	     (when (file-exists-p local-file)
167 168 169 170
	       ;; Hack to prevent find-file from opening empty buffer
	       ;; when decryption failed (bug#6568).  See the place
	       ;; where `find-file-not-found-functions' are called in
	       ;; `find-file-noselect-1'.
171
	       (setq-local epa-file-error error)
172 173
	       (add-hook 'find-file-not-found-functions
			 'epa-file--find-file-not-found-function
174 175
			 nil t)
	       (epa-display-error context))
Michael Olson's avatar
Michael Olson committed
176 177
	     (signal 'file-error
		     (cons "Opening input file" (cdr error)))))
178 179 180 181
          (set-buffer buf) ;In case timer/filter changed/killed it (bug#16029)!
	  (setq-local epa-file-encrypt-to
                      (mapcar #'car (epg-context-result-for
                                     context 'encrypted-to)))
Michael Olson's avatar
Michael Olson committed
182 183 184
	  (if (or beg end)
	      (setq string (substring string (or beg 0) end)))
	  (save-excursion
185 186 187 188 189 190 191 192 193 194 195
	    ;; If visiting, bind off buffer-file-name so that
	    ;; file-locking will not ask whether we should
	    ;; really edit the buffer.
	    (let ((buffer-file-name
		   (if visit nil buffer-file-name)))
	      (save-restriction
		(narrow-to-region (point) (point))
		(epa-file-decode-and-insert string file visit beg end replace)
		(setq length (- (point-max) (point-min))))
	      (if replace
		  (delete-region (point) (point-max))))
196 197
	    (if visit
		(set-visited-file-modtime))))
Michael Olson's avatar
Michael Olson committed
198 199 200 201 202 203 204 205 206
      (if (and local-copy
	       (file-exists-p local-copy))
	  (delete-file local-copy)))
    (list file length)))
(put 'insert-file-contents 'epa-file 'epa-file-insert-file-contents)

(defun epa-file-write-region (start end file &optional append visit lockname
				    mustbenew)
  (if append
Juanma Barranquero's avatar
Juanma Barranquero committed
207
      (error "Can't append to the file"))
Michael Olson's avatar
Michael Olson committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  (setq file (expand-file-name file))
  (let* ((coding-system (or coding-system-for-write
			    (if (fboundp 'select-safe-coding-system)
				;; This is needed since Emacs 22 has
				;; no-conversion setting for *.gpg in
				;; `auto-coding-alist'.
			        (let ((buffer-file-name
				       (file-name-sans-extension file)))
				  (select-safe-coding-system
				   (point-min) (point-max)))
			      buffer-file-coding-system)))
	 (context (epg-make-context))
	 (coding-system-for-write 'binary)
	 string entry
	 (recipients
	  (cond
	   ((listp epa-file-encrypt-to) epa-file-encrypt-to)
225 226
	   ((stringp epa-file-encrypt-to) (list epa-file-encrypt-to))))
	 buffer)
Michael Olson's avatar
Michael Olson committed
227 228 229 230
    (epg-context-set-passphrase-callback
     context
     (cons #'epa-file-passphrase-callback-function
	   file))
231 232 233 234
    (epg-context-set-progress-callback
     context
     (cons #'epa-progress-callback-function
	   (format "Encrypting %s" file)))
Daiki Ueno's avatar
Daiki Ueno committed
235
    (setf (epg-context-armor context) epa-armor)
236 237
    (if epa-pinentry-mode
	(setf (epg-context-pinentry-mode context) epa-pinentry-mode))
Michael Olson's avatar
Michael Olson committed
238 239 240 241 242 243
    (condition-case error
	(setq string
	      (epg-encrypt-string
	       context
	       (if (stringp start)
		   (epa-file--encode-coding-string start coding-system)
244
		 (unless start
Daiki Ueno's avatar
Daiki Ueno committed
245 246
		   (setq start (point-min)
			 end (point-max)))
247 248 249 250 251 252 253 254 255 256 257 258
		 (setq buffer (current-buffer))
		 (with-temp-buffer
		   (insert-buffer-substring buffer start end)
		   ;; Translate the region according to
		   ;; `buffer-file-format', as `write-region' would.
		   ;; We can't simply do `write-region' (into a
		   ;; temporary file) here, since it writes out
		   ;; decrypted contents.
		   (format-encode-buffer (with-current-buffer buffer
					   buffer-file-format))
		   (epa-file--encode-coding-string (buffer-string)
						   coding-system)))
259 260 261 262
	       (if (or (eq epa-file-select-keys t)
		       (and (null epa-file-select-keys)
			    (not (local-variable-p 'epa-file-encrypt-to
						   (current-buffer)))))
Michael Olson's avatar
Michael Olson committed
263 264
		   (epa-select-keys
		    context
Paul Eggert's avatar
Paul Eggert committed
265
		    "Select recipients for encryption.
Michael Olson's avatar
Michael Olson committed
266 267 268 269 270
If no one is selected, symmetric encryption will be performed.  "
		    recipients)
		 (if epa-file-encrypt-to
		     (epg-list-keys context recipients)))))
      (error
Daiki Ueno's avatar
Daiki Ueno committed
271
       (epa-display-error context)
Michael Olson's avatar
Michael Olson committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
       (if (setq entry (assoc file epa-file-passphrase-alist))
	   (setcdr entry nil))
       (signal 'file-error (cons "Opening output file" (cdr error)))))
    (epa-file-run-real-handler
     #'write-region
     (list string nil file append visit lockname mustbenew))
    (if (boundp 'last-coding-system-used)
	(setq last-coding-system-used coding-system))
    (if (eq visit t)
	(progn
	  (setq buffer-file-name file)
	  (set-visited-file-modtime))
      (if (stringp visit)
	  (progn
	    (set-visited-file-modtime)
	    (setq buffer-file-name visit))))
    (if (or (eq visit t)
	    (eq visit nil)
	    (stringp visit))
	(message "Wrote %s" buffer-file-name))))
(put 'write-region 'epa-file 'epa-file-write-region)

(defun epa-file-select-keys ()
  "Select recipients for encryption."
  (interactive)
297 298 299 300 301 302 303
  (setq-local epa-file-encrypt-to
              (mapcar
               (lambda (key)
                 (epg-sub-key-id (car (epg-key-sub-key-list key))))
               (epa-select-keys
                (epg-make-context)
                "Select recipients for encryption.
304
If no one is selected, symmetric encryption will be performed.  "))))
Michael Olson's avatar
Michael Olson committed
305 306 307 308 309 310 311 312

;;;###autoload
(defun epa-file-enable ()
  (interactive)
  (if (memq epa-file-handler file-name-handler-alist)
      (message "`epa-file' already enabled")
    (setq file-name-handler-alist
	  (cons epa-file-handler file-name-handler-alist))
313
    (add-hook 'find-file-hook 'epa-file-find-file-hook)
Michael Olson's avatar
Michael Olson committed
314 315 316 317 318 319 320 321 322 323
    (setq auto-mode-alist (cons epa-file-auto-mode-alist-entry auto-mode-alist))
    (message "`epa-file' enabled")))

;;;###autoload
(defun epa-file-disable ()
  (interactive)
  (if (memq epa-file-handler file-name-handler-alist)
      (progn
	(setq file-name-handler-alist
	      (delq epa-file-handler file-name-handler-alist))
324
	(remove-hook 'find-file-hook 'epa-file-find-file-hook)
Michael Olson's avatar
Michael Olson committed
325 326 327 328 329 330 331 332
	(setq auto-mode-alist (delq epa-file-auto-mode-alist-entry
				    auto-mode-alist))
	(message "`epa-file' disabled"))
    (message "`epa-file' already disabled")))

(provide 'epa-file)

;;; epa-file.el ends here