X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=epg.el;h=f4c2f8395203e446f643c03f704c56b5019d41a4;hb=f0cf0f951e5534b14c3a798424ff6fdc40ad39a8;hp=6356fae90ef7ba09fcb2b3e2b4391067df8dd04f;hpb=7f1f6fca222a32fc153ffddfc180d3d0855c2650;p=elisp%2Fepg.git diff --git a/epg.el b/epg.el index 6356fae..f4c2f83 100644 --- a/epg.el +++ b/epg.el @@ -1,4 +1,4 @@ -;;; epg.el --- EasyPG, yet another GnuPG interface. +;;; epg.el --- the EasyPG Library ;; Copyright (C) 1999, 2000, 2002, 2003, 2004, ;; 2005, 2006 Free Software Foundation, Inc. ;; Copyright (C) 2006 Daiki Ueno @@ -26,13 +26,15 @@ ;;; Code: (defgroup epg () - "EasyPG, yet another GnuPG interface.") + "The EasyPG Library") (defcustom epg-gpg-program "gpg" "The `gpg' executable." :group 'epg :type 'string) +(defconst epg-version-number "0.0.0") + (defvar epg-user-id nil "GnuPG ID of your default identity.") @@ -83,6 +85,24 @@ (2 . "ZLIB") (3 . "BZIP2"))) +(defconst epg-invalid-recipients-alist + '((0 . "No specific reason given") + (1 . "Not Found") + (2 . "Ambigious specification") + (3 . "Wrong key usage") + (4 . "Key revoked") + (5 . "Key expired") + (6 . "No CRL known") + (7 . "CRL too old") + (8 . "Policy mismatch") + (9 . "Not a secret key") + (10 . "Key not trusted"))) + +(defconst epg-delete-problem-alist + '((1 . "No such key") + (2 . "Must delete secret key first") + (3 . "Ambigious specification"))) + (defvar epg-key-validity-alist '((?o . unknown) (?i . invalid) @@ -120,23 +140,26 @@ "Return the string of DATA." (aref data 1)) -(defun epg-make-context (&optional protocol armor textmode include-certs) +(defun epg-make-context (&optional protocol armor textmode include-certs + cipher-algorithm digest-algorithm + compress-algorithm) "Return a context object." (vector protocol armor textmode include-certs + cipher-algorithm digest-algorithm compress-algorithm #'epg-passphrase-callback-function #'epg-progress-callback-function nil nil nil nil)) (defun epg-context-protocol (context) - "Return the protocol used within the context." + "Return the protocol used within CONTEXT." (aref context 0)) (defun epg-context-armor (context) - "Return t if the output shouled be ASCII armored in the CONTEXT context." + "Return t if the output shouled be ASCII armored in CONTEXT." (aref context 1)) (defun epg-context-textmode (context) - "Return t if canonical text mode should be used in the CONTEXT context." + "Return t if canonical text mode should be used in CONTEXT." (aref context 2)) (defun epg-context-include-certs (context) @@ -144,74 +167,98 @@ message." (aref context 3)) +(defun epg-context-cipher-algorithm (context) + "Return the cipher algorithm in CONTEXT." + (aref context 4)) + +(defun epg-context-digest-algorithm (context) + "Return the digest algorithm in CONTEXT." + (aref context 5)) + +(defun epg-context-compress-algorithm (context) + "Return the compress algorithm in CONTEXT." + (aref context 6)) + (defun epg-context-passphrase-callback (context) "Return the function used to query passphrase." - (aref context 4)) + (aref context 7)) (defun epg-context-progress-callback (context) "Return the function which handles progress update." - (aref context 5)) + (aref context 8)) (defun epg-context-signers (context) "Return the list of key-id for singning." - (aref context 6)) + (aref context 9)) (defun epg-context-process (context) "Return the process object of `epg-gpg-program'. This function is for internal use only." - (aref context 7)) + (aref context 10)) (defun epg-context-output-file (context) "Return the output file of `epg-gpg-program'. This function is for internal use only." - (aref context 8)) + (aref context 11)) (defun epg-context-result (context) "Return the result of the previous cryptographic operation." - (aref context 9)) + (aref context 12)) (defun epg-context-set-protocol (context protocol) - "Set the protocol used within the context." + "Set the protocol used within CONTEXT." (aset context 0 protocol)) (defun epg-context-set-armor (context armor) - "Specify if the output shouled be ASCII armored in the CONTEXT context." + "Specify if the output shouled be ASCII armored in CONTEXT." (aset context 1 armor)) (defun epg-context-set-textmode (context textmode) - "Specify if canonical text mode should be used in the CONTEXT context." + "Specify if canonical text mode should be used in CONTEXT." (aset context 2 textmode)) (defun epg-context-set-include-certs (context include-certs) "Set how many certificates should be included in an S/MIME signed message." (aset context 3 include-certs)) +(defun epg-context-set-cipher-algorithm (context cipher-algorithm) + "Set the cipher algorithm in CONTEXT." + (aset context 4 cipher-algorithm)) + +(defun epg-context-set-digest-algorithm (context digest-algorithm) + "Set the digest algorithm in CONTEXT." + (aset context 5 digest-algorithm)) + +(defun epg-context-set-compress-algorithm (context compress-algorithm) + "Set the compress algorithm in CONTEXT." + (aset context 6 compress-algorithm)) + (defun epg-context-set-passphrase-callback (context passphrase-callback) "Set the function used to query passphrase." - (aset context 4 passphrase-callback)) + (aset context 7 passphrase-callback)) (defun epg-context-set-progress-callback (context progress-callback) "Set the function which handles progress update." - (aset context 5 progress-callback)) + (aset context 8 progress-callback)) (defun epg-context-set-signers (context signers) "Set the list of key-id for singning." - (aset context 6 signers)) + (aset context 9 signers)) (defun epg-context-set-process (context process) "Set the process object of `epg-gpg-program'. This function is for internal use only." - (aset context 7 process)) + (aset context 10 process)) (defun epg-context-set-output-file (context output-file) "Set the output file of `epg-gpg-program'. This function is for internal use only." - (aset context 8 output-file)) + (aset context 11 output-file)) (defun epg-context-set-result (context result) "Set the result of the previous cryptographic operation." - (aset context 9 result)) + (aset context 12 result)) (defun epg-make-signature (status key-id user-id) "Return a signature object." @@ -373,6 +420,12 @@ This function is for internal use only." (orig-mode (default-file-modes)) (buffer (generate-new-buffer " *epg*")) process) + (if epg-debug + (save-excursion + (set-buffer (get-buffer-create " *epg-debug*")) + (goto-char (point-max)) + (insert (format "%s %s\n" epg-gpg-program + (mapconcat #'identity args " "))))) (with-current-buffer buffer (make-local-variable 'epg-read-point) (setq epg-read-point (point-min)) @@ -436,8 +489,9 @@ This function is for internal use only." epg-pending-status-list) (accept-process-output (epg-context-process context) 1)))) -(defun epg-wait-for-completion (context) - (if (eq (process-status (epg-context-process context)) 'run) +(defun epg-wait-for-completion (context &optional no-eof) + (if (and (not no-eof) + (eq (process-status (epg-context-process context)) 'run)) (process-send-eof (epg-context-process context))) (while (eq (process-status (epg-context-process context)) 'run) ;; We can't use accept-process-output instead of sit-for here @@ -480,7 +534,6 @@ This function is for internal use only." (funcall (if (consp (epg-context-passphrase-callback epg-context)) (car (epg-context-passphrase-callback epg-context)) (epg-context-passphrase-callback epg-context)) - epg-key-id (if (consp (epg-context-passphrase-callback epg-context)) (cdr (epg-context-passphrase-callback epg-context))))) string) @@ -641,16 +694,38 @@ This function is for internal use only." (cons 'bad-armor (epg-context-result-for epg-context 'error)))) -(defun epg-passphrase-callback-function (key-id handback) +(defun epg-status-INV_RECP (process string) + (if (string-match "\\`\\([0-9]+\\) \\(.*\\)" string) + (epg-context-set-result-for + epg-context 'error + (cons (list 'invalid-recipient + (string-to-number (match-string 1 string)) + (match-string 2 string)) + (epg-context-result-for epg-context 'error))))) + +(defun epg-status-NO_RECP (process string) + (epg-context-set-result-for + epg-context 'error + (cons 'no-recipients + (epg-context-result-for epg-context 'error)))) + +(defun epg-status-DELETE_PROBLEM (process string) + (if (string-match "\\`\\([0-9]+\\)" string) + (epg-context-set-result-for + epg-context 'error + (cons (cons 'delete-problem (string-to-number (match-string 1 string))) + (epg-context-result-for epg-context 'error))))) + +(defun epg-passphrase-callback-function (handback) (read-passwd - (if (eq key-id 'SYM) + (if (eq epg-key-id 'SYM) "Passphrase for symmetric encryption: " - (if (eq key-id 'PIN) + (if (eq epg-key-id 'PIN) "Passphrase for PIN: " - (let ((entry (assoc key-id epg-user-id-alist))) + (let ((entry (assoc epg-key-id epg-user-id-alist))) (if entry - (format "Passphrase for %s %s: " key-id (cdr entry)) - (format "Passphrase for %s: " key-id))))))) + (format "Passphrase for %s %s: " epg-key-id (cdr entry)) + (format "Passphrase for %s: " epg-key-id))))))) (defun epg-progress-callback-function (what char current total handback) (message "%s: %d%%/%d%%" what current total)) @@ -699,7 +774,8 @@ This function is for internal use only." (defun epg-make-sub-key-1 (line) (epg-make-sub-key - (cdr (assq (string-to-char (aref line 1)) epg-key-validity-alist)) + (if (aref line 1) + (cdr (assq (string-to-char (aref line 1)) epg-key-validity-alist))) (delq nil (mapcar (lambda (char) (cdr (assq char epg-key-capablity-alist))) (aref line 11))) @@ -724,8 +800,9 @@ This function is for internal use only." (car keys) (nreverse (epg-key-user-id-list (car keys))))) (setq keys (cons (epg-make-key - (cdr (assq (string-to-char (aref (car lines) 8)) - epg-key-validity-alist))) + (if (aref (car lines) 8) + (cdr (assq (string-to-char (aref (car lines) 8)) + epg-key-validity-alist)))) keys)) (epg-key-set-sub-key-list (car keys) @@ -740,8 +817,9 @@ This function is for internal use only." (epg-key-set-user-id-list (car keys) (cons (epg-make-user-id - (cdr (assq (string-to-char (aref (car lines) 1)) - epg-key-validity-alist)) + (if (aref (car lines) 1) + (cdr (assq (string-to-char (aref (car lines) 1)) + epg-key-validity-alist))) (aref (car lines) 9)) (epg-key-user-id-list (car keys))))) ((equal (aref (car lines) 0) "fpr") @@ -826,9 +904,10 @@ If PLAIN is nil, it returns the result as a string." (epg-context-set-output-file context (epg-make-temp-file "epg-output"))) (epg-start-decrypt context (epg-make-data-from-file cipher)) - (epg-wait-for-completion context) + (epg-wait-for-completion context t) (if (epg-context-result-for context 'error) - (error "Decryption failed")) + (error "Decrypt failed: %S" + (epg-context-result-for context 'error))) (unless plain (epg-read-output context))) (unless plain @@ -848,7 +927,8 @@ If PLAIN is nil, it returns the result as a string." (epg-start-decrypt context (epg-make-data-from-file input-file)) (epg-wait-for-completion context) (if (epg-context-result-for context 'error) - (error "Decryption failed")) + (error "Decrypt failed: %S" + (epg-context-result-for context 'error))) (epg-read-output context)) (epg-delete-output-file context) (if (file-exists-p input-file) @@ -905,7 +985,7 @@ For a normal or a clear text signature, SIGNED-TEXT should be nil." (epg-make-data-from-file signed-text)) (epg-start-verify context (epg-make-data-from-file signature))) - (epg-wait-for-completion context) + (epg-wait-for-completion context t) (unless plain (epg-read-output context))) (unless plain @@ -988,9 +1068,10 @@ Otherwise, it makes a normal signature." (epg-context-set-output-file context (epg-make-temp-file "epg-output"))) (epg-start-sign context (epg-make-data-from-file plain) mode) - (epg-wait-for-completion context) + (epg-wait-for-completion context t) (if (epg-context-result-for context 'error) - (error "Sign failed")) + (error "Sign failed: %S" + (epg-context-result-for context 'error))) (unless signature (epg-read-output context))) (unless signature @@ -1010,7 +1091,8 @@ Otherwise, it makes a normal signature." (epg-start-sign context (epg-make-data-from-string plain) mode) (epg-wait-for-completion context) (if (epg-context-result-for context 'error) - (error "Sign failed")) + (error "Sign failed: %S" + (epg-context-result-for context 'error))) (epg-read-output context)) (epg-delete-output-file context) (epg-reset context))) @@ -1044,9 +1126,8 @@ If you are unsure, use synchronous version of this function (if (epg-data-file plain) (list (epg-data-file plain))))) (if sign - (epg-wait-for-status context '("BEGIN_SIGNING")) - (if (null recipients) - (epg-wait-for-status context '("BEGIN_ENCRYPTION")))) + (epg-wait-for-status context '("BEGIN_SIGNING"))) + (epg-wait-for-status context '("BEGIN_ENCRYPTION")) (if (and (epg-data-string plain) (eq (process-status (epg-context-process context)) 'run)) (process-send-string (epg-context-process context) @@ -1066,9 +1147,10 @@ If RECIPIENTS is nil, it performs symmetric encryption." (epg-make-temp-file "epg-output"))) (epg-start-encrypt context (epg-make-data-from-file plain) recipients sign always-trust) - (epg-wait-for-completion context) + (epg-wait-for-completion context t) (if (epg-context-result-for context 'error) - (error "Encrypt failed")) + (error "Encrypt failed: %S" + (epg-context-result-for context 'error))) (unless cipher (epg-read-output context))) (unless cipher @@ -1088,37 +1170,54 @@ If RECIPIENTS is nil, it performs symmetric encryption." recipients sign always-trust) (epg-wait-for-completion context) (if (epg-context-result-for context 'error) - (error "Encrypt failed")) + (error "Encrypt failed: %S" + (epg-context-result-for context 'error))) (epg-read-output context)) (epg-delete-output-file context) (epg-reset context))) ;;;###autoload -(defun epg-start-export-keys (context pattern) +(defun epg-start-export-keys (context keys) "Initiate an export keys operation. If you use this function, you will need to wait for the completion of `epg-gpg-program' by using `epg-wait-for-completion' and call `epg-reset' to clear a temporaly output file. If you are unsure, use synchronous version of this function -`epg-export-keys' instead." +`epg-export-keys-to-file' or `epg-export-keys-to-string' instead." (epg-context-set-result context nil) - (epg-context-set-output-file context (epg-make-temp-file "epg-output")) - (epg-start context (list "--export" pattern))) + (epg-start context (cons "--export" + (mapcar + (lambda (key) + (epg-sub-key-id + (car (epg-key-sub-key-list key)))) + keys)))) ;;;###autoload -(defun epg-export-keys (context pattern) - "Extract public keys matched with PATTERN and return them." +(defun epg-export-keys-to-file (context keys file) + "Extract public KEYS." (unwind-protect (progn - (epg-start-export-keys context pattern) + (if keys + (epg-context-set-output-file context file) + (epg-context-set-output-file context + (epg-make-temp-file "epg-output"))) + (epg-start-export-keys context keys) (epg-wait-for-completion context) (if (epg-context-result-for context 'error) (error "Export keys failed")) - (epg-read-output context)) + (unless file + (epg-read-output context))) + (unless file + (epg-delete-output-file context)) (epg-reset context))) ;;;###autoload +(defun epg-export-keys-to-string (context keys) + "Extract public KEYS and return them as a string." + (epg-export-keys-to-file context keys nil)) + +;;;###autoload (defun epg-start-import-keys (context keys) "Initiate an import keys operation. KEYS is a data object. @@ -1130,7 +1229,7 @@ If you are unsure, use synchronous version of this function `epg-import-keys-from-file' or `epg-import-keys-from-string' instead." (epg-context-set-result context nil) (epg-context-set-output-file context (epg-make-temp-file "epg-output")) - (epg-start context (append (list "--import") (epg-data-file keys))) + (epg-start context (list "--import" (epg-data-file keys))) (if (and (epg-data-string keys) (eq (process-status (epg-context-process context)) 'run)) (process-send-string (epg-context-process context) @@ -1140,7 +1239,7 @@ If you are unsure, use synchronous version of this function (unwind-protect (progn (epg-start-import-keys context keys) - (epg-wait-for-completion context) + (epg-wait-for-completion context (epg-data-file keys)) (if (epg-context-result-for context 'error) (error "Import keys failed")) (epg-read-output context)) @@ -1156,6 +1255,36 @@ If you are unsure, use synchronous version of this function "Add keys from a string KEYS." (epg-import-keys-1 context (epg-make-data-from-string keys))) +;;;###autoload +(defun epg-start-delete-keys (context keys &optional allow-secret) + "Initiate an delete keys operation. + +If you use this function, you will need to wait for the completion of +`epg-gpg-program' by using `epg-wait-for-completion' and call +`epg-reset' to clear a temporaly output file. +If you are unsure, use synchronous version of this function +`epg-delete-keys' instead." + (epg-context-set-result context nil) + (epg-start context (cons (if allow-secret + "--delete-secret-key" + "--delete-key") + (mapcar + (lambda (key) + (epg-sub-key-id + (car (epg-key-sub-key-list key)))) + keys)))) + +;;;###autoload +(defun epg-delete-keys (context keys &optional allow-secret) + "Delete KEYS from the key ring." + (unwind-protect + (progn + (epg-start-delete-keys context keys) + (epg-wait-for-completion context t) + (if (epg-context-result-for context 'error) + (error "Delete key failed"))) + (epg-reset context))) + (provide 'epg) ;;; epg.el ends here