D-Bus  1.13.7
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 
57  DBusError *error)
58 {
59 
60  DBusUserDatabase *db;
61  const DBusUserInfo *info;
62  dbus_bool_t result = FALSE;
63 
64 #ifdef HAVE_SYSTEMD
65  /* check if we have logind */
66  if (access ("/run/systemd/seats/", F_OK) >= 0)
67  {
68  int r;
69 
70  /* Check whether this user is logged in on at least one physical
71  seat */
72  r = sd_uid_get_seats (uid, 0, NULL);
73  if (r < 0)
74  {
76  "Failed to determine seats of user \"" DBUS_UID_FORMAT "\": %s",
77  uid,
78  _dbus_strerror (-r));
79  return FALSE;
80  }
81 
82  return (r > 0);
83  }
84 #endif
85 
86 #ifdef HAVE_CONSOLE_OWNER_FILE
87 
88  DBusString f;
89  DBusStat st;
90 
91  if (!_dbus_string_init (&f))
92  {
93  _DBUS_SET_OOM (error);
94  return FALSE;
95  }
96 
97  if (!_dbus_string_append(&f, DBUS_CONSOLE_OWNER_FILE))
98  {
100  _DBUS_SET_OOM (error);
101  return FALSE;
102  }
103 
104  if (_dbus_stat(&f, &st, NULL) && (st.uid == uid))
105  {
106  _dbus_string_free(&f);
107  return TRUE;
108  }
109 
110  _dbus_string_free(&f);
111 
112 #endif /* HAVE_CONSOLE_OWNER_FILE */
113 
115  {
116  _DBUS_SET_OOM (error);
117  return FALSE;
118  }
119 
121  if (db == NULL)
122  {
123  dbus_set_error (error, DBUS_ERROR_FAILED, "Could not get system database.");
125  return FALSE;
126  }
127 
128  /* TPTD: this should be cache-safe, we've locked the DB and
129  _dbus_user_at_console doesn't pass it on. */
130  info = _dbus_user_database_lookup (db, uid, NULL, error);
131 
132  if (info == NULL)
133  {
135  return FALSE;
136  }
137 
138  result = _dbus_user_at_console (info->username, error);
139 
141 
142  return result;
143 }
144 
153 _dbus_get_user_id (const DBusString *username,
154  dbus_uid_t *uid)
155 {
156  return _dbus_get_user_id_and_primary_group (username, uid, NULL);
157 }
158 
167 _dbus_get_group_id (const DBusString *groupname,
168  dbus_gid_t *gid)
169 {
170  DBusUserDatabase *db;
171  const DBusGroupInfo *info;
172 
173  /* FIXME: this can't distinguish ENOMEM from other errors */
175  return FALSE;
176 
178  if (db == NULL)
179  {
181  return FALSE;
182  }
183 
184  if (!_dbus_user_database_get_groupname (db, groupname,
185  &info, NULL))
186  {
188  return FALSE;
189  }
190 
191  *gid = info->gid;
192 
194  return TRUE;
195 }
196 
207  dbus_uid_t *uid_p,
208  dbus_gid_t *gid_p)
209 {
210  DBusUserDatabase *db;
211  const DBusUserInfo *info;
212 
213  /* FIXME: this can't distinguish ENOMEM from other errors */
215  return FALSE;
216 
218  if (db == NULL)
219  {
221  return FALSE;
222  }
223 
224  if (!_dbus_user_database_get_username (db, username,
225  &info, NULL))
226  {
228  return FALSE;
229  }
230 
231  if (uid_p)
232  *uid_p = info->uid;
233  if (gid_p)
234  *gid_p = info->primary_gid;
235 
237  return TRUE;
238 }
239 
253 _dbus_user_database_lookup_group (DBusUserDatabase *db,
254  dbus_gid_t gid,
255  const DBusString *groupname,
256  DBusError *error)
257 {
258  DBusGroupInfo *info;
259 
260  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
261 
262  /* See if the group is really a number */
263  if (gid == DBUS_UID_UNSET)
264  {
265  unsigned long n;
266 
267  if (_dbus_is_a_number (groupname, &n))
268  gid = n;
269  }
270 
271  if (gid != DBUS_GID_UNSET)
272  info = _dbus_hash_table_lookup_uintptr (db->groups, gid);
273  else
274  info = _dbus_hash_table_lookup_string (db->groups_by_name,
275  _dbus_string_get_const_data (groupname));
276  if (info)
277  {
278  _dbus_verbose ("Using cache for GID "DBUS_GID_FORMAT" information\n",
279  info->gid);
280  return info;
281  }
282  else
283  {
284  if (gid != DBUS_GID_UNSET)
285  _dbus_verbose ("No cache for GID "DBUS_GID_FORMAT"\n",
286  gid);
287  else
288  _dbus_verbose ("No cache for groupname \"%s\"\n",
289  _dbus_string_get_const_data (groupname));
290 
291  info = dbus_new0 (DBusGroupInfo, 1);
292  if (info == NULL)
293  {
295  return NULL;
296  }
297 
298  if (gid != DBUS_GID_UNSET)
299  {
300  if (!_dbus_group_info_fill_gid (info, gid, error))
301  {
302  _DBUS_ASSERT_ERROR_IS_SET (error);
304  return NULL;
305  }
306  }
307  else
308  {
309  if (!_dbus_group_info_fill (info, groupname, error))
310  {
311  _DBUS_ASSERT_ERROR_IS_SET (error);
313  return NULL;
314  }
315  }
316 
317  /* don't use these past here */
318  gid = DBUS_GID_UNSET;
319  groupname = NULL;
320 
321  if (!_dbus_hash_table_insert_uintptr (db->groups, info->gid, info))
322  {
325  return NULL;
326  }
327 
328 
329  if (!_dbus_hash_table_insert_string (db->groups_by_name,
330  info->groupname,
331  info))
332  {
333  _dbus_hash_table_remove_uintptr (db->groups, info->gid);
335  return NULL;
336  }
337 
338  return info;
339  }
340 }
341 
342 
354 _dbus_user_database_get_groupname (DBusUserDatabase *db,
355  const DBusString *groupname,
356  const DBusGroupInfo **info,
357  DBusError *error)
358 {
359  *info = _dbus_user_database_lookup_group (db, DBUS_GID_UNSET, groupname, error);
360  return *info != NULL;
361 }
362 
374 _dbus_user_database_get_gid (DBusUserDatabase *db,
375  dbus_gid_t gid,
376  const DBusGroupInfo **info,
377  DBusError *error)
378 {
379  *info = _dbus_user_database_lookup_group (db, gid, NULL, error);
380  return *info != NULL;
381 }
382 
383 
396  dbus_gid_t **group_ids,
397  int *n_group_ids)
398 {
399  DBusUserDatabase *db;
400  const DBusUserInfo *info;
401  *group_ids = NULL;
402  *n_group_ids = 0;
403 
404  /* FIXME: this can't distinguish ENOMEM from other errors */
406  return FALSE;
407 
409  if (db == NULL)
410  {
412  return FALSE;
413  }
414 
415  if (!_dbus_user_database_get_uid (db, uid,
416  &info, NULL))
417  {
419  return FALSE;
420  }
421 
422  _dbus_assert (info->uid == uid);
423 
424  if (info->n_group_ids > 0)
425  {
426  *group_ids = dbus_new (dbus_gid_t, info->n_group_ids);
427  if (*group_ids == NULL)
428  {
430  return FALSE;
431  }
432 
433  *n_group_ids = info->n_group_ids;
434 
435  memcpy (*group_ids, info->group_ids, info->n_group_ids * sizeof (dbus_gid_t));
436  }
437 
439  return TRUE;
440 }
443 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
444 #include <stdio.h>
445 
452 _dbus_userdb_test (const char *test_data_dir)
453 {
454  const DBusString *username;
455  const DBusString *homedir;
456  dbus_uid_t uid;
457  unsigned long *group_ids;
458  int n_group_ids, i;
459  DBusError error;
460 
461  if (!_dbus_username_from_current_process (&username))
462  _dbus_test_fatal ("didn't get username");
463 
464  if (!_dbus_homedir_from_current_process (&homedir))
465  _dbus_test_fatal ("didn't get homedir");
466 
467  if (!_dbus_get_user_id (username, &uid))
468  _dbus_test_fatal ("didn't get uid");
469 
470  if (!_dbus_groups_from_uid (uid, &group_ids, &n_group_ids))
471  _dbus_test_fatal ("didn't get groups");
472 
473  _dbus_test_diag (" Current user: %s homedir: %s gids:",
474  _dbus_string_get_const_data (username),
475  _dbus_string_get_const_data (homedir));
476 
477  for (i=0; i<n_group_ids; i++)
478  _dbus_test_diag ("- %ld", group_ids[i]);
479 
480  dbus_error_init (&error);
481  _dbus_test_diag ("Is Console user: %i",
482  _dbus_is_console_user (uid, &error));
483  _dbus_test_diag ("Invocation was OK: %s", error.message ? error.message : "yes");
484  dbus_error_free (&error);
485  _dbus_test_diag ("Is Console user 4711: %i",
486  _dbus_is_console_user (4711, &error));
487  _dbus_test_diag ("Invocation was OK: %s", error.message ? error.message : "yes");
488  dbus_error_free (&error);
489 
490  dbus_free (group_ids);
491 
492  return TRUE;
493 }
494 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */
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:952
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:1110
const char * message
public error message field
Definition: dbus-errors.h:51
char * username
Username.
#define NULL
A null pointer, defined appropriately for C or C++.
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
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:703
Portable struct with stat() results.
Definition: dbus-sysdeps.h:546
#define dbus_new(type, count)
Safe macro for using dbus_malloc().
Definition: dbus-memory.h:57
#define DBUS_GID_FORMAT
an appropriate printf format for dbus_gid_t
Definition: dbus-sysdeps.h:150
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_user_database_lock_system(void)
Locks global system user database.
Definition: dbus-userdb.c:313
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.
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
void dbus_error_free(DBusError *error)
Frees an error that&#39;s been set (or just initialized), then reinitializes the error as in dbus_error_i...
Definition: dbus-errors.c:211
dbus_gid_t primary_gid
GID.
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:1300
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
void _dbus_user_database_unlock_system(void)
Unlocks global system user database.
Definition: dbus-userdb.c:330
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:175
char * groupname
Group name.
#define DBUS_UID_UNSET
an invalid UID used to represent an uninitialized dbus_uid_t field
Definition: dbus-sysdeps.h:141
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...
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
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_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_gid_t * group_ids
Groups IDs, including above primary group.
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_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
#define dbus_new0(type, count)
Safe macro for using dbus_malloc0().
Definition: dbus-memory.h:58
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
int n_group_ids
Size of group IDs array.
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:1225
dbus_uid_t uid
UID.
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...
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 *groupname, dbus_gid_t *gid)
Gets group ID given groupname.
Object representing an exception.
Definition: dbus-errors.h:48
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
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:264
#define DBUS_GID_UNSET
an invalid GID used to represent an uninitialized dbus_gid_t field
Definition: dbus-sysdeps.h:143
#define TRUE
Expands to "1".
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_uid_t uid
User owning file.
Definition: dbus-sysdeps.h:550
#define DBUS_ERROR_FAILED
A generic error; "something went wrong" - see the error message for more.
#define DBUS_UID_FORMAT
an appropriate printf format for dbus_uid_t
Definition: dbus-sysdeps.h:148
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_stat(const DBusString *filename, DBusStat *statbuf, DBusError *error)
stat() wrapper.
dbus_bool_t _dbus_get_user_id(const DBusString *username, dbus_uid_t *uid)
Gets user ID given username.
void dbus_error_init(DBusError *error)
Initializes a DBusError structure.
Definition: dbus-errors.c:188
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:1060
dbus_bool_t _dbus_user_at_console(const char *username, DBusError *error)
Checks if user is at the console.
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
#define FALSE
Expands to "0".
dbus_gid_t gid
GID.
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
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:134
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:1190
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.