dbus/dbus-keyring.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-keyring.c Store secret cookies in your homedir
   3  *
   4  * Copyright (C) 2003  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.0
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-keyring.h"
  25 #include "dbus-userdb.h"
  26 #include <dbus/dbus-string.h>
  27 #include <dbus/dbus-list.h>
  28 #include <dbus/dbus-sysdeps.h>
  29
  30 /**
  31  * @defgroup DBusKeyring keyring class
  32  * @ingroup  DBusInternals
  33  * @brief DBusKeyring data structure
  34  *
  35  * Types and functions related to DBusKeyring. DBusKeyring is intended
  36  * to manage cookies used to authenticate clients to servers.  This is
  37  * essentially the "verify that client can read the user's homedir"
  38  * authentication mechanism.  Both client and server must have access
  39  * to the homedir.
  40  *
  41  * The secret keys are not kept in locked memory, and are written to a
  42  * file in the user's homedir. However they are transient (only used
  43  * by a single server instance for a fixed period of time, then
  44  * discarded). Also, the keys are not sent over the wire.
  45  *
  46  * @todo there's a memory leak on some codepath in here, I saw it once
  47  * when running make check - probably some specific initial cookies
  48  * present in the cookie file, then depending on what we do with them.
  49  */
  50
  51 /**
  52  * @defgroup DBusKeyringInternals DBusKeyring implementation details
  53  * @ingroup  DBusInternals
  54  * @brief DBusKeyring implementation details
  55  *
  56  * The guts of DBusKeyring.
  57  *
  58  * @{
  59  */
  60
  61 /** The maximum age of a key before we create a new key to use in
  62  * challenges.  This isn't super-reliably enforced, since system
  63  * clocks can change or be wrong, but we make a best effort to only
  64  * use keys for a short time.
  65  */
  66 #define NEW_KEY_TIMEOUT_SECONDS     (60*5)
  67 /**
  68  * The time after which we drop a key from the secrets file.
  69  * The EXPIRE_KEYS_TIMEOUT_SECONDS - NEW_KEY_TIMEOUT_SECONDS is the minimum
  70  * time window a client has to complete authentication.
  71  */
  72 #define EXPIRE_KEYS_TIMEOUT_SECONDS (NEW_KEY_TIMEOUT_SECONDS + (60*2))
  73 /**
  74  * The maximum amount of time a key can be in the future.
  75  */
  76 #define MAX_TIME_TRAVEL_SECONDS (60*5)
  77
  78 /**
  79  * Maximum number of keys in the keyring before
  80  * we just ignore the rest
  81  */
  82 #ifdef DBUS_BUILD_TESTS
  83 #define MAX_KEYS_IN_FILE 10
  84 #else
  85 #define MAX_KEYS_IN_FILE 256
  86 #endif
  87
  88 /**
  89  * A single key from the cookie file
  90  */
  91 typedef struct
  92 {
  93   dbus_int32_t id; /**< identifier used to refer to the key */
  94
  95   long creation_time; /**< when the key was generated,
  96                        *   as unix timestamp. signed long
  97                        *   matches struct timeval.
  98                        */
  99
 100   DBusString secret; /**< the actual key */
 101
 102 } DBusKey;
 103
 104 /**
 105  * @brief Internals of DBusKeyring.
 106  *
 107  * DBusKeyring internals. DBusKeyring is an opaque object, it must be
 108  * used via accessor functions.
 109  */
 110 struct DBusKeyring
 111 {
 112   int refcount;             /**< Reference count */
 113   DBusString username;      /**< Username keyring is for */
 114   DBusString directory;     /**< Directory the below two items are inside */
 115   DBusString filename;      /**< Keyring filename */
 116   DBusString filename_lock; /**< Name of lockfile */
 117   DBusKey *keys; /**< Keys loaded from the file */
 118   int n_keys;    /**< Number of keys */
 119 };
 120
 121 static DBusKeyring*
 122 _dbus_keyring_new (void)
 123 {
 124   DBusKeyring *keyring;
 125
 126   keyring = dbus_new0 (DBusKeyring, 1);
 127   if (keyring == NULL)
 128     goto out_0;
 129
 130   if (!_dbus_string_init (&keyring->directory))
 131     goto out_1;
 132
 133   if (!_dbus_string_init (&keyring->filename))
 134     goto out_2;
 135
 136   if (!_dbus_string_init (&keyring->filename_lock))
 137     goto out_3;
 138
 139   if (!_dbus_string_init (&keyring->username))
 140     goto out_4;
 141
 142   keyring->refcount = 1;
 143   keyring->keys = NULL;
 144   keyring->n_keys = 0;
 145
 146   return keyring;
 147
 148  out_4:
 149   _dbus_string_free (&keyring->filename_lock);
 150  out_3:
 151   _dbus_string_free (&keyring->filename);
 152  out_2:
 153   _dbus_string_free (&keyring->directory);
 154  out_1:
 155   dbus_free (keyring);
 156  out_0:
 157   return NULL;
 158 }
 159
 160 static void
 161 free_keys (DBusKey *keys,
 162            int      n_keys)
 163 {
 164   int i;
 165
 166   /* should be safe for args NULL, 0 */
 167
 168   i = 0;
 169   while (i < n_keys)
 170     {
 171       _dbus_string_free (&keys[i].secret);
 172       ++i;
 173     }
 174
 175   dbus_free (keys);
 176 }
 177
 178 /* Our locking scheme is highly unreliable.  However, there is
 179  * unfortunately no reliable locking scheme in user home directories;
 180  * between bugs in Linux NFS, people using Tru64 or other total crap
 181  * NFS, AFS, random-file-system-of-the-week, and so forth, fcntl() in
 182  * homedirs simply generates tons of bug reports. This has been
 183  * learned through hard experience with GConf, unfortunately.
 184  *
 185  * This bad hack might work better for the kind of lock we have here,
 186  * which we don't expect to hold for any length of time.  Crashing
 187  * while we hold it should be unlikely, and timing out such that we
 188  * delete a stale lock should also be unlikely except when the
 189  * filesystem is running really slowly.  Stuff might break in corner
 190  * cases but as long as it's not a security-level breakage it should
 191  * be OK.
 192  */
 193
 194 /** Maximum number of timeouts waiting for lock before we decide it's stale */
 195 #define MAX_LOCK_TIMEOUTS 32
 196 /** Length of each timeout while waiting for a lock */
 197 #define LOCK_TIMEOUT_MILLISECONDS 250
 198
 199 static dbus_bool_t
 200 _dbus_keyring_lock (DBusKeyring *keyring)
 201 {
 202   int n_timeouts;
 203
 204   n_timeouts = 0;
 205   while (n_timeouts < MAX_LOCK_TIMEOUTS)
 206     {
 207       DBusError error;
 208
 209       dbus_error_init (&error);
 210       if (_dbus_create_file_exclusively (&keyring->filename_lock,
 211                                          &error))
 212         break;
 213
 214       _dbus_verbose ("Did not get lock file, sleeping %d milliseconds (%s)\n",
 215                      LOCK_TIMEOUT_MILLISECONDS, error.message);
 216       dbus_error_free (&error);
 217
 218       _dbus_sleep_milliseconds (LOCK_TIMEOUT_MILLISECONDS);
 219
 220       ++n_timeouts;
 221     }
 222
 223   if (n_timeouts == MAX_LOCK_TIMEOUTS)
 224     {
 225       DBusError error;
 226
 227       _dbus_verbose ("Lock file timed out %d times, assuming stale\n",
 228                      n_timeouts);
 229
 230       dbus_error_init (&error);
 231
 232       if (!_dbus_delete_file (&keyring->filename_lock, &error))
 233         {
 234           _dbus_verbose ("Couldn't delete old lock file: %s\n",
 235                          error.message);
 236           dbus_error_free (&error);
 237           return FALSE;
 238         }
 239
 240       if (!_dbus_create_file_exclusively (&keyring->filename_lock,
 241                                           &error))
 242         {
 243           _dbus_verbose ("Couldn't create lock file after deleting stale one: %s\n",
 244                          error.message);
 245           dbus_error_free (&error);
 246           return FALSE;
 247         }
 248     }
 249
 250   return TRUE;
 251 }
 252
 253 static void
 254 _dbus_keyring_unlock (DBusKeyring *keyring)
 255 {
 256   DBusError error;
 257   dbus_error_init (&error);
 258   if (!_dbus_delete_file (&keyring->filename_lock, &error))
 259     {
 260       _dbus_warn ("Failed to delete lock file: %s\n",
 261                   error.message);
 262       dbus_error_free (&error);
 263     }
 264 }
 265
 266 static DBusKey*
 267 find_key_by_id (DBusKey *keys,
 268                 int      n_keys,
 269                 int      id)
 270 {
 271   int i;
 272
 273   i = 0;
 274   while (i < n_keys)
 275     {
 276       if (keys[i].id == id)
 277         return &keys[i];
 278
 279       ++i;
 280     }
 281
 282   return NULL;
 283 }
 284
 285 static dbus_bool_t
 286 add_new_key (DBusKey  **keys_p,
 287              int       *n_keys_p,
 288              DBusError *error)
 289 {
 290   DBusKey *new;
 291   DBusString bytes;
 292   int id;
 293   unsigned long timestamp;
 294   const unsigned char *s;
 295   dbus_bool_t retval;
 296   DBusKey *keys;
 297   int n_keys;
 298
 299   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 300
 301   if (!_dbus_string_init (&bytes))
 302     {
 303       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 304       return FALSE;
 305     }
 306
 307   keys = *keys_p;
 308   n_keys = *n_keys_p;
 309   retval = FALSE;
 310
 311   /* Generate an integer ID and then the actual key. */
 312  retry:
 313
 314   if (!_dbus_generate_random_bytes (&bytes, 4))
 315     {
 316       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 317       goto out;
 318     }
 319
 320   s = (const unsigned char*) _dbus_string_get_const_data (&bytes);
 321
 322   id = s[0] | (s[1] << 8) | (s[2] << 16) | (s[3] << 24);
 323   if (id < 0)
 324     id = - id;
 325   _dbus_assert (id >= 0);
 326
 327   if (find_key_by_id (keys, n_keys, id) != NULL)
 328     {
 329       _dbus_string_set_length (&bytes, 0);
 330       _dbus_verbose ("Key ID %d already existed, trying another one\n",
 331                      id);
 332       goto retry;
 333     }
 334
 335   _dbus_verbose ("Creating key with ID %d\n", id);
 336
 337 #define KEY_LENGTH_BYTES 24
 338   _dbus_string_set_length (&bytes, 0);
 339   if (!_dbus_generate_random_bytes (&bytes, KEY_LENGTH_BYTES))
 340     {
 341       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 342       goto out;
 343     }
 344
 345   new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
 346   if (new == NULL)
 347     {
 348       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 349       goto out;
 350     }
 351
 352   keys = new;
 353   *keys_p = keys; /* otherwise *keys_p ends up invalid */
 354   n_keys += 1;
 355
 356   if (!_dbus_string_init (&keys[n_keys-1].secret))
 357     {
 358       n_keys -= 1; /* we don't want to free the one we didn't init */
 359       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 360       goto out;
 361     }
 362
 363   _dbus_get_current_time (&timestamp, NULL);
 364
 365   keys[n_keys-1].id = id;
 366   keys[n_keys-1].creation_time = timestamp;
 367   if (!_dbus_string_move (&bytes, 0,
 368                           &keys[n_keys-1].secret,
 369                           0))
 370     {
 371       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 372       _dbus_string_free (&keys[n_keys-1].secret);
 373       n_keys -= 1;
 374       goto out;
 375     }
 376
 377   retval = TRUE;
 378
 379  out:
 380   *n_keys_p = n_keys;
 381
 382   _dbus_string_free (&bytes);
 383   return retval;
 384 }
 385
 386 /**
 387  * Reloads the keyring file, optionally adds one new key to the file,
 388  * removes all expired keys from the file iff a key was added, then
 389  * resaves the file.  Stores the keys from the file in keyring->keys.
 390  * Note that the file is only resaved (written to) if a key is added,
 391  * this means that only servers ever write to the file and need to
 392  * lock it, which avoids a lot of lock contention at login time and
 393  * such.
 394  *
 395  * @param keyring the keyring
 396  * @param add_new #TRUE to add a new key to the file, expire keys, and resave
 397  * @param error return location for errors
 398  * @returns #FALSE on failure
 399  */
 400 static dbus_bool_t
 401 _dbus_keyring_reload (DBusKeyring *keyring,
 402                       dbus_bool_t  add_new,
 403                       DBusError   *error)
 404 {
 405   DBusString contents;
 406   DBusString line;
 407   dbus_bool_t retval;
 408   dbus_bool_t have_lock;
 409   DBusKey *keys;
 410   int n_keys;
 411   int i;
 412   long now;
 413   DBusError tmp_error;
 414
 415   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 416
 417   if (!_dbus_string_init (&contents))
 418     {
 419       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 420       return FALSE;
 421     }
 422
 423   if (!_dbus_string_init (&line))
 424     {
 425       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 426       _dbus_string_free (&contents);
 427       return FALSE;
 428     }
 429
 430   keys = NULL;
 431   n_keys = 0;
 432   retval = FALSE;
 433   have_lock = FALSE;
 434
 435   _dbus_get_current_time (&now, NULL);
 436
 437   if (add_new)
 438     {
 439       if (!_dbus_keyring_lock (keyring))
 440         {
 441           dbus_set_error (error, DBUS_ERROR_FAILED,
 442                           "Could not lock keyring file to add to it");
 443           goto out;
 444         }
 445
 446       have_lock = TRUE;
 447     }
 448
 449   dbus_error_init (&tmp_error);
 450   if (!_dbus_file_get_contents (&contents,
 451                                 &keyring->filename,
 452                                 &tmp_error))
 453     {
 454       _dbus_verbose ("Failed to load keyring file: %s\n",
 455                      tmp_error.message);
 456       /* continue with empty keyring file, so we recreate it */
 457       dbus_error_free (&tmp_error);
 458     }
 459
 460   if (!_dbus_string_validate_ascii (&contents, 0,
 461                                     _dbus_string_get_length (&contents)))
 462     {
 463       _dbus_warn ("Secret keyring file contains non-ASCII! Ignoring existing contents\n");
 464       _dbus_string_set_length (&contents, 0);
 465     }
 466
 467   /* FIXME this is badly inefficient for large keyring files
 468    * (not that large keyring files exist outside of test suites)
 469    */
 470   while (_dbus_string_pop_line (&contents, &line))
 471     {
 472       int next;
 473       long val;
 474       int id;
 475       long timestamp;
 476       int len;
 477       int end;
 478       DBusKey *new;
 479
 480       /* Don't load more than the max. */
 481       if (n_keys >= (add_new ? MAX_KEYS_IN_FILE : MAX_KEYS_IN_FILE - 1))
 482         break;
 483
 484       next = 0;
 485       if (!_dbus_string_parse_int (&line, 0, &val, &next))
 486         {
 487           _dbus_verbose ("could not parse secret key ID at start of line\n");
 488           continue;
 489         }
 490
 491       if (val > _DBUS_INT_MAX || val < 0)
 492         {
 493           _dbus_verbose ("invalid secret key ID at start of line\n");
 494           continue;
 495         }
 496
 497       id = val;
 498
 499       _dbus_string_skip_blank (&line, next, &next);
 500
 501       if (!_dbus_string_parse_int (&line, next, &timestamp, &next))
 502         {
 503           _dbus_verbose ("could not parse secret key timestamp\n");
 504           continue;
 505         }
 506
 507       if (timestamp < 0 ||
 508           (now + MAX_TIME_TRAVEL_SECONDS) < timestamp ||
 509           (now - EXPIRE_KEYS_TIMEOUT_SECONDS) > timestamp)
 510         {
 511           _dbus_verbose ("dropping/ignoring %ld-seconds old key with timestamp %ld as current time is %ld\n",
 512                          now - timestamp, timestamp, now);
 513           continue;
 514         }
 515
 516       _dbus_string_skip_blank (&line, next, &next);
 517
 518       len = _dbus_string_get_length (&line);
 519
 520       if ((len - next) == 0)
 521         {
 522           _dbus_verbose ("no secret key after ID and timestamp\n");
 523           continue;
 524         }
 525
 526       /* We have all three parts */
 527       new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
 528       if (new == NULL)
 529         {
 530           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 531           goto out;
 532         }
 533
 534       keys = new;
 535       n_keys += 1;
 536
 537       if (!_dbus_string_init (&keys[n_keys-1].secret))
 538         {
 539           n_keys -= 1; /* we don't want to free the one we didn't init */
 540           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 541           goto out;
 542         }
 543
 544       keys[n_keys-1].id = id;
 545       keys[n_keys-1].creation_time = timestamp;
 546       if (!_dbus_string_hex_decode (&line, next, &end,
 547                                     &keys[n_keys-1].secret, 0))
 548         {
 549           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 550           goto out;
 551         }
 552
 553       if (_dbus_string_get_length (&line) != end)
 554         {
 555           _dbus_verbose ("invalid hex encoding in keyring file\n");
 556           _dbus_string_free (&keys[n_keys - 1].secret);
 557           n_keys -= 1;
 558           continue;
 559         }
 560     }
 561
 562   _dbus_verbose ("Successfully loaded %d existing keys\n",
 563                  n_keys);
 564
 565   if (add_new)
 566     {
 567       if (!add_new_key (&keys, &n_keys, error))
 568         {
 569           _dbus_verbose ("Failed to generate new key: %s\n",
 570                          error ? "(unknown)" : error->message);
 571           goto out;
 572         }
 573
 574       _dbus_string_set_length (&contents, 0);
 575
 576       i = 0;
 577       while (i < n_keys)
 578         {
 579           if (!_dbus_string_append_int (&contents,
 580                                         keys[i].id))
 581             goto nomem;
 582
 583           if (!_dbus_string_append_byte (&contents, ' '))
 584             goto nomem;
 585
 586           if (!_dbus_string_append_int (&contents,
 587                                         keys[i].creation_time))
 588             goto nomem;
 589
 590           if (!_dbus_string_append_byte (&contents, ' '))
 591             goto nomem;
 592
 593           if (!_dbus_string_hex_encode (&keys[i].secret, 0,
 594                                         &contents,
 595                                         _dbus_string_get_length (&contents)))
 596             goto nomem;
 597
 598           if (!_dbus_string_append_byte (&contents, '\n'))
 599             goto nomem;
 600
 601           ++i;
 602           continue;
 603
 604         nomem:
 605           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 606           goto out;
 607         }
 608
 609       if (!_dbus_string_save_to_file (&contents, &keyring->filename,
 610                                       error))
 611         goto out;
 612     }
 613
 614   if (keyring->keys)
 615     free_keys (keyring->keys, keyring->n_keys);
 616   keyring->keys = keys;
 617   keyring->n_keys = n_keys;
 618   keys = NULL;
 619   n_keys = 0;
 620
 621   retval = TRUE;
 622
 623  out:
 624   if (have_lock)
 625     _dbus_keyring_unlock (keyring);
 626
 627   if (! ((retval == TRUE && (error == NULL || error->name == NULL)) ||
 628          (retval == FALSE && (error == NULL || error->name != NULL))))
 629     {
 630       if (error && error->name)
 631         _dbus_verbose ("error is %s: %s\n", error->name, error->message);
 632       _dbus_warn ("returning %d but error pointer %p name %s\n",
 633                   retval, error, error->name ? error->name : "(none)");
 634       _dbus_assert_not_reached ("didn't handle errors properly");
 635     }
 636
 637   if (keys != NULL)
 638     {
 639       i = 0;
 640       while (i < n_keys)
 641         {
 642           _dbus_string_zero (&keys[i].secret);
 643           _dbus_string_free (&keys[i].secret);
 644           ++i;
 645         }
 646
 647       dbus_free (keys);
 648     }
 649
 650   _dbus_string_free (&contents);
 651   _dbus_string_free (&line);
 652
 653   return retval;
 654 }
 655
 656 /** @} */ /* end of internals */
 657
 658 /**
 659  * @addtogroup DBusKeyring
 660  *
 661  * @{
 662  */
 663
 664 /**
 665  * Increments reference count of the keyring
 666  *
 667  * @param keyring the keyring
 668  * @returns the keyring
 669  */
 670 DBusKeyring *
 671 _dbus_keyring_ref (DBusKeyring *keyring)
 672 {
 673   keyring->refcount += 1;
 674
 675   return keyring;
 676 }
 677
 678 /**
 679  * Decrements refcount and finalizes if it reaches
 680  * zero.
 681  *
 682  * @param keyring the keyring
 683  */
 684 void
 685 _dbus_keyring_unref (DBusKeyring *keyring)
 686 {
 687   keyring->refcount -= 1;
 688
 689   if (keyring->refcount == 0)
 690     {
 691       _dbus_string_free (&keyring->username);
 692       _dbus_string_free (&keyring->filename);
 693       _dbus_string_free (&keyring->filename_lock);
 694       _dbus_string_free (&keyring->directory);
 695       free_keys (keyring->keys, keyring->n_keys);
 696       dbus_free (keyring);
 697     }
 698 }
 699
 700 /**
 701  * Creates a new keyring that lives in the ~/.dbus-keyrings
 702  * directory of the given user. If the username is #NULL,
 703  * uses the user owning the current process.
 704  *
 705  * @param username username to get keyring for, or #NULL
 706  * @param context which keyring to get
 707  * @param error return location for errors
 708  * @returns the keyring or #NULL on error
 709  */
 710 DBusKeyring*
 711 _dbus_keyring_new_homedir (const DBusString *username,
 712                            const DBusString *context,
 713                            DBusError        *error)
 714 {
 715   DBusString homedir;
 716   DBusKeyring *keyring;
 717   dbus_bool_t error_set;
 718   DBusString dotdir;
 719   DBusError tmp_error;
 720
 721   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 722
 723   keyring = NULL;
 724   error_set = FALSE;
 725
 726   if (!_dbus_string_init (&homedir))
 727     {
 728       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 729       return FALSE;
 730     }
 731
 732   _dbus_string_init_const (&dotdir, ".dbus-keyrings");
 733
 734   if (username == NULL)
 735     {
 736       const DBusString *const_homedir;
 737
 738       if (!_dbus_username_from_current_process (&username) ||
 739           !_dbus_homedir_from_current_process (&const_homedir))
 740         goto failed;
 741
 742       if (!_dbus_string_copy (const_homedir, 0,
 743                               &homedir, 0))
 744         goto failed;
 745     }
 746   else
 747     {
 748       if (!_dbus_homedir_from_username (username, &homedir))
 749         goto failed;
 750     }
 751
 752 #ifdef DBUS_BUILD_TESTS
 753  {
 754    const char *override;
 755
 756    override = _dbus_getenv ("DBUS_TEST_HOMEDIR");
 757    if (override != NULL && *override != '\0')
 758      {
 759        _dbus_string_set_length (&homedir, 0);
 760        if (!_dbus_string_append (&homedir, override))
 761          _dbus_assert_not_reached ("no memory");
 762
 763        _dbus_verbose ("Using fake homedir for testing: %s\n",
 764                       _dbus_string_get_const_data (&homedir));
 765      }
 766    else
 767      {
 768        static dbus_bool_t already_warned = FALSE;
 769        if (!already_warned)
 770          {
 771            _dbus_warn ("Using your real home directory for testing, set DBUS_TEST_HOMEDIR to avoid\n");
 772            already_warned = TRUE;
 773          }
 774      }
 775  }
 776 #endif
 777
 778   _dbus_assert (username != NULL);
 779
 780   keyring = _dbus_keyring_new ();
 781   if (keyring == NULL)
 782     goto failed;
 783
 784   /* should have been validated already, but paranoia check here */
 785   if (!_dbus_keyring_validate_context (context))
 786     {
 787       error_set = TRUE;
 788       dbus_set_error_const (error,
 789                             DBUS_ERROR_FAILED,
 790                             "Invalid context in keyring creation");
 791       goto failed;
 792     }
 793
 794   if (!_dbus_string_copy (username, 0,
 795                           &keyring->username, 0))
 796     goto failed;
 797
 798   if (!_dbus_string_copy (&homedir, 0,
 799                           &keyring->directory, 0))
 800     goto failed;
 801
 802   if (!_dbus_concat_dir_and_file (&keyring->directory,
 803                                   &dotdir))
 804     goto failed;
 805
 806   if (!_dbus_string_copy (&keyring->directory, 0,
 807                           &keyring->filename, 0))
 808     goto failed;
 809
 810   if (!_dbus_concat_dir_and_file (&keyring->filename,
 811                                   context))
 812     goto failed;
 813
 814   if (!_dbus_string_copy (&keyring->filename, 0,
 815                           &keyring->filename_lock, 0))
 816     goto failed;
 817
 818   if (!_dbus_string_append (&keyring->filename_lock, ".lock"))
 819     goto failed;
 820
 821   dbus_error_init (&tmp_error);
 822   if (!_dbus_keyring_reload (keyring, FALSE, &tmp_error))
 823     {
 824       _dbus_verbose ("didn't load an existing keyring: %s\n",
 825                      tmp_error.message);
 826       dbus_error_free (&tmp_error);
 827     }
 828
 829   /* We don't fail fatally if we can't create the directory,
 830    * but the keyring will probably always be empty
 831    * unless someone else manages to create it
 832    */
 833   dbus_error_init (&tmp_error);
 834   if (!_dbus_create_directory (&keyring->directory,
 835                                &tmp_error))
 836     {
 837       _dbus_verbose ("Creating keyring directory: %s\n",
 838                      tmp_error.message);
 839       dbus_error_free (&tmp_error);
 840     }
 841
 842   _dbus_string_free (&homedir);
 843
 844   return keyring;
 845
 846  failed:
 847   if (!error_set)
 848     dbus_set_error_const (error,
 849                           DBUS_ERROR_NO_MEMORY,
 850                           NULL);
 851   if (keyring)
 852     _dbus_keyring_unref (keyring);
 853   _dbus_string_free (&homedir);
 854   return FALSE;
 855
 856 }
 857
 858 /**
 859  * Checks whether the context is a valid context.
 860  * Contexts that might cause confusion when used
 861  * in filenames are not allowed (contexts can't
 862  * start with a dot or contain dir separators).
 863  *
 864  * @todo this is the most inefficient implementation
 865  * imaginable.
 866  *
 867  * @param context the context
 868  * @returns #TRUE if valid
 869  */
 870 dbus_bool_t
 871 _dbus_keyring_validate_context (const DBusString *context)
 872 {
 873   if (_dbus_string_get_length (context) == 0)
 874     {
 875       _dbus_verbose ("context is zero-length\n");
 876       return FALSE;
 877     }
 878
 879   if (!_dbus_string_validate_ascii (context, 0,
 880                                     _dbus_string_get_length (context)))
 881     {
 882       _dbus_verbose ("context not valid ascii\n");
 883       return FALSE;
 884     }
 885
 886   /* no directory separators */
 887   if (_dbus_string_find (context, 0, "/", NULL))
 888     {
 889       _dbus_verbose ("context contains a slash\n");
 890       return FALSE;
 891     }
 892
 893   if (_dbus_string_find (context, 0, "\\", NULL))
 894     {
 895       _dbus_verbose ("context contains a backslash\n");
 896       return FALSE;
 897     }
 898
 899   /* prevent attempts to use dotfiles or ".." or ".lock"
 900    * all of which might allow some kind of attack
 901    */
 902   if (_dbus_string_find (context, 0, ".", NULL))
 903     {
 904       _dbus_verbose ("context contains a dot\n");
 905       return FALSE;
 906     }
 907
 908   /* no spaces/tabs, those are used for separators in the protocol */
 909   if (_dbus_string_find_blank (context, 0, NULL))
 910     {
 911       _dbus_verbose ("context contains a blank\n");
 912       return FALSE;
 913     }
 914
 915   if (_dbus_string_find (context, 0, "\n", NULL))
 916     {
 917       _dbus_verbose ("context contains a newline\n");
 918       return FALSE;
 919     }
 920
 921   if (_dbus_string_find (context, 0, "\r", NULL))
 922     {
 923       _dbus_verbose ("context contains a carriage return\n");
 924       return FALSE;
 925     }
 926
 927   return TRUE;
 928 }
 929
 930 static DBusKey*
 931 find_recent_key (DBusKeyring *keyring)
 932 {
 933   int i;
 934   long tv_sec, tv_usec;
 935
 936   _dbus_get_current_time (&tv_sec, &tv_usec);
 937
 938   i = 0;
 939   while (i < keyring->n_keys)
 940     {
 941       DBusKey *key = &keyring->keys[i];
 942
 943       _dbus_verbose ("Key %d is %ld seconds old\n",
 944                      i, tv_sec - key->creation_time);
 945
 946       if ((tv_sec - NEW_KEY_TIMEOUT_SECONDS) < key->creation_time)
 947         return key;
 948
 949       ++i;
 950     }
 951
 952   return NULL;
 953 }
 954
 955 /**
 956  * Gets a recent key to use for authentication.
 957  * If no recent key exists, creates one. Returns
 958  * the key ID. If a key can't be written to the keyring
 959  * file so no recent key can be created, returns -1.
 960  * All valid keys are > 0.
 961  *
 962  * @param keyring the keyring
 963  * @param error error on failure
 964  * @returns key ID to use for auth, or -1 on failure
 965  */
 966 int
 967 _dbus_keyring_get_best_key (DBusKeyring  *keyring,
 968                             DBusError    *error)
 969 {
 970   DBusKey *key;
 971
 972   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 973
 974   key = find_recent_key (keyring);
 975   if (key)
 976     return key->id;
 977
 978   /* All our keys are too old, or we've never loaded the
 979    * keyring. Create a new one.
 980    */
 981   if (!_dbus_keyring_reload (keyring, TRUE,
 982                              error))
 983     return -1;
 984
 985   key = find_recent_key (keyring);
 986   if (key)
 987     return key->id;
 988   else
 989     {
 990       dbus_set_error_const (error,
 991                             DBUS_ERROR_FAILED,
 992                             "No recent-enough key found in keyring, and unable to create a new key");
 993       return -1;
 994     }
 995 }
 996
 997 /**
 998  * Checks whether the keyring is for the given username.
 999  *
1000  * @param keyring the keyring
1001  * @param username the username to check
1002  *
1003  * @returns #TRUE if the keyring belongs to the given user
1004  */
1005 dbus_bool_t
1006 _dbus_keyring_is_for_user (DBusKeyring       *keyring,
1007                            const DBusString  *username)
1008 {
1009   return _dbus_string_equal (&keyring->username,
1010                              username);
1011 }
1012
1013 /**
1014  * Gets the hex-encoded secret key for the given ID.
1015  * Returns #FALSE if not enough memory. Returns #TRUE
1016  * but empty key on any other error such as unknown
1017  * key ID.
1018  *
1019  * @param keyring the keyring
1020  * @param key_id the key ID
1021  * @param hex_key string to append hex-encoded key to
1022  * @returns #TRUE if we had enough memory
1023  */
1024 dbus_bool_t
1025 _dbus_keyring_get_hex_key (DBusKeyring       *keyring,
1026                            int                key_id,
1027                            DBusString        *hex_key)
1028 {
1029   DBusKey *key;
1030
1031   key = find_key_by_id (keyring->keys,
1032                         keyring->n_keys,
1033                         key_id);
1034   if (key == NULL)
1035     return TRUE; /* had enough memory, so TRUE */
1036
1037   return _dbus_string_hex_encode (&key->secret, 0,
1038                                   hex_key,
1039                                   _dbus_string_get_length (hex_key));
1040 }
1041
1042 /** @} */ /* end of exposed API */
1043
1044 #ifdef DBUS_BUILD_TESTS
1045 #include "dbus-test.h"
1046 #include <stdio.h>
1047
1048 dbus_bool_t
1049 _dbus_keyring_test (void)
1050 {
1051   DBusString context;
1052   DBusKeyring *ring1;
1053   DBusKeyring *ring2;
1054   int id;
1055   DBusError error;
1056   int i;
1057
1058   ring1 = NULL;
1059   ring2 = NULL;
1060
1061   /* Context validation */
1062
1063   _dbus_string_init_const (&context, "foo");
1064   _dbus_assert (_dbus_keyring_validate_context (&context));
1065   _dbus_string_init_const (&context, "org_freedesktop_blah");
1066   _dbus_assert (_dbus_keyring_validate_context (&context));
1067
1068   _dbus_string_init_const (&context, "");
1069   _dbus_assert (!_dbus_keyring_validate_context (&context));
1070   _dbus_string_init_const (&context, ".foo");
1071   _dbus_assert (!_dbus_keyring_validate_context (&context));
1072   _dbus_string_init_const (&context, "bar.foo");
1073   _dbus_assert (!_dbus_keyring_validate_context (&context));
1074   _dbus_string_init_const (&context, "bar/foo");
1075   _dbus_assert (!_dbus_keyring_validate_context (&context));
1076   _dbus_string_init_const (&context, "bar\\foo");
1077   _dbus_assert (!_dbus_keyring_validate_context (&context));
1078   _dbus_string_init_const (&context, "foo\xfa\xf0");
1079   _dbus_assert (!_dbus_keyring_validate_context (&context));
1080   _dbus_string_init_const (&context, "foo\x80");
1081   _dbus_assert (!_dbus_keyring_validate_context (&context));
1082   _dbus_string_init_const (&context, "foo\x7f");
1083   _dbus_assert (_dbus_keyring_validate_context (&context));
1084   _dbus_string_init_const (&context, "foo bar");
1085   _dbus_assert (!_dbus_keyring_validate_context (&context));
1086
1087   if (!_dbus_string_init (&context))
1088     _dbus_assert_not_reached ("no memory");
1089   if (!_dbus_string_append_byte (&context, '\0'))
1090     _dbus_assert_not_reached ("no memory");
1091   _dbus_assert (!_dbus_keyring_validate_context (&context));
1092   _dbus_string_free (&context);
1093
1094   /* Now verify that if we create a key in keyring 1,
1095    * it is properly loaded in keyring 2
1096    */
1097
1098   _dbus_string_init_const (&context, "org_freedesktop_dbus_testsuite");
1099   dbus_error_init (&error);
1100   ring1 = _dbus_keyring_new_homedir (NULL, &context,
1101                                      &error);
1102   _dbus_assert (ring1);
1103   _dbus_assert (error.name == NULL);
1104
1105   id = _dbus_keyring_get_best_key (ring1, &error);
1106   if (id < 0)
1107     {
1108       fprintf (stderr, "Could not load keyring: %s\n", error.message);
1109       dbus_error_free (&error);
1110       goto failure;
1111     }
1112
1113   ring2 = _dbus_keyring_new_homedir (NULL, &context, &error);
1114   _dbus_assert (ring2);
1115   _dbus_assert (error.name == NULL);
1116
1117   if (ring1->n_keys != ring2->n_keys)
1118     {
1119       fprintf (stderr, "Different number of keys in keyrings\n");
1120       goto failure;
1121     }
1122
1123   /* We guarantee we load and save keeping keys in a fixed
1124    * order
1125    */
1126   i = 0;
1127   while (i < ring1->n_keys)
1128     {
1129       if (ring1->keys[i].id != ring2->keys[i].id)
1130         {
1131           fprintf (stderr, "Keyring 1 has first key ID %d and keyring 2 has %d\n",
1132                    ring1->keys[i].id, ring2->keys[i].id);
1133           goto failure;
1134         }
1135
1136       if (ring1->keys[i].creation_time != ring2->keys[i].creation_time)
1137         {
1138           fprintf (stderr, "Keyring 1 has first key time %ld and keyring 2 has %ld\n",
1139                    ring1->keys[i].creation_time, ring2->keys[i].creation_time);
1140           goto failure;
1141         }
1142
1143       if (!_dbus_string_equal (&ring1->keys[i].secret,
1144                                &ring2->keys[i].secret))
1145         {
1146           fprintf (stderr, "Keyrings 1 and 2 have different secrets for same ID/timestamp\n");
1147           goto failure;
1148         }
1149
1150       ++i;
1151     }
1152
1153   printf (" %d keys in test\n", ring1->n_keys);
1154
1155   /* Test ref/unref */
1156   _dbus_keyring_ref (ring1);
1157   _dbus_keyring_ref (ring2);
1158   _dbus_keyring_unref (ring1);
1159   _dbus_keyring_unref (ring2);
1160
1161
1162   /* really unref */
1163   _dbus_keyring_unref (ring1);
1164   _dbus_keyring_unref (ring2);
1165
1166   return TRUE;
1167
1168  failure:
1169   if (ring1)
1170     _dbus_keyring_unref (ring1);
1171   if (ring2)
1172     _dbus_keyring_unref (ring2);
1173
1174   return FALSE;
1175 }
1176
1177 #endif /* DBUS_BUILD_TESTS */
1178