* lisp/subr.el (define-error): New function.
[emacs.git] / lisp / epg.el
blob33c0443dd91d07a828bbe27da5b8a74aa9edbf22
1 ;;; epg.el --- the EasyPG Library -*- lexical-binding: t -*-
2 ;; Copyright (C) 1999-2000, 2002-2013 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-capablity-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 "Cancelled")
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 (save-excursion
1282 (unless epg-debug-buffer
1283 (setq epg-debug-buffer (generate-new-buffer " *epg-debug*")))
1284 (set-buffer epg-debug-buffer)
1285 (goto-char (point-max))
1286 (insert input)))
1287 (if (buffer-live-p (process-buffer process))
1288 (with-current-buffer (process-buffer process)
1289 (goto-char (point-max))
1290 (insert input)
1291 (unless epg-process-filter-running
1292 (unwind-protect
1293 (progn
1294 (setq epg-process-filter-running t)
1295 (goto-char epg-read-point)
1296 (beginning-of-line)
1297 (while (looking-at ".*\n") ;the input line finished
1298 (if (looking-at "\\[GNUPG:] \\([A-Z_]+\\) ?\\(.*\\)")
1299 (let* ((status (match-string 1))
1300 (string (match-string 2))
1301 (symbol (intern-soft (concat "epg--status-"
1302 status))))
1303 (if (member status epg-pending-status-list)
1304 (setq epg-pending-status-list nil))
1305 (if (and symbol
1306 (fboundp symbol))
1307 (funcall symbol epg-context string))
1308 (setq epg-last-status (cons status string))))
1309 (forward-line)
1310 (setq epg-read-point (point))))
1311 (setq epg-process-filter-running nil))))))
1313 (defun epg-read-output (context)
1314 "Read the output file CONTEXT and return the content as a string."
1315 (with-temp-buffer
1316 (if (fboundp 'set-buffer-multibyte)
1317 (set-buffer-multibyte nil))
1318 (if (file-exists-p (epg-context-output-file context))
1319 (let ((coding-system-for-read 'binary))
1320 (insert-file-contents (epg-context-output-file context))
1321 (buffer-string)))))
1323 (defun epg-wait-for-status (context status-list)
1324 "Wait until one of elements in STATUS-LIST arrives."
1325 (with-current-buffer (process-buffer (epg-context-process context))
1326 (setq epg-pending-status-list status-list)
1327 (while (and (eq (process-status (epg-context-process context)) 'run)
1328 epg-pending-status-list)
1329 (accept-process-output (epg-context-process context) 1))
1330 (if epg-pending-status-list
1331 (epg-context-set-result-for
1332 context 'error
1333 (cons '(exit)
1334 (epg-context-result-for context 'error))))))
1336 (defun epg-wait-for-completion (context)
1337 "Wait until the `epg-gpg-program' process completes."
1338 (while (eq (process-status (epg-context-process context)) 'run)
1339 (accept-process-output (epg-context-process context) 1))
1340 ;; This line is needed to run the process-filter right now.
1341 (sleep-for 0.1)
1342 ;; Restore Emacs frame on text terminal, when pinentry-curses has terminated.
1343 (if (with-current-buffer (process-buffer (epg-context-process context))
1344 (and epg-agent-file
1345 (> (float-time (or (nth 5 (file-attributes epg-agent-file))
1346 '(0 0 0 0)))
1347 (float-time epg-agent-mtime))))
1348 (redraw-frame))
1349 (epg-context-set-result-for
1350 context 'error
1351 (nreverse (epg-context-result-for context 'error))))
1353 (defun epg-reset (context)
1354 "Reset the CONTEXT."
1355 (if (and (epg-context-process context)
1356 (buffer-live-p (process-buffer (epg-context-process context))))
1357 (kill-buffer (process-buffer (epg-context-process context))))
1358 (epg-context-set-process context nil))
1360 (defun epg-delete-output-file (context)
1361 "Delete the output file of CONTEXT."
1362 (if (and (epg-context-output-file context)
1363 (file-exists-p (epg-context-output-file context)))
1364 (delete-file (epg-context-output-file context))))
1366 (eval-and-compile
1367 (if (fboundp 'decode-coding-string)
1368 (defalias 'epg--decode-coding-string 'decode-coding-string)
1369 (defalias 'epg--decode-coding-string 'identity)))
1371 (defun epg--status-USERID_HINT (_context string)
1372 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
1373 (let* ((key-id (match-string 1 string))
1374 (user-id (match-string 2 string))
1375 (entry (assoc key-id epg-user-id-alist)))
1376 (condition-case nil
1377 (setq user-id (epg--decode-coding-string
1378 (epg--decode-percent-escape user-id)
1379 'utf-8))
1380 (error))
1381 (if entry
1382 (setcdr entry user-id)
1383 (setq epg-user-id-alist (cons (cons key-id user-id)
1384 epg-user-id-alist))))))
1386 (defun epg--status-NEED_PASSPHRASE (_context string)
1387 (if (string-match "\\`\\([^ ]+\\)" string)
1388 (setq epg-key-id (match-string 1 string))))
1390 (defun epg--status-NEED_PASSPHRASE_SYM (_context _string)
1391 (setq epg-key-id 'SYM))
1393 (defun epg--status-NEED_PASSPHRASE_PIN (_context _string)
1394 (setq epg-key-id 'PIN))
1396 (eval-and-compile
1397 (if (fboundp 'clear-string)
1398 (defalias 'epg--clear-string 'clear-string)
1399 (defun epg--clear-string (string)
1400 (fillarray string 0))))
1402 (eval-and-compile
1403 (if (fboundp 'encode-coding-string)
1404 (defalias 'epg--encode-coding-string 'encode-coding-string)
1405 (defalias 'epg--encode-coding-string 'identity)))
1407 (defun epg--status-GET_HIDDEN (context string)
1408 (when (and epg-key-id
1409 (string-match "\\`passphrase\\." string))
1410 (unless (epg-context-passphrase-callback context)
1411 (error "passphrase-callback not set"))
1412 (let (inhibit-quit
1413 passphrase
1414 passphrase-with-new-line
1415 encoded-passphrase-with-new-line)
1416 (unwind-protect
1417 (condition-case nil
1418 (progn
1419 (setq passphrase
1420 (funcall
1421 (car (epg-context-passphrase-callback context))
1422 context
1423 epg-key-id
1424 (cdr (epg-context-passphrase-callback context))))
1425 (when passphrase
1426 (setq passphrase-with-new-line (concat passphrase "\n"))
1427 (epg--clear-string passphrase)
1428 (setq passphrase nil)
1429 (if epg-passphrase-coding-system
1430 (progn
1431 (setq encoded-passphrase-with-new-line
1432 (epg--encode-coding-string
1433 passphrase-with-new-line
1434 (coding-system-change-eol-conversion
1435 epg-passphrase-coding-system 'unix)))
1436 (epg--clear-string passphrase-with-new-line)
1437 (setq passphrase-with-new-line nil))
1438 (setq encoded-passphrase-with-new-line
1439 passphrase-with-new-line
1440 passphrase-with-new-line nil))
1441 (process-send-string (epg-context-process context)
1442 encoded-passphrase-with-new-line)))
1443 (quit
1444 (epg-context-set-result-for
1445 context 'error
1446 (cons '(quit)
1447 (epg-context-result-for context 'error)))
1448 (delete-process (epg-context-process context))))
1449 (if passphrase
1450 (epg--clear-string passphrase))
1451 (if passphrase-with-new-line
1452 (epg--clear-string passphrase-with-new-line))
1453 (if encoded-passphrase-with-new-line
1454 (epg--clear-string encoded-passphrase-with-new-line))))))
1456 (defun epg--prompt-GET_BOOL (_context string)
1457 (let ((entry (assoc string epg-prompt-alist)))
1458 (y-or-n-p (if entry (cdr entry) (concat string "? ")))))
1460 (defun epg--prompt-GET_BOOL-untrusted_key.override (_context _string)
1461 (y-or-n-p (if (and (equal (car epg-last-status) "USERID_HINT")
1462 (string-match "\\`\\([^ ]+\\) \\(.*\\)"
1463 (cdr epg-last-status)))
1464 (let* ((key-id (match-string 1 (cdr epg-last-status)))
1465 (user-id (match-string 2 (cdr epg-last-status)))
1466 (entry (assoc key-id epg-user-id-alist)))
1467 (if entry
1468 (setq user-id (cdr entry)))
1469 (format "Untrusted key %s %s. Use anyway? " key-id user-id))
1470 "Use untrusted key anyway? ")))
1472 (defun epg--status-GET_BOOL (context string)
1473 (let (inhibit-quit)
1474 (condition-case nil
1475 (if (funcall (or (intern-soft (concat "epg--prompt-GET_BOOL-" string))
1476 #'epg--prompt-GET_BOOL)
1477 context string)
1478 (process-send-string (epg-context-process context) "y\n")
1479 (process-send-string (epg-context-process context) "n\n"))
1480 (quit
1481 (epg-context-set-result-for
1482 context 'error
1483 (cons '(quit)
1484 (epg-context-result-for context 'error)))
1485 (delete-process (epg-context-process context))))))
1487 (defun epg--status-GET_LINE (context string)
1488 (let ((entry (assoc string epg-prompt-alist))
1489 inhibit-quit)
1490 (condition-case nil
1491 (process-send-string (epg-context-process context)
1492 (concat (read-string
1493 (if entry
1494 (cdr entry)
1495 (concat string ": ")))
1496 "\n"))
1497 (quit
1498 (epg-context-set-result-for
1499 context 'error
1500 (cons '(quit)
1501 (epg-context-result-for context 'error)))
1502 (delete-process (epg-context-process context))))))
1504 (defun epg--status-*SIG (context status string)
1505 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
1506 (let* ((key-id (match-string 1 string))
1507 (user-id (match-string 2 string))
1508 (entry (assoc key-id epg-user-id-alist)))
1509 (epg-context-set-result-for
1510 context
1511 'verify
1512 (cons (epg-make-signature status key-id)
1513 (epg-context-result-for context 'verify)))
1514 (condition-case nil
1515 (if (eq (epg-context-protocol context) 'CMS)
1516 (setq user-id (epg-dn-from-string user-id))
1517 (setq user-id (epg--decode-coding-string
1518 (epg--decode-percent-escape user-id)
1519 'utf-8)))
1520 (error))
1521 (if entry
1522 (setcdr entry user-id)
1523 (setq epg-user-id-alist
1524 (cons (cons key-id user-id) epg-user-id-alist))))
1525 (epg-context-set-result-for
1526 context
1527 'verify
1528 (cons (epg-make-signature status)
1529 (epg-context-result-for context 'verify)))))
1531 (defun epg--status-GOODSIG (context string)
1532 (epg--status-*SIG context 'good string))
1534 (defun epg--status-EXPSIG (context string)
1535 (epg--status-*SIG context 'expired string))
1537 (defun epg--status-EXPKEYSIG (context string)
1538 (epg--status-*SIG context 'expired-key string))
1540 (defun epg--status-REVKEYSIG (context string)
1541 (epg--status-*SIG context 'revoked-key string))
1543 (defun epg--status-BADSIG (context string)
1544 (epg--status-*SIG context 'bad string))
1546 (defun epg--status-NO_PUBKEY (context string)
1547 (if (eq (epg-context-operation context) 'verify)
1548 (let ((signature (car (epg-context-result-for context 'verify))))
1549 (if (and signature
1550 (eq (epg-signature-status signature) 'error)
1551 (equal (epg-signature-key-id signature) string))
1552 (epg-signature-set-status signature 'no-pubkey)))
1553 (epg-context-set-result-for
1554 context 'error
1555 (cons (cons 'no-pubkey string)
1556 (epg-context-result-for context 'error)))))
1558 (defun epg--status-NO_SECKEY (context string)
1559 (epg-context-set-result-for
1560 context 'error
1561 (cons (cons 'no-seckey string)
1562 (epg-context-result-for context 'error))))
1564 (defun epg--time-from-seconds (seconds)
1565 (let ((number-seconds (string-to-number (concat seconds ".0"))))
1566 (cons (floor (/ number-seconds 65536))
1567 (floor (mod number-seconds 65536)))))
1569 (defun epg--status-ERRSIG (context string)
1570 (if (string-match "\\`\\([^ ]+\\) \\([0-9]+\\) \\([0-9]+\\) \
1571 \\([0-9A-Fa-f][0-9A-Fa-f]\\) \\([^ ]+\\) \\([0-9]+\\)"
1572 string)
1573 (let ((signature (epg-make-signature 'error)))
1574 (epg-context-set-result-for
1575 context
1576 'verify
1577 (cons signature
1578 (epg-context-result-for context 'verify)))
1579 (epg-signature-set-key-id
1580 signature
1581 (match-string 1 string))
1582 (epg-signature-set-pubkey-algorithm
1583 signature
1584 (string-to-number (match-string 2 string)))
1585 (epg-signature-set-digest-algorithm
1586 signature
1587 (string-to-number (match-string 3 string)))
1588 (epg-signature-set-class
1589 signature
1590 (string-to-number (match-string 4 string) 16))
1591 (epg-signature-set-creation-time
1592 signature
1593 (epg--time-from-seconds (match-string 5 string))))))
1595 (defun epg--status-VALIDSIG (context string)
1596 (let ((signature (car (epg-context-result-for context 'verify))))
1597 (when (and signature
1598 (eq (epg-signature-status signature) 'good)
1599 (string-match "\\`\\([^ ]+\\) [^ ]+ \\([^ ]+\\) \\([^ ]+\\) \
1600 \\([0-9]+\\) [^ ]+ \\([0-9]+\\) \\([0-9]+\\) \\([0-9A-Fa-f][0-9A-Fa-f]\\) \
1601 \\(.*\\)"
1602 string))
1603 (epg-signature-set-fingerprint
1604 signature
1605 (match-string 1 string))
1606 (epg-signature-set-creation-time
1607 signature
1608 (epg--time-from-seconds (match-string 2 string)))
1609 (unless (equal (match-string 3 string) "0")
1610 (epg-signature-set-expiration-time
1611 signature
1612 (epg--time-from-seconds (match-string 3 string))))
1613 (epg-signature-set-version
1614 signature
1615 (string-to-number (match-string 4 string)))
1616 (epg-signature-set-pubkey-algorithm
1617 signature
1618 (string-to-number (match-string 5 string)))
1619 (epg-signature-set-digest-algorithm
1620 signature
1621 (string-to-number (match-string 6 string)))
1622 (epg-signature-set-class
1623 signature
1624 (string-to-number (match-string 7 string) 16)))))
1626 (defun epg--status-TRUST_UNDEFINED (context _string)
1627 (let ((signature (car (epg-context-result-for context 'verify))))
1628 (if (and signature
1629 (eq (epg-signature-status signature) 'good))
1630 (epg-signature-set-validity signature 'undefined))))
1632 (defun epg--status-TRUST_NEVER (context _string)
1633 (let ((signature (car (epg-context-result-for context 'verify))))
1634 (if (and signature
1635 (eq (epg-signature-status signature) 'good))
1636 (epg-signature-set-validity signature 'never))))
1638 (defun epg--status-TRUST_MARGINAL (context _string)
1639 (let ((signature (car (epg-context-result-for context 'verify))))
1640 (if (and signature
1641 (eq (epg-signature-status signature) 'marginal))
1642 (epg-signature-set-validity signature 'marginal))))
1644 (defun epg--status-TRUST_FULLY (context _string)
1645 (let ((signature (car (epg-context-result-for context 'verify))))
1646 (if (and signature
1647 (eq (epg-signature-status signature) 'good))
1648 (epg-signature-set-validity signature 'full))))
1650 (defun epg--status-TRUST_ULTIMATE (context _string)
1651 (let ((signature (car (epg-context-result-for context 'verify))))
1652 (if (and signature
1653 (eq (epg-signature-status signature) 'good))
1654 (epg-signature-set-validity signature 'ultimate))))
1656 (defun epg--status-NOTATION_NAME (context string)
1657 (let ((signature (car (epg-context-result-for context 'verify))))
1658 (if signature
1659 (epg-signature-set-notations
1660 signature
1661 (cons (epg-make-sig-notation string nil t nil)
1662 (epg-sig-notations signature))))))
1664 (defun epg--status-NOTATION_DATA (context string)
1665 (let ((signature (car (epg-context-result-for context 'verify)))
1666 notation)
1667 (if (and signature
1668 (setq notation (car (epg-sig-notations signature))))
1669 (epg-sig-notation-set-value notation string))))
1671 (defun epg--status-POLICY_URL (context string)
1672 (let ((signature (car (epg-context-result-for context 'verify))))
1673 (if signature
1674 (epg-signature-set-notations
1675 signature
1676 (cons (epg-make-sig-notation nil string t nil)
1677 (epg-sig-notations signature))))))
1679 (defun epg--status-PROGRESS (context string)
1680 (if (and (epg-context-progress-callback context)
1681 (string-match "\\`\\([^ ]+\\) \\([^ ]\\) \\([0-9]+\\) \\([0-9]+\\)"
1682 string))
1683 (funcall (car (epg-context-progress-callback context))
1684 context
1685 (match-string 1 string)
1686 (match-string 2 string)
1687 (string-to-number (match-string 3 string))
1688 (string-to-number (match-string 4 string))
1689 (cdr (epg-context-progress-callback context)))))
1691 (defun epg--status-ENC_TO (context string)
1692 (if (string-match "\\`\\([0-9A-Za-z]+\\) \\([0-9]+\\) \\([0-9]+\\)" string)
1693 (epg-context-set-result-for
1694 context 'encrypted-to
1695 (cons (list (match-string 1 string)
1696 (string-to-number (match-string 2 string))
1697 (string-to-number (match-string 3 string)))
1698 (epg-context-result-for context 'encrypted-to)))))
1700 (defun epg--status-DECRYPTION_FAILED (context _string)
1701 (epg-context-set-result-for context 'decryption-failed t))
1703 (defun epg--status-DECRYPTION_OKAY (context _string)
1704 (epg-context-set-result-for context 'decryption-okay t))
1706 (defun epg--status-NODATA (context string)
1707 (epg-context-set-result-for
1708 context 'error
1709 (cons (cons 'no-data (string-to-number string))
1710 (epg-context-result-for context 'error))))
1712 (defun epg--status-UNEXPECTED (context string)
1713 (epg-context-set-result-for
1714 context 'error
1715 (cons (cons 'unexpected (string-to-number string))
1716 (epg-context-result-for context 'error))))
1718 (defun epg--status-KEYEXPIRED (context string)
1719 (epg-context-set-result-for
1720 context 'key
1721 (cons (list 'key-expired (cons 'expiration-time
1722 (epg--time-from-seconds string)))
1723 (epg-context-result-for context 'key))))
1725 (defun epg--status-KEYREVOKED (context _string)
1726 (epg-context-set-result-for
1727 context 'key
1728 (cons '(key-revoked)
1729 (epg-context-result-for context 'key))))
1731 (defun epg--status-BADARMOR (context _string)
1732 (epg-context-set-result-for
1733 context 'error
1734 (cons '(bad-armor)
1735 (epg-context-result-for context 'error))))
1737 (defun epg--status-INV_RECP (context string)
1738 (if (string-match "\\`\\([0-9]+\\) \\(.*\\)" string)
1739 (epg-context-set-result-for
1740 context 'error
1741 (cons (list 'invalid-recipient
1742 (cons 'reason
1743 (string-to-number (match-string 1 string)))
1744 (cons 'requested
1745 (match-string 2 string)))
1746 (epg-context-result-for context 'error)))))
1748 (defun epg--status-INV_SGNR (context string)
1749 (if (string-match "\\`\\([0-9]+\\) \\(.*\\)" string)
1750 (epg-context-set-result-for
1751 context 'error
1752 (cons (list 'invalid-signer
1753 (cons 'reason
1754 (string-to-number (match-string 1 string)))
1755 (cons 'requested
1756 (match-string 2 string)))
1757 (epg-context-result-for context 'error)))))
1759 (defun epg--status-NO_RECP (context _string)
1760 (epg-context-set-result-for
1761 context 'error
1762 (cons '(no-recipients)
1763 (epg-context-result-for context 'error))))
1765 (defun epg--status-NO_SGNR (context _string)
1766 (epg-context-set-result-for
1767 context 'error
1768 (cons '(no-signers)
1769 (epg-context-result-for context 'error))))
1771 (defun epg--status-DELETE_PROBLEM (context string)
1772 (if (string-match "\\`\\([0-9]+\\)" string)
1773 (epg-context-set-result-for
1774 context 'error
1775 (cons (cons 'delete-problem
1776 (string-to-number (match-string 1 string)))
1777 (epg-context-result-for context 'error)))))
1779 (defun epg--status-SIG_CREATED (context string)
1780 (if (string-match "\\`\\([DCS]\\) \\([0-9]+\\) \\([0-9]+\\) \
1781 \\([0-9A-Fa-F][0-9A-Fa-F]\\) \\(.*\\) " string)
1782 (epg-context-set-result-for
1783 context 'sign
1784 (cons (epg-make-new-signature
1785 (cdr (assq (aref (match-string 1 string) 0)
1786 epg-new-signature-type-alist))
1787 (string-to-number (match-string 2 string))
1788 (string-to-number (match-string 3 string))
1789 (string-to-number (match-string 4 string) 16)
1790 (epg--time-from-seconds (match-string 5 string))
1791 (substring string (match-end 0)))
1792 (epg-context-result-for context 'sign)))))
1794 (defun epg--status-KEY_CREATED (context string)
1795 (if (string-match "\\`\\([BPS]\\) \\([^ ]+\\)" string)
1796 (epg-context-set-result-for
1797 context 'generate-key
1798 (cons (list (cons 'type (string-to-char (match-string 1 string)))
1799 (cons 'fingerprint (match-string 2 string)))
1800 (epg-context-result-for context 'generate-key)))))
1802 (defun epg--status-KEY_NOT_CREATED (context _string)
1803 (epg-context-set-result-for
1804 context 'error
1805 (cons '(key-not-created)
1806 (epg-context-result-for context 'error))))
1808 (defun epg--status-IMPORTED (_context string)
1809 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
1810 (let* ((key-id (match-string 1 string))
1811 (user-id (match-string 2 string))
1812 (entry (assoc key-id epg-user-id-alist)))
1813 (condition-case nil
1814 (setq user-id (epg--decode-coding-string
1815 (epg--decode-percent-escape user-id)
1816 'utf-8))
1817 (error))
1818 (if entry
1819 (setcdr entry user-id)
1820 (setq epg-user-id-alist (cons (cons key-id user-id)
1821 epg-user-id-alist))))))
1823 (defun epg--status-IMPORT_OK (context string)
1824 (if (string-match "\\`\\([0-9]+\\)\\( \\(.+\\)\\)?" string)
1825 (let ((reason (string-to-number (match-string 1 string))))
1826 (epg-context-set-result-for
1827 context 'import-status
1828 (cons (epg-make-import-status (if (match-beginning 2)
1829 (match-string 3 string))
1831 (/= (logand reason 1) 0)
1832 (/= (logand reason 2) 0)
1833 (/= (logand reason 4) 0)
1834 (/= (logand reason 8) 0)
1835 (/= (logand reason 16) 0))
1836 (epg-context-result-for context 'import-status))))))
1838 (defun epg--status-IMPORT_PROBLEM (context string)
1839 (if (string-match "\\`\\([0-9]+\\)\\( \\(.+\\)\\)?" string)
1840 (epg-context-set-result-for
1841 context 'import-status
1842 (cons (epg-make-import-status
1843 (if (match-beginning 2)
1844 (match-string 3 string))
1845 (string-to-number (match-string 1 string)))
1846 (epg-context-result-for context 'import-status)))))
1848 (defun epg--status-IMPORT_RES (context string)
1849 (when (string-match "\\`\\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \
1850 \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\) \
1851 \\([0-9]+\\) \\([0-9]+\\) \\([0-9]+\\)" string)
1852 (epg-context-set-result-for
1853 context 'import
1854 (epg-make-import-result (string-to-number (match-string 1 string))
1855 (string-to-number (match-string 2 string))
1856 (string-to-number (match-string 3 string))
1857 (string-to-number (match-string 4 string))
1858 (string-to-number (match-string 5 string))
1859 (string-to-number (match-string 6 string))
1860 (string-to-number (match-string 7 string))
1861 (string-to-number (match-string 8 string))
1862 (string-to-number (match-string 9 string))
1863 (string-to-number (match-string 10 string))
1864 (string-to-number (match-string 11 string))
1865 (string-to-number (match-string 12 string))
1866 (string-to-number (match-string 13 string))
1867 (epg-context-result-for context 'import-status)))
1868 (epg-context-set-result-for context 'import-status nil)))
1870 (defun epg-passphrase-callback-function (context key-id _handback)
1871 (declare (obsolete epa-passphrase-callback-function "23.1"))
1872 (if (eq key-id 'SYM)
1873 (read-passwd "Passphrase for symmetric encryption: "
1874 (eq (epg-context-operation context) 'encrypt))
1875 (read-passwd
1876 (if (eq key-id 'PIN)
1877 "Passphrase for PIN: "
1878 (let ((entry (assoc key-id epg-user-id-alist)))
1879 (if entry
1880 (format "Passphrase for %s %s: " key-id (cdr entry))
1881 (format "Passphrase for %s: " key-id)))))))
1883 (defun epg--list-keys-1 (context name mode)
1884 (let ((args (append (if (epg-context-home-directory context)
1885 (list "--homedir"
1886 (epg-context-home-directory context)))
1887 '("--with-colons" "--no-greeting" "--batch"
1888 "--with-fingerprint" "--with-fingerprint")
1889 (unless (eq (epg-context-protocol context) 'CMS)
1890 '("--fixed-list-mode"))))
1891 (list-keys-option (if (memq mode '(t secret))
1892 "--list-secret-keys"
1893 (if (memq mode '(nil public))
1894 "--list-keys"
1895 "--list-sigs")))
1896 (coding-system-for-read 'binary)
1897 keys string field index)
1898 (if name
1899 (progn
1900 (unless (listp name)
1901 (setq name (list name)))
1902 (while name
1903 (setq args (append args (list list-keys-option (car name)))
1904 name (cdr name))))
1905 (setq args (append args (list list-keys-option))))
1906 (with-temp-buffer
1907 (apply #'call-process
1908 (epg-context-program context)
1909 nil (list t nil) nil args)
1910 (goto-char (point-min))
1911 (while (re-search-forward "^[a-z][a-z][a-z]:.*" nil t)
1912 (setq keys (cons (make-vector 15 nil) keys)
1913 string (match-string 0)
1914 index 0
1915 field 0)
1916 (while (eq index
1917 (string-match "\\([^:]+\\)?:" string index))
1918 (setq index (match-end 0))
1919 (aset (car keys) field (match-string 1 string))
1920 (setq field (1+ field))))
1921 (nreverse keys))))
1923 (defun epg--make-sub-key-1 (line)
1924 (epg-make-sub-key
1925 (if (aref line 1)
1926 (cdr (assq (string-to-char (aref line 1)) epg-key-validity-alist)))
1927 (delq nil
1928 (mapcar (lambda (char) (cdr (assq char epg-key-capablity-alist)))
1929 (aref line 11)))
1930 (member (aref line 0) '("sec" "ssb"))
1931 (string-to-number (aref line 3))
1932 (string-to-number (aref line 2))
1933 (aref line 4)
1934 (epg--time-from-seconds (aref line 5))
1935 (if (aref line 6)
1936 (epg--time-from-seconds (aref line 6)))))
1938 (defun epg-list-keys (context &optional name mode)
1939 "Return a list of epg-key objects matched with NAME.
1940 If MODE is nil or 'public, only public keyring should be searched.
1941 If MODE is t or 'secret, only secret keyring should be searched.
1942 Otherwise, only public keyring should be searched and the key
1943 signatures should be included.
1944 NAME is either a string or a list of strings."
1945 (let ((lines (epg--list-keys-1 context name mode))
1946 keys cert pointer pointer-1 index string)
1947 (while lines
1948 (cond
1949 ((member (aref (car lines) 0) '("pub" "sec" "crt" "crs"))
1950 (setq cert (member (aref (car lines) 0) '("crt" "crs"))
1951 keys (cons (epg-make-key
1952 (if (aref (car lines) 8)
1953 (cdr (assq (string-to-char (aref (car lines) 8))
1954 epg-key-validity-alist))))
1955 keys))
1956 (epg-key-set-sub-key-list
1957 (car keys)
1958 (cons (epg--make-sub-key-1 (car lines))
1959 (epg-key-sub-key-list (car keys)))))
1960 ((member (aref (car lines) 0) '("sub" "ssb"))
1961 (epg-key-set-sub-key-list
1962 (car keys)
1963 (cons (epg--make-sub-key-1 (car lines))
1964 (epg-key-sub-key-list (car keys)))))
1965 ((equal (aref (car lines) 0) "uid")
1966 ;; Decode the UID name as a backslash escaped UTF-8 string,
1967 ;; generated by GnuPG/GpgSM.
1968 (setq string (copy-sequence (aref (car lines) 9))
1969 index 0)
1970 (while (string-match "\"" string index)
1971 (setq string (replace-match "\\\"" t t string)
1972 index (1+ (match-end 0))))
1973 (condition-case nil
1974 (setq string (epg--decode-coding-string
1975 (car (read-from-string (concat "\"" string "\"")))
1976 'utf-8))
1977 (error
1978 (setq string (aref (car lines) 9))))
1979 (epg-key-set-user-id-list
1980 (car keys)
1981 (cons (epg-make-user-id
1982 (if (aref (car lines) 1)
1983 (cdr (assq (string-to-char (aref (car lines) 1))
1984 epg-key-validity-alist)))
1985 (if cert
1986 (condition-case nil
1987 (epg-dn-from-string string)
1988 (error string))
1989 string))
1990 (epg-key-user-id-list (car keys)))))
1991 ((equal (aref (car lines) 0) "fpr")
1992 (epg-sub-key-set-fingerprint (car (epg-key-sub-key-list (car keys)))
1993 (aref (car lines) 9)))
1994 ((equal (aref (car lines) 0) "sig")
1995 (epg-user-id-set-signature-list
1996 (car (epg-key-user-id-list (car keys)))
1997 (cons
1998 (epg-make-key-signature
1999 (if (aref (car lines) 1)
2000 (cdr (assq (string-to-char (aref (car lines) 1))
2001 epg-key-validity-alist)))
2002 (string-to-number (aref (car lines) 3))
2003 (aref (car lines) 4)
2004 (epg--time-from-seconds (aref (car lines) 5))
2005 (epg--time-from-seconds (aref (car lines) 6))
2006 (aref (car lines) 9)
2007 (string-to-number (aref (car lines) 10) 16)
2008 (eq (aref (aref (car lines) 10) 2) ?x))
2009 (epg-user-id-signature-list
2010 (car (epg-key-user-id-list (car keys))))))))
2011 (setq lines (cdr lines)))
2012 (setq keys (nreverse keys)
2013 pointer keys)
2014 (while pointer
2015 (epg-key-set-sub-key-list
2016 (car pointer)
2017 (nreverse (epg-key-sub-key-list (car pointer))))
2018 (setq pointer-1 (epg-key-set-user-id-list
2019 (car pointer)
2020 (nreverse (epg-key-user-id-list (car pointer)))))
2021 (while pointer-1
2022 (epg-user-id-set-signature-list
2023 (car pointer-1)
2024 (nreverse (epg-user-id-signature-list (car pointer-1))))
2025 (setq pointer-1 (cdr pointer-1)))
2026 (setq pointer (cdr pointer)))
2027 keys))
2029 (eval-and-compile
2030 (if (fboundp 'make-temp-file)
2031 (defalias 'epg--make-temp-file 'make-temp-file)
2032 (defvar temporary-file-directory)
2033 ;; stolen from poe.el.
2034 (defun epg--make-temp-file (prefix)
2035 "Create a temporary file.
2036 The returned file name (created by appending some random characters at the end
2037 of PREFIX, and expanding against `temporary-file-directory' if necessary),
2038 is guaranteed to point to a newly created empty file.
2039 You can then use `write-region' to write new data into the file."
2040 (let ((orig-modes (default-file-modes))
2041 tempdir tempfile)
2042 (setq prefix (expand-file-name prefix
2043 (if (featurep 'xemacs)
2044 (temp-directory)
2045 temporary-file-directory)))
2046 (unwind-protect
2047 (let (file)
2048 ;; First, create a temporary directory.
2049 (set-default-file-modes #o700)
2050 (while (condition-case ()
2051 (progn
2052 (setq tempdir (make-temp-name
2053 (concat
2054 (file-name-directory prefix)
2055 "DIR")))
2056 ;; return nil or signal an error.
2057 (make-directory tempdir))
2058 ;; let's try again.
2059 (file-already-exists t)))
2060 ;; Second, create a temporary file in the tempdir.
2061 ;; There *is* a race condition between `make-temp-name'
2062 ;; and `write-region', but we don't care it since we are
2063 ;; in a private directory now.
2064 (setq tempfile (make-temp-name (concat tempdir "/EMU")))
2065 (write-region "" nil tempfile nil 'silent)
2066 ;; Finally, make a hard-link from the tempfile.
2067 (while (condition-case ()
2068 (progn
2069 (setq file (make-temp-name prefix))
2070 ;; return nil or signal an error.
2071 (add-name-to-file tempfile file))
2072 ;; let's try again.
2073 (file-already-exists t)))
2074 file)
2075 (set-default-file-modes orig-modes)
2076 ;; Cleanup the tempfile.
2077 (and tempfile
2078 (file-exists-p tempfile)
2079 (delete-file tempfile))
2080 ;; Cleanup the tempdir.
2081 (and tempdir
2082 (file-directory-p tempdir)
2083 (delete-directory tempdir)))))))
2085 (defun epg--args-from-sig-notations (notations)
2086 (apply #'nconc
2087 (mapcar
2088 (lambda (notation)
2089 (if (and (epg-sig-notation-name notation)
2090 (not (epg-sig-notation-human-readable notation)))
2091 (error "Unreadable"))
2092 (if (epg-sig-notation-name notation)
2093 (list "--sig-notation"
2094 (if (epg-sig-notation-critical notation)
2095 (concat "!" (epg-sig-notation-name notation)
2096 "=" (epg-sig-notation-value notation))
2097 (concat (epg-sig-notation-name notation)
2098 "=" (epg-sig-notation-value notation))))
2099 (list "--sig-policy-url"
2100 (if (epg-sig-notation-critical notation)
2101 (concat "!" (epg-sig-notation-value notation))
2102 (epg-sig-notation-value notation)))))
2103 notations)))
2105 (defun epg-cancel (context)
2106 (if (buffer-live-p (process-buffer (epg-context-process context)))
2107 (with-current-buffer (process-buffer (epg-context-process context))
2108 (epg-context-set-result-for
2109 epg-context 'error
2110 (cons '(quit)
2111 (epg-context-result-for epg-context 'error)))))
2112 (if (eq (process-status (epg-context-process context)) 'run)
2113 (delete-process (epg-context-process context))))
2115 (defun epg-start-decrypt (context cipher)
2116 "Initiate a decrypt operation on CIPHER.
2117 CIPHER must be a file data object.
2119 If you use this function, you will need to wait for the completion of
2120 `epg-gpg-program' by using `epg-wait-for-completion' and call
2121 `epg-reset' to clear a temporary output file.
2122 If you are unsure, use synchronous version of this function
2123 `epg-decrypt-file' or `epg-decrypt-string' instead."
2124 (unless (epg-data-file cipher)
2125 (error "Not a file"))
2126 (epg-context-set-operation context 'decrypt)
2127 (epg-context-set-result context nil)
2128 (epg--start context (list "--decrypt" "--" (epg-data-file cipher)))
2129 ;; `gpgsm' does not read passphrase from stdin, so waiting is not needed.
2130 (unless (eq (epg-context-protocol context) 'CMS)
2131 (epg-wait-for-status context '("BEGIN_DECRYPTION"))))
2133 (defun epg--check-error-for-decrypt (context)
2134 (let ((errors (epg-context-result-for context 'error)))
2135 (if (epg-context-result-for context 'decryption-failed)
2136 (signal 'epg-error
2137 (list "Decryption failed" (epg-errors-to-string errors))))
2138 (unless (epg-context-result-for context 'decryption-okay)
2139 (signal 'epg-error
2140 (list "Can't decrypt" (epg-errors-to-string errors))))))
2142 (defun epg-decrypt-file (context cipher plain)
2143 "Decrypt a file CIPHER and store the result to a file PLAIN.
2144 If PLAIN is nil, it returns the result as a string."
2145 (unwind-protect
2146 (progn
2147 (if plain
2148 (epg-context-set-output-file context plain)
2149 (epg-context-set-output-file context
2150 (epg--make-temp-file "epg-output")))
2151 (epg-start-decrypt context (epg-make-data-from-file cipher))
2152 (epg-wait-for-completion context)
2153 (epg--check-error-for-decrypt context)
2154 (unless plain
2155 (epg-read-output context)))
2156 (unless plain
2157 (epg-delete-output-file context))
2158 (epg-reset context)))
2160 (defun epg-decrypt-string (context cipher)
2161 "Decrypt a string CIPHER and return the plain text."
2162 (let ((input-file (epg--make-temp-file "epg-input"))
2163 (coding-system-for-write 'binary))
2164 (unwind-protect
2165 (progn
2166 (write-region cipher nil input-file nil 'quiet)
2167 (epg-context-set-output-file context
2168 (epg--make-temp-file "epg-output"))
2169 (epg-start-decrypt context (epg-make-data-from-file input-file))
2170 (epg-wait-for-completion context)
2171 (epg--check-error-for-decrypt context)
2172 (epg-read-output context))
2173 (epg-delete-output-file context)
2174 (if (file-exists-p input-file)
2175 (delete-file input-file))
2176 (epg-reset context))))
2178 (defun epg-start-verify (context signature &optional signed-text)
2179 "Initiate a verify operation on SIGNATURE.
2180 SIGNATURE and SIGNED-TEXT are a data object if they are specified.
2182 For a detached signature, both SIGNATURE and SIGNED-TEXT should be set.
2183 For a normal or a cleartext signature, SIGNED-TEXT should be nil.
2185 If you use this function, you will need to wait for the completion of
2186 `epg-gpg-program' by using `epg-wait-for-completion' and call
2187 `epg-reset' to clear a temporary output file.
2188 If you are unsure, use synchronous version of this function
2189 `epg-verify-file' or `epg-verify-string' instead."
2190 (epg-context-set-operation context 'verify)
2191 (epg-context-set-result context nil)
2192 (if signed-text
2193 ;; Detached signature.
2194 (if (epg-data-file signed-text)
2195 (epg--start context (list "--verify" "--" (epg-data-file signature)
2196 (epg-data-file signed-text)))
2197 (epg--start context (list "--verify" "--" (epg-data-file signature)
2198 "-"))
2199 (if (eq (process-status (epg-context-process context)) 'run)
2200 (process-send-string (epg-context-process context)
2201 (epg-data-string signed-text)))
2202 (if (eq (process-status (epg-context-process context)) 'run)
2203 (process-send-eof (epg-context-process context))))
2204 ;; Normal (or cleartext) signature.
2205 (if (epg-data-file signature)
2206 (epg--start context (if (eq (epg-context-protocol context) 'CMS)
2207 (list "--verify" "--" (epg-data-file signature))
2208 (list "--" (epg-data-file signature))))
2209 (epg--start context (if (eq (epg-context-protocol context) 'CMS)
2210 '("--verify" "-")
2211 '("-")))
2212 (if (eq (process-status (epg-context-process context)) 'run)
2213 (process-send-string (epg-context-process context)
2214 (epg-data-string signature)))
2215 (if (eq (process-status (epg-context-process context)) 'run)
2216 (process-send-eof (epg-context-process context))))))
2218 (defun epg-verify-file (context signature &optional signed-text plain)
2219 "Verify a file SIGNATURE.
2220 SIGNED-TEXT and PLAIN are also a file if they are specified.
2222 For a detached signature, both SIGNATURE and SIGNED-TEXT should be
2223 string. For a normal or a cleartext signature, SIGNED-TEXT should be
2224 nil. In the latter case, if PLAIN is specified, the plaintext is
2225 stored into the file after successful verification."
2226 (unwind-protect
2227 (progn
2228 (if plain
2229 (epg-context-set-output-file context plain)
2230 (epg-context-set-output-file context
2231 (epg--make-temp-file "epg-output")))
2232 (if signed-text
2233 (epg-start-verify context
2234 (epg-make-data-from-file signature)
2235 (epg-make-data-from-file signed-text))
2236 (epg-start-verify context
2237 (epg-make-data-from-file signature)))
2238 (epg-wait-for-completion context)
2239 (unless plain
2240 (epg-read-output context)))
2241 (unless plain
2242 (epg-delete-output-file context))
2243 (epg-reset context)))
2245 (defun epg-verify-string (context signature &optional signed-text)
2246 "Verify a string SIGNATURE.
2247 SIGNED-TEXT is a string if it is specified.
2249 For a detached signature, both SIGNATURE and SIGNED-TEXT should be
2250 string. For a normal or a cleartext signature, SIGNED-TEXT should be
2251 nil. In the latter case, this function returns the plaintext after
2252 successful verification."
2253 (let ((coding-system-for-write 'binary)
2254 input-file)
2255 (unwind-protect
2256 (progn
2257 (epg-context-set-output-file context
2258 (epg--make-temp-file "epg-output"))
2259 (if signed-text
2260 (progn
2261 (setq input-file (epg--make-temp-file "epg-signature"))
2262 (write-region signature nil input-file nil 'quiet)
2263 (epg-start-verify context
2264 (epg-make-data-from-file input-file)
2265 (epg-make-data-from-string signed-text)))
2266 (epg-start-verify context (epg-make-data-from-string signature)))
2267 (epg-wait-for-completion context)
2268 (epg-read-output context))
2269 (epg-delete-output-file context)
2270 (if (and input-file
2271 (file-exists-p input-file))
2272 (delete-file input-file))
2273 (epg-reset context))))
2275 (defun epg-start-sign (context plain &optional mode)
2276 "Initiate a sign operation on PLAIN.
2277 PLAIN is a data object.
2279 If optional 3rd argument MODE is t or 'detached, it makes a detached signature.
2280 If it is nil or 'normal, it makes a normal signature.
2281 Otherwise, it makes a cleartext signature.
2283 If you use this function, you will need to wait for the completion of
2284 `epg-gpg-program' by using `epg-wait-for-completion' and call
2285 `epg-reset' to clear a temporary output file.
2286 If you are unsure, use synchronous version of this function
2287 `epg-sign-file' or `epg-sign-string' instead."
2288 (epg-context-set-operation context 'sign)
2289 (epg-context-set-result context nil)
2290 (unless (memq mode '(t detached nil normal)) ;i.e. cleartext
2291 (epg-context-set-armor context nil)
2292 (epg-context-set-textmode context nil))
2293 (epg--start context
2294 (append (list (if (memq mode '(t detached))
2295 "--detach-sign"
2296 (if (memq mode '(nil normal))
2297 "--sign"
2298 "--clearsign")))
2299 (apply #'nconc
2300 (mapcar
2301 (lambda (signer)
2302 (list "-u"
2303 (epg-sub-key-id
2304 (car (epg-key-sub-key-list signer)))))
2305 (epg-context-signers context)))
2306 (epg--args-from-sig-notations
2307 (epg-context-sig-notations context))
2308 (if (epg-data-file plain)
2309 (list "--" (epg-data-file plain)))))
2310 ;; `gpgsm' does not read passphrase from stdin, so waiting is not needed.
2311 (unless (eq (epg-context-protocol context) 'CMS)
2312 (epg-wait-for-status context '("BEGIN_SIGNING")))
2313 (when (epg-data-string plain)
2314 (if (eq (process-status (epg-context-process context)) 'run)
2315 (process-send-string (epg-context-process context)
2316 (epg-data-string plain)))
2317 (if (eq (process-status (epg-context-process context)) 'run)
2318 (process-send-eof (epg-context-process context)))))
2320 (defun epg-sign-file (context plain signature &optional mode)
2321 "Sign a file PLAIN and store the result to a file SIGNATURE.
2322 If SIGNATURE is nil, it returns the result as a string.
2323 If optional 3rd argument MODE is t or 'detached, it makes a detached signature.
2324 If it is nil or 'normal, it makes a normal signature.
2325 Otherwise, it makes a cleartext signature."
2326 (unwind-protect
2327 (progn
2328 (if signature
2329 (epg-context-set-output-file context signature)
2330 (epg-context-set-output-file context
2331 (epg--make-temp-file "epg-output")))
2332 (epg-start-sign context (epg-make-data-from-file plain) mode)
2333 (epg-wait-for-completion context)
2334 (unless (epg-context-result-for context 'sign)
2335 (let ((errors (epg-context-result-for context 'error)))
2336 (signal 'epg-error
2337 (list "Sign failed" (epg-errors-to-string errors)))))
2338 (unless signature
2339 (epg-read-output context)))
2340 (unless signature
2341 (epg-delete-output-file context))
2342 (epg-reset context)))
2344 (defun epg-sign-string (context plain &optional mode)
2345 "Sign a string PLAIN and return the output as string.
2346 If optional 3rd argument MODE is t or 'detached, it makes a detached signature.
2347 If it is nil or 'normal, it makes a normal signature.
2348 Otherwise, it makes a cleartext signature."
2349 (let ((input-file
2350 (unless (or (eq (epg-context-protocol context) 'CMS)
2351 (condition-case nil
2352 (progn
2353 (epg-check-configuration (epg-configuration))
2355 (error)))
2356 (epg--make-temp-file "epg-input")))
2357 (coding-system-for-write 'binary))
2358 (unwind-protect
2359 (progn
2360 (epg-context-set-output-file context
2361 (epg--make-temp-file "epg-output"))
2362 (if input-file
2363 (write-region plain nil input-file nil 'quiet))
2364 (epg-start-sign context
2365 (if input-file
2366 (epg-make-data-from-file input-file)
2367 (epg-make-data-from-string plain))
2368 mode)
2369 (epg-wait-for-completion context)
2370 (unless (epg-context-result-for context 'sign)
2371 (if (epg-context-result-for context 'error)
2372 (let ((errors (epg-context-result-for context 'error)))
2373 (signal 'epg-error
2374 (list "Sign failed" (epg-errors-to-string errors))))))
2375 (epg-read-output context))
2376 (epg-delete-output-file context)
2377 (if input-file
2378 (delete-file input-file))
2379 (epg-reset context))))
2381 (defun epg-start-encrypt (context plain recipients
2382 &optional sign always-trust)
2383 "Initiate an encrypt operation on PLAIN.
2384 PLAIN is a data object.
2385 If RECIPIENTS is nil, it performs symmetric encryption.
2387 If you use this function, you will need to wait for the completion of
2388 `epg-gpg-program' by using `epg-wait-for-completion' and call
2389 `epg-reset' to clear a temporary output file.
2390 If you are unsure, use synchronous version of this function
2391 `epg-encrypt-file' or `epg-encrypt-string' instead."
2392 (epg-context-set-operation context 'encrypt)
2393 (epg-context-set-result context nil)
2394 (epg--start context
2395 (append (if always-trust '("--always-trust"))
2396 (if recipients '("--encrypt") '("--symmetric"))
2397 (if sign '("--sign"))
2398 (if sign
2399 (apply #'nconc
2400 (mapcar
2401 (lambda (signer)
2402 (list "-u"
2403 (epg-sub-key-id
2404 (car (epg-key-sub-key-list
2405 signer)))))
2406 (epg-context-signers context))))
2407 (if sign
2408 (epg--args-from-sig-notations
2409 (epg-context-sig-notations context)))
2410 (apply #'nconc
2411 (mapcar
2412 (lambda (recipient)
2413 (list "-r"
2414 (epg-sub-key-id
2415 (car (epg-key-sub-key-list recipient)))))
2416 recipients))
2417 (if (epg-data-file plain)
2418 (list "--" (epg-data-file plain)))))
2419 ;; `gpgsm' does not read passphrase from stdin, so waiting is not needed.
2420 (unless (eq (epg-context-protocol context) 'CMS)
2421 (if sign
2422 (epg-wait-for-status context '("BEGIN_SIGNING"))
2423 (epg-wait-for-status context '("BEGIN_ENCRYPTION"))))
2424 (when (epg-data-string plain)
2425 (if (eq (process-status (epg-context-process context)) 'run)
2426 (process-send-string (epg-context-process context)
2427 (epg-data-string plain)))
2428 (if (eq (process-status (epg-context-process context)) 'run)
2429 (process-send-eof (epg-context-process context)))))
2431 (defun epg-encrypt-file (context plain recipients
2432 cipher &optional sign always-trust)
2433 "Encrypt a file PLAIN and store the result to a file CIPHER.
2434 If CIPHER is nil, it returns the result as a string.
2435 If RECIPIENTS is nil, it performs symmetric encryption."
2436 (unwind-protect
2437 (progn
2438 (if cipher
2439 (epg-context-set-output-file context cipher)
2440 (epg-context-set-output-file context
2441 (epg--make-temp-file "epg-output")))
2442 (epg-start-encrypt context (epg-make-data-from-file plain)
2443 recipients sign always-trust)
2444 (epg-wait-for-completion context)
2445 (let ((errors (epg-context-result-for context 'error)))
2446 (if (and sign
2447 (not (epg-context-result-for context 'sign)))
2448 (signal 'epg-error
2449 (list "Sign failed" (epg-errors-to-string errors))))
2450 (if errors
2451 (signal 'epg-error
2452 (list "Encrypt failed" (epg-errors-to-string errors)))))
2453 (unless cipher
2454 (epg-read-output context)))
2455 (unless cipher
2456 (epg-delete-output-file context))
2457 (epg-reset context)))
2459 (defun epg-encrypt-string (context plain recipients
2460 &optional sign always-trust)
2461 "Encrypt a string PLAIN.
2462 If RECIPIENTS is nil, it performs symmetric encryption."
2463 (let ((input-file
2464 (unless (or (not sign)
2465 (eq (epg-context-protocol context) 'CMS)
2466 (condition-case nil
2467 (progn
2468 (epg-check-configuration (epg-configuration))
2470 (error)))
2471 (epg--make-temp-file "epg-input")))
2472 (coding-system-for-write 'binary))
2473 (unwind-protect
2474 (progn
2475 (epg-context-set-output-file context
2476 (epg--make-temp-file "epg-output"))
2477 (if input-file
2478 (write-region plain nil input-file nil 'quiet))
2479 (epg-start-encrypt context
2480 (if input-file
2481 (epg-make-data-from-file input-file)
2482 (epg-make-data-from-string plain))
2483 recipients sign always-trust)
2484 (epg-wait-for-completion context)
2485 (let ((errors (epg-context-result-for context 'error)))
2486 (if (and sign
2487 (not (epg-context-result-for context 'sign)))
2488 (signal 'epg-error
2489 (list "Sign failed" (epg-errors-to-string errors))))
2490 (if errors
2491 (signal 'epg-error
2492 (list "Encrypt failed" (epg-errors-to-string errors)))))
2493 (epg-read-output context))
2494 (epg-delete-output-file context)
2495 (if input-file
2496 (delete-file input-file))
2497 (epg-reset context))))
2499 (defun epg-start-export-keys (context keys)
2500 "Initiate an export keys operation.
2502 If you use this function, you will need to wait for the completion of
2503 `epg-gpg-program' by using `epg-wait-for-completion' and call
2504 `epg-reset' to clear a temporary output file.
2505 If you are unsure, use synchronous version of this function
2506 `epg-export-keys-to-file' or `epg-export-keys-to-string' instead."
2507 (epg-context-set-operation context 'export-keys)
2508 (epg-context-set-result context nil)
2509 (epg--start context (cons "--export"
2510 (mapcar
2511 (lambda (key)
2512 (epg-sub-key-id
2513 (car (epg-key-sub-key-list key))))
2514 keys))))
2516 (defun epg-export-keys-to-file (context keys file)
2517 "Extract public KEYS."
2518 (unwind-protect
2519 (progn
2520 (if file
2521 (epg-context-set-output-file context file)
2522 (epg-context-set-output-file context
2523 (epg--make-temp-file "epg-output")))
2524 (epg-start-export-keys context keys)
2525 (epg-wait-for-completion context)
2526 (let ((errors (epg-context-result-for context 'error)))
2527 (if errors
2528 (signal 'epg-error
2529 (list "Export keys failed"
2530 (epg-errors-to-string errors)))))
2531 (unless file
2532 (epg-read-output context)))
2533 (unless file
2534 (epg-delete-output-file context))
2535 (epg-reset context)))
2537 (defun epg-export-keys-to-string (context keys)
2538 "Extract public KEYS and return them as a string."
2539 (epg-export-keys-to-file context keys nil))
2541 (defun epg-start-import-keys (context keys)
2542 "Initiate an import keys operation.
2543 KEYS is a data object.
2545 If you use this function, you will need to wait for the completion of
2546 `epg-gpg-program' by using `epg-wait-for-completion' and call
2547 `epg-reset' to clear a temporary output file.
2548 If you are unsure, use synchronous version of this function
2549 `epg-import-keys-from-file' or `epg-import-keys-from-string' instead."
2550 (epg-context-set-operation context 'import-keys)
2551 (epg-context-set-result context nil)
2552 (epg--start context (if (epg-data-file keys)
2553 (list "--import" "--" (epg-data-file keys))
2554 (list "--import")))
2555 (when (epg-data-string keys)
2556 (if (eq (process-status (epg-context-process context)) 'run)
2557 (process-send-string (epg-context-process context)
2558 (epg-data-string keys)))
2559 (if (eq (process-status (epg-context-process context)) 'run)
2560 (process-send-eof (epg-context-process context)))))
2562 (defun epg--import-keys-1 (context keys)
2563 (unwind-protect
2564 (progn
2565 (epg-start-import-keys context keys)
2566 (epg-wait-for-completion context)
2567 (let ((errors (epg-context-result-for context 'error)))
2568 (if errors
2569 (signal 'epg-error
2570 (list "Import keys failed"
2571 (epg-errors-to-string errors))))))
2572 (epg-reset context)))
2574 (defun epg-import-keys-from-file (context keys)
2575 "Add keys from a file KEYS."
2576 (epg--import-keys-1 context (epg-make-data-from-file keys)))
2578 (defun epg-import-keys-from-string (context keys)
2579 "Add keys from a string KEYS."
2580 (epg--import-keys-1 context (epg-make-data-from-string keys)))
2582 (defun epg-start-receive-keys (context key-id-list)
2583 "Initiate a receive key operation.
2584 KEY-ID-LIST is a list of key IDs.
2586 If you use this function, you will need to wait for the completion of
2587 `epg-gpg-program' by using `epg-wait-for-completion' and call
2588 `epg-reset' to clear a temporary output file.
2589 If you are unsure, use synchronous version of this function
2590 `epg-receive-keys' instead."
2591 (epg-context-set-operation context 'receive-keys)
2592 (epg-context-set-result context nil)
2593 (epg--start context (cons "--recv-keys" key-id-list)))
2595 (defun epg-receive-keys (context keys)
2596 "Add keys from server.
2597 KEYS is a list of key IDs"
2598 (unwind-protect
2599 (progn
2600 (epg-start-receive-keys context keys)
2601 (epg-wait-for-completion context)
2602 (let ((errors (epg-context-result-for context 'error)))
2603 (if errors
2604 (signal 'epg-error
2605 (list "Receive keys failed"
2606 (epg-errors-to-string errors))))))
2607 (epg-reset context)))
2609 (defalias 'epg-import-keys-from-server 'epg-receive-keys)
2611 (defun epg-start-delete-keys (context keys &optional allow-secret)
2612 "Initiate a delete keys operation.
2614 If you use this function, you will need to wait for the completion of
2615 `epg-gpg-program' by using `epg-wait-for-completion' and call
2616 `epg-reset' to clear a temporary output file.
2617 If you are unsure, use synchronous version of this function
2618 `epg-delete-keys' instead."
2619 (epg-context-set-operation context 'delete-keys)
2620 (epg-context-set-result context nil)
2621 (epg--start context (cons (if allow-secret
2622 "--delete-secret-key"
2623 "--delete-key")
2624 (mapcar
2625 (lambda (key)
2626 (epg-sub-key-id
2627 (car (epg-key-sub-key-list key))))
2628 keys))))
2630 (defun epg-delete-keys (context keys &optional allow-secret)
2631 "Delete KEYS from the key ring."
2632 (unwind-protect
2633 (progn
2634 (epg-start-delete-keys context keys allow-secret)
2635 (epg-wait-for-completion context)
2636 (let ((errors (epg-context-result-for context 'error)))
2637 (if errors
2638 (signal 'epg-error
2639 (list "Delete keys failed"
2640 (epg-errors-to-string errors))))))
2641 (epg-reset context)))
2643 (defun epg-start-sign-keys (context keys &optional local)
2644 "Initiate a sign keys operation.
2646 If you use this function, you will need to wait for the completion of
2647 `epg-gpg-program' by using `epg-wait-for-completion' and call
2648 `epg-reset' to clear a temporary output file.
2649 If you are unsure, use synchronous version of this function
2650 `epg-sign-keys' instead."
2651 (declare (obsolete nil "23.1"))
2652 (epg-context-set-operation context 'sign-keys)
2653 (epg-context-set-result context nil)
2654 (epg--start context (cons (if local
2655 "--lsign-key"
2656 "--sign-key")
2657 (mapcar
2658 (lambda (key)
2659 (epg-sub-key-id
2660 (car (epg-key-sub-key-list key))))
2661 keys))))
2663 (defun epg-sign-keys (context keys &optional local)
2664 "Sign KEYS from the key ring."
2665 (declare (obsolete nil "23.1"))
2666 (unwind-protect
2667 (progn
2668 (epg-start-sign-keys context keys local)
2669 (epg-wait-for-completion context)
2670 (let ((errors (epg-context-result-for context 'error)))
2671 (if errors
2672 (signal 'epg-error
2673 (list "Sign keys failed"
2674 (epg-errors-to-string errors))))))
2675 (epg-reset context)))
2677 (defun epg-start-generate-key (context parameters)
2678 "Initiate a key generation.
2679 PARAMETERS specifies parameters for the key.
2681 If you use this function, you will need to wait for the completion of
2682 `epg-gpg-program' by using `epg-wait-for-completion' and call
2683 `epg-reset' to clear a temporary output file.
2684 If you are unsure, use synchronous version of this function
2685 `epg-generate-key-from-file' or `epg-generate-key-from-string' instead."
2686 (epg-context-set-operation context 'generate-key)
2687 (epg-context-set-result context nil)
2688 (if (epg-data-file parameters)
2689 (epg--start context (list "--batch" "--genkey" "--"
2690 (epg-data-file parameters)))
2691 (epg--start context '("--batch" "--genkey"))
2692 (if (eq (process-status (epg-context-process context)) 'run)
2693 (process-send-string (epg-context-process context)
2694 (epg-data-string parameters)))
2695 (if (eq (process-status (epg-context-process context)) 'run)
2696 (process-send-eof (epg-context-process context)))))
2698 (defun epg-generate-key-from-file (context parameters)
2699 "Generate a new key pair.
2700 PARAMETERS is a file which tells how to create the key."
2701 (unwind-protect
2702 (progn
2703 (epg-start-generate-key context (epg-make-data-from-file parameters))
2704 (epg-wait-for-completion context)
2705 (let ((errors (epg-context-result-for context 'error)))
2706 (if errors
2707 (signal 'epg-error
2708 (list "Generate key failed"
2709 (epg-errors-to-string errors))))))
2710 (epg-reset context)))
2712 (defun epg-generate-key-from-string (context parameters)
2713 "Generate a new key pair.
2714 PARAMETERS is a string which tells how to create the key."
2715 (unwind-protect
2716 (progn
2717 (epg-start-generate-key context (epg-make-data-from-string parameters))
2718 (epg-wait-for-completion context)
2719 (let ((errors (epg-context-result-for context 'error)))
2720 (if errors
2721 (signal 'epg-error
2722 (list "Generate key failed"
2723 (epg-errors-to-string errors))))))
2724 (epg-reset context)))
2726 (defun epg--decode-percent-escape (string)
2727 (let ((index 0))
2728 (while (string-match "%\\(\\(%\\)\\|\\([0-9A-Fa-f][0-9A-Fa-f]\\)\\)"
2729 string index)
2730 (if (match-beginning 2)
2731 (setq string (replace-match "%" t t string)
2732 index (1- (match-end 0)))
2733 (setq string (replace-match
2734 (string (string-to-number (match-string 3 string) 16))
2735 t t string)
2736 index (- (match-end 0) 2))))
2737 string))
2739 (defun epg--decode-hexstring (string)
2740 (let ((index 0))
2741 (while (eq index (string-match "[0-9A-Fa-f][0-9A-Fa-f]" string index))
2742 (setq string (replace-match (string (string-to-number
2743 (match-string 0 string) 16))
2744 t t string)
2745 index (1- (match-end 0))))
2746 string))
2748 (defun epg--decode-quotedstring (string)
2749 (let ((index 0))
2750 (while (string-match "\\\\\\(\\([,=+<>#;\\\"]\\)\\|\
2751 \\([0-9A-Fa-f][0-9A-Fa-f]\\)\\)"
2752 string index)
2753 (if (match-beginning 2)
2754 (setq string (replace-match "\\2" t nil string)
2755 index (1- (match-end 0)))
2756 (if (match-beginning 3)
2757 (setq string (replace-match (string (string-to-number
2758 (match-string 0 string) 16))
2759 t t string)
2760 index (- (match-end 0) 2)))))
2761 string))
2763 (defun epg-dn-from-string (string)
2764 "Parse STRING as LADPv3 Distinguished Names (RFC2253).
2765 The return value is an alist mapping from types to values."
2766 (let ((index 0)
2767 (length (length string))
2768 alist type value group)
2769 (while (< index length)
2770 (if (eq index (string-match "[ \t\n\r]*" string index))
2771 (setq index (match-end 0)))
2772 (if (eq index (string-match
2773 "\\([0-9]+\\(\\.[0-9]+\\)*\\)\[ \t\n\r]*=[ \t\n\r]*"
2774 string index))
2775 (setq type (match-string 1 string)
2776 index (match-end 0))
2777 (if (eq index (string-match "\\([0-9A-Za-z]+\\)[ \t\n\r]*=[ \t\n\r]*"
2778 string index))
2779 (setq type (match-string 1 string)
2780 index (match-end 0))))
2781 (unless type
2782 (error "Invalid type"))
2783 (if (eq index (string-match
2784 "\\([^,=+<>#;\\\"]\\|\\\\.\\)+"
2785 string index))
2786 (setq index (match-end 0)
2787 value (epg--decode-quotedstring (match-string 0 string)))
2788 (if (eq index (string-match "#\\([0-9A-Fa-f]+\\)" string index))
2789 (setq index (match-end 0)
2790 value (epg--decode-hexstring (match-string 1 string)))
2791 (if (eq index (string-match "\"\\([^\\\"]\\|\\\\.\\)*\""
2792 string index))
2793 (setq index (match-end 0)
2794 value (epg--decode-quotedstring
2795 (match-string 0 string))))))
2796 (if group
2797 (if (stringp (car (car alist)))
2798 (setcar alist (list (cons type value) (car alist)))
2799 (setcar alist (cons (cons type value) (car alist))))
2800 (if (consp (car (car alist)))
2801 (setcar alist (nreverse (car alist))))
2802 (setq alist (cons (cons type value) alist)
2803 type nil
2804 value nil))
2805 (if (eq index (string-match "[ \t\n\r]*\\([,;+]\\)" string index))
2806 (setq index (match-end 0)
2807 group (eq (aref string (match-beginning 1)) ?+))))
2808 (nreverse alist)))
2810 (defun epg-decode-dn (alist)
2811 "Convert ALIST returned by `epg-dn-from-string' to a human readable form.
2812 Type names are resolved using `epg-dn-type-alist'."
2813 (mapconcat
2814 (lambda (rdn)
2815 (if (stringp (car rdn))
2816 (let ((entry (assoc (car rdn) epg-dn-type-alist)))
2817 (if entry
2818 (format "%s=%s" (cdr entry) (cdr rdn))
2819 (format "%s=%s" (car rdn) (cdr rdn))))
2820 (concat "(" (epg-decode-dn rdn) ")")))
2821 alist
2822 ", "))
2824 (provide 'epg)
2826 ;;; epg.el ends here