cgit.sxemacs.org Git - gnus/blob - lisp/smime.el

   1 ;;; smime.el --- S/MIME support library
   2 ;; Copyright (c) 2000, 2001 Free Software Foundation, Inc.
   3
   4 ;; Author: Simon Josefsson <simon@josefsson.org>
   5 ;; Keywords: SMIME X.509 PEM OpenSSL
   6
   7 ;; This file is not a part of GNU Emacs, but the same permissions apply.
   8
   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.
  13
  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.
  18
  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.
  23
  24 ;;; Commentary:
  25
  26 ;; This library perform S/MIME operations from within Emacs.
  27 ;;
  28 ;; Functions for fetching certificates from public repositories are
  29 ;; provided, currently only from DNS.  LDAP support (via EUDC) is planned.
  30 ;;
  31 ;; It uses OpenSSL (tested with version 0.9.5a and 0.9.6) for signing,
  32 ;; encryption and decryption.
  33 ;;
  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.
  39 ;;
  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
  43 ;; reflect this.
  44
  45 ;;; Quick introduction:
  46
  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.
  50 ;;
  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
  53 ;; key:
  54 ;;
  55 ;; $ openssl pkcs12 -in mykey.p12 -clcerts -nodes > mykey.pem
  56 ;; ...
  57 ;;
  58 ;; Now, use M-x customize-variable smime-keys and add mykey.pem as
  59 ;; a key.
  60 ;;
  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.
  65 ;;
  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
  69 ;; certificate with:
  70 ;;
  71 ;; $ openssl pkcs12 -in mykey.p12 -cacerts -nodes > cacert.pem
  72 ;; ...
  73 ;;
  74 ;; Now, use M-x customize-variable smime-CAs and add cacert.pem as a
  75 ;; CA certificate.
  76 ;;
  77 ;; You should now be able to sign messages, and even verify messages
  78 ;; sent by others that use the same CA as you.
  79
  80 ;; Bugs:
  81 ;;
  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. :-)
  87 ;;
  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.
  91 ;;
  92 ;; Suggestions and comments are appreciated, mail me at simon@josefsson.org.
  93
  94 ;; <rant>
  95 ;;
  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.
  99 ;;
 100 ;; Why can't someone write a simple introduction to all this stuff?
 101 ;; Until then, much of this resemble security by obscurity.
 102 ;;
 103 ;; Also, I'm not going to mention anything about the wonders of
 104 ;; cryptopolitics.  Oops, I just did.
 105 ;;
 106 ;; </rant>
 107
 108 ;;; Revision history:
 109
 110 ;; version 0 not released
 111
 112 ;;; Code:
 113
 114 (require 'dig)
 115 (require 'comint)
 116 (eval-when-compile (require 'cl))
 117
 118 (defgroup smime nil
 119   "S/MIME configuration.")
 120
 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"))))
 129   :group 'smime)
 130
 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:
 135
 136 $ ln -s ca.pem `openssl x509 -noout -hash -in ca.pem`
 137
 138 where `ca.pem' is the file containing a PEM encoded X.509 CA
 139 certificate."
 140   :type '(choice (const :tag "none" nil)
 141                  directory)
 142   :group 'smime)
 143
 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)
 148                  file)
 149   :group 'smime)
 150
 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
 157 ;manually.
 158   :type 'directory
 159   :group 'smime)
 160
 161 (defcustom smime-openssl-program
 162   (and (condition-case ()
 163            (eq 0 (call-process "openssl" nil nil nil "version"))
 164          (error nil))
 165        "openssl")
 166   "*Name of OpenSSL binary."
 167   :type 'string
 168   :group 'smime)
 169
 170 ;; OpenSSL option to select the encryption cipher
 171
 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"))
 179   :group 'smime)
 180
 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")
 185                  string)
 186   :group 'smime)
 187
 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)
 193   :group 'smime)
 194
 195 (defvar smime-details-buffer "*OpenSSL output*")
 196
 197 ;; Password dialog function
 198
 199 (defun smime-ask-passphrase ()
 200   "Asks the passphrase to unlock the secret key."
 201   (let ((passphrase
 202          (comint-read-noecho
 203           "Passphrase for secret key (RET for no passphrase): " t)))
 204     (if (string= passphrase "")
 205         nil
 206       passphrase)))
 207
 208 ;; OpenSSL wrappers.
 209
 210 (defun smime-call-openssl-region (b e buf &rest args)
 211   (case (apply 'call-process-region b e smime-openssl-program nil
 212                (list buf nil) nil (append smime-extra-arguments args))
 213     (0 t)
 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)))
 219
 220 (defun smime-make-certfiles (certfiles)
 221   (if certfiles
 222       (append (list "-certfile" (expand-file-name (car certfiles)))
 223               (smime-make-certfiles (cdr certfiles)))))
 224
 225 ;; Sign+encrypt region
 226
 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)))
 237     (if passphrase
 238         (setenv "GNUS_SMIME_PASSPHRASE" passphrase))
 239     (prog1
 240         (when (apply 'smime-call-openssl-region b e buffer "smime" "-sign"
 241                      "-signer" (expand-file-name keyfile)
 242                      (append
 243                       (smime-make-certfiles certfiles)
 244                       (if passphrase
 245                           (list "-passin" "env:GNUS_SMIME_PASSPHRASE"))))
 246           (delete-region b e)
 247           (insert-buffer buffer)
 248           (when (looking-at "^MIME-Version: 1.0$")
 249             (delete-region (point) (progn (forward-line 1) (point))))
 250           t)
 251       (if passphrase
 252           (setenv "GNUS_SMIME_PASSPHRASE" "" t))
 253       (with-current-buffer (get-buffer-create smime-details-buffer)
 254         (goto-char (point-max))
 255         (insert-buffer buffer))
 256       (kill-buffer buffer))))
 257
 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*"))))
 264     (prog1
 265         (when (apply 'smime-call-openssl-region b e buffer "smime" "-encrypt"
 266                      smime-encrypt-cipher (mapcar 'expand-file-name certfiles))
 267           (delete-region b e)
 268           (insert-buffer buffer)
 269           (when (looking-at "^MIME-Version: 1.0$")
 270             (delete-region (point) (progn (forward-line 1) (point))))
 271           t)
 272       (with-current-buffer (get-buffer-create smime-details-buffer)
 273         (goto-char (point-max))
 274         (insert-buffer buffer))
 275       (kill-buffer buffer))))
 276
 277 (defun smime-get-certfiles (keyfile keys)
 278   (if keys
 279       (let ((curkey (car keys))
 280             (otherkeys (cdr keys)))
 281         (if (string= keyfile (cadr curkey))
 282             (caddr curkey)
 283           (smime-get-certfiles keyfile otherkeys)))))
 284
 285 ;; Sign+encrypt buffer
 286
 287 (defun smime-sign-buffer (&optional keyfile buffer)
 288   "S/MIME sign BUFFER with key in KEYFILE.
 289 KEYFILE should contain a PEM encoded key and certificate."
 290   (interactive)
 291   (with-current-buffer (or buffer (current-buffer))
 292     (smime-sign-region
 293      (point-min) (point-max)
 294      (if keyfile
 295          (list keyfile (smime-get-certfiles keyfile smime-keys))
 296        (smime-get-key-by-email
 297         (completing-read "Sign using which signature? " smime-keys nil nil
 298                          (and (listp (car-safe smime-keys))
 299                               (cdr smime-keys))))))))
 300
 301 (defun smime-encrypt-buffer (&optional certfiles buffer)
 302   "S/MIME encrypt BUFFER for recipients specified in CERTFILES.
 303 CERTFILES is a list of filenames, each file is expected to consist of
 304 a PEM encoded key and certificate.  Uses current buffer if BUFFER is
 305 nil."
 306   (interactive)
 307   (with-current-buffer (or buffer (current-buffer))
 308     (smime-encrypt-region
 309      (point-min) (point-max)
 310      (or certfiles
 311          (list (read-file-name "Recipient's S/MIME certificate: "
 312                                smime-certificate-directory nil))))))
 313
 314 ;; Verify+decrypt region
 315
 316 (defun smime-verify-region (b e)
 317   (let ((buffer (get-buffer-create smime-details-buffer))
 318         (CAs (append (if smime-CA-file
 319                          (list "-CAfile"
 320                                (expand-file-name smime-CA-file)))
 321                      (if smime-CA-directory
 322                          (list "-CApath"
 323                                (expand-file-name smime-CA-directory))))))
 324     (unless CAs (error "No CA configured"))
 325     (with-current-buffer buffer
 326       (erase-buffer))
 327     (if (apply 'smime-call-openssl-region b e buffer "smime" "-verify"
 328                "-out" "/dev/null" CAs)
 329         (message "S/MIME message verified succesfully.")
 330       (message "S/MIME message NOT verified successfully.")
 331       nil)))
 332
 333 (defun smime-noverify-region (b e)
 334   (let ((buffer (get-buffer-create smime-details-buffer)))
 335     (with-current-buffer buffer
 336       (erase-buffer))
 337     (if (apply 'smime-call-openssl-region b e buffer "smime" "-verify"
 338                "-noverify" "-out" '("/dev/null"))
 339         (message "S/MIME message verified succesfully.")
 340       (message "S/MIME message NOT verified successfully.")
 341       nil)))
 342
 343 (defun smime-decrypt-region (b e keyfile)
 344   (let ((buffer (generate-new-buffer (generate-new-buffer-name "*smime*")))
 345         CAs (passphrase (smime-ask-passphrase)))
 346     (if passphrase
 347         (setenv "GNUS_SMIME_PASSPHRASE" passphrase))
 348     (when (apply 'smime-call-openssl-region
 349                  b e buffer "smime" "-decrypt"
 350                  "-recip" (expand-file-name keyfile)
 351                  (if passphrase
 352                      (list "-passin" "env:GNUS_SMIME_PASSPHRASE" )))
 353       (delete-region b e)
 354       (insert-buffer buffer))
 355     (if passphrase
 356         (setenv "GNUS_SMIME_PASSPHRASE" "" t))
 357     (with-current-buffer (get-buffer-create smime-details-buffer)
 358       (goto-char (point-max))
 359       (insert-buffer buffer))
 360     (kill-buffer buffer)))
 361
 362 ;; Verify+Decrypt buffer
 363
 364 (defun smime-verify-buffer (&optional buffer)
 365   "Verify integrity of S/MIME message in BUFFER.
 366 Uses current buffer if BUFFER is nil."
 367   (interactive)
 368   (with-current-buffer (or buffer (current-buffer))
 369     (smime-verify-region (point-min) (point-max))))
 370
 371 (defun smime-noverify-buffer (&optional buffer)
 372   "Verify integrity of S/MIME message in BUFFER.
 373 Uses current buffer if BUFFER is nil.
 374 Does NOT verify validity of certificate."
 375   (interactive)
 376   (with-current-buffer (or buffer (current-buffer))
 377     (smime-noverify-region (point-min) (point-max))))
 378
 379 (defun smime-decrypt-buffer (&optional buffer keyfile)
 380   "Decrypt S/MIME message in BUFFER using KEYFILE.
 381 Uses current buffer if BUFFER is nil, queries user of KEYFILE is nil."
 382   (interactive)
 383   (with-current-buffer (or buffer (current-buffer))
 384     (smime-decrypt-region
 385      (point-min) (point-max)
 386      (expand-file-name
 387       (or keyfile
 388           (smime-get-key-by-email
 389            (completing-read "Decrypt with which key? " smime-keys nil nil
 390                             (and (listp (car-safe smime-keys))
 391                                  (caar smime-keys)))))))))
 392
 393 ;; Various operations
 394
 395 (defun smime-pkcs7-region (b e)
 396   "Convert S/MIME message between points B and E into a PKCS7 message."
 397   (let ((buffer (get-buffer-create smime-details-buffer)))
 398     (with-current-buffer buffer
 399       (erase-buffer))
 400     (when (smime-call-openssl-region b e buffer "smime" "-pk7out")
 401       (delete-region b e)
 402       (insert-buffer-substring buffer)
 403       t)))
 404
 405 (defun smime-pkcs7-certificates-region (b e)
 406   "Extract any certificates enclosed in PKCS7 message between points B and E."
 407   (let ((buffer (get-buffer-create smime-details-buffer)))
 408     (with-current-buffer buffer
 409       (erase-buffer))
 410     (when (smime-call-openssl-region b e buffer "pkcs7" "-print_certs" "-text")
 411       (delete-region b e)
 412       (insert-buffer-substring buffer)
 413       t)))
 414
 415 (defun smime-pkcs7-email-region (b e)
 416   "Get email addresses contained in certificate between points B and E.
 417 A string or a list of strings is returned."
 418   (let ((buffer (get-buffer-create smime-details-buffer)))
 419     (with-current-buffer buffer
 420       (erase-buffer))
 421     (when (smime-call-openssl-region b e buffer "x509" "-email" "-noout")
 422       (delete-region b e)
 423       (insert-buffer-substring buffer)
 424       t)))
 425
 426 (defalias 'smime-point-at-eol
 427   (if (fboundp 'point-at-eol)
 428       'point-at-eol
 429     'line-end-position))
 430
 431 (defun smime-buffer-as-string-region (b e)
 432   "Return each line in region between B and E as a list of strings."
 433   (save-excursion
 434     (goto-char b)
 435     (let (res)
 436       (while (< (point) e)
 437         (let ((str (buffer-substring (point) (smime-point-at-eol))))
 438           (unless (string= "" str)
 439             (push str res)))
 440         (forward-line))
 441       res)))
 442
 443 ;; Find certificates
 444
 445 (defun smime-mail-to-domain (mailaddr)
 446   (if (string-match "@" mailaddr)
 447       (replace-match "." 'fixedcase 'literal mailaddr)
 448     mailaddr))
 449
 450 (defun smime-cert-by-dns (mail)
 451   (let* ((dig-dns-server smime-dns-server)
 452          (digbuf (dig-invoke (smime-mail-to-domain mail) "cert" nil nil "+vc"))
 453          (retbuf (generate-new-buffer (format "*certificate for %s*" mail)))
 454          (certrr (with-current-buffer digbuf
 455                    (dig-extract-rr (smime-mail-to-domain mail) "cert")))
 456          (cert (and certrr (dig-rr-get-pkix-cert certrr))))
 457       (if cert
 458           (with-current-buffer retbuf
 459             (insert "-----BEGIN CERTIFICATE-----\n")
 460             (let ((i 0) (len (length cert)))
 461               (while (> (- len 64) i)
 462                 (insert (substring cert i (+ i 64)) "\n")
 463                 (setq i (+ i 64)))
 464               (insert (substring cert i len) "\n"))
 465             (insert "-----END CERTIFICATE-----\n"))
 466         (kill-buffer retbuf)
 467         (setq retbuf nil))
 468       (kill-buffer digbuf)
 469       retbuf))
 470
 471 ;; User interface.
 472
 473 (defvar smime-buffer "*SMIME*")
 474
 475 (defvar smime-mode-map nil)
 476 (put 'smime-mode 'mode-class 'special)
 477
 478 (unless smime-mode-map
 479   (setq smime-mode-map (make-sparse-keymap))
 480   (suppress-keymap smime-mode-map)
 481
 482   (define-key smime-mode-map "q" 'smime-exit)
 483   (define-key smime-mode-map "f" 'smime-certificate-info))
 484
 485 (defun smime-mode ()
 486   "Major mode for browsing, viewing and fetching certificates.
 487
 488 All normal editing commands are switched off.
 489 \\<smime-mode-map>
 490
 491 The following commands are available:
 492
 493 \\{smime-mode-map}"
 494   (interactive)
 495   (kill-all-local-variables)
 496   (setq major-mode 'smime-mode)
 497   (setq mode-name "SMIME")
 498   (setq mode-line-process nil)
 499   (use-local-map smime-mode-map)
 500   (buffer-disable-undo)
 501   (setq truncate-lines t)
 502   (setq buffer-read-only t))
 503
 504 (defun smime-certificate-info (certfile)
 505   (interactive "fCertificate file: ")
 506   (let ((buffer (get-buffer-create (format "*certificate %s*" certfile))))
 507     (switch-to-buffer buffer)
 508     (erase-buffer)
 509     (call-process smime-openssl-program nil buffer 'display
 510                   "x509" "-in" (expand-file-name certfile) "-text")
 511     (fundamental-mode)
 512     (set-buffer-modified-p nil)
 513     (toggle-read-only t)
 514     (goto-char (point-min))))
 515
 516 (defun smime-draw-buffer ()
 517   (with-current-buffer smime-buffer
 518     (let (buffer-read-only)
 519       (erase-buffer)
 520       (insert "\nYour keys:\n")
 521       (dolist (key smime-keys)
 522         (insert
 523          (format "\t\t%s: %s\n" (car key) (cadr key))))
 524       (insert "\nTrusted Certificate Authoritys:\n")
 525       (insert "\nKnown Certificates:\n"))))
 526
 527 (defun smime ()
 528   "Go to the SMIME buffer."
 529   (interactive)
 530   (unless (get-buffer smime-buffer)
 531     (save-excursion
 532       (set-buffer (get-buffer-create smime-buffer))
 533       (smime-mode)))
 534   (smime-draw-buffer)
 535   (switch-to-buffer smime-buffer))
 536
 537 (defun smime-exit ()
 538   "Quit the S/MIME buffer."
 539   (interactive)
 540   (kill-buffer (current-buffer)))
 541
 542 ;; Other functions
 543
 544 (defun smime-get-key-by-email (email)
 545   (cadr (assoc email smime-keys)))
 546
 547 (provide 'smime)
 548
 549 ;;; smime.el ends here