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 1.2
   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 typedef struct
 101 {
 102   /* Set to DBUS_PID_UNSET etc. if not available */
 103   dbus_pid_t pid;
 104   dbus_uid_t uid;
 105   dbus_gid_t gid;
 106 } DBusCredentials;
 107
 108 int _dbus_connect_unix_socket (const char     *path,
 109                                dbus_bool_t     abstract,
 110                                DBusError      *error);
 111 int _dbus_listen_unix_socket  (const char     *path,
 112                                dbus_bool_t     abstract,
 113                                DBusError      *error);
 114 int _dbus_connect_tcp_socket  (const char     *host,
 115                                dbus_uint32_t   port,
 116                                DBusError      *error);
 117 int _dbus_listen_tcp_socket   (const char     *host,
 118                                dbus_uint32_t   port,
 119                                DBusError      *error);
 120 int _dbus_accept              (int             listen_fd);
 121
 122 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
 123                                                 DBusCredentials *credentials,
 124                                                 DBusError       *error);
 125 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
 126                                                 DBusError       *error);
 127
 128
 129 void        _dbus_credentials_clear                (DBusCredentials       *credentials);
 130 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 131 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 132                                                     const DBusCredentials *provided_credentials);
 133
 134
 135 typedef struct DBusUserInfo  DBusUserInfo;
 136 typedef struct DBusGroupInfo DBusGroupInfo;
 137
 138 struct DBusUserInfo
 139 {
 140   dbus_uid_t  uid;            /**< UID */
 141   dbus_gid_t  primary_gid;    /**< GID */
 142   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
 143   int         n_group_ids;    /**< Size of group IDs array */
 144   char       *username;       /**< Username */
 145   char       *homedir;        /**< Home directory */
 146 };
 147
 148 struct DBusGroupInfo
 149 {
 150   dbus_gid_t  gid;            /**< GID */
 151   char       *groupname;      /**< Group name */
 152 };
 153
 154 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
 155                                       const DBusString *username,
 156                                       DBusError        *error);
 157 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
 158                                       dbus_uid_t        uid,
 159                                       DBusError        *error);
 160 void        _dbus_user_info_free     (DBusUserInfo     *info);
 161
 162 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
 163                                        const DBusString *groupname,
 164                                        DBusError        *error);
 165 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
 166                                        dbus_gid_t        gid,
 167                                        DBusError        *error);
 168 void        _dbus_group_info_free     (DBusGroupInfo    *info);
 169
 170
 171 unsigned long _dbus_getpid (void);
 172 dbus_uid_t    _dbus_getuid (void);
 173 dbus_gid_t    _dbus_getgid (void);
 174
 175 typedef struct DBusAtomic DBusAtomic;
 176 struct DBusAtomic
 177 {
 178   volatile dbus_int32_t value;
 179 };
 180
 181 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 182 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 183
 184 #define _DBUS_POLLIN      0x0001    /* There is data to read */
 185 #define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
 186 #define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
 187 #define _DBUS_POLLERR     0x0008    /* Error condition */
 188 #define _DBUS_POLLHUP     0x0010    /* Hung up */
 189 #define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */
 190
 191 typedef struct
 192 {
 193   int fd;
 194   short events;
 195   short revents;
 196 } DBusPollFD;
 197
 198 int _dbus_poll (DBusPollFD *fds,
 199                 int         n_fds,
 200                 int         timeout_milliseconds);
 201
 202 void _dbus_sleep_milliseconds (int milliseconds);
 203
 204 void _dbus_get_current_time (long *tv_sec,
 205                              long *tv_usec);
 206
 207
 208 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 209                                        const DBusString *filename,
 210                                        DBusError        *error);
 211 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 212                                        const DBusString *filename,
 213                                        DBusError        *error);
 214
 215 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 216                                               DBusError        *error);
 217 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 218                                               DBusError        *error);
 219 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 220                                               DBusError        *error);
 221
 222 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 223                                        const DBusString *next_component);
 224 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 225                                        DBusString       *dirname);
 226 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 227
 228 typedef struct DBusDirIter DBusDirIter;
 229
 230 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 231                                             DBusError        *error);
 232 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 233                                             DBusString       *filename,
 234                                             DBusError        *error);
 235 void         _dbus_directory_close         (DBusDirIter      *iter);
 236
 237
 238 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
 239                                          int         n_bytes);
 240 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
 241                                          int         n_bytes);
 242
 243 const char *_dbus_errno_to_string  (int errnum);
 244 const char* _dbus_error_from_errno (int error_number);
 245
 246 void _dbus_disable_sigpipe (void);
 247
 248 void _dbus_fd_set_close_on_exec (int fd);
 249
 250 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 251
 252 typedef struct
 253 {
 254   unsigned long mode;
 255   unsigned long nlink;
 256   dbus_uid_t    uid;
 257   dbus_gid_t    gid;
 258   unsigned long size;
 259   unsigned long atime;
 260   unsigned long mtime;
 261   unsigned long ctime;
 262 } DBusStat;
 263
 264 dbus_bool_t _dbus_stat             (const DBusString *filename,
 265                                     DBusStat         *statbuf,
 266                                     DBusError        *error);
 267 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 268                                     int              *fd2,
 269                                     dbus_bool_t       blocking,
 270                                     DBusError        *error);
 271 dbus_bool_t _dbus_close            (int               fd,
 272                                     DBusError        *error);
 273
 274 void        _dbus_print_backtrace  (void);
 275
 276 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 277                                    DBusError        *error);
 278 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 279                                    unsigned long     pid,
 280                                    DBusError        *error);
 281 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 282                                    unsigned long     gid,
 283                                    DBusError        *error);
 284
 285 typedef void (* DBusSignalHandler) (int sig);
 286
 287 void _dbus_set_signal_handler (int               sig,
 288                                DBusSignalHandler handler);
 289
 290
 291 DBUS_END_DECLS;
 292
 293 #endif /* DBUS_SYSDEPS_H */