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_open_unix_socket (int              *fd,
 104                                     DBusError        *error);
 105 dbus_bool_t _dbus_close_socket     (int               fd,
 106                                     DBusError        *error);
 107 int         _dbus_read_socket      (int               fd,
 108                                     DBusString       *buffer,
 109                                     int               count);
 110 int         _dbus_write_socket     (int               fd,
 111                                     const DBusString *buffer,
 112                                     int               start,
 113                                     int               len);
 114 int         _dbus_write_socket_two (int               fd,
 115                                     const DBusString *buffer1,
 116                                     int               start1,
 117                                     int               len1,
 118                                     const DBusString *buffer2,
 119                                     int               start2,
 120                                     int               len2);
 121
 122
 123
 124 int _dbus_connect_unix_socket (const char     *path,
 125                                dbus_bool_t     abstract,
 126                                DBusError      *error);
 127 int _dbus_listen_unix_socket  (const char     *path,
 128                                dbus_bool_t     abstract,
 129                                DBusError      *error);
 130 int _dbus_connect_tcp_socket  (const char     *host,
 131                                dbus_uint32_t   port,
 132                                DBusError      *error);
 133 int _dbus_listen_tcp_socket   (const char     *host,
 134                                dbus_uint32_t   port,
 135                                DBusError      *error);
 136 int _dbus_accept              (int             listen_fd);
 137
 138 /**
 139  * Struct representing socket credentials
 140  */
 141 typedef struct
 142 {
 143   dbus_pid_t pid; /**< process ID or DBUS_PID_UNSET */
 144   dbus_uid_t uid; /**< user ID or DBUS_UID_UNSET */
 145   dbus_gid_t gid; /**< group ID or DBUS_GID_UNSET */
 146 } DBusCredentials;
 147
 148 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
 149                                                 DBusCredentials *credentials,
 150                                                 DBusError       *error);
 151 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
 152                                                 DBusError       *error);
 153
 154
 155 void        _dbus_credentials_clear                (DBusCredentials       *credentials);
 156 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 157 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 158                                                     const DBusCredentials *provided_credentials);
 159
 160
 161 typedef struct DBusUserInfo  DBusUserInfo;
 162 typedef struct DBusGroupInfo DBusGroupInfo;
 163
 164 /**
 165  * Information about a UNIX user
 166  */
 167 struct DBusUserInfo
 168 {
 169   dbus_uid_t  uid;            /**< UID */
 170   dbus_gid_t  primary_gid;    /**< GID */
 171   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 172   int         n_group_ids;    /**< Size of group IDs array */
 173   char       *username;       /**< Username */
 174   char       *homedir;        /**< Home directory */
 175 };
 176
 177 /**
 178  * Information about a UNIX group
 179  */
 180 struct DBusGroupInfo
 181 {
 182   dbus_gid_t  gid;            /**< GID */
 183   char       *groupname;      /**< Group name */
 184 };
 185
 186 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 187                                       const DBusString *username,
 188                                       DBusError        *error);
 189 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 190                                       dbus_uid_t        uid,
 191                                       DBusError        *error);
 192 void        _dbus_user_info_free     (DBusUserInfo     *info);
 193
 194 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 195                                        const DBusString *groupname,
 196                                        DBusError        *error);
 197 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 198                                        dbus_gid_t        gid,
 199                                        DBusError        *error);
 200 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 201
 202
 203 unsigned long _dbus_getpid (void);
 204 dbus_uid_t    _dbus_getuid (void);
 205 dbus_gid_t    _dbus_getgid (void);
 206
 207 typedef struct DBusAtomic DBusAtomic;
 208
 209 /**
 210  * An atomic integer.
 211  */
 212 struct DBusAtomic
 213 {
 214   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 215 };
 216
 217 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 218 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 219
 220 #define _DBUS_POLLIN      0x0001    /* There is data to read */
 221 #define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
 222 #define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
 223 #define _DBUS_POLLERR     0x0008    /* Error condition */
 224 #define _DBUS_POLLHUP     0x0010    /* Hung up */
 225 #define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */
 226
 227 /**
 228  * A portable struct pollfd wrapper.
 229  */
 230 typedef struct
 231 {
 232   int fd;            /**< File descriptor */
 233   short events;      /**< Events to poll for */
 234   short revents;     /**< Events that occurred */
 235 } DBusPollFD;
 236
 237 int _dbus_poll (DBusPollFD *fds,
 238                 int         n_fds,
 239                 int         timeout_milliseconds);
 240
 241 void _dbus_sleep_milliseconds (int milliseconds);
 242
 243 void _dbus_get_current_time (long *tv_sec,
 244                              long *tv_usec);
 245
 246 /**
 247  * File/directory interface
 248  */
 249 dbus_bool_t _dbus_file_exists         (const char       *file);
 250 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 251                                        const DBusString *filename,
 252                                        DBusError        *error);
 253 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 254                                        const DBusString *filename,
 255                                        DBusError        *error);
 256
 257 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 258                                               DBusError        *error);
 259 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 260                                               DBusError        *error);
 261 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 262                                               DBusError        *error);
 263 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 264                                               DBusError        *error);
 265
 266 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 267                                        const DBusString *next_component);
 268 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 269                                        DBusString       *dirname);
 270 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 271
 272 typedef struct DBusDirIter DBusDirIter;
 273
 274 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 275                                             DBusError        *error);
 276 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 277                                             DBusString       *filename,
 278                                             DBusError        *error);
 279 void         _dbus_directory_close         (DBusDirIter      *iter);
 280
 281 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 282                                                     DBusError *error);
 283
 284 void _dbus_fd_set_close_on_exec (int fd);
 285
 286 const char* _dbus_get_tmpdir      (void);
 287
 288 /**
 289  * Random numbers
 290  */
 291 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 292                                                       int   n_bytes);
 293 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 294                                                 int         n_bytes);
 295 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 296                                                 int         n_bytes);
 297 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 298                                                 int         n_bytes);
 299
 300 const char *_dbus_errno_to_string  (int errnum);
 301 const char* _dbus_error_from_errno (int error_number);
 302
 303 void _dbus_disable_sigpipe (void);
 304
 305
 306 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 307
 308 int _dbus_printf_string_upper_bound (const char *format,
 309                                      va_list args);
 310
 311
 312 /**
 313  * Portable struct with stat() results
 314  */
 315 typedef struct
 316 {
 317   unsigned long mode;  /**< File mode */
 318   unsigned long nlink; /**< Number of hard links */
 319   dbus_uid_t    uid;   /**< User owning file */
 320   dbus_gid_t    gid;   /**< Group owning file */
 321   unsigned long size;  /**< Size of file */
 322   unsigned long atime; /**< Access time */
 323   unsigned long mtime; /**< Modify time */
 324   unsigned long ctime; /**< Creation time */
 325 } DBusStat;
 326
 327 dbus_bool_t _dbus_stat             (const DBusString *filename,
 328                                     DBusStat         *statbuf,
 329                                     DBusError        *error);
 330 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 331                                     int              *fd2,
 332                                     dbus_bool_t       blocking,
 333                                     DBusError        *error);
 334
 335 void        _dbus_print_backtrace  (void);
 336
 337 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 338                                    int               print_pid_fd,
 339                                    DBusError        *error);
 340 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 341                                    unsigned long     pid,
 342                                    DBusError        *error);
 343 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 344                                    unsigned long     gid,
 345                                    DBusError        *error);
 346
 347 typedef void (* DBusSignalHandler) (int sig);
 348
 349 void _dbus_set_signal_handler (int               sig,
 350                                DBusSignalHandler handler);
 351
 352 dbus_bool_t _dbus_user_at_console (const char *username,
 353                                    DBusError  *error);
 354
 355 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 356  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 357  */
 358 #if !defined (DBUS_VA_COPY)
 359 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 360 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 361 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 362 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 363 #  else /* va_list is a pointer */
 364 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 365 #  endif /* va_list is a pointer */
 366 #endif /* !DBUS_VA_COPY */
 367
 368 /* On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 369  * or b in an 80-bit register, thus failing to compare the two 64-bit
 370  * doubles for bitwise equality.
 371  */
 372 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 373     (((const char*)&(p))[(i)])
 374 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 375      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 376       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 377       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 378       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 379       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 380       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 381       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 382       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 383
 384 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
 385                              dbus_uid_t        *uid);
 386
 387 DBUS_END_DECLS
 388
 389 #endif /* DBUS_SYSDEPS_H */