D-Bus: dbus-userdb.h Source File

D-Bus 1.14.0

dbus-userdb.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-userdb.h User database abstraction
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
24#ifndef DBUS_USERDB_H
25#define DBUS_USERDB_H
26
27#include <dbus/dbus-sysdeps-unix.h>
28
29#ifdef DBUS_WIN
30#error "Don't include this on Windows"
31#endif
32
33 DBUS_BEGIN_DECLS
34
35typedef struct DBusUserDatabase DBusUserDatabase;
36
37#ifdef DBUS_USERDB_INCLUDES_PRIVATE
38#include <dbus/dbus-hash.h>
39
43struct DBusUserDatabase
44{
45 int refcount;
47 DBusHashTable *users;
48 DBusHashTable *groups;
49 DBusHashTable *users_by_name;
50 DBusHashTable *groups_by_name;
52};
53
54
55DBusUserDatabase* _dbus_user_database_new (void);
56DBusUserDatabase* _dbus_user_database_ref (DBusUserDatabase *db);
57void _dbus_user_database_flush (DBusUserDatabase *db);
58void _dbus_user_database_unref (DBusUserDatabase *db);
59DBUS_PRIVATE_EXPORT
60 dbus_bool_t _dbus_user_database_get_uid (DBusUserDatabase *db,
61 dbus_uid_t uid,
62 const DBusUserInfo **info,
63 DBusError *error);
64DBUS_PRIVATE_EXPORT
65 dbus_bool_t _dbus_user_database_get_username (DBusUserDatabase *db,
66 const DBusString *username,
67 const DBusUserInfo **info,
68 DBusError *error);
69DBUS_PRIVATE_EXPORT
70const DBusUserInfo *_dbus_user_database_lookup (DBusUserDatabase *db,
71 dbus_uid_t uid,
72 const DBusString *username,
73 DBusError *error);
74DBUS_PRIVATE_EXPORT
75const DBusGroupInfo* _dbus_user_database_lookup_group (DBusUserDatabase *db,
76 dbus_gid_t gid,
77 const DBusString *groupname,
78 DBusError *error);
79
80void _dbus_user_info_unref (DBusUserInfo *info);
81DBUS_PRIVATE_EXPORT
82void _dbus_group_info_unref (DBusGroupInfo *info);
83#endif /* DBUS_USERDB_INCLUDES_PRIVATE */
84
85DBUS_PRIVATE_EXPORT
86DBusUserDatabase* _dbus_user_database_get_system (void);
87DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT
88 dbus_bool_t _dbus_user_database_lock_system (void);
89DBUS_PRIVATE_EXPORT
90void _dbus_user_database_unlock_system (void);
91void _dbus_user_database_flush_system (void);
92
93 dbus_bool_t _dbus_get_user_id (const DBusString *username,
94 dbus_uid_t *uid);
95 dbus_bool_t _dbus_get_group_id (const DBusString *group_name,
96 dbus_gid_t *gid);
97DBUS_PRIVATE_EXPORT
98 dbus_bool_t _dbus_get_user_id_and_primary_group (const DBusString *username,
99 dbus_uid_t *uid_p,
100 dbus_gid_t *gid_p);
101 dbus_bool_t _dbus_groups_from_uid (dbus_uid_t uid,
102 dbus_gid_t **group_ids,
103 int *n_group_ids);
104DBUS_PRIVATE_EXPORT
105 dbus_bool_t _dbus_is_console_user (dbus_uid_t uid,
106 DBusError *error);
107
108DBUS_PRIVATE_EXPORT
109 dbus_bool_t _dbus_is_a_number (const DBusString *str,
110 unsigned long *num);
111
112DBUS_PRIVATE_EXPORT
113 dbus_bool_t _dbus_username_from_current_process (const DBusString **username);
114DBUS_PRIVATE_EXPORT
115 dbus_bool_t _dbus_homedir_from_current_process (const DBusString **homedir);
116 dbus_bool_t _dbus_homedir_from_uid (dbus_uid_t uid,
117 DBusString *homedir);
118
119 DBUS_END_DECLS
120
121#endif /* DBUS_USERDB_H */
_dbus_user_database_lock_system
DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT dbus_bool_t _dbus_user_database_lock_system(void)
Locks global system user database.
Definition: dbus-userdb.c:351
_dbus_homedir_from_current_process
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_homedir_from_current_process(const DBusString **homedir)
Gets homedir of user owning current process.
Definition: dbus-userdb.c:440
_dbus_user_database_new
DBusUserDatabase * _dbus_user_database_new(void)
Creates a new user database object used to look up and cache user information.
Definition: dbus-userdb.c:596
_dbus_user_database_unlock_system
DBUS_PRIVATE_EXPORT void _dbus_user_database_unlock_system(void)
Unlocks global system user database.
Definition: dbus-userdb.c:368
_dbus_user_database_unref
void _dbus_user_database_unref(DBusUserDatabase *db)
Decrements refcount of user database.
Definition: dbus-userdb.c:669
_dbus_user_database_get_uid
dbus_bool_t _dbus_user_database_get_uid(DBusUserDatabase *db, dbus_uid_t uid, const DBusUserInfo **info, DBusError *error)
Gets the user information for the given UID, returned user info should not be freed.
Definition: dbus-userdb.c:703
_dbus_user_database_flush_system
void _dbus_user_database_flush_system(void)
Flushes the system global user database;.
Definition: dbus-userdb.c:394
_dbus_get_group_id
dbus_bool_t _dbus_get_group_id(const DBusString *group_name, dbus_gid_t *gid)
Gets group ID given groupname.
Definition: dbus-userdb-util.c:176
_dbus_group_info_unref
void _dbus_group_info_unref(DBusGroupInfo *info)
Decrements the reference count.
Definition: dbus-userdb.c:85
_dbus_user_database_lookup
const DBusUserInfo * _dbus_user_database_lookup(DBusUserDatabase *db, dbus_uid_t uid, const DBusString *username, DBusError *error)
Looks up a uid or username in the user database.
Definition: dbus-userdb.c:158
_dbus_user_info_unref
void _dbus_user_info_unref(DBusUserInfo *info)
Decrements the reference count.
Definition: dbus-userdb.c:62
_dbus_username_from_current_process
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_username_from_current_process(const DBusString **username)
Gets username of user owning current process.
Definition: dbus-userdb.c:416
_dbus_is_console_user
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_is_console_user(dbus_uid_t uid, DBusError *error)
Checks to see if the UID sent in is the console user.
Definition: dbus-userdb-util.c:65
_dbus_user_database_lookup_group
const DBusGroupInfo * _dbus_user_database_lookup_group(DBusUserDatabase *db, dbus_gid_t gid, const DBusString *groupname, DBusError *error)
Looks up a gid or group name in the user database.
Definition: dbus-userdb-util.c:264
_dbus_user_database_flush
void _dbus_user_database_flush(DBusUserDatabase *db)
Flush all information out of the user database.
Definition: dbus-userdb.c:639
_dbus_homedir_from_uid
dbus_bool_t _dbus_homedir_from_uid(dbus_uid_t uid, DBusString *homedir)
Gets the home directory for the given user.
Definition: dbus-userdb.c:464
_dbus_get_user_id_and_primary_group
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_get_user_id_and_primary_group(const DBusString *username, dbus_uid_t *uid_p, dbus_gid_t *gid_p)
Gets user ID and primary group given username.
Definition: dbus-userdb-util.c:217
_dbus_user_database_get_username
dbus_bool_t _dbus_user_database_get_username(DBusUserDatabase *db, const DBusString *username, const DBusUserInfo **info, DBusError *error)
Gets the user information for the given username.
Definition: dbus-userdb.c:722
_dbus_is_a_number
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_is_a_number(const DBusString *str, unsigned long *num)
Checks if a given string is actually a number and converts it if it is.
Definition: dbus-userdb.c:133
_dbus_groups_from_uid
dbus_bool_t _dbus_groups_from_uid(dbus_uid_t uid, dbus_gid_t **group_ids, int *n_group_ids)
Gets all groups corresponding to the given UID.
Definition: dbus-userdb-util.c:379
_dbus_get_user_id
dbus_bool_t _dbus_get_user_id(const DBusString *username, dbus_uid_t *uid)
Gets user ID given username.
Definition: dbus-userdb-util.c:162
_dbus_user_database_get_system
DBUS_PRIVATE_EXPORT DBusUserDatabase * _dbus_user_database_get_system(void)
Gets the system global user database; must be called with lock held (_dbus_user_database_lock_system(...
Definition: dbus-userdb.c:381
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_uid_t
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:137
dbus_gid_t
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:139
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusGroupInfo
Information about a UNIX group.
Definition: dbus-sysdeps-unix.h:121
DBusHashTable
Internals of DBusHashTable.
Definition: dbus-hash.c:174
DBusString
Definition: dbus-string.h:43
DBusUserInfo
Information about a UNIX user.
Definition: dbus-sysdeps-unix.h:107