gnutls.c 26.6 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 37
#ifdef WINDOWSNT
#include <windows.h>
#include "w32.h"
#endif

static int
emacs_gnutls_handle_error (gnutls_session_t, int err);

Lisp_Object Qgnutls_log_level;
Ted Zlatanov's avatar
Ted Zlatanov committed
38 39 40 41
Lisp_Object Qgnutls_code;
Lisp_Object Qgnutls_anon, Qgnutls_x509pki;
Lisp_Object Qgnutls_e_interrupted, Qgnutls_e_again,
  Qgnutls_e_invalid_session, Qgnutls_e_not_ready_for_handshake;
42
int gnutls_global_initialized;
Ted Zlatanov's avatar
Ted Zlatanov committed
43

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

/* Callback keys for `gnutls-boot'.  Unused currently.  */
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_TRANSPORT_POINTERS_SET)
77
    {
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
#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
97 98 99
      /* 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.  */
100
      gnutls_transport_set_ptr2 (state,
101 102
        			 (gnutls_transport_ptr_t) (long) proc->infd,
        			 (gnutls_transport_ptr_t) (long) proc->outfd);
103
#endif
104

105 106
      proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
    }
107

108 109 110 111 112 113 114
  do
    {
      ret = gnutls_handshake (state);
      emacs_gnutls_handle_error (state, ret);
    }
  while (ret < 0 && gnutls_error_is_fatal (ret) == 0);

115 116 117
  proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;

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

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

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

  bytes_written = 0;

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

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

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

166
  emacs_gnutls_handle_error (state, rtnval);
Ted Zlatanov's avatar
Ted Zlatanov committed
167 168 169
  return (bytes_written);
}

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

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

195 196 197 198 199 200 201 202
/* 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;

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

264
  return make_number (err);
Ted Zlatanov's avatar
Ted Zlatanov committed
265 266 267
}

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

  return make_number (GNUTLS_INITSTAGE (proc));
}

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

  return Qt;
}

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

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

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

  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,
321 322 323 324
       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
325 326 327 328 329 330 331
{
  Lisp_Object code;

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

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

  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,
350
       doc: /* Deallocate GnuTLS resources associated with process PROC.
Ted Zlatanov's avatar
Ted Zlatanov committed
351
See also `gnutls-init'.  */)
352
  (Lisp_Object proc)
Ted Zlatanov's avatar
Ted Zlatanov committed
353 354 355 356 357 358 359
{
  gnutls_session_t state;

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

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

  return Qt;
}

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

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

379
  gnutls_global_initialized = 1;
Ted Zlatanov's avatar
Ted Zlatanov committed
380 381 382 383

  return gnutls_make_error (ret);
}

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

393
  gnutls_global_initialized = 0;
Ted Zlatanov's avatar
Ted Zlatanov committed
394 395 396

  return gnutls_make_error (GNUTLS_E_SUCCESS);
}
397
#endif
Ted Zlatanov's avatar
Ted Zlatanov committed
398

399 400
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
401 402 403
Currently only client mode is supported.  Returns a success/failure
value you can check with `gnutls-errorp'.

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

407 408
:hostname is a string naming the remote host.

409
:priority is a GnuTLS priority string, defaults to "NORMAL".
410

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

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

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

417
:loglevel is the debug level requested from GnuTLS, try 4.
418

419 420 421 422 423 424 425 426 427
: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.

428 429 430
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
431 432 433 434 435

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.

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

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

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

450 451
  int max_log_level = 0;

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

455 456 457 458 459
  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
460 461 462 463
  gnutls_session_t state;
  gnutls_certificate_credentials_t x509_cred;
  gnutls_anon_client_credentials_t anon_cred;
  Lisp_Object global_init;
464
  char const *priority_string_ptr = "NORMAL"; /* default priority string.  */
465
  Lisp_Object tail;
466 467
  int peer_verification;
  char* c_hostname;
468 469 470 471 472

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

  CHECK_PROCESS (proc);
  CHECK_SYMBOL (type);
482 483
  CHECK_LIST (proplist);

484 485 486 487
  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
488
  /* callbacks          = Fplist_get (proplist, Qgnutls_bootprop_callbacks); */
489 490 491 492 493 494 495 496 497
  loglevel              = Fplist_get (proplist, Qgnutls_bootprop_loglevel);
  verify_flags          = Fplist_get (proplist, Qgnutls_bootprop_verify_flags);
  verify_error          = Fplist_get (proplist, Qgnutls_bootprop_verify_error);
  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
498 499

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

502 503 504 505 506 507 508
  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;
    }
509

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

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

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

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;

547 548
  GNUTLS_LOG (1, max_log_level, "allocating credentials");

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

      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);
572
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
573
  else if (EQ (type, Qgnutls_anon))
574
    {
575 576
      GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
      anon_cred = XPROCESS (proc)->gnutls_anon_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
577 578
      if (gnutls_anon_allocate_client_credentials (&anon_cred) < 0)
        memory_full ();
579
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
580
  else
581
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
582 583
      error ("unknown credential type");
      ret = GNUTLS_EMACS_ERROR_INVALID_TYPE;
584
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
585 586

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;

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

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

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

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_FILES;

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CALLBACKS;

#ifdef HAVE_GNUTLS_CALLBACK_CERTIFICATE_VERIFY
#else
#endif

648 649
  GNUTLS_LOG (1, max_log_level, "gnutls_init");

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

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

  XPROCESS (proc)->gnutls_state = state;

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT;

659 660
  if (STRINGP (priority_string))
    {
661
      priority_string_ptr = SSDATA (priority_string);
662 663 664 665 666 667 668 669
      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);
    }
670

671 672
  GNUTLS_LOG (1, max_log_level, "setting the priority string");

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

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_PRIORITY;

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

  if (ret < GNUTLS_E_SUCCESS)
697
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
698

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

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_SET;

705
  ret = emacs_gnutls_handshake (XPROCESS (proc));
706

707 708 709 710 711 712 713 714 715 716 717 718 719
  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
720

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

725 726 727
 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
728

729 730 731
 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
732

733 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
 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
774
      gnutls_verify_cert_list =
775 776 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
        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
812 813 814 815
}

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

If CONT is not nil the TLS connection gets terminated and further
820
receives and sends will be disallowed.  If the return value is zero you
Ted Zlatanov's avatar
Ted Zlatanov committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
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)
{
846 847 848 849
  gnutls_global_initialized = 0;

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

  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);

860 861 862
  Qgnutls_bootprop_hostname = intern_c_string (":hostname");
  staticpro (&Qgnutls_bootprop_hostname);

863
  Qgnutls_bootprop_priority = intern_c_string (":priority");
864 865
  staticpro (&Qgnutls_bootprop_priority);

866
  Qgnutls_bootprop_trustfiles = intern_c_string (":trustfiles");
867 868
  staticpro (&Qgnutls_bootprop_trustfiles);

869
  Qgnutls_bootprop_keyfiles = intern_c_string (":keyfiles");
870 871
  staticpro (&Qgnutls_bootprop_keyfiles);

872
  Qgnutls_bootprop_callbacks = intern_c_string (":callbacks");
873 874
  staticpro (&Qgnutls_bootprop_callbacks);

875 876 877
  Qgnutls_bootprop_callbacks_verify = intern_c_string ("verify");
  staticpro (&Qgnutls_bootprop_callbacks_verify);

878
  Qgnutls_bootprop_loglevel = intern_c_string (":loglevel");
879 880
  staticpro (&Qgnutls_bootprop_loglevel);

881 882 883 884 885 886 887 888 889
  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
890 891 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
  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);
}
#endif