gnutls.c 38.7 KB
Newer Older
Ted Zlatanov's avatar
Ted Zlatanov committed
1
/* GnuTLS glue for GNU Emacs.
2
   Copyright (C) 2010-2013 Free Software Foundation, Inc.
Ted Zlatanov's avatar
Ted Zlatanov committed
3 4 5 6 7 8 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/>.  */

#include <config.h>
#include <errno.h>

#include "lisp.h"
#include "process.h"

#ifdef HAVE_GNUTLS
#include <gnutls/gnutls.h>

28 29 30 31 32
#ifdef WINDOWSNT
#include <windows.h>
#include "w32.h"
#endif

33
static bool emacs_gnutls_handle_error (gnutls_session_t, int);
34

35
static Lisp_Object Qgnutls_dll;
36 37 38
static Lisp_Object Qgnutls_code;
static Lisp_Object Qgnutls_anon, Qgnutls_x509pki;
static Lisp_Object Qgnutls_e_interrupted, Qgnutls_e_again,
Ted Zlatanov's avatar
Ted Zlatanov committed
39
  Qgnutls_e_invalid_session, Qgnutls_e_not_ready_for_handshake;
40
static bool gnutls_global_initialized;
Ted Zlatanov's avatar
Ted Zlatanov committed
41

42
/* The following are for the property list of `gnutls-boot'.  */
43 44 45 46 47 48 49 50 51 52
static Lisp_Object QCgnutls_bootprop_priority;
static Lisp_Object QCgnutls_bootprop_trustfiles;
static Lisp_Object QCgnutls_bootprop_keylist;
static Lisp_Object QCgnutls_bootprop_crlfiles;
static Lisp_Object QCgnutls_bootprop_callbacks;
static Lisp_Object QCgnutls_bootprop_loglevel;
static Lisp_Object QCgnutls_bootprop_hostname;
static Lisp_Object QCgnutls_bootprop_min_prime_bits;
static Lisp_Object QCgnutls_bootprop_verify_flags;
static Lisp_Object QCgnutls_bootprop_verify_hostname_error;
53 54

/* Callback keys for `gnutls-boot'.  Unused currently.  */
55
static Lisp_Object QCgnutls_bootprop_callbacks_verify;
56

57
static void gnutls_log_function (int, const char *);
58
static void gnutls_audit_log_function (gnutls_session_t, const char *);
59 60 61 62 63 64
static void gnutls_log_function2 (int, const char*, const char*);


#ifdef WINDOWSNT

/* Macro for defining functions that will be loaded from the GnuTLS DLL.  */
65
#define DEF_GNUTLS_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
66 67 68 69 70 71 72 73

/* Macro for loading GnuTLS functions from the library.  */
#define LOAD_GNUTLS_FN(lib,func) {					\
    fn_##func = (void *) GetProcAddress (lib, #func);			\
    if (!fn_##func) return 0;						\
  }

DEF_GNUTLS_FN (gnutls_alert_description_t, gnutls_alert_get,
Andreas Schwab's avatar
Andreas Schwab committed
74
	       (gnutls_session_t));
75
DEF_GNUTLS_FN (const char *, gnutls_alert_get_name,
Andreas Schwab's avatar
Andreas Schwab committed
76
	       (gnutls_alert_description_t));
77 78
DEF_GNUTLS_FN (int, gnutls_alert_send_appropriate, (gnutls_session_t, int));
DEF_GNUTLS_FN (int, gnutls_anon_allocate_client_credentials,
Andreas Schwab's avatar
Andreas Schwab committed
79
	       (gnutls_anon_client_credentials_t *));
80
DEF_GNUTLS_FN (void, gnutls_anon_free_client_credentials,
Andreas Schwab's avatar
Andreas Schwab committed
81
	       (gnutls_anon_client_credentials_t));
82 83
DEF_GNUTLS_FN (int, gnutls_bye, (gnutls_session_t, gnutls_close_request_t));
DEF_GNUTLS_FN (int, gnutls_certificate_allocate_credentials,
Andreas Schwab's avatar
Andreas Schwab committed
84
	       (gnutls_certificate_credentials_t *));
85
DEF_GNUTLS_FN (void, gnutls_certificate_free_credentials,
Andreas Schwab's avatar
Andreas Schwab committed
86
	       (gnutls_certificate_credentials_t));
87
DEF_GNUTLS_FN (const gnutls_datum_t *, gnutls_certificate_get_peers,
Andreas Schwab's avatar
Andreas Schwab committed
88
	       (gnutls_session_t, unsigned int *));
89
DEF_GNUTLS_FN (void, gnutls_certificate_set_verify_flags,
Andreas Schwab's avatar
Andreas Schwab committed
90
	       (gnutls_certificate_credentials_t, unsigned int));
91
DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_crl_file,
Andreas Schwab's avatar
Andreas Schwab committed
92 93
	       (gnutls_certificate_credentials_t, const char *,
		gnutls_x509_crt_fmt_t));
94
DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_key_file,
Andreas Schwab's avatar
Andreas Schwab committed
95 96
	       (gnutls_certificate_credentials_t, const char *, const char *,
		gnutls_x509_crt_fmt_t));
97
DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_trust_file,
Andreas Schwab's avatar
Andreas Schwab committed
98 99
	       (gnutls_certificate_credentials_t, const char *,
		gnutls_x509_crt_fmt_t));
100
DEF_GNUTLS_FN (gnutls_certificate_type_t, gnutls_certificate_type_get,
Andreas Schwab's avatar
Andreas Schwab committed
101
	       (gnutls_session_t));
102
DEF_GNUTLS_FN (int, gnutls_certificate_verify_peers2,
Andreas Schwab's avatar
Andreas Schwab committed
103
	       (gnutls_session_t, unsigned int *));
104
DEF_GNUTLS_FN (int, gnutls_credentials_set,
Andreas Schwab's avatar
Andreas Schwab committed
105
	       (gnutls_session_t, gnutls_credentials_type_t, void *));
106
DEF_GNUTLS_FN (void, gnutls_deinit, (gnutls_session_t));
107
DEF_GNUTLS_FN (void, gnutls_dh_set_prime_bits,
Andreas Schwab's avatar
Andreas Schwab committed
108
	       (gnutls_session_t, unsigned int));
109 110 111
DEF_GNUTLS_FN (int, gnutls_error_is_fatal, (int));
DEF_GNUTLS_FN (int, gnutls_global_init, (void));
DEF_GNUTLS_FN (void, gnutls_global_set_log_function, (gnutls_log_func));
112 113 114
#ifdef HAVE_GNUTLS3
DEF_GNUTLS_FN (void, gnutls_global_set_audit_log_function, (gnutls_audit_log_func));
#endif
115
DEF_GNUTLS_FN (void, gnutls_global_set_log_level, (int));
116 117 118 119
DEF_GNUTLS_FN (void, gnutls_global_set_mem_functions,
	       (gnutls_alloc_function, gnutls_alloc_function,
		gnutls_is_secure_function, gnutls_realloc_function,
		gnutls_free_function));
120 121 122
DEF_GNUTLS_FN (int, gnutls_handshake, (gnutls_session_t));
DEF_GNUTLS_FN (int, gnutls_init, (gnutls_session_t *, gnutls_connection_end_t));
DEF_GNUTLS_FN (int, gnutls_priority_set_direct,
Andreas Schwab's avatar
Andreas Schwab committed
123
	       (gnutls_session_t, const char *, const char **));
124 125 126
DEF_GNUTLS_FN (size_t, gnutls_record_check_pending, (gnutls_session_t));
DEF_GNUTLS_FN (ssize_t, gnutls_record_recv, (gnutls_session_t, void *, size_t));
DEF_GNUTLS_FN (ssize_t, gnutls_record_send,
Andreas Schwab's avatar
Andreas Schwab committed
127
	       (gnutls_session_t, const void *, size_t));
128 129
DEF_GNUTLS_FN (const char *, gnutls_strerror, (int));
DEF_GNUTLS_FN (void, gnutls_transport_set_errno, (gnutls_session_t, int));
130
DEF_GNUTLS_FN (const char *, gnutls_check_version, (const char *));
131 132
DEF_GNUTLS_FN (void, gnutls_transport_set_lowat, (gnutls_session_t, int));
DEF_GNUTLS_FN (void, gnutls_transport_set_ptr2,
Andreas Schwab's avatar
Andreas Schwab committed
133 134
	       (gnutls_session_t, gnutls_transport_ptr_t,
		gnutls_transport_ptr_t));
135
DEF_GNUTLS_FN (void, gnutls_transport_set_pull_function,
Andreas Schwab's avatar
Andreas Schwab committed
136
	       (gnutls_session_t, gnutls_pull_func));
137
DEF_GNUTLS_FN (void, gnutls_transport_set_push_function,
Andreas Schwab's avatar
Andreas Schwab committed
138
	       (gnutls_session_t, gnutls_push_func));
139
DEF_GNUTLS_FN (int, gnutls_x509_crt_check_hostname,
Andreas Schwab's avatar
Andreas Schwab committed
140
	       (gnutls_x509_crt_t, const char *));
141 142
DEF_GNUTLS_FN (void, gnutls_x509_crt_deinit, (gnutls_x509_crt_t));
DEF_GNUTLS_FN (int, gnutls_x509_crt_import,
Andreas Schwab's avatar
Andreas Schwab committed
143 144
	       (gnutls_x509_crt_t, const gnutls_datum_t *,
		gnutls_x509_crt_fmt_t));
145 146
DEF_GNUTLS_FN (int, gnutls_x509_crt_init, (gnutls_x509_crt_t *));

147
static bool
148
init_gnutls_functions (void)
149 150
{
  HMODULE library;
151
  int max_log_level = 1;
152

153
  if (!(library = w32_delayed_load (Qgnutls_dll)))
154
    {
155
      GNUTLS_LOG (1, max_log_level, "GnuTLS library not found");
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
      return 0;
    }

  LOAD_GNUTLS_FN (library, gnutls_alert_get);
  LOAD_GNUTLS_FN (library, gnutls_alert_get_name);
  LOAD_GNUTLS_FN (library, gnutls_alert_send_appropriate);
  LOAD_GNUTLS_FN (library, gnutls_anon_allocate_client_credentials);
  LOAD_GNUTLS_FN (library, gnutls_anon_free_client_credentials);
  LOAD_GNUTLS_FN (library, gnutls_bye);
  LOAD_GNUTLS_FN (library, gnutls_certificate_allocate_credentials);
  LOAD_GNUTLS_FN (library, gnutls_certificate_free_credentials);
  LOAD_GNUTLS_FN (library, gnutls_certificate_get_peers);
  LOAD_GNUTLS_FN (library, gnutls_certificate_set_verify_flags);
  LOAD_GNUTLS_FN (library, gnutls_certificate_set_x509_crl_file);
  LOAD_GNUTLS_FN (library, gnutls_certificate_set_x509_key_file);
  LOAD_GNUTLS_FN (library, gnutls_certificate_set_x509_trust_file);
  LOAD_GNUTLS_FN (library, gnutls_certificate_type_get);
  LOAD_GNUTLS_FN (library, gnutls_certificate_verify_peers2);
  LOAD_GNUTLS_FN (library, gnutls_credentials_set);
  LOAD_GNUTLS_FN (library, gnutls_deinit);
176
  LOAD_GNUTLS_FN (library, gnutls_dh_set_prime_bits);
177 178 179
  LOAD_GNUTLS_FN (library, gnutls_error_is_fatal);
  LOAD_GNUTLS_FN (library, gnutls_global_init);
  LOAD_GNUTLS_FN (library, gnutls_global_set_log_function);
180 181 182
#ifdef HAVE_GNUTLS3
  LOAD_GNUTLS_FN (library, gnutls_global_set_audit_log_function);
#endif
183
  LOAD_GNUTLS_FN (library, gnutls_global_set_log_level);
184
  LOAD_GNUTLS_FN (library, gnutls_global_set_mem_functions);
185 186 187 188 189 190 191 192
  LOAD_GNUTLS_FN (library, gnutls_handshake);
  LOAD_GNUTLS_FN (library, gnutls_init);
  LOAD_GNUTLS_FN (library, gnutls_priority_set_direct);
  LOAD_GNUTLS_FN (library, gnutls_record_check_pending);
  LOAD_GNUTLS_FN (library, gnutls_record_recv);
  LOAD_GNUTLS_FN (library, gnutls_record_send);
  LOAD_GNUTLS_FN (library, gnutls_strerror);
  LOAD_GNUTLS_FN (library, gnutls_transport_set_errno);
193 194 195 196 197
  LOAD_GNUTLS_FN (library, gnutls_check_version);
  /* We don't need to call gnutls_transport_set_lowat in GnuTLS 2.11.1
     and later, and the function was removed entirely in 3.0.0.  */
  if (!fn_gnutls_check_version ("2.11.1"))
    LOAD_GNUTLS_FN (library, gnutls_transport_set_lowat);
198 199 200 201 202 203 204 205
  LOAD_GNUTLS_FN (library, gnutls_transport_set_ptr2);
  LOAD_GNUTLS_FN (library, gnutls_transport_set_pull_function);
  LOAD_GNUTLS_FN (library, gnutls_transport_set_push_function);
  LOAD_GNUTLS_FN (library, gnutls_x509_crt_check_hostname);
  LOAD_GNUTLS_FN (library, gnutls_x509_crt_deinit);
  LOAD_GNUTLS_FN (library, gnutls_x509_crt_import);
  LOAD_GNUTLS_FN (library, gnutls_x509_crt_init);

206
  max_log_level = global_gnutls_log_level;
207

208 209 210 211 212 213
  {
    Lisp_Object name = CAR_SAFE (Fget (Qgnutls_dll, QCloaded_from));
    GNUTLS_LOG2 (1, max_log_level, "GnuTLS library loaded:",
                 STRINGP (name) ? (const char *) SDATA (name) : "unknown");
  }

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
  return 1;
}

#else /* !WINDOWSNT */

#define fn_gnutls_alert_get			gnutls_alert_get
#define fn_gnutls_alert_get_name		gnutls_alert_get_name
#define fn_gnutls_alert_send_appropriate	gnutls_alert_send_appropriate
#define fn_gnutls_anon_allocate_client_credentials gnutls_anon_allocate_client_credentials
#define fn_gnutls_anon_free_client_credentials	gnutls_anon_free_client_credentials
#define fn_gnutls_bye				gnutls_bye
#define fn_gnutls_certificate_allocate_credentials gnutls_certificate_allocate_credentials
#define fn_gnutls_certificate_free_credentials	gnutls_certificate_free_credentials
#define fn_gnutls_certificate_get_peers		gnutls_certificate_get_peers
#define fn_gnutls_certificate_set_verify_flags	gnutls_certificate_set_verify_flags
#define fn_gnutls_certificate_set_x509_crl_file	gnutls_certificate_set_x509_crl_file
230
#define fn_gnutls_certificate_set_x509_key_file gnutls_certificate_set_x509_key_file
231
#define fn_gnutls_certificate_set_x509_trust_file gnutls_certificate_set_x509_trust_file
232 233 234 235
#define fn_gnutls_certificate_type_get		gnutls_certificate_type_get
#define fn_gnutls_certificate_verify_peers2	gnutls_certificate_verify_peers2
#define fn_gnutls_credentials_set		gnutls_credentials_set
#define fn_gnutls_deinit			gnutls_deinit
236
#define fn_gnutls_dh_set_prime_bits		gnutls_dh_set_prime_bits
237 238 239
#define fn_gnutls_error_is_fatal		gnutls_error_is_fatal
#define fn_gnutls_global_init			gnutls_global_init
#define fn_gnutls_global_set_log_function	gnutls_global_set_log_function
240 241 242
#ifdef HAVE_GNUTLS3
#define fn_gnutls_global_set_audit_log_function	gnutls_global_set_audit_log_function
#endif
243
#define fn_gnutls_global_set_log_level		gnutls_global_set_log_level
244
#define fn_gnutls_global_set_mem_functions	gnutls_global_set_mem_functions
245 246 247 248 249 250 251
#define fn_gnutls_handshake			gnutls_handshake
#define fn_gnutls_init				gnutls_init
#define fn_gnutls_priority_set_direct		gnutls_priority_set_direct
#define fn_gnutls_record_check_pending		gnutls_record_check_pending
#define fn_gnutls_record_recv			gnutls_record_recv
#define fn_gnutls_record_send			gnutls_record_send
#define fn_gnutls_strerror			gnutls_strerror
252
#ifdef WINDOWSNT
253
#define fn_gnutls_transport_set_errno		gnutls_transport_set_errno
254
#endif
255 256 257 258 259 260 261 262 263
#define fn_gnutls_transport_set_ptr2		gnutls_transport_set_ptr2
#define fn_gnutls_x509_crt_check_hostname	gnutls_x509_crt_check_hostname
#define fn_gnutls_x509_crt_deinit		gnutls_x509_crt_deinit
#define fn_gnutls_x509_crt_import		gnutls_x509_crt_import
#define fn_gnutls_x509_crt_init			gnutls_x509_crt_init

#endif /* !WINDOWSNT */


264 265 266 267 268 269 270 271 272 273
/* Function to log a simple audit message.  */
static void
gnutls_audit_log_function (gnutls_session_t session, const char* string)
{
  if (global_gnutls_log_level >= 1)
    {
      message ("gnutls.c: [audit] %s", string);
    }
}

274
/* Function to log a simple message.  */
275
static void
276 277 278 279 280
gnutls_log_function (int level, const char* string)
{
  message ("gnutls.c: [%d] %s", level, string);
}

281
/* Function to log a message and a string.  */
282 283 284 285 286 287
static void
gnutls_log_function2 (int level, const char* string, const char* extra)
{
  message ("gnutls.c: [%d] %s %s", level, string, extra);
}

288 289 290 291 292 293 294
/* Function to log a message and an integer.  */
static void
gnutls_log_function2i (int level, const char* string, int extra)
{
  message ("gnutls.c: [%d] %s %d", level, string, extra);
}

295
static int
296 297 298 299 300 301
emacs_gnutls_handshake (struct Lisp_Process *proc)
{
  gnutls_session_t state = proc->gnutls_state;
  int ret;

  if (proc->gnutls_initstage < GNUTLS_STAGE_HANDSHAKE_CANDO)
302
    return -1;
303 304

  if (proc->gnutls_initstage < GNUTLS_STAGE_TRANSPORT_POINTERS_SET)
305
    {
306 307
#ifdef WINDOWSNT
      /* On W32 we cannot transfer socket handles between different runtime
Andreas Schwab's avatar
Andreas Schwab committed
308 309
	 libraries, so we tell GnuTLS to use our special push/pull
	 functions.  */
310
      fn_gnutls_transport_set_ptr2 (state,
Andreas Schwab's avatar
Andreas Schwab committed
311 312
				    (gnutls_transport_ptr_t) proc,
				    (gnutls_transport_ptr_t) proc);
313 314
      fn_gnutls_transport_set_push_function (state, &emacs_gnutls_push);
      fn_gnutls_transport_set_pull_function (state, &emacs_gnutls_pull);
315 316

      /* For non blocking sockets or other custom made pull/push
Andreas Schwab's avatar
Andreas Schwab committed
317 318
	 functions the gnutls_transport_set_lowat must be called, with
	 a zero low water mark value. (GnuTLS 2.10.4 documentation)
319

Andreas Schwab's avatar
Andreas Schwab committed
320 321 322
	 (Note: this is probably not strictly necessary as the lowat
	  value is only used when no custom pull/push functions are
	  set.)  */
323 324 325 326 327 328
      /* According to GnuTLS NEWS file, lowat level has been set to
	 zero by default in version 2.11.1, and the function
	 gnutls_transport_set_lowat was removed from the library in
	 version 2.99.0.  */
      if (!fn_gnutls_check_version ("2.11.1"))
	fn_gnutls_transport_set_lowat (state, 0);
329
#else
330
      /* This is how GnuTLS takes sockets: as file descriptors passed
Andreas Schwab's avatar
Andreas Schwab committed
331 332
	 in.  For an Emacs process socket, infd and outfd are the
	 same but we use this two-argument version for clarity.  */
333
      fn_gnutls_transport_set_ptr2 (state,
Andreas Schwab's avatar
Andreas Schwab committed
334 335
				    (gnutls_transport_ptr_t) (long) proc->infd,
				    (gnutls_transport_ptr_t) (long) proc->outfd);
336
#endif
337

338 339
      proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
    }
340

341 342
  do
    {
343
      ret = fn_gnutls_handshake (state);
344
      emacs_gnutls_handle_error (state, ret);
345
      QUIT;
346
    }
347
  while (ret < 0 && fn_gnutls_error_is_fatal (ret) == 0);
348

349 350 351
  proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;

  if (ret == GNUTLS_E_SUCCESS)
352
    {
353
      /* Here we're finally done.  */
354 355
      proc->gnutls_initstage = GNUTLS_STAGE_READY;
    }
356 357
  else
    {
358
      fn_gnutls_alert_send_appropriate (state, ret);
359 360
    }
  return ret;
361 362
}

363 364 365 366 367 368
int
emacs_gnutls_record_check_pending (gnutls_session_t state)
{
  return fn_gnutls_record_check_pending (state);
}

369
#ifdef WINDOWSNT
370 371 372 373 374
void
emacs_gnutls_transport_set_errno (gnutls_session_t state, int err)
{
  fn_gnutls_transport_set_errno (state, err);
}
375
#endif
376

377 378
ptrdiff_t
emacs_gnutls_write (struct Lisp_Process *proc, const char *buf, ptrdiff_t nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
379
{
380
  ssize_t rtnval = 0;
381
  ptrdiff_t bytes_written;
382 383
  gnutls_session_t state = proc->gnutls_state;

384 385 386 387 388
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
    {
      errno = EAGAIN;
      return 0;
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
389 390 391 392 393

  bytes_written = 0;

  while (nbyte > 0)
    {
394
      rtnval = fn_gnutls_record_send (state, buf, nbyte);
Ted Zlatanov's avatar
Ted Zlatanov committed
395

396
      if (rtnval < 0)
Andreas Schwab's avatar
Andreas Schwab committed
397
	{
398
	  if (rtnval == GNUTLS_E_INTERRUPTED)
Andreas Schwab's avatar
Andreas Schwab committed
399 400
	    continue;
	  else
401 402 403 404 405
	    {
	      /* If we get GNUTLS_E_AGAIN, then set errno
		 appropriately so that send_process retries the
		 correct way instead of erroring out. */
	      if (rtnval == GNUTLS_E_AGAIN)
406
		errno = EAGAIN;
407
	      break;
408
	    }
Andreas Schwab's avatar
Andreas Schwab committed
409
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
410 411 412 413 414 415

      buf += rtnval;
      nbyte -= rtnval;
      bytes_written += rtnval;
    }

416
  emacs_gnutls_handle_error (state, rtnval);
Ted Zlatanov's avatar
Ted Zlatanov committed
417 418 419
  return (bytes_written);
}

420 421
ptrdiff_t
emacs_gnutls_read (struct Lisp_Process *proc, char *buf, ptrdiff_t nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
422
{
423
  ssize_t rtnval;
424 425
  gnutls_session_t state = proc->gnutls_state;

426 427
  int log_level = proc->gnutls_log_level;

428 429
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
    {
430 431 432 433 434 435 436
      /* If the handshake count is under the limit, try the handshake
         again and increment the handshake count.  This count is kept
         per process (connection), not globally.  */
      if (proc->gnutls_handshakes_tried < GNUTLS_EMACS_HANDSHAKES_LIMIT)
        {
          proc->gnutls_handshakes_tried++;
          emacs_gnutls_handshake (proc);
437
          GNUTLS_LOG2i (5, log_level, "Retried handshake",
438 439 440 441 442 443 444
                        proc->gnutls_handshakes_tried);
          return -1;
        }

      GNUTLS_LOG (2, log_level, "Giving up on handshake; resetting retries");
      proc->gnutls_handshakes_tried = 0;
      return 0;
445
    }
446
  rtnval = fn_gnutls_record_recv (state, buf, nbyte);
447 448
  if (rtnval >= 0)
    return rtnval;
449 450 451
  else if (rtnval == GNUTLS_E_UNEXPECTED_PACKET_LENGTH)
    /* The peer closed the connection. */
    return 0;
452
  else if (emacs_gnutls_handle_error (state, rtnval))
453 454
    /* non-fatal error */
    return -1;
455
  else {
Juanma Barranquero's avatar
Juanma Barranquero committed
456
    /* a fatal error occurred */
457
    return 0;
458
  }
Ted Zlatanov's avatar
Ted Zlatanov committed
459 460
}

461 462 463
/* Report a GnuTLS error to the user.
   Return true if the error code was successfully handled.  */
static bool
464 465 466 467
emacs_gnutls_handle_error (gnutls_session_t session, int err)
{
  int max_log_level = 0;

468
  bool ret;
469 470 471 472
  const char *str;

  /* TODO: use a Lisp_Object generated by gnutls_make_error?  */
  if (err >= 0)
473
    return 1;
474

475
  max_log_level = global_gnutls_log_level;
476 477 478

  /* TODO: use gnutls-error-fatalp and gnutls-error-string.  */

479
  str = fn_gnutls_strerror (err);
480 481 482
  if (!str)
    str = "unknown";

483
  if (fn_gnutls_error_is_fatal (err))
484
    {
485
      ret = 0;
486 487 488 489
      GNUTLS_LOG2 (0, max_log_level, "fatal error:", str);
    }
  else
    {
490
      ret = 1;
491 492 493 494 495 496 497 498 499 500 501 502 503 504

      switch (err)
        {
        case GNUTLS_E_AGAIN:
          GNUTLS_LOG2 (3,
                       max_log_level,
                       "retry:",
                       str);
        default:
          GNUTLS_LOG2 (1,
                       max_log_level,
                       "non-fatal error:",
                       str);
        }
505 506 507 508 509
    }

  if (err == GNUTLS_E_WARNING_ALERT_RECEIVED
      || err == GNUTLS_E_FATAL_ALERT_RECEIVED)
    {
510
      int alert = fn_gnutls_alert_get (session);
511
      int level = (err == GNUTLS_E_FATAL_ALERT_RECEIVED) ? 0 : 1;
512
      str = fn_gnutls_alert_get_name (alert);
513 514 515 516 517 518 519 520
      if (!str)
	str = "unknown";

      GNUTLS_LOG2 (level, max_log_level, "Received alert: ", str);
    }
  return ret;
}

Ted Zlatanov's avatar
Ted Zlatanov committed
521 522 523 524
/* convert an integer error to a Lisp_Object; it will be either a
   known symbol like `gnutls_e_interrupted' and `gnutls_e_again' or
   simply the integer value of the error.  GNUTLS_E_SUCCESS is mapped
   to Qt.  */
525
static Lisp_Object
526
gnutls_make_error (int err)
Ted Zlatanov's avatar
Ted Zlatanov committed
527
{
528
  switch (err)
529 530 531 532 533 534 535 536 537 538
    {
    case GNUTLS_E_SUCCESS:
      return Qt;
    case GNUTLS_E_AGAIN:
      return Qgnutls_e_again;
    case GNUTLS_E_INTERRUPTED:
      return Qgnutls_e_interrupted;
    case GNUTLS_E_INVALID_SESSION:
      return Qgnutls_e_invalid_session;
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
539

540
  return make_number (err);
Ted Zlatanov's avatar
Ted Zlatanov committed
541 542
}

543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
Lisp_Object
emacs_gnutls_deinit (Lisp_Object proc)
{
  int log_level;

  CHECK_PROCESS (proc);

  if (XPROCESS (proc)->gnutls_p == 0)
    return Qnil;

  log_level = XPROCESS (proc)->gnutls_log_level;

  if (XPROCESS (proc)->gnutls_x509_cred)
    {
      GNUTLS_LOG (2, log_level, "Deallocating x509 credentials");
      fn_gnutls_certificate_free_credentials (XPROCESS (proc)->gnutls_x509_cred);
      XPROCESS (proc)->gnutls_x509_cred = NULL;
    }

  if (XPROCESS (proc)->gnutls_anon_cred)
    {
      GNUTLS_LOG (2, log_level, "Deallocating anon credentials");
      fn_gnutls_anon_free_client_credentials (XPROCESS (proc)->gnutls_anon_cred);
      XPROCESS (proc)->gnutls_anon_cred = NULL;
    }

Chong Yidong's avatar
Chong Yidong committed
569
  if (XPROCESS (proc)->gnutls_state)
570 571
    {
      fn_gnutls_deinit (XPROCESS (proc)->gnutls_state);
Chong Yidong's avatar
Chong Yidong committed
572 573 574
      XPROCESS (proc)->gnutls_state = NULL;
      if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
	GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT - 1;
575 576 577 578 579 580
    }

  XPROCESS (proc)->gnutls_p = 0;
  return Qt;
}

Ted Zlatanov's avatar
Ted Zlatanov committed
581
DEFUN ("gnutls-get-initstage", Fgnutls_get_initstage, Sgnutls_get_initstage, 1, 1, 0,
582
       doc: /* Return the GnuTLS init stage of process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
583
See also `gnutls-boot'.  */)
584
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
585 586 587 588 589 590 591
{
  CHECK_PROCESS (proc);

  return make_number (GNUTLS_INITSTAGE (proc));
}

DEFUN ("gnutls-errorp", Fgnutls_errorp, Sgnutls_errorp, 1, 1, 0,
592 593 594 595
       doc: /* Return t if ERROR indicates a GnuTLS problem.
ERROR is an integer or a symbol with an integer `gnutls-code' property.
usage: (gnutls-errorp ERROR)  */)
  (Lisp_Object err)
Ted Zlatanov's avatar
Ted Zlatanov committed
596
{
597
  if (EQ (err, Qt)) return Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
598 599 600 601 602

  return Qt;
}

DEFUN ("gnutls-error-fatalp", Fgnutls_error_fatalp, Sgnutls_error_fatalp, 1, 1, 0,
603 604 605 606
       doc: /* Check if ERROR is fatal.
ERROR is an integer or a symbol with an integer `gnutls-code' property.
usage: (gnutls-error-fatalp ERROR)  */)
  (Lisp_Object err)
Ted Zlatanov's avatar
Ted Zlatanov committed
607 608 609 610 611 612 613
{
  Lisp_Object code;

  if (EQ (err, Qt)) return Qnil;

  if (SYMBOLP (err))
    {
614 615 616 617 618 619 620 621 622
      code = Fget (err, Qgnutls_code);
      if (NUMBERP (code))
	{
	  err = code;
	}
      else
	{
	  error ("Symbol has no numeric gnutls-code property");
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
623 624
    }

625
  if (! TYPE_RANGED_INTEGERP (int, err))
Ted Zlatanov's avatar
Ted Zlatanov committed
626 627
    error ("Not an error symbol or code");

628
  if (0 == fn_gnutls_error_is_fatal (XINT (err)))
Ted Zlatanov's avatar
Ted Zlatanov committed
629 630 631 632 633 634
    return Qnil;

  return Qt;
}

DEFUN ("gnutls-error-string", Fgnutls_error_string, Sgnutls_error_string, 1, 1, 0,
635 636 637 638
       doc: /* Return a description of ERROR.
ERROR is an integer or a symbol with an integer `gnutls-code' property.
usage: (gnutls-error-string ERROR)  */)
  (Lisp_Object err)
Ted Zlatanov's avatar
Ted Zlatanov committed
639 640 641 642 643 644 645
{
  Lisp_Object code;

  if (EQ (err, Qt)) return build_string ("Not an error");

  if (SYMBOLP (err))
    {
646 647 648 649 650 651 652 653 654
      code = Fget (err, Qgnutls_code);
      if (NUMBERP (code))
	{
	  err = code;
	}
      else
	{
	  return build_string ("Symbol has no numeric gnutls-code property");
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
655 656
    }

657
  if (! TYPE_RANGED_INTEGERP (int, err))
Ted Zlatanov's avatar
Ted Zlatanov committed
658 659
    return build_string ("Not an error symbol or code");

660
  return build_string (fn_gnutls_strerror (XINT (err)));
Ted Zlatanov's avatar
Ted Zlatanov committed
661 662 663
}

DEFUN ("gnutls-deinit", Fgnutls_deinit, Sgnutls_deinit, 1, 1, 0,
664
       doc: /* Deallocate GnuTLS resources associated with process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
665
See also `gnutls-init'.  */)
666
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
667
{
668
  return emacs_gnutls_deinit (proc);
Ted Zlatanov's avatar
Ted Zlatanov committed
669 670
}

671 672 673 674 675 676 677 678 679 680 681
DEFUN ("gnutls-available-p", Fgnutls_available_p, Sgnutls_available_p, 0, 0, 0,
       doc: /* Return t if GnuTLS is available in this instance of Emacs.  */)
     (void)
{
#ifdef WINDOWSNT
  Lisp_Object found = Fassq (Qgnutls_dll, Vlibrary_cache);
  if (CONSP (found))
    return XCDR (found);
  else
    {
      Lisp_Object status;
682
      status = init_gnutls_functions () ? Qt : Qnil;
683 684 685 686 687 688 689 690 691
      Vlibrary_cache = Fcons (Fcons (Qgnutls_dll, status), Vlibrary_cache);
      return status;
    }
#else
  return Qt;
#endif
}


692 693
/* Initializes global GnuTLS state to defaults.
Call `gnutls-global-deinit' when GnuTLS usage is no longer needed.
Ted Zlatanov's avatar
Ted Zlatanov committed
694
Returns zero on success.  */
695
static Lisp_Object
696
emacs_gnutls_global_init (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
697 698 699
{
  int ret = GNUTLS_E_SUCCESS;

700
  if (!gnutls_global_initialized)
701 702 703 704 705
    {
      fn_gnutls_global_set_mem_functions (xmalloc, xmalloc, NULL,
					  xrealloc, xfree);
      ret = fn_gnutls_global_init ();
    }
706
  gnutls_global_initialized = 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
707 708 709 710

  return gnutls_make_error (ret);
}

711
#if 0
712
/* Deinitializes global GnuTLS state.
Ted Zlatanov's avatar
Ted Zlatanov committed
713
See also `gnutls-global-init'.  */
714
static Lisp_Object
715
emacs_gnutls_global_deinit (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
716
{
717
  if (gnutls_global_initialized)
Ted Zlatanov's avatar
Ted Zlatanov committed
718 719
    gnutls_global_deinit ();

720
  gnutls_global_initialized = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
721 722 723

  return gnutls_make_error (GNUTLS_E_SUCCESS);
}
724
#endif
Ted Zlatanov's avatar
Ted Zlatanov committed
725

726 727
DEFUN ("gnutls-boot", Fgnutls_boot, Sgnutls_boot, 3, 3, 0,
       doc: /* Initialize GnuTLS client for process PROC with TYPE+PROPLIST.
Chong Yidong's avatar
Chong Yidong committed
728
Currently only client mode is supported.  Return a success/failure
Ted Zlatanov's avatar
Ted Zlatanov committed
729 730
value you can check with `gnutls-errorp'.

731 732 733
TYPE is a symbol, either `gnutls-anon' or `gnutls-x509pki'.
PROPLIST is a property list with the following keys:

734 735
:hostname is a string naming the remote host.

736
:priority is a GnuTLS priority string, defaults to "NORMAL".
737

738
:trustfiles is a list of PEM-encoded trust files for `gnutls-x509pki'.
739

740 741 742 743
:crlfiles is a list of PEM-encoded CRL lists for `gnutls-x509pki'.

:keylist is an alist of PEM-encoded key files and PEM-encoded
certificates for `gnutls-x509pki'.
744 745 746

:callbacks is an alist of callback functions, see below.

747
:loglevel is the debug level requested from GnuTLS, try 4.
748

749 750 751 752 753 754
:verify-flags is a bitset as per GnuTLS'
gnutls_certificate_set_verify_flags.

:verify-hostname-error, if non-nil, makes a hostname mismatch an
error.  Otherwise it will be just a warning.

755 756 757
:min-prime-bits is the minimum accepted number of bits the client will
accept in Diffie-Hellman key exchange.

758 759 760
The debug level will be set for this process AND globally for GnuTLS.
So if you set it higher or lower at any point, it affects global
debugging.
Ted Zlatanov's avatar
Ted Zlatanov committed
761 762 763 764 765

Note that the priority is set on the client.  The server does not use
the protocols's priority except for disabling protocols that were not
specified.

766
Processes must be initialized with this function before other GnuTLS
Ted Zlatanov's avatar
Ted Zlatanov committed
767 768 769
functions are used.  This function allocates resources which can only
be deallocated by calling `gnutls-deinit' or by calling it again.

770 771 772
The callbacks alist can have a `verify' key, associated with a
verification function (UNUSED).

Ted Zlatanov's avatar
Ted Zlatanov committed
773
Each authentication type may need additional information in order to
774 775 776
work.  For X.509 PKI (`gnutls-x509pki'), you probably need at least
one trustfile (usually a CA bundle).  */)
  (Lisp_Object proc, Lisp_Object type, Lisp_Object proplist)
Ted Zlatanov's avatar
Ted Zlatanov committed
777 778
{
  int ret = GNUTLS_E_SUCCESS;
779 780
  int max_log_level = 0;

Ted Zlatanov's avatar
Ted Zlatanov committed
781
  gnutls_session_t state;
Chong Yidong's avatar
Chong Yidong committed
782 783
  gnutls_certificate_credentials_t x509_cred = NULL;
  gnutls_anon_client_credentials_t anon_cred = NULL;
Ted Zlatanov's avatar
Ted Zlatanov committed
784
  Lisp_Object global_init;
785
  char const *priority_string_ptr = "NORMAL"; /* default priority string.  */
786
  unsigned int peer_verification;
787
  char* c_hostname;
788 789 790 791

  /* Placeholders for the property list elements.  */
  Lisp_Object priority_string;
  Lisp_Object trustfiles;
792 793
  Lisp_Object crlfiles;
  Lisp_Object keylist;
794
  /* Lisp_Object callbacks; */
795
  Lisp_Object loglevel;
796
  Lisp_Object hostname;
Paul Eggert's avatar
Paul Eggert committed
797
  /* Lisp_Object verify_error; */
798
  Lisp_Object verify_hostname_error;
799
  Lisp_Object prime_bits;
Ted Zlatanov's avatar
Ted Zlatanov committed
800 801 802

  CHECK_PROCESS (proc);
  CHECK_SYMBOL (type);
803 804
  CHECK_LIST (proplist);

805
  if (NILP (Fgnutls_available_p ()))
Paul Eggert's avatar
Paul Eggert committed
806
    error ("GnuTLS not available");
807

Chong Yidong's avatar
Chong Yidong committed
808
  if (!EQ (type, Qgnutls_x509pki) && !EQ (type, Qgnutls_anon))
Paul Eggert's avatar
Paul Eggert committed
809
    error ("Invalid GnuTLS credential type");
Chong Yidong's avatar
Chong Yidong committed
810

811 812 813 814 815 816 817 818
  hostname              = Fplist_get (proplist, QCgnutls_bootprop_hostname);
  priority_string       = Fplist_get (proplist, QCgnutls_bootprop_priority);
  trustfiles            = Fplist_get (proplist, QCgnutls_bootprop_trustfiles);
  keylist               = Fplist_get (proplist, QCgnutls_bootprop_keylist);
  crlfiles              = Fplist_get (proplist, QCgnutls_bootprop_crlfiles);
  loglevel              = Fplist_get (proplist, QCgnutls_bootprop_loglevel);
  verify_hostname_error = Fplist_get (proplist, QCgnutls_bootprop_verify_hostname_error);
  prime_bits            = Fplist_get (proplist, QCgnutls_bootprop_min_prime_bits);
819 820 821 822

  if (!STRINGP (hostname))
    error ("gnutls-boot: invalid :hostname parameter");
  c_hostname = SSDATA (hostname);
Ted Zlatanov's avatar
Ted Zlatanov committed
823 824 825

  state = XPROCESS (proc)->gnutls_state;

826
  if (TYPE_RANGED_INTEGERP (int, loglevel))
827
    {
828
      fn_gnutls_global_set_log_function (gnutls_log_function);
829 830 831
#ifdef HAVE_GNUTLS3
      fn_gnutls_global_set_audit_log_function (gnutls_audit_log_function);
#endif
832
      fn_gnutls_global_set_log_level (XINT (loglevel));
833 834 835
      max_log_level = XINT (loglevel);
      XPROCESS (proc)->gnutls_log_level = max_log_level;
    }
836

Ted Zlatanov's avatar
Ted Zlatanov committed
837
  /* always initialize globals.  */
838
  global_init = emacs_gnutls_global_init ();
Ted Zlatanov's avatar
Ted Zlatanov committed
839 840 841
  if (! NILP (Fgnutls_errorp (global_init)))
    return global_init;

842 843 844
  /* Before allocating new credentials, deallocate any credentials
     that PROC might already have.  */
  emacs_gnutls_deinit (proc);
Ted Zlatanov's avatar
Ted Zlatanov committed
845

846
  /* Mark PROC as a GnuTLS process.  */
Chong Yidong's avatar
Chong Yidong committed
847
  XPROCESS (proc)->gnutls_state = NULL;
848 849
  XPROCESS (proc)->gnutls_x509_cred = NULL;
  XPROCESS (proc)->gnutls_anon_cred = NULL;
Paul Eggert's avatar
Paul Eggert committed
850
  pset_gnutls_cred_type (XPROCESS (proc), type);
Ted Zlatanov's avatar
Ted Zlatanov committed
851 852
  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;

853
  GNUTLS_LOG (1, max_log_level, "allocating credentials");
Ted Zlatanov's avatar
Ted Zlatanov committed
854
  if (EQ (type, Qgnutls_x509pki))
855
    {
Chong Yidong's avatar
Chong Yidong committed
856 857 858
      Lisp_Object verify_flags;
      unsigned int gnutls_verify_flags = GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT;

859
      GNUTLS_LOG (2, max_log_level, "allocating x509 credentials");
860
      fn_gnutls_certificate_allocate_credentials (&x509_cred);
Chong Yidong's avatar
Chong Yidong committed
861
      XPROCESS (proc)->gnutls_x509_cred = x509_cred;
862

Chong Yidong's avatar
Chong Yidong committed
863
      verify_flags = Fplist_get (proplist, QCgnutls_bootprop_verify_flags);
864
      if (NUMBERP (verify_flags))
Andreas Schwab's avatar
Andreas Schwab committed
865 866 867 868
	{
	  gnutls_verify_flags = XINT (verify_flags);
	  GNUTLS_LOG (2, max_log_level, "setting verification flags");
	}
869
      else if (NILP (verify_flags))
Chong Yidong's avatar
Chong Yidong committed
870
	GNUTLS_LOG (2, max_log_level, "using default verification flags");
871
      else
Chong Yidong's avatar
Chong Yidong committed
872 873
	GNUTLS_LOG (2, max_log_level, "ignoring invalid verify-flags");

874
      fn_gnutls_certificate_set_verify_flags (x509_cred, gnutls_verify_flags);
875
    }
Chong Yidong's avatar
Chong Yidong committed
876
  else /* Qgnutls_anon: */
877
    {
878
      GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
879
      fn_gnutls_anon_allocate_client_credentials (&anon_cred);
Chong Yidong's avatar
Chong Yidong committed
880
      XPROCESS (proc)->gnutls_anon_cred = anon_cred;
881
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
882 883 884 885

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;

  if (EQ (type, Qgnutls_x509pki))
886
    {
Chong Yidong's avatar
Chong Yidong committed
887 888 889 890
      /* TODO: GNUTLS_X509_FMT_DER is also an option.  */
      int file_format = GNUTLS_X509_FMT_PEM;
      Lisp_Object tail;

891
      for (tail = trustfiles; CONSP (tail); tail = XCDR (tail))
892
	{
893
	  Lisp_Object trustfile = XCAR (tail);
Andreas Schwab's avatar
Andreas Schwab committed
894 895 896 897 898 899 900 901 902 903 904 905 906 907
	  if (STRINGP (trustfile))
	    {
	      GNUTLS_LOG2 (1, max_log_level, "setting the trustfile: ",
			   SSDATA (trustfile));
	      ret = fn_gnutls_certificate_set_x509_trust_file
		(x509_cred,
		 SSDATA (trustfile),
		 file_format);

	      if (ret < GNUTLS_E_SUCCESS)
		return gnutls_make_error (ret);
	    }
	  else
	    {
Chong Yidong's avatar
Chong Yidong committed
908 909
	      emacs_gnutls_deinit (proc);
	      error ("Invalid trustfile");
Andreas Schwab's avatar
Andreas Schwab committed
910 911
	    }
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
912

913
      for (tail = crlfiles; CONSP (tail); tail = XCDR (tail))
914
	{