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