-/* -*- mode: C; c-file-style: "gnu" -*- */
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-keyring.c Store secret cookies in your homedir
*
- * Copyright (C) 2003 Red Hat Inc.
+ * Copyright (C) 2003, 2004 Red Hat Inc.
*
- * Licensed under the Academic Free License version 1.2
+ * Licensed under the Academic Free License version 2.1
*
* 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
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
+#include <config.h>
#include "dbus-keyring.h"
+#include "dbus-protocol.h"
#include <dbus/dbus-string.h>
#include <dbus/dbus-list.h>
#include <dbus/dbus-sysdeps.h>
* 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.
+ *
+ * @todo there's a memory leak on some codepath in here, I saw it once
+ * when running make check - probably some specific initial cookies
+ * present in the cookie file, then depending on what we do with them.
*/
/**
*/
#define MAX_TIME_TRAVEL_SECONDS (60*5)
+/**
+ * Maximum number of keys in the keyring before
+ * we just ignore the rest
+ */
+#ifdef DBUS_ENABLE_EMBEDDED_TESTS
+#define MAX_KEYS_IN_FILE 10
+#else
+#define MAX_KEYS_IN_FILE 256
+#endif
+
+/**
+ * A single key from the cookie file
+ */
typedef struct
{
dbus_int32_t id; /**< identifier used to refer to the key */
DBusString filename_lock; /**< Name of lockfile */
DBusKey *keys; /**< Keys loaded from the file */
int n_keys; /**< Number of keys */
+ DBusCredentials *credentials; /**< Credentials containing user the keyring is for */
};
static DBusKeyring*
if (keyring == NULL)
goto out_0;
- if (!_dbus_string_init (&keyring->directory, _DBUS_INT_MAX))
+ if (!_dbus_string_init (&keyring->directory))
goto out_1;
- if (!_dbus_string_init (&keyring->filename, _DBUS_INT_MAX))
+ if (!_dbus_string_init (&keyring->filename))
goto out_2;
- if (!_dbus_string_init (&keyring->filename_lock, _DBUS_INT_MAX))
+ if (!_dbus_string_init (&keyring->filename_lock))
goto out_3;
-
+
keyring->refcount = 1;
keyring->keys = NULL;
keyring->n_keys = 0;
return keyring;
-
+
out_3:
_dbus_string_free (&keyring->filename);
out_2:
n_timeouts = 0;
while (n_timeouts < MAX_LOCK_TIMEOUTS)
{
- DBusError error;
+ DBusError error = DBUS_ERROR_INIT;
- dbus_error_init (&error);
if (_dbus_create_file_exclusively (&keyring->filename_lock,
&error))
break;
if (n_timeouts == MAX_LOCK_TIMEOUTS)
{
- DBusError error;
-
+ DBusError error = DBUS_ERROR_INIT;
+
_dbus_verbose ("Lock file timed out %d times, assuming stale\n",
n_timeouts);
- dbus_error_init (&error);
-
if (!_dbus_delete_file (&keyring->filename_lock, &error))
{
_dbus_verbose ("Couldn't delete old lock file: %s\n",
static void
_dbus_keyring_unlock (DBusKeyring *keyring)
{
- DBusError error;
- dbus_error_init (&error);
+ DBusError error = DBUS_ERROR_INIT;
+
if (!_dbus_delete_file (&keyring->filename_lock, &error))
{
_dbus_warn ("Failed to delete lock file: %s\n",
DBusKey *new;
DBusString bytes;
int id;
- unsigned long timestamp;
+ long timestamp;
const unsigned char *s;
dbus_bool_t retval;
DBusKey *keys;
int n_keys;
-
- if (!_dbus_string_init (&bytes, _DBUS_INT_MAX))
+
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+ if (!_dbus_string_init (&bytes))
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to generate new secret key");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
return FALSE;
}
if (!_dbus_generate_random_bytes (&bytes, 4))
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to generate new secret key");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
- _dbus_string_get_const_data (&bytes, (const char**) &s);
+ s = (const unsigned char*) _dbus_string_get_const_data (&bytes);
id = s[0] | (s[1] << 8) | (s[2] << 16) | (s[3] << 24);
if (id < 0)
_dbus_string_set_length (&bytes, 0);
if (!_dbus_generate_random_bytes (&bytes, KEY_LENGTH_BYTES))
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to generate new secret key");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
if (new == NULL)
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to reallocate secret key list");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
keys = new;
+ *keys_p = keys; /* otherwise *keys_p ends up invalid */
n_keys += 1;
- if (!_dbus_string_init (&keys[n_keys-1].secret,
- _DBUS_INT_MAX))
+ if (!_dbus_string_init (&keys[n_keys-1].secret))
{
n_keys -= 1; /* we don't want to free the one we didn't init */
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to store secret key");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
- _dbus_get_current_time (×tamp, NULL);
+ _dbus_get_real_time (×tamp, NULL);
keys[n_keys-1].id = id;
keys[n_keys-1].creation_time = timestamp;
&keys[n_keys-1].secret,
0))
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to store secret key");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ _dbus_string_free (&keys[n_keys-1].secret);
+ n_keys -= 1;
goto out;
}
retval = TRUE;
out:
- if (retval)
- {
- *n_keys_p = n_keys;
- *keys_p = keys;
- }
+ *n_keys_p = n_keys;
_dbus_string_free (&bytes);
return retval;
{
DBusString contents;
DBusString line;
- DBusResultCode result;
dbus_bool_t retval;
dbus_bool_t have_lock;
DBusKey *keys;
int n_keys;
int i;
long now;
+ DBusError tmp_error;
+
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
- if (!_dbus_string_init (&contents, _DBUS_INT_MAX))
+ if (!_dbus_check_dir_is_private_to_user (&keyring->directory, error))
+ return FALSE;
+
+ if (!_dbus_string_init (&contents))
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to reload keyring");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
return FALSE;
}
- if (!_dbus_string_init (&line, _DBUS_INT_MAX))
+ if (!_dbus_string_init (&line))
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to reload keyring");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
_dbus_string_free (&contents);
return FALSE;
}
-
+
keys = NULL;
n_keys = 0;
retval = FALSE;
have_lock = FALSE;
- _dbus_get_current_time (&now, NULL);
+ _dbus_get_real_time (&now, NULL);
if (add_new)
{
have_lock = TRUE;
}
- result = _dbus_file_get_contents (&contents,
- &keyring->filename);
-
- if (result != DBUS_RESULT_SUCCESS)
+ dbus_error_init (&tmp_error);
+ if (!_dbus_file_get_contents (&contents,
+ &keyring->filename,
+ &tmp_error))
{
_dbus_verbose ("Failed to load keyring file: %s\n",
- dbus_result_to_string (result));
+ tmp_error.message);
/* continue with empty keyring file, so we recreate it */
+ dbus_error_free (&tmp_error);
}
if (!_dbus_string_validate_ascii (&contents, 0,
_dbus_warn ("Secret keyring file contains non-ASCII! Ignoring existing contents\n");
_dbus_string_set_length (&contents, 0);
}
-
+
+ /* FIXME this is badly inefficient for large keyring files
+ * (not that large keyring files exist outside of test suites)
+ */
while (_dbus_string_pop_line (&contents, &line))
{
int next;
int id;
long timestamp;
int len;
+ int end;
DBusKey *new;
+
+ /* Don't load more than the max. */
+ if (n_keys >= (add_new ? MAX_KEYS_IN_FILE - 1 : MAX_KEYS_IN_FILE))
+ break;
next = 0;
if (!_dbus_string_parse_int (&line, 0, &val, &next))
continue;
}
- if (val > _DBUS_INT_MAX || val < 0)
+ if (val > _DBUS_INT32_MAX || val < 0)
{
_dbus_verbose ("invalid secret key ID at start of line\n");
continue;
new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
if (new == NULL)
{
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to reallocate secret key list");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
keys = new;
n_keys += 1;
- if (!_dbus_string_init (&keys[n_keys-1].secret,
- _DBUS_INT_MAX))
+ if (!_dbus_string_init (&keys[n_keys-1].secret))
{
n_keys -= 1; /* we don't want to free the one we didn't init */
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to store secret key");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
keys[n_keys-1].id = id;
keys[n_keys-1].creation_time = timestamp;
- if (!_dbus_string_hex_decode (&line, next,
- &keys[n_keys-1].secret,
- 0))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to store secret key or invalid hex encoding");
- goto out;
- }
+ 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;
+ }
}
_dbus_verbose ("Successfully loaded %d existing keys\n",
if (!add_new_key (&keys, &n_keys, error))
{
_dbus_verbose ("Failed to generate new key: %s\n",
- error ? "(unknown)" : error->message);
+ error ? error->message : "(unknown)");
goto out;
}
continue;
nomem:
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
- "No memory to save secret keyring");
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
goto out;
}
- result = _dbus_string_save_to_file (&contents, &keyring->filename);
- if (result != DBUS_RESULT_SUCCESS)
- {
- dbus_set_error (error, DBUS_ERROR_FAILED,
- "Failed to save keyring file: %s",
- dbus_result_to_string (result));
- goto out;
- }
+ if (!_dbus_string_save_to_file (&contents, &keyring->filename,
+ FALSE, error))
+ goto out;
}
- dbus_free (keyring->keys);
+ if (keyring->keys)
+ free_keys (keyring->keys, keyring->n_keys);
keyring->keys = keys;
keyring->n_keys = n_keys;
keys = NULL;
i = 0;
while (i < n_keys)
{
+ _dbus_string_zero (&keys[i].secret);
_dbus_string_free (&keys[i].secret);
++i;
}
* Increments reference count of the keyring
*
* @param keyring the keyring
+ * @returns the keyring
*/
-void
+DBusKeyring *
_dbus_keyring_ref (DBusKeyring *keyring)
{
keyring->refcount += 1;
+
+ return keyring;
}
/**
if (keyring->refcount == 0)
{
+ if (keyring->credentials)
+ _dbus_credentials_unref (keyring->credentials);
+
_dbus_string_free (&keyring->filename);
_dbus_string_free (&keyring->filename_lock);
_dbus_string_free (&keyring->directory);
}
/**
- * Creates a new keyring that lives in the ~/.dbus-keyrings
- * directory of the given user. If the username is #NULL,
- * uses the user owning the current process.
+ * Creates a new keyring that lives in the ~/.dbus-keyrings directory
+ * of the user represented by @p credentials. If the @p credentials are
+ * #NULL or empty, uses those of the current process.
*
- * @param username username to get keyring for, or #NULL
+ * @param credentials a set of credentials representing a user or #NULL
* @param context which keyring to get
* @param error return location for errors
* @returns the keyring or #NULL on error
*/
DBusKeyring*
-_dbus_keyring_new_homedir (const DBusString *username,
- const DBusString *context,
- DBusError *error)
+_dbus_keyring_new_for_credentials (DBusCredentials *credentials,
+ const DBusString *context,
+ DBusError *error)
{
- DBusString homedir;
+ DBusString ringdir;
DBusKeyring *keyring;
dbus_bool_t error_set;
- DBusString dotdir;
DBusError tmp_error;
+ DBusCredentials *our_credentials;
+
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+ if (_dbus_check_setuid ())
+ {
+ dbus_set_error_const (error, DBUS_ERROR_NOT_SUPPORTED,
+ "Unable to create DBus keyring when setuid");
+ return NULL;
+ }
keyring = NULL;
error_set = FALSE;
+ our_credentials = NULL;
- if (!_dbus_string_init (&homedir, _DBUS_INT_MAX))
- return FALSE;
-
- _dbus_string_init_const (&dotdir, ".dbus-keyrings");
-
- if (username == NULL)
+ if (!_dbus_string_init (&ringdir))
{
- const DBusString *const_homedir;
-
- if (!_dbus_user_info_from_current_process (&username,
- &const_homedir,
- NULL))
- goto failed;
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ return NULL;
+ }
- if (!_dbus_string_copy (const_homedir, 0,
- &homedir, 0))
- goto failed;
+ if (credentials != NULL)
+ {
+ our_credentials = _dbus_credentials_copy (credentials);
}
else
{
- if (!_dbus_homedir_from_username (username, &homedir))
- goto failed;
+ our_credentials = _dbus_credentials_new_from_current_process ();
}
+
+ if (our_credentials == NULL)
+ goto failed;
+ if (_dbus_credentials_are_anonymous (our_credentials))
+ {
+ if (!_dbus_credentials_add_from_current_process (our_credentials))
+ goto failed;
+ }
+
+ if (!_dbus_append_keyring_directory_for_credentials (&ringdir,
+ our_credentials))
+ goto failed;
+
keyring = _dbus_keyring_new ();
if (keyring == NULL)
goto failed;
+ _dbus_assert (keyring->credentials == NULL);
+ keyring->credentials = our_credentials;
+ our_credentials = NULL; /* so we don't unref it again later */
+
/* should have been validated already, but paranoia check here */
if (!_dbus_keyring_validate_context (context))
{
"Invalid context in keyring creation");
goto failed;
}
-
- if (!_dbus_string_copy (&homedir, 0,
- &keyring->directory, 0))
- goto failed;
- _dbus_string_free (&homedir);
-
- if (!_dbus_concat_dir_and_file (&keyring->directory,
- &dotdir))
- goto failed;
+ /* Save keyring dir in the keyring object */
+ if (!_dbus_string_copy (&ringdir, 0,
+ &keyring->directory, 0))
+ goto failed;
+ /* Create keyring->filename based on keyring dir and context */
if (!_dbus_string_copy (&keyring->directory, 0,
&keyring->filename, 0))
goto failed;
context))
goto failed;
+ /* Create lockfile name */
if (!_dbus_string_copy (&keyring->filename, 0,
&keyring->filename_lock, 0))
goto failed;
if (!_dbus_string_append (&keyring->filename_lock, ".lock"))
goto failed;
+ /* Reload keyring */
dbus_error_init (&tmp_error);
if (!_dbus_keyring_reload (keyring, FALSE, &tmp_error))
{
tmp_error.message);
dbus_error_free (&tmp_error);
}
+
+ _dbus_string_free (&ringdir);
return keyring;
if (!error_set)
dbus_set_error_const (error,
DBUS_ERROR_NO_MEMORY,
- "No memory to create keyring");
+ NULL);
+ if (our_credentials)
+ _dbus_credentials_unref (our_credentials);
if (keyring)
_dbus_keyring_unref (keyring);
- _dbus_string_free (&homedir);
- return FALSE;
+ _dbus_string_free (&ringdir);
+ return NULL;
}
* in filenames are not allowed (contexts can't
* start with a dot or contain dir separators).
*
+ * @todo this is the most inefficient implementation
+ * imaginable.
+ *
* @param context the context
* @returns #TRUE if valid
*/
return FALSE;
}
+ /* 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;
+ }
+
return TRUE;
}
int i;
long tv_sec, tv_usec;
- _dbus_get_current_time (&tv_sec, &tv_usec);
+ _dbus_get_real_time (&tv_sec, &tv_usec);
i = 0;
while (i < keyring->n_keys)
{
DBusKey *key;
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
key = find_recent_key (keyring);
if (key)
return key->id;
}
}
+/**
+ * Checks whether the keyring is for the same user as the given credentials.
+ *
+ * @param keyring the keyring
+ * @param credentials the credentials to check
+ *
+ * @returns #TRUE if the keyring belongs to the given user
+ */
+dbus_bool_t
+_dbus_keyring_is_for_credentials (DBusKeyring *keyring,
+ DBusCredentials *credentials)
+{
+ return _dbus_credentials_same_user (keyring->credentials,
+ credentials);
+}
+
+/**
+ * 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));
+}
+
/** @} */ /* end of exposed API */
-#ifdef DBUS_BUILD_TESTS
+#ifdef DBUS_ENABLE_EMBEDDED_TESTS
#include "dbus-test.h"
#include <stdio.h>
_dbus_assert (!_dbus_keyring_validate_context (&context));
_dbus_string_init_const (&context, "foo\x7f");
_dbus_assert (_dbus_keyring_validate_context (&context));
+ _dbus_string_init_const (&context, "foo bar");
+ _dbus_assert (!_dbus_keyring_validate_context (&context));
- if (!_dbus_string_init (&context, _DBUS_INT_MAX))
+ if (!_dbus_string_init (&context))
_dbus_assert_not_reached ("no memory");
if (!_dbus_string_append_byte (&context, '\0'))
_dbus_assert_not_reached ("no memory");
_dbus_string_init_const (&context, "org_freedesktop_dbus_testsuite");
dbus_error_init (&error);
- ring1 = _dbus_keyring_new_homedir (NULL, &context,
- &error);
- _dbus_assert (ring1);
+ ring1 = _dbus_keyring_new_for_credentials (NULL, &context,
+ &error);
+ _dbus_assert (ring1 != NULL);
_dbus_assert (error.name == NULL);
id = _dbus_keyring_get_best_key (ring1, &error);
goto failure;
}
- ring2 = _dbus_keyring_new_homedir (NULL, &context, &error);
- _dbus_assert (ring2);
+ ring2 = _dbus_keyring_new_for_credentials (NULL, &context, &error);
+ _dbus_assert (ring2 != NULL);
_dbus_assert (error.name == NULL);
if (ring1->n_keys != ring2->n_keys)
printf (" %d keys in test\n", ring1->n_keys);
+ /* Test ref/unref */
+ _dbus_keyring_ref (ring1);
+ _dbus_keyring_ref (ring2);
+ _dbus_keyring_unref (ring1);
+ _dbus_keyring_unref (ring2);
+
+
+ /* really unref */
_dbus_keyring_unref (ring1);
_dbus_keyring_unref (ring2);
return FALSE;
}
-#endif /* DBUS_BUILD_TESTS */
+#endif /* DBUS_ENABLE_EMBEDDED_TESTS */
projects / platform / upstream / dbus.git / blobdiff