1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
;;; test-gpg.el --- Flycheck Specs: GPG-encrypted buffers -*- lexical-binding: t; -*-
;; Copyright (C) 2013-2016 Sebastian Wiesner and Flycheck contributors
;; Author: Sebastian Wiesner <swiesner@lunaryorn.com>
;; This file is not part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program 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
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Specs for detecting encrypted buffers.
;;; Code:
(require 'flycheck-buttercup)
(require 'epa)
(require 'epg-config) ; For GPG configuration
(require 'epa-file) ; To test encrypted buffers
(defun flycheck/encrypt-string-to-file (string passphrase filename)
"Encrypt STRING with PASSPHRASE and write to FILENAME.
This function is ABSOLUTELY INSECURE, use only and exclusively for testing."
;; Encrypt string via GPG, passing it on standard input. Enforce a pipe for
;; communication with `process-connection-type nil', otherwise gpg tries to
;; read beyond EOF and never finishes.
(let* ((process-connection-type nil)
(gpg (start-process "flycheck-buttercup-gpg" nil
epg-gpg-program "--batch" "--no-tty"
"--pinentry-mode" "loopback"
"--homedir" epg-gpg-home-directory
"-c"
"--passphrase" passphrase
"-o" filename
"-")))
(process-send-string gpg string)
(process-send-eof gpg)
;; Wait until GPG exists
(while (process-live-p gpg)
(accept-process-output)
(sleep-for 0.1))))
(defun flycheck/gnupg21-available-p ()
"Whether GPG is available or not."
(let ((config (epg-find-configuration 'OpenPGP 'force)))
;; `epg-check-configuration' errors if the configuration is invalid, and
;; otherwise returns nil, hence ignore errors and default to `t' to get a
;; proper truthy result
(and config (ignore-errors (or (epg-check-configuration config "2.1") t)))))
(describe "Encrypted buffers"
(describe "flycheck-encrypted-buffer-p"
(let ((gpg-tty (getenv "GPG_TTY"))
(old-home-dir epg-gpg-home-directory)
temp-home-dir)
(before-each
;; Use a temporary directory as home directory for GPG to make sure that
;; GPG runs against an existing home directory (some CI systems may have
;; users without home directories). See
;; https://github.com/flycheck/flycheck/pull/891
(setq temp-home-dir (make-temp-file "flycheck-epg-gpg-home" 'dir-flag))
(setq epg-gpg-home-directory temp-home-dir)
;; Clear GPG TTY information from environment to prevent gpg from
;; hanging, see https://github.com/flycheck/flycheck/pull/890
(setenv "GPG_TTY"))
(after-each
;; Restore GPG TTY information
(setenv "GPG_TTY" gpg-tty)
;; Delete our custom gpg home directory, and restore the old default
(ignore-errors (delete-directory temp-home-dir 'recursive))
(setq epg-gpg-home-directory old-home-dir))
(it "considers a temporary buffer as unencrypted"
(with-temp-buffer
(expect (flycheck-encrypted-buffer-p) :not :to-be-truthy)))
(it "considers a file buffer as unencrypted"
(let ((file-name (make-temp-file "flycheck-file")))
(unwind-protect
(with-temp-buffer
(insert-file-contents file-name 'visit)
(set-visited-file-name file-name 'no-query)
(expect (flycheck-encrypted-buffer-p) :not :to-be-truthy)
(ignore-errors (delete-file file-name))))))
(it "recognizes an encrypted buffer"
(assume (version<= "25" emacs-version))
(assume (flycheck/gnupg21-available-p) "gpg not installed")
;; Create a temporary file name. Do NOT use `make-temp-file' here,
;; because that hangs with the extension `.gpg'.
(let* ((file-name (expand-file-name
(concat (make-temp-name "flycheck-encrypted-file")
".txt.gpg")
temporary-file-directory))
(epa-pinentry-mode 'loopback)
(passphrase "spam with eggs")
;; Teach EPA about the passphrase for our file to decrypt without
;; any user interaction. `epa-file-passphrase-alist' stores
;; canonical file names, hence we pass the temporary file name
;; through `file-truename' to remove any symlinks in the path.
(epa-file-cache-passphrase-for-symmetric-encryption t)
(epa-file-passphrase-alist (list (cons (file-truename file-name)
passphrase))))
(unwind-protect
(with-temp-buffer
(flycheck/encrypt-string-to-file "Hello world"
passphrase file-name)
(let ((inhibit-message t))
;; Silence "Decrypting ..." messages to keep buttercup output
;; clean
(insert-file-contents file-name 'visit))
(set-visited-file-name file-name 'no-query)
(expect (flycheck-encrypted-buffer-p) :to-be-truthy))
(ignore-errors (delete-file file-name))))))))
;;; test-gpg.el ends here
|
