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/dbus-string.h>
  26 #include <dbus/dbus-list.h>
  27 #include <dbus/dbus-sysdeps.h>
  28
  29 /**
  30  * @defgroup DBusKeyring keyring class
  31  * @ingroup  DBusInternals
  32  * @brief DBusKeyring data structure
  33  *
  34  * Types and functions related to DBusKeyring. DBusKeyring is intended
  35  * to manage cookies used to authenticate clients to servers.  This is
  36  * essentially the "verify that client can read the user's homedir"
  37  * authentication mechanism.  Both client and server must have access
  38  * to the homedir.
  39  *
  40  * The secret keys are not kept in locked memory, and are written to a
  41  * file in the user's homedir. However they are transient (only used
  42  * by a single server instance for a fixed period of time, then
  43  * discarded). Also, the keys are not sent over the wire.
  44  */
  45
  46 /**
  47  * @defgroup DBusKeyringInternals DBusKeyring implementation details
  48  * @ingroup  DBusInternals
  49  * @brief DBusKeyring implementation details
  50  *
  51  * The guts of DBusKeyring.
  52  *
  53  * @{
  54  */
  55
  56 typedef struct
  57 {
  58   dbus_uint32_t id; /**< identifier used to refer to the key */
  59
  60   unsigned long creation_time; /**< when the key was generated,
  61                                 *   as unix timestamp
  62                                 */
  63
  64   DBusString context; /**< Name of kind of server using this
  65                        *   key, for example "desktop_session_bus"
  66                        */
  67
  68   DBusString secret; /**< the actual key */
  69
  70 } DBusKey;
  71
  72 /**
  73  * @brief Internals of DBusKeyring.
  74  *
  75  * DBusKeyring internals. DBusKeyring is an opaque object, it must be
  76  * used via accessor functions.
  77  */
  78 struct DBusKeyring
  79 {
  80   DBusString filename;
  81   DBusString lock_filename;
  82
  83
  84 };
  85
  86 /** @} */ /* end of internals */
  87
  88 /**
  89  * @addtogroup DBusKeyring
  90  *
  91  * @{
  92  */
  93
  94
  95 /** @} */ /* end of public API */