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

3
;; Copyright (C) 2010-2013 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
(require 'cl-lib)
39

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

46 47 48 49
(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\"."
50
  :group 'gnutls
51
  :type '(choice (const nil)
52 53
                 string))

54 55 56 57 58 59 60 61 62 63 64 65 66
(defcustom gnutls-verify-error nil
  "If non-nil, this should be a list of checks per hostname regex or t."
  :group 'gnutls
  :type '(choice
          (const t)
          (repeat :tag "List of hostname regexps with flags for each"
           (list
            (choice :tag "Hostname"
                    (const ".*" :tag "Any hostname")
                    regexp)
            (set (const :trustfiles)
                 (const :hostname))))))

67 68 69 70 71
(defcustom gnutls-trustfiles
  '(
    "/etc/ssl/certs/ca-certificates.crt" ; Debian, Ubuntu, Gentoo and Arch Linux
    "/etc/pki/tls/certs/ca-bundle.crt"   ; Fedora and RHEL
    "/etc/ssl/ca-bundle.pem"             ; Suse
72
    "/usr/ssl/certs/ca-bundle.crt"       ; Cygwin
73 74 75 76 77 78 79
    )
  "List of CA bundle location filenames or a function returning said list.
The files may be in PEM or DER format, as per the GnuTLS documentation.
The files may not exist, in which case they will be ignored."
  :group 'gnutls
  :type '(choice (function :tag "Function to produce list of bundle filenames")
                 (repeat (file :tag "Bundle filename"))))
80

81
;;;###autoload
82
(defcustom gnutls-min-prime-bits 256
83 84 85 86 87 88 89
  ;; Several mail servers send fewer bits than the GnuTLS default.
  ;; Currently, 256 appears to be a reasonable choice (Bug#11267).
  "Minimum number of prime bits accepted by GnuTLS for key exchange.
During a Diffie-Hellman handshake, if the server sends a prime
number with fewer than this number of bits, the handshake is
rejected.  \(The smaller the prime number, the less secure the
key exchange is against man-in-the-middle attacks.)
90

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

96 97
(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
98 99 100 101 102 103 104 105 106 107 108
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
109 110
specifying a port number to connect to.

111 112 113 114 115 116 117 118
Usage example:

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

119 120 121 122
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."
123 124 125
  (gnutls-negotiate :process (open-network-stream name buffer host service)
                    :type 'gnutls-x509pki
                    :hostname host))
126

127
(define-error 'gnutls-error "GnuTLS error")
Ted Zlatanov's avatar
Ted Zlatanov committed
128

129
(declare-function gnutls-boot "gnutls.c" (proc type proplist))
130
(declare-function gnutls-errorp "gnutls.c" (error))
131
(defvar gnutls-log-level)               ; gnutls.c
132

Stefan Monnier's avatar
Stefan Monnier committed
133
(cl-defun gnutls-negotiate
134 135
    (&rest spec
           &key process type hostname priority-string
136 137
           trustfiles crlfiles keylist min-prime-bits
           verify-flags verify-error verify-hostname-error
138
           &allow-other-keys)
Juanma Barranquero's avatar
Juanma Barranquero committed
139
  "Negotiate a SSL/TLS connection.  Returns proc.  Signals gnutls-error.
140 141 142

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

143
TYPE is `gnutls-x509pki' (default) or `gnutls-anon'.  Use nil for the default.
144
PROCESS is a process returned by `open-network-stream'.
145
HOSTNAME is the remote hostname.  It must be a valid string.
146
PRIORITY-STRING is as per the GnuTLS docs, default is \"NORMAL\".
147
TRUSTFILES is a list of CA bundles.  It defaults to `gnutls-trustfiles'.
148 149
CRLFILES is a list of CRL files.
KEYLIST is an alist of (client key file, client cert file) pairs.
150 151 152
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.
153

154 155 156 157 158 159 160
VERIFY-HOSTNAME-ERROR is a backwards compatibility option for
putting `:hostname' in VERIFY-ERROR.

When VERIFY-ERROR is t or a list containing `:trustfiles', 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.
161

162 163 164 165 166 167 168 169 170 171 172
When VERIFY-ERROR is t or a list containing `:hostname', 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.  Otherwise,
only a warning will be issued.

Note that the list in `gnutls-verify-error', matched against the
HOSTNAME, is the default VERIFY-ERROR.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189

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."
190
  (let* ((type (or type 'gnutls-x509pki))
191
         (trustfiles (or trustfiles
192 193 194 195 196
                         (delq nil
                               (mapcar (lambda (f) (and f (file-exists-p f) f))
                                       (if (functionp gnutls-trustfiles)
                                           (funcall gnutls-trustfiles)
                                         gnutls-trustfiles)))))
Ted Zlatanov's avatar
Ted Zlatanov committed
197 198
         (priority-string (or priority-string
                              (cond
199
                               ((eq type 'gnutls-anon)
Ted Zlatanov's avatar
Ted Zlatanov committed
200
                                "NORMAL:+ANON-DH:!ARCFOUR-128")
201
                               ((eq type 'gnutls-x509pki)
202 203 204
                                (if gnutls-algorithm-priority
                                    (upcase gnutls-algorithm-priority)
                                  "NORMAL")))))
205 206 207 208 209 210 211 212
         (verify-error (or verify-error
                           ;; this uses the value of `gnutls-verify-error'
                           (cond
                            ;; if t, pass it on
                            ((eq gnutls-verify-error t)
                             t)
                            ;; if a list, look for hostname matches
                            ((listp gnutls-verify-error)
213
                             (cl-mapcan
214 215 216 217 218 219
                              (lambda (check)
                                (when (string-match (car check) hostname)
                                  (cdr check)))
                              gnutls-verify-error))
                            ;; else it's nil
                            (t nil))))
220
         (min-prime-bits (or min-prime-bits gnutls-min-prime-bits))
221 222 223 224 225 226
         params ret)

    (when verify-hostname-error
      (push :hostname verify-error))

    (setq params `(:priority ,priority-string
227
                             :hostname ,hostname
228
                             :loglevel ,gnutls-log-level
229
                             :min-prime-bits ,min-prime-bits
230
                             :trustfiles ,trustfiles
231 232
                             :crlfiles ,crlfiles
                             :keylist ,keylist
233 234
                             :verify-flags ,verify-flags
                             :verify-error ,verify-error
235
                             :callbacks nil))
Ted Zlatanov's avatar
Ted Zlatanov committed
236 237

    (gnutls-message-maybe
238
     (setq ret (gnutls-boot process type params))
239 240 241 242
     "boot: %s" params)

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

245
    process))
Ted Zlatanov's avatar
Ted Zlatanov committed
246

247 248
(declare-function gnutls-error-string "gnutls.c" (error))

Ted Zlatanov's avatar
Ted Zlatanov committed
249 250 251 252 253 254 255 256 257 258 259 260
(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