dbus/dbus-sysdeps-unix.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-sysdeps-unix.h UNIX-specific wrappers around system/libc features (internal to D-Bus implementation)
   3  *
   4  * Copyright (C) 2002, 2003, 2006  Red Hat, Inc.
   5  * Copyright (C) 2003 CodeFactory AB
   6  *
   7  * Licensed under the Academic Free License version 2.1
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  22  *
  23  */
  24
  25 #ifndef DBUS_SYSDEPS_UNIX_H
  26 #define DBUS_SYSDEPS_UNIX_H
  27
  28 #include <config.h>
  29 #include <dbus/dbus-sysdeps.h>
  30
  31 #ifdef DBUS_WIN
  32 #error "Don't include this on Windows"
  33 #endif
  34
  35 DBUS_BEGIN_DECLS
  36
  37 /**
  38  * @defgroup DBusSysdepsUnix UNIX-specific internal API
  39  * @ingroup DBusInternals
  40  * @brief Internal system-dependent API available on UNIX only
  41  * @{
  42  */
  43
  44 dbus_bool_t
  45 _dbus_close     (int               fd,
  46                  DBusError        *error);
  47 int _dbus_dup   (int               fd,
  48                  DBusError        *error);
  49 int
  50 _dbus_read      (int               fd,
  51                  DBusString       *buffer,
  52                  int               count);
  53 int
  54 _dbus_write     (int               fd,
  55                  const DBusString *buffer,
  56                  int               start,
  57                  int               len);
  58 int
  59 _dbus_write_two (int               fd,
  60                  const DBusString *buffer1,
  61                  int               start1,
  62                  int               len1,
  63                  const DBusString *buffer2,
  64                  int               start2,
  65                  int               len2);
  66
  67 dbus_bool_t _dbus_open_unix_socket (int              *fd,
  68                                     DBusError        *error);
  69 int _dbus_connect_unix_socket (const char     *path,
  70                                dbus_bool_t     abstract,
  71                                DBusError      *error);
  72 int _dbus_listen_unix_socket  (const char     *path,
  73                                dbus_bool_t     abstract,
  74                                DBusError      *error);
  75
  76 dbus_bool_t _dbus_read_credentials (int               client_fd,
  77                                     DBusCredentials  *credentials,
  78                                     DBusError        *error);
  79 dbus_bool_t _dbus_send_credentials (int              server_fd,
  80                                     DBusError       *error);
  81
  82 /** Information about a UNIX user */
  83 typedef struct DBusUserInfo  DBusUserInfo;
  84 /** Information about a UNIX group */
  85 typedef struct DBusGroupInfo DBusGroupInfo;
  86
  87 /**
  88  * Information about a UNIX user
  89  */
  90 struct DBusUserInfo
  91 {
  92   dbus_uid_t  uid;            /**< UID */
  93   dbus_gid_t  primary_gid;    /**< GID */
  94   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
  95   int         n_group_ids;    /**< Size of group IDs array */
  96   char       *username;       /**< Username */
  97   char       *homedir;        /**< Home directory */
  98 };
  99
 100 /**
 101  * Information about a UNIX group
 102  */
 103 struct DBusGroupInfo
 104 {
 105   dbus_gid_t  gid;            /**< GID */
 106   char       *groupname;      /**< Group name */
 107 };
 108
 109 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 110                                       const DBusString *username,
 111                                       DBusError        *error);
 112 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 113                                       dbus_uid_t        uid,
 114                                       DBusError        *error);
 115 void        _dbus_user_info_free     (DBusUserInfo     *info);
 116
 117 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 118                                        const DBusString *groupname,
 119                                        DBusError        *error);
 120 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 121                                        dbus_gid_t        gid,
 122                                        DBusError        *error);
 123 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 124
 125 dbus_uid_t    _dbus_getuid (void);
 126 dbus_uid_t    _dbus_geteuid (void);
 127 dbus_gid_t    _dbus_getgid (void);
 128
 129 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
 130                              dbus_uid_t        *uid);
 131
 132 /** @} */
 133
 134 DBUS_END_DECLS
 135
 136 #endif /* DBUS_SYSDEPS_UNIX_H */