D-Bus 1.13.18

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#if HAVE_ELOGIND
43#include <elogind/sd-login.h>
44#endif
45
51 static DBusGroupInfo *
52_dbus_group_info_ref (DBusGroupInfo *info)
53{
54 _dbus_assert (info->refcount > 0);
55 _dbus_assert (info->refcount < SIZE_MAX);
56 info->refcount++;
57 return info;
58}
59
67 dbus_bool_t
68_dbus_is_console_user (dbus_uid_t uid,
69 DBusError *error)
70{
71
72 DBusUserDatabase *db;
73 const DBusUserInfo *info;
74 dbus_bool_t result = FALSE;
75
76#if defined(HAVE_SYSTEMD) || defined(HAVE_ELOGIND)
77 /* check if we have logind */
78 if (access ("/run/systemd/seats/", F_OK) >= 0)
79 {
80 int r;
81
82 /* Check whether this user is logged in on at least one physical
83 seat */
84 r = sd_uid_get_seats (uid, 0, NULL);
85 if (r < 0)
86 {
87 dbus_set_error (error, _dbus_error_from_errno (-r),
88 "Failed to determine seats of user \"" DBUS_UID_FORMAT "\": %s",
89 uid,
90 _dbus_strerror (-r));
91 return FALSE;
92 }
93
94 return (r > 0);
95 }
96#endif
97
98#ifdef HAVE_CONSOLE_OWNER_FILE
99
100 DBusString f;
101 DBusStat st;
102
103 if (!_dbus_string_init (&f))
104 {
105 _DBUS_SET_OOM (error);
106 return FALSE;
107 }
108
109 if (!_dbus_string_append(&f, DBUS_CONSOLE_OWNER_FILE))
110 {
111 _dbus_string_free(&f);
112 _DBUS_SET_OOM (error);
113 return FALSE;
114 }
115
116 if (_dbus_stat(&f, &st, NULL) && (st.uid == uid))
117 {
118 _dbus_string_free(&f);
119 return TRUE;
120 }
121
122 _dbus_string_free(&f);
123
124#endif /* HAVE_CONSOLE_OWNER_FILE */
125
126 if (!_dbus_user_database_lock_system ())
127 {
128 _DBUS_SET_OOM (error);
129 return FALSE;
130 }
131
132 db = _dbus_user_database_get_system ();
133 if (db == NULL)
134 {
135 dbus_set_error (error, DBUS_ERROR_FAILED, "Could not get system database.");
136 _dbus_user_database_unlock_system ();
137 return FALSE;
138 }
139
140 /* TPTD: this should be cache-safe, we've locked the DB and
141 _dbus_user_at_console doesn't pass it on. */
142 info = _dbus_user_database_lookup (db, uid, NULL, error);
143
144 if (info == NULL)
145 {
146 _dbus_user_database_unlock_system ();
147 return FALSE;
148 }
149
150 result = _dbus_user_at_console (info->username, error);
151
152 _dbus_user_database_unlock_system ();
153
154 return result;
155}
156
164 dbus_bool_t
165_dbus_get_user_id (const DBusString *username,
166 dbus_uid_t *uid)
167{
168 return _dbus_get_user_id_and_primary_group (username, uid, NULL);
169}
170
178 dbus_bool_t
179_dbus_get_group_id (const DBusString *groupname,
180 dbus_gid_t *gid)
181{
182 DBusUserDatabase *db;
183 const DBusGroupInfo *info;
184
185 /* FIXME: this can't distinguish ENOMEM from other errors */
186 if (!_dbus_user_database_lock_system ())
187 return FALSE;
188
189 db = _dbus_user_database_get_system ();
190 if (db == NULL)
191 {
192 _dbus_user_database_unlock_system ();
193 return FALSE;
194 }
195
196 info = _dbus_user_database_lookup_group (db, DBUS_GID_UNSET, groupname,
197 NULL);
198
199 if (info == NULL)
200 {
201 _dbus_user_database_unlock_system ();
202 return FALSE;
203 }
204
205 *gid = info->gid;
206
207 _dbus_user_database_unlock_system ();
208 return TRUE;
209}
210
219 dbus_bool_t
220_dbus_get_user_id_and_primary_group (const DBusString *username,
221 dbus_uid_t *uid_p,
222 dbus_gid_t *gid_p)
223{
224 DBusUserDatabase *db;
225 const DBusUserInfo *info;
226
227 /* FIXME: this can't distinguish ENOMEM from other errors */
228 if (!_dbus_user_database_lock_system ())
229 return FALSE;
230
231 db = _dbus_user_database_get_system ();
232 if (db == NULL)
233 {
234 _dbus_user_database_unlock_system ();
235 return FALSE;
236 }
237
238 if (!_dbus_user_database_get_username (db, username,
239 &info, NULL))
240 {
241 _dbus_user_database_unlock_system ();
242 return FALSE;
243 }
244
245 if (uid_p)
246 *uid_p = info->uid;
247 if (gid_p)
248 *gid_p = info->primary_gid;
249
250 _dbus_user_database_unlock_system ();
251 return TRUE;
252}
253
266 const DBusGroupInfo *
267_dbus_user_database_lookup_group (DBusUserDatabase *db,
268 dbus_gid_t gid,
269 const DBusString *groupname,
270 DBusError *error)
271{
272 DBusGroupInfo *info;
273
274 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
275
276 /* See if the group is really a number */
277 if (gid == DBUS_UID_UNSET)
278 {
279 unsigned long n;
280
281 if (_dbus_is_a_number (groupname, &n))
282 gid = n;
283 }
284
285 if (gid != DBUS_GID_UNSET)
286 info = _dbus_hash_table_lookup_uintptr (db->groups, gid);
287 else
288 info = _dbus_hash_table_lookup_string (db->groups_by_name,
289 _dbus_string_get_const_data (groupname));
290 if (info)
291 {
292 _dbus_verbose ("Using cache for GID "DBUS_GID_FORMAT" information\n",
293 info->gid);
294 return info;
295 }
296 else
297 {
298 if (gid != DBUS_GID_UNSET)
299 _dbus_verbose ("No cache for GID "DBUS_GID_FORMAT"\n",
300 gid);
301 else
302 _dbus_verbose ("No cache for groupname \"%s\"\n",
303 _dbus_string_get_const_data (groupname));
304
305 info = dbus_new0 (DBusGroupInfo, 1);
306 if (info == NULL)
307 {
308 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
309 return NULL;
310 }
311 info->refcount = 1;
312
313 if (gid != DBUS_GID_UNSET)
314 {
315 if (!_dbus_group_info_fill_gid (info, gid, error))
316 {
317 _DBUS_ASSERT_ERROR_IS_SET (error);
318 _dbus_group_info_unref (info);
319 return NULL;
320 }
321 }
322 else
323 {
324 if (!_dbus_group_info_fill (info, groupname, error))
325 {
326 _DBUS_ASSERT_ERROR_IS_SET (error);
327 _dbus_group_info_unref (info);
328 return NULL;
329 }
330 }
331
332 /* don't use these past here */
333 gid = DBUS_GID_UNSET;
334 groupname = NULL;
335
336 if (_dbus_hash_table_insert_uintptr (db->groups, info->gid, info))
337 {
338 _dbus_group_info_ref (info);
339 }
340 else
341 {
342 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
343 _dbus_group_info_unref (info);
344 return NULL;
345 }
346
347
348 if (_dbus_hash_table_insert_string (db->groups_by_name,
349 info->groupname,
350 info))
351 {
352 _dbus_group_info_ref (info);
353 }
354 else
355 {
356 _dbus_hash_table_remove_uintptr (db->groups, info->gid);
357 _dbus_group_info_unref (info);
358 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
359 return NULL;
360 }
361
362 /* Release the original reference */
363 _dbus_group_info_unref (info);
364
365 /* Return a borrowed reference to the DBusGroupInfo owned by the
366 * two hash tables */
367 return info;
368 }
369}
370
381 dbus_bool_t
382_dbus_groups_from_uid (dbus_uid_t uid,
383 dbus_gid_t **group_ids,
384 int *n_group_ids)
385{
386 DBusUserDatabase *db;
387 const DBusUserInfo *info;
388 *group_ids = NULL;
389 *n_group_ids = 0;
390
391 /* FIXME: this can't distinguish ENOMEM from other errors */
392 if (!_dbus_user_database_lock_system ())
393 return FALSE;
394
395 db = _dbus_user_database_get_system ();
396 if (db == NULL)
397 {
398 _dbus_user_database_unlock_system ();
399 return FALSE;
400 }
401
402 if (!_dbus_user_database_get_uid (db, uid,
403 &info, NULL))
404 {
405 _dbus_user_database_unlock_system ();
406 return FALSE;
407 }
408
409 _dbus_assert (info->uid == uid);
410
411 if (info->n_group_ids > 0)
412 {
413 *group_ids = dbus_new (dbus_gid_t, info->n_group_ids);
414 if (*group_ids == NULL)
415 {
416 _dbus_user_database_unlock_system ();
417 return FALSE;
418 }
419
420 *n_group_ids = info->n_group_ids;
421
422 memcpy (*group_ids, info->group_ids, info->n_group_ids * sizeof (dbus_gid_t));
423 }
424
425 _dbus_user_database_unlock_system ();
426 return TRUE;
427}
dbus_set_error
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_hash_table_remove_uintptr
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_hash_table_insert_string
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
_dbus_hash_table_lookup_uintptr
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
_dbus_hash_table_lookup_string
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_hash_table_insert_uintptr
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_stat
dbus_bool_t _dbus_stat(const DBusString *filename, DBusStat *statbuf, DBusError *error)
stat() wrapper.
Definition: dbus-sysdeps-util-unix.c:635
_dbus_assert
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
Definition: dbus-internals.h:153
_dbus_user_database_lock_system
dbus_bool_t _dbus_user_database_lock_system(void)
Locks global system user database.
Definition: dbus-userdb.c:351
_dbus_user_at_console
dbus_bool_t _dbus_user_at_console(const char *username, DBusError *error)
Checks if user is at the console.
Definition: dbus-sysdeps-util-unix.c:571
_dbus_error_from_errno
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
_dbus_user_database_unlock_system
void _dbus_user_database_unlock_system(void)
Unlocks global system user database.
Definition: dbus-userdb.c:368
_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_get_group_id
dbus_bool_t _dbus_get_group_id(const DBusString *groupname, dbus_gid_t *gid)
Gets group ID given groupname.
Definition: dbus-userdb-util.c:179
_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_is_console_user
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:68
_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:267
_dbus_get_user_id_and_primary_group
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:220
_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_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:382
_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:165
_dbus_user_database_get_system
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
NULL
#define NULL
A null pointer, defined appropriately for C or C++.
TRUE
#define TRUE
Expands to "1".
FALSE
#define FALSE
Expands to "0".
dbus_new
#define dbus_new(type, count)
Safe macro for using dbus_malloc().
Definition: dbus-memory.h:57
dbus_new0
#define dbus_new0(type, count)
Safe macro for using dbus_malloc0().
Definition: dbus-memory.h:58
DBUS_ERROR_FAILED
#define DBUS_ERROR_FAILED
A generic error; "something went wrong" - see the error message for more.
Definition: dbus-protocol.h:359
DBUS_ERROR_NO_MEMORY
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
Definition: dbus-protocol.h:361
_dbus_string_append
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:959
_dbus_string_init
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:182
_dbus_string_free
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:271
_dbus_group_info_fill
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.
Definition: dbus-sysdeps-util-unix.c:926
_dbus_group_info_fill_gid
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.
Definition: dbus-sysdeps-util-unix.c:945
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_UID_UNSET
#define DBUS_UID_UNSET
an invalid UID used to represent an uninitialized dbus_uid_t field
Definition: dbus-sysdeps.h:144
DBUS_GID_UNSET
#define DBUS_GID_UNSET
an invalid GID used to represent an uninitialized dbus_gid_t field
Definition: dbus-sysdeps.h:146
DBUS_GID_FORMAT
#define DBUS_GID_FORMAT
an appropriate printf format for dbus_gid_t
Definition: dbus-sysdeps.h:153
DBUS_UID_FORMAT
#define DBUS_UID_FORMAT
an appropriate printf format for dbus_uid_t
Definition: dbus-sysdeps.h:151
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
DBusGroupInfo::gid
dbus_gid_t gid
GID.
Definition: dbus-sysdeps-unix.h:123
DBusGroupInfo::groupname
char * groupname
Group name.
Definition: dbus-sysdeps-unix.h:124
DBusGroupInfo::refcount
size_t refcount
Reference count.
Definition: dbus-sysdeps-unix.h:122
DBusStat
Portable struct with stat() results.
Definition: dbus-sysdeps.h:554
DBusStat::uid
dbus_uid_t uid
User owning file.
Definition: dbus-sysdeps.h:557
DBusString
Definition: dbus-string.h:43
DBusUserInfo
Information about a UNIX user.
Definition: dbus-sysdeps-unix.h:107
DBusUserInfo::n_group_ids
int n_group_ids
Size of group IDs array.
Definition: dbus-sysdeps-unix.h:112
DBusUserInfo::uid
dbus_uid_t uid
UID.
Definition: dbus-sysdeps-unix.h:109
DBusUserInfo::group_ids
dbus_gid_t * group_ids
Groups IDs, including above primary group.
Definition: dbus-sysdeps-unix.h:111
DBusUserInfo::username
char * username
Username.
Definition: dbus-sysdeps-unix.h:113
DBusUserInfo::primary_gid
dbus_gid_t primary_gid
GID.
Definition: dbus-sysdeps-unix.h:110