D-Bus: dbus-keyring.h Source File

D-Bus 1.14.4

dbus-keyring.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-keyring.h Store secret cookies in your homedir
3 *
4 * Copyright (C) 2003 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23#ifndef DBUS_KEYRING_H
24#define DBUS_KEYRING_H
25
26#include <dbus/dbus-macros.h>
27#include <dbus/dbus-errors.h>
28#include <dbus/dbus-string.h>
29#include <dbus/dbus-credentials.h>
30
31 DBUS_BEGIN_DECLS
32
33typedef struct DBusKeyring DBusKeyring;
34
35 DBusKeyring* _dbus_keyring_new_for_credentials (DBusCredentials *credentials,
36 const DBusString *context,
37 DBusError *error);
38 DBusKeyring* _dbus_keyring_ref (DBusKeyring *keyring);
39void _dbus_keyring_unref (DBusKeyring *keyring);
40 dbus_bool_t _dbus_keyring_validate_context (const DBusString *context);
41int _dbus_keyring_get_best_key (DBusKeyring *keyring,
42 DBusError *error);
43 dbus_bool_t _dbus_keyring_is_for_credentials (DBusKeyring *keyring,
44 DBusCredentials *credentials);
45 dbus_bool_t _dbus_keyring_get_hex_key (DBusKeyring *keyring,
46 int key_id,
47 DBusString *hex_key);
48
49
50 DBUS_END_DECLS
51
52#endif /* DBUS_KEYRING_H */
_dbus_keyring_get_best_key
int _dbus_keyring_get_best_key(DBusKeyring *keyring, DBusError *error)
Gets a recent key to use for authentication.
Definition: dbus-keyring.c:944
_dbus_keyring_validate_context
dbus_bool_t _dbus_keyring_validate_context(const DBusString *context)
Checks whether the context is a valid context.
Definition: dbus-keyring.c:848
_dbus_keyring_is_for_credentials
dbus_bool_t _dbus_keyring_is_for_credentials(DBusKeyring *keyring, DBusCredentials *credentials)
Checks whether the keyring is for the same user as the given credentials.
Definition: dbus-keyring.c:983
_dbus_keyring_new_for_credentials
DBusKeyring * _dbus_keyring_new_for_credentials(DBusCredentials *credentials, const DBusString *context, DBusError *error)
Creates a new keyring that lives in the ~/.dbus-keyrings directory of the user represented by credent...
Definition: dbus-keyring.c:704
_dbus_keyring_get_hex_key
dbus_bool_t _dbus_keyring_get_hex_key(DBusKeyring *keyring, int key_id, DBusString *hex_key)
Gets the hex-encoded secret key for the given ID.
Definition: dbus-keyring.c:1002
_dbus_keyring_ref
DBusKeyring * _dbus_keyring_ref(DBusKeyring *keyring)
Increments reference count of the keyring.
Definition: dbus-keyring.c:662
_dbus_keyring_unref
void _dbus_keyring_unref(DBusKeyring *keyring)
Decrements refcount and finalizes if it reaches zero.
Definition: dbus-keyring.c:676
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusCredentials
Definition: dbus-credentials.c:49
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusKeyring
Internals of DBusKeyring.
Definition: dbus-keyring.c:113
DBusKeyring::credentials
DBusCredentials * credentials
Credentials containing user the keyring is for.
Definition: dbus-keyring.c:120
DBusString
Definition: dbus-string.h:43