dbus/dbus-sysdeps.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  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 #include <stdarg.h>
  37
  38
  39 /* AIX sys/poll.h does #define events reqevents, and other
  40  * wonderousness, so must include sys/poll before declaring
  41  * DBusPollFD
  42  */
  43 #ifdef HAVE_POLL
  44 #include <sys/poll.h>
  45 #endif
  46
  47 DBUS_BEGIN_DECLS
  48
  49 #ifdef DBUS_WIN
  50 #define _DBUS_PATH_SEPARATOR ";"
  51 #else
  52 #define _DBUS_PATH_SEPARATOR ":"
  53 #endif
  54
  55 /* Forward declarations */
  56
  57 /** An opaque string type */
  58 typedef struct DBusString DBusString;
  59
  60 /** An opaque list type */
  61 typedef struct DBusList DBusList;
  62
  63 /** Object that contains a list of credentials such as UNIX or Windows user ID */
  64 typedef struct DBusCredentials DBusCredentials;
  65
  66 /**
  67  * @addtogroup DBusSysdeps
  68  *
  69  * @{
  70  */
  71
  72 /* The idea of this file is to encapsulate everywhere that we're
  73  * relying on external libc features, for ease of security
  74  * auditing. The idea is from vsftpd. This also gives us a chance to
  75  * make things more convenient to use, e.g.  by reading into a
  76  * DBusString. Operating system headers aren't intended to be used
  77  * outside of this file and a limited number of others (such as
  78  * dbus-memory.c)
  79  */
  80
  81 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  82 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  83   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  84 #define _DBUS_GNUC_NORETURN                         \
  85   __attribute__((__noreturn__))
  86 #else   /* !__GNUC__ */
  87 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  88 #define _DBUS_GNUC_NORETURN
  89 #endif  /* !__GNUC__ */
  90
  91 /** @def _DBUS_GNUC_PRINTF
  92  * used to tell gcc about printf format strings
  93  */
  94 /** @def _DBUS_GNUC_NORETURN
  95  * used to tell gcc about functions that never return, such as _dbus_abort()
  96  */
  97
  98 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  99
 100 const char* _dbus_getenv (const char *varname);
 101 dbus_bool_t _dbus_setenv (const char *varname,
 102                           const char *value);
 103 dbus_bool_t _dbus_clearenv (void);
 104 char **     _dbus_get_environment (void);
 105
 106 /** A process ID */
 107 typedef unsigned long dbus_pid_t;
 108 /** A user ID */
 109 typedef unsigned long dbus_uid_t;
 110 /** A group ID */
 111 typedef unsigned long dbus_gid_t;
 112
 113 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
 114 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
 115 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
 116 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
 117 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
 118 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
 119
 120 /** an appropriate printf format for dbus_pid_t */
 121 #define DBUS_PID_FORMAT "%lu"
 122 /** an appropriate printf format for dbus_uid_t */
 123 #define DBUS_UID_FORMAT "%lu"
 124 /** an appropriate printf format for dbus_gid_t */
 125 #define DBUS_GID_FORMAT "%lu"
 126
 127
 128 /**
 129  * Socket interface
 130  *
 131  *  @todo Use for the file descriptors a struct
 132  *           - struct DBusSocket{ int d; }; -
 133  *        instead of int to get type-safety which
 134  *        will be checked by the compiler.
 135  *
 136  */
 137
 138 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
 139                                     DBusError        *error);
 140 dbus_bool_t _dbus_close_socket     (int               fd,
 141                                     DBusError        *error);
 142 int         _dbus_read_socket      (int               fd,
 143                                     DBusString       *buffer,
 144                                     int               count);
 145 int         _dbus_write_socket     (int               fd,
 146                                     const DBusString *buffer,
 147                                     int               start,
 148                                     int               len);
 149 int         _dbus_write_socket_two (int               fd,
 150                                     const DBusString *buffer1,
 151                                     int               start1,
 152                                     int               len1,
 153                                     const DBusString *buffer2,
 154                                     int               start2,
 155                                     int               len2);
 156
 157 int _dbus_read_socket_with_unix_fds      (int               fd,
 158                                           DBusString       *buffer,
 159                                           int               count,
 160                                           int              *fds,
 161                                           int              *n_fds);
 162 int _dbus_write_socket_with_unix_fds     (int               fd,
 163                                           const DBusString *buffer,
 164                                           int               start,
 165                                           int               len,
 166                                           const int        *fds,
 167                                           int               n_fds);
 168 int _dbus_write_socket_with_unix_fds_two (int               fd,
 169                                           const DBusString *buffer1,
 170                                           int               start1,
 171                                           int               len1,
 172                                           const DBusString *buffer2,
 173                                           int               start2,
 174                                           int               len2,
 175                                           const int        *fds,
 176                                           int               n_fds);
 177
 178 dbus_bool_t _dbus_socket_is_invalid (int              fd);
 179
 180 int _dbus_connect_tcp_socket  (const char     *host,
 181                                const char     *port,
 182                                const char     *family,
 183                                DBusError      *error);
 184 int _dbus_listen_tcp_socket   (const char     *host,
 185                                const char     *port,
 186                                const char     *family,
 187                                DBusString     *retport,
 188                                int           **fds_p,
 189                                DBusError      *error);
 190 int _dbus_accept              (int             listen_fd);
 191
 192
 193 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
 194                                            DBusCredentials  *credentials,
 195                                            DBusError        *error);
 196 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
 197                                            DBusError       *error);
 198
 199 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
 200                                                         const DBusString *username);
 201 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
 202 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
 203
 204 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
 205                                                  dbus_uid_t        *uid_p);
 206 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
 207                                                  dbus_gid_t        *gid_p);
 208 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
 209                                                  dbus_gid_t       **group_ids,
 210                                                  int               *n_group_ids);
 211 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
 212                                                  DBusError         *error);
 213 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
 214 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
 215
 216 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
 217                                                             DBusCredentials *credentials);
 218
 219 dbus_bool_t _dbus_socket_can_pass_unix_fd(int fd);
 220
 221 /** Opaque type representing an atomically-modifiable integer
 222  * that can be used from multiple threads.
 223  */
 224 typedef struct DBusAtomic DBusAtomic;
 225
 226 /**
 227  * An atomic integer safe to increment or decrement from multiple threads.
 228  */
 229 struct DBusAtomic
 230 {
 231 #ifdef DBUS_WIN
 232   volatile long value; /**< Value of the atomic integer. */
 233 #else
 234   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 235 #endif
 236 };
 237
 238 /* The value we get from autofoo is in the form of a cpp expression;
 239  * convert that to a conventional defined/undef switch. (We can't get
 240  * the conventional defined/undef because of multiarch builds only running
 241  * ./configure once, on Darwin.) */
 242 #if DBUS_HAVE_ATOMIC_INT_COND
 243 #   define DBUS_HAVE_ATOMIC_INT 1
 244 #else
 245 #   undef DBUS_HAVE_ATOMIC_INT
 246 #endif
 247
 248 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 249 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 250
 251
 252 /* AIX uses different values for poll */
 253
 254 #ifdef _AIX
 255 /** There is data to read */
 256 #define _DBUS_POLLIN      0x0001
 257 /** There is urgent data to read */
 258 #define _DBUS_POLLPRI     0x0004
 259 /** Writing now will not block */
 260 #define _DBUS_POLLOUT     0x0002
 261 /** Error condition */
 262 #define _DBUS_POLLERR     0x4000
 263 /** Hung up */
 264 #define _DBUS_POLLHUP     0x2000
 265 /** Invalid request: fd not open */
 266 #define _DBUS_POLLNVAL    0x8000
 267 #elif defined(__HAIKU__)
 268 /** There is data to read */
 269 #define _DBUS_POLLIN      0x0001
 270 /** Writing now will not block */
 271 #define _DBUS_POLLOUT     0x0002
 272 /** Error condition */
 273 #define _DBUS_POLLERR     0x0004
 274 /** There is urgent data to read */
 275 #define _DBUS_POLLPRI     0x0020
 276 /** Hung up */
 277 #define _DBUS_POLLHUP     0x0080
 278 /** Invalid request: fd not open */
 279 #define _DBUS_POLLNVAL    0x1000
 280 #else
 281 /** There is data to read */
 282 #define _DBUS_POLLIN      0x0001
 283 /** There is urgent data to read */
 284 #define _DBUS_POLLPRI     0x0002
 285 /** Writing now will not block */
 286 #define _DBUS_POLLOUT     0x0004
 287 /** Error condition */
 288 #define _DBUS_POLLERR     0x0008
 289 /** Hung up */
 290 #define _DBUS_POLLHUP     0x0010
 291 /** Invalid request: fd not open */
 292 #define _DBUS_POLLNVAL    0x0020
 293 #endif
 294
 295 /**
 296  * A portable struct pollfd wrapper.
 297  */
 298 typedef struct
 299 {
 300   int fd;            /**< File descriptor */
 301   short events;      /**< Events to poll for */
 302   short revents;     /**< Events that occurred */
 303 } DBusPollFD;
 304
 305 int _dbus_poll (DBusPollFD *fds,
 306                 int         n_fds,
 307                 int         timeout_milliseconds);
 308
 309 void _dbus_sleep_milliseconds (int milliseconds);
 310
 311 void _dbus_get_current_time (long *tv_sec,
 312                              long *tv_usec);
 313
 314 /**
 315  * File/directory interface
 316  */
 317 dbus_bool_t _dbus_file_exists         (const char       *file);
 318 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 319                                        const DBusString *filename,
 320                                        DBusError        *error);
 321 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 322                                        const DBusString *filename,
 323                                        DBusError        *error);
 324
 325 dbus_bool_t _dbus_make_file_world_readable   (const DBusString *filename,
 326                                               DBusError *error);
 327
 328 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 329                                               DBusError        *error);
 330 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 331                                               DBusError        *error);
 332 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 333                                               DBusError        *error);
 334 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 335                                               DBusError        *error);
 336
 337 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 338                                        const DBusString *next_component);
 339 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 340                                        DBusString       *dirname);
 341 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 342
 343 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
 344 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
 345
 346 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
 347 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
 348
 349 typedef struct {
 350   int fd_or_handle;
 351 } DBusPipe;
 352
 353 void        _dbus_pipe_init                (DBusPipe         *pipe,
 354                                             int               fd);
 355 void        _dbus_pipe_init_stdout         (DBusPipe         *pipe);
 356 int         _dbus_pipe_write               (DBusPipe         *pipe,
 357                                             const DBusString *buffer,
 358                                             int               start,
 359                                             int               len,
 360                                             DBusError        *error);
 361 int         _dbus_pipe_close               (DBusPipe         *pipe,
 362                                             DBusError        *error);
 363 dbus_bool_t _dbus_pipe_is_valid            (DBusPipe         *pipe);
 364 void        _dbus_pipe_invalidate          (DBusPipe         *pipe);
 365 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe         *pipe);
 366
 367
 368 /** Opaque type for reading a directory listing */
 369 typedef struct DBusDirIter DBusDirIter;
 370
 371 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 372                                             DBusError        *error);
 373 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 374                                             DBusString       *filename,
 375                                             DBusError        *error);
 376 void         _dbus_directory_close         (DBusDirIter      *iter);
 377
 378 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 379                                                     DBusError *error);
 380
 381 void _dbus_fd_set_close_on_exec (int fd);
 382
 383 const char* _dbus_get_tmpdir      (void);
 384
 385 /**
 386  * Random numbers
 387  */
 388 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 389                                                       int   n_bytes);
 390 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 391                                                 int         n_bytes);
 392 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 393                                                 int         n_bytes);
 394 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 395                                                 int         n_bytes);
 396
 397 const char* _dbus_error_from_errno (int error_number);
 398
 399 void        _dbus_set_errno_to_zero                  (void);
 400 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
 401 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
 402 dbus_bool_t _dbus_get_is_errno_enomem                (void);
 403 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
 404 dbus_bool_t _dbus_get_is_errno_epipe                 (void);
 405 const char* _dbus_strerror_from_errno                (void);
 406
 407 void _dbus_disable_sigpipe (void);
 408
 409
 410 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 411
 412 int _dbus_printf_string_upper_bound (const char *format,
 413                                      va_list args);
 414
 415
 416 /**
 417  * Portable struct with stat() results
 418  */
 419 typedef struct
 420 {
 421   unsigned long mode;  /**< File mode */
 422   unsigned long nlink; /**< Number of hard links */
 423   dbus_uid_t    uid;   /**< User owning file */
 424   dbus_gid_t    gid;   /**< Group owning file */
 425   unsigned long size;  /**< Size of file */
 426   unsigned long atime; /**< Access time */
 427   unsigned long mtime; /**< Modify time */
 428   unsigned long ctime; /**< Creation time */
 429 } DBusStat;
 430
 431 dbus_bool_t _dbus_stat             (const DBusString *filename,
 432                                     DBusStat         *statbuf,
 433                                     DBusError        *error);
 434 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 435                                     int              *fd2,
 436                                     dbus_bool_t       blocking,
 437                                     DBusError        *error);
 438
 439 void        _dbus_print_backtrace  (void);
 440
 441 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 442                                    DBusPipe         *print_pid_pipe,
 443                                    DBusError        *error,
 444                                    dbus_bool_t       keep_umask);
 445
 446 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
 447 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
 448                                          DBusError  *error);
 449
 450 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
 451                                               DBusPipe         *print_pid_pipe,
 452                                               dbus_pid_t        pid_to_write,
 453                                               DBusError        *error);
 454
 455 dbus_bool_t _dbus_command_for_pid (unsigned long  pid,
 456                                    DBusString    *str,
 457                                    int            max_len,
 458                                    DBusError     *error);
 459
 460 /** A UNIX signal handler */
 461 typedef void (* DBusSignalHandler) (int sig);
 462
 463 void _dbus_set_signal_handler (int               sig,
 464                                DBusSignalHandler handler);
 465
 466 dbus_bool_t _dbus_user_at_console (const char *username,
 467                                    DBusError  *error);
 468
 469 void _dbus_init_system_log (void);
 470 void _dbus_log_info (const char *msg, va_list args);
 471 void _dbus_log_security (const char *msg, va_list args);
 472
 473 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 474  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 475  */
 476 #if !defined (DBUS_VA_COPY)
 477 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 478 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 479 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 480 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 481 #  else /* va_list is a pointer */
 482 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 483 #  endif /* va_list is a pointer */
 484 #endif /* !DBUS_VA_COPY */
 485
 486
 487 /**
 488  * Casts a primitive C type to a byte array and then indexes
 489  * a particular byte of the array.
 490  */
 491 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 492     (((const char*)&(p))[(i)])
 493 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 494  * or b in an 80-bit register, thus failing to compare the two 64-bit
 495  * doubles for bitwise equality. So this macro compares the two doubles
 496  * bitwise.
 497  */
 498 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 499      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 500       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 501       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 502       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 503       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 504       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 505       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 506       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 507
 508 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
 509                                           DBusError *error);
 510
 511 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
 512                                           DBusString  *address,
 513                                           DBusError   *error);
 514
 515 /** Type representing a universally unique ID
 516  * @todo rename to UUID instead of GUID
 517  */
 518 typedef union DBusGUID DBusGUID;
 519
 520 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
 521                                              dbus_bool_t       create_if_not_found,
 522                                              DBusError        *error);
 523
 524 /**
 525  * Initialize threads as in dbus_threads_init_default(), appropriately
 526  * for the platform.
 527  * @returns #FALSE if no memory
 528  */
 529 dbus_bool_t _dbus_threads_init_platform_specific (void);
 530
 531 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
 532                                           const char *suffix,
 533                                           DBusList **dir_list);
 534
 535 unsigned long _dbus_pid_for_log (void);
 536
 537 /* FIXME move back to dbus-sysdeps-unix.h probably -
 538  * the PID file handling just needs a little more abstraction
 539  * in the bus daemon first.
 540  */
 541 dbus_pid_t    _dbus_getpid (void);
 542
 543 void _dbus_flush_caches (void);
 544
 545 /** @} */
 546
 547 DBUS_END_DECLS
 548
 549 #endif /* DBUS_SYSDEPS_H */