gnutls.c 28.2 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
static Lisp_Object Qgnutls_bootprop_priority;
static Lisp_Object Qgnutls_bootprop_trustfiles;
47 48
static Lisp_Object Qgnutls_bootprop_keylist;
static Lisp_Object Qgnutls_bootprop_crlfiles;
49 50 51 52 53 54
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;
55 56

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

59
static void
60 61 62 63 64 65 66 67 68 69 70 71
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
72 73 74 75 76 77
emacs_gnutls_handshake (struct Lisp_Process *proc)
{
  gnutls_session_t state = proc->gnutls_state;
  int ret;

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

  if (proc->gnutls_initstage < GNUTLS_STAGE_TRANSPORT_POINTERS_SET)
81
    {
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
#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
101 102 103
      /* 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.  */
104
      gnutls_transport_set_ptr2 (state,
105 106
        			 (gnutls_transport_ptr_t) (long) proc->infd,
        			 (gnutls_transport_ptr_t) (long) proc->outfd);
107
#endif
108

109 110
      proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
    }
111

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

119 120 121
  proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;

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

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

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

  bytes_written = 0;

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

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

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

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

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

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

198 199 200 201 202 203 204 205
/* 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;

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

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

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

  return make_number (GNUTLS_INITSTAGE (proc));
}

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

  return Qt;
}

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

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

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

  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,
324 325 326 327
       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
328 329 330 331 332 333 334
{
  Lisp_Object code;

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

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

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

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

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

  return Qt;
}

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

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

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

  return gnutls_make_error (ret);
}

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

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

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

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

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

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

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

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

416 417 418 419
: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'.
420 421 422

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

423
:loglevel is the debug level requested from GnuTLS, try 4.
424

425 426 427 428 429 430 431 432 433
: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.

434 435 436
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
437 438 439 440 441

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.

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

446 447 448
The callbacks alist can have a `verify' key, associated with a
verification function (UNUSED).

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

456 457
  int max_log_level = 0;

Ted Zlatanov's avatar
Ted Zlatanov committed
458 459 460
  /* TODO: GNUTLS_X509_FMT_DER is also an option.  */
  int file_format = GNUTLS_X509_FMT_PEM;

461 462 463 464 465
  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
466 467 468 469
  gnutls_session_t state;
  gnutls_certificate_credentials_t x509_cred;
  gnutls_anon_client_credentials_t anon_cred;
  Lisp_Object global_init;
470
  char const *priority_string_ptr = "NORMAL"; /* default priority string.  */
471
  Lisp_Object tail;
472
  unsigned int peer_verification;
473
  char* c_hostname;
474 475 476 477

  /* Placeholders for the property list elements.  */
  Lisp_Object priority_string;
  Lisp_Object trustfiles;
478 479
  Lisp_Object crlfiles;
  Lisp_Object keylist;
480
  /* Lisp_Object callbacks; */
481
  Lisp_Object loglevel;
482 483
  Lisp_Object hostname;
  Lisp_Object verify_flags;
Paul Eggert's avatar
Paul Eggert committed
484
  /* Lisp_Object verify_error; */
485
  Lisp_Object verify_hostname_error;
Ted Zlatanov's avatar
Ted Zlatanov committed
486 487 488

  CHECK_PROCESS (proc);
  CHECK_SYMBOL (type);
489 490
  CHECK_LIST (proplist);

491 492 493
  hostname              = Fplist_get (proplist, Qgnutls_bootprop_hostname);
  priority_string       = Fplist_get (proplist, Qgnutls_bootprop_priority);
  trustfiles            = Fplist_get (proplist, Qgnutls_bootprop_trustfiles);
494 495
  keylist               = Fplist_get (proplist, Qgnutls_bootprop_keylist);
  crlfiles              = Fplist_get (proplist, Qgnutls_bootprop_crlfiles);
Paul Eggert's avatar
Paul Eggert committed
496
  /* callbacks          = Fplist_get (proplist, Qgnutls_bootprop_callbacks); */
497 498
  loglevel              = Fplist_get (proplist, Qgnutls_bootprop_loglevel);
  verify_flags          = Fplist_get (proplist, Qgnutls_bootprop_verify_flags);
499
  /* verify_error       = Fplist_get (proplist, Qgnutls_bootprop_verify_error); */
500 501 502 503 504 505
  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
506 507

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

510 511 512 513 514 515 516
  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;
    }
517

Ted Zlatanov's avatar
Ted Zlatanov committed
518
  /* always initialize globals.  */
519
  global_init = emacs_gnutls_global_init ();
Ted Zlatanov's avatar
Ted Zlatanov committed
520 521 522 523 524
  if (! NILP (Fgnutls_errorp (global_init)))
    return global_init;

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

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

      if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
547
	{
548
          GNUTLS_LOG (1, max_log_level, "deallocating x509 credentials");
Ted Zlatanov's avatar
Ted Zlatanov committed
549
          Fgnutls_deinit (proc);
550 551
	}
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
552 553 554

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;

555 556
  GNUTLS_LOG (1, max_log_level, "allocating credentials");

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

      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);
580
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
581
  else if (EQ (type, Qgnutls_anon))
582
    {
583 584
      GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
      anon_cred = XPROCESS (proc)->gnutls_anon_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
585 586
      if (gnutls_anon_allocate_client_credentials (&anon_cred) < 0)
        memory_full ();
587
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
588
  else
589
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
590 591
      error ("unknown credential type");
      ret = GNUTLS_EMACS_ERROR_INVALID_TYPE;
592
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
593 594

  if (ret < GNUTLS_E_SUCCESS)
595
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
596 597 598 599

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;

  if (EQ (type, Qgnutls_x509pki))
600
    {
601
      for (tail = trustfiles; !NILP (tail); tail = Fcdr (tail))
602
	{
603 604 605 606
	  Lisp_Object trustfile = Fcar (tail);
          if (STRINGP (trustfile))
            {
              GNUTLS_LOG2 (1, max_log_level, "setting the trustfile: ",
607
                           SSDATA (trustfile));
608 609
              ret = gnutls_certificate_set_x509_trust_file
                (x509_cred,
610
                 SSDATA (trustfile),
611
                 file_format);
612

613 614 615 616 617 618
              if (ret < GNUTLS_E_SUCCESS)
                return gnutls_make_error (ret);
            }
          else
            {
              error ("Sorry, GnuTLS can't use non-string trustfile %s",
619
                     SDATA (trustfile));
620 621
            }
        }
Ted Zlatanov's avatar
Ted Zlatanov committed
622

623
      for (tail = crlfiles; !NILP (tail); tail = Fcdr (tail))
624
	{
625 626
	  Lisp_Object crlfile = Fcar (tail);
          if (STRINGP (crlfile))
627
            {
628 629
              GNUTLS_LOG2 (1, max_log_level, "setting the CRL file: ",
                           SSDATA (crlfile));
630 631
              ret = gnutls_certificate_set_x509_crl_file
                (x509_cred,
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
                 SSDATA (crlfile),
                 file_format);

              if (ret < GNUTLS_E_SUCCESS)
                return gnutls_make_error (ret);
            }
          else
            {
              error ("Sorry, GnuTLS can't use non-string CRL file %s",
                     SDATA (crlfile));
            }
        }

      for (tail = keylist; !NILP (tail); tail = Fcdr (tail))
	{
	  Lisp_Object keyfile = Fcar (Fcar (tail));
	  Lisp_Object certfile = Fcar (Fcdr (tail));
          if (STRINGP (keyfile) && STRINGP (certfile))
            {
              GNUTLS_LOG2 (1, max_log_level, "setting the client key file: ",
                           SSDATA (keyfile));
              GNUTLS_LOG2 (1, max_log_level, "setting the client cert file: ",
                           SSDATA (certfile));
              ret = gnutls_certificate_set_x509_key_file
                (x509_cred,
                 SSDATA (certfile),
658
                 SSDATA (keyfile),
659
                 file_format);
660

661 662 663 664 665
              if (ret < GNUTLS_E_SUCCESS)
                return gnutls_make_error (ret);
            }
          else
            {
666 667 668 669 670 671
              if (STRINGP (keyfile))
                error ("Sorry, GnuTLS can't use non-string client cert file %s",
                       SDATA (certfile));
              else
                error ("Sorry, GnuTLS can't use non-string client key file %s",
                       SDATA (keyfile));
672 673
            }
        }
674
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
675 676 677

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_FILES;

678 679 680 681 682 683 684 685
  GNUTLS_LOG (1, max_log_level, "gnutls callbacks");

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CALLBACKS;

#ifdef HAVE_GNUTLS_CALLBACK_CERTIFICATE_VERIFY
#else
#endif

686 687
  GNUTLS_LOG (1, max_log_level, "gnutls_init");

Ted Zlatanov's avatar
Ted Zlatanov committed
688 689 690
  ret = gnutls_init (&state, GNUTLS_CLIENT);

  if (ret < GNUTLS_E_SUCCESS)
691
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
692 693 694 695 696

  XPROCESS (proc)->gnutls_state = state;

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT;

697 698
  if (STRINGP (priority_string))
    {
699
      priority_string_ptr = SSDATA (priority_string);
700 701 702 703 704 705 706 707
      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);
    }
708

709 710
  GNUTLS_LOG (1, max_log_level, "setting the priority string");

711
  ret = gnutls_priority_set_direct (state,
712
				    priority_string_ptr,
713
				    NULL);
Ted Zlatanov's avatar
Ted Zlatanov committed
714 715

  if (ret < GNUTLS_E_SUCCESS)
716
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
717 718 719 720

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_PRIORITY;

  if (EQ (type, Qgnutls_x509pki))
721
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
722
      ret = gnutls_cred_set (state, GNUTLS_CRD_CERTIFICATE, x509_cred);
723
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
724
  else if (EQ (type, Qgnutls_anon))
725
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
726
      ret = gnutls_cred_set (state, GNUTLS_CRD_ANON, anon_cred);
727
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
728
  else
729
    {
Ted Zlatanov's avatar
Ted Zlatanov committed
730 731
      error ("unknown credential type");
      ret = GNUTLS_EMACS_ERROR_INVALID_TYPE;
732
    }
Ted Zlatanov's avatar
Ted Zlatanov committed
733 734

  if (ret < GNUTLS_E_SUCCESS)
735
    return gnutls_make_error (ret);
Ted Zlatanov's avatar
Ted Zlatanov committed
736

737 738
  XPROCESS (proc)->gnutls_anon_cred = anon_cred;
  XPROCESS (proc)->gnutls_x509_cred = x509_cred;
Ted Zlatanov's avatar
Ted Zlatanov committed
739 740 741 742
  XPROCESS (proc)->gnutls_cred_type = type;

  GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_SET;

743
  ret = emacs_gnutls_handshake (XPROCESS (proc));
744

745 746 747 748 749 750 751 752 753 754 755 756 757
  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
758

759
  if (XINT (loglevel) > 0 && peer_verification & GNUTLS_CERT_INVALID)
Paul Eggert's avatar
Paul Eggert committed
760
    message ("%s certificate could not be verified.",
761
             c_hostname);
Paul Eggert's avatar
Paul Eggert committed
762

763 764 765
 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
766

767 768 769
 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
770

771 772 773 774 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
 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
812
      gnutls_verify_cert_list =
813 814 815 816 817 818 819 820 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 846 847 848 849
        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
850 851 852 853
}

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

If CONT is not nil the TLS connection gets terminated and further
858
receives and sends will be disallowed.  If the return value is zero you
Ted Zlatanov's avatar
Ted Zlatanov committed
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
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)
{
884 885 886 887
  gnutls_global_initialized = 0;

  Qgnutls_log_level = intern_c_string ("gnutls-log-level");
  staticpro (&Qgnutls_log_level);
Ted Zlatanov's avatar
Ted Zlatanov committed
888 889 890 891 892 893 894 895 896 897

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

898 899 900
  Qgnutls_bootprop_hostname = intern_c_string (":hostname");
  staticpro (&Qgnutls_bootprop_hostname);

901
  Qgnutls_bootprop_priority = intern_c_string (":priority");
902 903
  staticpro (&Qgnutls_bootprop_priority);

904
  Qgnutls_bootprop_trustfiles = intern_c_string (":trustfiles");
905 906
  staticpro (&Qgnutls_bootprop_trustfiles);

907 908 909 910 911
  Qgnutls_bootprop_keylist = intern_c_string (":keylist");
  staticpro (&Qgnutls_bootprop_keylist);

  Qgnutls_bootprop_crlfiles = intern_c_string (":crlfiles");
  staticpro (&Qgnutls_bootprop_crlfiles);
912

913
  Qgnutls_bootprop_callbacks = intern_c_string (":callbacks");
914 915
  staticpro (&Qgnutls_bootprop_callbacks);

916 917 918
  Qgnutls_bootprop_callbacks_verify = intern_c_string ("verify");
  staticpro (&Qgnutls_bootprop_callbacks_verify);

919
  Qgnutls_bootprop_loglevel = intern_c_string (":loglevel");
920 921
  staticpro (&Qgnutls_bootprop_loglevel);

922 923 924 925 926 927 928 929 930
  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
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
  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);
}
960 961

#endif /* HAVE_GNUTLS */