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.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., 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 #include <stdarg.h>
  41
  42 DBUS_BEGIN_DECLS
  43
  44 /**
  45  * @addtogroup DBusSysdeps
  46  *
  47  * @{
  48  */
  49
  50 /* The idea of this file is to encapsulate everywhere that we're
  51  * relying on external libc features, for ease of security
  52  * auditing. The idea is from vsftpd. This also gives us a chance to
  53  * make things more convenient to use, e.g.  by reading into a
  54  * DBusString. Operating system headers aren't intended to be used
  55  * outside of this file and a limited number of others (such as
  56  * dbus-memory.c)
  57  */
  58
  59 /** An opaque string type */
  60 typedef struct DBusString DBusString;
  61
  62 /** avoid circular includes with DBusList */
  63 typedef struct DBusList DBusList;
  64
  65 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  66 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  67   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  68 #define _DBUS_GNUC_NORETURN                         \
  69   __attribute__((__noreturn__))
  70 #else   /* !__GNUC__ */
  71 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  72 #define _DBUS_GNUC_NORETURN
  73 #endif  /* !__GNUC__ */
  74
  75 /** @def _DBUS_GNUC_PRINTF
  76  * used to tell gcc about printf format strings
  77  */
  78 /** @def _DBUS_GNUC_NORETURN
  79  * used to tell gcc about functions that never return, such as _dbus_abort()
  80  */
  81
  82 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  83
  84 const char* _dbus_getenv (const char *varname);
  85 dbus_bool_t _dbus_setenv (const char *varname,
  86                           const char *value);
  87
  88 /** A process ID */
  89 typedef unsigned long dbus_pid_t;
  90 /** A user ID */
  91 typedef unsigned long dbus_uid_t;
  92 /** A group ID */
  93 typedef unsigned long dbus_gid_t;
  94
  95 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
  96 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
  97 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
  98 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
  99 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
 100 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
 101
 102 /** an appropriate printf format for dbus_pid_t */
 103 #define DBUS_PID_FORMAT "%lu"
 104 /** an appropriate printf format for dbus_uid_t */
 105 #define DBUS_UID_FORMAT "%lu"
 106 /** an appropriate printf format for dbus_gid_t */
 107 #define DBUS_GID_FORMAT "%lu"
 108
 109
 110 /**
 111  * Socket interface
 112  *
 113  *  @todo Use for the file descriptors a struct
 114  *           - struct DBusSocket{ int d; }; -
 115  *        instead of int to get type-safety which
 116  *        will be checked by the compiler.
 117  *
 118  */
 119
 120 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
 121                                     DBusError        *error);
 122 dbus_bool_t _dbus_close_socket     (int               fd,
 123                                     DBusError        *error);
 124 int         _dbus_read_socket      (int               fd,
 125                                     DBusString       *buffer,
 126                                     int               count);
 127 int         _dbus_write_socket     (int               fd,
 128                                     const DBusString *buffer,
 129                                     int               start,
 130                                     int               len);
 131 int         _dbus_write_socket_two (int               fd,
 132                                     const DBusString *buffer1,
 133                                     int               start1,
 134                                     int               len1,
 135                                     const DBusString *buffer2,
 136                                     int               start2,
 137                                     int               len2);
 138 int _dbus_connect_tcp_socket  (const char     *host,
 139                                dbus_uint32_t   port,
 140                                DBusError      *error);
 141 int _dbus_listen_tcp_socket   (const char     *host,
 142                                dbus_uint32_t   port,
 143                                DBusError      *error);
 144 int _dbus_accept              (int             listen_fd);
 145
 146 /**
 147  * Struct representing socket credentials
 148  */
 149 typedef struct
 150 {
 151   dbus_pid_t pid; /**< process ID or DBUS_PID_UNSET */
 152   dbus_uid_t uid; /**< user ID or DBUS_UID_UNSET */
 153   dbus_gid_t gid; /**< group ID or DBUS_GID_UNSET */
 154 } DBusCredentials;
 155
 156 /* FIXME these read/send credentials should get moved to sysdeps-unix.h,
 157  * or renamed to reflect what they mean cross-platform
 158  */
 159 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
 160                                                 DBusCredentials *credentials,
 161                                                 DBusError       *error);
 162 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
 163                                                 DBusError       *error);
 164
 165
 166 void        _dbus_credentials_clear                (DBusCredentials       *credentials);
 167 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 168 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 169                                                     const DBusCredentials *provided_credentials);
 170
 171
 172 /** Information about a UNIX user */
 173 typedef struct DBusUserInfo  DBusUserInfo;
 174 /** Information about a UNIX group */
 175 typedef struct DBusGroupInfo DBusGroupInfo;
 176
 177 /**
 178  * Information about a UNIX user
 179  */
 180 struct DBusUserInfo
 181 {
 182   dbus_uid_t  uid;            /**< UID */
 183   dbus_gid_t  primary_gid;    /**< GID */
 184   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 185   int         n_group_ids;    /**< Size of group IDs array */
 186   char       *username;       /**< Username */
 187   char       *homedir;        /**< Home directory */
 188 };
 189
 190 /**
 191  * Information about a UNIX group
 192  */
 193 struct DBusGroupInfo
 194 {
 195   dbus_gid_t  gid;            /**< GID */
 196   char       *groupname;      /**< Group name */
 197 };
 198
 199 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 200                                       const DBusString *username,
 201                                       DBusError        *error);
 202 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 203                                       dbus_uid_t        uid,
 204                                       DBusError        *error);
 205 void        _dbus_user_info_free     (DBusUserInfo     *info);
 206
 207 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 208                                        const DBusString *groupname,
 209                                        DBusError        *error);
 210 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 211                                        dbus_gid_t        gid,
 212                                        DBusError        *error);
 213 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 214
 215
 216 unsigned long _dbus_getpid (void);
 217 dbus_uid_t    _dbus_getuid (void);
 218 dbus_gid_t    _dbus_getgid (void);
 219
 220 /** Opaque type representing an atomically-modifiable integer
 221  * that can be used from multiple threads.
 222  */
 223 typedef struct DBusAtomic DBusAtomic;
 224
 225 /**
 226  * An atomic integer safe to increment or decrement from multiple threads.
 227  */
 228 struct DBusAtomic
 229 {
 230   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 231 };
 232
 233 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 234 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 235
 236 /** There is data to read */
 237 #define _DBUS_POLLIN      0x0001
 238 /** There is urgent data to read */
 239 #define _DBUS_POLLPRI     0x0002
 240 /** Writing now will not block */
 241 #define _DBUS_POLLOUT     0x0004
 242 /** Error condition */
 243 #define _DBUS_POLLERR     0x0008
 244 /** Hung up */
 245 #define _DBUS_POLLHUP     0x0010
 246 /** Invalid request: fd not open */
 247 #define _DBUS_POLLNVAL    0x0020
 248
 249 /**
 250  * A portable struct pollfd wrapper.
 251  */
 252 typedef struct
 253 {
 254   int fd;            /**< File descriptor */
 255   short events;      /**< Events to poll for */
 256   short revents;     /**< Events that occurred */
 257 } DBusPollFD;
 258
 259 int _dbus_poll (DBusPollFD *fds,
 260                 int         n_fds,
 261                 int         timeout_milliseconds);
 262
 263 void _dbus_sleep_milliseconds (int milliseconds);
 264
 265 void _dbus_get_current_time (long *tv_sec,
 266                              long *tv_usec);
 267
 268 /**
 269  * File/directory interface
 270  */
 271 dbus_bool_t _dbus_file_exists         (const char       *file);
 272 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 273                                        const DBusString *filename,
 274                                        DBusError        *error);
 275 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 276                                        const DBusString *filename,
 277                                        DBusError        *error);
 278
 279 dbus_bool_t _dbus_make_file_world_readable   (const DBusString *filename,
 280                                               DBusError *error);
 281
 282 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 283                                               DBusError        *error);
 284 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 285                                               DBusError        *error);
 286 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 287                                               DBusError        *error);
 288 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 289                                               DBusError        *error);
 290
 291 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 292                                        const DBusString *next_component);
 293 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 294                                        DBusString       *dirname);
 295 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 296
 297 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
 298
 299 /** Opaque type for reading a directory listing */
 300 typedef struct DBusDirIter DBusDirIter;
 301
 302 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 303                                             DBusError        *error);
 304 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 305                                             DBusString       *filename,
 306                                             DBusError        *error);
 307 void         _dbus_directory_close         (DBusDirIter      *iter);
 308
 309 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 310                                                     DBusError *error);
 311
 312 void _dbus_fd_set_close_on_exec (int fd);
 313
 314 const char* _dbus_get_tmpdir      (void);
 315
 316 /**
 317  * Random numbers
 318  */
 319 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 320                                                       int   n_bytes);
 321 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 322                                                 int         n_bytes);
 323 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 324                                                 int         n_bytes);
 325 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 326                                                 int         n_bytes);
 327
 328 const char* _dbus_error_from_errno (int error_number);
 329
 330 void _dbus_disable_sigpipe (void);
 331
 332
 333 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 334
 335 int _dbus_printf_string_upper_bound (const char *format,
 336                                      va_list args);
 337
 338
 339 /**
 340  * Portable struct with stat() results
 341  */
 342 typedef struct
 343 {
 344   unsigned long mode;  /**< File mode */
 345   unsigned long nlink; /**< Number of hard links */
 346   dbus_uid_t    uid;   /**< User owning file */
 347   dbus_gid_t    gid;   /**< Group owning file */
 348   unsigned long size;  /**< Size of file */
 349   unsigned long atime; /**< Access time */
 350   unsigned long mtime; /**< Modify time */
 351   unsigned long ctime; /**< Creation time */
 352 } DBusStat;
 353
 354 dbus_bool_t _dbus_stat             (const DBusString *filename,
 355                                     DBusStat         *statbuf,
 356                                     DBusError        *error);
 357 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 358                                     int              *fd2,
 359                                     dbus_bool_t       blocking,
 360                                     DBusError        *error);
 361
 362 void        _dbus_print_backtrace  (void);
 363
 364 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 365                                    int               print_pid_fd,
 366                                    DBusError        *error);
 367 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 368                                    unsigned long     pid,
 369                                    DBusError        *error);
 370 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 371                                    unsigned long     gid,
 372                                    DBusError        *error);
 373
 374 /** A UNIX signal handler */
 375 typedef void (* DBusSignalHandler) (int sig);
 376
 377 void _dbus_set_signal_handler (int               sig,
 378                                DBusSignalHandler handler);
 379
 380 dbus_bool_t _dbus_user_at_console (const char *username,
 381                                    DBusError  *error);
 382
 383 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 384  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 385  */
 386 #if !defined (DBUS_VA_COPY)
 387 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 388 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 389 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 390 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 391 #  else /* va_list is a pointer */
 392 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 393 #  endif /* va_list is a pointer */
 394 #endif /* !DBUS_VA_COPY */
 395
 396
 397 /**
 398  * Casts a primitive C type to a byte array and then indexes
 399  * a particular byte of the array.
 400  */
 401 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 402     (((const char*)&(p))[(i)])
 403 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 404  * or b in an 80-bit register, thus failing to compare the two 64-bit
 405  * doubles for bitwise equality. So this macro compares the two doubles
 406  * bitwise.
 407  */
 408 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 409      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 410       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 411       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 412       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 413       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 414       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 415       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 416       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 417
 418 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
 419                              dbus_uid_t        *uid);
 420
 421 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
 422                                           DBusError *error);
 423
 424 /** Type representing a universally unique ID
 425  * @todo rename to UUID instead of GUID
 426  */
 427 typedef union DBusGUID DBusGUID;
 428
 429 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
 430                                              dbus_bool_t       create_if_not_found,
 431                                              DBusError        *error);
 432
 433 /**
 434  * Initialize threads as in dbus_threads_init_default(), appropriately
 435  * for the platform.
 436  * @returns #FALSE if no memory
 437  */
 438 dbus_bool_t _dbus_threads_init_platform_specific (void);
 439
 440 /** @} */
 441
 442 DBUS_END_DECLS
 443
 444 #endif /* DBUS_SYSDEPS_H */