gnutls.c 40.2 KB
Newer Older
Ted Zlatanov's avatar
Ted Zlatanov committed
1
/* GnuTLS glue for GNU Emacs.
2
   Copyright (C) 2010-2014 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

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"
24
#include "coding.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
25 26 27 28

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

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

34
static bool emacs_gnutls_handle_error (gnutls_session_t, int);
35

36
static Lisp_Object Qgnutls_dll;
37 38 39
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
40
  Qgnutls_e_invalid_session, Qgnutls_e_not_ready_for_handshake;
41
static bool gnutls_global_initialized;
Ted Zlatanov's avatar
Ted Zlatanov committed
42

43
/* The following are for the property list of `gnutls-boot'.  */
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;
53
static Lisp_Object QCgnutls_bootprop_verify_error;
54 55

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

58 59
static void gnutls_log_function (int, const char *);
static void gnutls_log_function2 (int, const char*, const char*);
60 61 62
#ifdef HAVE_GNUTLS3
static void gnutls_audit_log_function (gnutls_session_t, const char *);
#endif
63 64 65 66 67


#ifdef WINDOWSNT

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

/* 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
77
	       (gnutls_session_t));
78
DEF_GNUTLS_FN (const char *, gnutls_alert_get_name,
Andreas Schwab's avatar
Andreas Schwab committed
79
	       (gnutls_alert_description_t));
80 81
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
82
	       (gnutls_anon_client_credentials_t *));
83
DEF_GNUTLS_FN (void, gnutls_anon_free_client_credentials,
Andreas Schwab's avatar
Andreas Schwab committed
84
	       (gnutls_anon_client_credentials_t));
85 86
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
87
	       (gnutls_certificate_credentials_t *));
88
DEF_GNUTLS_FN (void, gnutls_certificate_free_credentials,
Andreas Schwab's avatar
Andreas Schwab committed
89
	       (gnutls_certificate_credentials_t));
90
DEF_GNUTLS_FN (const gnutls_datum_t *, gnutls_certificate_get_peers,
Andreas Schwab's avatar
Andreas Schwab committed
91
	       (gnutls_session_t, unsigned int *));
92
DEF_GNUTLS_FN (void, gnutls_certificate_set_verify_flags,
Andreas Schwab's avatar
Andreas Schwab committed
93
	       (gnutls_certificate_credentials_t, unsigned int));
94
DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_crl_file,
Andreas Schwab's avatar
Andreas Schwab committed
95 96
	       (gnutls_certificate_credentials_t, const char *,
		gnutls_x509_crt_fmt_t));
97
DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_key_file,
Andreas Schwab's avatar
Andreas Schwab committed
98 99
	       (gnutls_certificate_credentials_t, const char *, const char *,
		gnutls_x509_crt_fmt_t));
100
DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_trust_file,
Andreas Schwab's avatar
Andreas Schwab committed
101 102
	       (gnutls_certificate_credentials_t, const char *,
		gnutls_x509_crt_fmt_t));
103
DEF_GNUTLS_FN (gnutls_certificate_type_t, gnutls_certificate_type_get,
Andreas Schwab's avatar
Andreas Schwab committed
104
	       (gnutls_session_t));
105
DEF_GNUTLS_FN (int, gnutls_certificate_verify_peers2,
Andreas Schwab's avatar
Andreas Schwab committed
106
	       (gnutls_session_t, unsigned int *));
107
DEF_GNUTLS_FN (int, gnutls_credentials_set,
Andreas Schwab's avatar
Andreas Schwab committed
108
	       (gnutls_session_t, gnutls_credentials_type_t, void *));
109
DEF_GNUTLS_FN (void, gnutls_deinit, (gnutls_session_t));
110
DEF_GNUTLS_FN (void, gnutls_dh_set_prime_bits,
Andreas Schwab's avatar
Andreas Schwab committed
111
	       (gnutls_session_t, unsigned int));
112 113 114
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));
115 116 117
#ifdef HAVE_GNUTLS3
DEF_GNUTLS_FN (void, gnutls_global_set_audit_log_function, (gnutls_audit_log_func));
#endif
118 119
DEF_GNUTLS_FN (void, gnutls_global_set_log_level, (int));
DEF_GNUTLS_FN (int, gnutls_handshake, (gnutls_session_t));
120
DEF_GNUTLS_FN (int, gnutls_init, (gnutls_session_t *, unsigned int));
121
DEF_GNUTLS_FN (int, gnutls_priority_set_direct,
Andreas Schwab's avatar
Andreas Schwab committed
122
	       (gnutls_session_t, const char *, const char **));
123 124 125
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
126
	       (gnutls_session_t, const void *, size_t));
127 128
DEF_GNUTLS_FN (const char *, gnutls_strerror, (int));
DEF_GNUTLS_FN (void, gnutls_transport_set_errno, (gnutls_session_t, int));
129
DEF_GNUTLS_FN (const char *, gnutls_check_version, (const char *));
130 131
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
132 133
	       (gnutls_session_t, gnutls_transport_ptr_t,
		gnutls_transport_ptr_t));
134
DEF_GNUTLS_FN (void, gnutls_transport_set_pull_function,
Andreas Schwab's avatar
Andreas Schwab committed
135
	       (gnutls_session_t, gnutls_pull_func));
136
DEF_GNUTLS_FN (void, gnutls_transport_set_push_function,
Andreas Schwab's avatar
Andreas Schwab committed
137
	       (gnutls_session_t, gnutls_push_func));
138
DEF_GNUTLS_FN (int, gnutls_x509_crt_check_hostname,
Andreas Schwab's avatar
Andreas Schwab committed
139
	       (gnutls_x509_crt_t, const char *));
140 141
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
142 143
	       (gnutls_x509_crt_t, const gnutls_datum_t *,
		gnutls_x509_crt_fmt_t));
144 145
DEF_GNUTLS_FN (int, gnutls_x509_crt_init, (gnutls_x509_crt_t *));

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

152
  if (!(library = w32_delayed_load (Qgnutls_dll)))
153
    {
154
      GNUTLS_LOG (1, max_log_level, "GnuTLS library not found");
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
      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);
175
  LOAD_GNUTLS_FN (library, gnutls_dh_set_prime_bits);
176 177 178
  LOAD_GNUTLS_FN (library, gnutls_error_is_fatal);
  LOAD_GNUTLS_FN (library, gnutls_global_init);
  LOAD_GNUTLS_FN (library, gnutls_global_set_log_function);
179 180 181
#ifdef HAVE_GNUTLS3
  LOAD_GNUTLS_FN (library, gnutls_global_set_audit_log_function);
#endif
182 183 184 185 186 187 188 189 190
  LOAD_GNUTLS_FN (library, gnutls_global_set_log_level);
  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);
191 192 193 194 195
  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);
196 197 198 199 200 201 202 203
  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);

204
  max_log_level = global_gnutls_log_level;
205

206 207 208 209 210 211
  {
    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");
  }

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  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
228
#define fn_gnutls_certificate_set_x509_key_file gnutls_certificate_set_x509_key_file
229
#define fn_gnutls_certificate_set_x509_trust_file gnutls_certificate_set_x509_trust_file
230 231 232 233
#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
234
#define fn_gnutls_dh_set_prime_bits		gnutls_dh_set_prime_bits
235 236 237
#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
238 239 240
#ifdef HAVE_GNUTLS3
#define fn_gnutls_global_set_audit_log_function	gnutls_global_set_audit_log_function
#endif
241 242 243 244 245 246 247 248
#define fn_gnutls_global_set_log_level		gnutls_global_set_log_level
#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
249
#ifdef WINDOWSNT
250
#define fn_gnutls_transport_set_errno		gnutls_transport_set_errno
251
#endif
252 253 254 255 256 257 258 259 260
#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 */


261 262 263 264 265 266 267 268 269 270 271
/* Report memory exhaustion if ERR is an out-of-memory indication.  */
static void
check_memory_full (int err)
{
  /* When GnuTLS exhausts memory, it doesn't say how much memory it
     asked for, so tell the Emacs allocator that GnuTLS asked for no
     bytes.  This isn't accurate, but it's good enough.  */
  if (err == GNUTLS_E_MEMORY_ERROR)
    memory_full (0);
}

272
#ifdef HAVE_GNUTLS3
273 274 275 276 277 278 279 280 281
/* 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);
    }
}
282
#endif
283

284
/* Function to log a simple message.  */
285
static void
286 287 288 289 290
gnutls_log_function (int level, const char* string)
{
  message ("gnutls.c: [%d] %s", level, string);
}

291
/* Function to log a message and a string.  */
292 293 294 295 296 297
static void
gnutls_log_function2 (int level, const char* string, const char* extra)
{
  message ("gnutls.c: [%d] %s %s", level, string, extra);
}

298 299 300 301 302 303 304
/* 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);
}

305
static int
306 307 308 309 310 311
emacs_gnutls_handshake (struct Lisp_Process *proc)
{
  gnutls_session_t state = proc->gnutls_state;
  int ret;

  if (proc->gnutls_initstage < GNUTLS_STAGE_HANDSHAKE_CANDO)
312
    return -1;
313 314

  if (proc->gnutls_initstage < GNUTLS_STAGE_TRANSPORT_POINTERS_SET)
315
    {
316 317
#ifdef WINDOWSNT
      /* On W32 we cannot transfer socket handles between different runtime
Andreas Schwab's avatar
Andreas Schwab committed
318 319
	 libraries, so we tell GnuTLS to use our special push/pull
	 functions.  */
320
      fn_gnutls_transport_set_ptr2 (state,
Andreas Schwab's avatar
Andreas Schwab committed
321 322
				    (gnutls_transport_ptr_t) proc,
				    (gnutls_transport_ptr_t) proc);
323 324
      fn_gnutls_transport_set_push_function (state, &emacs_gnutls_push);
      fn_gnutls_transport_set_pull_function (state, &emacs_gnutls_pull);
325 326

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

Andreas Schwab's avatar
Andreas Schwab committed
330 331 332
	 (Note: this is probably not strictly necessary as the lowat
	  value is only used when no custom pull/push functions are
	  set.)  */
333 334 335 336 337 338
      /* 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);
339
#else
340
      /* This is how GnuTLS takes sockets: as file descriptors passed
Andreas Schwab's avatar
Andreas Schwab committed
341 342
	 in.  For an Emacs process socket, infd and outfd are the
	 same but we use this two-argument version for clarity.  */
343
      fn_gnutls_transport_set_ptr2 (state,
Andreas Schwab's avatar
Andreas Schwab committed
344 345
				    (gnutls_transport_ptr_t) (long) proc->infd,
				    (gnutls_transport_ptr_t) (long) proc->outfd);
346
#endif
347

348 349
      proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
    }
350

351 352
  do
    {
353
      ret = fn_gnutls_handshake (state);
354
      emacs_gnutls_handle_error (state, ret);
355
      QUIT;
356
    }
357
  while (ret < 0 && fn_gnutls_error_is_fatal (ret) == 0);
358

359 360 361
  proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;

  if (ret == GNUTLS_E_SUCCESS)
362
    {
363
      /* Here we're finally done.  */
364 365
      proc->gnutls_initstage = GNUTLS_STAGE_READY;
    }
366 367
  else
    {
368
      check_memory_full (fn_gnutls_alert_send_appropriate (state, ret));
369 370
    }
  return ret;
371 372
}

373
ptrdiff_t
374 375 376 377 378
emacs_gnutls_record_check_pending (gnutls_session_t state)
{
  return fn_gnutls_record_check_pending (state);
}

379
#ifdef WINDOWSNT
380 381 382 383 384
void
emacs_gnutls_transport_set_errno (gnutls_session_t state, int err)
{
  fn_gnutls_transport_set_errno (state, err);
}
385
#endif
386

387 388
ptrdiff_t
emacs_gnutls_write (struct Lisp_Process *proc, const char *buf, ptrdiff_t nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
389
{
390
  ssize_t rtnval = 0;
391
  ptrdiff_t bytes_written;
392 393
  gnutls_session_t state = proc->gnutls_state;

394 395 396 397 398
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
    {
      errno = EAGAIN;
      return 0;
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
399 400 401 402 403

  bytes_written = 0;

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

406
      if (rtnval < 0)
Andreas Schwab's avatar
Andreas Schwab committed
407
	{
408
	  if (rtnval == GNUTLS_E_INTERRUPTED)
Andreas Schwab's avatar
Andreas Schwab committed
409 410
	    continue;
	  else
411 412 413 414 415
	    {
	      /* 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)
416
		errno = EAGAIN;
417
	      break;
418
	    }
Andreas Schwab's avatar
Andreas Schwab committed
419
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
420 421 422 423 424 425

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

426
  emacs_gnutls_handle_error (state, rtnval);
Ted Zlatanov's avatar
Ted Zlatanov committed
427 428 429
  return (bytes_written);
}

430 431
ptrdiff_t
emacs_gnutls_read (struct Lisp_Process *proc, char *buf, ptrdiff_t nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
432
{
433
  ssize_t rtnval;
434 435
  gnutls_session_t state = proc->gnutls_state;

436 437
  int log_level = proc->gnutls_log_level;

438 439
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
    {
440 441 442 443 444 445 446
      /* 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);
447
          GNUTLS_LOG2i (5, log_level, "Retried handshake",
448 449 450 451 452 453 454
                        proc->gnutls_handshakes_tried);
          return -1;
        }

      GNUTLS_LOG (2, log_level, "Giving up on handshake; resetting retries");
      proc->gnutls_handshakes_tried = 0;
      return 0;
455
    }
456
  rtnval = fn_gnutls_record_recv (state, buf, nbyte);
457 458
  if (rtnval >= 0)
    return rtnval;
459 460 461
  else if (rtnval == GNUTLS_E_UNEXPECTED_PACKET_LENGTH)
    /* The peer closed the connection. */
    return 0;
462
  else if (emacs_gnutls_handle_error (state, rtnval))
463 464
    /* non-fatal error */
    return -1;
465
  else {
Juanma Barranquero's avatar
Juanma Barranquero committed
466
    /* a fatal error occurred */
467
    return 0;
468
  }
Ted Zlatanov's avatar
Ted Zlatanov committed
469 470
}

471 472 473
/* Report a GnuTLS error to the user.
   Return true if the error code was successfully handled.  */
static bool
474 475 476 477
emacs_gnutls_handle_error (gnutls_session_t session, int err)
{
  int max_log_level = 0;

478
  bool ret;
479 480 481 482
  const char *str;

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

485 486
  check_memory_full (err);

487
  max_log_level = global_gnutls_log_level;
488 489 490

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

491
  str = fn_gnutls_strerror (err);
492 493 494
  if (!str)
    str = "unknown";

495
  if (fn_gnutls_error_is_fatal (err))
496
    {
497
      ret = 0;
498 499 500 501
      GNUTLS_LOG2 (0, max_log_level, "fatal error:", str);
    }
  else
    {
502
      ret = 1;
503 504 505 506 507 508 509 510 511 512 513 514 515 516

      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);
        }
517 518 519 520 521
    }

  if (err == GNUTLS_E_WARNING_ALERT_RECEIVED
      || err == GNUTLS_E_FATAL_ALERT_RECEIVED)
    {
522
      int alert = fn_gnutls_alert_get (session);
523
      int level = (err == GNUTLS_E_FATAL_ALERT_RECEIVED) ? 0 : 1;
524
      str = fn_gnutls_alert_get_name (alert);
525 526 527 528 529 530 531 532
      if (!str)
	str = "unknown";

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

Ted Zlatanov's avatar
Ted Zlatanov committed
533 534 535 536
/* 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.  */
537
static Lisp_Object
538
gnutls_make_error (int err)
Ted Zlatanov's avatar
Ted Zlatanov committed
539
{
540
  switch (err)
541 542 543 544 545 546 547 548 549 550
    {
    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
551

552
  check_memory_full (err);
553
  return make_number (err);
Ted Zlatanov's avatar
Ted Zlatanov committed
554 555
}

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
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
582
  if (XPROCESS (proc)->gnutls_state)
583 584
    {
      fn_gnutls_deinit (XPROCESS (proc)->gnutls_state);
Chong Yidong's avatar
Chong Yidong committed
585 586 587
      XPROCESS (proc)->gnutls_state = NULL;
      if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
	GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT - 1;
588 589 590 591 592 593
    }

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

Ted Zlatanov's avatar
Ted Zlatanov committed
594
DEFUN ("gnutls-get-initstage", Fgnutls_get_initstage, Sgnutls_get_initstage, 1, 1, 0,
595
       doc: /* Return the GnuTLS init stage of process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
596
See also `gnutls-boot'.  */)
597
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
598 599 600 601 602 603 604
{
  CHECK_PROCESS (proc);

  return make_number (GNUTLS_INITSTAGE (proc));
}

DEFUN ("gnutls-errorp", Fgnutls_errorp, Sgnutls_errorp, 1, 1, 0,
605 606 607 608
       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
609
{
610
  if (EQ (err, Qt)) return Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
611 612 613 614 615

  return Qt;
}

DEFUN ("gnutls-error-fatalp", Fgnutls_error_fatalp, Sgnutls_error_fatalp, 1, 1, 0,
616 617 618 619
       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
620 621 622 623 624 625 626
{
  Lisp_Object code;

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

  if (SYMBOLP (err))
    {
627 628 629 630 631 632 633 634 635
      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
636 637
    }

638
  if (! TYPE_RANGED_INTEGERP (int, err))
Ted Zlatanov's avatar
Ted Zlatanov committed
639 640
    error ("Not an error symbol or code");

641
  if (0 == fn_gnutls_error_is_fatal (XINT (err)))
Ted Zlatanov's avatar
Ted Zlatanov committed
642 643 644 645 646 647
    return Qnil;

  return Qt;
}

DEFUN ("gnutls-error-string", Fgnutls_error_string, Sgnutls_error_string, 1, 1, 0,
648 649 650 651
       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
652 653 654 655 656 657 658
{
  Lisp_Object code;

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

  if (SYMBOLP (err))
    {
659 660 661 662 663 664 665 666 667
      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
668 669
    }

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

673
  return build_string (fn_gnutls_strerror (XINT (err)));
Ted Zlatanov's avatar
Ted Zlatanov committed
674 675 676
}

DEFUN ("gnutls-deinit", Fgnutls_deinit, Sgnutls_deinit, 1, 1, 0,
677
       doc: /* Deallocate GnuTLS resources associated with process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
678
See also `gnutls-init'.  */)
679
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
680
{
681
  return emacs_gnutls_deinit (proc);
Ted Zlatanov's avatar
Ted Zlatanov committed
682 683
}

684 685
/* Initializes global GnuTLS state to defaults.
Call `gnutls-global-deinit' when GnuTLS usage is no longer needed.
Ted Zlatanov's avatar
Ted Zlatanov committed
686
Returns zero on success.  */
687
static Lisp_Object
688
emacs_gnutls_global_init (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
689 690 691
{
  int ret = GNUTLS_E_SUCCESS;

692
  if (!gnutls_global_initialized)
693 694
    ret = fn_gnutls_global_init ();

695
  gnutls_global_initialized = 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
696 697 698 699

  return gnutls_make_error (ret);
}

700
#if 0
701
/* Deinitializes global GnuTLS state.
Ted Zlatanov's avatar
Ted Zlatanov committed
702
See also `gnutls-global-init'.  */
703
static Lisp_Object
704
emacs_gnutls_global_deinit (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
705
{
706
  if (gnutls_global_initialized)
Ted Zlatanov's avatar
Ted Zlatanov committed
707 708
    gnutls_global_deinit ();

709
  gnutls_global_initialized = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
710 711 712

  return gnutls_make_error (GNUTLS_E_SUCCESS);
}
713
#endif
Ted Zlatanov's avatar
Ted Zlatanov committed
714

715 716
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
717
Currently only client mode is supported.  Return a success/failure
Ted Zlatanov's avatar
Ted Zlatanov committed
718 719
value you can check with `gnutls-errorp'.

720 721 722
TYPE is a symbol, either `gnutls-anon' or `gnutls-x509pki'.
PROPLIST is a property list with the following keys:

723 724
:hostname is a string naming the remote host.

725
:priority is a GnuTLS priority string, defaults to "NORMAL".
726

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

729 730 731 732
: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'.
733 734 735

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

736
:loglevel is the debug level requested from GnuTLS, try 4.
737

738 739 740
:verify-flags is a bitset as per GnuTLS'
gnutls_certificate_set_verify_flags.

741 742 743 744 745 746
:verify-hostname-error is ignored.  Pass :hostname in :verify-error
instead.

:verify-error is a list of symbols to express verification checks or
`t' to do all checks.  Currently it can contain `:trustfiles' and
`:hostname' to verify the certificate or the hostname respectively.
747

748 749 750
:min-prime-bits is the minimum accepted number of bits the client will
accept in Diffie-Hellman key exchange.

751 752 753
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
754 755 756 757 758

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.

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

763 764 765
The callbacks alist can have a `verify' key, associated with a
verification function (UNUSED).

Ted Zlatanov's avatar
Ted Zlatanov committed
766
Each authentication type may need additional information in order to
767 768 769
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
770 771
{
  int ret = GNUTLS_E_SUCCESS;
772
  int max_log_level = 0;
773
  bool verify_error_all = 0;
774

Ted Zlatanov's avatar
Ted Zlatanov committed
775
  gnutls_session_t state;
Chong Yidong's avatar
Chong Yidong committed
776 777
  gnutls_certificate_credentials_t x509_cred = NULL;
  gnutls_anon_client_credentials_t anon_cred = NULL;
Ted Zlatanov's avatar
Ted Zlatanov committed
778
  Lisp_Object global_init;
779
  char const *priority_string_ptr = "NORMAL"; /* default priority string.  */
780
  unsigned int peer_verification;
781
  char* c_hostname;
782 783 784 785

  /* Placeholders for the property list elements.  */
  Lisp_Object priority_string;
  Lisp_Object trustfiles;
786 787
  Lisp_Object crlfiles;
  Lisp_Object keylist;
788
  /* Lisp_Object callbacks; */
789
  Lisp_Object loglevel;
790
  Lisp_Object hostname;
791
  Lisp_Object verify_error;
792
  Lisp_Object prime_bits;
Ted Zlatanov's avatar
Ted Zlatanov committed
793 794 795

  CHECK_PROCESS (proc);
  CHECK_SYMBOL (type);
796 797
  CHECK_LIST (proplist);

798
  if (NILP (Fgnutls_available_p ()))
Paul Eggert's avatar
Paul Eggert committed
799
    error ("GnuTLS not available");
800

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

804 805 806 807 808 809
  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);
810
  verify_error          = Fplist_get (proplist, QCgnutls_bootprop_verify_error);
811
  prime_bits            = Fplist_get (proplist, QCgnutls_bootprop_min_prime_bits);
812

813 814 815 816 817 818 819 820
  if (EQ (verify_error, Qt))
    {
      verify_error_all = 1;
    }
  else if (NILP (Flistp (verify_error)))
    {
      error ("gnutls-boot: invalid :verify_error parameter (not a list)");
    }
821

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

  state = XPROCESS (proc)->gnutls_state;

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

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

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

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

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

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

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

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;

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

895
      for (tail = trustfiles; CONSP (tail); tail = XCDR (tail))
896
	{