include/gsignond/gsignond-config-general.h

   1 /* vi: set et sw=4 ts=4 cino=t0,(0: */
   2 /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   3 /*
   4  * This file is part of gsignond
   5  *
   6  * Copyright (C) 2012 Intel Corporation.
   7  *
   8  * Contact: Amarnath Valluri <amarnath.valluri@linux.intel.com>
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  23  * 02110-1301 USA
  24  */
  25
  26 #ifndef __GSIGNOND_CONFIG_GENERAL_H_
  27 #define __GSIGNOND_CONFIG_GENERAL_H_
  28
  29 /**
  30  * SECTION:gsignond-config-general
  31  * @title: General configuration
  32  * @short_description: gSSO general configuration keys
  33  * @include: gsignond/gsignond-config.h
  34  *
  35  * General configuration keys are defined below. See #GSignondConfig for how to use them.
  36  */
  37
  38 /**
  39  * GSIGNOND_CONFIG_GENERAL:
  40  *
  41  * A prefix for general keys. Should be used only when defining new keys.
  42  */
  43 #define GSIGNOND_CONFIG_GENERAL                 "General"
  44
  45 /**
  46  * GSIGNOND_CONFIG_GENERAL_STORAGE_PATH:
  47  *
  48  * Base path for #GSignondStorageManager to operate in.
  49  *
  50  * Default value: "/var/db", can be overriden in debug
  51  * builds by setting SSO_STORAGE_PATH environment variable.
  52  */
  53 #define GSIGNOND_CONFIG_GENERAL_STORAGE_PATH    GSIGNOND_CONFIG_GENERAL \
  54                                                 "/StoragePath"
  55 /**
  56  * GSIGNOND_CONFIG_GENERAL_EXTENSION:
  57  *
  58  * The name of the gSSO extension to use. If not specified, the default
  59  * implementation is used (see #GSignondExtension).
  60  *
  61  * Can be overriden in debug
  62  * builds by setting SSO_EXTENSION environment variable.
  63  */
  64 #define GSIGNOND_CONFIG_GENERAL_EXTENSION       GSIGNOND_CONFIG_GENERAL \
  65                                                 "/Extension"
  66 /**
  67  * GSIGNOND_CONFIG_GENERAL_SECURE_DIR:
  68  *
  69  * Path provided by #GSignondStorageManager for storing user-specific
  70  * information, including secret and metadata databases.
  71  *
  72  * This is a run-time value and any value read from configuration file
  73  * is overwritten.
  74  *
  75  * Value provided by the default implementation:
  76  * #GSIGNOND_CONFIG_GENERAL_STORAGE_PATH + "/gsignond." + g_get_user_name().
  77  */
  78 #define GSIGNOND_CONFIG_GENERAL_SECURE_DIR      GSIGNOND_CONFIG_GENERAL \
  79                                                 "/SecureDir"
  80 /**
  81  * GSIGNOND_CONFIG_PLUGIN_TIMEOUT:
  82  *
  83  * A timeout in seconds, after which inactive plugin objects and processes are removed.
  84  * If not set, the plugin objects will persist for possible reuse.
  85  *
  86  * Can be overriden in debug
  87  * builds by setting SSO_PLUGIN_TIMEOUT environment variable.
  88  */
  89 #define GSIGNOND_CONFIG_PLUGIN_TIMEOUT          GSIGNOND_CONFIG_GENERAL \
  90                                                 "/PluginTimeout"
  91
  92 /**
  93  * GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX:
  94  *
  95  * System security context of the keychain UI process
  96  * (see #GSignondAccessControlManager).
  97  *
  98  * Default value can be defined through configure --enable-keychain flag (see
  99  * <link linkend="gsignond-building">Building gsignond</link>).
 100  */
 101 #define GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX GSIGNOND_CONFIG_GENERAL \
 102                                                 "/KeychainSystemContext"
 103
 104 #endif /* __GSIGNOND_GENERAL_CONFIG_H_ */