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

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 <setjmp.h>

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

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

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

static int
emacs_gnutls_handle_error (gnutls_session_t, int err);

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

44
/* The following are for the property list of `gnutls-boot'.  */
45 46 47 48 49 50 51 52 53
static Lisp_Object Qgnutls_bootprop_priority;
static Lisp_Object Qgnutls_bootprop_trustfiles;
static Lisp_Object Qgnutls_bootprop_keyfiles;
static Lisp_Object Qgnutls_bootprop_callbacks;
static Lisp_Object Qgnutls_bootprop_loglevel;
static Lisp_Object Qgnutls_bootprop_hostname;
static Lisp_Object Qgnutls_bootprop_verify_flags;
static Lisp_Object Qgnutls_bootprop_verify_error;
static Lisp_Object Qgnutls_bootprop_verify_hostname_error;
54 55

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

58
static void
59 60 61 62 63 64 65 66 67 68 69 70
gnutls_log_function (int level, const char* string)
{
  message ("gnutls.c: [%d] %s", level, string);
}

static void
gnutls_log_function2 (int level, const char* string, const char* extra)
{
  message ("gnutls.c: [%d] %s %s", level, string, extra);
}

static int
71 72 73 74 75 76
emacs_gnutls_handshake (struct Lisp_Process *proc)
{
  gnutls_session_t state = proc->gnutls_state;
  int ret;

  if (proc->gnutls_initstage < GNUTLS_STAGE_HANDSHAKE_CANDO)
77
    return -1;
78 79

  if (proc->gnutls_initstage < GNUTLS_STAGE_TRANSPORT_POINTERS_SET)
80
    {
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
#ifdef WINDOWSNT
      /* On W32 we cannot transfer socket handles between different runtime
         libraries, so we tell GnuTLS to use our special push/pull
         functions.  */
      gnutls_transport_set_ptr2 (state,
                                 (gnutls_transport_ptr_t) proc,
                                 (gnutls_transport_ptr_t) proc);
      gnutls_transport_set_push_function (state, &emacs_gnutls_push);
      gnutls_transport_set_pull_function (state, &emacs_gnutls_pull);

      /* For non blocking sockets or other custom made pull/push
         functions the gnutls_transport_set_lowat must be called, with
         a zero low water mark value. (GnuTLS 2.10.4 documentation)

         (Note: this is probably not strictly necessary as the lowat
          value is only used when no custom pull/push functions are
          set.)  */
      gnutls_transport_set_lowat (state, 0);
#else
100 101 102
      /* This is how GnuTLS takes sockets: as file descriptors passed
         in.  For an Emacs process socket, infd and outfd are the
         same but we use this two-argument version for clarity.  */
103
      gnutls_transport_set_ptr2 (state,
104 105
        			 (gnutls_transport_ptr_t) (long) proc->infd,
        			 (gnutls_transport_ptr_t) (long) proc->outfd);
106
#endif
107

108 109
      proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
    }
110

111 112 113 114 115 116 117
  do
    {
      ret = gnutls_handshake (state);
      emacs_gnutls_handle_error (state, ret);
    }
  while (ret < 0 && gnutls_error_is_fatal (ret) == 0);

118 119 120
  proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;

  if (ret == GNUTLS_E_SUCCESS)
121
    {
122
      /* Here we're finally done.  */
123 124
      proc->gnutls_initstage = GNUTLS_STAGE_READY;
    }
125 126 127 128 129
  else
    {
        gnutls_alert_send_appropriate (state, ret);
    }
  return ret;
130 131
}

132
EMACS_INT
133
emacs_gnutls_write (int fildes, struct Lisp_Process *proc, const char *buf,
134
                    EMACS_INT nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
135
{
136
  ssize_t rtnval = 0;
137
  EMACS_INT bytes_written;
138 139
  gnutls_session_t state = proc->gnutls_state;

140 141 142 143 144 145 146
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY) {
#ifdef EWOULDBLOCK
    errno = EWOULDBLOCK;
#endif
#ifdef EAGAIN
    errno = EAGAIN;
#endif
147
    return 0;
148
  }
Ted Zlatanov's avatar
Ted Zlatanov committed
149 150 151 152 153 154 155

  bytes_written = 0;

  while (nbyte > 0)
    {
      rtnval = gnutls_write (state, buf, nbyte);

156
      if (rtnval < 0)
Ted Zlatanov's avatar
Ted Zlatanov committed
157
        {
158
          if (rtnval == GNUTLS_E_AGAIN || rtnval == GNUTLS_E_INTERRUPTED)
Ted Zlatanov's avatar
Ted Zlatanov committed
159 160
            continue;
          else
161
            break;
Ted Zlatanov's avatar
Ted Zlatanov committed
162 163 164 165 166 167 168
        }

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

169
  emacs_gnutls_handle_error (state, rtnval);
Ted Zlatanov's avatar
Ted Zlatanov committed
170 171 172
  return (bytes_written);
}

173
EMACS_INT
174
emacs_gnutls_read (int fildes, struct Lisp_Process *proc, char *buf,
175
                   EMACS_INT nbyte)
Ted Zlatanov's avatar
Ted Zlatanov committed
176
{
177
  ssize_t rtnval;
178 179
  gnutls_session_t state = proc->gnutls_state;

180 181 182 183 184
  if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
    {
      emacs_gnutls_handshake (proc);
      return -1;
    }
185 186 187
  rtnval = gnutls_read (state, buf, nbyte);
  if (rtnval >= 0)
    return rtnval;
188 189 190
  else if (emacs_gnutls_handle_error (state, rtnval) == 0)
    /* non-fatal error */
    return -1;
191
  else {
192 193
    /* a fatal error occured */
    return 0;
194
  }
Ted Zlatanov's avatar
Ted Zlatanov committed
195 196
}

197 198 199 200 201 202 203 204
/* report a GnuTLS error to the user.
   Returns zero if the error code was successfully handled. */
static int
emacs_gnutls_handle_error (gnutls_session_t session, int err)
{
  Lisp_Object gnutls_log_level = Fsymbol_value (Qgnutls_log_level);
  int max_log_level = 0;

205
  int ret;
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
  const char *str;

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

  if (NUMBERP (gnutls_log_level))
    max_log_level = XINT (gnutls_log_level);

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

  str = gnutls_strerror (err);
  if (!str)
    str = "unknown";

  if (gnutls_error_is_fatal (err))
    {
      ret = err;
      GNUTLS_LOG2 (0, max_log_level, "fatal error:", str);
    }
  else
    {
      ret = 0;
      GNUTLS_LOG2 (1, max_log_level, "non-fatal error:", str);
      /* TODO: EAGAIN AKA Qgnutls_e_again should be level 2.  */
    }

  if (err == GNUTLS_E_WARNING_ALERT_RECEIVED
      || err == GNUTLS_E_FATAL_ALERT_RECEIVED)
    {
      int alert = gnutls_alert_get (session);
      int level = (err == GNUTLS_E_FATAL_ALERT_RECEIVED) ? 0 : 1;
      str = gnutls_alert_get_name (alert);
      if (!str)
	str = "unknown";

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

Ted Zlatanov's avatar
Ted Zlatanov committed
247 248 249 250
/* 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.  */
251
static Lisp_Object
252
gnutls_make_error (int err)
Ted Zlatanov's avatar
Ted Zlatanov committed
253
{
254
  switch (err)
255 256 257 258 259 260 261 262 263 264
    {
    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
265

266
  return make_number (err);
Ted Zlatanov's avatar
Ted Zlatanov committed
267 268 269
}

DEFUN ("gnutls-get-initstage", Fgnutls_get_initstage, Sgnutls_get_initstage, 1, 1, 0,
270
       doc: /* Return the GnuTLS init stage of process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
271
See also `gnutls-boot'.  */)
272
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
273 274 275 276 277 278 279
{
  CHECK_PROCESS (proc);

  return make_number (GNUTLS_INITSTAGE (proc));
}

DEFUN ("gnutls-errorp", Fgnutls_errorp, Sgnutls_errorp, 1, 1, 0,
280 281 282 283
       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
284
{
285
  if (EQ (err, Qt)) return Qnil;
Ted Zlatanov's avatar
Ted Zlatanov committed
286 287 288 289 290

  return Qt;
}

DEFUN ("gnutls-error-fatalp", Fgnutls_error_fatalp, Sgnutls_error_fatalp, 1, 1, 0,
291 292 293 294
       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
295 296 297 298 299 300 301
{
  Lisp_Object code;

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

  if (SYMBOLP (err))
    {
302 303 304 305 306 307 308 309 310
      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
311 312 313 314 315 316 317 318 319 320 321 322
    }

  if (!NUMBERP (err))
    error ("Not an error symbol or code");

  if (0 == gnutls_error_is_fatal (XINT (err)))
    return Qnil;

  return Qt;
}

DEFUN ("gnutls-error-string", Fgnutls_error_string, Sgnutls_error_string, 1, 1, 0,
323 324 325 326
       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
327 328 329 330 331 332 333
{
  Lisp_Object code;

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

  if (SYMBOLP (err))
    {
334 335 336 337 338 339 340 341 342
      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
343 344 345 346 347 348 349 350 351
    }

  if (!NUMBERP (err))
    return build_string ("Not an error symbol or code");

  return build_string (gnutls_strerror (XINT (err)));
}

DEFUN ("gnutls-deinit", Fgnutls_deinit, Sgnutls_deinit, 1, 1, 0,
352
       doc: /* Deallocate GnuTLS resources associated with process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
353
See also `gnutls-init'.  */)
354
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
355 356 357 358 359 360 361
{
  gnutls_session_t state;

  CHECK_PROCESS (proc);
  state = XPROCESS (proc)->gnutls_state;

  if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
362
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
363 364
      gnutls_deinit (state);
      GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT - 1;
365
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
366 367 368 369

  return Qt;
}

370 371
/* Initializes global GnuTLS state to defaults.
Call `gnutls-global-deinit' when GnuTLS usage is no longer needed.
Ted Zlatanov's avatar
Ted Zlatanov committed
372
Returns zero on success.  */
373
static Lisp_Object
374
emacs_gnutls_global_init (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
375 376 377
{
  int ret = GNUTLS_E_SUCCESS;

378
  if (!gnutls_global_initialized)
Ted Zlatanov's avatar
Ted Zlatanov committed
379 380
    ret = gnutls_global_init ();

381
  gnutls_global_initialized = 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
382 383 384 385

  return gnutls_make_error (ret);
}

386
#if 0
387
/* Deinitializes global GnuTLS state.
Ted Zlatanov's avatar
Ted Zlatanov committed
388
See also `gnutls-global-init'.  */
389
static Lisp_Object
390
emacs_gnutls_global_deinit (void)
Ted Zlatanov's avatar
Ted Zlatanov committed
391
{
392
  if (gnutls_global_initialized)
Ted Zlatanov's avatar
Ted Zlatanov committed
393 394
    gnutls_global_deinit ();

395
  gnutls_global_initialized = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
396 397 398

  return gnutls_make_error (GNUTLS_E_SUCCESS);
}
399
#endif
Ted Zlatanov's avatar
Ted Zlatanov committed
400

401 402
DEFUN ("gnutls-boot", Fgnutls_boot, Sgnutls_boot, 3, 3, 0,
       doc: /* Initialize GnuTLS client for process PROC with TYPE+PROPLIST.
Ted Zlatanov's avatar
Ted Zlatanov committed
403 404 405
Currently only client mode is supported.  Returns a success/failure
value you can check with `gnutls-errorp'.

406 407 408
TYPE is a symbol, either `gnutls-anon' or `gnutls-x509pki'.
PROPLIST is a property list with the following keys:

409 410
:hostname is a string naming the remote host.

411
:priority is a GnuTLS priority string, defaults to "NORMAL".
412

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

415
:keyfiles is a list of PEM-encoded key files for `gnutls-x509pki'.
416 417 418

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

419
:loglevel is the debug level requested from GnuTLS, try 4.
420

421 422 423 424 425 426 427 428 429
:verify-flags is a bitset as per GnuTLS'
gnutls_certificate_set_verify_flags.

:verify-error, if non-nil, makes failure of the certificate validation
an error.  Otherwise it will be just a series of warnings.

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

430 431 432
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
433 434 435 436 437

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.

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

442 443 444
The callbacks alist can have a `verify' key, associated with a
verification function (UNUSED).

Ted Zlatanov's avatar
Ted Zlatanov committed
445
Each authentication type may need additional information in order to
446 447 448
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
449 450 451
{
  int ret = GNUTLS_E_SUCCESS;

452 453
  int max_log_level = 0;

Ted Zlatanov's avatar
Ted Zlatanov committed
454 455 456
  /* TODO: GNUTLS_X509_FMT_DER is also an option.  */
  int file_format = GNUTLS_X509_FMT_PEM;

457 458 459 460 461
  unsigned int gnutls_verify_flags = GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT;
  gnutls_x509_crt_t gnutls_verify_cert;
  unsigned int gnutls_verify_cert_list_size;
  const gnutls_datum_t *gnutls_verify_cert_list;

Ted Zlatanov's avatar
Ted Zlatanov committed
462 463 464 465
  gnutls_session_t state;
  gnutls_certificate_credentials_t x509_cred;
  gnutls_anon_client_credentials_t anon_cred;
  Lisp_Object global_init;
466
  char const *priority_string_ptr = "NORMAL"; /* default priority string.  */
467
  Lisp_Object tail;
468
  unsigned int peer_verification;
469
  char* c_hostname;
470 471 472 473 474

  /* Placeholders for the property list elements.  */
  Lisp_Object priority_string;
  Lisp_Object trustfiles;
  Lisp_Object keyfiles;
475
  /* Lisp_Object callbacks; */
476
  Lisp_Object loglevel;
477 478
  Lisp_Object hostname;
  Lisp_Object verify_flags;
Paul Eggert's avatar
Paul Eggert committed
479
  /* Lisp_Object verify_error; */
480
  Lisp_Object verify_hostname_error;
Ted Zlatanov's avatar
Ted Zlatanov committed
481 482 483

  CHECK_PROCESS (proc);
  CHECK_SYMBOL (type);
484 485
  CHECK_LIST (proplist);

486 487 488 489
  hostname              = Fplist_get (proplist, Qgnutls_bootprop_hostname);
  priority_string       = Fplist_get (proplist, Qgnutls_bootprop_priority);
  trustfiles            = Fplist_get (proplist, Qgnutls_bootprop_trustfiles);
  keyfiles              = Fplist_get (proplist, Qgnutls_bootprop_keyfiles);
Paul Eggert's avatar
Paul Eggert committed
490
  /* callbacks          = Fplist_get (proplist, Qgnutls_bootprop_callbacks); */
491 492
  loglevel              = Fplist_get (proplist, Qgnutls_bootprop_loglevel);
  verify_flags          = Fplist_get (proplist, Qgnutls_bootprop_verify_flags);
493
  /* verify_error       = Fplist_get (proplist, Qgnutls_bootprop_verify_error); */
494 495 496 497 498 499
  verify_hostname_error = Fplist_get (proplist, Qgnutls_bootprop_verify_hostname_error);

  if (!STRINGP (hostname))
    error ("gnutls-boot: invalid :hostname parameter");

  c_hostname = SSDATA (hostname);
Ted Zlatanov's avatar
Ted Zlatanov committed
500 501

  state = XPROCESS (proc)->gnutls_state;
502
  XPROCESS (proc)->gnutls_p = 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
503

504 505 506 507 508 509 510
  if (NUMBERP (loglevel))
    {
      gnutls_global_set_log_function (gnutls_log_function);
      gnutls_global_set_log_level (XINT (loglevel));
      max_log_level = XINT (loglevel);
      XPROCESS (proc)->gnutls_log_level = max_log_level;
    }
511

Ted Zlatanov's avatar
Ted Zlatanov committed
512
  /* always initialize globals.  */
513
  global_init = emacs_gnutls_global_init ();
Ted Zlatanov's avatar
Ted Zlatanov committed
514 515 516 517 518
  if (! NILP (Fgnutls_errorp (global_init)))
    return global_init;

  /* deinit and free resources.  */
  if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_CRED_ALLOC)
519
    {
520 521
      GNUTLS_LOG (1, max_log_level, "deallocating credentials");

Ted Zlatanov's avatar
Ted Zlatanov committed
522
      if (EQ (type, Qgnutls_x509pki))
523
	{
524 525
          GNUTLS_LOG (2, max_log_level, "deallocating x509 credentials");
          x509_cred = XPROCESS (proc)->gnutls_x509_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
526
          gnutls_certificate_free_credentials (x509_cred);
527
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
528
      else if (EQ (type, Qgnutls_anon))
529
	{
530 531
          GNUTLS_LOG (2, max_log_level, "deallocating anon credentials");
          anon_cred = XPROCESS (proc)->gnutls_anon_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
532
          gnutls_anon_free_client_credentials (anon_cred);
533
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
534
      else
535
	{
Ted Zlatanov's avatar
Ted Zlatanov committed
536 537
          error ("unknown credential type");
          ret = GNUTLS_EMACS_ERROR_INVALID_TYPE;
538
	}
Ted Zlatanov's avatar
Ted Zlatanov committed
539 540

      if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
541
	{
542
          GNUTLS_LOG (1, max_log_level, "deallocating x509 credentials");
Ted Zlatanov's avatar
Ted Zlatanov committed
543
          Fgnutls_deinit (proc);
544 545
	}
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
546 547 548

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;

549 550
  GNUTLS_LOG (1, max_log_level, "allocating credentials");

Ted Zlatanov's avatar
Ted Zlatanov committed
551
  if (EQ (type, Qgnutls_x509pki))
552
    {
553 554
      GNUTLS_LOG (2, max_log_level, "allocating x509 credentials");
      x509_cred = XPROCESS (proc)->gnutls_x509_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
555 556
      if (gnutls_certificate_allocate_credentials (&x509_cred) < 0)
        memory_full ();
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573

      if (NUMBERP (verify_flags))
        {
          gnutls_verify_flags = XINT (verify_flags);
          GNUTLS_LOG (2, max_log_level, "setting verification flags");
        }
      else if (NILP (verify_flags))
        {
          /* The default is already GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT.  */
          GNUTLS_LOG (2, max_log_level, "using default verification flags");
        }
      else
        {
          /* The default is already GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT.  */
          GNUTLS_LOG (2, max_log_level, "ignoring invalid verify-flags");
        }
      gnutls_certificate_set_verify_flags (x509_cred, gnutls_verify_flags);
574
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
575
  else if (EQ (type, Qgnutls_anon))
576
    {
577 578
      GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
      anon_cred = XPROCESS (proc)->gnutls_anon_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
579 580
      if (gnutls_anon_allocate_client_credentials (&anon_cred) < 0)
        memory_full ();
581
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
582
  else
583
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
584 585
      error ("unknown credential type");
      ret = GNUTLS_EMACS_ERROR_INVALID_TYPE;
586
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
587 588

  if (ret < GNUTLS_E_SUCCESS)
589
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
590 591 592 593

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;

  if (EQ (type, Qgnutls_x509pki))
594
    {
595
      for (tail = trustfiles; !NILP (tail); tail = Fcdr (tail))
596
	{
597 598 599 600
	  Lisp_Object trustfile = Fcar (tail);
          if (STRINGP (trustfile))
            {
              GNUTLS_LOG2 (1, max_log_level, "setting the trustfile: ",
601
                           SSDATA (trustfile));
602 603
              ret = gnutls_certificate_set_x509_trust_file
                (x509_cred,
604
                 SSDATA (trustfile),
605
                 file_format);
606

607 608 609 610 611 612
              if (ret < GNUTLS_E_SUCCESS)
                return gnutls_make_error (ret);
            }
          else
            {
              error ("Sorry, GnuTLS can't use non-string trustfile %s",
613
                     SDATA (trustfile));
614 615
            }
        }
Ted Zlatanov's avatar
Ted Zlatanov committed
616

617
      for (tail = keyfiles; !NILP (tail); tail = Fcdr (tail))
618
	{
619 620 621 622
	  Lisp_Object keyfile = Fcar (tail);
          if (STRINGP (keyfile))
            {
              GNUTLS_LOG2 (1, max_log_level, "setting the keyfile: ",
623
                           SSDATA (keyfile));
624 625
              ret = gnutls_certificate_set_x509_crl_file
                (x509_cred,
626
                 SSDATA (keyfile),
627
                 file_format);
628

629 630 631 632 633 634
              if (ret < GNUTLS_E_SUCCESS)
                return gnutls_make_error (ret);
            }
          else
            {
              error ("Sorry, GnuTLS can't use non-string keyfile %s",
635
                     SDATA (keyfile));
636 637
            }
        }
638
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
639 640 641

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_FILES;

642 643 644 645 646 647 648 649
  GNUTLS_LOG (1, max_log_level, "gnutls callbacks");

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CALLBACKS;

#ifdef HAVE_GNUTLS_CALLBACK_CERTIFICATE_VERIFY
#else
#endif

650 651
  GNUTLS_LOG (1, max_log_level, "gnutls_init");

Ted Zlatanov's avatar
Ted Zlatanov committed
652 653 654
  ret = gnutls_init (&state, GNUTLS_CLIENT);

  if (ret < GNUTLS_E_SUCCESS)
655
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
656 657 658 659 660

  XPROCESS (proc)->gnutls_state = state;

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT;

661 662
  if (STRINGP (priority_string))
    {
663
      priority_string_ptr = SSDATA (priority_string);
664 665 666 667 668 669 670 671
      GNUTLS_LOG2 (1, max_log_level, "got non-default priority string:",
                   priority_string_ptr);
    }
  else
    {
      GNUTLS_LOG2 (1, max_log_level, "using default priority string:",
                   priority_string_ptr);
    }
672

673 674
  GNUTLS_LOG (1, max_log_level, "setting the priority string");

675
  ret = gnutls_priority_set_direct (state,
676
				    priority_string_ptr,
677
				    NULL);
Ted Zlatanov's avatar
Ted Zlatanov committed
678 679

  if (ret < GNUTLS_E_SUCCESS)
680
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
681 682 683 684

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_PRIORITY;

  if (EQ (type, Qgnutls_x509pki))
685
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
686
      ret = gnutls_cred_set (state, GNUTLS_CRD_CERTIFICATE, x509_cred);
687
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
688
  else if (EQ (type, Qgnutls_anon))
689
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
690
      ret = gnutls_cred_set (state, GNUTLS_CRD_ANON, anon_cred);
691
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
692
  else
693
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
694 695
      error ("unknown credential type");
      ret = GNUTLS_EMACS_ERROR_INVALID_TYPE;
696
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
697 698

  if (ret < GNUTLS_E_SUCCESS)
699
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
700

701 702
  XPROCESS (proc)->gnutls_anon_cred = anon_cred;
  XPROCESS (proc)->gnutls_x509_cred = x509_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
703 704 705 706
  XPROCESS (proc)->gnutls_cred_type = type;

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_SET;

707
  ret = emacs_gnutls_handshake (XPROCESS (proc));
708

709 710 711 712 713 714 715 716 717 718 719 720 721
  if (ret < GNUTLS_E_SUCCESS)
    return gnutls_make_error (ret);

  /* Now verify the peer, following
     http://www.gnu.org/software/gnutls/manual/html_node/Verifying-peer_0027s-certificate.html.
     The peer should present at least one certificate in the chain; do a
     check of the certificate's hostname with
     gnutls_x509_crt_check_hostname() against :hostname.  */

  ret = gnutls_certificate_verify_peers2 (state, &peer_verification);

  if (ret < GNUTLS_E_SUCCESS)
    return gnutls_make_error (ret);
Paul Eggert's avatar
Paul Eggert committed
722

723
  if (XINT (loglevel) > 0 && peer_verification & GNUTLS_CERT_INVALID)
Paul Eggert's avatar
Paul Eggert committed
724
    message ("%s certificate could not be verified.",
725
             c_hostname);
Paul Eggert's avatar
Paul Eggert committed
726

727 728 729
 if (peer_verification & GNUTLS_CERT_REVOKED)
   GNUTLS_LOG2 (1, max_log_level, "certificate was revoked (CRL):",
                c_hostname);
Paul Eggert's avatar
Paul Eggert committed
730

731 732 733
 if (peer_verification & GNUTLS_CERT_SIGNER_NOT_FOUND)
   GNUTLS_LOG2 (1, max_log_level, "certificate signer was not found:",
                c_hostname);
Paul Eggert's avatar
Paul Eggert committed
734

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
 if (peer_verification & GNUTLS_CERT_SIGNER_NOT_CA)
   GNUTLS_LOG2 (1, max_log_level, "certificate signer is not a CA:",
                c_hostname);

 if (peer_verification & GNUTLS_CERT_INSECURE_ALGORITHM)
   GNUTLS_LOG2 (1, max_log_level,
                "certificate was signed with an insecure algorithm:",
                c_hostname);

 if (peer_verification & GNUTLS_CERT_NOT_ACTIVATED)
   GNUTLS_LOG2 (1, max_log_level, "certificate is not yet activated:",
                c_hostname);

 if (peer_verification & GNUTLS_CERT_EXPIRED)
   GNUTLS_LOG2 (1, max_log_level, "certificate has expired:",
                c_hostname);

 if (peer_verification != 0)
   {
     if (NILP (verify_hostname_error))
       {
         GNUTLS_LOG2 (1, max_log_level, "certificate validation failed:",
                      c_hostname);
       }
     else
       {
         error ("Certificate validation failed %s, verification code %d",
                c_hostname, peer_verification);
       }
   }

  /* Up to here the process is the same for X.509 certificates and
     OpenPGP keys.  From now on X.509 certificates are assumed.  This
     can be easily extended to work with openpgp keys as well.  */
  if (gnutls_certificate_type_get (state) == GNUTLS_CRT_X509)
    {
      ret = gnutls_x509_crt_init (&gnutls_verify_cert);

      if (ret < GNUTLS_E_SUCCESS)
        return gnutls_make_error (ret);

Paul Eggert's avatar
Paul Eggert committed
776
      gnutls_verify_cert_list =
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
        gnutls_certificate_get_peers (state, &gnutls_verify_cert_list_size);

      if (NULL == gnutls_verify_cert_list)
        {
          error ("No x509 certificate was found!\n");
        }

      /* We only check the first certificate in the given chain.  */
      ret = gnutls_x509_crt_import (gnutls_verify_cert,
                                    &gnutls_verify_cert_list[0],
                                    GNUTLS_X509_FMT_DER);

      if (ret < GNUTLS_E_SUCCESS)
        {
          gnutls_x509_crt_deinit (gnutls_verify_cert);
          return gnutls_make_error (ret);
        }

      if (!gnutls_x509_crt_check_hostname (gnutls_verify_cert, c_hostname))
        {
          if (NILP (verify_hostname_error))
            {
              GNUTLS_LOG2 (1, max_log_level, "x509 certificate does not match:",
                           c_hostname);
            }
          else
            {
              gnutls_x509_crt_deinit (gnutls_verify_cert);
              error ("The x509 certificate does not match \"%s\"",
                     c_hostname);
            }
        }

      gnutls_x509_crt_deinit (gnutls_verify_cert);
    }

  return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
814 815 816 817
}

DEFUN ("gnutls-bye", Fgnutls_bye,
       Sgnutls_bye, 2, 2, 0,
818
       doc: /* Terminate current GnuTLS connection for process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
819 820 821
The connection should have been initiated using `gnutls-handshake'.

If CONT is not nil the TLS connection gets terminated and further
822
receives and sends will be disallowed.  If the return value is zero you
Ted Zlatanov's avatar
Ted Zlatanov committed
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
may continue using the connection.  If CONT is nil, GnuTLS actually
sends an alert containing a close request and waits for the peer to
reply with the same message.  In order to reuse the connection you
should wait for an EOF from the peer.

This function may also return `gnutls-e-again', or
`gnutls-e-interrupted'.  */)
    (Lisp_Object proc, Lisp_Object cont)
{
  gnutls_session_t state;
  int ret;

  CHECK_PROCESS (proc);

  state = XPROCESS (proc)->gnutls_state;

  ret = gnutls_bye (state,
                    NILP (cont) ? GNUTLS_SHUT_RDWR : GNUTLS_SHUT_WR);

  return gnutls_make_error (ret);
}

void
syms_of_gnutls (void)
{
848 849 850 851
  gnutls_global_initialized = 0;

  Qgnutls_log_level = intern_c_string ("gnutls-log-level");
  staticpro (&Qgnutls_log_level);
Ted Zlatanov's avatar
Ted Zlatanov committed
852 853 854 855 856 857 858 859 860 861

  Qgnutls_code = intern_c_string ("gnutls-code");
  staticpro (&Qgnutls_code);

  Qgnutls_anon = intern_c_string ("gnutls-anon");
  staticpro (&Qgnutls_anon);

  Qgnutls_x509pki = intern_c_string ("gnutls-x509pki");
  staticpro (&Qgnutls_x509pki);

862 863 864
  Qgnutls_bootprop_hostname = intern_c_string (":hostname");
  staticpro (&Qgnutls_bootprop_hostname);

865
  Qgnutls_bootprop_priority = intern_c_string (":priority");
866 867
  staticpro (&Qgnutls_bootprop_priority);

868
  Qgnutls_bootprop_trustfiles = intern_c_string (":trustfiles");
869 870
  staticpro (&Qgnutls_bootprop_trustfiles);

871
  Qgnutls_bootprop_keyfiles = intern_c_string (":keyfiles");
872 873
  staticpro (&Qgnutls_bootprop_keyfiles);

874
  Qgnutls_bootprop_callbacks = intern_c_string (":callbacks");
875 876
  staticpro (&Qgnutls_bootprop_callbacks);

877 878 879
  Qgnutls_bootprop_callbacks_verify = intern_c_string ("verify");
  staticpro (&Qgnutls_bootprop_callbacks_verify);

880
  Qgnutls_bootprop_loglevel = intern_c_string (":loglevel");
881 882
  staticpro (&Qgnutls_bootprop_loglevel);

883 884 885 886 887 888 889 890 891
  Qgnutls_bootprop_verify_flags = intern_c_string (":verify-flags");
  staticpro (&Qgnutls_bootprop_verify_flags);

  Qgnutls_bootprop_verify_hostname_error = intern_c_string (":verify-error");
  staticpro (&Qgnutls_bootprop_verify_error);

  Qgnutls_bootprop_verify_hostname_error = intern_c_string (":verify-hostname-error");
  staticpro (&Qgnutls_bootprop_verify_hostname_error);

Ted Zlatanov's avatar
Ted Zlatanov committed
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
  Qgnutls_e_interrupted = intern_c_string ("gnutls-e-interrupted");
  staticpro (&Qgnutls_e_interrupted);
  Fput (Qgnutls_e_interrupted, Qgnutls_code,
        make_number (GNUTLS_E_INTERRUPTED));

  Qgnutls_e_again = intern_c_string ("gnutls-e-again");
  staticpro (&Qgnutls_e_again);
  Fput (Qgnutls_e_again, Qgnutls_code,
        make_number (GNUTLS_E_AGAIN));

  Qgnutls_e_invalid_session = intern_c_string ("gnutls-e-invalid-session");
  staticpro (&Qgnutls_e_invalid_session);
  Fput (Qgnutls_e_invalid_session, Qgnutls_code,
        make_number (GNUTLS_E_INVALID_SESSION));

  Qgnutls_e_not_ready_for_handshake =
    intern_c_string ("gnutls-e-not-ready-for-handshake");
  staticpro (&Qgnutls_e_not_ready_for_handshake);
  Fput (Qgnutls_e_not_ready_for_handshake, Qgnutls_code,
        make_number (GNUTLS_E_APPLICATION_ERROR_MIN));

  defsubr (&Sgnutls_get_initstage);
  defsubr (&Sgnutls_errorp);
  defsubr (&Sgnutls_error_fatalp);
  defsubr (&Sgnutls_error_string);
  defsubr (&Sgnutls_boot);
  defsubr (&Sgnutls_deinit);
  defsubr (&Sgnutls_bye);
}
921 922

#endif /* HAVE_GNUTLS */