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.0
   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 <dbus/dbus-errors.h>
  29
  30 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
  31  * stuff straight out of string.h, so have this here for now.
  32  */
  33 #include <string.h>
  34
  35 /* and it would just be annoying to abstract this */
  36 #include <errno.h>
  37
  38 DBUS_BEGIN_DECLS;
  39
  40 /* The idea of this file is to encapsulate everywhere that we're
  41  * relying on external libc features, for ease of security
  42  * auditing. The idea is from vsftpd. This also gives us a chance to
  43  * make things more convenient to use, e.g.  by reading into a
  44  * DBusString. Operating system headers aren't intended to be used
  45  * outside of this file and a limited number of others (such as
  46  * dbus-memory.c)
  47  */
  48
  49 typedef struct DBusString DBusString;
  50
  51 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  52 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  53   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  54 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )     \
  55   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  56 #define _DBUS_GNUC_FORMAT( arg_idx )                \
  57   __attribute__((__format_arg__ (arg_idx)))
  58 #define _DBUS_GNUC_NORETURN                         \
  59   __attribute__((__noreturn__))
  60 #else   /* !__GNUC__ */
  61 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  62 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
  63 #define _DBUS_GNUC_FORMAT( arg_idx )
  64 #define _DBUS_GNUC_NORETURN
  65 #endif  /* !__GNUC__ */
  66
  67 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  68
  69 const char* _dbus_getenv (const char *varname);
  70 dbus_bool_t _dbus_setenv (const char *varname,
  71                           const char *value);
  72
  73 int _dbus_read      (int               fd,
  74                      DBusString       *buffer,
  75                      int               count);
  76 int _dbus_write     (int               fd,
  77                      const DBusString *buffer,
  78                      int               start,
  79                      int               len);
  80 int _dbus_write_two (int               fd,
  81                      const DBusString *buffer1,
  82                      int               start1,
  83                      int               len1,
  84                      const DBusString *buffer2,
  85                      int               start2,
  86                      int               len2);
  87
  88 typedef unsigned long dbus_pid_t;
  89 typedef unsigned long dbus_uid_t;
  90 typedef unsigned long dbus_gid_t;
  91
  92 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
  93 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
  94 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
  95
  96 #define DBUS_PID_FORMAT "%lu"
  97 #define DBUS_UID_FORMAT "%lu"
  98 #define DBUS_GID_FORMAT "%lu"
  99
 100 /**
 101  * Struct representing socket credentials
 102  */
 103 typedef struct
 104 {
 105   dbus_pid_t pid; /**< process ID or DBUS_PID_UNSET */
 106   dbus_uid_t uid; /**< user ID or DBUS_UID_UNSET */
 107   dbus_gid_t gid; /**< group ID or DBUS_GID_UNSET */
 108 } DBusCredentials;
 109
 110 int _dbus_connect_unix_socket (const char     *path,
 111                                dbus_bool_t     abstract,
 112                                DBusError      *error);
 113 int _dbus_listen_unix_socket  (const char     *path,
 114                                dbus_bool_t     abstract,
 115                                DBusError      *error);
 116 int _dbus_connect_tcp_socket  (const char     *host,
 117                                dbus_uint32_t   port,
 118                                DBusError      *error);
 119 int _dbus_listen_tcp_socket   (const char     *host,
 120                                dbus_uint32_t   port,
 121                                DBusError      *error);
 122 int _dbus_accept              (int             listen_fd);
 123
 124 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
 125                                                 DBusCredentials *credentials,
 126                                                 DBusError       *error);
 127 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
 128                                                 DBusError       *error);
 129
 130
 131 void        _dbus_credentials_clear                (DBusCredentials       *credentials);
 132 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 133 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 134                                                     const DBusCredentials *provided_credentials);
 135
 136
 137 typedef struct DBusUserInfo  DBusUserInfo;
 138 typedef struct DBusGroupInfo DBusGroupInfo;
 139
 140 /**
 141  * Information about a UNIX user
 142  */
 143 struct DBusUserInfo
 144 {
 145   dbus_uid_t  uid;            /**< UID */
 146   dbus_gid_t  primary_gid;    /**< GID */
 147   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 148   int         n_group_ids;    /**< Size of group IDs array */
 149   char       *username;       /**< Username */
 150   char       *homedir;        /**< Home directory */
 151 };
 152
 153 /**
 154  * Information about a UNIX group
 155  */
 156 struct DBusGroupInfo
 157 {
 158   dbus_gid_t  gid;            /**< GID */
 159   char       *groupname;      /**< Group name */
 160 };
 161
 162 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 163                                       const DBusString *username,
 164                                       DBusError        *error);
 165 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 166                                       dbus_uid_t        uid,
 167                                       DBusError        *error);
 168 void        _dbus_user_info_free     (DBusUserInfo     *info);
 169
 170 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 171                                        const DBusString *groupname,
 172                                        DBusError        *error);
 173 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 174                                        dbus_gid_t        gid,
 175                                        DBusError        *error);
 176 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 177
 178
 179 unsigned long _dbus_getpid (void);
 180 dbus_uid_t    _dbus_getuid (void);
 181 dbus_gid_t    _dbus_getgid (void);
 182
 183 typedef struct DBusAtomic DBusAtomic;
 184
 185 /**
 186  * An atomic integer.
 187  */
 188 struct DBusAtomic
 189 {
 190   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 191 };
 192
 193 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 194 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 195
 196 #define _DBUS_POLLIN      0x0001    /* There is data to read */
 197 #define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
 198 #define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
 199 #define _DBUS_POLLERR     0x0008    /* Error condition */
 200 #define _DBUS_POLLHUP     0x0010    /* Hung up */
 201 #define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */
 202
 203 /**
 204  * A portable struct pollfd wrapper.
 205  */
 206 typedef struct
 207 {
 208   int fd;            /**< File descriptor */
 209   short events;      /**< Events to poll for */
 210   short revents;     /**< Events that occurred */
 211 } DBusPollFD;
 212
 213 int _dbus_poll (DBusPollFD *fds,
 214                 int         n_fds,
 215                 int         timeout_milliseconds);
 216
 217 void _dbus_sleep_milliseconds (int milliseconds);
 218
 219 void _dbus_get_current_time (long *tv_sec,
 220                              long *tv_usec);
 221
 222
 223 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 224                                        const DBusString *filename,
 225                                        DBusError        *error);
 226 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 227                                        const DBusString *filename,
 228                                        DBusError        *error);
 229
 230 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 231                                               DBusError        *error);
 232 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 233                                               DBusError        *error);
 234 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 235                                               DBusError        *error);
 236 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 237                                               DBusError        *error);
 238
 239 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 240                                        const DBusString *next_component);
 241 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 242                                        DBusString       *dirname);
 243 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 244
 245 typedef struct DBusDirIter DBusDirIter;
 246
 247 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 248                                             DBusError        *error);
 249 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 250                                             DBusString       *filename,
 251                                             DBusError        *error);
 252 void         _dbus_directory_close         (DBusDirIter      *iter);
 253
 254
 255 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
 256                                          int         n_bytes);
 257 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
 258                                          int         n_bytes);
 259
 260 const char *_dbus_errno_to_string  (int errnum);
 261 const char* _dbus_error_from_errno (int error_number);
 262
 263 void _dbus_disable_sigpipe (void);
 264
 265 void _dbus_fd_set_close_on_exec (int fd);
 266
 267 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 268
 269 /**
 270  * Portable struct with stat() results
 271  */
 272 typedef struct
 273 {
 274   unsigned long mode;  /**< File mode */
 275   unsigned long nlink; /**< Number of hard links */
 276   dbus_uid_t    uid;   /**< User owning file */
 277   dbus_gid_t    gid;   /**< Group owning file */
 278   unsigned long size;  /**< Size of file */
 279   unsigned long atime; /**< Access time */
 280   unsigned long mtime; /**< Modify time */
 281   unsigned long ctime; /**< Creation time */
 282 } DBusStat;
 283
 284 dbus_bool_t _dbus_stat             (const DBusString *filename,
 285                                     DBusStat         *statbuf,
 286                                     DBusError        *error);
 287 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 288                                     int              *fd2,
 289                                     dbus_bool_t       blocking,
 290                                     DBusError        *error);
 291 dbus_bool_t _dbus_close            (int               fd,
 292                                     DBusError        *error);
 293
 294 void        _dbus_print_backtrace  (void);
 295
 296 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 297                                    DBusError        *error);
 298 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 299                                    unsigned long     pid,
 300                                    DBusError        *error);
 301 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 302                                    unsigned long     gid,
 303                                    DBusError        *error);
 304
 305 typedef void (* DBusSignalHandler) (int sig);
 306
 307 void _dbus_set_signal_handler (int               sig,
 308                                DBusSignalHandler handler);
 309
 310
 311 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 312  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 313  */
 314 #if !defined (DBUS_VA_COPY)
 315 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 316 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 317 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 318 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 319 #  else /* va_list is a pointer */
 320 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 321 #  endif /* va_list is a pointer */
 322 #endif /* !DBUS_VA_COPY */
 323
 324
 325 DBUS_END_DECLS;
 326
 327 #endif /* DBUS_SYSDEPS_H */