gnutls.c 39.9 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
DEF_GNUTLS_FN (void, gnutls_global_set_log_level, (int));
119 120 121 122
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));
123 124 125
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
126
	       (gnutls_session_t, const char *, const char **));
127 128 129
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
130
	       (gnutls_session_t, const void *, size_t));
131 132
DEF_GNUTLS_FN (const char *, gnutls_strerror, (int));
DEF_GNUTLS_FN (void, gnutls_transport_set_errno, (gnutls_session_t, int));
133
DEF_GNUTLS_FN (const char *, gnutls_check_version, (const char *));
134 135
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
136 137
	       (gnutls_session_t, gnutls_transport_ptr_t,
		gnutls_transport_ptr_t));
138
DEF_GNUTLS_FN (void, gnutls_transport_set_pull_function,
Andreas Schwab's avatar
Andreas Schwab committed
139
	       (gnutls_session_t, gnutls_pull_func));
140
DEF_GNUTLS_FN (void, gnutls_transport_set_push_function,
Andreas Schwab's avatar
Andreas Schwab committed
141
	       (gnutls_session_t, gnutls_push_func));
142
DEF_GNUTLS_FN (int, gnutls_x509_crt_check_hostname,
Andreas Schwab's avatar
Andreas Schwab committed
143
	       (gnutls_x509_crt_t, const char *));
144 145
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
146 147
	       (gnutls_x509_crt_t, const gnutls_datum_t *,
		gnutls_x509_crt_fmt_t));
148 149
DEF_GNUTLS_FN (int, gnutls_x509_crt_init, (gnutls_x509_crt_t *));

150
static bool
151
init_gnutls_functions (void)
152 153
{
  HMODULE library;
154
  int max_log_level = 1;
155

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

209
  max_log_level = global_gnutls_log_level;
210

211 212 213 214 215 216
  {
    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");
  }

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


267
#ifdef HAVE_GNUTLS3
268 269 270 271 272 273 274 275 276
/* 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);
    }
}
277
#endif
278

279
/* Function to log a simple message.  */
280
static void
281 282 283 284 285
gnutls_log_function (int level, const char* string)
{
  message ("gnutls.c: [%d] %s", level, string);
}

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

293 294 295 296 297 298 299
/* 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);
}

300
static int
301 302 303 304 305 306
emacs_gnutls_handshake (struct Lisp_Process *proc)
{
  gnutls_session_t state = proc->gnutls_state;
  int ret;

  if (proc->gnutls_initstage < GNUTLS_STAGE_HANDSHAKE_CANDO)
307
    return -1;
308 309

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

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

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

343 344
      proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
    }
345

346 347
  do
    {
348
      ret = fn_gnutls_handshake (state);
349
      emacs_gnutls_handle_error (state, ret);
350
      QUIT;
351
    }
352
  while (ret < 0 && fn_gnutls_error_is_fatal (ret) == 0);
353

354 355 356
  proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;

  if (ret == GNUTLS_E_SUCCESS)
357
    {
358
      /* Here we're finally done.  */
359 360
      proc->gnutls_initstage = GNUTLS_STAGE_READY;
    }
361 362
  else
    {
363
      fn_gnutls_alert_send_appropriate (state, ret);
364 365
    }
  return ret;
366 367
}

368
ptrdiff_t
369 370 371 372 373
emacs_gnutls_record_check_pending (gnutls_session_t state)
{
  return fn_gnutls_record_check_pending (state);
}

374
#ifdef WINDOWSNT
375 376 377 378 379
void
emacs_gnutls_transport_set_errno (gnutls_session_t state, int err)
{
  fn_gnutls_transport_set_errno (state, err);
}
380
#endif
381

382 383
ptrdiff_t
emacs_gnutls_write (struct Lisp_Process *proc, const char *buf, ptrdiff_t nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
384
{
385
  ssize_t rtnval = 0;
386
  ptrdiff_t bytes_written;
387 388
  gnutls_session_t state = proc->gnutls_state;

389 390 391 392 393
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
    {
      errno = EAGAIN;
      return 0;
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
394 395 396 397 398

  bytes_written = 0;

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

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

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

421
  emacs_gnutls_handle_error (state, rtnval);
Ted Zlatanov's avatar
Ted Zlatanov committed
422 423 424
  return (bytes_written);
}

425 426
ptrdiff_t
emacs_gnutls_read (struct Lisp_Process *proc, char *buf, ptrdiff_t nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
427
{
428
  ssize_t rtnval;
429 430
  gnutls_session_t state = proc->gnutls_state;

431 432
  int log_level = proc->gnutls_log_level;

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

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

466 467 468
/* Report a GnuTLS error to the user.
   Return true if the error code was successfully handled.  */
static bool
469 470 471 472
emacs_gnutls_handle_error (gnutls_session_t session, int err)
{
  int max_log_level = 0;

473
  bool ret;
474 475 476 477
  const char *str;

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

480
  max_log_level = global_gnutls_log_level;
481 482 483

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

484
  str = fn_gnutls_strerror (err);
485 486 487
  if (!str)
    str = "unknown";

488
  if (fn_gnutls_error_is_fatal (err))
489
    {
490
      ret = 0;
491 492 493 494
      GNUTLS_LOG2 (0, max_log_level, "fatal error:", str);
    }
  else
    {
495
      ret = 1;
496 497 498 499 500 501 502 503 504 505 506 507 508 509

      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);
        }
510 511 512 513 514
    }

  if (err == GNUTLS_E_WARNING_ALERT_RECEIVED
      || err == GNUTLS_E_FATAL_ALERT_RECEIVED)
    {
515
      int alert = fn_gnutls_alert_get (session);
516
      int level = (err == GNUTLS_E_FATAL_ALERT_RECEIVED) ? 0 : 1;
517
      str = fn_gnutls_alert_get_name (alert);
518 519 520 521 522 523 524 525
      if (!str)
	str = "unknown";

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

Ted Zlatanov's avatar
Ted Zlatanov committed
526 527 528 529
/* 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.  */
530
static Lisp_Object
531
gnutls_make_error (int err)
Ted Zlatanov's avatar
Ted Zlatanov committed
532
{
533
  switch (err)
534 535 536 537 538 539 540 541 542 543
    {
    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
544

545
  return make_number (err);
Ted Zlatanov's avatar
Ted Zlatanov committed
546 547
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
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
574
  if (XPROCESS (proc)->gnutls_state)
575 576
    {
      fn_gnutls_deinit (XPROCESS (proc)->gnutls_state);
Chong Yidong's avatar
Chong Yidong committed
577 578 579
      XPROCESS (proc)->gnutls_state = NULL;
      if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
	GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT - 1;
580 581 582 583 584 585
    }

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

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

  return make_number (GNUTLS_INITSTAGE (proc));
}

DEFUN ("gnutls-errorp", Fgnutls_errorp, Sgnutls_errorp, 1, 1, 0,
597 598 599 600
       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
601
{
602
  if (EQ (err, Qt)) return Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
603 604 605 606 607

  return Qt;
}

DEFUN ("gnutls-error-fatalp", Fgnutls_error_fatalp, Sgnutls_error_fatalp, 1, 1, 0,
608 609 610 611
       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
612 613 614 615 616 617 618
{
  Lisp_Object code;

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

  if (SYMBOLP (err))
    {
619 620 621 622 623 624 625 626 627
      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
628 629
    }

630
  if (! TYPE_RANGED_INTEGERP (int, err))
Ted Zlatanov's avatar
Ted Zlatanov committed
631 632
    error ("Not an error symbol or code");

633
  if (0 == fn_gnutls_error_is_fatal (XINT (err)))
Ted Zlatanov's avatar
Ted Zlatanov committed
634 635 636 637 638 639
    return Qnil;

  return Qt;
}

DEFUN ("gnutls-error-string", Fgnutls_error_string, Sgnutls_error_string, 1, 1, 0,
640 641 642 643
       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
644 645 646 647 648 649 650
{
  Lisp_Object code;

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

  if (SYMBOLP (err))
    {
651 652 653 654 655 656 657 658 659
      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
660 661
    }

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

665
  return build_string (fn_gnutls_strerror (XINT (err)));
Ted Zlatanov's avatar
Ted Zlatanov committed
666 667 668
}

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

676 677 678 679 680 681 682 683 684 685 686
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;
687
      status = init_gnutls_functions () ? Qt : Qnil;
688 689 690 691 692 693 694 695 696
      Vlibrary_cache = Fcons (Fcons (Qgnutls_dll, status), Vlibrary_cache);
      return status;
    }
#else
  return Qt;
#endif
}


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

705
  if (!gnutls_global_initialized)
706 707 708 709 710
    {
      fn_gnutls_global_set_mem_functions (xmalloc, xmalloc, NULL,
					  xrealloc, xfree);
      ret = fn_gnutls_global_init ();
    }
711
  gnutls_global_initialized = 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
712 713 714 715

  return gnutls_make_error (ret);
}

716
#if 0
717
/* Deinitializes global GnuTLS state.
Ted Zlatanov's avatar
Ted Zlatanov committed
718
See also `gnutls-global-init'.  */
719
static Lisp_Object
720
emacs_gnutls_global_deinit (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
721
{
722
  if (gnutls_global_initialized)
Ted Zlatanov's avatar
Ted Zlatanov committed
723 724
    gnutls_global_deinit ();

725
  gnutls_global_initialized = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
726 727 728

  return gnutls_make_error (GNUTLS_E_SUCCESS);
}
729
#endif
Ted Zlatanov's avatar
Ted Zlatanov committed
730

731 732
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
733
Currently only client mode is supported.  Return a success/failure
Ted Zlatanov's avatar
Ted Zlatanov committed
734 735
value you can check with `gnutls-errorp'.

736 737 738
TYPE is a symbol, either `gnutls-anon' or `gnutls-x509pki'.
PROPLIST is a property list with the following keys:

739 740
:hostname is a string naming the remote host.

741
:priority is a GnuTLS priority string, defaults to "NORMAL".
742

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

745 746 747 748
: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'.
749 750 751

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

752
:loglevel is the debug level requested from GnuTLS, try 4.
753

754 755 756
:verify-flags is a bitset as per GnuTLS'
gnutls_certificate_set_verify_flags.

757 758 759 760 761 762
: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.
763

764 765 766
:min-prime-bits is the minimum accepted number of bits the client will
accept in Diffie-Hellman key exchange.

767 768 769
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
770 771 772 773 774

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.

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

779 780 781
The callbacks alist can have a `verify' key, associated with a
verification function (UNUSED).

Ted Zlatanov's avatar
Ted Zlatanov committed
782
Each authentication type may need additional information in order to
783 784 785
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
786 787
{
  int ret = GNUTLS_E_SUCCESS;
788
  int max_log_level = 0;
789
  bool verify_error_all = 0;
790

Ted Zlatanov's avatar
Ted Zlatanov committed
791
  gnutls_session_t state;
Chong Yidong's avatar
Chong Yidong committed
792 793
  gnutls_certificate_credentials_t x509_cred = NULL;
  gnutls_anon_client_credentials_t anon_cred = NULL;
Ted Zlatanov's avatar
Ted Zlatanov committed
794
  Lisp_Object global_init;
795
  char const *priority_string_ptr = "NORMAL"; /* default priority string.  */
796
  unsigned int peer_verification;
797
  char* c_hostname;
798 799 800 801

  /* Placeholders for the property list elements.  */
  Lisp_Object priority_string;
  Lisp_Object trustfiles;
802 803
  Lisp_Object crlfiles;
  Lisp_Object keylist;
804
  /* Lisp_Object callbacks; */
805
  Lisp_Object loglevel;
806
  Lisp_Object hostname;
807
  Lisp_Object verify_error;
808
  Lisp_Object prime_bits;
Ted Zlatanov's avatar
Ted Zlatanov committed
809 810 811

  CHECK_PROCESS (proc);
  CHECK_SYMBOL (type);
812 813
  CHECK_LIST (proplist);

814
  if (NILP (Fgnutls_available_p ()))
Paul Eggert's avatar
Paul Eggert committed
815
    error ("GnuTLS not available");
816

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

820 821 822 823 824 825
  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);
826
  verify_error          = Fplist_get (proplist, QCgnutls_bootprop_verify_error);
827
  prime_bits            = Fplist_get (proplist, QCgnutls_bootprop_min_prime_bits);
828

829 830 831 832 833 834 835 836
  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)");
    }
837

838
  if (!STRINGP (hostname))
839
    error ("gnutls-boot: invalid :hostname parameter (not a string)");
840
  c_hostname = SSDATA (hostname);
Ted Zlatanov's avatar
Ted Zlatanov committed
841 842 843

  state = XPROCESS (proc)->gnutls_state;

844
  if (TYPE_RANGED_INTEGERP (int, loglevel))
845
    {
846
      fn_gnutls_global_set_log_function (gnutls_log_function);
847 848 849
#ifdef HAVE_GNUTLS3
      fn_gnutls_global_set_audit_log_function (gnutls_audit_log_function);
#endif
850
      fn_gnutls_global_set_log_level (XINT (loglevel));
851 852 853
      max_log_level = XINT (loglevel);
      XPROCESS (proc)->gnutls_log_level = max_log_level;
    }
854

Ted Zlatanov's avatar
Ted Zlatanov committed
855
  /* always initialize globals.  */
856
  global_init = emacs_gnutls_global_init ();
Ted Zlatanov's avatar
Ted Zlatanov committed
857 858 859
  if (! NILP (Fgnutls_errorp (global_init)))
    return global_init;

860 861 862
  /* Before allocating new credentials, deallocate any credentials
     that PROC might already have.  */
  emacs_gnutls_deinit (proc);
Ted Zlatanov's avatar
Ted Zlatanov committed
863

864
  /* Mark PROC as a GnuTLS process.  */
Chong Yidong's avatar
Chong Yidong committed
865
  XPROCESS (proc)->gnutls_state = NULL;
866 867
  XPROCESS (proc)->gnutls_x509_cred = NULL;
  XPROCESS (proc)->gnutls_anon_cred = NULL;
Paul Eggert's avatar
Paul Eggert committed
868
  pset_gnutls_cred_type (XPROCESS (proc), type);
Ted Zlatanov's avatar
Ted Zlatanov committed
869 870
  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;

871
  GNUTLS_LOG (1, max_log_level, "allocating credentials");
Ted Zlatanov's avatar
Ted Zlatanov committed
872
  if (EQ (type, Qgnutls_x509pki))
873
    {
Chong Yidong's avatar
Chong Yidong committed
874 875 876
      Lisp_Object verify_flags;
      unsigned int gnutls_verify_flags = GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT;

877
      GNUTLS_LOG (2, max_log_level, "allocating x509 credentials");
878
      fn_gnutls_certificate_allocate_credentials (&x509_cred);
Chong Yidong's avatar
Chong Yidong committed
879
      XPROCESS (proc)->gnutls_x509_cred = x509_cred;
880

Chong Yidong's avatar
Chong Yidong committed
881
      verify_flags = Fplist_get (proplist, QCgnutls_bootprop_verify_flags);
882
      if (NUMBERP (verify_flags))
Andreas Schwab's avatar
Andreas Schwab committed
883 884 885 886
	{
	  gnutls_verify_flags = XINT (verify_flags);
	  GNUTLS_LOG (2, max_log_level, "setting verification flags");
	}
887
      else if (NILP (verify_flags))
Chong Yidong's avatar
Chong Yidong committed
888
	GNUTLS_LOG (2, max_log_level, "using default verification flags");
889
      else
Chong Yidong's avatar
Chong Yidong committed
890 891
	GNUTLS_LOG (2, max_log_level, "ignoring invalid verify-flags");

892
      fn_gnutls_certificate_set_verify_flags (x509_cred, gnutls_verify_flags);
893
    }
Chong Yidong's avatar
Chong Yidong committed
894
  else /* Qgnutls_anon: */
895
    {
896
      GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
897
      fn_gnutls_anon_allocate_client_credentials (&anon_cred);
Chong Yidong's avatar
Chong Yidong committed
898
      XPROCESS (proc)->gnutls_anon_cred = anon_cred;
899
    }