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