2 "EasyPG, yet another GnuPG interface.")
4 (defcustom epg-gpg-program "gpg"
5 "The `gpg' executable."
9 (defvar epg-user-id nil
10 "GnuPG ID of your default identity.")
12 (defvar epg-user-id-alist nil
13 "An alist mapping from key ID to user ID.")
15 (defvar epg-read-point nil)
16 (defvar epg-pending-status-list nil)
17 (defvar epg-key-id nil)
18 (defvar epg-context nil)
19 (defvar epg-debug nil)
21 (defvar epg-colons-pub-spec
23 (length "[0-9]+" 0 string-to-number)
24 (algorithm "[0-9]+" 0 string-to-number)
26 (creation-date "[0-9]+")
27 (expiration-date "[0-9]+")
32 (capability "[escaESCA]*"))
33 "The schema of keylisting output whose type is \"pub\".
34 This is used by `epg-list-keys'.")
36 (defvar epg-colons-sec-spec
38 (length "[0-9]+" 0 string-to-number)
39 (algorithm "[0-9]+" 0 string-to-number)
41 (creation-date "[0-9]+")
42 (expiration-date "[0-9]+")
45 "The schema of keylisting output whose type is \"sec\".
46 This is used by `epg-list-keys'.")
48 (defvar epg-colons-uid-spec
53 (creation-date "[0-9]+")
54 (expiration-date "[0-9]+")
58 "The schema of keylisting output whose type is \"uid\".
59 This is used by `epg-list-keys'.")
61 (defun epg-make-context (&optional protocol armor textmode include-certs)
62 "Return a context object."
63 (vector protocol armor textmode include-certs
64 (cons #'epg-passphrase-callback-function nil)
65 (cons #'epg-progress-callback-function nil)
68 (defun epg-context-protocol (context)
69 "Return the protocol used within the context."
72 (defun epg-context-armor (context)
73 "Return t if the output shouled be ASCII armored in the CONTEXT context."
76 (defun epg-context-textmode (context)
77 "Return t if canonical text mode should be used in the CONTEXT context."
80 (defun epg-context-include-certs (context)
81 "Return how many certificates should be included in an S/MIME signed
85 (defun epg-context-passphrase-callback-info (context)
86 "Return the function used to query passphrase."
89 (defun epg-context-progress-callback-info (context)
90 "Return the function which handles progress update."
93 (defun epg-context-signers (context)
94 "Return the list of key-id for singning."
97 (defun epg-context-process (context)
98 "Return the process object of `epg-gpg-program'.
99 This function is for internal use only."
102 (defun epg-context-output-file (context)
103 "Return the output file of `epg-gpg-program'.
104 This function is for internal use only."
107 (defun epg-context-result (context)
108 "Return the result of the previous cryptographic operation."
111 (defun epg-context-set-protocol (context protocol)
112 "Set the protocol used within the context."
113 (aset context 0 protocol))
115 (defun epg-context-set-armor (context armor)
116 "Specify if the output shouled be ASCII armored in the CONTEXT context."
117 (aset context 1 armor))
119 (defun epg-context-set-textmode (context textmode)
120 "Specify if canonical text mode should be used in the CONTEXT context."
121 (aset context 2 textmode))
123 (defun epg-context-set-include-certs (context include-certs)
124 "Set how many certificates should be included in an S/MIME signed message."
125 (aset context 3 include-certs))
127 (defun epg-context-set-passphrase-callback-info (context
128 passphrase-callback-info)
129 "Set the function used to query passphrase."
130 (aset context 4 passphrase-callback-info))
132 (defun epg-context-set-progress-callback-info (context progress-callback-info)
133 "Set the function which handles progress update."
134 (aset context 5 progress-callback-info))
136 (defun epg-context-set-signers (context signers)
137 "Set the list of key-id for singning."
138 (aset context 6 signers))
140 (defun epg-context-set-process (context process)
141 "Set the process object of `epg-gpg-program'.
142 This function is for internal use only."
143 (aset context 7 process))
145 (defun epg-context-set-output-file (context output-file)
146 "Set the output file of `epg-gpg-program'.
147 This function is for internal use only."
148 (aset context 8 output-file))
150 (defun epg-context-set-result (context result)
151 "Set the result of the previous cryptographic operation."
152 (aset context 9 result))
154 (defun epg-make-signature (status key-id user-id)
155 "Return a signature object."
156 (vector status key-id user-id nil))
158 (defun epg-signature-status (signature)
159 "Return the status code of SIGNATURE."
162 (defun epg-signature-key-id (signature)
163 "Return the key-id of SIGNATURE."
166 (defun epg-signature-user-id (signature)
167 "Return the user-id of SIGNATURE."
170 (defun epg-signature-validity (signature)
171 "Return the validity of SIGNATURE."
174 (defun epg-signature-set-status (signature status)
175 "Set the status code of SIGNATURE."
176 (aset signature 0 status))
178 (defun epg-signature-set-key-id (signature key-id)
179 "Set the key-id of SIGNATURE."
180 (aset signature 1 key-id))
182 (defun epg-signature-set-user-id (signature user-id)
183 "Set the user-id of SIGNATURE."
184 (aset signature 2 user-id))
186 (defun epg-signature-set-validity (signature validity)
187 "Set the validity of SIGNATURE."
188 (aset signature 3 validity))
190 (defun epg-context-result-for (context name)
191 (cdr (assq name (epg-context-result context))))
193 (defun epg-context-set-result-for (context name value)
194 (let* ((result (epg-context-result context))
195 (entry (assq name result)))
198 (epg-context-set-result context (cons (cons name value) result)))))
200 (defun epg-start (context args)
201 "Start `epg-gpg-program' in a subprocess with given ARGS."
202 (let* ((args (append (list "--no-tty"
206 (if (epg-context-armor context) '("--armor"))
207 (if (epg-context-textmode context) '("--textmode"))
208 (if (epg-context-output-file context)
209 (list "--output" (epg-context-output-file context)))
211 (coding-system-for-write 'binary)
212 process-connection-type
213 (orig-mode (default-file-modes))
214 (buffer (generate-new-buffer " *epg*"))
216 (with-current-buffer buffer
217 (make-local-variable 'epg-read-point)
218 (setq epg-read-point (point-min))
219 (make-local-variable 'epg-pending-status-list)
220 (setq epg-pending-status-list nil)
221 (make-local-variable 'epg-key-id)
222 (setq epg-key-id nil)
223 (make-local-variable 'epg-context)
224 (setq epg-context context))
227 (set-default-file-modes 448)
229 (apply #'start-process "epg" buffer epg-gpg-program args)))
230 (set-default-file-modes orig-mode))
231 (set-process-filter process #'epg-process-filter)
232 (epg-context-set-process context process)))
234 (defun epg-process-filter (process input)
237 (set-buffer (get-buffer-create " *epg-debug*"))
238 (goto-char (point-max))
240 (if (buffer-live-p (process-buffer process))
242 (set-buffer (process-buffer process))
243 (goto-char (point-max))
245 (goto-char epg-read-point)
247 (while (looking-at ".*\n") ;the input line is finished
249 (if (looking-at "\\[GNUPG:] \\([A-Z_]+\\) ?\\(.*\\)")
250 (let* ((status (match-string 1))
251 (string (match-string 2))
252 (symbol (intern-soft (concat "epg-status-" status))))
253 (if (member status epg-pending-status-list)
254 (setq epg-pending-status-list nil))
257 (funcall symbol process string)))))
259 (setq epg-read-point (point)))))
261 (defun epg-read-output (context)
263 (set-buffer-multibyte nil)
264 (if (file-exists-p (epg-context-output-file context))
265 (let ((coding-system-for-read (if (epg-context-textmode context)
268 (insert-file-contents (epg-context-output-file context))
271 (defun epg-wait-for-status (context status-list)
272 (with-current-buffer (process-buffer (epg-context-process context))
273 (setq epg-pending-status-list status-list)
274 (while (and (eq (process-status (epg-context-process context)) 'run)
275 epg-pending-status-list)
276 (accept-process-output (epg-context-process context) 1))))
278 (defun epg-wait-for-completion (context)
279 (if (eq (process-status (epg-context-process context)) 'run)
280 (process-send-eof (epg-context-process context)))
281 (while (eq (process-status (epg-context-process context)) 'run)
282 ;; We can't use accept-process-output instead of sit-for here
283 ;; because it may cause an interrupt during the sentinel execution.
286 (defun epg-reset (context)
287 (if (and (epg-context-process context)
288 (buffer-live-p (process-buffer (epg-context-process context))))
289 (kill-buffer (process-buffer (epg-context-process context))))
290 (epg-context-set-process context nil)
291 (if (file-exists-p (epg-context-output-file context))
292 (delete-file (epg-context-output-file context)))
293 (aset context 9 nil))
295 (defun epg-status-USERID_HINT (process string)
296 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
297 (let* ((key-id (match-string 1 string))
298 (user-id (match-string 2 string))
299 (entry (assoc key-id epg-user-id-alist)))
301 (setcdr entry user-id)
302 (setq epg-user-id-alist (cons (cons key-id user-id)
303 epg-user-id-alist))))))
305 (defun epg-status-NEED_PASSPHRASE (process string)
306 (if (string-match "\\`\\([^ ]+\\)" string)
307 (setq epg-key-id (match-string 1 string))))
309 (defun epg-status-NEED_PASSPHRASE_SYM (process string)
310 (setq epg-key-id 'SYM))
312 (defun epg-status-NEED_PASSPHRASE_PIN (process string)
313 (setq epg-key-id 'PIN))
315 (defun epg-status-GET_HIDDEN (process string)
317 (funcall (car (epg-context-passphrase-callback-info epg-context))
319 (cdr (epg-context-passphrase-callback-info epg-context))))
324 (setq string (concat passphrase "\n"))
325 (fillarray passphrase 0)
326 (setq passphrase nil)
327 (process-send-string process string))
329 (fillarray string 0))))))
331 (defun epg-status-GOODSIG (process string)
332 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
333 (epg-context-set-result-for
336 (cons (epg-make-signature 'good
337 (match-string 1 string)
338 (match-string 2 string))
339 (epg-context-result-for epg-context 'verify)))))
341 (defun epg-status-EXPSIG (process string)
342 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
343 (epg-context-set-result-for
346 (cons (epg-make-signature 'expired
347 (match-string 1 string)
348 (match-string 2 string))
349 (epg-context-result-for epg-context 'verify)))))
351 (defun epg-status-EXPKEYSIG (process string)
352 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
353 (epg-context-set-result-for
356 (cons (epg-make-signature 'expired-key
357 (match-string 1 string)
358 (match-string 2 string))
359 (epg-context-result-for epg-context 'verify)))))
361 (defun epg-status-REVKEYSIG (process string)
362 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
363 (epg-context-set-result-for
366 (cons (epg-make-signature 'revoked-key
367 (match-string 1 string)
368 (match-string 2 string))
369 (epg-context-result-for epg-context 'verify)))))
371 (defun epg-status-BADSIG (process string)
372 (if (string-match "\\`\\([^ ]+\\) \\(.*\\)" string)
373 (epg-context-set-result-for
376 (cons (epg-make-signature 'bad
377 (match-string 1 string)
378 (match-string 2 string))
379 (epg-context-result-for epg-context 'verify)))))
381 (defun epg-status-TRUST_UNDEFINED (process string)
382 (let ((signature (car (epg-context-result-for epg-context 'verify))))
384 (eq (epg-signature-status signature) 'good))
385 (epg-signature-set-validity signature 'unknown))))
387 (defun epg-status-TRUST_NEVER (process string)
388 (let ((signature (car (epg-context-result-for epg-context 'verify))))
390 (eq (epg-signature-status signature) 'good))
391 (epg-signature-set-validity signature 'never))))
393 (defun epg-status-TRUST_MARGINAL (process string)
394 (let ((signature (car (epg-context-result-for epg-context 'verify))))
396 (eq (epg-signature-status signature) 'marginal))
397 (epg-signature-set-validity signature 'marginal))))
399 (defun epg-status-TRUST_FULLY (process string)
400 (let ((signature (car (epg-context-result-for epg-context 'verify))))
402 (eq (epg-signature-status signature) 'good))
403 (epg-signature-set-validity signature 'full))))
405 (defun epg-status-TRUST_ULTIMATE (process string)
406 (let ((signature (car (epg-context-result-for epg-context 'verify))))
408 (eq (epg-signature-status signature) 'good))
409 (epg-signature-set-validity signature 'full))))
411 (defun epg-status-PROGRESS (process string)
412 (if (string-match "\\`\\([^ ]+\\) \\([^ ]\\) \\([0-9]+\\) \\([0-9]+\\)"
414 (funcall (car (epg-context-progress-callback-info epg-context))
415 (match-string 1 string)
416 (match-string 2 string)
417 (string-to-number (match-string 3 string))
418 (string-to-number (match-string 4 string))
419 (cdr (epg-context-progress-callback-info epg-context)))))
421 (defun epg-status-DECRYPTION_FAILED (process string)
422 (epg-context-set-result-for
424 (cons 'decryption-failed
425 (epg-context-result-for epg-context 'error))))
427 (defun epg-status-NODATA (process string)
428 (epg-context-set-result-for
430 (cons (cons 'no-data (string-to-number string))
431 (epg-context-result-for epg-context 'error))))
433 (defun epg-status-UNEXPECTED (process string)
434 (epg-context-set-result-for
436 (cons (cons 'unexpected (string-to-number string))
437 (epg-context-result-for epg-context 'error))))
439 (defun epg-status-KEYEXPIRED (process string)
440 (epg-context-set-result-for
442 (cons (cons 'key-expired string)
443 (epg-context-result-for epg-context 'error))))
445 (defun epg-status-KEYREVOKED (process string)
446 (epg-context-set-result-for
449 (epg-context-result-for epg-context 'error))))
451 (defun epg-status-BADARMOR (process string)
452 (epg-context-set-result-for
455 (epg-context-result-for epg-context 'error))))
457 (defun epg-passphrase-callback-function (key-id handback)
460 "Passphrase for symmetric encryption: "
462 "Passphrase for PIN: "
463 (format "Passphrase for %s: "
464 (let ((entry (assoc key-id epg-user-id-alist)))
469 (defun epg-progress-callback-function (what char current total handback)
470 (message "%s: %d%%/%d%%" what current total))
472 (defun epg-list-keys (name &optional secret)
473 "List keys associated with STRING."
474 (let ((args (list "--with-colons" "--no-greeting" "--batch"
476 (if secret "--list-secret-keys" "--list-keys")
478 keys type symbol pointer)
480 (apply #'call-process epg-gpg-program nil (list t nil) nil args)
481 (goto-char (point-min))
482 (while (looking-at "\\([a-z][a-z][a-z]\\):\\(.*\\)")
483 (setq type (match-string 1)
484 symbol (intern-soft (format "epg-colons-%s-spec" type)))
485 (if (member type '("pub" "sec"))
486 (setq keys (cons nil keys)))
489 (setcar keys (cons (cons (intern type)
491 (symbol-value symbol)
497 (setcar pointer (nreverse (car pointer)))
498 (setq pointer (cdr pointer)))
501 (defun epg-parse-colons (alist string)
505 (or (null (car alist))
508 (concat "\\(" (nth 1 (car alist)) "\\)?:")
512 (setq index (match-end 0))
513 (if (match-beginning 1)
515 (cons (cons (car (car alist))
516 (funcall (or (nth 3 (car alist)) #'identity)
518 (1+ (or (nth 2 (car alist)) 0))
521 (setq index (1+ index)))
522 (setq alist (cdr alist)))
525 (defalias 'epg-make-temp-file 'make-temp-file)
528 (defun epg-decrypt-start (context input-file)
529 "Initiate a decrypt operation on INPUT-FILE.
531 If you use this function, you will need to wait for the completion of
532 `epg-gpg-program' by using `epg-wait-for-completion' and call
533 `epg-reset' to clear a temporaly output file.
534 If you are unsure, use synchronous version of this function
535 `epg-decrypt-string' instead."
536 (epg-context-set-output-file context (epg-make-temp-file "epg-output"))
538 (list "--decrypt" input-file))
539 (epg-wait-for-status context '("BEGIN_DECRYPTION")))
542 (defun epg-decrypt-file (context input-file)
543 "Decrypt INPUT-FILE and return the plain text."
546 (epg-decrypt-start context input-file)
547 (epg-wait-for-completion context)
548 (if (epg-context-result-for context 'error)
549 (error "Decryption failed"))
550 (epg-read-output context))
552 (if (file-exists-p input-file)
553 (delete-file input-file))))
556 (defun epg-decrypt-string (context string)
557 "Decrypt STRING and return the plain text."
558 (let ((input-file (epg-make-temp-file "epg-input"))
559 (coding-system-for-write 'binary))
562 (write-region string nil input-file)
563 (epg-decrypt-file context input-file))
564 (if (file-exists-p input-file)
565 (delete-file input-file)))))
568 (defun epg-verify-start (context signature &optional string)
569 "Initiate a verify operation on SIGNATURE.
571 For a detached signature, both SIGNATURE and STRING should be string.
572 For a normal or a clear text signature, STRING should be nil.
574 If you use this function, you will need to wait for the completion of
575 `epg-gpg-program' by using `epg-wait-for-completion' and call
576 `epg-reset' to clear a temporaly output file.
577 If you are unsure, use synchronous version of this function
578 `epg-verify-string' instead."
579 (epg-context-set-output-file context (epg-make-temp-file "epg-output"))
581 ;; Detached signature.
584 (append (list "--verify")
585 (list signature "-")))
586 (if (eq (process-status (epg-context-process context)) 'run)
587 (process-send-string (epg-context-process context) string)))
588 ;; Normal (or cleartext) signature.
589 (epg-start context (list "--verify"))
590 (if (eq (process-status (epg-context-process context)) 'run)
591 (process-send-string (epg-context-process context) signature))))
594 (defun epg-verify-string (context signature &optional string)
597 For a detached signature, both SIGNATURE and STRING should be string.
598 For a normal or a clear text signature, STRING should be nil."
599 (let ((input-file (epg-make-temp-file "epg-input"))
600 (coding-system-for-write 'binary))
604 (write-region signature nil input-file))
605 (epg-verify-start context input-file string)
606 (epg-wait-for-completion context)
607 (epg-context-result-for context 'verify))
609 (if (file-exists-p input-file)
610 (delete-file input-file)))))
613 (defun epg-sign-start (context string &optional mode)
614 "Initiate a sign operation on STRING.
616 If optional 3rd argument MODE is 'clearsign, it makes a clear text signature.
617 If MODE is t or 'detached, it makes a detached signature.
618 Otherwise, it makes a normal signature.
620 If you use this function, you will need to wait for the completion of
621 `epg-gpg-program' by using `epg-wait-for-completion' and call
622 `epg-reset' to clear a temporaly output file.
623 If you are unsure, use synchronous version of this function
624 `epg-sign-string' instead."
625 (epg-context-set-output-file context (epg-make-temp-file "epg-output"))
627 (append (list (if (eq mode 'clearsign)
629 (if (or (eq mode t) (eq mode 'detached))
633 (mapcar (lambda (signer)
635 (epg-context-signers context)))))
636 (epg-wait-for-status context '("BEGIN_SIGNING"))
637 (if (eq (process-status (epg-context-process context)) 'run)
638 (process-send-string (epg-context-process context) string)))
641 (defun epg-sign-string (context string &optional mode)
642 "Sign STRING and return the output as string.
643 If optional 3rd argument MODE is 'clearsign, it makes a clear text signature.
644 If MODE is t or 'detached, it makes a detached signature.
645 Otherwise, it makes a normal signature."
648 (epg-sign-start context string mode)
649 (epg-wait-for-completion context)
650 (if (epg-context-result-for context 'error)
651 (error "Sign failed"))
652 (epg-read-output context))
653 (epg-reset context)))
656 (defun epg-encrypt-start (context string recipients
657 &optional sign always-trust)
658 "Initiate a encrypt operation on STRING.
659 If RECIPIENTS is nil, it performs symmetric encryption.
661 If you use this function, you will need to wait for the completion of
662 `epg-gpg-program' by using `epg-wait-for-completion' and call
663 `epg-reset' to clear a temporaly output file.
664 If you are unsure, use synchronous version of this function
665 `epg-encrypt-string' instead."
666 (epg-context-set-output-file context (epg-make-temp-file "epg-output"))
668 (append (if always-trust '("--always-trust"))
669 (if recipients '("--encrypt") '("--symmetric"))
673 (mapcar (lambda (signer)
675 (epg-context-signers context)))))
677 (mapcar (lambda (recipient)
678 (list "-r" recipient))
681 (epg-wait-for-status context '("BEGIN_SIGNING"))
682 (if (null recipients)
683 (epg-wait-for-status context '("BEGIN_ENCRYPTION"))))
684 (if (eq (process-status (epg-context-process context)) 'run)
685 (process-send-string (epg-context-process context) string)))
688 (defun epg-encrypt-string (context string recipients
689 &optional sign always-trust)
691 If RECIPIENTS is nil, it performs symmetric encryption."
694 (epg-encrypt-start context string recipients sign always-trust)
695 (epg-wait-for-completion context)
696 (if (epg-context-result-for context 'error)
697 (error "Encrypt failed"))
698 (epg-read-output context))
699 (epg-reset context)))