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_user            (DBusCredentials  *credentials,
 166                                                         const DBusString *username);
 167 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
 168 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
 169
 170 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
 171                                                  dbus_uid_t        *uid_p);
 172 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
 173                                                  dbus_gid_t        *gid_p);
 174 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
 175                                                  dbus_gid_t       **group_ids,
 176                                                  int               *n_group_ids);
 177 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
 178                                                  DBusError         *error);
 179 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
 180 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
 181
 182 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
 183                                                             DBusCredentials *credentials);
 184
 185 /** Opaque type representing an atomically-modifiable integer
 186  * that can be used from multiple threads.
 187  */
 188 typedef struct DBusAtomic DBusAtomic;
 189
 190 /**
 191  * An atomic integer safe to increment or decrement from multiple threads.
 192  */
 193 struct DBusAtomic
 194 {
 195 #ifdef DBUS_WIN
 196   volatile long value; /**< Value of the atomic integer. */
 197 #else
 198   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 199 #endif
 200 };
 201
 202 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 203 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 204
 205 /** There is data to read */
 206 #define _DBUS_POLLIN      0x0001
 207 /** There is urgent data to read */
 208 #define _DBUS_POLLPRI     0x0002
 209 /** Writing now will not block */
 210 #define _DBUS_POLLOUT     0x0004
 211 /** Error condition */
 212 #define _DBUS_POLLERR     0x0008
 213 /** Hung up */
 214 #define _DBUS_POLLHUP     0x0010
 215 /** Invalid request: fd not open */
 216 #define _DBUS_POLLNVAL    0x0020
 217
 218 /**
 219  * A portable struct pollfd wrapper.
 220  */
 221 typedef struct
 222 {
 223   int fd;            /**< File descriptor */
 224   short events;      /**< Events to poll for */
 225   short revents;     /**< Events that occurred */
 226 } DBusPollFD;
 227
 228 int _dbus_poll (DBusPollFD *fds,
 229                 int         n_fds,
 230                 int         timeout_milliseconds);
 231
 232 void _dbus_sleep_milliseconds (int milliseconds);
 233
 234 void _dbus_get_current_time (long *tv_sec,
 235                              long *tv_usec);
 236
 237 /**
 238  * File/directory interface
 239  */
 240 dbus_bool_t _dbus_file_exists         (const char       *file);
 241 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 242                                        const DBusString *filename,
 243                                        DBusError        *error);
 244 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 245                                        const DBusString *filename,
 246                                        DBusError        *error);
 247
 248 dbus_bool_t _dbus_make_file_world_readable   (const DBusString *filename,
 249                                               DBusError *error);
 250
 251 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 252                                               DBusError        *error);
 253 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 254                                               DBusError        *error);
 255 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 256                                               DBusError        *error);
 257 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 258                                               DBusError        *error);
 259
 260 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 261                                        const DBusString *next_component);
 262 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 263                                        DBusString       *dirname);
 264 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 265
 266 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
 267
 268 typedef struct {
 269   int fd_or_handle;
 270 } DBusPipe;
 271
 272 void        _dbus_pipe_init                (DBusPipe         *pipe,
 273                                             int               fd);
 274 void        _dbus_pipe_init_stdout         (DBusPipe         *pipe);
 275 int         _dbus_pipe_write               (DBusPipe         *pipe,
 276                                             const DBusString *buffer,
 277                                             int               start,
 278                                             int               len,
 279                                             DBusError        *error);
 280 int         _dbus_pipe_close               (DBusPipe         *pipe,
 281                                             DBusError        *error);
 282 dbus_bool_t _dbus_pipe_is_valid            (DBusPipe         *pipe);
 283 void        _dbus_pipe_invalidate          (DBusPipe         *pipe);
 284 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe         *pipe);
 285
 286
 287 /** Opaque type for reading a directory listing */
 288 typedef struct DBusDirIter DBusDirIter;
 289
 290 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 291                                             DBusError        *error);
 292 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 293                                             DBusString       *filename,
 294                                             DBusError        *error);
 295 void         _dbus_directory_close         (DBusDirIter      *iter);
 296
 297 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 298                                                     DBusError *error);
 299
 300 void _dbus_fd_set_close_on_exec (int fd);
 301
 302 const char* _dbus_get_tmpdir      (void);
 303
 304 /**
 305  * Random numbers
 306  */
 307 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 308                                                       int   n_bytes);
 309 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 310                                                 int         n_bytes);
 311 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 312                                                 int         n_bytes);
 313 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 314                                                 int         n_bytes);
 315
 316 const char* _dbus_error_from_errno (int error_number);
 317
 318 void _dbus_disable_sigpipe (void);
 319
 320
 321 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 322
 323 int _dbus_printf_string_upper_bound (const char *format,
 324                                      va_list args);
 325
 326
 327 /**
 328  * Portable struct with stat() results
 329  */
 330 typedef struct
 331 {
 332   unsigned long mode;  /**< File mode */
 333   unsigned long nlink; /**< Number of hard links */
 334   dbus_uid_t    uid;   /**< User owning file */
 335   dbus_gid_t    gid;   /**< Group owning file */
 336   unsigned long size;  /**< Size of file */
 337   unsigned long atime; /**< Access time */
 338   unsigned long mtime; /**< Modify time */
 339   unsigned long ctime; /**< Creation time */
 340 } DBusStat;
 341
 342 dbus_bool_t _dbus_stat             (const DBusString *filename,
 343                                     DBusStat         *statbuf,
 344                                     DBusError        *error);
 345 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 346                                     int              *fd2,
 347                                     dbus_bool_t       blocking,
 348                                     DBusError        *error);
 349
 350 void        _dbus_print_backtrace  (void);
 351
 352 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 353                                    DBusPipe         *print_pid_pipe,
 354                                    DBusError        *error);
 355 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 356                                    unsigned long     pid,
 357                                    DBusError        *error);
 358 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
 359 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
 360                                          DBusError  *error);
 361
 362 /** A UNIX signal handler */
 363 typedef void (* DBusSignalHandler) (int sig);
 364
 365 void _dbus_set_signal_handler (int               sig,
 366                                DBusSignalHandler handler);
 367
 368 dbus_bool_t _dbus_user_at_console (const char *username,
 369                                    DBusError  *error);
 370
 371 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 372  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 373  */
 374 #if !defined (DBUS_VA_COPY)
 375 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 376 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 377 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 378 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 379 #  else /* va_list is a pointer */
 380 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 381 #  endif /* va_list is a pointer */
 382 #endif /* !DBUS_VA_COPY */
 383
 384
 385 /**
 386  * Casts a primitive C type to a byte array and then indexes
 387  * a particular byte of the array.
 388  */
 389 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 390     (((const char*)&(p))[(i)])
 391 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 392  * or b in an 80-bit register, thus failing to compare the two 64-bit
 393  * doubles for bitwise equality. So this macro compares the two doubles
 394  * bitwise.
 395  */
 396 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 397      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 398       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 399       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 400       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 401       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 402       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 403       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 404       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 405
 406 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
 407                                           DBusError *error);
 408
 409 /** Type representing a universally unique ID
 410  * @todo rename to UUID instead of GUID
 411  */
 412 typedef union DBusGUID DBusGUID;
 413
 414 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
 415                                              dbus_bool_t       create_if_not_found,
 416                                              DBusError        *error);
 417
 418 /**
 419  * Initialize threads as in dbus_threads_init_default(), appropriately
 420  * for the platform.
 421  * @returns #FALSE if no memory
 422  */
 423 dbus_bool_t _dbus_threads_init_platform_specific (void);
 424
 425 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
 426                                           const char *suffix,
 427                                           DBusList **dir_list);
 428
 429 unsigned long _dbus_pid_for_log (void);
 430
 431 /* FIXME move back to dbus-sysdeps-unix.h probably -
 432  * the PID file handling just needs a little more abstraction
 433  * in the bus daemon first.
 434  */
 435 dbus_pid_t    _dbus_getpid (void);
 436
 437 void _dbus_flush_caches (void);
 438
 439 /** @} */
 440
 441 DBUS_END_DECLS
 442
 443 #endif /* DBUS_SYSDEPS_H */