D-Bus  1.13.7
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 
34 
35 typedef struct DBusUserDatabase DBusUserDatabase;
36 
37 #ifdef DBUS_USERDB_INCLUDES_PRIVATE
38 #include <dbus/dbus-hash.h>
39 
43 struct DBusUserDatabase
44 {
45  int refcount;
47  DBusHashTable *users;
48  DBusHashTable *groups;
49  DBusHashTable *users_by_name;
50  DBusHashTable *groups_by_name;
52 };
53 
54 
55 DBusUserDatabase* _dbus_user_database_new (void);
56 DBusUserDatabase* _dbus_user_database_ref (DBusUserDatabase *db);
57 void _dbus_user_database_flush (DBusUserDatabase *db);
58 void _dbus_user_database_unref (DBusUserDatabase *db);
59 DBUS_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);
64 dbus_bool_t _dbus_user_database_get_gid (DBusUserDatabase *db,
65  dbus_gid_t gid,
66  const DBusGroupInfo **info,
67  DBusError *error);
68 DBUS_PRIVATE_EXPORT
69 dbus_bool_t _dbus_user_database_get_username (DBusUserDatabase *db,
70  const DBusString *username,
71  const DBusUserInfo **info,
72  DBusError *error);
74  const DBusString *groupname,
75  const DBusGroupInfo **info,
76  DBusError *error);
77 
78 DBUS_PRIVATE_EXPORT
79 DBusUserInfo* _dbus_user_database_lookup (DBusUserDatabase *db,
80  dbus_uid_t uid,
81  const DBusString *username,
82  DBusError *error);
83 DBUS_PRIVATE_EXPORT
84 DBusGroupInfo* _dbus_user_database_lookup_group (DBusUserDatabase *db,
85  dbus_gid_t gid,
86  const DBusString *groupname,
87  DBusError *error);
88 DBUS_PRIVATE_EXPORT
90 DBUS_PRIVATE_EXPORT
92 #endif /* DBUS_USERDB_INCLUDES_PRIVATE */
93 
94 DBUS_PRIVATE_EXPORT
95 DBusUserDatabase* _dbus_user_database_get_system (void);
96 DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT
98 DBUS_PRIVATE_EXPORT
101 
102 dbus_bool_t _dbus_get_user_id (const DBusString *username,
103  dbus_uid_t *uid);
104 dbus_bool_t _dbus_get_group_id (const DBusString *group_name,
105  dbus_gid_t *gid);
106 DBUS_PRIVATE_EXPORT
108  dbus_uid_t *uid_p,
109  dbus_gid_t *gid_p);
110 dbus_bool_t _dbus_credentials_from_uid (dbus_uid_t user_id,
111  DBusCredentials *credentials);
113  dbus_gid_t **group_ids,
114  int *n_group_ids);
115 DBUS_PRIVATE_EXPORT
117  DBusError *error);
118 
119 DBUS_PRIVATE_EXPORT
121  unsigned long *num);
122 
123 DBUS_PRIVATE_EXPORT
125 DBUS_PRIVATE_EXPORT
128  DBusString *homedir);
129 
131  DBusString *homedir);
132 
134 
135 #endif /* DBUS_USERDB_H */
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:135
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
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.
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:313
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.
void _dbus_user_database_flush_system(void)
Flushes the system global user database;.
Definition: dbus-userdb.c:356
dbus_bool_t _dbus_homedir_from_username(const DBusString *username, DBusString *homedir)
Gets the home directory for the given user.
Definition: dbus-userdb.c:426
void _dbus_user_database_flush(DBusUserDatabase *db)
Flush all information out of the user database.
Definition: dbus-userdb.c:643
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:707
DBUS_PRIVATE_EXPORT void _dbus_user_database_unlock_system(void)
Unlocks global system user database.
Definition: dbus-userdb.c:330
dbus_bool_t _dbus_user_database_get_groupname(DBusUserDatabase *db, const DBusString *groupname, const DBusGroupInfo **info, DBusError *error)
Gets the user information for the given group name, returned group info should not be freed...
void _dbus_user_info_free_allocated(DBusUserInfo *info)
Frees the given DBusUserInfo&#39;s members with _dbus_user_info_free() and also calls dbus_free() on the ...
Definition: dbus-userdb.c:52
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:343
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:468
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.
dbus_bool_t _dbus_user_database_get_gid(DBusUserDatabase *db, dbus_gid_t gid, const DBusGroupInfo **info, DBusError *error)
Gets the user information for the given GID, returned group info should not be freed.
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:110
void _dbus_group_info_free_allocated(DBusGroupInfo *info)
Frees the given DBusGroupInfo&#39;s members with _dbus_group_info_free() and also calls dbus_free() on th...
Definition: dbus-userdb.c:68
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
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.
dbus_bool_t _dbus_get_group_id(const DBusString *group_name, dbus_gid_t *gid)
Gets group ID given groupname.
Object representing an exception.
Definition: dbus-errors.h:48
DBusUserDatabase * _dbus_user_database_new(void)
Creates a new user database object used to look up and cache user information.
Definition: dbus-userdb.c:600
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:402
Information about a UNIX group.
dbus_bool_t _dbus_get_user_id(const DBusString *username, dbus_uid_t *uid)
Gets user ID given username.
Internals of DBusHashTable.
Definition: dbus-hash.c:169
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:726
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:136
void _dbus_user_database_unref(DBusUserDatabase *db)
Decrements refcount of user database.
Definition: dbus-userdb.c:673
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:134
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:378
Information about a UNIX user.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.