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  * GSIGNOND_CONFIG_GENERAL_STORAGE_PATH:
  46  *
  47  * Base path for #GSignondStorageManager to operate in.
  48  *
  49  * Default value: "/var/db", can be overriden in debug
  50  * builds by setting SSO_STORAGE_PATH environment variable.
  51  */
  52 #define GSIGNOND_CONFIG_GENERAL_STORAGE_PATH    GSIGNOND_CONFIG_GENERAL \
  53                                                 "/StoragePath"
  54 /**
  55  * GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR:
  56  *
  57  * The path where gSSO is looking for available extension modules.
  58  *
  59  * Default value: $(pkglibdir)/extensions, can be overriden in debug
  60  * builds by setting SSO_EXTENSIONS_DIR environment variable.
  61  */
  62 #define GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR  GSIGNOND_CONFIG_GENERAL \
  63                                                 "/ExtensionsDir"
  64 /**
  65  * GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR:
  66  *
  67  * The path where gSSO is looking for available plugins.
  68  *
  69  * Default value: $(pkglibdir)/plugins, can be overriden in debug
  70  * builds by setting SSO_PLUGINS_DIR environment variable.
  71  */
  72 #define GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR     GSIGNOND_CONFIG_GENERAL \
  73                                                 "/PluginsDir"
  74 /**
  75  * GSIGNOND_CONFIG_GENERAL_BIN_DIR:
  76  *
  77  * The path where gSSO is looking for the gsignond-plugind binary when it needs
  78  * to start a plugin process. Can be used for finding other supplementary binaries in
  79  * the future.
  80  *
  81  * Default value: $(bindir), can be overriden in debug
  82  * builds by setting SSO_BIN_DIR environment variable.
  83  */
  84 #define GSIGNOND_CONFIG_GENERAL_BIN_DIR         GSIGNOND_CONFIG_GENERAL \
  85                                                 "/BinDir"
  86 /**
  87  * GSIGNOND_CONFIG_GENERAL_EXTENSION:
  88  *
  89  * The name of the gSSO extension to use. If not specified, the default
  90  * implementation is used (see #GSignondExtension).
  91  *
  92  * Can be overriden in debug
  93  * builds by setting SSO_EXTENSION environment variable.
  94  */
  95 #define GSIGNOND_CONFIG_GENERAL_EXTENSION       GSIGNOND_CONFIG_GENERAL \
  96                                                 "/Extension"
  97 /**
  98  * GSIGNOND_CONFIG_GENERAL_SECURE_DIR:
  99  *
 100  * Path provided by #GSignondStorageManager for storing user-specific
 101  * information, including secret and metadata databases.
 102  *
 103  * Value provided by the default implementation:
 104  * #GSIGNOND_CONFIG_GENERAL_STORAGE_PATH + "/gsignond." + g_get_user_name().
 105  */
 106 #define GSIGNOND_CONFIG_GENERAL_SECURE_DIR      GSIGNOND_CONFIG_GENERAL \
 107                                                 "/SecureDir"
 108 /**
 109  * GSIGNOND_CONFIG_PLUGIN_TIMEOUT:
 110  *
 111  * A timeout in seconds, after which inactive plugin objects and processes are removed.
 112  * If not set, the plugin objects will persist for possible reuse.
 113  *
 114  * Can be overriden in debug
 115  * builds by setting SSO_PLUGIN_TIMEOUT environment variable.
 116  */
 117 #define GSIGNOND_CONFIG_PLUGIN_TIMEOUT          GSIGNOND_CONFIG_GENERAL \
 118                                                 "/PluginTimeout"
 119
 120 #endif /* __GSIGNOND_GENERAL_CONFIG_H_ */