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