epa-file.el 11.7 KB
Newer Older
1
;;; epa-file.el --- the EasyPG Assistant, transparent file encryption -*- lexical-binding: t -*-
Paul Eggert's avatar
Paul Eggert committed
2
;; Copyright (C) 2006-2017 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 86 87
(defvar epa-inhibit nil
  "Non-nil means don't try to decrypt .gpg files when operating on them.")

88
;;;###autoload
Michael Olson's avatar
Michael Olson committed
89
(defun epa-file-handler (operation &rest args)
90 91
  (save-match-data
    (let ((op (get operation 'epa-file)))
92 93
      (if (and op (not epa-inhibit))
          (apply op args)
94 95
  	(epa-file-run-real-handler operation args)))))

Michael Olson's avatar
Michael Olson committed
96 97 98 99 100 101 102 103 104 105 106 107
(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))
108 109 110
	(insert (if enable-multibyte-characters
		    (string-to-multibyte string)
		  string))
Daiki Ueno's avatar
Daiki Ueno committed
111 112 113
	(decode-coding-inserted-region
	 (point-min) (point-max)
	 (substring file 0 (string-match epa-file-name-regexp file))
114
	 visit beg end replace))
Michael Olson's avatar
Michael Olson committed
115 116 117
    (insert (epa-file--decode-coding-string string (or coding-system-for-read
						       'undecided)))))

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))
123
    (signal 'file-missing
124 125
	    (cons "Opening input file" (cdr error)))))

Michael Olson's avatar
Michael Olson committed
126 127 128 129 130 131 132
(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
133
	  (condition-case nil
Michael Olson's avatar
Michael Olson committed
134 135 136 137
	      (epa-file-run-real-handler #'file-local-copy (list file))
	    (error)))
	 (local-file (or local-copy file))
	 (context (epg-make-context))
138
         (buf (current-buffer))
Michael Olson's avatar
Michael Olson committed
139
	 string length entry)
140 141
    (if visit
	(setq buffer-file-name file))
Michael Olson's avatar
Michael Olson committed
142 143 144 145
    (epg-context-set-passphrase-callback
     context
     (cons #'epa-file-passphrase-callback-function
	   local-file))
146 147 148 149
    (epg-context-set-progress-callback
     context
     (cons #'epa-progress-callback-function
	   (format "Decrypting %s" file)))
150
    (setf (epg-context-pinentry-mode context) epa-pinentry-mode)
Michael Olson's avatar
Michael Olson committed
151 152 153 154 155 156 157 158 159
    (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
160 161 162 163
	     ;; 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.
Paul Eggert's avatar
Paul Eggert committed
164
	     (if (and (memq 'file-error (get (car error) 'error-conditions))
Daiki Ueno's avatar
Daiki Ueno committed
165 166 167
		      (equal (cadr error) "Searching for program"))
		 (error "Decryption program `%s' not found"
			(nth 3 error)))
168 169 170 171 172 173 174 175 176 177 178 179 180
	     (let ((exists (file-exists-p local-file)))
	       (when exists
		 ;; 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'.
		 (setq-local epa-file-error error)
		 (add-hook 'find-file-not-found-functions
			   'epa-file--find-file-not-found-function
			   nil t)
		 (epa-display-error context))
	       (signal (if exists 'file-error 'file-missing)
		       (cons "Opening input file" (cdr error))))))
181 182 183 184
          (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
185 186 187
	  (if (or beg end)
	      (setq string (substring string (or beg 0) end)))
	  (save-excursion
188 189 190 191 192 193 194 195 196 197 198
	    ;; 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))))
199 200
	    (if visit
		(set-visited-file-modtime))))
Michael Olson's avatar
Michael Olson committed
201 202 203 204 205 206 207 208 209
      (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
210
      (error "Can't append to the file"))
Michael Olson's avatar
Michael Olson committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  (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)
228 229
	   ((stringp epa-file-encrypt-to) (list epa-file-encrypt-to))))
	 buffer)
Michael Olson's avatar
Michael Olson committed
230 231 232 233
    (epg-context-set-passphrase-callback
     context
     (cons #'epa-file-passphrase-callback-function
	   file))
234 235 236 237
    (epg-context-set-progress-callback
     context
     (cons #'epa-progress-callback-function
	   (format "Encrypting %s" file)))
Daiki Ueno's avatar
Daiki Ueno committed
238
    (setf (epg-context-armor context) epa-armor)
239
    (setf (epg-context-pinentry-mode context) epa-pinentry-mode)
Michael Olson's avatar
Michael Olson committed
240 241 242 243 244 245
    (condition-case error
	(setq string
	      (epg-encrypt-string
	       context
	       (if (stringp start)
		   (epa-file--encode-coding-string start coding-system)
246
		 (unless start
Daiki Ueno's avatar
Daiki Ueno committed
247 248
		   (setq start (point-min)
			 end (point-max)))
249 250 251 252 253 254 255 256 257 258 259 260
		 (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)))
261 262 263 264
	       (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
265 266
		   (epa-select-keys
		    context
Paul Eggert's avatar
Paul Eggert committed
267
		    "Select recipients for encryption.
Michael Olson's avatar
Michael Olson committed
268 269 270 271 272
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
273
       (epa-display-error context)
Michael Olson's avatar
Michael Olson committed
274 275
       (if (setq entry (assoc file epa-file-passphrase-alist))
	   (setcdr entry nil))
276
       (signal 'file-error (cons "Opening output file" (cdr error)))))
Michael Olson's avatar
Michael Olson committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
    (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))
293 294 295 296 297
	(message "Wrote %d characters to `%s'"
                 (cond ((null start) (buffer-size))
                       ((stringp start) (length start))
                       (t (- end start)))
                 buffer-file-name))))
Michael Olson's avatar
Michael Olson committed
298 299 300 301 302
(put 'write-region 'epa-file 'epa-file-write-region)

(defun epa-file-select-keys ()
  "Select recipients for encryption."
  (interactive)
303 304 305 306 307 308 309
  (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.
310
If no one is selected, symmetric encryption will be performed.  "))))
Michael Olson's avatar
Michael Olson committed
311 312 313 314 315 316 317 318

;;;###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))
319
    (add-hook 'find-file-hook 'epa-file-find-file-hook)
Michael Olson's avatar
Michael Olson committed
320 321 322 323 324 325 326 327 328 329
    (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))
330
	(remove-hook 'find-file-hook 'epa-file-find-file-hook)
Michael Olson's avatar
Michael Olson committed
331 332 333 334 335 336 337 338
	(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