Home | History | Annotate | Download | only in dbus
      1 /* -*- mode: C; c-file-style: "gnu" -*- */
      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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
     21  *
     22  */
     23 
     24 #ifndef DBUS_USERDB_H
     25 #define DBUS_USERDB_H
     26 
     27 #include <dbus/dbus-sysdeps.h>
     28 
     29 DBUS_BEGIN_DECLS
     30 
     31 typedef struct DBusUserDatabase DBusUserDatabase;
     32 
     33 #ifdef DBUS_USERDB_INCLUDES_PRIVATE
     34 #include <dbus/dbus-hash.h>
     35 
     36 /**
     37  * Internals of DBusUserDatabase
     38  */
     39 struct DBusUserDatabase
     40 {
     41   int refcount; /**< Reference count */
     42 
     43   DBusHashTable *users; /**< Users in the database by UID */
     44   DBusHashTable *groups; /**< Groups in the database by GID */
     45   DBusHashTable *users_by_name; /**< Users in the database by name */
     46   DBusHashTable *groups_by_name; /**< Groups in the database by name */
     47 
     48 };
     49 
     50 #endif /* DBUS_USERDB_INCLUDES_PRIVATE */
     51 
     52 DBusUserDatabase* _dbus_user_database_new           (void);
     53 DBusUserDatabase* _dbus_user_database_ref           (DBusUserDatabase     *db);
     54 void              _dbus_user_database_flush         (DBusUserDatabase     *db);
     55 void              _dbus_user_database_unref         (DBusUserDatabase     *db);
     56 dbus_bool_t       _dbus_user_database_get_groups    (DBusUserDatabase     *db,
     57                                                      dbus_uid_t            uid,
     58                                                      dbus_gid_t          **group_ids,
     59                                                      int                  *n_group_ids,
     60                                                      DBusError            *error);
     61 dbus_bool_t       _dbus_user_database_get_uid       (DBusUserDatabase     *db,
     62                                                      dbus_uid_t            uid,
     63                                                      const DBusUserInfo  **info,
     64                                                      DBusError            *error);
     65 dbus_bool_t       _dbus_user_database_get_gid       (DBusUserDatabase     *db,
     66                                                      dbus_gid_t            gid,
     67                                                      const DBusGroupInfo **info,
     68                                                      DBusError            *error);
     69 dbus_bool_t       _dbus_user_database_get_username  (DBusUserDatabase     *db,
     70                                                      const DBusString     *username,
     71                                                      const DBusUserInfo  **info,
     72                                                      DBusError            *error);
     73 dbus_bool_t       _dbus_user_database_get_groupname (DBusUserDatabase     *db,
     74                                                      const DBusString     *groupname,
     75                                                      const DBusGroupInfo **info,
     76                                                      DBusError            *error);
     77 
     78 #ifdef DBUS_USERDB_INCLUDES_PRIVATE
     79 DBusUserInfo*  _dbus_user_database_lookup       (DBusUserDatabase *db,
     80                                                  dbus_uid_t        uid,
     81                                                  const DBusString *username,
     82                                                  DBusError        *error);
     83 DBusGroupInfo* _dbus_user_database_lookup_group (DBusUserDatabase *db,
     84                                                  dbus_gid_t        gid,
     85                                                  const DBusString *groupname,
     86                                                  DBusError        *error);
     87 void           _dbus_user_info_free_allocated   (DBusUserInfo     *info);
     88 void           _dbus_group_info_free_allocated  (DBusGroupInfo    *info);
     89 #endif /* DBUS_USERDB_INCLUDES_PRIVATE */
     90 
     91 DBusUserDatabase* _dbus_user_database_get_system    (void);
     92 void              _dbus_user_database_lock_system   (void);
     93 void              _dbus_user_database_unlock_system (void);
     94 
     95 dbus_bool_t _dbus_username_from_current_process (const DBusString **username);
     96 dbus_bool_t _dbus_homedir_from_current_process  (const DBusString **homedir);
     97 dbus_bool_t _dbus_homedir_from_username         (const DBusString  *username,
     98                                                  DBusString        *homedir);
     99 dbus_bool_t _dbus_get_user_id                   (const DBusString  *username,
    100                                                  dbus_uid_t        *uid);
    101 dbus_bool_t _dbus_get_group_id                  (const DBusString  *group_name,
    102                                                  dbus_gid_t        *gid);
    103 dbus_bool_t _dbus_credentials_from_username     (const DBusString  *username,
    104                                                  DBusCredentials   *credentials);
    105 dbus_bool_t _dbus_credentials_from_uid          (dbus_uid_t         user_id,
    106                                                  DBusCredentials   *credentials);
    107 dbus_bool_t _dbus_is_console_user               (dbus_uid_t         uid,
    108                                                  DBusError         *error);
    109 
    110 dbus_bool_t _dbus_is_a_number                   (const DBusString *str,
    111                                                  unsigned long    *num);
    112 
    113 
    114 DBUS_END_DECLS
    115 
    116 #endif /* DBUS_USERDB_H */
    117