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 <dbus/dbus-sysdeps.h>
  29
  30 #ifdef DBUS_WIN
  31 #error "Don't include this on Windows"
  32 #endif
  33
  34 DBUS_BEGIN_DECLS
  35
  36 /**
  37  * @defgroup DBusSysdepsUnix UNIX-specific internal API
  38  * @ingroup DBusInternals
  39  * @brief Internal system-dependent API available on UNIX only
  40  * @{
  41  */
  42
  43 DBUS_PRIVATE_EXPORT
  44 dbus_bool_t
  45 _dbus_close     (int               fd,
  46                  DBusError        *error);
  47 DBUS_PRIVATE_EXPORT
  48 int _dbus_dup   (int               fd,
  49                  DBusError        *error);
  50 DBUS_PRIVATE_EXPORT
  51 int
  52 _dbus_read      (int               fd,
  53                  DBusString       *buffer,
  54                  int               count);
  55 int
  56 _dbus_write     (int               fd,
  57                  const DBusString *buffer,
  58                  int               start,
  59                  int               len);
  60 int
  61 _dbus_write_two (int               fd,
  62                  const DBusString *buffer1,
  63                  int               start1,
  64                  int               len1,
  65                  const DBusString *buffer2,
  66                  int               start2,
  67                  int               len2);
  68
  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 int _dbus_connect_exec (const char     *path,
  77                         char *const    argv[],
  78                         DBusError      *error);
  79
  80 int _dbus_listen_systemd_sockets (DBusSocket  **fd,
  81                                   DBusError    *error);
  82
  83 dbus_bool_t _dbus_read_credentials (int               client_fd,
  84                                     DBusCredentials  *credentials,
  85                                     DBusError        *error);
  86 dbus_bool_t _dbus_send_credentials (int              server_fd,
  87                                     DBusError       *error);
  88
  89 dbus_bool_t _dbus_lookup_launchd_socket (DBusString *socket_path,
  90                                          const char *launchd_env_var,
  91                                          DBusError  *error);
  92
  93 DBUS_PRIVATE_EXPORT
  94 dbus_bool_t _dbus_lookup_user_bus (dbus_bool_t *supported,
  95                                    DBusString  *address,
  96                                    DBusError   *error);
  97
  98 /** Information about a UNIX user */
  99 typedef struct DBusUserInfo  DBusUserInfo;
 100 /** Information about a UNIX group */
 101 typedef struct DBusGroupInfo DBusGroupInfo;
 102
 103 /**
 104  * Information about a UNIX user
 105  */
 106 struct DBusUserInfo
 107 {
 108   size_t      refcount;       /**< Reference count */
 109   dbus_uid_t  uid;            /**< UID */
 110   dbus_gid_t  primary_gid;    /**< GID */
 111   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 112   int         n_group_ids;    /**< Size of group IDs array */
 113   char       *username;       /**< Username */
 114   char       *homedir;        /**< Home directory */
 115 };
 116
 117 /**
 118  * Information about a UNIX group
 119  */
 120 struct DBusGroupInfo
 121 {
 122   size_t      refcount;       /**< Reference count */
 123   dbus_gid_t  gid;            /**< GID */
 124   char       *groupname;      /**< Group name */
 125 };
 126
 127 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 128                                       const DBusString *username,
 129                                       DBusError        *error);
 130 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 131                                       dbus_uid_t        uid,
 132                                       DBusError        *error);
 133 void        _dbus_user_info_free     (DBusUserInfo     *info);
 134
 135 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 136                                        const DBusString *groupname,
 137                                        DBusError        *error);
 138 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 139                                        dbus_gid_t        gid,
 140                                        DBusError        *error);
 141 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 142
 143 DBUS_PRIVATE_EXPORT
 144 dbus_uid_t    _dbus_geteuid (void);
 145
 146 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
 147                              dbus_uid_t        *uid);
 148
 149 DBUS_PRIVATE_EXPORT
 150 void _dbus_close_all (void);
 151
 152 dbus_bool_t _dbus_append_address_from_socket (DBusSocket  fd,
 153                                               DBusString *address,
 154                                               DBusError  *error);
 155
 156 DBUS_PRIVATE_EXPORT
 157 void _dbus_fd_set_close_on_exec (int fd);
 158
 159 typedef enum
 160 {
 161   DBUS_FORCE_STDIN_NULL = (1 << 0),
 162   DBUS_FORCE_STDOUT_NULL = (1 << 1),
 163   DBUS_FORCE_STDERR_NULL = (1 << 2)
 164 } DBusEnsureStandardFdsFlags;
 165
 166 DBUS_PRIVATE_EXPORT
 167 dbus_bool_t _dbus_ensure_standard_fds (DBusEnsureStandardFdsFlags   flags,
 168                                        const char                 **error_str_p);
 169
 170 /** A UNIX signal handler */
 171 typedef void (* DBusSignalHandler) (int sig);
 172
 173 void _dbus_set_signal_handler (int               sig,
 174                                DBusSignalHandler handler);
 175
 176 /** @} */
 177
 178 DBUS_END_DECLS
 179
 180 #endif /* DBUS_SYSDEPS_UNIX_H */