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 /**
  45  * @addtogroup DBusSysdeps
  46  *
  47  * @{
  48  */
  49
  50 /* The idea of this file is to encapsulate everywhere that we're
  51  * relying on external libc features, for ease of security
  52  * auditing. The idea is from vsftpd. This also gives us a chance to
  53  * make things more convenient to use, e.g.  by reading into a
  54  * DBusString. Operating system headers aren't intended to be used
  55  * outside of this file and a limited number of others (such as
  56  * dbus-memory.c)
  57  */
  58
  59 typedef struct DBusString DBusString;
  60
  61 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  62 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  63   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  64 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )     \
  65   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  66 #define _DBUS_GNUC_FORMAT( arg_idx )                \
  67   __attribute__((__format_arg__ (arg_idx)))
  68 #define _DBUS_GNUC_NORETURN                         \
  69   __attribute__((__noreturn__))
  70 #else   /* !__GNUC__ */
  71 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  72 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
  73 #define _DBUS_GNUC_FORMAT( arg_idx )
  74 #define _DBUS_GNUC_NORETURN
  75 #endif  /* !__GNUC__ */
  76
  77 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  78
  79 const char* _dbus_getenv (const char *varname);
  80 dbus_bool_t _dbus_setenv (const char *varname,
  81                           const char *value);
  82
  83
  84 typedef unsigned long dbus_pid_t;
  85 typedef unsigned long dbus_uid_t;
  86 typedef unsigned long dbus_gid_t;
  87
  88 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
  89 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
  90 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
  91
  92 #define DBUS_PID_FORMAT "%lu"
  93 #define DBUS_UID_FORMAT "%lu"
  94 #define DBUS_GID_FORMAT "%lu"
  95
  96
  97 /**
  98  * Socket interface
  99  *
 100  *  @todo Use for the file descriptors a struct
 101  *           - struct DBusSocket{ int d; }; -
 102  *        instead of int to get type-safety which
 103  *        will be checked by the compiler.
 104  *
 105  */
 106
 107 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
 108                                     DBusError        *error);
 109 dbus_bool_t _dbus_close_socket     (int               fd,
 110                                     DBusError        *error);
 111 int         _dbus_read_socket      (int               fd,
 112                                     DBusString       *buffer,
 113                                     int               count);
 114 int         _dbus_write_socket     (int               fd,
 115                                     const DBusString *buffer,
 116                                     int               start,
 117                                     int               len);
 118 int         _dbus_write_socket_two (int               fd,
 119                                     const DBusString *buffer1,
 120                                     int               start1,
 121                                     int               len1,
 122                                     const DBusString *buffer2,
 123                                     int               start2,
 124                                     int               len2);
 125 int _dbus_connect_tcp_socket  (const char     *host,
 126                                dbus_uint32_t   port,
 127                                DBusError      *error);
 128 int _dbus_listen_tcp_socket   (const char     *host,
 129                                dbus_uint32_t   port,
 130                                DBusError      *error);
 131 int _dbus_accept              (int             listen_fd);
 132
 133 /**
 134  * Struct representing socket credentials
 135  */
 136 typedef struct
 137 {
 138   dbus_pid_t pid; /**< process ID or DBUS_PID_UNSET */
 139   dbus_uid_t uid; /**< user ID or DBUS_UID_UNSET */
 140   dbus_gid_t gid; /**< group ID or DBUS_GID_UNSET */
 141 } DBusCredentials;
 142
 143 /* FIXME these read/send credentials should get moved to sysdeps-unix.h,
 144  * or renamed to reflect what they mean cross-platform
 145  */
 146 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
 147                                                 DBusCredentials *credentials,
 148                                                 DBusError       *error);
 149 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
 150                                                 DBusError       *error);
 151
 152
 153 void        _dbus_credentials_clear                (DBusCredentials       *credentials);
 154 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 155 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 156                                                     const DBusCredentials *provided_credentials);
 157
 158
 159 typedef struct DBusUserInfo  DBusUserInfo;
 160 typedef struct DBusGroupInfo DBusGroupInfo;
 161
 162 /**
 163  * Information about a UNIX user
 164  */
 165 struct DBusUserInfo
 166 {
 167   dbus_uid_t  uid;            /**< UID */
 168   dbus_gid_t  primary_gid;    /**< GID */
 169   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 170   int         n_group_ids;    /**< Size of group IDs array */
 171   char       *username;       /**< Username */
 172   char       *homedir;        /**< Home directory */
 173 };
 174
 175 /**
 176  * Information about a UNIX group
 177  */
 178 struct DBusGroupInfo
 179 {
 180   dbus_gid_t  gid;            /**< GID */
 181   char       *groupname;      /**< Group name */
 182 };
 183
 184 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 185                                       const DBusString *username,
 186                                       DBusError        *error);
 187 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 188                                       dbus_uid_t        uid,
 189                                       DBusError        *error);
 190 void        _dbus_user_info_free     (DBusUserInfo     *info);
 191
 192 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 193                                        const DBusString *groupname,
 194                                        DBusError        *error);
 195 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 196                                        dbus_gid_t        gid,
 197                                        DBusError        *error);
 198 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 199
 200
 201 unsigned long _dbus_getpid (void);
 202 dbus_uid_t    _dbus_getuid (void);
 203 dbus_gid_t    _dbus_getgid (void);
 204
 205 typedef struct DBusAtomic DBusAtomic;
 206
 207 /**
 208  * An atomic integer.
 209  */
 210 struct DBusAtomic
 211 {
 212   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 213 };
 214
 215 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 216 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 217
 218 #define _DBUS_POLLIN      0x0001    /* There is data to read */
 219 #define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
 220 #define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
 221 #define _DBUS_POLLERR     0x0008    /* Error condition */
 222 #define _DBUS_POLLHUP     0x0010    /* Hung up */
 223 #define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */
 224
 225 /**
 226  * A portable struct pollfd wrapper.
 227  */
 228 typedef struct
 229 {
 230   int fd;            /**< File descriptor */
 231   short events;      /**< Events to poll for */
 232   short revents;     /**< Events that occurred */
 233 } DBusPollFD;
 234
 235 int _dbus_poll (DBusPollFD *fds,
 236                 int         n_fds,
 237                 int         timeout_milliseconds);
 238
 239 void _dbus_sleep_milliseconds (int milliseconds);
 240
 241 void _dbus_get_current_time (long *tv_sec,
 242                              long *tv_usec);
 243
 244 /**
 245  * File/directory interface
 246  */
 247 dbus_bool_t _dbus_file_exists         (const char       *file);
 248 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 249                                        const DBusString *filename,
 250                                        DBusError        *error);
 251 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 252                                        const DBusString *filename,
 253                                        DBusError        *error);
 254
 255 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 256                                               DBusError        *error);
 257 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 258                                               DBusError        *error);
 259 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 260                                               DBusError        *error);
 261 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 262                                               DBusError        *error);
 263
 264 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 265                                        const DBusString *next_component);
 266 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 267                                        DBusString       *dirname);
 268 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 269
 270 typedef struct DBusDirIter DBusDirIter;
 271
 272 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 273                                             DBusError        *error);
 274 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 275                                             DBusString       *filename,
 276                                             DBusError        *error);
 277 void         _dbus_directory_close         (DBusDirIter      *iter);
 278
 279 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 280                                                     DBusError *error);
 281
 282 void _dbus_fd_set_close_on_exec (int fd);
 283
 284 const char* _dbus_get_tmpdir      (void);
 285
 286 /**
 287  * Random numbers
 288  */
 289 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 290                                                       int   n_bytes);
 291 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 292                                                 int         n_bytes);
 293 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 294                                                 int         n_bytes);
 295 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 296                                                 int         n_bytes);
 297
 298 const char *_dbus_errno_to_string  (int errnum);
 299 const char* _dbus_error_from_errno (int error_number);
 300
 301 void _dbus_disable_sigpipe (void);
 302
 303
 304 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 305
 306 int _dbus_printf_string_upper_bound (const char *format,
 307                                      va_list args);
 308
 309
 310 /**
 311  * Portable struct with stat() results
 312  */
 313 typedef struct
 314 {
 315   unsigned long mode;  /**< File mode */
 316   unsigned long nlink; /**< Number of hard links */
 317   dbus_uid_t    uid;   /**< User owning file */
 318   dbus_gid_t    gid;   /**< Group owning file */
 319   unsigned long size;  /**< Size of file */
 320   unsigned long atime; /**< Access time */
 321   unsigned long mtime; /**< Modify time */
 322   unsigned long ctime; /**< Creation time */
 323 } DBusStat;
 324
 325 dbus_bool_t _dbus_stat             (const DBusString *filename,
 326                                     DBusStat         *statbuf,
 327                                     DBusError        *error);
 328 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 329                                     int              *fd2,
 330                                     dbus_bool_t       blocking,
 331                                     DBusError        *error);
 332
 333 void        _dbus_print_backtrace  (void);
 334
 335 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 336                                    int               print_pid_fd,
 337                                    DBusError        *error);
 338 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 339                                    unsigned long     pid,
 340                                    DBusError        *error);
 341 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 342                                    unsigned long     gid,
 343                                    DBusError        *error);
 344
 345 typedef void (* DBusSignalHandler) (int sig);
 346
 347 void _dbus_set_signal_handler (int               sig,
 348                                DBusSignalHandler handler);
 349
 350 dbus_bool_t _dbus_user_at_console (const char *username,
 351                                    DBusError  *error);
 352
 353 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 354  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 355  */
 356 #if !defined (DBUS_VA_COPY)
 357 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 358 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 359 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 360 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 361 #  else /* va_list is a pointer */
 362 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 363 #  endif /* va_list is a pointer */
 364 #endif /* !DBUS_VA_COPY */
 365
 366 /* On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 367  * or b in an 80-bit register, thus failing to compare the two 64-bit
 368  * doubles for bitwise equality.
 369  */
 370 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 371     (((const char*)&(p))[(i)])
 372 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 373      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 374       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 375       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 376       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 377       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 378       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 379       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 380       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 381
 382 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
 383                              dbus_uid_t        *uid);
 384
 385 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
 386                                           DBusError *error);
 387
 388 typedef union DBusGUID DBusGUID;
 389
 390 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
 391                                              dbus_bool_t       create_if_not_found,
 392                                              DBusError        *error);
 393
 394
 395 /** @} */
 396
 397 DBUS_END_DECLS
 398
 399 #endif /* DBUS_SYSDEPS_H */