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