dbus-keyring.c 30.4 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 3
/* dbus-keyring.c Store secret cookies in your homedir
 *
4
 * Copyright (C) 2003, 2004  Red Hat Inc.
5
 *
6
 * Licensed under the Academic Free License version 2.1
7 8 9 10 11 12 13 14 15 16 17 18 19
 * 
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 22 23
 *
 */

24
#include <config.h>
25
#include "dbus-keyring.h"
26
#include "dbus-protocol.h"
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
#include <dbus/dbus-string.h>
#include <dbus/dbus-list.h>
#include <dbus/dbus-sysdeps.h>

/**
 * @defgroup DBusKeyring keyring class
 * @ingroup  DBusInternals
 * @brief DBusKeyring data structure
 *
 * Types and functions related to DBusKeyring. DBusKeyring is intended
 * to manage cookies used to authenticate clients to servers.  This is
 * essentially the "verify that client can read the user's homedir"
 * authentication mechanism.  Both client and server must have access
 * to the homedir.
 *
 * The secret keys are not kept in locked memory, and are written to a
 * file in the user's homedir. However they are transient (only used
 * by a single server instance for a fixed period of time, then
 * discarded). Also, the keys are not sent over the wire.
46
 *
47
 * @todo there's a memory leak on some codepath in here, I saw it once
48 49
 * when running make check - probably some specific initial cookies
 * present in the cookie file, then depending on what we do with them.
50 51 52 53 54 55 56 57 58 59 60 61
 */

/**
 * @defgroup DBusKeyringInternals DBusKeyring implementation details
 * @ingroup  DBusInternals
 * @brief DBusKeyring implementation details
 *
 * The guts of DBusKeyring.
 *
 * @{
 */

62 63 64 65
/** The maximum age of a key before we create a new key to use in
 * challenges.  This isn't super-reliably enforced, since system
 * clocks can change or be wrong, but we make a best effort to only
 * use keys for a short time.
66
 */
67
#define NEW_KEY_TIMEOUT_SECONDS     (60*5)
68
/**
69 70 71
 * The time after which we drop a key from the secrets file.
 * The EXPIRE_KEYS_TIMEOUT_SECONDS - NEW_KEY_TIMEOUT_SECONDS is the minimum
 * time window a client has to complete authentication.
72
 */
73 74 75 76 77
#define EXPIRE_KEYS_TIMEOUT_SECONDS (NEW_KEY_TIMEOUT_SECONDS + (60*2))
/**
 * The maximum amount of time a key can be in the future.
 */
#define MAX_TIME_TRAVEL_SECONDS (60*5)
78

79 80 81 82 83 84 85 86 87 88
/**
 * Maximum number of keys in the keyring before
 * we just ignore the rest
 */
#ifdef DBUS_BUILD_TESTS
#define MAX_KEYS_IN_FILE 10
#else
#define MAX_KEYS_IN_FILE 256
#endif

89 90 91
/**
 * A single key from the cookie file
 */
92 93
typedef struct
{
94
  dbus_int32_t id; /**< identifier used to refer to the key */
95

96 97 98 99
  long creation_time; /**< when the key was generated,
                       *   as unix timestamp. signed long
                       *   matches struct timeval.
                       */
100 101 102 103 104 105 106 107 108 109 110 111 112
  
  DBusString secret; /**< the actual key */

} DBusKey;

/**
 * @brief Internals of DBusKeyring.
 * 
 * DBusKeyring internals. DBusKeyring is an opaque object, it must be
 * used via accessor functions.
 */
struct DBusKeyring
{
113 114 115 116 117 118
  int refcount;             /**< Reference count */
  DBusString directory;     /**< Directory the below two items are inside */
  DBusString filename;      /**< Keyring filename */
  DBusString filename_lock; /**< Name of lockfile */
  DBusKey *keys; /**< Keys loaded from the file */
  int n_keys;    /**< Number of keys */
119
  DBusCredentials *credentials; /**< Credentials containing user the keyring is for */
120 121 122 123 124 125 126 127 128 129
};

static DBusKeyring*
_dbus_keyring_new (void)
{
  DBusKeyring *keyring;

  keyring = dbus_new0 (DBusKeyring, 1);
  if (keyring == NULL)
    goto out_0;
130
  
131
  if (!_dbus_string_init (&keyring->directory))
132 133
    goto out_1;

134
  if (!_dbus_string_init (&keyring->filename))
135 136
    goto out_2;

137
  if (!_dbus_string_init (&keyring->filename_lock))
138
    goto out_3;
139
  
140 141 142 143 144
  keyring->refcount = 1;
  keyring->keys = NULL;
  keyring->n_keys = 0;

  return keyring;
145

146
  /*  out_4: */
147
  _dbus_string_free (&keyring->filename_lock);
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
 out_3:
  _dbus_string_free (&keyring->filename);
 out_2:
  _dbus_string_free (&keyring->directory);
 out_1:
  dbus_free (keyring);
 out_0:
  return NULL;
}

static void
free_keys (DBusKey *keys,
           int      n_keys)
{
  int i;

  /* should be safe for args NULL, 0 */
  
  i = 0;
  while (i < n_keys)
    {
      _dbus_string_free (&keys[i].secret);
      ++i;
    }

  dbus_free (keys);
}

/* Our locking scheme is highly unreliable.  However, there is
 * unfortunately no reliable locking scheme in user home directories;
 * between bugs in Linux NFS, people using Tru64 or other total crap
 * NFS, AFS, random-file-system-of-the-week, and so forth, fcntl() in
 * homedirs simply generates tons of bug reports. This has been
 * learned through hard experience with GConf, unfortunately.
 *
 * This bad hack might work better for the kind of lock we have here,
 * which we don't expect to hold for any length of time.  Crashing
 * while we hold it should be unlikely, and timing out such that we
 * delete a stale lock should also be unlikely except when the
 * filesystem is running really slowly.  Stuff might break in corner
 * cases but as long as it's not a security-level breakage it should
 * be OK.
 */

/** Maximum number of timeouts waiting for lock before we decide it's stale */
193
#define MAX_LOCK_TIMEOUTS 32
194
/** Length of each timeout while waiting for a lock */
195
#define LOCK_TIMEOUT_MILLISECONDS 250
196 197 198 199 200 201 202 203 204

static dbus_bool_t
_dbus_keyring_lock (DBusKeyring *keyring)
{
  int n_timeouts;
  
  n_timeouts = 0;
  while (n_timeouts < MAX_LOCK_TIMEOUTS)
    {
205
      DBusError error = DBUS_ERROR_INIT;
206 207 208 209 210

      if (_dbus_create_file_exclusively (&keyring->filename_lock,
                                         &error))
        break;

211 212
      _dbus_verbose ("Did not get lock file, sleeping %d milliseconds (%s)\n",
                     LOCK_TIMEOUT_MILLISECONDS, error.message);
213 214
      dbus_error_free (&error);

215
      _dbus_sleep_milliseconds (LOCK_TIMEOUT_MILLISECONDS);
216 217 218 219 220 221
      
      ++n_timeouts;
    }

  if (n_timeouts == MAX_LOCK_TIMEOUTS)
    {
222 223
      DBusError error = DBUS_ERROR_INIT;

224 225
      _dbus_verbose ("Lock file timed out %d times, assuming stale\n",
                     n_timeouts);
226

227 228 229 230 231 232 233
      if (!_dbus_delete_file (&keyring->filename_lock, &error))
        {
          _dbus_verbose ("Couldn't delete old lock file: %s\n",
                         error.message);
          dbus_error_free (&error);
          return FALSE;
        }
234 235

      if (!_dbus_create_file_exclusively (&keyring->filename_lock,
236
                                          &error))
237
        {
238 239 240
          _dbus_verbose ("Couldn't create lock file after deleting stale one: %s\n",
                         error.message);
          dbus_error_free (&error);
241 242 243 244 245 246 247 248 249 250
          return FALSE;
        }
    }
  
  return TRUE;
}

static void
_dbus_keyring_unlock (DBusKeyring *keyring)
{
251 252
  DBusError error = DBUS_ERROR_INIT;

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
  if (!_dbus_delete_file (&keyring->filename_lock, &error))
    {
      _dbus_warn ("Failed to delete lock file: %s\n",
                  error.message);
      dbus_error_free (&error);
    }
}

static DBusKey*
find_key_by_id (DBusKey *keys,
                int      n_keys,
                int      id)
{
  int i;

  i = 0;
  while (i < n_keys)
    {
      if (keys[i].id == id)
        return &keys[i];
      
      ++i;
    }

  return NULL;
}

static dbus_bool_t
add_new_key (DBusKey  **keys_p,
             int       *n_keys_p,
             DBusError *error)
{
  DBusKey *new;
  DBusString bytes;
  int id;
288
  long timestamp;
289 290 291 292
  const unsigned char *s;
  dbus_bool_t retval;
  DBusKey *keys;
  int n_keys;
293 294 295

  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
  
296
  if (!_dbus_string_init (&bytes))
297
    {
298
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
299 300 301 302 303 304 305 306 307 308 309 310
      return FALSE;
    }

  keys = *keys_p;
  n_keys = *n_keys_p;
  retval = FALSE;
      
  /* Generate an integer ID and then the actual key. */
 retry:
      
  if (!_dbus_generate_random_bytes (&bytes, 4))
    {
311
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
312 313 314
      goto out;
    }

315
  s = (const unsigned char*) _dbus_string_get_const_data (&bytes);
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
      
  id = s[0] | (s[1] << 8) | (s[2] << 16) | (s[3] << 24);
  if (id < 0)
    id = - id;
  _dbus_assert (id >= 0);

  if (find_key_by_id (keys, n_keys, id) != NULL)
    {
      _dbus_string_set_length (&bytes, 0);
      _dbus_verbose ("Key ID %d already existed, trying another one\n",
                     id);
      goto retry;
    }

  _dbus_verbose ("Creating key with ID %d\n", id);
      
#define KEY_LENGTH_BYTES 24
  _dbus_string_set_length (&bytes, 0);
  if (!_dbus_generate_random_bytes (&bytes, KEY_LENGTH_BYTES))
    {
336
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
337 338 339 340 341 342
      goto out;
    }

  new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
  if (new == NULL)
    {
343
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
344 345 346 347
      goto out;
    }

  keys = new;
348
  *keys_p = keys; /* otherwise *keys_p ends up invalid */
349 350
  n_keys += 1;

351
  if (!_dbus_string_init (&keys[n_keys-1].secret))
352 353
    {
      n_keys -= 1; /* we don't want to free the one we didn't init */
354
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
355 356 357 358 359 360 361 362 363 364 365
      goto out;
    }

  _dbus_get_current_time (&timestamp, NULL);
      
  keys[n_keys-1].id = id;
  keys[n_keys-1].creation_time = timestamp;
  if (!_dbus_string_move (&bytes, 0,
                          &keys[n_keys-1].secret,
                          0))
    {
366
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
367 368
      _dbus_string_free (&keys[n_keys-1].secret);
      n_keys -= 1;
369 370 371 372 373 374
      goto out;
    }
  
  retval = TRUE;
  
 out:
375
  *n_keys_p = n_keys;
376 377 378
  
  _dbus_string_free (&bytes);
  return retval;
379 380 381 382
}

/**
 * Reloads the keyring file, optionally adds one new key to the file,
383 384 385 386 387 388
 * removes all expired keys from the file iff a key was added, then
 * resaves the file.  Stores the keys from the file in keyring->keys.
 * Note that the file is only resaved (written to) if a key is added,
 * this means that only servers ever write to the file and need to
 * lock it, which avoids a lot of lock contention at login time and
 * such.
389 390
 *
 * @param keyring the keyring
391
 * @param add_new #TRUE to add a new key to the file, expire keys, and resave
392 393 394 395 396 397 398 399
 * @param error return location for errors
 * @returns #FALSE on failure
 */
static dbus_bool_t
_dbus_keyring_reload (DBusKeyring *keyring,
                      dbus_bool_t  add_new,
                      DBusError   *error)
{
400 401 402 403 404 405 406 407
  DBusString contents;
  DBusString line;
  dbus_bool_t retval;
  dbus_bool_t have_lock;
  DBusKey *keys;
  int n_keys;
  int i;
  long now;
408
  DBusError tmp_error;
409 410

  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
411
  
John Palmieri's avatar
John Palmieri committed
412 413 414
  if (!_dbus_check_dir_is_private_to_user (&keyring->directory, error))
    return FALSE;
    
415
  if (!_dbus_string_init (&contents))
416
    {
417
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
418 419 420
      return FALSE;
    }

421
  if (!_dbus_string_init (&line))
422
    {
423
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
424 425 426
      _dbus_string_free (&contents);
      return FALSE;
    }
John Palmieri's avatar
John Palmieri committed
427
   
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
  keys = NULL;
  n_keys = 0;
  retval = FALSE;
  have_lock = FALSE;

  _dbus_get_current_time (&now, NULL);
  
  if (add_new)
    {
      if (!_dbus_keyring_lock (keyring))
        {
          dbus_set_error (error, DBUS_ERROR_FAILED,
                          "Could not lock keyring file to add to it");
          goto out;
        }

      have_lock = TRUE;
    }

447 448 449 450
  dbus_error_init (&tmp_error);
  if (!_dbus_file_get_contents (&contents, 
                                &keyring->filename,
                                &tmp_error))
451 452
    {
      _dbus_verbose ("Failed to load keyring file: %s\n",
453
                     tmp_error.message);
454
      /* continue with empty keyring file, so we recreate it */
455
      dbus_error_free (&tmp_error);
456 457 458 459 460 461 462 463
    }

  if (!_dbus_string_validate_ascii (&contents, 0,
                                    _dbus_string_get_length (&contents)))
    {
      _dbus_warn ("Secret keyring file contains non-ASCII! Ignoring existing contents\n");
      _dbus_string_set_length (&contents, 0);
    }
464 465 466 467

  /* FIXME this is badly inefficient for large keyring files
   * (not that large keyring files exist outside of test suites)
   */
468 469 470 471 472 473 474
  while (_dbus_string_pop_line (&contents, &line))
    {
      int next;
      long val;
      int id;
      long timestamp;
      int len;
475
      int end;
476
      DBusKey *new;
477 478

      /* Don't load more than the max. */
479
      if (n_keys >= (add_new ? MAX_KEYS_IN_FILE - 1 : MAX_KEYS_IN_FILE))
480
        break;
481 482 483 484 485 486 487 488
      
      next = 0;
      if (!_dbus_string_parse_int (&line, 0, &val, &next))
        {
          _dbus_verbose ("could not parse secret key ID at start of line\n");
          continue;
        }

489
      if (val > _DBUS_INT32_MAX || val < 0)
490 491 492 493 494 495 496 497 498 499 500 501 502 503
        {
          _dbus_verbose ("invalid secret key ID at start of line\n");
          continue;
        }
      
      id = val;

      _dbus_string_skip_blank (&line, next, &next);
      
      if (!_dbus_string_parse_int (&line, next, &timestamp, &next))
        {
          _dbus_verbose ("could not parse secret key timestamp\n");
          continue;
        }
504

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
      if (timestamp < 0 ||
          (now + MAX_TIME_TRAVEL_SECONDS) < timestamp ||
          (now - EXPIRE_KEYS_TIMEOUT_SECONDS) > timestamp)
        {
          _dbus_verbose ("dropping/ignoring %ld-seconds old key with timestamp %ld as current time is %ld\n",
                         now - timestamp, timestamp, now);
          continue;
        }
      
      _dbus_string_skip_blank (&line, next, &next);

      len = _dbus_string_get_length (&line);

      if ((len - next) == 0)
        {
          _dbus_verbose ("no secret key after ID and timestamp\n");
          continue;
        }
      
      /* We have all three parts */
      new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
      if (new == NULL)
        {
528
          dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
529 530 531 532 533 534
          goto out;
        }

      keys = new;
      n_keys += 1;

535
      if (!_dbus_string_init (&keys[n_keys-1].secret))
536 537
        {
          n_keys -= 1; /* we don't want to free the one we didn't init */
538
          dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
539 540 541 542 543
          goto out;
        }
      
      keys[n_keys-1].id = id;
      keys[n_keys-1].creation_time = timestamp;
544 545 546 547 548 549 550 551 552 553 554 555 556 557
      if (!_dbus_string_hex_decode (&line, next, &end,
                                    &keys[n_keys-1].secret, 0))
	{
	  dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
	  goto out;
	}

      if (_dbus_string_get_length (&line) != end)
	{
	  _dbus_verbose ("invalid hex encoding in keyring file\n");
	  _dbus_string_free (&keys[n_keys - 1].secret);
	  n_keys -= 1;
	  continue;
	}
558 559 560 561 562 563 564 565 566 567
    }

  _dbus_verbose ("Successfully loaded %d existing keys\n",
                 n_keys);

  if (add_new)
    {
      if (!add_new_key (&keys, &n_keys, error))
        {
          _dbus_verbose ("Failed to generate new key: %s\n",
John Palmieri's avatar
John Palmieri committed
568
                         error ? error->message : "(unknown)");
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
          goto out;
        }

      _dbus_string_set_length (&contents, 0);

      i = 0;
      while (i < n_keys)
        {
          if (!_dbus_string_append_int (&contents,
                                        keys[i].id))
            goto nomem;

          if (!_dbus_string_append_byte (&contents, ' '))
            goto nomem;

          if (!_dbus_string_append_int (&contents,
                                        keys[i].creation_time))
            goto nomem;

          if (!_dbus_string_append_byte (&contents, ' '))
            goto nomem;

          if (!_dbus_string_hex_encode (&keys[i].secret, 0,
                                        &contents,
                                        _dbus_string_get_length (&contents)))
            goto nomem;

          if (!_dbus_string_append_byte (&contents, '\n'))
            goto nomem;          
          
          ++i;
          continue;

        nomem:
603
          dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
604 605 606
          goto out;
        }
      
607 608 609
      if (!_dbus_string_save_to_file (&contents, &keyring->filename,
                                      error))
        goto out;
610 611
    }

612 613
  if (keyring->keys)
    free_keys (keyring->keys, keyring->n_keys);
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
  keyring->keys = keys;
  keyring->n_keys = n_keys;
  keys = NULL;
  n_keys = 0;
  
  retval = TRUE;  
  
 out:
  if (have_lock)
    _dbus_keyring_unlock (keyring);
  
  if (! ((retval == TRUE && (error == NULL || error->name == NULL)) ||
         (retval == FALSE && (error == NULL || error->name != NULL))))
    {
      if (error && error->name)
        _dbus_verbose ("error is %s: %s\n", error->name, error->message);
      _dbus_warn ("returning %d but error pointer %p name %s\n",
                  retval, error, error->name ? error->name : "(none)");
      _dbus_assert_not_reached ("didn't handle errors properly");
    }
  
  if (keys != NULL)
    {
      i = 0;
      while (i < n_keys)
        {
640
          _dbus_string_zero (&keys[i].secret);
641 642 643 644 645 646 647 648 649 650 651
          _dbus_string_free (&keys[i].secret);
          ++i;
        }

      dbus_free (keys);
    }
  
  _dbus_string_free (&contents);
  _dbus_string_free (&line);

  return retval;
652
}
653 654 655 656 657 658 659 660 661

/** @} */ /* end of internals */

/**
 * @addtogroup DBusKeyring
 *
 * @{
 */

662 663 664 665
/**
 * Increments reference count of the keyring
 *
 * @param keyring the keyring
666
 * @returns the keyring
667
 */
668
DBusKeyring *
669 670 671
_dbus_keyring_ref (DBusKeyring *keyring)
{
  keyring->refcount += 1;
672 673

  return keyring;
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
}

/**
 * Decrements refcount and finalizes if it reaches
 * zero.
 *
 * @param keyring the keyring
 */
void
_dbus_keyring_unref (DBusKeyring *keyring)
{
  keyring->refcount -= 1;

  if (keyring->refcount == 0)
    {
689 690 691
      if (keyring->credentials)
        _dbus_credentials_unref (keyring->credentials);

692 693 694 695 696 697 698 699 700
      _dbus_string_free (&keyring->filename);
      _dbus_string_free (&keyring->filename_lock);
      _dbus_string_free (&keyring->directory);
      free_keys (keyring->keys, keyring->n_keys);
      dbus_free (keyring);      
    }
}

/**
701 702 703
 * Creates a new keyring that lives in the ~/.dbus-keyrings directory
 * of the given user credentials. If the credentials are #NULL or
 * empty, uses those of the current process.
704 705 706 707 708 709 710
 *
 * @param username username to get keyring for, or #NULL
 * @param context which keyring to get
 * @param error return location for errors
 * @returns the keyring or #NULL on error
 */
DBusKeyring*
711 712 713
_dbus_keyring_new_for_credentials (DBusCredentials  *credentials,
                                   const DBusString *context,
                                   DBusError        *error)
714
{
715
  DBusString ringdir;
716 717
  DBusKeyring *keyring;
  dbus_bool_t error_set;
718
  DBusError tmp_error;
719 720
  DBusCredentials *our_credentials;
  
721
  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
722 723 724
  
  keyring = NULL;
  error_set = FALSE;
725
  our_credentials = NULL;
726
  
727
  if (!_dbus_string_init (&ringdir))
728 729
    {
      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
730
      return NULL;
731
    }
732

733
  if (credentials != NULL)
734
    {
735
      our_credentials = _dbus_credentials_copy (credentials);
736 737 738
    }
  else
    {
739
      our_credentials = _dbus_credentials_new_from_current_process ();
740
    }
741 742 743
  
  if (our_credentials == NULL)
    goto failed;
744

745 746 747 748 749
  if (_dbus_credentials_are_anonymous (our_credentials))
    {
      if (!_dbus_credentials_add_from_current_process (our_credentials))
        goto failed;
    }
750
  
751 752 753
  if (!_dbus_append_keyring_directory_for_credentials (&ringdir,
                                                       our_credentials))
    goto failed;
754
  
755 756 757 758
  keyring = _dbus_keyring_new ();
  if (keyring == NULL)
    goto failed;

759 760 761 762
  _dbus_assert (keyring->credentials == NULL);
  keyring->credentials = our_credentials;
  our_credentials = NULL; /* so we don't unref it again later */
  
763 764 765 766 767 768 769 770 771
  /* should have been validated already, but paranoia check here */
  if (!_dbus_keyring_validate_context (context))
    {
      error_set = TRUE;
      dbus_set_error_const (error,
                            DBUS_ERROR_FAILED,
                            "Invalid context in keyring creation");
      goto failed;
    }
772

773 774
  /* Save keyring dir in the keyring object */
  if (!_dbus_string_copy (&ringdir, 0,
775
                          &keyring->directory, 0))
776
    goto failed;  
777

778
  /* Create keyring->filename based on keyring dir and context */
779 780 781 782 783 784 785 786
  if (!_dbus_string_copy (&keyring->directory, 0,
                          &keyring->filename, 0))
    goto failed;

  if (!_dbus_concat_dir_and_file (&keyring->filename,
                                  context))
    goto failed;

787
  /* Create lockfile name */
788 789 790 791
  if (!_dbus_string_copy (&keyring->filename, 0,
                          &keyring->filename_lock, 0))
    goto failed;

792
  if (!_dbus_string_append (&keyring->filename_lock, ".lock"))
793 794
    goto failed;

795
  /* Reload keyring */
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
  dbus_error_init (&tmp_error);
  if (!_dbus_keyring_reload (keyring, FALSE, &tmp_error))
    {
      _dbus_verbose ("didn't load an existing keyring: %s\n",
                     tmp_error.message);
      dbus_error_free (&tmp_error);
    }
  
  /* We don't fail fatally if we can't create the directory,
   * but the keyring will probably always be empty
   * unless someone else manages to create it
   */
  dbus_error_init (&tmp_error);
  if (!_dbus_create_directory (&keyring->directory,
                               &tmp_error))
    {
      _dbus_verbose ("Creating keyring directory: %s\n",
                     tmp_error.message);
      dbus_error_free (&tmp_error);
    }
816

817
  _dbus_string_free (&ringdir);
818
  
819 820 821 822 823 824
  return keyring;
  
 failed:
  if (!error_set)
    dbus_set_error_const (error,
                          DBUS_ERROR_NO_MEMORY,
825
                          NULL);
826 827
  if (our_credentials)
    _dbus_credentials_unref (our_credentials);
828 829
  if (keyring)
    _dbus_keyring_unref (keyring);
830
  _dbus_string_free (&ringdir);
831
  return NULL;
832 833 834 835 836 837 838 839 840

}

/**
 * Checks whether the context is a valid context.
 * Contexts that might cause confusion when used
 * in filenames are not allowed (contexts can't
 * start with a dot or contain dir separators).
 *
841 842 843
 * @todo this is the most inefficient implementation
 * imaginable.
 *
844 845 846 847 848 849
 * @param context the context
 * @returns #TRUE if valid
 */
dbus_bool_t
_dbus_keyring_validate_context (const DBusString *context)
{
850
  if (_dbus_string_get_length (context) == 0)
851 852 853 854 855 856 857 858 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 884
    {
      _dbus_verbose ("context is zero-length\n");
      return FALSE;
    }

  if (!_dbus_string_validate_ascii (context, 0,
                                    _dbus_string_get_length (context)))
    {
      _dbus_verbose ("context not valid ascii\n");
      return FALSE;
    }
  
  /* no directory separators */  
  if (_dbus_string_find (context, 0, "/", NULL))
    {
      _dbus_verbose ("context contains a slash\n");
      return FALSE;
    }

  if (_dbus_string_find (context, 0, "\\", NULL))
    {
      _dbus_verbose ("context contains a backslash\n");
      return FALSE;
    }

  /* prevent attempts to use dotfiles or ".." or ".lock"
   * all of which might allow some kind of attack
   */
  if (_dbus_string_find (context, 0, ".", NULL))
    {
      _dbus_verbose ("context contains a dot\n");
      return FALSE;
    }

885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
  /* no spaces/tabs, those are used for separators in the protocol */
  if (_dbus_string_find_blank (context, 0, NULL))
    {
      _dbus_verbose ("context contains a blank\n");
      return FALSE;
    }

  if (_dbus_string_find (context, 0, "\n", NULL))
    {
      _dbus_verbose ("context contains a newline\n");
      return FALSE;
    }

  if (_dbus_string_find (context, 0, "\r", NULL))
    {
      _dbus_verbose ("context contains a carriage return\n");
      return FALSE;
    }
  
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
  return TRUE;
}

static DBusKey*
find_recent_key (DBusKeyring *keyring)
{
  int i;
  long tv_sec, tv_usec;

  _dbus_get_current_time (&tv_sec, &tv_usec);
  
  i = 0;
  while (i < keyring->n_keys)
    {
      DBusKey *key = &keyring->keys[i];

920 921 922 923
      _dbus_verbose ("Key %d is %ld seconds old\n",
                     i, tv_sec - key->creation_time);
      
      if ((tv_sec - NEW_KEY_TIMEOUT_SECONDS) < key->creation_time)
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
        return key;
      
      ++i;
    }

  return NULL;
}

/**
 * Gets a recent key to use for authentication.
 * If no recent key exists, creates one. Returns
 * the key ID. If a key can't be written to the keyring
 * file so no recent key can be created, returns -1.
 * All valid keys are > 0.
 *
 * @param keyring the keyring
 * @param error error on failure
 * @returns key ID to use for auth, or -1 on failure
 */
int
_dbus_keyring_get_best_key (DBusKeyring  *keyring,
945
                            DBusError    *error)
946 947 948
{
  DBusKey *key;

949 950
  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
  
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
  key = find_recent_key (keyring);
  if (key)
    return key->id;

  /* All our keys are too old, or we've never loaded the
   * keyring. Create a new one.
   */
  if (!_dbus_keyring_reload (keyring, TRUE,
                             error))
    return -1;

  key = find_recent_key (keyring);
  if (key)
    return key->id;
  else
    {
      dbus_set_error_const (error,
                            DBUS_ERROR_FAILED,
                            "No recent-enough key found in keyring, and unable to create a new key");
      return -1;
    }
}
973

974
/**
975
 * Checks whether the keyring is for the same user as the given credentials.
976 977
 *
 * @param keyring the keyring
978
 * @param credentials the credentials to check
979 980 981 982
 *
 * @returns #TRUE if the keyring belongs to the given user
 */
dbus_bool_t
983 984
_dbus_keyring_is_for_credentials (DBusKeyring           *keyring,
                                  DBusCredentials       *credentials)
985
{
986 987
  return _dbus_credentials_same_user (keyring->credentials,
                                      credentials);
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
}

/**
 * Gets the hex-encoded secret key for the given ID.
 * Returns #FALSE if not enough memory. Returns #TRUE
 * but empty key on any other error such as unknown
 * key ID.
 *
 * @param keyring the keyring
 * @param key_id the key ID
 * @param hex_key string to append hex-encoded key to
 * @returns #TRUE if we had enough memory
 */
dbus_bool_t
_dbus_keyring_get_hex_key (DBusKeyring       *keyring,
                           int                key_id,
                           DBusString        *hex_key)
{
  DBusKey *key;

  key = find_key_by_id (keyring->keys,
                        keyring->n_keys,
                        key_id);
  if (key == NULL)
    return TRUE; /* had enough memory, so TRUE */

  return _dbus_string_hex_encode (&key->secret, 0,
                                  hex_key,
                                  _dbus_string_get_length (hex_key));
}

1019
/** @} */ /* end of exposed API */
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
#ifdef DBUS_BUILD_TESTS
#include "dbus-test.h"
#include <stdio.h>

dbus_bool_t
_dbus_keyring_test (void)
{
  DBusString context;
  DBusKeyring *ring1;
  DBusKeyring *ring2;
  int id;
  DBusError error;
  int i;

  ring1 = NULL;
  ring2 = NULL;
  
  /* Context validation */
  
  _dbus_string_init_const (&context, "foo");
  _dbus_assert (_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "org_freedesktop_blah");
  _dbus_assert (_dbus_keyring_validate_context (&context));
  
  _dbus_string_init_const (&context, "");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, ".foo");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "bar.foo");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "bar/foo");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "bar\\foo");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "foo\xfa\xf0");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "foo\x80");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_init_const (&context, "foo\x7f");
  _dbus_assert (_dbus_keyring_validate_context (&context));
1061 1062
  _dbus_string_init_const (&context, "foo bar");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
1063
  
1064
  if (!_dbus_string_init (&context))
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
    _dbus_assert_not_reached ("no memory");
  if (!_dbus_string_append_byte (&context, '\0'))
    _dbus_assert_not_reached ("no memory");
  _dbus_assert (!_dbus_keyring_validate_context (&context));
  _dbus_string_free (&context);

  /* Now verify that if we create a key in keyring 1,
   * it is properly loaded in keyring 2
   */

  _dbus_string_init_const (&context, "org_freedesktop_dbus_testsuite");
  dbus_error_init (&error);
1077 1078
  ring1 = _dbus_keyring_new_for_credentials (NULL, &context,
                                             &error);
1079
  _dbus_assert (ring1 != NULL);
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
  _dbus_assert (error.name == NULL);

  id = _dbus_keyring_get_best_key (ring1, &error);
  if (id < 0)
    {
      fprintf (stderr, "Could not load keyring: %s\n", error.message);
      dbus_error_free (&error);
      goto failure;
    }

1090
  ring2 = _dbus_keyring_new_for_credentials (NULL, &context, &error);
1091
  _dbus_assert (ring2 != NULL);
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
  _dbus_assert (error.name == NULL);
  
  if (ring1->n_keys != ring2->n_keys)
    {
      fprintf (stderr, "Different number of keys in keyrings\n");
      goto failure;
    }

  /* We guarantee we load and save keeping keys in a fixed
   * order
   */
  i = 0;
  while (i < ring1->n_keys)
    {
      if (ring1->keys[i].id != ring2->keys[i].id)
        {
          fprintf (stderr, "Keyring 1 has first key ID %d and keyring 2 has %d\n",
                   ring1->keys[i].id, ring2->keys[i].id);
          goto failure;
        }      

      if (ring1->keys[i].creation_time != ring2->keys[i].creation_time)
        {
          fprintf (stderr, "Keyring 1 has first key time %ld and keyring 2 has %ld\n",
                   ring1->keys[i].creation_time, ring2->keys[i].creation_time);
          goto failure;
        }

      if (!_dbus_string_equal (&ring1->keys[i].secret,
                               &ring2->keys[i].secret))
        {
          fprintf (stderr, "Keyrings 1 and 2 have different secrets for same ID/timestamp\n");
          goto failure;
        }
      
      ++i;
    }

  printf (" %d keys in test\n", ring1->n_keys);
1131

1132 1133 1134 1135 1136 1137 1138 1139
  /* Test ref/unref */
  _dbus_keyring_ref (ring1);
  _dbus_keyring_ref (ring2);
  _dbus_keyring_unref (ring1);
  _dbus_keyring_unref (ring2);


  /* really unref */
1140 1141
  _dbus_keyring_unref (ring1);
  _dbus_keyring_unref (ring2);
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
  
  return TRUE;

 failure:
  if (ring1)
    _dbus_keyring_unref (ring1);
  if (ring2)
    _dbus_keyring_unref (ring2);

  return FALSE;
}

#endif /* DBUS_BUILD_TESTS */