D-Bus 1.15.0
dbus-userdb-util.c
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-userdb-util.c Would be in dbus-userdb.c, but not used in libdbus
3 *
4 * Copyright (C) 2003, 2004, 2005 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#include <config.h>
24#include <unistd.h>
25#define DBUS_USERDB_INCLUDES_PRIVATE 1
26#include "dbus-userdb.h"
27#include "dbus-test.h"
28#include "dbus-internals.h"
29#include "dbus-protocol.h"
30#include <dbus/dbus-test-tap.h>
31#include <string.h>
32
33/* It isn't obvious from its name, but this file is part of the Unix
34 * system-dependent part of libdbus. */
35#if defined(DBUS_WIN) || !defined(DBUS_UNIX)
36#error "This file only makes sense on Unix OSs"
37#endif
38
39#ifdef HAVE_SYSTEMD
40#include <systemd/sd-login.h>
41#endif
42
48static DBusGroupInfo *
49_dbus_group_info_ref (DBusGroupInfo *info)
50{
51 _dbus_assert (info->refcount > 0);
52 _dbus_assert (info->refcount < SIZE_MAX);
53 info->refcount++;
54 return info;
55}
56
66 DBusError *error)
67{
68#ifdef HAVE_SYSTEMD
69 /* check if we have logind */
70 if (access ("/run/systemd/seats/", F_OK) >= 0)
71 {
72 int r;
73
74 /* Check whether this user is logged in on at least one physical
75 seat */
76 r = sd_uid_get_seats (uid, 0, NULL);
77 if (r < 0)
78 {
80 "Failed to determine seats of user \"" DBUS_UID_FORMAT "\": %s",
81 uid,
82 _dbus_strerror (-r));
83 return FALSE;
84 }
85
86 return (r > 0);
87 }
88#endif
89
90#ifdef HAVE_CONSOLE_OWNER_FILE
91
92 DBusString f;
93 DBusStat st;
94
95 if (!_dbus_string_init (&f))
96 {
97 _DBUS_SET_OOM (error);
98 return FALSE;
99 }
100
101 if (!_dbus_string_append(&f, DBUS_CONSOLE_OWNER_FILE))
102 {
104 _DBUS_SET_OOM (error);
105 return FALSE;
106 }
107
108 if (_dbus_stat(&f, &st, NULL) && (st.uid == uid))
109 {
111 return TRUE;
112 }
113
115
116#endif /* HAVE_CONSOLE_OWNER_FILE */
117
118 return FALSE;
119}
120
130 dbus_uid_t *uid)
131{
132 return _dbus_get_user_id_and_primary_group (username, uid, NULL);
133}
134
144 dbus_gid_t *gid)
145{
146 DBusUserDatabase *db;
147 const DBusGroupInfo *info;
148
149 /* FIXME: this can't distinguish ENOMEM from other errors */
151 return FALSE;
152
154 if (db == NULL)
155 {
157 return FALSE;
158 }
159
161 NULL);
162
163 if (info == NULL)
164 {
166 return FALSE;
167 }
168
169 *gid = info->gid;
170
172 return TRUE;
173}
174
185 dbus_uid_t *uid_p,
186 dbus_gid_t *gid_p)
187{
188 DBusUserDatabase *db;
189 const DBusUserInfo *info;
190
191 /* FIXME: this can't distinguish ENOMEM from other errors */
193 return FALSE;
194
196 if (db == NULL)
197 {
199 return FALSE;
200 }
201
202 if (!_dbus_user_database_get_username (db, username,
203 &info, NULL))
204 {
206 return FALSE;
207 }
208
209 if (uid_p)
210 *uid_p = info->uid;
211 if (gid_p)
212 *gid_p = info->primary_gid;
213
215 return TRUE;
216}
217
230const DBusGroupInfo *
232 dbus_gid_t gid,
233 const DBusString *groupname,
234 DBusError *error)
235{
236 DBusGroupInfo *info;
237
238 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
239
240 /* See if the group is really a number */
241 if (gid == DBUS_UID_UNSET)
242 {
243 unsigned long n;
244
245 if (_dbus_is_a_number (groupname, &n))
246 gid = n;
247 }
248
249 if (gid != DBUS_GID_UNSET)
250 info = _dbus_hash_table_lookup_uintptr (db->groups, gid);
251 else
252 info = _dbus_hash_table_lookup_string (db->groups_by_name,
253 _dbus_string_get_const_data (groupname));
254 if (info)
255 {
256 _dbus_verbose ("Using cache for GID "DBUS_GID_FORMAT" information\n",
257 info->gid);
258 return info;
259 }
260 else
261 {
262 if (gid != DBUS_GID_UNSET)
263 _dbus_verbose ("No cache for GID "DBUS_GID_FORMAT"\n",
264 gid);
265 else
266 _dbus_verbose ("No cache for groupname \"%s\"\n",
267 _dbus_string_get_const_data (groupname));
268
269 info = dbus_new0 (DBusGroupInfo, 1);
270 if (info == NULL)
271 {
273 return NULL;
274 }
275 info->refcount = 1;
276
277 if (gid != DBUS_GID_UNSET)
278 {
279 if (!_dbus_group_info_fill_gid (info, gid, error))
280 {
281 _DBUS_ASSERT_ERROR_IS_SET (error);
283 return NULL;
284 }
285 }
286 else
287 {
288 if (!_dbus_group_info_fill (info, groupname, error))
289 {
290 _DBUS_ASSERT_ERROR_IS_SET (error);
292 return NULL;
293 }
294 }
295
296 /* don't use these past here */
297 gid = DBUS_GID_UNSET;
298 groupname = NULL;
299
300 if (_dbus_hash_table_insert_uintptr (db->groups, info->gid, info))
301 {
302 _dbus_group_info_ref (info);
303 }
304 else
305 {
308 return NULL;
309 }
310
311
312 if (_dbus_hash_table_insert_string (db->groups_by_name,
313 info->groupname,
314 info))
315 {
316 _dbus_group_info_ref (info);
317 }
318 else
319 {
320 _dbus_hash_table_remove_uintptr (db->groups, info->gid);
323 return NULL;
324 }
325
326 /* Release the original reference */
328
329 /* Return a borrowed reference to the DBusGroupInfo owned by the
330 * two hash tables */
331 return info;
332 }
333}
334
347 dbus_gid_t **group_ids,
348 int *n_group_ids)
349{
350 DBusUserDatabase *db;
351 const DBusUserInfo *info;
352 *group_ids = NULL;
353 *n_group_ids = 0;
354
355 /* FIXME: this can't distinguish ENOMEM from other errors */
357 return FALSE;
358
360 if (db == NULL)
361 {
363 return FALSE;
364 }
365
366 if (!_dbus_user_database_get_uid (db, uid,
367 &info, NULL))
368 {
370 return FALSE;
371 }
372
373 _dbus_assert (info->uid == uid);
374
375 if (info->n_group_ids > 0)
376 {
377 *group_ids = dbus_new (dbus_gid_t, info->n_group_ids);
378 if (*group_ids == NULL)
379 {
381 return FALSE;
382 }
383
384 *n_group_ids = info->n_group_ids;
385
386 memcpy (*group_ids, info->group_ids, info->n_group_ids * sizeof (dbus_gid_t));
387 }
388
390 return TRUE;
391}
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:354
dbus_bool_t _dbus_hash_table_remove_uintptr(DBusHashTable *table, uintptr_t key)
Removes the hash entry for the given key.
Definition: dbus-hash.c:1242
dbus_bool_t _dbus_hash_table_insert_string(DBusHashTable *table, char *key, void *value)
Creates a hash entry with the given key and value.
Definition: dbus-hash.c:1277
void * _dbus_hash_table_lookup_uintptr(DBusHashTable *table, uintptr_t key)
Looks up the value for a given integer in a hash table of type DBUS_HASH_UINTPTR.
Definition: dbus-hash.c:1162
void * _dbus_hash_table_lookup_string(DBusHashTable *table, const char *key)
Looks up the value for a given string in a hash table of type DBUS_HASH_STRING.
Definition: dbus-hash.c:1112
dbus_bool_t _dbus_hash_table_insert_uintptr(DBusHashTable *table, uintptr_t key, void *value)
Creates a hash entry with the given key and value.
Definition: dbus-hash.c:1352
dbus_bool_t _dbus_stat(const DBusString *filename, DBusStat *statbuf, DBusError *error)
stat() wrapper.
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
dbus_bool_t _dbus_user_database_lock_system(void)
Locks global system user database.
Definition: dbus-userdb.c:351
const char * _dbus_error_from_errno(int error_number)
Converts a UNIX errno, or Windows errno or WinSock error value into a DBusError name.
Definition: dbus-sysdeps.c:599
void _dbus_user_database_unlock_system(void)
Unlocks global system user database.
Definition: dbus-userdb.c:368
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_bool_t _dbus_get_group_id(const DBusString *groupname, dbus_gid_t *gid)
Gets group ID given groupname.
void _dbus_group_info_unref(DBusGroupInfo *info)
Decrements the reference count.
Definition: dbus-userdb.c:85
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.
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_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_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_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_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_bool_t _dbus_get_user_id(const DBusString *username, dbus_uid_t *uid)
Gets user ID given username.
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
#define NULL
A null pointer, defined appropriately for C or C++.
#define TRUE
Expands to "1".
#define FALSE
Expands to "0".
#define dbus_new(type, count)
Safe macro for using dbus_malloc().
Definition: dbus-memory.h:57
#define dbus_new0(type, count)
Safe macro for using dbus_malloc0().
Definition: dbus-memory.h:58
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
Definition: dbus-string.c:978
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:180
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init(), and fills it with the same contents as #_DBUS_STRING_I...
Definition: dbus-string.c:276
dbus_bool_t _dbus_group_info_fill(DBusGroupInfo *info, const DBusString *groupname, DBusError *error)
Initializes the given DBusGroupInfo struct with information about the given group name.
dbus_bool_t _dbus_group_info_fill_gid(DBusGroupInfo *info, dbus_gid_t gid, DBusError *error)
Initializes the given DBusGroupInfo struct with information about the given group ID.
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:135
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:137
#define DBUS_UID_UNSET
an invalid UID used to represent an uninitialized dbus_uid_t field
Definition: dbus-sysdeps.h:142
#define DBUS_GID_UNSET
an invalid GID used to represent an uninitialized dbus_gid_t field
Definition: dbus-sysdeps.h:144
#define DBUS_GID_FORMAT
an appropriate printf format for dbus_gid_t
Definition: dbus-sysdeps.h:151
#define DBUS_UID_FORMAT
an appropriate printf format for dbus_uid_t
Definition: dbus-sysdeps.h:149
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
Object representing an exception.
Definition: dbus-errors.h:49
Information about a UNIX group.
dbus_gid_t gid
GID.
char * groupname
Group name.
size_t refcount
Reference count.
Portable struct with stat() results.
Definition: dbus-sysdeps.h:548
dbus_uid_t uid
User owning file.
Definition: dbus-sysdeps.h:551
Information about a UNIX user.
int n_group_ids
Size of group IDs array.
dbus_uid_t uid
UID.
dbus_gid_t * group_ids
Groups IDs, including above primary group.
dbus_gid_t primary_gid
GID.