dbus/dbus-sysdeps.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-sysdeps.h Wrappers around system/libc features (internal to D-BUS implementation)
   3  *
   4  * Copyright (C) 2002, 2003  Red Hat, Inc.
   5  * Copyright (C) 2003 CodeFactory AB
   6  *
   7  * Licensed under the Academic Free License version 1.2
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #ifndef DBUS_SYSDEPS_H
  26 #define DBUS_SYSDEPS_H
  27
  28 #include <dbus/dbus-string.h>
  29 #include <dbus/dbus-errors.h>
  30
  31 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
  32  * stuff straight out of string.h, so have this here for now.
  33  */
  34 #include <string.h>
  35
  36 /* and it would just be annoying to abstract this */
  37 #include <errno.h>
  38
  39 DBUS_BEGIN_DECLS;
  40
  41 /* The idea of this file is to encapsulate everywhere that we're
  42  * relying on external libc features, for ease of security
  43  * auditing. The idea is from vsftpd. This also gives us a chance to
  44  * make things more convenient to use, e.g.  by reading into a
  45  * DBusString. Operating system headers aren't intended to be used
  46  * outside of this file and a limited number of others (such as
  47  * dbus-memory.c)
  48  */
  49
  50 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  51 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  52   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  53 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )     \
  54   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  55 #define _DBUS_GNUC_FORMAT( arg_idx )                \
  56   __attribute__((__format_arg__ (arg_idx)))
  57 #define _DBUS_GNUC_NORETURN                         \
  58   __attribute__((__noreturn__))
  59 #else   /* !__GNUC__ */
  60 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  61 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
  62 #define _DBUS_GNUC_FORMAT( arg_idx )
  63 #define _DBUS_GNUC_NORETURN
  64 #endif  /* !__GNUC__ */
  65
  66 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  67
  68 const char* _dbus_getenv (const char *varname);
  69 dbus_bool_t _dbus_setenv (const char *varname,
  70                           const char *value);
  71
  72 int _dbus_read      (int               fd,
  73                      DBusString       *buffer,
  74                      int               count);
  75 int _dbus_write     (int               fd,
  76                      const DBusString *buffer,
  77                      int               start,
  78                      int               len);
  79 int _dbus_write_two (int               fd,
  80                      const DBusString *buffer1,
  81                      int               start1,
  82                      int               len1,
  83                      const DBusString *buffer2,
  84                      int               start2,
  85                      int               len2);
  86
  87 typedef unsigned long dbus_pid_t;
  88 typedef unsigned long dbus_uid_t;
  89 typedef unsigned long dbus_gid_t;
  90
  91 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
  92 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
  93 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
  94
  95 #define DBUS_PID_FORMAT "%lu"
  96 #define DBUS_UID_FORMAT "%lu"
  97 #define DBUS_GID_FORMAT "%lu"
  98
  99 typedef struct
 100 {
 101   /* Set to DBUS_PID_UNSET etc. if not available */
 102   dbus_pid_t pid;
 103   dbus_uid_t uid;
 104   dbus_gid_t gid;
 105 } DBusCredentials;
 106
 107 int _dbus_connect_unix_socket (const char     *path,
 108                                dbus_bool_t     abstract,
 109                                DBusError      *error);
 110 int _dbus_listen_unix_socket  (const char     *path,
 111                                dbus_bool_t     abstract,
 112                                DBusError      *error);
 113 int _dbus_connect_tcp_socket  (const char     *host,
 114                                dbus_uint32_t   port,
 115                                DBusError      *error);
 116 int _dbus_listen_tcp_socket   (const char     *host,
 117                                dbus_uint32_t   port,
 118                                DBusError      *error);
 119 int _dbus_accept              (int             listen_fd);
 120
 121 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
 122                                                 DBusCredentials *credentials,
 123                                                 DBusError       *error);
 124 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
 125                                                 DBusError       *error);
 126
 127
 128 void        _dbus_credentials_clear                (DBusCredentials       *credentials);
 129 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 130 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 131                                                     const DBusCredentials *provided_credentials);
 132
 133
 134 typedef struct DBusUserInfo  DBusUserInfo;
 135 typedef struct DBusGroupInfo DBusGroupInfo;
 136
 137 struct DBusUserInfo
 138 {
 139   dbus_uid_t  uid;            /**< UID */
 140   dbus_gid_t  primary_gid;    /**< GID */
 141   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 142   int         n_group_ids;    /**< Size of group IDs array */
 143   char       *username;       /**< Username */
 144   char       *homedir;        /**< Home directory */
 145 };
 146
 147 struct DBusGroupInfo
 148 {
 149   dbus_gid_t  gid;            /**< GID */
 150   char       *groupname;      /**< Group name */
 151 };
 152
 153 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 154                                       const DBusString *username,
 155                                       DBusError        *error);
 156 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 157                                       dbus_uid_t        uid,
 158                                       DBusError        *error);
 159 void        _dbus_user_info_free     (DBusUserInfo     *info);
 160
 161 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 162                                        const DBusString *groupname,
 163                                        DBusError        *error);
 164 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 165                                        dbus_gid_t        gid,
 166                                        DBusError        *error);
 167 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 168
 169
 170 unsigned long _dbus_getpid (void);
 171 dbus_uid_t    _dbus_getuid (void);
 172 dbus_gid_t    _dbus_getgid (void);
 173
 174 typedef struct DBusAtomic DBusAtomic;
 175 struct DBusAtomic
 176 {
 177   volatile dbus_int32_t value;
 178 };
 179
 180 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 181 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 182
 183 #define _DBUS_POLLIN      0x0001    /* There is data to read */
 184 #define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
 185 #define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
 186 #define _DBUS_POLLERR     0x0008    /* Error condition */
 187 #define _DBUS_POLLHUP     0x0010    /* Hung up */
 188 #define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */
 189
 190 typedef struct
 191 {
 192   int fd;
 193   short events;
 194   short revents;
 195 } DBusPollFD;
 196
 197 int _dbus_poll (DBusPollFD *fds,
 198                 int         n_fds,
 199                 int         timeout_milliseconds);
 200
 201 void _dbus_sleep_milliseconds (int milliseconds);
 202
 203 void _dbus_get_current_time (long *tv_sec,
 204                              long *tv_usec);
 205
 206
 207 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 208                                        const DBusString *filename,
 209                                        DBusError        *error);
 210 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 211                                        const DBusString *filename,
 212                                        DBusError        *error);
 213
 214 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 215                                               DBusError        *error);
 216 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 217                                               DBusError        *error);
 218 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 219                                               DBusError        *error);
 220
 221 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 222                                        const DBusString *next_component);
 223 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 224                                        DBusString       *dirname);
 225 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 226
 227 typedef struct DBusDirIter DBusDirIter;
 228
 229 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 230                                             DBusError        *error);
 231 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 232                                             DBusString       *filename,
 233                                             DBusError        *error);
 234 void         _dbus_directory_close         (DBusDirIter      *iter);
 235
 236
 237 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
 238                                          int         n_bytes);
 239 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
 240                                          int         n_bytes);
 241
 242 const char *_dbus_errno_to_string  (int errnum);
 243 const char* _dbus_error_from_errno (int error_number);
 244
 245 void _dbus_disable_sigpipe (void);
 246
 247 void _dbus_fd_set_close_on_exec (int fd);
 248
 249 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 250
 251 typedef struct
 252 {
 253   unsigned long mode;
 254   unsigned long nlink;
 255   dbus_uid_t    uid;
 256   dbus_gid_t    gid;
 257   unsigned long size;
 258   unsigned long atime;
 259   unsigned long mtime;
 260   unsigned long ctime;
 261 } DBusStat;
 262
 263 dbus_bool_t _dbus_stat             (const DBusString *filename,
 264                                     DBusStat         *statbuf,
 265                                     DBusError        *error);
 266 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 267                                     int              *fd2,
 268                                     dbus_bool_t       blocking,
 269                                     DBusError        *error);
 270 dbus_bool_t _dbus_close            (int               fd,
 271                                     DBusError        *error);
 272
 273 void        _dbus_print_backtrace  (void);
 274
 275 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 276                                    DBusError        *error);
 277 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 278                                    unsigned long     pid,
 279                                    DBusError        *error);
 280 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 281                                    unsigned long     gid,
 282                                    DBusError        *error);
 283
 284 typedef void (* DBusSignalHandler) (int sig);
 285
 286 void _dbus_set_signal_handler (int               sig,
 287                                DBusSignalHandler handler);
 288
 289
 290 DBUS_END_DECLS;
 291
 292 #endif /* DBUS_SYSDEPS_H */