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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
;;; epg-config.el --- configuration of the EasyPG Library
;; Copyright (C) 2006-2017 Free Software Foundation, Inc.
;; Author: Daiki Ueno <ueno@unixuser.org>
;; Keywords: PGP, GnuPG
;; Package: epg
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; 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
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Code:
(eval-when-compile (require 'cl-lib))
(defconst epg-package-name "epg"
"Name of this package.")
(defconst epg-version-number "1.0.0"
"Version number of this package.")
(defconst epg-bug-report-address "ueno@unixuser.org"
"Report bugs to this address.")
(defgroup epg ()
"Interface to the GNU Privacy Guard (GnuPG)."
:tag "EasyPG"
:version "23.1"
:group 'data
:group 'external)
(defcustom epg-gpg-program (if (executable-find "gpg2")
"gpg2"
"gpg")
"The `gpg' executable.
Setting this variable directly does not take effect;
instead use \\[customize] (see the info node `Easy Customization')."
:version "25.1"
:group 'epg
:type 'string)
(defcustom epg-gpgsm-program "gpgsm"
"The `gpgsm' executable.
Setting this variable directly does not take effect;
instead use \\[customize] (see the info node `Easy Customization')."
:group 'epg
:type 'string)
(defcustom epg-gpgconf-program "gpgconf"
"The `gpgconf' executable."
:version "25.1"
:group 'epg
:type 'string)
(defcustom epg-gpg-home-directory nil
"The directory which contains the configuration files of `epg-gpg-program'."
:group 'epg
:type '(choice (const :tag "Default" nil) directory))
(defcustom epg-passphrase-coding-system nil
"Coding system to use with messages from `epg-gpg-program'."
:group 'epg
:type 'symbol)
(defcustom epg-debug nil
"If non-nil, debug output goes to the \" *epg-debug*\" buffer.
Note that the buffer name starts with a space."
:group 'epg
:type 'boolean)
(defconst epg-gpg-minimum-version "1.4.3")
(defconst epg-config--program-alist
'((OpenPGP
epg-gpg-program
("gpg2" . "2.1.6") ("gpg" . "1.4.3"))
(CMS
epg-gpgsm-program
("gpgsm" . "2.0.4")))
"Alist used to obtain the usable configuration of executables.
The first element of each entry is protocol symbol, which is
either `OpenPGP' or `CMS'. The second element is a symbol where
the executable name is remembered. The rest of the entry is an
alist mapping executable names to the minimum required version
suitable for the use with Emacs.")
(defconst epg-config--configuration-constructor-alist
'((OpenPGP . epg-config--make-gpg-configuration)
(CMS . epg-config--make-gpgsm-configuration))
"Alist used to obtain the usable configuration of executables.
The first element of each entry is protocol symbol, which is
either `OpenPGP' or `CMS'. The second element is a function
which constructs a configuration object (actually a plist).")
(defvar epg--configurations nil)
;;;###autoload
(defun epg-find-configuration (protocol &optional no-cache program-alist)
"Find or create a usable configuration to handle PROTOCOL.
This function first looks at the existing configuration found by
the previous invocation of this function, unless NO-CACHE is non-nil.
Then it walks through PROGRAM-ALIST or
`epg-config--program-alist'. If `epg-gpg-program' or
`epg-gpgsm-program' is already set with custom, use it.
Otherwise, it tries the programs listed in the entry until the
version requirement is met."
(unless program-alist
(setq program-alist epg-config--program-alist))
(let ((entry (assq protocol program-alist)))
(unless entry
(error "Unknown protocol %S" protocol))
(cl-destructuring-bind (symbol . alist)
(cdr entry)
(let ((constructor
(alist-get protocol epg-config--configuration-constructor-alist)))
(or (and (not no-cache) (alist-get protocol epg--configurations))
;; If the executable value is already set with M-x
;; customize, use it without checking.
(if (and symbol (get symbol 'saved-value))
(let ((configuration
(funcall constructor (symbol-value symbol))))
(push (cons protocol configuration) epg--configurations)
configuration)
(catch 'found
(dolist (program-version alist)
(let ((executable (executable-find (car program-version))))
(when executable
(let ((configuration
(funcall constructor executable)))
(when (ignore-errors
(epg-check-configuration configuration
(cdr program-version))
t)
(unless no-cache
(push (cons protocol configuration)
epg--configurations))
(throw 'found configuration)))))))))))))
;; Create an `epg-configuration' object for `gpg', using PROGRAM.
(defun epg-config--make-gpg-configuration (program)
(let (config groups type args)
(with-temp-buffer
(apply #'call-process program nil (list t nil) nil
(append (if epg-gpg-home-directory
(list "--homedir" epg-gpg-home-directory))
'("--with-colons" "--list-config")))
(goto-char (point-min))
(while (re-search-forward "^cfg:\\([^:]+\\):\\(.*\\)" nil t)
(setq type (intern (match-string 1))
args (match-string 2))
(cond
((eq type 'group)
(if (string-match "\\`\\([^:]+\\):" args)
(setq groups
(cons (cons (downcase (match-string 1 args))
(delete "" (split-string
(substring args
(match-end 0))
";")))
groups))
(if epg-debug
(message "Invalid group configuration: %S" args))))
((memq type '(pubkey cipher digest compress))
(if (string-match "\\`\\([0-9]+\\)\\(;[0-9]+\\)*" args)
(setq config
(cons (cons type
(mapcar #'string-to-number
(delete "" (split-string args ";"))))
config))
(if epg-debug
(message "Invalid %S algorithm configuration: %S"
type args))))
(t
(setq config (cons (cons type args) config))))))
(push (cons 'program program) config)
(if groups
(cons (cons 'groups groups) config)
config)))
;; Create an `epg-configuration' object for `gpgsm', using PROGRAM.
(defun epg-config--make-gpgsm-configuration (program)
(with-temp-buffer
(call-process program nil (list t nil) nil "--version")
(goto-char (point-min))
(when (looking-at "\\S-+ (")
(goto-char (match-end 0))
(backward-char)
(forward-sexp)
(skip-syntax-forward "-" (point-at-eol))
(list (cons 'program program)
(cons 'version (buffer-substring (point) (point-at-eol)))))))
;;;###autoload
(defun epg-configuration ()
"Return a list of internal configuration parameters of `epg-gpg-program'."
(declare (obsolete epg-find-configuration "25.1"))
(epg-config--make-gpg-configuration epg-gpg-program))
(defun epg-config--parse-version (string)
(let ((index 0)
version)
(while (eq index (string-match "\\([0-9]+\\)\\.?" string index))
(setq version (cons (string-to-number (match-string 1 string))
version)
index (match-end 0)))
(nreverse version)))
(defun epg-config--compare-version (v1 v2)
(while (and v1 v2 (= (car v1) (car v2)))
(setq v1 (cdr v1) v2 (cdr v2)))
(- (or (car v1) 0) (or (car v2) 0)))
;;;###autoload
(defun epg-check-configuration (config &optional minimum-version)
"Verify that a sufficient version of GnuPG is installed."
(let ((entry (assq 'version config))
version)
(unless (and entry
(stringp (cdr entry)))
(error "Undetermined version: %S" entry))
(setq version (epg-config--parse-version (cdr entry))
minimum-version (epg-config--parse-version
(or minimum-version
epg-gpg-minimum-version)))
(unless (>= (epg-config--compare-version version minimum-version) 0)
(error "Unsupported version: %s" (cdr entry)))))
;;;###autoload
(defun epg-expand-group (config group)
"Look at CONFIG and try to expand GROUP."
(let ((entry (assq 'groups config)))
(if (and entry
(setq entry (assoc (downcase group) (cdr entry))))
(cdr entry))))
(provide 'epg-config)
;;; epg-config.el ends here
|
