docs/html/GSignondSecretStorage.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsignond API Reference Manual: GSignondSecretStorage</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch06.html" title="GSignond API for writing platform adaptation extensions">
   9 <link rel="prev" href="GSignondStorageManager.html" title="GSignondStorageManager">
  10 <link rel="next" href="GSignondCredentials.html" title="GSignondCredentials">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#GSignondSecretStorage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#GSignondSecretStorage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
  20                   <a href="#GSignondSecretStorage.properties" class="shortcut">Properties</a></span>
  21 </td>
  22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  23 <td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  24 <td><a accesskey="p" href="GSignondStorageManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  25 <td><a accesskey="n" href="GSignondCredentials.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  26 </tr></table>
  27 <div class="refentry">
  28 <a name="GSignondSecretStorage"></a><div class="titlepage"></div>
  29 <div class="refnamediv"><table width="100%"><tr>
  30 <td valign="top">
  31 <h2><span class="refentrytitle"><a name="GSignondSecretStorage.top_of_page"></a>GSignondSecretStorage</span></h2>
  32 <p>GSignondSecretStorage — provides access to the database that stores user credentials and identity/method cache</p>
  33 </td>
  34 <td class="gallery_image" valign="top" align="right"></td>
  35 </tr></table></div>
  36 <div class="refsect1">
  37 <a name="GSignondSecretStorage.functions"></a><h2>Functions</h2>
  38 <div class="informaltable"><table width="100%" border="0">
  39 <colgroup>
  40 <col width="150px" class="functions_return">
  41 <col class="functions_name">
  42 </colgroup>
  43 <tbody>
  44 <tr>
  45 <td class="function_type">
  46 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  47 </td>
  48 <td class="function_name">
  49 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-open-db" title="gsignond_secret_storage_open_db ()">gsignond_secret_storage_open_db</a> <span class="c_punctuation">()</span>
  50 </td>
  51 </tr>
  52 <tr>
  53 <td class="function_type">
  54 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  55 </td>
  56 <td class="function_name">
  57 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-close-db" title="gsignond_secret_storage_close_db ()">gsignond_secret_storage_close_db</a> <span class="c_punctuation">()</span>
  58 </td>
  59 </tr>
  60 <tr>
  61 <td class="function_type">
  62 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  63 </td>
  64 <td class="function_name">
  65 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-clear-db" title="gsignond_secret_storage_clear_db ()">gsignond_secret_storage_clear_db</a> <span class="c_punctuation">()</span>
  66 </td>
  67 </tr>
  68 <tr>
  69 <td class="function_type">
  70 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  71 </td>
  72 <td class="function_name">
  73 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-is-open-db" title="gsignond_secret_storage_is_open_db ()">gsignond_secret_storage_is_open_db</a> <span class="c_punctuation">()</span>
  74 </td>
  75 </tr>
  76 <tr>
  77 <td class="function_type">
  78 <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> *
  79 </td>
  80 <td class="function_name">
  81 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-credentials" title="gsignond_secret_storage_load_credentials ()">gsignond_secret_storage_load_credentials</a> <span class="c_punctuation">()</span>
  82 </td>
  83 </tr>
  84 <tr>
  85 <td class="function_type">
  86 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  87 </td>
  88 <td class="function_name">
  89 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-credentials" title="gsignond_secret_storage_update_credentials ()">gsignond_secret_storage_update_credentials</a> <span class="c_punctuation">()</span>
  90 </td>
  91 </tr>
  92 <tr>
  93 <td class="function_type">
  94 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  95 </td>
  96 <td class="function_name">
  97 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-credentials" title="gsignond_secret_storage_remove_credentials ()">gsignond_secret_storage_remove_credentials</a> <span class="c_punctuation">()</span>
  98 </td>
  99 </tr>
 100 <tr>
 101 <td class="function_type">
 102 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 103 </td>
 104 <td class="function_name">
 105 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-check-credentials" title="gsignond_secret_storage_check_credentials ()">gsignond_secret_storage_check_credentials</a> <span class="c_punctuation">()</span>
 106 </td>
 107 </tr>
 108 <tr>
 109 <td class="function_type">
 110 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
 111 </td>
 112 <td class="function_name">
 113 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-load-data" title="gsignond_secret_storage_load_data ()">gsignond_secret_storage_load_data</a> <span class="c_punctuation">()</span>
 114 </td>
 115 </tr>
 116 <tr>
 117 <td class="function_type">
 118 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 119 </td>
 120 <td class="function_name">
 121 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-update-data" title="gsignond_secret_storage_update_data ()">gsignond_secret_storage_update_data</a> <span class="c_punctuation">()</span>
 122 </td>
 123 </tr>
 124 <tr>
 125 <td class="function_type">
 126 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 127 </td>
 128 <td class="function_name">
 129 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-remove-data" title="gsignond_secret_storage_remove_data ()">gsignond_secret_storage_remove_data</a> <span class="c_punctuation">()</span>
 130 </td>
 131 </tr>
 132 <tr>
 133 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
 134 </td>
 135 <td class="function_name">
 136 <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-get-last-error" title="gsignond_secret_storage_get_last_error ()">gsignond_secret_storage_get_last_error</a> <span class="c_punctuation">()</span>
 137 </td>
 138 </tr>
 139 </tbody>
 140 </table></div>
 141 </div>
 142 <div class="refsect1">
 143 <a name="GSignondSecretStorage.properties"></a><h2>Properties</h2>
 144 <div class="informaltable"><table border="0">
 145 <colgroup>
 146 <col width="150px" class="properties_type">
 147 <col width="300px" class="properties_name">
 148 <col width="200px" class="properties_flags">
 149 </colgroup>
 150 <tbody><tr>
 151 <td class="property_type">
 152 <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *</td>
 153 <td class="property_name"><a class="link" href="GSignondSecretStorage.html#GSignondSecretStorage--config" title="The “config” property">config</a></td>
 154 <td class="property_flags">Read / Write / Construct Only</td>
 155 </tr></tbody>
 156 </table></div>
 157 </div>
 158 <div class="refsect1">
 159 <a name="GSignondSecretStorage.object-hierarchy"></a><h2>Object Hierarchy</h2>
 160 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 161     <span class="lineart">╰──</span> GSignondSecretStorage
 162 </pre>
 163 </div>
 164 <div class="refsect1">
 165 <a name="GSignondSecretStorage.includes"></a><h2>Includes</h2>
 166 <pre class="synopsis">#include &lt;gsignond/gsignond-secret-storage.h&gt;
 167 </pre>
 168 </div>
 169 <div class="refsect1">
 170 <a name="GSignondSecretStorage.description"></a><h2>Description</h2>
 171 <p><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> provides access to the database where sensitive identity
 172 data (<a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a>) and identity/method cache are stored. It's preferred
 173 that this database is protected against access by processes other than gSSO.</p>
 174 <p>gSSO can be configured to use a custom extension
 175 that provides a subclassed implementation of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a>
 176 (see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>), otherwise a default implementation is used.</p>
 177 </div>
 178 <div class="refsect1">
 179 <a name="GSignondSecretStorage.functions_details"></a><h2>Functions</h2>
 180 <div class="refsect2">
 181 <a name="gsignond-secret-storage-open-db"></a><h3>gsignond_secret_storage_open_db ()</h3>
 182 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 183 gsignond_secret_storage_open_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre>
 184 <p>Opens (and initializes) the database. The implementation should take
 185 care of creating the DB, if it doesn't exist, and it should use
 186 <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_SECURE_DIR"><span class="type">GSIGNOND_CONFIG_GENERAL_SECURE_DIR</span></a>
 187 to determine database location in the filesystem.</p>
 188 <p>The default implementation is using SQLite for the storage.</p>
 189 <div class="refsect3">
 190 <a name="id-1.7.6.8.2.6"></a><h4>Parameters</h4>
 191 <div class="informaltable"><table width="100%" border="0">
 192 <colgroup>
 193 <col width="150px" class="parameters_name">
 194 <col class="parameters_description">
 195 <col width="200px" class="parameters_annotations">
 196 </colgroup>
 197 <tbody><tr>
 198 <td class="parameter_name"><p>self</p></td>
 199 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 200 <td class="parameter_annotations"> </td>
 201 </tr></tbody>
 202 </table></div>
 203 </div>
 204 <div class="refsect3">
 205 <a name="id-1.7.6.8.2.7"></a><h4>Returns</h4>
 206 <p> TRUE if successful, FALSE otherwise.</p>
 207 <p></p>
 208 </div>
 209 </div>
 210 <hr>
 211 <div class="refsect2">
 212 <a name="gsignond-secret-storage-close-db"></a><h3>gsignond_secret_storage_close_db ()</h3>
 213 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 214 gsignond_secret_storage_close_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre>
 215 <p>Closes the database. To reopen it, call <a class="link" href="GSignondSecretStorage.html#gsignond-secret-storage-open-db" title="gsignond_secret_storage_open_db ()"><code class="function">gsignond_secret_storage_open_db()</code></a>.</p>
 216 <div class="refsect3">
 217 <a name="id-1.7.6.8.3.5"></a><h4>Parameters</h4>
 218 <div class="informaltable"><table width="100%" border="0">
 219 <colgroup>
 220 <col width="150px" class="parameters_name">
 221 <col class="parameters_description">
 222 <col width="200px" class="parameters_annotations">
 223 </colgroup>
 224 <tbody><tr>
 225 <td class="parameter_name"><p>self</p></td>
 226 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 227 <td class="parameter_annotations"> </td>
 228 </tr></tbody>
 229 </table></div>
 230 </div>
 231 <div class="refsect3">
 232 <a name="id-1.7.6.8.3.6"></a><h4>Returns</h4>
 233 <p> TRUE if successful, FALSE otherwise.</p>
 234 <p></p>
 235 </div>
 236 </div>
 237 <hr>
 238 <div class="refsect2">
 239 <a name="gsignond-secret-storage-clear-db"></a><h3>gsignond_secret_storage_clear_db ()</h3>
 240 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 241 gsignond_secret_storage_clear_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre>
 242 <p>Removes all stored secrets from the database.</p>
 243 <div class="refsect3">
 244 <a name="id-1.7.6.8.4.5"></a><h4>Parameters</h4>
 245 <div class="informaltable"><table width="100%" border="0">
 246 <colgroup>
 247 <col width="150px" class="parameters_name">
 248 <col class="parameters_description">
 249 <col width="200px" class="parameters_annotations">
 250 </colgroup>
 251 <tbody><tr>
 252 <td class="parameter_name"><p>self</p></td>
 253 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 254 <td class="parameter_annotations"> </td>
 255 </tr></tbody>
 256 </table></div>
 257 </div>
 258 <div class="refsect3">
 259 <a name="id-1.7.6.8.4.6"></a><h4>Returns</h4>
 260 <p> TRUE if successful, FALSE otherwise.</p>
 261 <p></p>
 262 </div>
 263 </div>
 264 <hr>
 265 <div class="refsect2">
 266 <a name="gsignond-secret-storage-is-open-db"></a><h3>gsignond_secret_storage_is_open_db ()</h3>
 267 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 268 gsignond_secret_storage_is_open_db (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre>
 269 <p>Checks if the database is open or not.</p>
 270 <div class="refsect3">
 271 <a name="id-1.7.6.8.5.5"></a><h4>Parameters</h4>
 272 <div class="informaltable"><table width="100%" border="0">
 273 <colgroup>
 274 <col width="150px" class="parameters_name">
 275 <col class="parameters_description">
 276 <col width="200px" class="parameters_annotations">
 277 </colgroup>
 278 <tbody><tr>
 279 <td class="parameter_name"><p>self</p></td>
 280 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 281 <td class="parameter_annotations"> </td>
 282 </tr></tbody>
 283 </table></div>
 284 </div>
 285 <div class="refsect3">
 286 <a name="id-1.7.6.8.5.6"></a><h4>Returns</h4>
 287 <p> TRUE if successful, FALSE otherwise.</p>
 288 <p></p>
 289 </div>
 290 </div>
 291 <hr>
 292 <div class="refsect2">
 293 <a name="gsignond-secret-storage-load-credentials"></a><h3>gsignond_secret_storage_load_credentials ()</h3>
 294 <pre class="programlisting"><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="returnvalue">GSignondCredentials</span></a> *
 295 gsignond_secret_storage_load_credentials
 296                                (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 297                                 <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre>
 298 <p>Loads the credentials from the database.</p>
 299 <div class="refsect3">
 300 <a name="id-1.7.6.8.6.5"></a><h4>Parameters</h4>
 301 <div class="informaltable"><table width="100%" border="0">
 302 <colgroup>
 303 <col width="150px" class="parameters_name">
 304 <col class="parameters_description">
 305 <col width="200px" class="parameters_annotations">
 306 </colgroup>
 307 <tbody>
 308 <tr>
 309 <td class="parameter_name"><p>self</p></td>
 310 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 311 <td class="parameter_annotations"> </td>
 312 </tr>
 313 <tr>
 314 <td class="parameter_name"><p>id</p></td>
 315 <td class="parameter_description"><p>the identity id whose credentials are being loaded.</p></td>
 316 <td class="parameter_annotations"> </td>
 317 </tr>
 318 </tbody>
 319 </table></div>
 320 </div>
 321 <div class="refsect3">
 322 <a name="id-1.7.6.8.6.6"></a><h4>Returns</h4>
 323 <p> <a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> if successful,
 324 NULL otherwise. </p>
 325 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 326 </div>
 327 </div>
 328 <hr>
 329 <div class="refsect2">
 330 <a name="gsignond-secret-storage-update-credentials"></a><h3>gsignond_secret_storage_update_credentials ()</h3>
 331 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 332 gsignond_secret_storage_update_credentials
 333                                (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 334                                 <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *creds</code></em>);</pre>
 335 <p>Stores/updates the credentials for the given identity.</p>
 336 <div class="refsect3">
 337 <a name="id-1.7.6.8.7.5"></a><h4>Parameters</h4>
 338 <div class="informaltable"><table width="100%" border="0">
 339 <colgroup>
 340 <col width="150px" class="parameters_name">
 341 <col class="parameters_description">
 342 <col width="200px" class="parameters_annotations">
 343 </colgroup>
 344 <tbody>
 345 <tr>
 346 <td class="parameter_name"><p>self</p></td>
 347 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 348 <td class="parameter_annotations"> </td>
 349 </tr>
 350 <tr>
 351 <td class="parameter_name"><p>creds</p></td>
 352 <td class="parameter_description"><p> the credentials that are being updated. </p></td>
 353 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 354 </tr>
 355 </tbody>
 356 </table></div>
 357 </div>
 358 <div class="refsect3">
 359 <a name="id-1.7.6.8.7.6"></a><h4>Returns</h4>
 360 <p> TRUE if successful, FALSE otherwise.</p>
 361 <p></p>
 362 </div>
 363 </div>
 364 <hr>
 365 <div class="refsect2">
 366 <a name="gsignond-secret-storage-remove-credentials"></a><h3>gsignond_secret_storage_remove_credentials ()</h3>
 367 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 368 gsignond_secret_storage_remove_credentials
 369                                (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 370                                 <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>);</pre>
 371 <p>Remove the credentials for the given identity.</p>
 372 <div class="refsect3">
 373 <a name="id-1.7.6.8.8.5"></a><h4>Parameters</h4>
 374 <div class="informaltable"><table width="100%" border="0">
 375 <colgroup>
 376 <col width="150px" class="parameters_name">
 377 <col class="parameters_description">
 378 <col width="200px" class="parameters_annotations">
 379 </colgroup>
 380 <tbody>
 381 <tr>
 382 <td class="parameter_name"><p>self</p></td>
 383 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 384 <td class="parameter_annotations"> </td>
 385 </tr>
 386 <tr>
 387 <td class="parameter_name"><p>id</p></td>
 388 <td class="parameter_description"><p>the identity whose credentials are being updated.</p></td>
 389 <td class="parameter_annotations"> </td>
 390 </tr>
 391 </tbody>
 392 </table></div>
 393 </div>
 394 <div class="refsect3">
 395 <a name="id-1.7.6.8.8.6"></a><h4>Returns</h4>
 396 <p> TRUE if successful, FALSE otherwise.</p>
 397 <p></p>
 398 </div>
 399 </div>
 400 <hr>
 401 <div class="refsect2">
 402 <a name="gsignond-secret-storage-check-credentials"></a><h3>gsignond_secret_storage_check_credentials ()</h3>
 403 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 404 gsignond_secret_storage_check_credentials
 405                                (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 406                                 <em class="parameter"><code><a class="link" href="GSignondCredentials.html" title="GSignondCredentials"><span class="type">GSignondCredentials</span></a> *creds</code></em>);</pre>
 407 <p>Checks whether the given credentials match what is stored in the database.</p>
 408 <div class="refsect3">
 409 <a name="id-1.7.6.8.9.5"></a><h4>Parameters</h4>
 410 <div class="informaltable"><table width="100%" border="0">
 411 <colgroup>
 412 <col width="150px" class="parameters_name">
 413 <col class="parameters_description">
 414 <col width="200px" class="parameters_annotations">
 415 </colgroup>
 416 <tbody>
 417 <tr>
 418 <td class="parameter_name"><p>self</p></td>
 419 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 420 <td class="parameter_annotations"> </td>
 421 </tr>
 422 <tr>
 423 <td class="parameter_name"><p>creds</p></td>
 424 <td class="parameter_description"><p> the credentials that are being checked. </p></td>
 425 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 426 </tr>
 427 </tbody>
 428 </table></div>
 429 </div>
 430 <div class="refsect3">
 431 <a name="id-1.7.6.8.9.6"></a><h4>Returns</h4>
 432 <p> TRUE if successful, FALSE otherwise.</p>
 433 <p></p>
 434 </div>
 435 </div>
 436 <hr>
 437 <div class="refsect2">
 438 <a name="gsignond-secret-storage-load-data"></a><h3>gsignond_secret_storage_load_data ()</h3>
 439 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
 440 gsignond_secret_storage_load_data (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 441                                    <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>,
 442                                    <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>);</pre>
 443 <p>Loads the secret data associated with a given identity and method.</p>
 444 <div class="refsect3">
 445 <a name="id-1.7.6.8.10.5"></a><h4>Parameters</h4>
 446 <div class="informaltable"><table width="100%" border="0">
 447 <colgroup>
 448 <col width="150px" class="parameters_name">
 449 <col class="parameters_description">
 450 <col width="200px" class="parameters_annotations">
 451 </colgroup>
 452 <tbody>
 453 <tr>
 454 <td class="parameter_name"><p>self</p></td>
 455 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 456 <td class="parameter_annotations"> </td>
 457 </tr>
 458 <tr>
 459 <td class="parameter_name"><p>id</p></td>
 460 <td class="parameter_description"><p>the identity id whose data are fetched</p></td>
 461 <td class="parameter_annotations"> </td>
 462 </tr>
 463 <tr>
 464 <td class="parameter_name"><p>method</p></td>
 465 <td class="parameter_description"><p>the authentication method the data is used for.</p></td>
 466 <td class="parameter_annotations"> </td>
 467 </tr>
 468 </tbody>
 469 </table></div>
 470 </div>
 471 <div class="refsect3">
 472 <a name="id-1.7.6.8.10.6"></a><h4>Returns</h4>
 473 <p> the secret data. </p>
 474 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 475 </div>
 476 </div>
 477 <hr>
 478 <div class="refsect2">
 479 <a name="gsignond-secret-storage-update-data"></a><h3>gsignond_secret_storage_update_data ()</h3>
 480 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 481 gsignond_secret_storage_update_data (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 482                                      <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>,
 483                                      <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>,
 484                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *data</code></em>);</pre>
 485 <p>Calling this method updates the secret data
 486 associated with the given id/method.</p>
 487 <div class="refsect3">
 488 <a name="id-1.7.6.8.11.5"></a><h4>Parameters</h4>
 489 <div class="informaltable"><table width="100%" border="0">
 490 <colgroup>
 491 <col width="150px" class="parameters_name">
 492 <col class="parameters_description">
 493 <col width="200px" class="parameters_annotations">
 494 </colgroup>
 495 <tbody>
 496 <tr>
 497 <td class="parameter_name"><p>self</p></td>
 498 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 499 <td class="parameter_annotations"> </td>
 500 </tr>
 501 <tr>
 502 <td class="parameter_name"><p>id</p></td>
 503 <td class="parameter_description"><p>the identity whose data are fetched.</p></td>
 504 <td class="parameter_annotations"> </td>
 505 </tr>
 506 <tr>
 507 <td class="parameter_name"><p>method</p></td>
 508 <td class="parameter_description"><p>the authentication method the data is used for.</p></td>
 509 <td class="parameter_annotations"> </td>
 510 </tr>
 511 <tr>
 512 <td class="parameter_name"><p>data</p></td>
 513 <td class="parameter_description"><p> the data to update. </p></td>
 514 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 515 </tr>
 516 </tbody>
 517 </table></div>
 518 </div>
 519 <div class="refsect3">
 520 <a name="id-1.7.6.8.11.6"></a><h4>Returns</h4>
 521 <p> TRUE if successful, FALSE otherwise.</p>
 522 <p></p>
 523 </div>
 524 </div>
 525 <hr>
 526 <div class="refsect2">
 527 <a name="gsignond-secret-storage-remove-data"></a><h3>gsignond_secret_storage_remove_data ()</h3>
 528 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 529 gsignond_secret_storage_remove_data (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>,
 530                                      <em class="parameter"><code>const <span class="type">guint32</span> id</code></em>,
 531                                      <em class="parameter"><code>const <span class="type">guint32</span> method</code></em>);</pre>
 532 <p>Removes secret data associated with a given id/method.</p>
 533 <div class="refsect3">
 534 <a name="id-1.7.6.8.12.5"></a><h4>Parameters</h4>
 535 <div class="informaltable"><table width="100%" border="0">
 536 <colgroup>
 537 <col width="150px" class="parameters_name">
 538 <col class="parameters_description">
 539 <col width="200px" class="parameters_annotations">
 540 </colgroup>
 541 <tbody>
 542 <tr>
 543 <td class="parameter_name"><p>self</p></td>
 544 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 545 <td class="parameter_annotations"> </td>
 546 </tr>
 547 <tr>
 548 <td class="parameter_name"><p>id</p></td>
 549 <td class="parameter_description"><p>the identity whose data are fetched.</p></td>
 550 <td class="parameter_annotations"> </td>
 551 </tr>
 552 <tr>
 553 <td class="parameter_name"><p>method</p></td>
 554 <td class="parameter_description"><p>the authentication method the data is used for.</p></td>
 555 <td class="parameter_annotations"> </td>
 556 </tr>
 557 </tbody>
 558 </table></div>
 559 </div>
 560 <div class="refsect3">
 561 <a name="id-1.7.6.8.12.6"></a><h4>Returns</h4>
 562 <p> TRUE if successful, FALSE otherwise.</p>
 563 <p></p>
 564 </div>
 565 </div>
 566 <hr>
 567 <div class="refsect2">
 568 <a name="gsignond-secret-storage-get-last-error"></a><h3>gsignond_secret_storage_get_last_error ()</h3>
 569 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
 570 gsignond_secret_storage_get_last_error
 571                                (<em class="parameter"><code><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> *self</code></em>);</pre>
 572 <p>Retrieves the last occurred error that has occured</p>
 573 <div class="refsect3">
 574 <a name="id-1.7.6.8.13.5"></a><h4>Parameters</h4>
 575 <div class="informaltable"><table width="100%" border="0">
 576 <colgroup>
 577 <col width="150px" class="parameters_name">
 578 <col class="parameters_description">
 579 <col width="200px" class="parameters_annotations">
 580 </colgroup>
 581 <tbody><tr>
 582 <td class="parameter_name"><p>self</p></td>
 583 <td class="parameter_description"><p>instance of <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a></p></td>
 584 <td class="parameter_annotations"> </td>
 585 </tr></tbody>
 586 </table></div>
 587 </div>
 588 <div class="refsect3">
 589 <a name="id-1.7.6.8.13.6"></a><h4>Returns</h4>
 590 <p> last occurred <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p>
 591 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 592 </div>
 593 </div>
 594 </div>
 595 <div class="refsect1">
 596 <a name="GSignondSecretStorage.other_details"></a><h2>Types and Values</h2>
 597 </div>
 598 <div class="refsect1">
 599 <a name="GSignondSecretStorage.property-details"></a><h2>Property Details</h2>
 600 <div class="refsect2">
 601 <a name="GSignondSecretStorage--config"></a><h3>The <code class="literal">“config”</code> property</h3>
 602 <pre class="programlisting">  “config”                   <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *</pre>
 603 <p>Configuration object.</p>
 604 <p>Flags: Read / Write / Construct Only</p>
 605 </div>
 606 </div>
 607 </div>
 608 <div class="footer">
 609 <hr>
 610           Generated by GTK-Doc V1.20</div>
 611 </body>
 612 </html>