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

   1 ;;; starttls.el --- STARTTLS functions
   2
   3 ;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
   4 ;;   2005 Free Software Foundation, Inc.
   5
   6 ;; Author: Daiki Ueno <ueno@unixuser.org>
   7 ;; Author: Simon Josefsson <simon@josefsson.org>
   8 ;; Created: 1999/11/20
   9 ;; Keywords: TLS, SSL, OpenSSL, GNUTLS, mail, news
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software; you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 2, or (at your option)
  16 ;; any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26 ;; Boston, MA 02110-1301, USA.
  27
  28 ;;; Commentary:
  29
  30 ;; This module defines some utility functions for STARTTLS profiles.
  31
  32 ;; [RFC 2595] "Using TLS with IMAP, POP3 and ACAP"
  33 ;;      by Chris Newman <chris.newman@innosoft.com> (1999/06)
  34
  35 ;; This file now contains a combination of the two previous
  36 ;; implementations both called "starttls.el".  The first one is Daiki
  37 ;; Ueno's starttls.el which uses his own "starttls" command line tool,
  38 ;; and the second one is Simon Josefsson's starttls.el which uses
  39 ;; "gnutls-cli" from GNUTLS.
  40 ;;
  41 ;; If "starttls" is available, it is prefered by the code over
  42 ;; "gnutls-cli", for backwards compatibility.  Use
  43 ;; `starttls-use-gnutls' to toggle between implementations if you have
  44 ;; both tools installed.  It is recommended to use GNUTLS, though, as
  45 ;; it performs more verification of the certificates.
  46
  47 ;; The GNUTLS support requires GNUTLS 0.9.90 (released 2003-10-08) or
  48 ;; later, from <http://www.gnu.org/software/gnutls/>, or "starttls"
  49 ;; from <ftp://ftp.opaopa.org/pub/elisp/>.
  50
  51 ;; Usage is similar to `open-network-stream'.  For example:
  52 ;;
  53 ;; (when (setq tmp (starttls-open-stream
  54 ;;                      "test" (current-buffer) "yxa.extundo.com" 25))
  55 ;;   (accept-process-output tmp 15)
  56 ;;   (process-send-string tmp "STARTTLS\n")
  57 ;;   (accept-process-output tmp 15)
  58 ;;   (message "STARTTLS output:\n%s" (starttls-negotiate tmp))
  59 ;;   (process-send-string tmp "EHLO foo\n"))
  60
  61 ;; An example run yields the following output:
  62 ;;
  63 ;; 220 yxa.extundo.com ESMTP Sendmail 8.12.11/8.12.11/Debian-3; Wed, 26 May 2004 19:12:29 +0200; (No UCE/UBE) logging access from: c494102a.s-bi.bostream.se(OK)-c494102a.s-bi.bostream.se [217.215.27.65]
  64 ;; 220 2.0.0 Ready to start TLS
  65 ;; 250-yxa.extundo.com Hello c494102a.s-bi.bostream.se [217.215.27.65], pleased to meet you
  66 ;; 250-ENHANCEDSTATUSCODES
  67 ;; 250-PIPELINING
  68 ;; 250-EXPN
  69 ;; 250-VERB
  70 ;; 250-8BITMIME
  71 ;; 250-SIZE
  72 ;; 250-DSN
  73 ;; 250-ETRN
  74 ;; 250-AUTH DIGEST-MD5 CRAM-MD5 PLAIN LOGIN
  75 ;; 250-DELIVERBY
  76 ;; 250 HELP
  77 ;; nil
  78 ;;
  79 ;; With the message buffer containing:
  80 ;;
  81 ;; STARTTLS output:
  82 ;; *** Starting TLS handshake
  83 ;; - Server's trusted authorities:
  84 ;;    [0]: C=SE,ST=Stockholm,L=Stockholm,O=YXA,OU=CA,CN=yxa.extundo.com,EMAIL=staff@yxa.extundo.com
  85 ;; - Certificate type: X.509
  86 ;;  - Got a certificate list of 2 certificates.
  87 ;;
  88 ;;  - Certificate[0] info:
  89 ;;  # The hostname in the certificate matches 'yxa.extundo.com'.
  90 ;;  # valid since: Wed May 26 12:16:00 CEST 2004
  91 ;;  # expires at: Wed Jul 26 12:16:00 CEST 2023
  92 ;;  # serial number: 04
  93 ;;  # fingerprint: 7c 04 4b c1 fa 26 9b 5d 90 22 52 3c 65 3d 85 3a
  94 ;;  # version: #1
  95 ;;  # public key algorithm: RSA
  96 ;;  #   Modulus: 1024 bits
  97 ;;  # Subject's DN: C=SE,ST=Stockholm,L=Stockholm,O=YXA,OU=Mail server,CN=yxa.extundo.com,EMAIL=staff@yxa.extundo.com
  98 ;;  # Issuer's DN: C=SE,ST=Stockholm,L=Stockholm,O=YXA,OU=CA,CN=yxa.extundo.com,EMAIL=staff@yxa.extundo.com
  99 ;;
 100 ;;  - Certificate[1] info:
 101 ;;  # valid since: Sun May 23 11:35:00 CEST 2004
 102 ;;  # expires at: Sun Jul 23 11:35:00 CEST 2023
 103 ;;  # serial number: 00
 104 ;;  # fingerprint: fc 76 d8 63 1a c9 0b 3b fa 40 fe ed 47 7a 58 ae
 105 ;;  # version: #3
 106 ;;  # public key algorithm: RSA
 107 ;;  #   Modulus: 1024 bits
 108 ;;  # Subject's DN: C=SE,ST=Stockholm,L=Stockholm,O=YXA,OU=CA,CN=yxa.extundo.com,EMAIL=staff@yxa.extundo.com
 109 ;;  # Issuer's DN: C=SE,ST=Stockholm,L=Stockholm,O=YXA,OU=CA,CN=yxa.extundo.com,EMAIL=staff@yxa.extundo.com
 110 ;;
 111 ;; - Peer's certificate issuer is unknown
 112 ;; - Peer's certificate is NOT trusted
 113 ;; - Version: TLS 1.0
 114 ;; - Key Exchange: RSA
 115 ;; - Cipher: ARCFOUR 128
 116 ;; - MAC: SHA
 117 ;; - Compression: NULL
 118
 119 ;;; Code:
 120
 121 (defgroup starttls nil
 122   "Support for `Transport Layer Security' protocol."
 123   :version "21.1"
 124   :group 'mail)
 125
 126 (defcustom starttls-gnutls-program "gnutls-cli"
 127   "Name of GNUTLS command line tool.
 128 This program is used when GNUTLS is used, i.e. when
 129 `starttls-use-gnutls' is non-nil."
 130   :version "22.1"
 131   :type 'string
 132   :group 'starttls)
 133
 134 (defcustom starttls-program "starttls"
 135   "The program to run in a subprocess to open an TLSv1 connection.
 136 This program is used when the `starttls' command is used,
 137 i.e. when `starttls-use-gnutls' is nil."
 138   :type 'string
 139   :group 'starttls)
 140
 141 (defcustom starttls-use-gnutls (not (executable-find starttls-program))
 142   "*Whether to use GNUTLS instead of the `starttls' command."
 143   :version "22.1"
 144   :type 'boolean
 145   :group 'starttls)
 146
 147 (defcustom starttls-extra-args nil
 148   "Extra arguments to `starttls-program'.
 149 These apply when the `starttls' command is used, i.e. when
 150 `starttls-use-gnutls' is nil."
 151   :type '(repeat string)
 152   :group 'starttls)
 153
 154 (defcustom starttls-extra-arguments nil