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 1.2
   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       DBusKey *new;
 478
 479       /* Don't load more than the max. */
 480       if (n_keys >= (add_new ? MAX_KEYS_IN_FILE : MAX_KEYS_IN_FILE - 1))
 481         break;
 482
 483       next = 0;
 484       if (!_dbus_string_parse_int (&line, 0, &val, &next))
 485         {
 486           _dbus_verbose ("could not parse secret key ID at start of line\n");
 487           continue;
 488         }
 489
 490       if (val > _DBUS_INT_MAX || val < 0)
 491         {
 492           _dbus_verbose ("invalid secret key ID at start of line\n");
 493           continue;
 494         }
 495
 496       id = val;
 497
 498       _dbus_string_skip_blank (&line, next, &next);
 499
 500       if (!_dbus_string_parse_int (&line, next, &timestamp, &next))
 501         {
 502           _dbus_verbose ("could not parse secret key timestamp\n");
 503           continue;
 504         }
 505
 506       if (timestamp < 0 ||
 507           (now + MAX_TIME_TRAVEL_SECONDS) < timestamp ||
 508           (now - EXPIRE_KEYS_TIMEOUT_SECONDS) > timestamp)
 509         {
 510           _dbus_verbose ("dropping/ignoring %ld-seconds old key with timestamp %ld as current time is %ld\n",
 511                          now - timestamp, timestamp, now);
 512           continue;
 513         }
 514
 515       _dbus_string_skip_blank (&line, next, &next);
 516
 517       len = _dbus_string_get_length (&line);
 518
 519       if ((len - next) == 0)
 520         {
 521           _dbus_verbose ("no secret key after ID and timestamp\n");
 522           continue;
 523         }
 524
 525       /* We have all three parts */
 526       new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
 527       if (new == NULL)
 528         {
 529           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 530           goto out;
 531         }
 532
 533       keys = new;
 534       n_keys += 1;
 535
 536       if (!_dbus_string_init (&keys[n_keys-1].secret))
 537         {
 538           n_keys -= 1; /* we don't want to free the one we didn't init */
 539           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 540           goto out;
 541         }
 542
 543       keys[n_keys-1].id = id;
 544       keys[n_keys-1].creation_time = timestamp;
 545       if (!_dbus_string_hex_decode (&line, next,
 546                                     &keys[n_keys-1].secret,
 547                                     0))
 548         {
 549           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 550           goto out;
 551         }
 552     }
 553
 554   _dbus_verbose ("Successfully loaded %d existing keys\n",
 555                  n_keys);
 556
 557   if (add_new)
 558     {
 559       if (!add_new_key (&keys, &n_keys, error))
 560         {
 561           _dbus_verbose ("Failed to generate new key: %s\n",
 562                          error ? "(unknown)" : error->message);
 563           goto out;
 564         }
 565
 566       _dbus_string_set_length (&contents, 0);
 567
 568       i = 0;
 569       while (i < n_keys)
 570         {
 571           if (!_dbus_string_append_int (&contents,
 572                                         keys[i].id))
 573             goto nomem;
 574
 575           if (!_dbus_string_append_byte (&contents, ' '))
 576             goto nomem;
 577
 578           if (!_dbus_string_append_int (&contents,
 579                                         keys[i].creation_time))
 580             goto nomem;
 581
 582           if (!_dbus_string_append_byte (&contents, ' '))
 583             goto nomem;
 584
 585           if (!_dbus_string_hex_encode (&keys[i].secret, 0,
 586                                         &contents,
 587                                         _dbus_string_get_length (&contents)))
 588             goto nomem;
 589
 590           if (!_dbus_string_append_byte (&contents, '\n'))
 591             goto nomem;
 592
 593           ++i;
 594           continue;
 595
 596         nomem:
 597           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 598           goto out;
 599         }
 600
 601       if (!_dbus_string_save_to_file (&contents, &keyring->filename,
 602                                       error))
 603         goto out;
 604     }
 605
 606   if (keyring->keys)
 607     free_keys (keyring->keys, keyring->n_keys);
 608   keyring->keys = keys;
 609   keyring->n_keys = n_keys;
 610   keys = NULL;
 611   n_keys = 0;
 612
 613   retval = TRUE;
 614
 615  out:
 616   if (have_lock)
 617     _dbus_keyring_unlock (keyring);
 618
 619   if (! ((retval == TRUE && (error == NULL || error->name == NULL)) ||
 620          (retval == FALSE && (error == NULL || error->name != NULL))))
 621     {
 622       if (error && error->name)
 623         _dbus_verbose ("error is %s: %s\n", error->name, error->message);
 624       _dbus_warn ("returning %d but error pointer %p name %s\n",
 625                   retval, error, error->name ? error->name : "(none)");
 626       _dbus_assert_not_reached ("didn't handle errors properly");
 627     }
 628
 629   if (keys != NULL)
 630     {
 631       i = 0;
 632       while (i < n_keys)
 633         {
 634           _dbus_string_zero (&keys[i].secret);
 635           _dbus_string_free (&keys[i].secret);
 636           ++i;
 637         }
 638
 639       dbus_free (keys);
 640     }
 641
 642   _dbus_string_free (&contents);
 643   _dbus_string_free (&line);
 644
 645   return retval;
 646 }
 647
 648 /** @} */ /* end of internals */
 649
 650 /**
 651  * @addtogroup DBusKeyring
 652  *
 653  * @{
 654  */
 655
 656 /**
 657  * Increments reference count of the keyring
 658  *
 659  * @param keyring the keyring
 660  */
 661 void
 662 _dbus_keyring_ref (DBusKeyring *keyring)
 663 {
 664   keyring->refcount += 1;
 665 }
 666
 667 /**
 668  * Decrements refcount and finalizes if it reaches
 669  * zero.
 670  *
 671  * @param keyring the keyring
 672  */
 673 void
 674 _dbus_keyring_unref (DBusKeyring *keyring)
 675 {
 676   keyring->refcount -= 1;
 677
 678   if (keyring->refcount == 0)
 679     {
 680       _dbus_string_free (&keyring->username);
 681       _dbus_string_free (&keyring->filename);
 682       _dbus_string_free (&keyring->filename_lock);
 683       _dbus_string_free (&keyring->directory);
 684       free_keys (keyring->keys, keyring->n_keys);
 685       dbus_free (keyring);
 686     }
 687 }
 688
 689 /**
 690  * Creates a new keyring that lives in the ~/.dbus-keyrings
 691  * directory of the given user. If the username is #NULL,
 692  * uses the user owning the current process.
 693  *
 694  * @param username username to get keyring for, or #NULL
 695  * @param context which keyring to get
 696  * @param error return location for errors
 697  * @returns the keyring or #NULL on error
 698  */
 699 DBusKeyring*
 700 _dbus_keyring_new_homedir (const DBusString *username,
 701                            const DBusString *context,
 702                            DBusError        *error)
 703 {
 704   DBusString homedir;
 705   DBusKeyring *keyring;
 706   dbus_bool_t error_set;
 707   DBusString dotdir;
 708   DBusError tmp_error;
 709
 710   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 711
 712   keyring = NULL;
 713   error_set = FALSE;
 714
 715   if (!_dbus_string_init (&homedir))
 716     {
 717       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 718       return FALSE;
 719     }
 720
 721   _dbus_string_init_const (&dotdir, ".dbus-keyrings");
 722
 723   if (username == NULL)
 724     {
 725       const DBusString *const_homedir;
 726
 727       if (!_dbus_username_from_current_process (&username) ||
 728           !_dbus_homedir_from_current_process (&const_homedir))
 729         goto failed;
 730
 731       if (!_dbus_string_copy (const_homedir, 0,
 732                               &homedir, 0))
 733         goto failed;
 734     }
 735   else
 736     {
 737       if (!_dbus_homedir_from_username (username, &homedir))
 738         goto failed;
 739     }
 740
 741 #ifdef DBUS_BUILD_TESTS
 742  {
 743    const char *override;
 744
 745    override = _dbus_getenv ("DBUS_TEST_HOMEDIR");
 746    if (override != NULL && *override != '\0')
 747      {
 748        _dbus_string_set_length (&homedir, 0);
 749        if (!_dbus_string_append (&homedir, override))
 750          _dbus_assert_not_reached ("no memory");
 751
 752        _dbus_verbose ("Using fake homedir for testing: %s\n",
 753                       _dbus_string_get_const_data (&homedir));
 754      }
 755    else
 756      {
 757        static dbus_bool_t already_warned = FALSE;
 758        if (!already_warned)
 759          {
 760            _dbus_warn ("Using your real home directory for testing, set DBUS_TEST_HOMEDIR to avoid\n");
 761            already_warned = TRUE;
 762          }
 763      }
 764  }
 765 #endif
 766
 767   _dbus_assert (username != NULL);
 768
 769   keyring = _dbus_keyring_new ();
 770   if (keyring == NULL)
 771     goto failed;
 772
 773   /* should have been validated already, but paranoia check here */
 774   if (!_dbus_keyring_validate_context (context))
 775     {
 776       error_set = TRUE;
 777       dbus_set_error_const (error,
 778                             DBUS_ERROR_FAILED,
 779                             "Invalid context in keyring creation");
 780       goto failed;
 781     }
 782
 783   if (!_dbus_string_copy (username, 0,
 784                           &keyring->username, 0))
 785     goto failed;
 786
 787   if (!_dbus_string_copy (&homedir, 0,
 788                           &keyring->directory, 0))
 789     goto failed;
 790
 791   if (!_dbus_concat_dir_and_file (&keyring->directory,
 792                                   &dotdir))
 793     goto failed;
 794
 795   if (!_dbus_string_copy (&keyring->directory, 0,
 796                           &keyring->filename, 0))
 797     goto failed;
 798
 799   if (!_dbus_concat_dir_and_file (&keyring->filename,
 800                                   context))
 801     goto failed;
 802
 803   if (!_dbus_string_copy (&keyring->filename, 0,
 804                           &keyring->filename_lock, 0))
 805     goto failed;
 806
 807   if (!_dbus_string_append (&keyring->filename_lock, ".lock"))
 808     goto failed;
 809
 810   dbus_error_init (&tmp_error);
 811   if (!_dbus_keyring_reload (keyring, FALSE, &tmp_error))
 812     {
 813       _dbus_verbose ("didn't load an existing keyring: %s\n",
 814                      tmp_error.message);
 815       dbus_error_free (&tmp_error);
 816     }
 817
 818   /* We don't fail fatally if we can't create the directory,
 819    * but the keyring will probably always be empty
 820    * unless someone else manages to create it
 821    */
 822   dbus_error_init (&tmp_error);
 823   if (!_dbus_create_directory (&keyring->directory,
 824                                &tmp_error))
 825     {
 826       _dbus_verbose ("Creating keyring directory: %s\n",
 827                      tmp_error.message);
 828       dbus_error_free (&tmp_error);
 829     }
 830
 831   _dbus_string_free (&homedir);
 832
 833   return keyring;
 834
 835  failed:
 836   if (!error_set)
 837     dbus_set_error_const (error,
 838                           DBUS_ERROR_NO_MEMORY,
 839                           NULL);
 840   if (keyring)
 841     _dbus_keyring_unref (keyring);
 842   _dbus_string_free (&homedir);
 843   return FALSE;
 844
 845 }
 846
 847 /**
 848  * Checks whether the context is a valid context.
 849  * Contexts that might cause confusion when used
 850  * in filenames are not allowed (contexts can't
 851  * start with a dot or contain dir separators).
 852  *
 853  * @todo this is the most inefficient implementation
 854  * imaginable.
 855  *
 856  * @param context the context
 857  * @returns #TRUE if valid
 858  */
 859 dbus_bool_t
 860 _dbus_keyring_validate_context (const DBusString *context)
 861 {
 862   if (_dbus_string_get_length (context) == 0)
 863     {
 864       _dbus_verbose ("context is zero-length\n");
 865       return FALSE;
 866     }
 867
 868   if (!_dbus_string_validate_ascii (context, 0,
 869                                     _dbus_string_get_length (context)))
 870     {
 871       _dbus_verbose ("context not valid ascii\n");
 872       return FALSE;
 873     }
 874
 875   /* no directory separators */
 876   if (_dbus_string_find (context, 0, "/", NULL))
 877     {
 878       _dbus_verbose ("context contains a slash\n");
 879       return FALSE;
 880     }
 881
 882   if (_dbus_string_find (context, 0, "\\", NULL))
 883     {
 884       _dbus_verbose ("context contains a backslash\n");
 885       return FALSE;
 886     }
 887
 888   /* prevent attempts to use dotfiles or ".." or ".lock"
 889    * all of which might allow some kind of attack
 890    */
 891   if (_dbus_string_find (context, 0, ".", NULL))
 892     {
 893       _dbus_verbose ("context contains a dot\n");
 894       return FALSE;
 895     }
 896
 897   /* no spaces/tabs, those are used for separators in the protocol */
 898   if (_dbus_string_find_blank (context, 0, NULL))
 899     {
 900       _dbus_verbose ("context contains a blank\n");
 901       return FALSE;
 902     }
 903
 904   if (_dbus_string_find (context, 0, "\n", NULL))
 905     {
 906       _dbus_verbose ("context contains a newline\n");
 907       return FALSE;
 908     }
 909
 910   if (_dbus_string_find (context, 0, "\r", NULL))
 911     {
 912       _dbus_verbose ("context contains a carriage return\n");
 913       return FALSE;
 914     }
 915
 916   return TRUE;
 917 }
 918
 919 static DBusKey*
 920 find_recent_key (DBusKeyring *keyring)
 921 {
 922   int i;
 923   long tv_sec, tv_usec;
 924
 925   _dbus_get_current_time (&tv_sec, &tv_usec);
 926
 927   i = 0;
 928   while (i < keyring->n_keys)
 929     {
 930       DBusKey *key = &keyring->keys[i];
 931
 932       _dbus_verbose ("Key %d is %ld seconds old\n",
 933                      i, tv_sec - key->creation_time);
 934
 935       if ((tv_sec - NEW_KEY_TIMEOUT_SECONDS) < key->creation_time)
 936         return key;
 937
 938       ++i;
 939     }
 940
 941   return NULL;
 942 }
 943
 944 /**
 945  * Gets a recent key to use for authentication.
 946  * If no recent key exists, creates one. Returns
 947  * the key ID. If a key can't be written to the keyring
 948  * file so no recent key can be created, returns -1.
 949  * All valid keys are > 0.
 950  *
 951  * @param keyring the keyring
 952  * @param error error on failure
 953  * @returns key ID to use for auth, or -1 on failure
 954  */
 955 int
 956 _dbus_keyring_get_best_key (DBusKeyring  *keyring,
 957                             DBusError    *error)
 958 {
 959   DBusKey *key;
 960
 961   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 962
 963   key = find_recent_key (keyring);
 964   if (key)
 965     return key->id;
 966
 967   /* All our keys are too old, or we've never loaded the
 968    * keyring. Create a new one.
 969    */
 970   if (!_dbus_keyring_reload (keyring, TRUE,
 971                              error))
 972     return -1;
 973
 974   key = find_recent_key (keyring);
 975   if (key)
 976     return key->id;
 977   else
 978     {
 979       dbus_set_error_const (error,
 980                             DBUS_ERROR_FAILED,
 981                             "No recent-enough key found in keyring, and unable to create a new key");
 982       return -1;
 983     }
 984 }
 985
 986 /**
 987  * Checks whether the keyring is for the given username.
 988  *
 989  * @param keyring the keyring
 990  * @param username the username to check
 991  *
 992  * @returns #TRUE if the keyring belongs to the given user
 993  */
 994 dbus_bool_t
 995 _dbus_keyring_is_for_user (DBusKeyring       *keyring,
 996                            const DBusString  *username)
 997 {
 998   return _dbus_string_equal (&keyring->username,
 999                              username);
1000 }
1001
1002 /**
1003  * Gets the hex-encoded secret key for the given ID.
1004  * Returns #FALSE if not enough memory. Returns #TRUE
1005  * but empty key on any other error such as unknown
1006  * key ID.
1007  *
1008  * @param keyring the keyring
1009  * @param key_id the key ID
1010  * @param hex_key string to append hex-encoded key to
1011  * @returns #TRUE if we had enough memory
1012  */
1013 dbus_bool_t
1014 _dbus_keyring_get_hex_key (DBusKeyring       *keyring,
1015                            int                key_id,
1016                            DBusString        *hex_key)
1017 {
1018   DBusKey *key;
1019
1020   key = find_key_by_id (keyring->keys,
1021                         keyring->n_keys,
1022                         key_id);
1023   if (key == NULL)
1024     return TRUE; /* had enough memory, so TRUE */
1025
1026   return _dbus_string_hex_encode (&key->secret, 0,
1027                                   hex_key,
1028                                   _dbus_string_get_length (hex_key));
1029 }
1030
1031 /** @} */ /* end of exposed API */
1032
1033 #ifdef DBUS_BUILD_TESTS
1034 #include "dbus-test.h"
1035 #include <stdio.h>
1036
1037 dbus_bool_t
1038 _dbus_keyring_test (void)
1039 {
1040   DBusString context;
1041   DBusKeyring *ring1;
1042   DBusKeyring *ring2;
1043   int id;
1044   DBusError error;
1045   int i;
1046
1047   ring1 = NULL;
1048   ring2 = NULL;
1049
1050   /* Context validation */
1051
1052   _dbus_string_init_const (&context, "foo");
1053   _dbus_assert (_dbus_keyring_validate_context (&context));
1054   _dbus_string_init_const (&context, "org_freedesktop_blah");
1055   _dbus_assert (_dbus_keyring_validate_context (&context));
1056
1057   _dbus_string_init_const (&context, "");
1058   _dbus_assert (!_dbus_keyring_validate_context (&context));
1059   _dbus_string_init_const (&context, ".foo");
1060   _dbus_assert (!_dbus_keyring_validate_context (&context));
1061   _dbus_string_init_const (&context, "bar.foo");
1062   _dbus_assert (!_dbus_keyring_validate_context (&context));
1063   _dbus_string_init_const (&context, "bar/foo");
1064   _dbus_assert (!_dbus_keyring_validate_context (&context));
1065   _dbus_string_init_const (&context, "bar\\foo");
1066   _dbus_assert (!_dbus_keyring_validate_context (&context));
1067   _dbus_string_init_const (&context, "foo\xfa\xf0");
1068   _dbus_assert (!_dbus_keyring_validate_context (&context));
1069   _dbus_string_init_const (&context, "foo\x80");
1070   _dbus_assert (!_dbus_keyring_validate_context (&context));
1071   _dbus_string_init_const (&context, "foo\x7f");
1072   _dbus_assert (_dbus_keyring_validate_context (&context));
1073   _dbus_string_init_const (&context, "foo bar");
1074   _dbus_assert (!_dbus_keyring_validate_context (&context));
1075
1076   if (!_dbus_string_init (&context))
1077     _dbus_assert_not_reached ("no memory");
1078   if (!_dbus_string_append_byte (&context, '\0'))
1079     _dbus_assert_not_reached ("no memory");
1080   _dbus_assert (!_dbus_keyring_validate_context (&context));
1081   _dbus_string_free (&context);
1082
1083   /* Now verify that if we create a key in keyring 1,
1084    * it is properly loaded in keyring 2
1085    */
1086
1087   _dbus_string_init_const (&context, "org_freedesktop_dbus_testsuite");
1088   dbus_error_init (&error);
1089   ring1 = _dbus_keyring_new_homedir (NULL, &context,
1090                                      &error);
1091   _dbus_assert (ring1);
1092   _dbus_assert (error.name == NULL);
1093
1094   id = _dbus_keyring_get_best_key (ring1, &error);
1095   if (id < 0)
1096     {
1097       fprintf (stderr, "Could not load keyring: %s\n", error.message);
1098       dbus_error_free (&error);
1099       goto failure;
1100     }
1101
1102   ring2 = _dbus_keyring_new_homedir (NULL, &context, &error);
1103   _dbus_assert (ring2);
1104   _dbus_assert (error.name == NULL);
1105
1106   if (ring1->n_keys != ring2->n_keys)
1107     {
1108       fprintf (stderr, "Different number of keys in keyrings\n");
1109       goto failure;
1110     }
1111
1112   /* We guarantee we load and save keeping keys in a fixed
1113    * order
1114    */
1115   i = 0;
1116   while (i < ring1->n_keys)
1117     {
1118       if (ring1->keys[i].id != ring2->keys[i].id)
1119         {
1120           fprintf (stderr, "Keyring 1 has first key ID %d and keyring 2 has %d\n",
1121                    ring1->keys[i].id, ring2->keys[i].id);
1122           goto failure;
1123         }
1124
1125       if (ring1->keys[i].creation_time != ring2->keys[i].creation_time)
1126         {
1127           fprintf (stderr, "Keyring 1 has first key time %ld and keyring 2 has %ld\n",
1128                    ring1->keys[i].creation_time, ring2->keys[i].creation_time);
1129           goto failure;
1130         }
1131
1132       if (!_dbus_string_equal (&ring1->keys[i].secret,
1133                                &ring2->keys[i].secret))
1134         {
1135           fprintf (stderr, "Keyrings 1 and 2 have different secrets for same ID/timestamp\n");
1136           goto failure;
1137         }
1138
1139       ++i;
1140     }
1141
1142   printf (" %d keys in test\n", ring1->n_keys);
1143
1144   /* Test ref/unref */
1145   _dbus_keyring_ref (ring1);
1146   _dbus_keyring_ref (ring2);
1147   _dbus_keyring_unref (ring1);
1148   _dbus_keyring_unref (ring2);
1149
1150
1151   /* really unref */
1152   _dbus_keyring_unref (ring1);
1153   _dbus_keyring_unref (ring2);
1154
1155   return TRUE;
1156
1157  failure:
1158   if (ring1)
1159     _dbus_keyring_unref (ring1);
1160   if (ring2)
1161     _dbus_keyring_unref (ring2);
1162
1163   return FALSE;
1164 }
1165
1166 #endif /* DBUS_BUILD_TESTS */
1167