1 ;;; smime.el --- S/MIME support library
2 ;; Copyright (c) 2000, 2001 Free Software Foundation, Inc.
4 ;; Author: Simon Josefsson <simon@josefsson.org>
5 ;; Keywords: SMIME X.509 PEM OpenSSL
7 ;; This file is not a part of GNU Emacs, but the same permissions apply.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published
11 ;; by the Free Software Foundation; either version 2, or (at your
12 ;; option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful, but
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 ;; General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; This library perform S/MIME operations from within Emacs.
28 ;; Functions for fetching certificates from public repositories are
29 ;; provided, currently only from DNS. LDAP support (via EUDC) is planned.
31 ;; It uses OpenSSL (tested with version 0.9.5a and 0.9.6) for signing,
32 ;; encryption and decryption.
34 ;; Some general knowledge of S/MIME, X.509, PKCS#12, PEM etc is
35 ;; probably required to use this library in any useful way.
36 ;; Especially, don't expect this library to buy security for you. If
37 ;; you don't understand what you are doing, you're as likely to lose
38 ;; security than gain any by using this library.
40 ;; This library is not intended to provide a "raw" API for S/MIME,
41 ;; PKCSx or similar, it's intended to perform common operations
42 ;; done on messages encoded in these formats. The terminology chosen
45 ;;; Quick introduction:
47 ;; Get your S/MIME certificate from VeriSign or someplace. I used
48 ;; Netscape to generate the key and certificate request and stuff, and
49 ;; Netscape can export the key into PKCS#12 format.
51 ;; Enter OpenSSL. To be able to use this library, it need to have the
52 ;; SMIME key readable in PEM format. OpenSSL is used to convert the
55 ;; $ openssl pkcs12 -in mykey.p12 -clcerts -nodes > mykey.pem
58 ;; Now, use M-x customize-variable smime-keys and add mykey.pem as
61 ;; Now you should be able to sign messages! Create a buffer and write
62 ;; something and run M-x smime-sign-buffer RET RET and you should see
63 ;; your message MIME armoured and a signature. Encryption, M-x
64 ;; smime-encrypt-buffer, should also work.
66 ;; To be able to verify messages you need to build up trust with
67 ;; someone. Perhaps you trust the CA that issued your certificate, at
68 ;; least I did, so I export it's certificates from my PKCS#12
71 ;; $ openssl pkcs12 -in mykey.p12 -cacerts -nodes > cacert.pem
74 ;; Now, use M-x customize-variable smime-CAs and add cacert.pem as a
77 ;; You should now be able to sign messages, and even verify messages
78 ;; sent by others that use the same CA as you.
82 ;; Don't complain that this package doesn't do encrypted PEM files,
83 ;; submit a patch instead. I store my keys in a safe place, so I
84 ;; didn't need the encryption. Also, programming was made easier by
85 ;; that decision. One might think that this even influenced were I
86 ;; store my keys, and one would probably be right. :-)
88 ;; Update: Mathias Herberts sent the patch. However, it uses
89 ;; environment variables to pass the password to OpenSSL, which is
90 ;; slightly insecure. Hence a new todo: use a better -passin method.
92 ;; Suggestions and comments are appreciated, mail me at simon@josefsson.org.
96 ;; I would include pointers to introductory text on concepts used in
97 ;; this library here, but the material I've read are so horrible I
98 ;; don't want to recomend them.
100 ;; Why can't someone write a simple introduction to all this stuff?
101 ;; Until then, much of this resemble security by obscurity.
103 ;; Also, I'm not going to mention anything about the wonders of
104 ;; cryptopolitics. Oops, I just did.
108 ;;; Revision history:
110 ;; version 0 not released
116 (eval-when-compile (require 'cl))
119 "S/MIME configuration.")
121 (defcustom smime-keys nil
122 "*Map mail addresses to a file containing Certificate (and private key).
123 The file is assumed to be in PEM format. You can also associate additional
124 certificates to be sent with every message to each address."
125 :type '(repeat (list (string :tag "Mail address")
126 (file :tag "File name")
127 (repeat :tag "Additional certificate files"
128 (file :tag "File name"))))
131 (defcustom smime-CA-directory nil
132 "*Directory containing certificates for CAs you trust.
133 Directory should contain files (in PEM format) named to the X.509
134 hash of the certificate. This can be done using OpenSSL such as:
136 $ ln -s ca.pem `openssl x509 -noout -hash -in ca.pem`
138 where `ca.pem' is the file containing a PEM encoded X.509 CA
140 :type '(choice (const :tag "none" nil)
144 (defcustom smime-CA-file nil
145 "*Files containing certificates for CAs you trust.
146 File should contain certificates in PEM format."
147 :type '(choice (const :tag "none" nil)
151 (defcustom smime-certificate-directory "~/Mail/certs/"
152 "*Directory containing other people's certificates.
153 It should contain files named to the X.509 hash of the certificate,
154 and the files themself should be in PEM format."
155 ;The S/MIME library provide simple functionality for fetching
156 ;certificates into this directory, so there is no need to populate it
161 (defcustom smime-openssl-program
162 (and (condition-case ()
163 (eq 0 (call-process "openssl" nil nil nil "version"))
166 "*Name of OpenSSL binary."
170 ;; OpenSSL option to select the encryption cipher
172 (defcustom smime-encrypt-cipher "-des3"
173 "*Cipher algorithm used for encryption."
174 :type '(choice (const :tag "Triple DES" "-des3")
175 (const :tag "DES" "-des")
176 (const :tag "RC2 40 bits" "-rc2-40")
177 (const :tag "RC2 64 bits" "-rc2-64")
178 (const :tag "RC2 128 bits" "-rc2-128"))
181 (defcustom smime-dns-server nil
182 "*DNS server to query certificates from.
183 If nil, use system defaults."
184 :type '(choice (const :tag "System defaults")
188 (defcustom smime-extra-arguments nil
189 "*List of additional arguments passed to OpenSSL.
190 For instance, if you don't have a /dev/random you might be forced
191 to set this to e.g. `(\"-rand\" \"/etc/entropy\")'."
192 :type '(repeat string)
195 (defvar smime-details-buffer "*OpenSSL output*")
197 ;; Password dialog function
199 (defun smime-ask-passphrase ()
200 "Asks the passphrase to unlock the secret key."
203 "Passphrase for secret key (RET for no passphrase): " t)))
204 (if (string= passphrase "")
210 (defun smime-call-openssl-region (b e buf &rest args)
211 (case (apply 'call-process-region b e smime-openssl-program nil
212 buf nil (append smime-extra-arguments args))
214 (1 (message "OpenSSL: An error occurred parsing the command options.") nil)
215 (2 (message "OpenSSL: One of the input files could not be read.") nil)
216 (3 (message "OpenSSL: An error occurred creating the PKCS#7 file or when reading the MIME message.") nil)
217 (4 (message "OpenSSL: An error occurred decrypting or verifying the message.") nil)
218 (t (error "Unknown OpenSSL exitcode") nil)))
220 (defun smime-make-certfiles (certfiles)
222 (append (list "-certfile" (expand-file-name (car certfiles)))
223 (smime-make-certfiles (cdr certfiles)))))
225 ;; Sign+encrypt region
227 (defun smime-sign-region (b e keyfiles)
228 "Sign region with certified key in KEYFILES.
229 If signing fails, the buffer is not modified. Region is assumed to
230 have proper MIME tags. KEYFILES is expected to contain a PEM encoded
231 private key and certificate as its car, and a list of additional certificates
232 to include in its caar."
233 (let ((keyfile (car keyfiles))
234 (certfiles (and (cdr keyfiles) (cadr keyfiles)))
235 (buffer (generate-new-buffer (generate-new-buffer-name " *smime*")))
236 (passphrase (smime-ask-passphrase)))
238 (setenv "GNUS_SMIME_PASSPHRASE" passphrase))
240 (when (apply 'smime-call-openssl-region b e buffer "smime" "-sign"
241 "-signer" (expand-file-name keyfile)
243 (smime-make-certfiles certfiles)
245 (list "-passin" "env:GNUS_SMIME_PASSPHRASE"))))
247 (insert-buffer-substring buffer)
248 (when (looking-at "^MIME-Version: 1.0$")
249 (delete-region (point) (progn (forward-line 1) (point))))
252 (setenv "GNUS_SMIME_PASSPHRASE" "" t))
253 (with-current-buffer (get-buffer-create smime-details-buffer)
254 (goto-char (point-max))
255 (insert-buffer-substring buffer))
256 (kill-buffer buffer))))
258 (defun smime-encrypt-region (b e certfiles)
259 "Encrypt region for recipients specified in CERTFILES.
260 If encryption fails, the buffer is not modified. Region is assumed to
261 have proper MIME tags. CERTFILES is a list of filenames, each file
262 is expected to contain of a PEM encoded certificate."
263 (let ((buffer (generate-new-buffer (generate-new-buffer-name " *smime*"))))
265 (when (apply 'smime-call-openssl-region b e buffer "smime" "-encrypt"
266 smime-encrypt-cipher (mapcar 'expand-file-name certfiles))
268 (insert-buffer-substring buffer)
269 (when (looking-at "^MIME-Version: 1.0$")
270 (delete-region (point) (progn (forward-line 1) (point))))
272 (with-current-buffer (get-buffer-create smime-details-buffer)
273 (goto-char (point-max))
274 (insert-buffer-substring buffer))
275 (kill-buffer buffer))))
277 ;; Sign+encrypt buffer
279 (defun smime-sign-buffer (&optional keyfile buffer)
280 "S/MIME sign BUFFER with key in KEYFILE.
281 KEYFILE should contain a PEM encoded key and certificate."
283 (with-current-buffer (or buffer (current-buffer))
285 (point-min) (point-max)
287 (list keyfile (smime-get-certfiles keyfile smime-keys))
288 (smime-get-key-by-email
289 (completing-read "Sign using which signature? " smime-keys nil nil
290 (and (listp (car-safe smime-keys))
291 (cdr smime-keys))))))))
293 (defun smime-encrypt-buffer (&optional certfiles buffer)
294 "S/MIME encrypt BUFFER for recipients specified in CERTFILES.
295 CERTFILES is a list of filenames, each file is expected to consist of
296 a PEM encoded key and certificate. Uses current buffer if BUFFER is
299 (with-current-buffer (or buffer (current-buffer))
300 (smime-encrypt-region
301 (point-min) (point-max)
303 (list (read-file-name "Recipient's S/MIME certificate: "
304 smime-certificate-directory nil))))))
306 ;; Verify+decrypt region
308 (defun smime-verify-region (b e)
309 "Verify S/MIME message in region between B and E.
310 Returns non-nil on success.
311 Any details (stdout and stderr) are left in the buffer specified by
312 `smime-details-buffer'."
313 (smime-new-details-buffer)
314 (let ((CAs (append (if smime-CA-file
316 (expand-file-name smime-CA-file)))
317 (if smime-CA-directory
319 (expand-file-name smime-CA-directory))))))
321 (error "No CA configured"))
322 (if (apply 'smime-call-openssl-region b e (list smime-details-buffer t)
323 "smime" "-verify" "-out" "/dev/null" CAs)
325 (insert-buffer-substring smime-details-buffer)
328 (defun smime-noverify-region (b e)
329 "Verify integrity of S/MIME message in region between B and E.
330 Returns non-nil on success.
331 Any details (stdout and stderr) are left in the buffer specified by
332 `smime-details-buffer'."
333 (smime-new-details-buffer)
334 (if (apply 'smime-call-openssl-region b e (list smime-details-buffer t)
335 "smime" "-verify" "-noverify" "-out" '("/dev/null"))
337 (insert-buffer-substring smime-details-buffer)
340 (defun smime-decrypt-region (b e keyfile)
341 "Decrypt S/MIME message in region between B and E with key in KEYFILE.
342 On success, replaces region with decrypted data and return non-nil.
343 Any details (stderr on success, stdout and stderr on error) are left
344 in the buffer specified by `smime-details-buffer'."
345 (smime-new-details-buffer)
346 (let ((buffer (generate-new-buffer (generate-new-buffer-name " *smime*")))
347 CAs (passphrase (smime-ask-passphrase))
348 (tmpfile (make-temp-file "smime")))
350 (setenv "GNUS_SMIME_PASSPHRASE" passphrase))
352 (apply 'smime-call-openssl-region b e
353 (list buffer tmpfile)
354 "smime" "-decrypt" "-recip" (expand-file-name keyfile)
356 (list "-passin" "env:GNUS_SMIME_PASSPHRASE")))
358 (setenv "GNUS_SMIME_PASSPHRASE" "" t))
359 (with-current-buffer smime-details-buffer
360 (insert-file-contents tmpfile)
361 (delete-file tmpfile)))
364 (insert-buffer-substring buffer)
367 (with-current-buffer smime-details-buffer
368 (insert-buffer-substring buffer))
371 (insert-buffer-substring smime-details-buffer)
374 ;; Verify+Decrypt buffer
376 (defun smime-verify-buffer (&optional buffer)
377 "Verify integrity of S/MIME message in BUFFER.
378 Uses current buffer if BUFFER is nil. Returns non-nil on success.
379 Any details (stdout and stderr) are left in the buffer specified by
380 `smime-details-buffer'."
382 (with-current-buffer (or buffer (current-buffer))
383 (smime-verify-region (point-min) (point-max))))
385 (defun smime-noverify-buffer (&optional buffer)
386 "Verify integrity of S/MIME message in BUFFER.
387 Does NOT verify validity of certificate (only message integrity).
388 Uses current buffer if BUFFER is nil. Returns non-nil on success.
389 Any details (stdout and stderr) are left in the buffer specified by
390 `smime-details-buffer'."
392 (with-current-buffer (or buffer (current-buffer))
393 (smime-noverify-region (point-min) (point-max))))
395 (defun smime-decrypt-buffer (&optional buffer keyfile)
396 "Decrypt S/MIME message in BUFFER using KEYFILE.
397 Uses current buffer if BUFFER is nil, and query user of KEYFILE if it's nil.
398 On success, replaces data in buffer and return non-nil.
399 Any details (stderr on success, stdout and stderr on error) are left
400 in the buffer specified by `smime-details-buffer'."
402 (with-current-buffer (or buffer (current-buffer))
403 (smime-decrypt-region
404 (point-min) (point-max)
407 (smime-get-key-by-email
408 (completing-read "Decrypt with which key? " smime-keys nil nil
409 (and (listp (car-safe smime-keys))
410 (caar smime-keys)))))))))
412 ;; Various operations
414 (defun smime-new-details-buffer ()
415 (with-current-buffer (get-buffer-create smime-details-buffer)
418 (defun smime-pkcs7-region (b e)
419 "Convert S/MIME message between points B and E into a PKCS7 message."
420 (smime-new-details-buffer)
421 (when (smime-call-openssl-region b e smime-details-buffer "smime" "-pk7out")
423 (insert-buffer-substring smime-details-buffer)
426 (defun smime-pkcs7-certificates-region (b e)
427 "Extract any certificates enclosed in PKCS7 message between points B and E."
428 (smime-new-details-buffer)
429 (when (smime-call-openssl-region
430 b e smime-details-buffer "pkcs7" "-print_certs" "-text")
432 (insert-buffer-substring smime-details-buffer)
435 (defun smime-pkcs7-email-region (b e)
436 "Get email addresses contained in certificate between points B and E.
437 A string or a list of strings is returned."
438 (smime-new-details-buffer)
439 (when (smime-call-openssl-region
440 b e smime-details-buffer "x509" "-email" "-noout")
442 (insert-buffer-substring smime-details-buffer)
447 (defun smime-get-certfiles (keyfile keys)
449 (let ((curkey (car keys))
450 (otherkeys (cdr keys)))
451 (if (string= keyfile (cadr curkey))
453 (smime-get-certfiles keyfile otherkeys)))))
455 (defalias 'smime-point-at-eol
456 (if (fboundp 'point-at-eol)
460 (defun smime-buffer-as-string-region (b e)
461 "Return each line in region between B and E as a list of strings."
466 (let ((str (buffer-substring (point) (smime-point-at-eol))))
467 (unless (string= "" str)
474 (defun smime-mail-to-domain (mailaddr)
475 (if (string-match "@" mailaddr)
476 (replace-match "." 'fixedcase 'literal mailaddr)
479 (defun smime-cert-by-dns (mail)
480 (let* ((dig-dns-server smime-dns-server)
481 (digbuf (dig-invoke (smime-mail-to-domain mail) "cert" nil nil "+vc"))
482 (retbuf (generate-new-buffer (format "*certificate for %s*" mail)))
483 (certrr (with-current-buffer digbuf
484 (dig-extract-rr (smime-mail-to-domain mail) "cert")))
485 (cert (and certrr (dig-rr-get-pkix-cert certrr))))
487 (with-current-buffer retbuf
488 (insert "-----BEGIN CERTIFICATE-----\n")
489 (let ((i 0) (len (length cert)))
490 (while (> (- len 64) i)
491 (insert (substring cert i (+ i 64)) "\n")
493 (insert (substring cert i len) "\n"))
494 (insert "-----END CERTIFICATE-----\n"))
502 (defvar smime-buffer "*SMIME*")
504 (defvar smime-mode-map nil)
505 (put 'smime-mode 'mode-class 'special)
507 (unless smime-mode-map
508 (setq smime-mode-map (make-sparse-keymap))
509 (suppress-keymap smime-mode-map)
511 (define-key smime-mode-map "q" 'smime-exit)
512 (define-key smime-mode-map "f" 'smime-certificate-info))
515 "Major mode for browsing, viewing and fetching certificates.
517 All normal editing commands are switched off.
520 The following commands are available:
524 (kill-all-local-variables)
525 (setq major-mode 'smime-mode)
526 (setq mode-name "SMIME")
527 (setq mode-line-process nil)
528 (use-local-map smime-mode-map)
529 (buffer-disable-undo)
530 (setq truncate-lines t)
531 (setq buffer-read-only t))
533 (defun smime-certificate-info (certfile)
534 (interactive "fCertificate file: ")
535 (let ((buffer (get-buffer-create (format "*certificate %s*" certfile))))
536 (switch-to-buffer buffer)
538 (call-process smime-openssl-program nil buffer 'display
539 "x509" "-in" (expand-file-name certfile) "-text")
541 (set-buffer-modified-p nil)
543 (goto-char (point-min))))
545 (defun smime-draw-buffer ()
546 (with-current-buffer smime-buffer
547 (let (buffer-read-only)
549 (insert "\nYour keys:\n")
550 (dolist (key smime-keys)
552 (format "\t\t%s: %s\n" (car key) (cadr key))))
553 (insert "\nTrusted Certificate Authoritys:\n")
554 (insert "\nKnown Certificates:\n"))))
557 "Go to the SMIME buffer."
559 (unless (get-buffer smime-buffer)
561 (set-buffer (get-buffer-create smime-buffer))
564 (switch-to-buffer smime-buffer))
567 "Quit the S/MIME buffer."
569 (kill-buffer (current-buffer)))
573 (defun smime-get-key-by-email (email)
574 (cadr (assoc email smime-keys)))
578 ;;; smime.el ends here