gnutls.el 8.01 KB
Newer Older
1
;;; gnutls.el --- Support SSL/TLS connections through GnuTLS
2

3
;; Copyright (C) 2010-2011 Free Software Foundation, Inc.
Ted Zlatanov's avatar
Ted Zlatanov committed
4 5 6 7

;; Author: Ted Zlatanov <tzz@lifelogs.com>
;; Keywords: comm, tls, ssl, encryption
;; Originally-By: Simon Josefsson (See http://josefsson.org/emacs-security/)
8
;; Thanks-To: Lars Magne Ingebrigtsen <larsi@gnus.org>
Ted Zlatanov's avatar
Ted Zlatanov committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This package provides language bindings for the GnuTLS library
28 29
;; using the corresponding core functions in gnutls.c.  It should NOT
;; be used directly, only through open-protocol-stream.
Ted Zlatanov's avatar
Ted Zlatanov committed
30 31 32

;; Simple test:
;;
33 34
;; (open-gnutls-stream "tls" "tls-buffer" "yourserver.com" "https")
;; (open-gnutls-stream "tls" "tls-buffer" "imap.gmail.com" "imaps")
Ted Zlatanov's avatar
Ted Zlatanov committed
35 36 37

;;; Code:

38 39
(eval-when-compile (require 'cl))

40 41 42 43 44
(defgroup gnutls nil
  "Emacs interface to the GnuTLS library."
  :prefix "gnutls-"
  :group 'net-utils)

45 46 47 48 49 50 51
(defcustom gnutls-algorithm-priority nil
  "If non-nil, this should be a TLS priority string.
For instance, if you want to skip the \"dhe-rsa\" algorithm,
set this variable to \"normal:-dhe-rsa\"."
  :type '(choice (const nil)
		 string))

52 53 54 55 56 57 58 59 60 61 62 63 64
;;;###autoload
(defcustom gnutls-min-prime-bits nil
  "The minimum number of bits to be used in Diffie-Hellman key exchange.

This sets the minimum accepted size of the key to be used in a
client-server handshake.  If the server sends a prime with fewer than
the specified number of bits the handshake will fail.

A value of nil says to use the default gnutls value."
  :type '(choice (const :tag "Use default value" nil)
                 (integer :tag "Number of bits" 512))
  :group 'gnutls)

65 66
(defun open-gnutls-stream (name buffer host service)
  "Open a SSL/TLS connection for a service to a host.
Ted Zlatanov's avatar
Ted Zlatanov committed
67 68 69 70 71 72 73 74 75 76 77
Returns a subprocess-object to represent the connection.
Input and output work as for subprocesses; `delete-process' closes it.
Args are NAME BUFFER HOST SERVICE.
NAME is name for process.  It is modified if necessary to make it unique.
BUFFER is the buffer (or `buffer-name') to associate with the process.
 Process output goes at end of that buffer, unless you specify
 an output stream or filter function to handle the output.
 BUFFER may be also nil, meaning that this process is not associated
 with any buffer
Third arg is name of the host to connect to, or its IP address.
Fourth arg SERVICE is name of the service desired, or an integer
78 79
specifying a port number to connect to.

80 81 82 83 84 85 86 87
Usage example:

  \(with-temp-buffer
    \(open-gnutls-stream \"tls\"
                        \(current-buffer)
                        \"your server goes here\"
                        \"imaps\"))

88 89 90 91
This is a very simple wrapper around `gnutls-negotiate'.  See its
documentation for the specific parameters you can use to open a
GnuTLS connection, including specifying the credential type,
trust and key files, and priority string."
92 93 94
  (gnutls-negotiate :process (open-network-stream name buffer host service)
                    :type 'gnutls-x509pki
                    :hostname host))
95 96 97 98 99 100

(put 'gnutls-error
     'error-conditions
     '(error gnutls-error))
(put 'gnutls-error
     'error-message "GnuTLS error")
Ted Zlatanov's avatar
Ted Zlatanov committed
101

102
(declare-function gnutls-boot "gnutls.c" (proc type proplist))
103
(declare-function gnutls-errorp "gnutls.c" (error))
104

105 106 107
(defun* gnutls-negotiate
    (&rest spec
           &key process type hostname priority-string
108 109
           trustfiles crlfiles keylist min-prime-bits
           verify-flags verify-error verify-hostname-error
110
           &allow-other-keys)
Juanma Barranquero's avatar
Juanma Barranquero committed
111
  "Negotiate a SSL/TLS connection.  Returns proc.  Signals gnutls-error.
112 113 114

Note arguments are passed CL style, :type TYPE instead of just TYPE.

115
TYPE is `gnutls-x509pki' (default) or `gnutls-anon'.  Use nil for the default.
116
PROCESS is a process returned by `open-network-stream'.
117
HOSTNAME is the remote hostname.  It must be a valid string.
118 119
PRIORITY-STRING is as per the GnuTLS docs, default is \"NORMAL\".
TRUSTFILES is a list of CA bundles.
120 121
CRLFILES is a list of CRL files.
KEYLIST is an alist of (client key file, client cert file) pairs.
122 123 124
MIN-PRIME-BITS is the minimum acceptable size of Diffie-Hellman keys
\(see `gnutls-min-prime-bits' for more information).  Use nil for the
default.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

When VERIFY-HOSTNAME-ERROR is not nil, an error will be raised
when the hostname does not match the presented certificate's host
name.  The exact verification algorithm is a basic implementation
of the matching described in RFC2818 (HTTPS), which takes into
account wildcards, and the DNSName/IPAddress subject alternative
name PKIX extension.  See GnuTLS' gnutls_x509_crt_check_hostname
for details.  When VERIFY-HOSTNAME-ERROR is nil, only a warning
will be issued.

When VERIFY-ERROR is not nil, an error will be raised when the
peer certificate verification fails as per GnuTLS'
gnutls_certificate_verify_peers2.  Otherwise, only warnings will
be shown about the verification failure.

VERIFY-FLAGS is a numeric OR of verification flags only for
`gnutls-x509pki' connections.  See GnuTLS' x509.h for details;
here's a recent version of the list.

    GNUTLS_VERIFY_DISABLE_CA_SIGN = 1,
    GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT = 2,
    GNUTLS_VERIFY_DO_NOT_ALLOW_SAME = 4,
    GNUTLS_VERIFY_ALLOW_ANY_X509_V1_CA_CRT = 8,
    GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD2 = 16,
    GNUTLS_VERIFY_ALLOW_SIGN_RSA_MD5 = 32,
    GNUTLS_VERIFY_DISABLE_TIME_CHECKS = 64,
    GNUTLS_VERIFY_DISABLE_TRUSTED_TIME_CHECKS = 128,
    GNUTLS_VERIFY_DO_NOT_ALLOW_X509_V1_CA_CRT = 256

It must be omitted, a number, or nil; if omitted or nil it
defaults to GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT."
156
  (let* ((type (or type 'gnutls-x509pki))
157
         (default-trustfile "/etc/ssl/certs/ca-certificates.crt")
158
         (trustfiles (or trustfiles
159 160
                         (when (file-exists-p default-trustfile)
                           (list default-trustfile))))
Ted Zlatanov's avatar
Ted Zlatanov committed
161 162
         (priority-string (or priority-string
                              (cond
163
                               ((eq type 'gnutls-anon)
Ted Zlatanov's avatar
Ted Zlatanov committed
164
                                "NORMAL:+ANON-DH:!ARCFOUR-128")
165
                               ((eq type 'gnutls-x509pki)
166 167 168
				(if gnutls-algorithm-priority
				    (upcase gnutls-algorithm-priority)
				  "NORMAL")))))
169
         (min-prime-bits (or min-prime-bits gnutls-min-prime-bits))
170
         (params `(:priority ,priority-string
171
                             :hostname ,hostname
172
                             :loglevel ,gnutls-log-level
173
                             :min-prime-bits ,min-prime-bits
174
                             :trustfiles ,trustfiles
175 176
                             :crlfiles ,crlfiles
                             :keylist ,keylist
177 178 179
                             :verify-flags ,verify-flags
                             :verify-error ,verify-error
                             :verify-hostname-error ,verify-hostname-error
180
                             :callbacks nil))
Ted Zlatanov's avatar
Ted Zlatanov committed
181 182 183
         ret)

    (gnutls-message-maybe
184
     (setq ret (gnutls-boot process type params))
185 186 187 188
     "boot: %s" params)

    (when (gnutls-errorp ret)
      ;; This is a error from the underlying C code.
189
      (signal 'gnutls-error (list process ret)))
Ted Zlatanov's avatar
Ted Zlatanov committed
190

191
    process))
Ted Zlatanov's avatar
Ted Zlatanov committed
192

193 194
(declare-function gnutls-error-string "gnutls.c" (error))

Ted Zlatanov's avatar
Ted Zlatanov committed
195 196 197 198 199 200 201 202 203 204 205 206
(defun gnutls-message-maybe (doit format &rest params)
  "When DOIT, message with the caller name followed by FORMAT on PARAMS."
  ;; (apply 'debug format (or params '(nil)))
  (when (gnutls-errorp doit)
    (message "%s: (err=[%s] %s) %s"
             "gnutls.el"
             doit (gnutls-error-string doit)
             (apply 'format format (or params '(nil))))))

(provide 'gnutls)

;;; gnutls.el ends here