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