Update the 24.5 release date in all ChangeLog files
[emacs.git] / lisp / epg.el
blob594e41423a814195bf8485bf5c9b08d9b9b56333
1 ;;; epg.el --- the EasyPG Library -*- lexical-binding: t -*-
2 ;; Copyright (C) 1999-2000, 2002-2015 Free Software Foundation, Inc.
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: PGP, GnuPG
6 ;; Version: 1.0.0
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
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.
20 ;; 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/>.
23 ;;; Code:
25 (require 'epg-config)
27 (defvar epg-user-id nil
28 "GnuPG ID of your default identity.")
30 (defvar epg-user-id-alist nil
31 "An alist mapping from key ID to user ID.")
33 (defvar epg-last-status nil)
34 (defvar epg-read-point nil)
35 (defvar epg-process-filter-running nil)
36 (defvar epg-pending-status-list nil)
37 (defvar epg-key-id nil)
38 (defvar epg-context nil)
39 (defvar epg-debug-buffer nil)
40 (defvar epg-agent-file nil)
41 (defvar epg-agent-mtime nil)
43 ;; from gnupg/include/cipher.h
44 (defconst epg-cipher-algorithm-alist
45 '((0 . "NONE")
46 (1 . "IDEA")
47 (2 . "3DES")
48 (3 . "CAST5")
49 (4 . "BLOWFISH")
50 (7 . "AES")
51 (8 . "AES192")
52 (9 . "AES256")
53 (10 . "TWOFISH")
54 (11 . "CAMELLIA128")
55 (12 . "CAMELLIA256")
56 (110 . "DUMMY")))
58 ;; from gnupg/include/cipher.h
59 (defconst epg-pubkey-algorithm-alist
60 '((1 . "RSA")
61 (2 . "RSA_E")
62 (3 . "RSA_S")
63 (16 . "ELGAMAL_E")
64 (17 . "DSA")
65 (20 . "ELGAMAL")))
67 ;; from gnupg/include/cipher.h
68 (defconst epg-digest-algorithm-alist
69 '((1 . "MD5")
70 (2 . "SHA1")
71 (3 . "RIPEMD160")
72 (8 . "SHA256")
73 (9 . "SHA384")
74 (10 . "SHA512")
75 (11 . "SHA224")))
77 ;; from gnupg/include/cipher.h
78 (defconst epg-compress-algorithm-alist
79 '((0 . "NONE")
80 (1 . "ZIP")
81 (2 . "ZLIB")
82 (3 . "BZIP2")))
84 (defconst epg-invalid-recipients-reason-alist
85 '((0 . "No specific reason given")
86 (1 . "Not Found")
87 (2 . "Ambiguous specification")
88 (3 . "Wrong key usage")
89 (4 . "Key revoked")
90 (5 . "Key expired")
91 (6 . "No CRL known")
92 (7 . "CRL too old")
93 (8 . "Policy mismatch")
94 (9 . "Not a secret key")
95 (10 . "Key not trusted")))
97 (defconst epg-delete-problem-reason-alist
98 '((1 . "No such key")
99 (2 . "Must delete secret key first")
100 (3 . "Ambiguous specification")))
102 (defconst epg-import-ok-reason-alist
103 '((0 . "Not actually changed")
104 (1 . "Entirely new key")
105 (2 . "New user IDs")
106 (4 . "New signatures")
107 (8 . "New subkeys")
108 (16 . "Contains private key")))
110 (defconst epg-import-problem-reason-alist
111 '((0 . "No specific reason given")
112 (1 . "Invalid Certificate")
113 (2 . "Issuer Certificate missing")
114 (3 . "Certificate Chain too long")
115 (4 . "Error storing certificate")))
117 (defconst epg-no-data-reason-alist
118 '((1 . "No armored data")
119 (2 . "Expected a packet but did not found one")
120 (3 . "Invalid packet found, this may indicate a non OpenPGP message")
121 (4 . "Signature expected but not found")))
123 (defconst epg-unexpected-reason-alist nil)
125 (defvar epg-key-validity-alist
126 '((?o . unknown)
127 (?i . invalid)
128 (?d . disabled)
129 (?r . revoked)
130 (?e . expired)
131 (?- . none)
132 (?q . undefined)
133 (?n . never)
134 (?m . marginal)
135 (?f . full)
136 (?u . ultimate)))
138 (defvar epg-key-capability-alist
139 '((?e . encrypt)
140 (?s . sign)
141 (?c . certify)
142 (?a . authentication)
143 (?D . disabled)))
145 (defvar epg-new-signature-type-alist
146 '((?D . detached)
147 (?C . clear)
148 (?S . normal)))
150 (defvar epg-dn-type-alist
151 '(("1.2.840.113549.1.9.1" . "EMail")
152 ("2.5.4.12" . "T")
153 ("2.5.4.42" . "GN")
154 ("2.5.4.4" . "SN")
155 ("0.2.262.1.10.7.20" . "NameDistinguisher")
156 ("2.5.4.16" . "ADDR")
157 ("2.5.4.15" . "BC")
158 ("2.5.4.13" . "D")
159 ("2.5.4.17" . "PostalCode")
160 ("2.5.4.65" . "Pseudo")
161 ("2.5.4.5" . "SerialNumber")))
163 (defvar epg-prompt-alist nil)
165 (define-error 'epg-error "GPG error")
167 (defun epg-make-data-from-file (file)
168 "Make a data object from FILE."
169 (cons 'epg-data (vector file nil)))
171 (defun epg-make-data-from-string (string)
172 "Make a data object from STRING."
173 (cons 'epg-data (vector nil string)))
175 (defun epg-data-file (data)
176 "Return the file of DATA."
177 (unless (eq (car-safe data) 'epg-data)
178 (signal 'wrong-type-argument (list 'epg-data-p data)))
179 (aref (cdr data) 0))
181 (defun epg-data-string (data)
182 "Return the string of DATA."
183 (unless (eq (car-safe data) 'epg-data)
184 (signal 'wrong-type-argument (list 'epg-data-p data)))
185 (aref (cdr data) 1))
187 ;;;###autoload
188 (defun epg-make-context (&optional protocol armor textmode include-certs
189 cipher-algorithm digest-algorithm
190 compress-algorithm)
191 "Return a context object."
192 (unless protocol
193 (setq protocol 'OpenPGP))
194 (unless (memq protocol '(OpenPGP CMS))
195 (signal 'epg-error (list "unknown protocol" protocol)))
196 (cons 'epg-context
197 (vector protocol
198 (if (eq protocol 'OpenPGP)
199 epg-gpg-program
200 epg-gpgsm-program)
201 epg-gpg-home-directory
202 armor textmode include-certs
203 cipher-algorithm digest-algorithm compress-algorithm
204 (list #'epg-passphrase-callback-function)
206 nil nil nil nil nil nil nil)))
208 (defun epg-context-protocol (context)
209 "Return the protocol used within CONTEXT."
210 (unless (eq (car-safe context) 'epg-context)
211 (signal 'wrong-type-argument (list 'epg-context-p context)))
212 (aref (cdr context) 0))
214 (defun epg-context-program (context)
215 "Return the gpg or gpgsm executable used within CONTEXT."
216 (unless (eq (car-safe context) 'epg-context)
217 (signal 'wrong-type-argument (list 'epg-context-p context)))
218 (aref (cdr context) 1))
220 (defun epg-context-home-directory (context)
221 "Return the GnuPG home directory used in CONTEXT."
222 (unless (eq (car-safe context) 'epg-context)
223 (signal 'wrong-type-argument (list 'epg-context-p context)))
224 (aref (cdr context) 2))
226 (defun epg-context-armor (context)
227 "Return t if the output should be ASCII armored in CONTEXT."
228 (unless (eq (car-safe context) 'epg-context)
229 (signal 'wrong-type-argument (list 'epg-context-p context)))
230 (aref (cdr context) 3))
232 (defun epg-context-textmode (context)
233 "Return t if canonical text mode should be used in CONTEXT."
234 (unless (eq (car-safe context) 'epg-context)
235 (signal 'wrong-type-argument (list 'epg-context-p context)))
236 (aref (cdr context) 4))
238 (defun epg-context-include-certs (context)
239 "Return how many certificates should be included in an S/MIME signed message."
240 (unless (eq (car-safe context) 'epg-context)
241 (signal 'wrong-type-argument (list 'epg-context-p context)))
242 (aref (cdr context) 5))
244 (defun epg-context-cipher-algorithm (context)
245 "Return the cipher algorithm in CONTEXT."
246 (unless (eq (car-safe context) 'epg-context)
247 (signal 'wrong-type-argument (list 'epg-context-p context)))
248 (aref (cdr context) 6))
250 (defun epg-context-digest-algorithm (context)
251 "Return the digest algorithm in CONTEXT."
252 (unless (eq (car-safe context) 'epg-context)
253 (signal 'wrong-type-argument (list 'epg-context-p context)))
254 (aref (cdr context) 7))
256 (defun epg-context-compress-algorithm (context)
257 "Return the compress algorithm in CONTEXT."
258 (unless (eq (car-safe context) 'epg-context)
259 (signal 'wrong-type-argument (list 'epg-context-p context)))
260 (aref (cdr context) 8))
262 (defun epg-context-passphrase-callback (context)
263 "Return the function used to query passphrase."
264 (unless (eq (car-safe context) 'epg-context)
265 (signal 'wrong-type-argument (list 'epg-context-p context)))
266 (aref (cdr context) 9))
268 (defun epg-context-progress-callback (context)
269 "Return the function which handles progress update."
270 (unless (eq (car-safe context) 'epg-context)
271 (signal 'wrong-type-argument (list 'epg-context-p context)))
272 (aref (cdr context) 10))
274 (defun epg-context-signers (context)
275 "Return the list of key-id for signing."
276 (unless (eq (car-safe context) 'epg-context)
277 (signal 'wrong-type-argument (list 'epg-context-p context)))
278 (aref (cdr context) 11))
280 (defun epg-context-sig-notations (context)
281 "Return the list of notations for signing."
282 (unless (eq (car-safe context) 'epg-context)
283 (signal 'wrong-type-argument (list 'epg-context-p context)))
284 (aref (cdr context) 12))
286 (defun epg-context-process (context)
287 "Return the process object of `epg-gpg-program'.
288 This function is for internal use only."
289 (unless (eq (car-safe context) 'epg-context)
290 (signal 'wrong-type-argument (list 'epg-context-p context)))
291 (aref (cdr context) 13))
293 (defun epg-context-output-file (context)
294 "Return the output file of `epg-gpg-program'.
295 This function is for internal use only."
296 (unless (eq (car-safe context) 'epg-context)
297 (signal 'wrong-type-argument (list 'epg-context-p context)))
298 (aref (cdr context) 14))
300 (defun epg-context-result (context)
301 "Return the result of the previous cryptographic operation."
302 (unless (eq (car-safe context) 'epg-context)
303 (signal 'wrong-type-argument (list 'epg-context-p context)))
304 (aref (cdr context) 15))
306 (defun epg-context-operation (context)
307 "Return the name of the current cryptographic operation."
308 (unless (eq (car-safe context) 'epg-context)
309 (signal 'wrong-type-argument (list 'epg-context-p context)))
310 (aref (cdr context) 16))
312 (defun epg-context-pinentry-mode (context)
313 "Return the mode of pinentry invocation."
314 (unless (eq (car-safe context) 'epg-context)
315 (signal 'wrong-type-argument (list 'epg-context-p context)))
316 (aref (cdr context) 17))
318 (defun epg-context-set-protocol (context protocol)
319 "Set the protocol used within CONTEXT."
320 (unless (eq (car-safe context) 'epg-context)
321 (signal 'wrong-type-argument (list 'epg-context-p context)))
322 (aset (cdr context) 0 protocol))
324 (defun epg-context-set-program (context protocol)
325 "Set the gpg or gpgsm executable used within CONTEXT."
326 (unless (eq (car-safe context) 'epg-context)
327 (signal 'wrong-type-argument (list 'epg-context-p context)))
328 (aset (cdr context) 1 protocol))
330 (defun epg-context-set-home-directory (context directory)
331 "Set the GnuPG home directory."
332 (unless (eq (car-safe context) 'epg-context)
333 (signal 'wrong-type-argument (list 'epg-context-p context)))
334 (aset (cdr context) 2 directory))
336 (defun epg-context-set-armor (context armor)
337 "Specify if the output should be ASCII armored in CONTEXT."
338 (unless (eq (car-safe context) 'epg-context)
339 (signal 'wrong-type-argument (list 'epg-context-p context)))
340 (aset (cdr context) 3 armor))
342 (defun epg-context-set-textmode (context textmode)
343 "Specify if canonical text mode should be used in CONTEXT."
344 (unless (eq (car-safe context) 'epg-context)
345 (signal 'wrong-type-argument (list 'epg-context-p context)))
346 (aset (cdr context) 4 textmode))
348 (defun epg-context-set-include-certs (context include-certs)
349 "Set how many certificates should be included in an S/MIME signed message."
350 (unless (eq (car-safe context) 'epg-context)
351 (signal 'wrong-type-argument (list 'epg-context-p context)))
352 (aset (cdr context) 5 include-certs))
354 (defun epg-context-set-cipher-algorithm (context cipher-algorithm)
355 "Set the cipher algorithm in CONTEXT."
356 (unless (eq (car-safe context) 'epg-context)
357 (signal 'wrong-type-argument (list 'epg-context-p context)))
358 (aset (cdr context) 6 cipher-algorithm))
360 (defun epg-context-set-digest-algorithm (context digest-algorithm)
361 "Set the digest algorithm in CONTEXT."
362 (unless (eq (car-safe context) 'epg-context)
363 (signal 'wrong-type-argument (list 'epg-context-p context)))
364 (aset (cdr context) 7 digest-algorithm))
366 (defun epg-context-set-compress-algorithm (context compress-algorithm)
367 "Set the compress algorithm in CONTEXT."
368 (unless (eq (car-safe context) 'epg-context)
369 (signal 'wrong-type-argument (list 'epg-context-p context)))
370 (aset (cdr context) 8 compress-algorithm))
372 (defun epg-context-set-passphrase-callback (context
373 passphrase-callback)
374 "Set the function used to query passphrase.
376 PASSPHRASE-CALLBACK is either a function, or a cons-cell whose
377 car is a function and cdr is a callback data.
379 The function gets three arguments: the context, the key-id in
380 question, and the callback data (if any).
382 The callback may not be called if you use GnuPG 2.x, which relies
383 on the external program called `gpg-agent' for passphrase query.
384 If you really want to intercept passphrase query, consider
385 installing GnuPG 1.x _along with_ GnuPG 2.x, which does passphrase
386 query by itself and Emacs can intercept them."
387 (unless (eq (car-safe context) 'epg-context)
388 (signal 'wrong-type-argument (list 'epg-context-p context)))
389 (aset (cdr context) 9 (if (consp passphrase-callback)
390 passphrase-callback
391 (list passphrase-callback))))
393 (defun epg-context-set-progress-callback (context
394 progress-callback)
395 "Set the function which handles progress update.
397 PROGRESS-CALLBACK is either a function, or a cons-cell whose
398 car is a function and cdr is a callback data.
400 The function gets six arguments: the context, the operation
401 description, the character to display a progress unit, the
402 current amount done, the total amount to be done, and the
403 callback data (if any)."
404 (unless (eq (car-safe context) 'epg-context)
405 (signal 'wrong-type-argument (list 'epg-context-p context)))
406 (aset (cdr context) 10 (if (consp progress-callback)
407 progress-callback
408 (list progress-callback))))
410 (defun epg-context-set-signers (context signers)
411 "Set the list of key-id for signing."
412 (unless (eq (car-safe context) 'epg-context)
413 (signal 'wrong-type-argument (list 'epg-context-p context)))
414 (aset (cdr context) 11 signers))
416 (defun epg-context-set-sig-notations (context notations)
417 "Set the list of notations for signing."
418 (unless (eq (car-safe context) 'epg-context)
419 (signal 'wrong-type-argument (list 'epg-context-p context)))
420 (aset (cdr context) 12 notations))
422 (defun epg-context-set-process (context process)
423 "Set the process object of `epg-gpg-program'.
424 This function is for internal use only."
425 (unless (eq (car-safe context) 'epg-context)
426 (signal 'wrong-type-argument (list 'epg-context-p context)))
427 (aset (cdr context) 13 process))
429 (defun epg-context-set-output-file (context output-file)
430 "Set the output file of `epg-gpg-program'.
431 This function is for internal use only."
432 (unless (eq (car-safe context) 'epg-context)
433 (signal 'wrong-type-argument (list 'epg-context-p context)))
434 (aset (cdr context) 14 output-file))
436 (defun epg-context-set-result (context result)
437 "Set the result of the previous cryptographic operation."
438 (unless (eq (car-safe context) 'epg-context)
439 (signal 'wrong-type-argument (list 'epg-context-p context)))
440 (aset (cdr context) 15 result))
442 (defun epg-context-set-operation (context operation)
443 "Set the name of the current cryptographic operation."
444 (unless (eq (car-safe context) 'epg-context)
445 (signal 'wrong-type-argument (list 'epg-context-p context)))
446 (aset (cdr context) 16 operation))
448 (defun epg-context-set-pinentry-mode (context mode)
449 "Set the mode of pinentry invocation."
450 (unless (eq (car-safe context) 'epg-context)
451 (signal 'wrong-type-argument (list 'epg-context-p context)))
452 (unless (memq mode '(nil ask cancel error loopback))
453 (signal 'epg-error (list "Unknown pinentry mode" mode)))
454 (aset (cdr context) 17 mode))
456 (defun epg-make-signature (status &optional key-id)
457 "Return a signature object."
458 (cons 'epg-signature (vector status key-id nil nil nil nil nil nil nil nil
459 nil)))
461 (defun epg-signature-status (signature)
462 "Return the status code of SIGNATURE."
463 (unless (eq (car-safe signature) 'epg-signature)
464 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
465 (aref (cdr signature) 0))
467 (defun epg-signature-key-id (signature)
468 "Return the key-id of SIGNATURE."
469 (unless (eq (car-safe signature) 'epg-signature)
470 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
471 (aref (cdr signature) 1))
473 (defun epg-signature-validity (signature)
474 "Return the validity of SIGNATURE."
475 (unless (eq (car-safe signature) 'epg-signature)
476 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
477 (aref (cdr signature) 2))
479 (defun epg-signature-fingerprint (signature)
480 "Return the fingerprint of SIGNATURE."
481 (unless (eq (car-safe signature) 'epg-signature)
482 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
483 (aref (cdr signature) 3))
485 (defun epg-signature-creation-time (signature)
486 "Return the creation time of SIGNATURE."
487 (unless (eq (car-safe signature) 'epg-signature)
488 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
489 (aref (cdr signature) 4))
491 (defun epg-signature-expiration-time (signature)
492 "Return the expiration time of SIGNATURE."
493 (unless (eq (car-safe signature) 'epg-signature)
494 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
495 (aref (cdr signature) 5))
497 (defun epg-signature-pubkey-algorithm (signature)
498 "Return the public key algorithm of SIGNATURE."
499 (unless (eq (car-safe signature) 'epg-signature)
500 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
501 (aref (cdr signature) 6))
503 (defun epg-signature-digest-algorithm (signature)
504 "Return the digest algorithm of SIGNATURE."
505 (unless (eq (car-safe signature) 'epg-signature)
506 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
507 (aref (cdr signature) 7))
509 (defun epg-signature-class (signature)
510 "Return the class of SIGNATURE."
511 (unless (eq (car-safe signature) 'epg-signature)
512 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
513 (aref (cdr signature) 8))
515 (defun epg-signature-version (signature)
516 "Return the version of SIGNATURE."
517 (unless (eq (car-safe signature) 'epg-signature)
518 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
519 (aref (cdr signature) 9))
521 (defun epg-sig-notations (signature)
522 "Return the list of notations of SIGNATURE."
523 (unless (eq (car-safe signature) 'epg-signature)
524 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
525 (aref (cdr signature) 10))
527 (defun epg-signature-set-status (signature status)
528 "Set the status code of SIGNATURE."
529 (unless (eq (car-safe signature) 'epg-signature)
530 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
531 (aset (cdr signature) 0 status))
533 (defun epg-signature-set-key-id (signature key-id)
534 "Set the key-id of SIGNATURE."
535 (unless (eq (car-safe signature) 'epg-signature)
536 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
537 (aset (cdr signature) 1 key-id))
539 (defun epg-signature-set-validity (signature validity)
540 "Set the validity of SIGNATURE."
541 (unless (eq (car-safe signature) 'epg-signature)
542 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
543 (aset (cdr signature) 2 validity))
545 (defun epg-signature-set-fingerprint (signature fingerprint)
546 "Set the fingerprint of SIGNATURE."
547 (unless (eq (car-safe signature) 'epg-signature)
548 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
549 (aset (cdr signature) 3 fingerprint))
551 (defun epg-signature-set-creation-time (signature creation-time)
552 "Set the creation time of SIGNATURE."
553 (unless (eq (car-safe signature) 'epg-signature)
554 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
555 (aset (cdr signature) 4 creation-time))
557 (defun epg-signature-set-expiration-time (signature expiration-time)
558 "Set the expiration time of SIGNATURE."
559 (unless (eq (car-safe signature) 'epg-signature)
560 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
561 (aset (cdr signature) 5 expiration-time))
563 (defun epg-signature-set-pubkey-algorithm (signature pubkey-algorithm)
564 "Set the public key algorithm of SIGNATURE."
565 (unless (eq (car-safe signature) 'epg-signature)
566 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
567 (aset (cdr signature) 6 pubkey-algorithm))
569 (defun epg-signature-set-digest-algorithm (signature digest-algorithm)
570 "Set the digest algorithm of SIGNATURE."
571 (unless (eq (car-safe signature) 'epg-signature)
572 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
573 (aset (cdr signature) 7 digest-algorithm))
575 (defun epg-signature-set-class (signature class)
576 "Set the class of SIGNATURE."
577 (unless (eq (car-safe signature) 'epg-signature)
578 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
579 (aset (cdr signature) 8 class))
581 (defun epg-signature-set-version (signature version)
582 "Set the version of SIGNATURE."
583 (unless (eq (car-safe signature) 'epg-signature)
584 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
585 (aset (cdr signature) 9 version))
587 (defun epg-signature-set-notations (signature notations)
588 "Set the list of notations of SIGNATURE."
589 (unless (eq (car-safe signature) 'epg-signature)
590 (signal 'wrong-type-argument (list 'epg-signature-p signature)))
591 (aset (cdr signature) 10 notations))
593 (defun epg-make-new-signature (type pubkey-algorithm digest-algorithm
594 class creation-time fingerprint)
595 "Return a new signature object."
596 (cons 'epg-new-signature (vector type pubkey-algorithm digest-algorithm
597 class creation-time fingerprint)))
599 (defun epg-new-signature-type (new-signature)
600 "Return the type of NEW-SIGNATURE."
601 (unless (eq (car-safe new-signature) 'epg-new-signature)
602 (signal 'wrong-type-argument (list 'epg-new-signature-p new-signature)))
603 (aref (cdr new-signature) 0))
605 (defun epg-new-signature-pubkey-algorithm (new-signature)
606 "Return the public key algorithm of NEW-SIGNATURE."
607 (unless (eq (car-safe new-signature) 'epg-new-signature)
608 (signal 'wrong-type-argument (list 'epg-new-signature-p new-signature)))
609 (aref (cdr new-signature) 1))
611 (defun epg-new-signature-digest-algorithm (new-signature)
612 "Return the digest algorithm of NEW-SIGNATURE."
613 (unless (eq (car-safe new-signature) 'epg-new-signature)
614 (signal 'wrong-type-argument (list 'epg-new-signature-p new-signature)))
615 (aref (cdr new-signature) 2))
617 (defun epg-new-signature-class (new-signature)
618 "Return the class of NEW-SIGNATURE."
619 (unless (eq (car-safe new-signature) 'epg-new-signature)
620 (signal 'wrong-type-argument (list 'epg-new-signature-p new-signature)))
621 (aref (cdr new-signature) 3))
623 (defun epg-new-signature-creation-time (new-signature)
624 "Return the creation time of NEW-SIGNATURE."
625 (unless (eq (car-safe new-signature) 'epg-new-signature)
626 (signal 'wrong-type-argument (list 'epg-new-signature-p new-signature)))
627 (aref (cdr new-signature) 4))
629 (defun epg-new-signature-fingerprint (new-signature)
630 "Return the fingerprint of NEW-SIGNATURE."
631 (unless (eq (car-safe new-signature) 'epg-new-signature)
632 (signal 'wrong-type-argument (list 'epg-new-signature-p new-signature)))
633 (aref (cdr new-signature) 5))
635 (defun epg-make-key (owner-trust)
636 "Return a key object."
637 (cons 'epg-key (vector owner-trust nil nil)))
639 (defun epg-key-owner-trust (key)
640 "Return the owner trust of KEY."
641 (unless (eq (car-safe key) 'epg-key)
642 (signal 'wrong-type-argument (list 'epg-key-p key)))
643 (aref (cdr key) 0))
645 (defun epg-key-sub-key-list (key)
646 "Return the sub key list of KEY."
647 (unless (eq (car-safe key) 'epg-key)
648 (signal 'wrong-type-argument (list 'epg-key-p key)))
649 (aref (cdr key) 1))
651 (defun epg-key-user-id-list (key)
652 "Return the user ID list of KEY."
653 (unless (eq (car-safe key) 'epg-key)
654 (signal 'wrong-type-argument (list 'epg-key-p key)))
655 (aref (cdr key) 2))
657 (defun epg-key-set-sub-key-list (key sub-key-list)
658 "Set the sub key list of KEY."
659 (unless (eq (car-safe key) 'epg-key)
660 (signal 'wrong-type-argument (list 'epg-key-p key)))
661 (aset (cdr key) 1 sub-key-list))
663 (defun epg-key-set-user-id-list (key user-id-list)
664 "Set the user ID list of KEY."
665 (unless (eq (car-safe key) 'epg-key)
666 (signal 'wrong-type-argument (list 'epg-key-p key)))
667 (aset (cdr key) 2 user-id-list))
669 (defun epg-make-sub-key (validity capability secret-p algorithm length id
670 creation-time expiration-time)
671 "Return a sub key object."
672 (cons 'epg-sub-key
673 (vector validity capability secret-p algorithm length id creation-time
674 expiration-time nil)))
676 (defun epg-sub-key-validity (sub-key)
677 "Return the validity of SUB-KEY."
678 (unless (eq (car-safe sub-key) 'epg-sub-key)
679 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
680 (aref (cdr sub-key) 0))
682 (defun epg-sub-key-capability (sub-key)
683 "Return the capability of SUB-KEY."
684 (unless (eq (car-safe sub-key) 'epg-sub-key)
685 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
686 (aref (cdr sub-key) 1))
688 (defun epg-sub-key-secret-p (sub-key)
689 "Return non-nil if SUB-KEY is a secret key."
690 (unless (eq (car-safe sub-key) 'epg-sub-key)
691 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
692 (aref (cdr sub-key) 2))
694 (defun epg-sub-key-algorithm (sub-key)
695 "Return the algorithm of SUB-KEY."
696 (unless (eq (car-safe sub-key) 'epg-sub-key)
697 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
698 (aref (cdr sub-key) 3))
700 (defun epg-sub-key-length (sub-key)
701 "Return the length of SUB-KEY."
702 (unless (eq (car-safe sub-key) 'epg-sub-key)
703 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
704 (aref (cdr sub-key) 4))
706 (defun epg-sub-key-id (sub-key)
707 "Return the ID of SUB-KEY."
708 (unless (eq (car-safe sub-key) 'epg-sub-key)
709 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
710 (aref (cdr sub-key) 5))
712 (defun epg-sub-key-creation-time (sub-key)
713 "Return the creation time of SUB-KEY."
714 (unless (eq (car-safe sub-key) 'epg-sub-key)
715 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
716 (aref (cdr sub-key) 6))
718 (defun epg-sub-key-expiration-time (sub-key)
719 "Return the expiration time of SUB-KEY."
720 (unless (eq (car-safe sub-key) 'epg-sub-key)
721 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
722 (aref (cdr sub-key) 7))
724 (defun epg-sub-key-fingerprint (sub-key)
725 "Return the fingerprint of SUB-KEY."
726 (unless (eq (car-safe sub-key) 'epg-sub-key)
727 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
728 (aref (cdr sub-key) 8))
730 (defun epg-sub-key-set-fingerprint (sub-key fingerprint)
731 "Set the fingerprint of SUB-KEY.
732 This function is for internal use only."
733 (unless (eq (car-safe sub-key) 'epg-sub-key)
734 (signal 'wrong-type-argument (list 'epg-sub-key-p sub-key)))
735 (aset (cdr sub-key) 8 fingerprint))
737 (defun epg-make-user-id (validity string)
738 "Return a user ID object."
739 (cons 'epg-user-id (vector validity string nil)))
741 (defun epg-user-id-validity (user-id)
742 "Return the validity of USER-ID."
743 (unless (eq (car-safe user-id) 'epg-user-id)
744 (signal 'wrong-type-argument (list 'epg-user-id-p user-id)))
745 (aref (cdr user-id) 0))
747 (defun epg-user-id-string (user-id)
748 "Return the name of USER-ID."
749 (unless (eq (car-safe user-id) 'epg-user-id)
750 (signal 'wrong-type-argument (list 'epg-user-id-p user-id)))
751 (aref (cdr user-id) 1))
753 (defun epg-user-id-signature-list (user-id)
754 "Return the signature list of USER-ID."
755 (unless (eq (car-safe user-id) 'epg-user-id)
756 (signal 'wrong-type-argument (list 'epg-user-id-p user-id)))
757 (aref (cdr user-id) 2))
759 (defun epg-user-id-set-signature-list (user-id signature-list)
760 "Set the signature list of USER-ID."
761 (unless (eq (car-safe user-id) 'epg-user-id)
762 (signal 'wrong-type-argument (list 'epg-user-id-p user-id)))
763 (aset (cdr user-id) 2 signature-list))
765 (defun epg-make-key-signature (validity pubkey-algorithm key-id creation-time
766 expiration-time user-id class
767 exportable-p)
768 "Return a key signature object."
769 (cons 'epg-key-signature
770 (vector validity pubkey-algorithm key-id creation-time expiration-time
771 user-id class exportable-p)))
773 (defun epg-key-signature-validity (key-signature)
774 "Return the validity of KEY-SIGNATURE."
775 (unless (eq (car-safe key-signature) 'epg-key-signature)
776 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
777 (aref (cdr key-signature) 0))
779 (defun epg-key-signature-pubkey-algorithm (key-signature)
780 "Return the public key algorithm of KEY-SIGNATURE."
781 (unless (eq (car-safe key-signature) 'epg-key-signature)
782 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
783 (aref (cdr key-signature) 1))
785 (defun epg-key-signature-key-id (key-signature)
786 "Return the key-id of KEY-SIGNATURE."
787 (unless (eq (car-safe key-signature) 'epg-key-signature)
788 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
789 (aref (cdr key-signature) 2))
791 (defun epg-key-signature-creation-time (key-signature)
792 "Return the creation time of KEY-SIGNATURE."
793 (unless (eq (car-safe key-signature) 'epg-key-signature)
794 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
795 (aref (cdr key-signature) 3))
797 (defun epg-key-signature-expiration-time (key-signature)
798 "Return the expiration time of KEY-SIGNATURE."
799 (unless (eq (car-safe key-signature) 'epg-key-signature)
800 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
801 (aref (cdr key-signature) 4))
803 (defun epg-key-signature-user-id (key-signature)
804 "Return the user-id of KEY-SIGNATURE."
805 (unless (eq (car-safe key-signature) 'epg-key-signature)
806 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
807 (aref (cdr key-signature) 5))
809 (defun epg-key-signature-class (key-signature)
810 "Return the class of KEY-SIGNATURE."
811 (unless (eq (car-safe key-signature) 'epg-key-signature)
812 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
813 (aref (cdr key-signature) 6))
815 (defun epg-key-signature-exportable-p (key-signature)
816 "Return t if KEY-SIGNATURE is exportable."
817 (unless (eq (car-safe key-signature) 'epg-key-signature)
818 (signal 'wrong-type-argument (list 'epg-key-signature-p key-signature)))
819 (aref (cdr key-signature) 7))
821 (defun epg-make-sig-notation (name value &optional human-readable
822 critical)
823 "Return a notation object."
824 (cons 'epg-sig-notation (vector name value human-readable critical)))
826 (defun epg-sig-notation-name (sig-notation)
827 "Return the name of SIG-NOTATION."
828 (unless (eq (car-safe sig-notation) 'epg-sig-notation)
829 (signal 'wrong-type-argument (list 'epg-sig-notation-p
830 sig-notation)))
831 (aref (cdr sig-notation) 0))
833 (defun epg-sig-notation-value (sig-notation)
834 "Return the value of SIG-NOTATION."
835 (unless (eq (car-safe sig-notation) 'epg-sig-notation)
836 (signal 'wrong-type-argument (list 'epg-sig-notation-p
837 sig-notation)))
838 (aref (cdr sig-notation) 1))
840 (defun epg-sig-notation-human-readable (sig-notation)
841 "Return the human-readable of SIG-NOTATION."
842 (unless (eq (car-safe sig-notation) 'epg-sig-notation)
843 (signal 'wrong-type-argument (list 'epg-sig-notation-p
844 sig-notation)))
845 (aref (cdr sig-notation) 2))
847 (defun epg-sig-notation-critical (sig-notation)
848 "Return the critical of SIG-NOTATION."
849 (unless (eq (car-safe sig-notation) 'epg-sig-notation)
850 (signal 'wrong-type-argument (list 'epg-sig-notation-p
851 sig-notation)))
852 (aref (cdr sig-notation) 3))
854 (defun epg-sig-notation-set-value (sig-notation value)
855 "Set the value of SIG-NOTATION."
856 (unless (eq (car-safe sig-notation) 'epg-sig-notation)
857 (signal 'wrong-type-argument (list 'epg-sig-notation-p
858 sig-notation)))
859 (aset (cdr sig-notation) 1 value))
861 (defun epg-make-import-status (fingerprint &optional reason new user-id
862 signature sub-key secret)
863 "Return an import status object."
864 (cons 'epg-import-status (vector fingerprint reason new user-id signature
865 sub-key secret)))
867 (defun epg-import-status-fingerprint (import-status)
868 "Return the fingerprint of the key that was considered."
869 (unless (eq (car-safe import-status) 'epg-import-status)
870 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
871 (aref (cdr import-status) 0))
873 (defun epg-import-status-reason (import-status)
874 "Return the reason code for import failure."
875 (unless (eq (car-safe import-status) 'epg-import-status)
876 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
877 (aref (cdr import-status) 1))
879 (defun epg-import-status-new (import-status)
880 "Return t if the imported key was new."
881 (unless (eq (car-safe import-status) 'epg-import-status)
882 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
883 (aref (cdr import-status) 2))
885 (defun epg-import-status-user-id (import-status)
886 "Return t if the imported key contained new user IDs."
887 (unless (eq (car-safe import-status) 'epg-import-status)
888 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
889 (aref (cdr import-status) 3))
891 (defun epg-import-status-signature (import-status)
892 "Return t if the imported key contained new signatures."
893 (unless (eq (car-safe import-status) 'epg-import-status)
894 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
895 (aref (cdr import-status) 4))
897 (defun epg-import-status-sub-key (import-status)
898 "Return t if the imported key contained new sub keys."
899 (unless (eq (car-safe import-status) 'epg-import-status)
900 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
901 (aref (cdr import-status) 5))
903 (defun epg-import-status-secret (import-status)
904 "Return t if the imported key contained a secret key."
905 (unless (eq (car-safe import-status) 'epg-import-status)
906 (signal 'wrong-type-argument (list 'epg-import-status-p import-status)))
907 (aref (cdr import-status) 6))
909 (defun epg-make-import-result (considered no-user-id imported imported-rsa
910 unchanged new-user-ids new-sub-keys
911 new-signatures new-revocations
912 secret-read secret-imported
913 secret-unchanged not-imported
914 imports)
915 "Return an import result object."
916 (cons 'epg-import-result (vector considered no-user-id imported imported-rsa
917 unchanged new-user-ids new-sub-keys
918 new-signatures new-revocations secret-read
919 secret-imported secret-unchanged
920 not-imported imports)))
922 (defun epg-import-result-considered (import-result)
923 "Return the total number of considered keys."
924 (unless (eq (car-safe import-result) 'epg-import-result)
925 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
926 (aref (cdr import-result) 0))
928 (defun epg-import-result-no-user-id (import-result)
929 "Return the number of keys without user ID."
930 (unless (eq (car-safe import-result) 'epg-import-result)
931 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
932 (aref (cdr import-result) 1))
934 (defun epg-import-result-imported (import-result)
935 "Return the number of imported keys."
936 (unless (eq (car-safe import-result) 'epg-import-result)
937 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
938 (aref (cdr import-result) 2))
940 (defun epg-import-result-imported-rsa (import-result)
941 "Return the number of imported RSA keys."
942 (unless (eq (car-safe import-result) 'epg-import-result)
943 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
944 (aref (cdr import-result) 3))
946 (defun epg-import-result-unchanged (import-result)
947 "Return the number of unchanged keys."
948 (unless (eq (car-safe import-result) 'epg-import-result)
949 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
950 (aref (cdr import-result) 4))
952 (defun epg-import-result-new-user-ids (import-result)
953 "Return the number of new user IDs."
954 (unless (eq (car-safe import-result) 'epg-import-result)
955 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
956 (aref (cdr import-result) 5))
958 (defun epg-import-result-new-sub-keys (import-result)
959 "Return the number of new sub keys."
960 (unless (eq (car-safe import-result) 'epg-import-result)
961 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
962 (aref (cdr import-result) 6))
964 (defun epg-import-result-new-signatures (import-result)
965 "Return the number of new signatures."
966 (unless (eq (car-safe import-result) 'epg-import-result)
967 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
968 (aref (cdr import-result) 7))
970 (defun epg-import-result-new-revocations (import-result)
971 "Return the number of new revocations."
972 (unless (eq (car-safe import-result) 'epg-import-result)
973 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
974 (aref (cdr import-result) 8))
976 (defun epg-import-result-secret-read (import-result)
977 "Return the total number of secret keys read."
978 (unless (eq (car-safe import-result) 'epg-import-result)
979 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
980 (aref (cdr import-result) 9))
982 (defun epg-import-result-secret-imported (import-result)
983 "Return the number of imported secret keys."
984 (unless (eq (car-safe import-result) 'epg-import-result)
985 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
986 (aref (cdr import-result) 10))
988 (defun epg-import-result-secret-unchanged (import-result)
989 "Return the number of unchanged secret keys."
990 (unless (eq (car-safe import-result) 'epg-import-result)
991 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
992 (aref (cdr import-result) 11))
994 (defun epg-import-result-not-imported (import-result)
995 "Return the number of keys not imported."
996 (unless (eq (car-safe import-result) 'epg-import-result)
997 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
998 (aref (cdr import-result) 12))
1000 (defun epg-import-result-imports (import-result)
1001 "Return the list of `epg-import-status' objects."
1002 (unless (eq (car-safe import-result) 'epg-import-result)
1003 (signal 'wrong-type-argument (list 'epg-import-result-p import-result)))
1004 (aref (cdr import-result) 13))
1006 (defun epg-context-result-for (context name)
1007 "Return the result of CONTEXT associated with NAME."
1008 (cdr (assq name (epg-context-result context))))
1010 (defun epg-context-set-result-for (context name value)
1011 "Set the result of CONTEXT associated with NAME to VALUE."
1012 (let* ((result (epg-context-result context))
1013 (entry (assq name result)))
1014 (if entry
1015 (setcdr entry value)
1016 (epg-context-set-result context (cons (cons name value) result)))))
1018 (defun epg-signature-to-string (signature)
1019 "Convert SIGNATURE to a human readable string."
1020 (let* ((user-id (cdr (assoc (epg-signature-key-id signature)
1021 epg-user-id-alist)))
1022 (pubkey-algorithm (epg-signature-pubkey-algorithm signature))
1023 (key-id (epg-signature-key-id signature)))
1024 (concat
1025 (cond ((eq (epg-signature-status signature) 'good)
1026 "Good signature from ")
1027 ((eq (epg-signature-status signature) 'bad)
1028 "Bad signature from ")
1029 ((eq (epg-signature-status signature) 'expired)
1030 "Expired signature from ")
1031 ((eq (epg-signature-status signature) 'expired-key)
1032 "Signature made by expired key ")
1033 ((eq (epg-signature-status signature) 'revoked-key)
1034 "Signature made by revoked key ")
1035 ((eq (epg-signature-status signature) 'no-pubkey)
1036 "No public key for "))
1037 key-id
1038 (if user-id
1039 (concat " "
1040 (if (stringp user-id)
1041 user-id
1042 (epg-decode-dn user-id)))
1044 (if (epg-signature-validity signature)
1045 (format " (trust %s)" (epg-signature-validity signature))
1047 (if (epg-signature-creation-time signature)
1048 (format-time-string " created at %Y-%m-%dT%T%z"
1049 (epg-signature-creation-time signature))
1051 (if pubkey-algorithm
1052 (concat " using "
1053 (or (cdr (assq pubkey-algorithm epg-pubkey-algorithm-alist))
1054 (format "(unknown algorithm %d)" pubkey-algorithm)))
1055 ""))))
1057 (defun epg-verify-result-to-string (verify-result)
1058 "Convert VERIFY-RESULT to a human readable string."
1059 (mapconcat #'epg-signature-to-string verify-result "\n"))
1061 (defun epg-new-signature-to-string (new-signature)
1062 "Convert NEW-SIGNATURE to a human readable string."
1063 (concat
1064 (cond ((eq (epg-new-signature-type new-signature) 'detached)
1065 "Detached signature ")
1066 ((eq (epg-new-signature-type new-signature) 'clear)
1067 "Cleartext signature ")
1069 "Signature "))
1070 (cdr (assq (epg-new-signature-pubkey-algorithm new-signature)
1071 epg-pubkey-algorithm-alist))
1073 (cdr (assq (epg-new-signature-digest-algorithm new-signature)
1074 epg-digest-algorithm-alist))
1076 (format "%02X " (epg-new-signature-class new-signature))
1077 (epg-new-signature-fingerprint new-signature)))
1079 (defun epg-import-result-to-string (import-result)
1080 "Convert IMPORT-RESULT to a human readable string."
1081 (concat (format "Total number processed: %d\n"
1082 (epg-import-result-considered import-result))
1083 (if (> (epg-import-result-not-imported import-result) 0)
1084 (format " skipped new keys: %d\n"
1085 (epg-import-result-not-imported import-result)))
1086 (if (> (epg-import-result-no-user-id import-result) 0)
1087 (format " w/o user IDs: %d\n"
1088 (epg-import-result-no-user-id import-result)))
1089 (if (> (epg-import-result-imported import-result) 0)
1090 (concat (format " imported: %d"
1091 (epg-import-result-imported import-result))
1092 (if (> (epg-import-result-imported-rsa import-result) 0)
1093 (format " (RSA: %d)"
1094 (epg-import-result-imported-rsa
1095 import-result)))
1096 "\n"))
1097 (if (> (epg-import-result-unchanged import-result) 0)
1098 (format " unchanged: %d\n"
1099 (epg-import-result-unchanged import-result)))
1100 (if (> (epg-import-result-new-user-ids import-result) 0)
1101 (format " new user IDs: %d\n"
1102 (epg-import-result-new-user-ids import-result)))
1103 (if (> (epg-import-result-new-sub-keys import-result) 0)
1104 (format " new subkeys: %d\n"
1105 (epg-import-result-new-sub-keys import-result)))
1106 (if (> (epg-import-result-new-signatures import-result) 0)
1107 (format " new signatures: %d\n"
1108 (epg-import-result-new-signatures import-result)))
1109 (if (> (epg-import-result-new-revocations import-result) 0)
1110 (format " new key revocations: %d\n"
1111 (epg-import-result-new-revocations import-result)))
1112 (if (> (epg-import-result-secret-read import-result) 0)
1113 (format " secret keys read: %d\n"
1114 (epg-import-result-secret-read import-result)))
1115 (if (> (epg-import-result-secret-imported import-result) 0)
1116 (format " secret keys imported: %d\n"
1117 (epg-import-result-secret-imported import-result)))
1118 (if (> (epg-import-result-secret-unchanged import-result) 0)
1119 (format " secret keys unchanged: %d\n"
1120 (epg-import-result-secret-unchanged import-result)))))
1122 (defun epg-error-to-string (error)
1123 (cond
1124 ((eq (car error) 'exit)
1125 "Exit")
1126 ((eq (car error) 'quit)
1127 "Canceled")
1128 ((eq (car error) 'no-data)
1129 (let ((entry (assq (cdr error) epg-no-data-reason-alist)))
1130 (if entry
1131 (format "No data (%s)" (downcase (cdr entry)))
1132 "No data")))
1133 ((eq (car error) 'unexpected)
1134 (let ((entry (assq (cdr error) epg-unexpected-reason-alist)))
1135 (if entry
1136 (format "Unexpected (%s)" (downcase (cdr entry)))
1137 "Unexpected")))
1138 ((eq (car error) 'bad-armor)
1139 "Bad armor")
1140 ((memq (car error) '(invalid-recipient invalid-signer))
1141 (concat
1142 (if (eq (car error) 'invalid-recipient)
1143 "Unusable public key"
1144 "Unusable secret key")
1145 (let ((entry (assq 'requested (cdr error))))
1146 (if entry
1147 (format ": %s" (cdr entry))
1148 ": <unknown>"))
1149 (let ((entry (assq 'reason (cdr error))))
1150 (if (and entry
1151 (> (cdr entry) 0) ;no specific reason given
1152 (setq entry (assq (cdr entry)
1153 epg-invalid-recipients-reason-alist)))
1154 (format " (%s)" (downcase (cdr entry)))
1155 ""))))
1156 ((eq (car error) 'no-pubkey)
1157 (format "No public key: %s" (cdr error)))
1158 ((eq (car error) 'no-seckey)
1159 (format "No secret key: %s" (cdr error)))
1160 ((eq (car error) 'no-recipients)
1161 "No recipients")
1162 ((eq (car error) 'no-signers)
1163 "No signers")
1164 ((eq (car error) 'delete-problem)
1165 (let ((entry (assq (cdr error) epg-delete-problem-reason-alist)))
1166 (if entry
1167 (format "Delete problem (%s)" (downcase (cdr entry)))
1168 "Delete problem")))
1169 ((eq (car error) 'key-not-created)
1170 "Key not created")))
1172 (defun epg-errors-to-string (errors)
1173 (mapconcat #'epg-error-to-string errors "; "))
1175 (defun epg--start (context args)
1176 "Start `epg-gpg-program' in a subprocess with given ARGS."
1177 (if (and (epg-context-process context)
1178 (eq (process-status (epg-context-process context)) 'run))
1179 (error "%s is already running in this context"
1180 (epg-context-program context)))
1181 (let* ((agent-info (getenv "GPG_AGENT_INFO"))
1182 (args (append (list "--no-tty"
1183 "--status-fd" "1"
1184 "--yes")
1185 (if (and (not (eq (epg-context-protocol context) 'CMS))
1186 (string-match ":" (or agent-info "")))
1187 '("--use-agent"))
1188 (if (and (not (eq (epg-context-protocol context) 'CMS))
1189 (epg-context-progress-callback context))
1190 '("--enable-progress-filter"))
1191 (if (epg-context-home-directory context)
1192 (list "--homedir"
1193 (epg-context-home-directory context)))
1194 (unless (eq (epg-context-protocol context) 'CMS)
1195 '("--command-fd" "0"))
1196 (if (epg-context-armor context) '("--armor"))
1197 (if (epg-context-textmode context) '("--textmode"))
1198 (if (epg-context-output-file context)
1199 (list "--output" (epg-context-output-file context)))
1200 (if (epg-context-pinentry-mode context)
1201 (list "--pinentry-mode"
1202 (symbol-name (epg-context-pinentry-mode
1203 context))))
1204 args))
1205 (coding-system-for-write 'binary)
1206 (coding-system-for-read 'binary)
1207 process-connection-type
1208 (process-environment process-environment)
1209 (orig-mode (default-file-modes))
1210 (buffer (generate-new-buffer " *epg*"))
1211 process
1212 terminal-name
1213 agent-file
1214 (agent-mtime '(0 0 0 0)))
1215 ;; Set GPG_TTY and TERM for pinentry-curses. Note that we can't
1216 ;; use `terminal-name' here to get the real pty name for the child
1217 ;; process, though /dev/fd/0" is not portable.
1218 (unless (memq system-type '(ms-dos windows-nt))
1219 (with-temp-buffer
1220 (condition-case nil
1221 (when (= (call-process "tty" "/dev/fd/0" t) 0)
1222 (delete-char -1)
1223 (setq terminal-name (buffer-string)))
1224 (file-error))))
1225 (when terminal-name
1226 (setq process-environment
1227 (cons (concat "GPG_TTY=" terminal-name)
1228 (cons "TERM=xterm" process-environment))))
1229 ;; Record modified time of gpg-agent socket to restore the Emacs
1230 ;; frame on text terminal in `epg-wait-for-completion'.
1231 ;; See
1232 ;; <http://lists.gnu.org/archive/html/emacs-devel/2007-02/msg00755.html>
1233 ;; for more details.
1234 (when (and agent-info (string-match "\\(.*\\):[0-9]+:[0-9]+" agent-info))
1235 (setq agent-file (match-string 1 agent-info)
1236 agent-mtime (or (nth 5 (file-attributes agent-file)) '(0 0 0 0))))
1237 (if epg-debug
1238 (save-excursion
1239 (unless epg-debug-buffer
1240 (setq epg-debug-buffer (generate-new-buffer " *epg-debug*")))
1241 (set-buffer epg-debug-buffer)
1242 (goto-char (point-max))
1243 (insert (if agent-info
1244 (format "GPG_AGENT_INFO=%s\n" agent-info)
1245 "GPG_AGENT_INFO is not set\n")
1246 (format "%s %s\n"
1247 (epg-context-program context)
1248 (mapconcat #'identity args " ")))))
1249 (with-current-buffer buffer
1250 (if (fboundp 'set-buffer-multibyte)
1251 (set-buffer-multibyte nil))
1252 (make-local-variable 'epg-last-status)
1253 (setq epg-last-status nil)
1254 (make-local-variable 'epg-read-point)
1255 (setq epg-read-point (point-min))
1256 (make-local-variable 'epg-process-filter-running)
1257 (setq epg-process-filter-running nil)
1258 (make-local-variable 'epg-pending-status-list)
1259 (setq epg-pending-status-list nil)
1260 (make-local-variable 'epg-key-id)
1261 (setq epg-key-id nil)
1262 (make-local-variable 'epg-context)
1263 (setq epg-context context)
1264 (make-local-variable 'epg-agent-file)
1265 (setq epg-agent-file agent-file)
1266 (make-local-variable 'epg-agent-mtime)
1267 (setq epg-agent-mtime agent-mtime))
1268 (unwind-protect
1269 (progn
1270 (set-default-file-modes 448)
1271 (setq process
1272 (apply #'start-process "epg" buffer
1273 (epg-context-program context)
1274 args)))
1275 (set-default-file-modes orig-mode))
1276 (set-process-filter process #'epg--process-filter)
1277 (epg-context-set-process context process)))
1279 (defun epg--process-filter (process input)
1280 (if epg-debug
1281 (with-current-buffer
1282 (or epg-debug-buffer
1283 (setq epg-debug-buffer (generate-new-buffer " *epg-debug*")))
1284 (goto-char (point-max))
1285 (insert input)))
1286 (if (buffer-live-p (process-buffer process))
1287 (with-current-buffer (process-buffer process)
1288 (save-excursion
1289 (goto-char (point-max))
1290 (insert input)
1291 (unless epg-process-filter-running
1292 (let ((epg-process-filter-running t))
1293 (goto-char epg-read-point)
1294 (beginning-of-line)
1295 (while (looking-at ".*\n") ;the input line finished
1296 (if (looking-at "\\[GNUPG:] \\([A-Z_]+\\) ?\\(.*\\)")
1297 (let* ((status (match-string 1))
1298 (string (match-string 2))
1299 (symbol (intern-soft (concat "epg--status-"
1300 status))))
1301 (if (member status epg-pending-status-list)
1302 (setq epg-pending-status-list nil))
1303 (if (and symbol
1304 (fboundp symbol))
1305 (funcall symbol epg-context string))
1306 (setq epg-last-status (cons status string))))
1307 (forward-line)
1308 (setq epg-read-point (point)))))))))
1310 (defun epg-read-output (context)
1311 "Read the output file CONTEXT and return the content as a string."
1312 (with-temp-buffer
1313 (if (fboundp 'set-buffer-multibyte)
1314 (set-buffer-multibyte nil))
1315 (if (file-exists-p (epg-context-output-file context))
1316 (let ((coding-system-for-read 'binary))
1317 (insert-file-contents (epg-context-output-file context))
1318 (buffer-string)))))
1320 (defun epg-wait-for-status (context status-list)
1321 "Wait until one of elements in STATUS-LIST arrives."
1322 (with-current-buffer (process-buffer (epg-context-process context))
1323 (setq epg-pending-status-list status-list)
1324 (while (and (eq (process-status (epg-context-process context)) 'run)
1325 epg-pending-status-list)
1326 (accept-process-output (epg-context-process context) 1))
1327 (if epg-pending-status-list
1328 (epg-context-set-result-for
1329 context 'error
1330 (cons '(exit)
1331 (epg-context-result-for context 'error))))))
1333 (defun epg-wait-for-completion (context)
1334 "Wait until the `epg-gpg-program' process completes."
1335 (while (eq (process-status (epg-context-process context)) 'run)
1336 (accept-process-output (epg-context-process context) 1))
1337 ;; This line is needed to run the process-filter right now.
1338 (sleep-for 0.1)
1339 ;; Restore Emacs frame on text terminal, when pinentry-curses has terminated.
1340 (if (with-current-buffer (process-buffer (epg-context-process context))
1341 (and epg-agent-file
1342 (> (float-time (or (nth 5 (file-attributes epg-agent-file))
1343 '(0 0 0 0)))
1344 (float-time epg-agent-mtime))))
1345 (redraw-frame))
1346 (epg-context-set-result-for
1347 context 'error
1348 (nreverse (epg-context-result-for context 'error))))
1350 (defun epg-reset (context)
1351 "Reset the CONTEXT."
1352 (if (and (epg-context-process context)
1353 (buffer-live-p (process-buffer (epg-context-process context))))
1354 (kill-buffer (process-buffer (epg-context-process context))))
1355 (epg-context-set-process context nil))
1357 (defun epg-delete-output-file (context)
1358 "Delete the output file of CONTEXT."
1359 (if (and (epg-context-output-file context)
1360 (file-exists-p (epg-context-output-file context)))
1361 (delete-file (epg-context-output-file context))))
1363 (eval-and-compile
1364 (if (fboundp 'decode-coding-string)
1365 (defalias 'epg--decode-coding-string 'decode-coding-string)
1366 (defalias 'epg--decode-coding-string 'identity)))
1368 (defun epg--status-USERID_HINT (_context string)
1369 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
1370 (let* ((key-id (match-string 1 string))
1371 (user-id (match-string 2 string))
1372 (entry (assoc key-id epg-user-id-alist)))
1373 (condition-case nil
1374 (setq user-id (epg--decode-coding-string
1375 (epg--decode-percent-escape user-id)
1376 'utf-8))
1377 (error))
1378 (if entry
1379 (setcdr entry user-id)
1380 (setq epg-user-id-alist (cons (cons key-id user-id)
1381 epg-user-id-alist))))))
1383 (defun epg--status-NEED_PASSPHRASE (_context string)
1384 (if (string-match "\\`\\([^ ]+\\)" string)
1385 (setq epg-key-id (match-string 1 string))))
1387 (defun epg--status-NEED_PASSPHRASE_SYM (_context _string)
1388 (setq epg-key-id 'SYM))
1390 (defun epg--status-NEED_PASSPHRASE_PIN (_context _string)
1391 (setq epg-key-id 'PIN))
1393 (eval-and-compile
1394 (if (fboundp 'clear-string)
1395 (defalias 'epg--clear-string 'clear-string)
1396 (defun epg--clear-string (string)
1397 (fillarray string 0))))
1399 (eval-and-compile
1400 (if (fboundp 'encode-coding-string)
1401 (defalias 'epg--encode-coding-string 'encode-coding-string)
1402 (defalias 'epg--encode-coding-string 'identity)))
1404 (defun epg--status-GET_HIDDEN (context string)
1405 (when (and epg-key-id
1406 (string-match "\\`passphrase\\." string))
1407 (unless (epg-context-passphrase-callback context)
1408 (error "passphrase-callback not set"))
1409 (let (inhibit-quit
1410 passphrase
1411 passphrase-with-new-line
1412 encoded-passphrase-with-new-line)
1413 (unwind-protect
1414 (condition-case nil
1415 (progn
1416 (setq passphrase
1417 (funcall
1418 (car (epg-context-passphrase-callback context))
1419 context
1420 epg-key-id
1421 (cdr (epg-context-passphrase-callback context))))
1422 (when passphrase
1423 (setq passphrase-with-new-line (concat passphrase "\n"))
1424 (epg--clear-string passphrase)
1425 (setq passphrase nil)
1426 (if epg-passphrase-coding-system
1427 (progn
1428 (setq encoded-passphrase-with-new-line
1429 (epg--encode-coding-string
1430 passphrase-with-new-line
1431 (coding-system-change-eol-conversion
1432 epg-passphrase-coding-system 'unix)))
1433 (epg--clear-string passphrase-with-new-line)
1434 (setq passphrase-with-new-line nil))
1435 (setq encoded-passphrase-with-new-line
1436 passphrase-with-new-line
1437 passphrase-with-new-line nil))
1438 (process-send-string (epg-context-process context)
1439 encoded-passphrase-with-new-line)))
1440 (quit
1441 (epg-context-set-result-for
1442 context 'error
1443 (cons '(quit)
1444 (epg-context-result-for context 'error)))
1445 (delete-process (epg-context-process context))))
1446 (if passphrase
1447 (epg--clear-string passphrase))
1448 (if passphrase-with-new-line
1449 (epg--clear-string passphrase-with-new-line))
1450 (if encoded-passphrase-with-new-line
1451 (epg--clear-string encoded-passphrase-with-new-line))))))
1453 (defun epg--prompt-GET_BOOL (_context string)
1454 (let ((entry (assoc string epg-prompt-alist)))
1455 (y-or-n-p (if entry (cdr entry) (concat string "? ")))))
1457 (defun epg--prompt-GET_BOOL-untrusted_key.override (_context _string)
1458 (y-or-n-p (if (and (equal (car epg-last-status) "USERID_HINT")
1459 (string-match "\\`\\([^ ]+\\) \\(.*\\)"
1460 (cdr epg-last-status)))
1461 (let* ((key-id (match-string 1 (cdr epg-last-status)))
1462 (user-id (match-string 2 (cdr epg-last-status)))
1463 (entry (assoc key-id epg-user-id-alist)))
1464 (if entry
1465 (setq user-id (cdr entry)))
1466 (format "Untrusted key %s %s. Use anyway? " key-id user-id))
1467 "Use untrusted key anyway? ")))
1469 (defun epg--status-GET_BOOL (context string)
1470 (let (inhibit-quit)
1471 (condition-case nil
1472 (if (funcall (or (intern-soft (concat "epg--prompt-GET_BOOL-" string))
1473 #'epg--prompt-GET_BOOL)
1474 context string)
1475 (process-send-string (epg-context-process context) "y\n")
1476 (process-send-string (epg-context-process context) "n\n"))
1477 (quit
1478 (epg-context-set-result-for
1479 context 'error
1480 (cons '(quit)
1481 (epg-context-result-for context 'error)))
1482 (delete-process (epg-context-process context))))))
1484 (defun epg--status-GET_LINE (context string)
1485 (let ((entry (assoc string epg-prompt-alist))
1486 inhibit-quit)
1487 (condition-case nil
1488 (process-send-string (epg-context-process context)
1489 (concat (read-string
1490 (if entry
1491 (cdr entry)
1492 (concat string ": ")))
1493 "\n"))
1494 (quit
1495 (epg-context-set-result-for
1496 context 'error
1497 (cons '(quit)
1498 (epg-context-result-for context 'error)))
1499 (delete-process (epg-context-process context))))))
1501 (defun epg--status-*SIG (context status string)
1502 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
1503 (let* ((key-id (match-string 1 string))
1504 (user-id (match-string 2 string))
1505 (entry (assoc key-id epg-user-id-alist)))
1506 (epg-context-set-result-for
1507 context
1508 'verify
1509 (cons (epg-make-signature status key-id)
1510 (epg-context-result-for context 'verify)))
1511 (condition-case nil
1512 (if (eq (epg-context-protocol context) 'CMS)
1513 (setq user-id (epg-dn-from-string user-id))
1514 (setq user-id (epg--decode-coding-string
1515 (epg--decode-percent-escape user-id)
1516 'utf-8)))
1517 (error))
1518 (if entry
1519 (setcdr entry user-id)
1520 (setq epg-user-id-alist
1521 (cons (cons key-id user-id) epg-user-id-alist))))
1522 (epg-context-set-result-for
1523 context
1524 'verify
1525 (cons (epg-make-signature status)
1526 (epg-context-result-for context 'verify)))))
1528 (defun epg--status-GOODSIG (context string)
1529 (epg--status-*SIG context 'good string))
1531 (defun epg--status-EXPSIG (context string)
1532 (epg--status-*SIG context 'expired string))
1534 (defun epg--status-EXPKEYSIG (context string)
1535 (epg--status-*SIG context 'expired-key string))
1537 (defun epg--status-REVKEYSIG (context string)
1538 (epg--status-*SIG context 'revoked-key string))
1540 (defun epg--status-BADSIG (context string)
1541 (epg--status-*SIG context 'bad string))
1543 (defun epg--status-NO_PUBKEY (context string)
1544 (if (eq (epg-context-operation context) 'verify)
1545 (let ((signature (car (epg-context-result-for context 'verify))))
1546 (if (and signature
1547 (eq (epg-signature-status signature) 'error)
1548 (equal (epg-signature-key-id signature) string))
1549 (epg-signature-set-status signature 'no-pubkey)))
1550 (epg-context-set-result-for
1551 context 'error
1552 (cons (cons 'no-pubkey string)
1553 (epg-context-result-for context 'error)))))
1555 (defun epg--status-NO_SECKEY (context string)
1556 (epg-context-set-result-for
1557 context 'error
1558 (cons (cons 'no-seckey string)
1559 (epg-context-result-for context 'error))))
1561 (defun epg--time-from-seconds (seconds)
1562 (let ((number-seconds (string-to-number (concat seconds ".0"))))
1563 (cons (floor (/ number-seconds 65536))
1564 (floor (mod number-seconds 65536)))))
1566 (defun epg--status-ERRSIG (context string)
1567 (if (string-match "\\`\\([^ ]+\\) \\([0-9]+\\) \\([0-9]+\\) \
1568 \\([0-9A-Fa-f][0-9A-Fa-f]\\) \\([^ ]+\\) \\([0-9]+\\)"
1569 string)
1570 (let ((signature (epg-make-signature 'error)))
1571 (epg-context-set-result-for
1572 context
1573 'verify
1574 (cons signature
1575 (epg-context-result-for context 'verify)))
1576 (epg-signature-set-key-id
1577 signature
1578 (match-string 1 string))
1579 (epg-signature-set-pubkey-algorithm
1580 signature
1581 (string-to-number (match-string 2 string)))
1582 (epg-signature-set-digest-algorithm
1583 signature
1584 (string-to-number (match-string 3 string)))
1585 (epg-signature-set-class
1586 signature
1587 (string-to-number (match-string 4 string) 16))
1588 (epg-signature-set-creation-time
1589 signature
1590 (epg--time-from-seconds (match-string 5 string))))))
1592 (defun epg--status-VALIDSIG (context string)
1593 (let ((signature (car (epg-context-result-for context 'verify))))
1594 (when (and signature
1595 (eq (epg-signature-status signature) 'good)
1596 (string-match "\\`\\([^ ]+\\) [^ ]+ \\([^ ]+\\) \\([^ ]+\\) \
1597 \\([0-9]+\\) [^ ]+ \\([0-9]+\\) \\([0-9]+\\) \\([0-9A-Fa-f][0-9A-Fa-f]\\) \
1598 \\(.*\\)"
1599 string))
1600 (epg-signature-set-fingerprint
1601 signature
1602 (match-string 1 string))
1603 (epg-signature-set-creation-time
1604 signature
1605 (epg--time-from-seconds (match-string 2 string)))
1606 (unless (equal (match-string 3 string) "0")
1607 (epg-signature-set-expiration-time
1608 signature
1609 (epg--time-from-seconds (match-string 3 string))))
1610 (epg-signature-set-version
1611 signature
1612 (string-to-number (match-string 4 string)))
1613 (epg-signature-set-pubkey-algorithm
1614 signature
1615 (string-to-number (match-string 5 string)))
1616 (epg-signature-set-digest-algorithm
1617 signature
1618 (string-to-number (match-string 6 string)))
1619 (epg-signature-set-class
1620 signature
1621 (string-to-number (match-string 7 string) 16)))))
1623 (defun epg--status-TRUST_UNDEFINED (context _string)
1624 (let ((signature (car (epg-context-result-for context 'verify))))
1625 (if (and signature
1626 (eq (epg-signature-status signature) 'good))
1627 (epg-signature-set-validity signature 'undefined))))
1629 (defun epg--status-TRUST_NEVER (context _string)
1630 (let ((signature (car (epg-context-result-for context 'verify))))
1631 (if (and signature
1632 (eq (epg-signature-status signature) 'good))
1633 (epg-signature-set-validity signature 'never))))
1635 (defun epg--status-TRUST_MARGINAL (context _string)
1636 (let ((signature (car (epg-context-result-for context 'verify))))
1637 (if (and signature
1638 (eq (epg-signature-status signature) 'marginal))
1639 (epg-signature-set-validity signature 'marginal))))
1641 (defun epg--status-TRUST_FULLY (context _string)
1642 (let ((signature (car (epg-context-result-for context 'verify))))
1643 (if (and signature
1644 (eq (epg-signature-status signature) 'good))
1645 (epg-signature-set-validity signature 'full))))
1647 (defun epg--status-TRUST_ULTIMATE (context _string)
1648 (let ((signature (car (epg-context-result-for context 'verify))))
1649 (if (and signature
1650 (eq (epg-signature-status signature) 'good))
1651 (epg-signature-set-validity signature 'ultimate))))
1653 (defun epg--status-NOTATION_NAME (context string)
1654 (let ((signature (car (epg-context-result-for context 'verify))))
1655 (if signature
1656 (epg-signature-set-notations
1657 signature
1658 (cons (epg-make-sig-notation string nil t nil)
1659 (epg-sig-notations signature))))))
1661 (defun epg--status-NOTATION_DATA (context string)
1662 (let ((signature (car (epg-context-result-for context 'verify)))
1663 notation)
1664 (if (and signature
1665 (setq notation (car (epg-sig-notations signature))))
1666 (epg-sig-notation-set-value notation string))))
1668 (defun epg--status-POLICY_URL (context string)
1669 (let ((signature (car (epg-context-result-for context 'verify))))
1670 (if signature
1671 (epg-signature-set-notations
1672 signature
1673 (cons (epg-make-sig-notation nil string t nil)
1674 (epg-sig-notations signature))))))
1676 (defun epg--status-PROGRESS (context string)
1677 (if (and (epg-context-progress-callback context)
1678 (string-match "\\`\\([^ ]+\\) \\([^ ]\\) \\([0-9]+\\) \\([0-9]+\\)"
1679 string))
1680 (funcall (car (epg-context-progress-callback context))
1681 context
1682 (match-string 1 string)
1683 (match-string 2 string)
1684 (string-to-number (match-string 3 string))
1685 (string-to-number (match-string 4 string))
1686 (cdr (epg-context-progress-callback context)))))
1688 (defun epg--status-ENC_TO (context string)
1689 (if (string-match "\\`\\([0-9A-Za-z]+\\) \\([0-9]+\\) \\([0-9]+\\)" string)
1690 (epg-context-set-result-for
1691 context 'encrypted-to
1692 (cons (list (match-string 1 string)
1693 (string-to-number (match-string 2 string))
1694 (string-to-number (match-string 3 string)))
1695 (epg-context-result-for context 'encrypted-to)))))
1697 (defun epg--status-DECRYPTION_FAILED (context _string)
1698 (epg-context-set-result-for context 'decryption-failed t))
1700 (defun epg--status-DECRYPTION_OKAY (context _string)
1701 (epg-context-set-result-for context 'decryption-okay t))
1703 (defun epg--status-NODATA (context string)
1704 (epg-context-set-result-for
1705 context 'error
1706 (cons (cons 'no-data (string-to-number string))
1707 (epg-context-result-for context 'error))))
1709 (defun epg--status-UNEXPECTED (context string)
1710 (epg-context-set-result-for
1711 context 'error
1712 (cons (cons 'unexpected (string-to-number string))
1713 (epg-context-result-for context 'error))))
1715 (defun epg--status-KEYEXPIRED (context string)
1716 (epg-context-set-result-for
1717 context 'key
1718 (cons (list 'key-expired (cons 'expiration-time
1719 (epg--time-from-seconds string)))
1720 (epg-context-result-for context 'key))))
1722 (defun epg--status-KEYREVOKED (context _string)
1723 (epg-context-set-result-for
1724 context 'key
1725 (cons '(key-revoked)
1726 (epg-context-result-for context 'key))))
1728 (defun epg--status-BADARMOR (context _string)
1729 (epg-context-set-result-for
1730 context 'error
1731 (cons '(bad-armor)
1732 (epg-context-result-for context 'error))))
1734 (defun epg--status-INV_RECP (context string)
1735 (if (string-match "\\`\\([0-9]+\\) \\(.*\\)" string)
1736 (epg-context-set-result-for
1737 context 'error
1738 (cons (list 'invalid-recipient
1739 (cons 'reason
1740 (string-to-number (match-string 1 string)))
1741 (cons 'requested
1742 (match-string 2 string)))
1743 (epg-context-result-for context 'error)))))
1745 (defun epg--status-INV_SGNR (context string)
1746 (if (string-match "\\`\\([0-9]+\\) \\(.*\\)" string)
1747 (epg-context-set-result-for
1748 context 'error
1749 (cons (list 'invalid-signer
1750 (cons 'reason
1751 (string-to-number (match-string 1 string)))
1752 (cons 'requested
1753 (match-string 2 string)))
1754 (epg-context-result-for context 'error)))))
1756 (defun epg--status-NO_RECP (context _string)
1757 (epg-context-set-result-for
1758 context 'error
1759 (cons '(no-recipients)
1760 (epg-context-result-for context 'error))))
1762 (defun epg--status-NO_SGNR (context _string)
1763 (epg-context-set-result-for
1764 context 'error
1765 (cons '(no-signers)
1766 (epg-context-result-for context 'error))))
1768 (defun epg--status-DELETE_PROBLEM (context string)
1769 (if (string-match "\\`\\([0-9]+\\)" string)
1770 (epg-context-set-result-for
1771 context 'error
1772 (cons (cons 'delete-problem
1773 (string-to-number (match-string 1 string)))
1774 (epg-context-result-for context 'error)))))
1776 (defun epg--status-SIG_CREATED (context string)
1777 (if (string-match "\\`\\([DCS]\\) \\([0-9]+\\) \\([0-9]+\\) \
1778 \\([0-9A-Fa-F][0-9A-Fa-F]\\) \\(.*\\) " string)
1779 (epg-context-set-result-for
1780 context 'sign
1781 (cons (epg-make-new-signature
1782 (cdr (assq (aref (match-string 1 string) 0)
1783 epg-new-signature-type-alist))
1784 (string-to-number (match-string 2 string))
1785 (string-to-number (match-string 3 string))
1786 (string-to-number (match-string 4 string) 16)
1787 (epg--time-from-seconds (match-string 5 string))
1788 (substring string (match-end 0)))
1789 (epg-context-result-for context 'sign)))))
1791 (defun epg--status-KEY_CREATED (context string)
1792 (if (string-match "\\`\\([BPS]\\) \\([^ ]+\\)" string)
1793 (epg-context-set-result-for
1794 context 'generate-key
1795 (cons (list (cons 'type (string-to-char (match-string 1 string)))
1796 (cons 'fingerprint (match-string 2 string)))
1797 (epg-context-result-for context 'generate-key)))))
1799 (defun epg--status-KEY_NOT_CREATED (context _string)
1800 (epg-context-set-result-for
1801 context 'error
1802 (cons '(key-not-created)
1803 (epg-context-result-for context 'error))))
1805 (defun epg--status-IMPORTED (_context string)
1806 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
1807 (let* ((key-id (match-string 1 string))
1808 (user-id (match-string 2 string))
1809 (entry (assoc key-id epg-user-id-alist)))
1810 (condition-case nil
1811 (setq user-id (epg--decode-coding-string
1812 (epg--decode-percent-escape user-id)
1813 'utf-8))
1814 (error))
1815 (if entry
1816 (setcdr entry user-id)
1817 (setq epg-user-id-alist (cons (cons key-id user-id)
1818 epg-user-id-alist))))))
1820 (defun epg--status-IMPORT_OK (context string)
1821 (if (string-match "\\`\\([0-9]+\\)\\( \\(.+\\)\\)?" string)
1822 (let ((reason (string-to-number (match-string 1 string))))
1823 (epg-context-set-result-for
1824 context 'import-status
1825 (cons (epg-make-import-status (if (match-beginning 2)
1826 (match-string 3 string))
1828 (/= (logand reason 1) 0)
1829 (/= (logand reason 2) 0)
1830 (/= (logand reason 4) 0)
1831 (/= (logand reason 8) 0)
1832 (/= (logand reason 16) 0))
1833 (epg-context-result-for context 'import-status))))))
1835 (defun epg--status-IMPORT_PROBLEM (context string)
1836 (if (string-match "\\`\\([0-9]+\\)\\( \\(.+\\)\\)?" string)
1837 (epg-context-set-result-for
1838 context 'import-status
1839 (cons (epg-make-import-status
1840 (if (match-beginning 2)
1841 (match-string 3 string))
1842 (string-to-number (match-string 1 string)))
1843 (epg-context-result-for context 'import-status)))))
1845 (defun epg--status-IMPORT_RES (context string)
1846 (when (string-match "\\`\\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \
1847 \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \
1848 \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\)" string)
1849 (epg-context-set-result-for
1850 context 'import
1851 (epg-make-import-result (string-to-number (match-string 1 string))
1852 (string-to-number (match-string 2 string))
1853 (string-to-number (match-string 3 string))
1854 (string-to-number (match-string 4 string))
1855 (string-to-number (match-string 5 string))
1856 (string-to-number (match-string 6 string))
1857 (string-to-number (match-string 7 string))
1858 (string-to-number (match-string 8 string))
1859 (string-to-number (match-string 9 string))
1860 (string-to-number (match-string 10 string))
1861 (string-to-number (match-string 11 string))
1862 (string-to-number (match-string 12 string))
1863 (string-to-number (match-string 13 string))
1864 (epg-context-result-for context 'import-status)))
1865 (epg-context-set-result-for context 'import-status nil)))
1867 (defun epg-passphrase-callback-function (context key-id _handback)
1868 (declare (obsolete epa-passphrase-callback-function "23.1"))
1869 (if (eq key-id 'SYM)
1870 (read-passwd "Passphrase for symmetric encryption: "
1871 (eq (epg-context-operation context) 'encrypt))
1872 (read-passwd
1873 (if (eq key-id 'PIN)
1874 "Passphrase for PIN: "
1875 (let ((entry (assoc key-id epg-user-id-alist)))
1876 (if entry
1877 (format "Passphrase for %s %s: " key-id (cdr entry))
1878 (format "Passphrase for %s: " key-id)))))))
1880 (defun epg--list-keys-1 (context name mode)
1881 (let ((args (append (if (epg-context-home-directory context)
1882 (list "--homedir"
1883 (epg-context-home-directory context)))
1884 '("--with-colons" "--no-greeting" "--batch"
1885 "--with-fingerprint" "--with-fingerprint")
1886 (unless (eq (epg-context-protocol context) 'CMS)
1887 '("--fixed-list-mode"))))
1888 (list-keys-option (if (memq mode '(t secret))
1889 "--list-secret-keys"
1890 (if (memq mode '(nil public))
1891 "--list-keys"
1892 "--list-sigs")))
1893 (coding-system-for-read 'binary)
1894 keys string field index)
1895 (if name
1896 (progn
1897 (unless (listp name)
1898 (setq name (list name)))
1899 (while name
1900 (setq args (append args (list list-keys-option (car name)))
1901 name (cdr name))))
1902 (setq args (append args (list list-keys-option))))
1903 (with-temp-buffer
1904 (apply #'call-process
1905 (epg-context-program context)
1906 nil (list t nil) nil args)
1907 (goto-char (point-min))
1908 (while (re-search-forward "^[a-z][a-z][a-z]:.*" nil t)
1909 (setq keys (cons (make-vector 15 nil) keys)
1910 string (match-string 0)
1911 index 0
1912 field 0)
1913 (while (and (< field (length (car keys)))
1914 (eq index
1915 (string-match "\\([^:]+\\)?:" string index)))
1916 (setq index (match-end 0))
1917 (aset (car keys) field (match-string 1 string))
1918 (setq field (1+ field))))
1919 (nreverse keys))))
1921 (defun epg--make-sub-key-1 (line)
1922 (epg-make-sub-key
1923 (if (aref line 1)
1924 (cdr (assq (string-to-char (aref line 1)) epg-key-validity-alist)))
1925 (delq nil
1926 (mapcar (lambda (char) (cdr (assq char epg-key-capability-alist)))
1927 (aref line 11)))
1928 (member (aref line 0) '("sec" "ssb"))
1929 (string-to-number (aref line 3))
1930 (string-to-number (aref line 2))
1931 (aref line 4)
1932 (epg--time-from-seconds (aref line 5))
1933 (if (aref line 6)
1934 (epg--time-from-seconds (aref line 6)))))
1936 (defun epg-list-keys (context &optional name mode)
1937 "Return a list of epg-key objects matched with NAME.
1938 If MODE is nil or 'public, only public keyring should be searched.
1939 If MODE is t or 'secret, only secret keyring should be searched.
1940 Otherwise, only public keyring should be searched and the key
1941 signatures should be included.
1942 NAME is either a string or a list of strings."
1943 (let ((lines (epg--list-keys-1 context name mode))
1944 keys cert pointer pointer-1 index string)
1945 (while lines
1946 (cond
1947 ((member (aref (car lines) 0) '("pub" "sec" "crt" "crs"))
1948 (setq cert (member (aref (car lines) 0) '("crt" "crs"))
1949 keys (cons (epg-make-key
1950 (if (aref (car lines) 8)
1951 (cdr (assq (string-to-char (aref (car lines) 8))
1952 epg-key-validity-alist))))
1953 keys))
1954 (epg-key-set-sub-key-list
1955 (car keys)
1956 (cons (epg--make-sub-key-1 (car lines))
1957 (epg-key-sub-key-list (car keys)))))
1958 ((member (aref (car lines) 0) '("sub" "ssb"))
1959 (epg-key-set-sub-key-list
1960 (car keys)
1961 (cons (epg--make-sub-key-1 (car lines))
1962 (epg-key-sub-key-list (car keys)))))
1963 ((equal (aref (car lines) 0) "uid")
1964 ;; Decode the UID name as a backslash escaped UTF-8 string,
1965 ;; generated by GnuPG/GpgSM.
1966 (setq string (copy-sequence (aref (car lines) 9))
1967 index 0)
1968 (while (string-match "\"" string index)
1969 (setq string (replace-match "\\\"" t t string)
1970 index (1+ (match-end 0))))
1971 (condition-case nil
1972 (setq string (epg--decode-coding-string
1973 (car (read-from-string (concat "\"" string "\"")))
1974 'utf-8))
1975 (error
1976 (setq string (aref (car lines) 9))))
1977 (epg-key-set-user-id-list
1978 (car keys)
1979 (cons (epg-make-user-id
1980 (if (aref (car lines) 1)
1981 (cdr (assq (string-to-char (aref (car lines) 1))
1982 epg-key-validity-alist)))
1983 (if cert
1984 (condition-case nil
1985 (epg-dn-from-string string)
1986 (error string))
1987 string))
1988 (epg-key-user-id-list (car keys)))))
1989 ((equal (aref (car lines) 0) "fpr")
1990 (epg-sub-key-set-fingerprint (car (epg-key-sub-key-list (car keys)))
1991 (aref (car lines) 9)))
1992 ((equal (aref (car lines) 0) "sig")
1993 (epg-user-id-set-signature-list
1994 (car (epg-key-user-id-list (car keys)))
1995 (cons
1996 (epg-make-key-signature
1997 (if (aref (car lines) 1)
1998 (cdr (assq (string-to-char (aref (car lines) 1))
1999 epg-key-validity-alist)))
2000 (string-to-number (aref (car lines) 3))
2001 (aref (car lines) 4)
2002 (epg--time-from-seconds (aref (car lines) 5))
2003 (epg--time-from-seconds (aref (car lines) 6))
2004 (aref (car lines) 9)
2005 (string-to-number (aref (car lines) 10) 16)
2006 (eq (aref (aref (car lines) 10) 2) ?x))
2007 (epg-user-id-signature-list
2008 (car (epg-key-user-id-list (car keys))))))))
2009 (setq lines (cdr lines)))
2010 (setq keys (nreverse keys)
2011 pointer keys)
2012 (while pointer
2013 (epg-key-set-sub-key-list
2014 (car pointer)
2015 (nreverse (epg-key-sub-key-list (car pointer))))
2016 (setq pointer-1 (epg-key-set-user-id-list
2017 (car pointer)
2018 (nreverse (epg-key-user-id-list (car pointer)))))
2019 (while pointer-1
2020 (epg-user-id-set-signature-list
2021 (car pointer-1)
2022 (nreverse (epg-user-id-signature-list (car pointer-1))))
2023 (setq pointer-1 (cdr pointer-1)))
2024 (setq pointer (cdr pointer)))
2025 keys))
2027 (eval-and-compile
2028 (if (fboundp 'make-temp-file)
2029 (defalias 'epg--make-temp-file 'make-temp-file)
2030 (defvar temporary-file-directory)
2031 ;; stolen from poe.el.
2032 (defun epg--make-temp-file (prefix)
2033 "Create a temporary file.
2034 The returned file name (created by appending some random characters at the end
2035 of PREFIX, and expanding against `temporary-file-directory' if necessary),
2036 is guaranteed to point to a newly created empty file.
2037 You can then use `write-region' to write new data into the file."
2038 (let ((orig-modes (default-file-modes))
2039 tempdir tempfile)
2040 (setq prefix (expand-file-name prefix
2041 (if (featurep 'xemacs)
2042 (temp-directory)
2043 temporary-file-directory)))
2044 (unwind-protect
2045 (let (file)
2046 ;; First, create a temporary directory.
2047 (set-default-file-modes #o700)
2048 (while (condition-case ()
2049 (progn
2050 (setq tempdir (make-temp-name
2051 (concat
2052 (file-name-directory prefix)
2053 "DIR")))
2054 ;; return nil or signal an error.
2055 (make-directory tempdir))
2056 ;; let's try again.
2057 (file-already-exists t)))
2058 ;; Second, create a temporary file in the tempdir.
2059 ;; There *is* a race condition between `make-temp-name'
2060 ;; and `write-region', but we don't care it since we are
2061 ;; in a private directory now.
2062 (setq tempfile (make-temp-name (concat tempdir "/EMU")))
2063 (write-region "" nil tempfile nil 'silent)
2064 ;; Finally, make a hard-link from the tempfile.
2065 (while (condition-case ()
2066 (progn
2067 (setq file (make-temp-name prefix))
2068 ;; return nil or signal an error.
2069 (add-name-to-file tempfile file))
2070 ;; let's try again.
2071 (file-already-exists t)))
2072 file)
2073 (set-default-file-modes orig-modes)
2074 ;; Cleanup the tempfile.
2075 (and tempfile
2076 (file-exists-p tempfile)
2077 (delete-file tempfile))
2078 ;; Cleanup the tempdir.
2079 (and tempdir
2080 (file-directory-p tempdir)
2081 (delete-directory tempdir)))))))
2083 (defun epg--args-from-sig-notations (notations)
2084 (apply #'nconc
2085 (mapcar
2086 (lambda (notation)
2087 (if (and (epg-sig-notation-name notation)
2088 (not (epg-sig-notation-human-readable notation)))
2089 (error "Unreadable"))
2090 (if (epg-sig-notation-name notation)
2091 (list "--sig-notation"
2092 (if (epg-sig-notation-critical notation)
2093 (concat "!" (epg-sig-notation-name notation)
2094 "=" (epg-sig-notation-value notation))
2095 (concat (epg-sig-notation-name notation)
2096 "=" (epg-sig-notation-value notation))))
2097 (list "--sig-policy-url"
2098 (if (epg-sig-notation-critical notation)
2099 (concat "!" (epg-sig-notation-value notation))
2100 (epg-sig-notation-value notation)))))
2101 notations)))
2103 (defun epg-cancel (context)
2104 (if (buffer-live-p (process-buffer (epg-context-process context)))
2105 (with-current-buffer (process-buffer (epg-context-process context))
2106 (epg-context-set-result-for
2107 epg-context 'error
2108 (cons '(quit)
2109 (epg-context-result-for epg-context 'error)))))
2110 (if (eq (process-status (epg-context-process context)) 'run)
2111 (delete-process (epg-context-process context))))
2113 (defun epg-start-decrypt (context cipher)
2114 "Initiate a decrypt operation on CIPHER.
2115 CIPHER must be a file data object.
2117 If you use this function, you will need to wait for the completion of
2118 `epg-gpg-program' by using `epg-wait-for-completion' and call
2119 `epg-reset' to clear a temporary output file.
2120 If you are unsure, use synchronous version of this function
2121 `epg-decrypt-file' or `epg-decrypt-string' instead."
2122 (unless (epg-data-file cipher)
2123 (error "Not a file"))
2124 (epg-context-set-operation context 'decrypt)
2125 (epg-context-set-result context nil)
2126 (epg--start context (list "--decrypt" "--" (epg-data-file cipher)))
2127 ;; `gpgsm' does not read passphrase from stdin, so waiting is not needed.
2128 (unless (eq (epg-context-protocol context) 'CMS)
2129 (epg-wait-for-status context '("BEGIN_DECRYPTION"))))
2131 (defun epg--check-error-for-decrypt (context)
2132 (let ((errors (epg-context-result-for context 'error)))
2133 (if (epg-context-result-for context 'decryption-failed)
2134 (signal 'epg-error
2135 (list "Decryption failed" (epg-errors-to-string errors))))
2136 (unless (epg-context-result-for context 'decryption-okay)
2137 (signal 'epg-error
2138 (list "Can't decrypt" (epg-errors-to-string errors))))))
2140 (defun epg-decrypt-file (context cipher plain)
2141 "Decrypt a file CIPHER and store the result to a file PLAIN.
2142 If PLAIN is nil, it returns the result as a string."
2143 (unwind-protect
2144 (progn
2145 (if plain
2146 (epg-context-set-output-file context plain)
2147 (epg-context-set-output-file context
2148 (epg--make-temp-file "epg-output")))
2149 (epg-start-decrypt context (epg-make-data-from-file cipher))
2150 (epg-wait-for-completion context)
2151 (epg--check-error-for-decrypt context)
2152 (unless plain
2153 (epg-read-output context)))
2154 (unless plain
2155 (epg-delete-output-file context))
2156 (epg-reset context)))
2158 (defun epg-decrypt-string (context cipher)
2159 "Decrypt a string CIPHER and return the plain text."
2160 (let ((input-file (epg--make-temp-file "epg-input"))
2161 (coding-system-for-write 'binary))
2162 (unwind-protect
2163 (progn
2164 (write-region cipher nil input-file nil 'quiet)
2165 (epg-context-set-output-file context
2166 (epg--make-temp-file "epg-output"))
2167 (epg-start-decrypt context (epg-make-data-from-file input-file))
2168 (epg-wait-for-completion context)
2169 (epg--check-error-for-decrypt context)
2170 (epg-read-output context))
2171 (epg-delete-output-file context)
2172 (if (file-exists-p input-file)
2173 (delete-file input-file))
2174 (epg-reset context))))
2176 (defun epg-start-verify (context signature &optional signed-text)
2177 "Initiate a verify operation on SIGNATURE.
2178 SIGNATURE and SIGNED-TEXT are a data object if they are specified.
2180 For a detached signature, both SIGNATURE and SIGNED-TEXT should be set.
2181 For a normal or a cleartext signature, SIGNED-TEXT should be nil.
2183 If you use this function, you will need to wait for the completion of
2184 `epg-gpg-program' by using `epg-wait-for-completion' and call
2185 `epg-reset' to clear a temporary output file.
2186 If you are unsure, use synchronous version of this function
2187 `epg-verify-file' or `epg-verify-string' instead."
2188 (epg-context-set-operation context 'verify)
2189 (epg-context-set-result context nil)
2190 (if signed-text
2191 ;; Detached signature.
2192 (if (epg-data-file signed-text)
2193 (epg--start context (list "--verify" "--" (epg-data-file signature)
2194 (epg-data-file signed-text)))
2195 (epg--start context (list "--verify" "--" (epg-data-file signature)
2196 "-"))
2197 (if (eq (process-status (epg-context-process context)) 'run)
2198 (process-send-string (epg-context-process context)
2199 (epg-data-string signed-text)))
2200 (if (eq (process-status (epg-context-process context)) 'run)
2201 (process-send-eof (epg-context-process context))))
2202 ;; Normal (or cleartext) signature.
2203 (if (epg-data-file signature)
2204 (epg--start context (if (eq (epg-context-protocol context) 'CMS)
2205 (list "--verify" "--" (epg-data-file signature))
2206 (list "--" (epg-data-file signature))))
2207 (epg--start context (if (eq (epg-context-protocol context) 'CMS)
2208 '("--verify" "-")
2209 '("-")))
2210 (if (eq (process-status (epg-context-process context)) 'run)
2211 (process-send-string (epg-context-process context)
2212 (epg-data-string signature)))
2213 (if (eq (process-status (epg-context-process context)) 'run)
2214 (process-send-eof (epg-context-process context))))))
2216 (defun epg-verify-file (context signature &optional signed-text plain)
2217 "Verify a file SIGNATURE.
2218 SIGNED-TEXT and PLAIN are also a file if they are specified.
2220 For a detached signature, both SIGNATURE and SIGNED-TEXT should be
2221 string. For a normal or a cleartext signature, SIGNED-TEXT should be
2222 nil. In the latter case, if PLAIN is specified, the plaintext is
2223 stored into the file after successful verification.
2225 Note that this function does not return verification result as t
2226 or nil, nor signal error on failure. That's a design decision to
2227 handle the case where SIGNATURE has multiple signature.
2229 To check the verification results, use `epg-context-result-for' as follows:
2231 \(epg-context-result-for context 'verify)
2233 which will return a list of `epg-signature' object."
2234 (unwind-protect
2235 (progn
2236 (if plain
2237 (epg-context-set-output-file context plain)
2238 (epg-context-set-output-file context
2239 (epg--make-temp-file "epg-output")))
2240 (if signed-text
2241 (epg-start-verify context
2242 (epg-make-data-from-file signature)
2243 (epg-make-data-from-file signed-text))
2244 (epg-start-verify context
2245 (epg-make-data-from-file signature)))
2246 (epg-wait-for-completion context)
2247 (unless plain
2248 (epg-read-output context)))
2249 (unless plain
2250 (epg-delete-output-file context))
2251 (epg-reset context)))
2253 (defun epg-verify-string (context signature &optional signed-text)
2254 "Verify a string SIGNATURE.
2255 SIGNED-TEXT is a string if it is specified.
2257 For a detached signature, both SIGNATURE and SIGNED-TEXT should be
2258 string. For a normal or a cleartext signature, SIGNED-TEXT should be
2259 nil. In the latter case, this function returns the plaintext after
2260 successful verification.
2262 Note that this function does not return verification result as t
2263 or nil, nor signal error on failure. That's a design decision to
2264 handle the case where SIGNATURE has multiple signature.
2266 To check the verification results, use `epg-context-result-for' as follows:
2268 \(epg-context-result-for context 'verify)
2270 which will return a list of `epg-signature' object."
2271 (let ((coding-system-for-write 'binary)
2272 input-file)
2273 (unwind-protect
2274 (progn
2275 (epg-context-set-output-file context
2276 (epg--make-temp-file "epg-output"))
2277 (if signed-text
2278 (progn
2279 (setq input-file (epg--make-temp-file "epg-signature"))
2280 (write-region signature nil input-file nil 'quiet)
2281 (epg-start-verify context
2282 (epg-make-data-from-file input-file)
2283 (epg-make-data-from-string signed-text)))
2284 (epg-start-verify context (epg-make-data-from-string signature)))
2285 (epg-wait-for-completion context)
2286 (epg-read-output context))
2287 (epg-delete-output-file context)
2288 (if (and input-file
2289 (file-exists-p input-file))
2290 (delete-file input-file))
2291 (epg-reset context))))
2293 (defun epg-start-sign (context plain &optional mode)
2294 "Initiate a sign operation on PLAIN.
2295 PLAIN is a data object.
2297 If optional 3rd argument MODE is t or 'detached, it makes a detached signature.
2298 If it is nil or 'normal, it makes a normal signature.
2299 Otherwise, it makes a cleartext signature.
2301 If you use this function, you will need to wait for the completion of
2302 `epg-gpg-program' by using `epg-wait-for-completion' and call
2303 `epg-reset' to clear a temporary output file.
2304 If you are unsure, use synchronous version of this function
2305 `epg-sign-file' or `epg-sign-string' instead."
2306 (epg-context-set-operation context 'sign)
2307 (epg-context-set-result context nil)
2308 (unless (memq mode '(t detached nil normal)) ;i.e. cleartext
2309 (epg-context-set-armor context nil)
2310 (epg-context-set-textmode context nil))
2311 (epg--start context
2312 (append (list (if (memq mode '(t detached))
2313 "--detach-sign"
2314 (if (memq mode '(nil normal))
2315 "--sign"
2316 "--clearsign")))
2317 (apply #'nconc
2318 (mapcar
2319 (lambda (signer)
2320 (list "-u"
2321 (epg-sub-key-id
2322 (car (epg-key-sub-key-list signer)))))
2323 (epg-context-signers context)))
2324 (epg--args-from-sig-notations
2325 (epg-context-sig-notations context))
2326 (if (epg-data-file plain)
2327 (list "--" (epg-data-file plain)))))
2328 ;; `gpgsm' does not read passphrase from stdin, so waiting is not needed.
2329 (unless (eq (epg-context-protocol context) 'CMS)
2330 (epg-wait-for-status context '("BEGIN_SIGNING")))
2331 (when (epg-data-string plain)
2332 (if (eq (process-status (epg-context-process context)) 'run)
2333 (process-send-string (epg-context-process context)
2334 (epg-data-string plain)))
2335 (if (eq (process-status (epg-context-process context)) 'run)
2336 (process-send-eof (epg-context-process context)))))
2338 (defun epg-sign-file (context plain signature &optional mode)
2339 "Sign a file PLAIN and store the result to a file SIGNATURE.
2340 If SIGNATURE is nil, it returns the result as a string.
2341 If optional 3rd argument MODE is t or 'detached, it makes a detached signature.
2342 If it is nil or 'normal, it makes a normal signature.
2343 Otherwise, it makes a cleartext signature."
2344 (unwind-protect
2345 (progn
2346 (if signature
2347 (epg-context-set-output-file context signature)
2348 (epg-context-set-output-file context
2349 (epg--make-temp-file "epg-output")))
2350 (epg-start-sign context (epg-make-data-from-file plain) mode)
2351 (epg-wait-for-completion context)
2352 (unless (epg-context-result-for context 'sign)
2353 (let ((errors (epg-context-result-for context 'error)))
2354 (signal 'epg-error
2355 (list "Sign failed" (epg-errors-to-string errors)))))
2356 (unless signature
2357 (epg-read-output context)))
2358 (unless signature
2359 (epg-delete-output-file context))
2360 (epg-reset context)))
2362 (defun epg-sign-string (context plain &optional mode)
2363 "Sign a string PLAIN and return the output as string.
2364 If optional 3rd argument MODE is t or 'detached, it makes a detached signature.
2365 If it is nil or 'normal, it makes a normal signature.
2366 Otherwise, it makes a cleartext signature."
2367 (let ((input-file
2368 (unless (or (eq (epg-context-protocol context) 'CMS)
2369 (condition-case nil
2370 (progn
2371 (epg-check-configuration (epg-configuration))
2373 (error)))
2374 (epg--make-temp-file "epg-input")))
2375 (coding-system-for-write 'binary))
2376 (unwind-protect
2377 (progn
2378 (epg-context-set-output-file context
2379 (epg--make-temp-file "epg-output"))
2380 (if input-file
2381 (write-region plain nil input-file nil 'quiet))
2382 (epg-start-sign context
2383 (if input-file
2384 (epg-make-data-from-file input-file)
2385 (epg-make-data-from-string plain))
2386 mode)
2387 (epg-wait-for-completion context)
2388 (unless (epg-context-result-for context 'sign)
2389 (if (epg-context-result-for context 'error)
2390 (let ((errors (epg-context-result-for context 'error)))
2391 (signal 'epg-error
2392 (list "Sign failed" (epg-errors-to-string errors))))))
2393 (epg-read-output context))
2394 (epg-delete-output-file context)
2395 (if input-file
2396 (delete-file input-file))
2397 (epg-reset context))))
2399 (defun epg-start-encrypt (context plain recipients
2400 &optional sign always-trust)
2401 "Initiate an encrypt operation on PLAIN.
2402 PLAIN is a data object.
2403 If RECIPIENTS is nil, it performs symmetric encryption.
2405 If you use this function, you will need to wait for the completion of
2406 `epg-gpg-program' by using `epg-wait-for-completion' and call
2407 `epg-reset' to clear a temporary output file.
2408 If you are unsure, use synchronous version of this function
2409 `epg-encrypt-file' or `epg-encrypt-string' instead."
2410 (epg-context-set-operation context 'encrypt)
2411 (epg-context-set-result context nil)
2412 (epg--start context
2413 (append (if always-trust '("--always-trust"))
2414 (if recipients '("--encrypt") '("--symmetric"))
2415 (if sign '("--sign"))
2416 (if sign
2417 (apply #'nconc
2418 (mapcar
2419 (lambda (signer)
2420 (list "-u"
2421 (epg-sub-key-id
2422 (car (epg-key-sub-key-list
2423 signer)))))
2424 (epg-context-signers context))))
2425 (if sign
2426 (epg--args-from-sig-notations
2427 (epg-context-sig-notations context)))
2428 (apply #'nconc
2429 (mapcar
2430 (lambda (recipient)
2431 (list "-r"
2432 (epg-sub-key-id
2433 (car (epg-key-sub-key-list recipient)))))
2434 recipients))
2435 (if (epg-data-file plain)
2436 (list "--" (epg-data-file plain)))))
2437 ;; `gpgsm' does not read passphrase from stdin, so waiting is not needed.
2438 (unless (eq (epg-context-protocol context) 'CMS)
2439 (epg-wait-for-status context
2440 (if sign '("BEGIN_SIGNING") '("BEGIN_ENCRYPTION"))))
2441 (when (epg-data-string plain)
2442 (if (eq (process-status (epg-context-process context)) 'run)
2443 (process-send-string (epg-context-process context)
2444 (epg-data-string plain)))
2445 (if (eq (process-status (epg-context-process context)) 'run)
2446 (process-send-eof (epg-context-process context)))))
2448 (defun epg-encrypt-file (context plain recipients
2449 cipher &optional sign always-trust)
2450 "Encrypt a file PLAIN and store the result to a file CIPHER.
2451 If CIPHER is nil, it returns the result as a string.
2452 If RECIPIENTS is nil, it performs symmetric encryption."
2453 (unwind-protect
2454 (progn
2455 (if cipher
2456 (epg-context-set-output-file context cipher)
2457 (epg-context-set-output-file context
2458 (epg--make-temp-file "epg-output")))
2459 (epg-start-encrypt context (epg-make-data-from-file plain)
2460 recipients sign always-trust)
2461 (epg-wait-for-completion context)
2462 (let ((errors (epg-context-result-for context 'error)))
2463 (if (and sign
2464 (not (epg-context-result-for context 'sign)))
2465 (signal 'epg-error
2466 (list "Sign failed" (epg-errors-to-string errors))))
2467 (if errors
2468 (signal 'epg-error
2469 (list "Encrypt failed" (epg-errors-to-string errors)))))
2470 (unless cipher
2471 (epg-read-output context)))
2472 (unless cipher
2473 (epg-delete-output-file context))
2474 (epg-reset context)))
2476 (defun epg-encrypt-string (context plain recipients
2477 &optional sign always-trust)
2478 "Encrypt a string PLAIN.
2479 If RECIPIENTS is nil, it performs symmetric encryption."
2480 (let ((input-file
2481 (unless (or (not sign)
2482 (eq (epg-context-protocol context) 'CMS)
2483 (condition-case nil
2484 (progn
2485 (epg-check-configuration (epg-configuration))
2487 (error)))
2488 (epg--make-temp-file "epg-input")))
2489 (coding-system-for-write 'binary))
2490 (unwind-protect
2491 (progn
2492 (epg-context-set-output-file context
2493 (epg--make-temp-file "epg-output"))
2494 (if input-file
2495 (write-region plain nil input-file nil 'quiet))
2496 (epg-start-encrypt context
2497 (if input-file
2498 (epg-make-data-from-file input-file)
2499 (epg-make-data-from-string plain))
2500 recipients sign always-trust)
2501 (epg-wait-for-completion context)
2502 (let ((errors (epg-context-result-for context 'error)))
2503 (if (and sign
2504 (not (epg-context-result-for context 'sign)))
2505 (signal 'epg-error
2506 (list "Sign failed" (epg-errors-to-string errors))))
2507 (if errors
2508 (signal 'epg-error
2509 (list "Encrypt failed" (epg-errors-to-string errors)))))
2510 (epg-read-output context))
2511 (epg-delete-output-file context)
2512 (if input-file
2513 (delete-file input-file))
2514 (epg-reset context))))
2516 (defun epg-start-export-keys (context keys)
2517 "Initiate an export keys operation.
2519 If you use this function, you will need to wait for the completion of
2520 `epg-gpg-program' by using `epg-wait-for-completion' and call
2521 `epg-reset' to clear a temporary output file.
2522 If you are unsure, use synchronous version of this function
2523 `epg-export-keys-to-file' or `epg-export-keys-to-string' instead."
2524 (epg-context-set-operation context 'export-keys)
2525 (epg-context-set-result context nil)
2526 (epg--start context (cons "--export"
2527 (mapcar
2528 (lambda (key)
2529 (epg-sub-key-id
2530 (car (epg-key-sub-key-list key))))
2531 keys))))
2533 (defun epg-export-keys-to-file (context keys file)
2534 "Extract public KEYS."
2535 (unwind-protect
2536 (progn
2537 (if file
2538 (epg-context-set-output-file context file)
2539 (epg-context-set-output-file context
2540 (epg--make-temp-file "epg-output")))
2541 (epg-start-export-keys context keys)
2542 (epg-wait-for-completion context)
2543 (let ((errors (epg-context-result-for context 'error)))
2544 (if errors
2545 (signal 'epg-error
2546 (list "Export keys failed"
2547 (epg-errors-to-string errors)))))
2548 (unless file
2549 (epg-read-output context)))
2550 (unless file
2551 (epg-delete-output-file context))
2552 (epg-reset context)))
2554 (defun epg-export-keys-to-string (context keys)
2555 "Extract public KEYS and return them as a string."
2556 (epg-export-keys-to-file context keys nil))
2558 (defun epg-start-import-keys (context keys)
2559 "Initiate an import keys operation.
2560 KEYS is a data object.
2562 If you use this function, you will need to wait for the completion of
2563 `epg-gpg-program' by using `epg-wait-for-completion' and call
2564 `epg-reset' to clear a temporary output file.
2565 If you are unsure, use synchronous version of this function
2566 `epg-import-keys-from-file' or `epg-import-keys-from-string' instead."
2567 (epg-context-set-operation context 'import-keys)
2568 (epg-context-set-result context nil)
2569 (epg--start context (if (epg-data-file keys)
2570 (list "--import" "--" (epg-data-file keys))
2571 (list "--import")))
2572 (when (epg-data-string keys)
2573 (if (eq (process-status (epg-context-process context)) 'run)
2574 (process-send-string (epg-context-process context)
2575 (epg-data-string keys)))
2576 (if (eq (process-status (epg-context-process context)) 'run)
2577 (process-send-eof (epg-context-process context)))))
2579 (defun epg--import-keys-1 (context keys)
2580 (unwind-protect
2581 (progn
2582 (epg-start-import-keys context keys)
2583 (epg-wait-for-completion context)
2584 (let ((errors (epg-context-result-for context 'error)))
2585 (if errors
2586 (signal 'epg-error
2587 (list "Import keys failed"
2588 (epg-errors-to-string errors))))))
2589 (epg-reset context)))
2591 (defun epg-import-keys-from-file (context keys)
2592 "Add keys from a file KEYS."
2593 (epg--import-keys-1 context (epg-make-data-from-file keys)))
2595 (defun epg-import-keys-from-string (context keys)
2596 "Add keys from a string KEYS."
2597 (epg--import-keys-1 context (epg-make-data-from-string keys)))
2599 (defun epg-start-receive-keys (context key-id-list)
2600 "Initiate a receive key operation.
2601 KEY-ID-LIST is a list of key IDs.
2603 If you use this function, you will need to wait for the completion of
2604 `epg-gpg-program' by using `epg-wait-for-completion' and call
2605 `epg-reset' to clear a temporary output file.
2606 If you are unsure, use synchronous version of this function
2607 `epg-receive-keys' instead."
2608 (epg-context-set-operation context 'receive-keys)
2609 (epg-context-set-result context nil)
2610 (epg--start context (cons "--recv-keys" key-id-list)))
2612 (defun epg-receive-keys (context keys)
2613 "Add keys from server.
2614 KEYS is a list of key IDs"
2615 (unwind-protect
2616 (progn
2617 (epg-start-receive-keys context keys)
2618 (epg-wait-for-completion context)
2619 (let ((errors (epg-context-result-for context 'error)))
2620 (if errors
2621 (signal 'epg-error
2622 (list "Receive keys failed"
2623 (epg-errors-to-string errors))))))
2624 (epg-reset context)))
2626 (defalias 'epg-import-keys-from-server 'epg-receive-keys)
2628 (defun epg-start-delete-keys (context keys &optional allow-secret)
2629 "Initiate a delete keys operation.
2631 If you use this function, you will need to wait for the completion of
2632 `epg-gpg-program' by using `epg-wait-for-completion' and call
2633 `epg-reset' to clear a temporary output file.
2634 If you are unsure, use synchronous version of this function
2635 `epg-delete-keys' instead."
2636 (epg-context-set-operation context 'delete-keys)
2637 (epg-context-set-result context nil)
2638 (epg--start context (cons (if allow-secret
2639 "--delete-secret-key"
2640 "--delete-key")
2641 (mapcar
2642 (lambda (key)
2643 (epg-sub-key-id
2644 (car (epg-key-sub-key-list key))))
2645 keys))))
2647 (defun epg-delete-keys (context keys &optional allow-secret)
2648 "Delete KEYS from the key ring."
2649 (unwind-protect
2650 (progn
2651 (epg-start-delete-keys context keys allow-secret)
2652 (epg-wait-for-completion context)
2653 (let ((errors (epg-context-result-for context 'error)))
2654 (if errors
2655 (signal 'epg-error
2656 (list "Delete keys failed"
2657 (epg-errors-to-string errors))))))
2658 (epg-reset context)))
2660 (defun epg-start-sign-keys (context keys &optional local)
2661 "Initiate a sign keys operation.
2663 If you use this function, you will need to wait for the completion of
2664 `epg-gpg-program' by using `epg-wait-for-completion' and call
2665 `epg-reset' to clear a temporary output file.
2666 If you are unsure, use synchronous version of this function
2667 `epg-sign-keys' instead."
2668 (declare (obsolete nil "23.1"))
2669 (epg-context-set-operation context 'sign-keys)
2670 (epg-context-set-result context nil)
2671 (epg--start context (cons (if local
2672 "--lsign-key"
2673 "--sign-key")
2674 (mapcar
2675 (lambda (key)
2676 (epg-sub-key-id
2677 (car (epg-key-sub-key-list key))))
2678 keys))))
2680 (defun epg-sign-keys (context keys &optional local)
2681 "Sign KEYS from the key ring."
2682 (declare (obsolete nil "23.1"))
2683 (unwind-protect
2684 (progn
2685 (epg-start-sign-keys context keys local)
2686 (epg-wait-for-completion context)
2687 (let ((errors (epg-context-result-for context 'error)))
2688 (if errors
2689 (signal 'epg-error
2690 (list "Sign keys failed"
2691 (epg-errors-to-string errors))))))
2692 (epg-reset context)))
2694 (defun epg-start-generate-key (context parameters)
2695 "Initiate a key generation.
2696 PARAMETERS specifies parameters for the key.
2698 If you use this function, you will need to wait for the completion of
2699 `epg-gpg-program' by using `epg-wait-for-completion' and call
2700 `epg-reset' to clear a temporary output file.
2701 If you are unsure, use synchronous version of this function
2702 `epg-generate-key-from-file' or `epg-generate-key-from-string' instead."
2703 (epg-context-set-operation context 'generate-key)
2704 (epg-context-set-result context nil)
2705 (if (epg-data-file parameters)
2706 (epg--start context (list "--batch" "--genkey" "--"
2707 (epg-data-file parameters)))
2708 (epg--start context '("--batch" "--genkey"))
2709 (if (eq (process-status (epg-context-process context)) 'run)
2710 (process-send-string (epg-context-process context)
2711 (epg-data-string parameters)))
2712 (if (eq (process-status (epg-context-process context)) 'run)
2713 (process-send-eof (epg-context-process context)))))
2715 (defun epg-generate-key-from-file (context parameters)
2716 "Generate a new key pair.
2717 PARAMETERS is a file which tells how to create the key."
2718 (unwind-protect
2719 (progn
2720 (epg-start-generate-key context (epg-make-data-from-file parameters))
2721 (epg-wait-for-completion context)
2722 (let ((errors (epg-context-result-for context 'error)))
2723 (if errors
2724 (signal 'epg-error
2725 (list "Generate key failed"
2726 (epg-errors-to-string errors))))))
2727 (epg-reset context)))
2729 (defun epg-generate-key-from-string (context parameters)
2730 "Generate a new key pair.
2731 PARAMETERS is a string which tells how to create the key."
2732 (unwind-protect
2733 (progn
2734 (epg-start-generate-key context (epg-make-data-from-string parameters))
2735 (epg-wait-for-completion context)
2736 (let ((errors (epg-context-result-for context 'error)))
2737 (if errors
2738 (signal 'epg-error
2739 (list "Generate key failed"
2740 (epg-errors-to-string errors))))))
2741 (epg-reset context)))
2743 (defun epg--decode-percent-escape (string)
2744 (let ((index 0))
2745 (while (string-match "%\\(\\(%\\)\\|\\([0-9A-Fa-f][0-9A-Fa-f]\\)\\)"
2746 string index)
2747 (if (match-beginning 2)
2748 (setq string (replace-match "%" t t string)
2749 index (1- (match-end 0)))
2750 (setq string (replace-match
2751 (string (string-to-number (match-string 3 string) 16))
2752 t t string)
2753 index (- (match-end 0) 2))))
2754 string))
2756 (defun epg--decode-hexstring (string)
2757 (let ((index 0))
2758 (while (eq index (string-match "[0-9A-Fa-f][0-9A-Fa-f]" string index))
2759 (setq string (replace-match (string (string-to-number
2760 (match-string 0 string) 16))
2761 t t string)
2762 index (1- (match-end 0))))
2763 string))
2765 (defun epg--decode-quotedstring (string)
2766 (let ((index 0))
2767 (while (string-match "\\\\\\(\\([,=+<>#;\\\"]\\)\\|\
2768 \\([0-9A-Fa-f][0-9A-Fa-f]\\)\\)"
2769 string index)
2770 (if (match-beginning 2)
2771 (setq string (replace-match "\\2" t nil string)
2772 index (1- (match-end 0)))
2773 (if (match-beginning 3)
2774 (setq string (replace-match (string (string-to-number
2775 (match-string 0 string) 16))
2776 t t string)
2777 index (- (match-end 0) 2)))))
2778 string))
2780 (defun epg-dn-from-string (string)
2781 "Parse STRING as LADPv3 Distinguished Names (RFC2253).
2782 The return value is an alist mapping from types to values."
2783 (let ((index 0)
2784 (length (length string))
2785 alist type value group)
2786 (while (< index length)
2787 (if (eq index (string-match "[ \t\n\r]*" string index))
2788 (setq index (match-end 0)))
2789 (if (eq index (string-match
2790 "\\([0-9]+\\(\\.[0-9]+\\)*\\)\[ \t\n\r]*=[ \t\n\r]*"
2791 string index))
2792 (setq type (match-string 1 string)
2793 index (match-end 0))
2794 (if (eq index (string-match "\\([0-9A-Za-z]+\\)[ \t\n\r]*=[ \t\n\r]*"
2795 string index))
2796 (setq type (match-string 1 string)
2797 index (match-end 0))))
2798 (unless type
2799 (error "Invalid type"))
2800 (if (eq index (string-match
2801 "\\([^,=+<>#;\\\"]\\|\\\\.\\)+"
2802 string index))
2803 (setq index (match-end 0)
2804 value (epg--decode-quotedstring (match-string 0 string)))
2805 (if (eq index (string-match "#\\([0-9A-Fa-f]+\\)" string index))
2806 (setq index (match-end 0)
2807 value (epg--decode-hexstring (match-string 1 string)))
2808 (if (eq index (string-match "\"\\([^\\\"]\\|\\\\.\\)*\""
2809 string index))
2810 (setq index (match-end 0)
2811 value (epg--decode-quotedstring
2812 (match-string 0 string))))))
2813 (if group
2814 (if (stringp (car (car alist)))
2815 (setcar alist (list (cons type value) (car alist)))
2816 (setcar alist (cons (cons type value) (car alist))))
2817 (if (consp (car (car alist)))
2818 (setcar alist (nreverse (car alist))))
2819 (setq alist (cons (cons type value) alist)
2820 type nil
2821 value nil))
2822 (if (eq index (string-match "[ \t\n\r]*\\([,;+]\\)" string index))
2823 (setq index (match-end 0)
2824 group (eq (aref string (match-beginning 1)) ?+))))
2825 (nreverse alist)))
2827 (defun epg-decode-dn (alist)
2828 "Convert ALIST returned by `epg-dn-from-string' to a human readable form.
2829 Type names are resolved using `epg-dn-type-alist'."
2830 (mapconcat
2831 (lambda (rdn)
2832 (if (stringp (car rdn))
2833 (let ((entry (assoc (car rdn) epg-dn-type-alist)))
2834 (if entry
2835 (format "%s=%s" (cdr entry) (cdr rdn))
2836 (format "%s=%s" (car rdn) (cdr rdn))))
2837 (concat "(" (epg-decode-dn rdn) ")")))
2838 alist
2839 ", "))
2841 (provide 'epg)
2843 ;;; epg.el ends here