D-Bus  1.16.2
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  * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
7  *
8  * Licensed under the Academic Free License version 2.1
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 #ifndef DBUS_USERDB_H
27 #define DBUS_USERDB_H
28 
29 #include <dbus/dbus-sysdeps-unix.h>
30 
31 #ifdef DBUS_WIN
32 #error "Don't include this on Windows"
33 #endif
34 
36 
37 typedef struct DBusUserDatabase DBusUserDatabase;
38 
39 #ifdef DBUS_USERDB_INCLUDES_PRIVATE
40 #include <dbus/dbus-hash.h>
41 
45 struct DBusUserDatabase
46 {
47  int refcount;
49  DBusHashTable *users;
50  DBusHashTable *groups;
51  DBusHashTable *users_by_name;
52  DBusHashTable *groups_by_name;
54 };
55 
56 
57 DBusUserDatabase* _dbus_user_database_new (void);
58 DBusUserDatabase* _dbus_user_database_ref (DBusUserDatabase *db);
59 void _dbus_user_database_flush (DBusUserDatabase *db);
60 void _dbus_user_database_unref (DBusUserDatabase *db);
61 DBUS_PRIVATE_EXPORT
62 dbus_bool_t _dbus_user_database_get_uid (DBusUserDatabase *db,
63  dbus_uid_t uid,
64  const DBusUserInfo **info,
65  DBusError *error);
66 DBUS_PRIVATE_EXPORT
67 dbus_bool_t _dbus_user_database_get_username (DBusUserDatabase *db,
68  const DBusString *username,
69  const DBusUserInfo **info,
70  DBusError *error);
71 DBUS_PRIVATE_EXPORT
72 const DBusUserInfo *_dbus_user_database_lookup (DBusUserDatabase *db,
73  dbus_uid_t uid,
74  const DBusString *username,
75  DBusError *error);
76 DBUS_PRIVATE_EXPORT
77 const DBusGroupInfo* _dbus_user_database_lookup_group (DBusUserDatabase *db,
78  dbus_gid_t gid,
79  const DBusString *groupname,
80  DBusError *error);
81 
83 DBUS_PRIVATE_EXPORT
85 #endif /* DBUS_USERDB_INCLUDES_PRIVATE */
86 
87 DBUS_PRIVATE_EXPORT
88 DBusUserDatabase* _dbus_user_database_get_system (void);
89 DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT
91 DBUS_PRIVATE_EXPORT
94 
96  dbus_uid_t *uid);
97 dbus_bool_t _dbus_get_group_id (const DBusString *group_name,
98  dbus_gid_t *gid);
99 DBUS_PRIVATE_EXPORT
101  dbus_uid_t *uid_p,
102  dbus_gid_t *gid_p);
104  dbus_gid_t **group_ids,
105  int *n_group_ids,
106  DBusError *error);
107 DBUS_PRIVATE_EXPORT
109  DBusError *error);
110 
111 DBUS_PRIVATE_EXPORT
113  unsigned long *num);
114 
115 DBUS_PRIVATE_EXPORT
117 DBUS_PRIVATE_EXPORT
120  DBusString *homedir);
121 
123 
124 #endif /* DBUS_USERDB_H */
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
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:353
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:396
void _dbus_user_database_flush(DBusUserDatabase *db)
Flush all information out of the user database.
Definition: dbus-userdb.c:641
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:705
DBUS_PRIVATE_EXPORT void _dbus_user_database_unlock_system(void)
Unlocks global system user database.
Definition: dbus-userdb.c:370
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.
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:383
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:466
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_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:135
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:37
void _dbus_user_info_unref(DBusUserInfo *info)
Decrements the reference count.
Definition: dbus-userdb.c:64
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:50
DBusUserDatabase * _dbus_user_database_new(void)
Creates a new user database object used to look up and cache user information.
Definition: dbus-userdb.c:598
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:442
Information about a UNIX group.
dbus_bool_t _dbus_get_user_id(const DBusString *username, dbus_uid_t *uid)
Gets user ID given username.
dbus_bool_t _dbus_groups_from_uid(dbus_uid_t uid, dbus_gid_t **group_ids, int *n_group_ids, DBusError *error)
Gets all groups corresponding to the given UID.
Internals of DBusHashTable.
Definition: dbus-hash.c:175
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:724
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:143
void _dbus_user_database_unref(DBusUserDatabase *db)
Decrements refcount of user database.
Definition: dbus-userdb.c:671
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:141
void _dbus_group_info_unref(DBusGroupInfo *info)
Decrements the reference count.
Definition: dbus-userdb.c:87
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:418
Information about a UNIX user.
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:160
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.