dbus-sysdeps.h 12.6 KB
Newer Older
1 2 3
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-sysdeps.h Wrappers around system/libc features (internal to D-BUS implementation)
 * 
4 5
 * Copyright (C) 2002, 2003  Red Hat, Inc.
 * Copyright (C) 2003 CodeFactory AB
6
 *
7
 * Licensed under the Academic Free License version 2.1
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef DBUS_SYSDEPS_H
#define DBUS_SYSDEPS_H

28 29
#include <config.h>

30
#include <dbus/dbus-errors.h>
31 32 33 34 35 36

/* this is perhaps bogus, but strcmp() etc. are faster if we use the
 * stuff straight out of string.h, so have this here for now.
 */
#include <string.h>

37 38 39
/* and it would just be annoying to abstract this */
#include <errno.h>

40
DBUS_BEGIN_DECLS
41 42 43 44 45 46 47 48 49 50

/* The idea of this file is to encapsulate everywhere that we're
 * relying on external libc features, for ease of security
 * auditing. The idea is from vsftpd. This also gives us a chance to
 * make things more convenient to use, e.g.  by reading into a
 * DBusString. Operating system headers aren't intended to be used
 * outside of this file and a limited number of others (such as
 * dbus-memory.c)
 */

51 52
typedef struct DBusString DBusString;

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
#if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
#define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  __attribute__((__format__ (__printf__, format_idx, arg_idx)))
#define _DBUS_GNUC_SCANF( format_idx, arg_idx )     \
  __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
#define _DBUS_GNUC_FORMAT( arg_idx )                \
  __attribute__((__format_arg__ (arg_idx)))
#define _DBUS_GNUC_NORETURN                         \
  __attribute__((__noreturn__))
#else   /* !__GNUC__ */
#define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
#define _DBUS_GNUC_SCANF( format_idx, arg_idx )
#define _DBUS_GNUC_FORMAT( arg_idx )
#define _DBUS_GNUC_NORETURN
#endif  /* !__GNUC__ */

void _dbus_abort (void) _DBUS_GNUC_NORETURN;
70 71

const char* _dbus_getenv (const char *varname);
72 73
dbus_bool_t _dbus_setenv (const char *varname,
			  const char *value);
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

int _dbus_read      (int               fd,
                     DBusString       *buffer,
                     int               count);
int _dbus_write     (int               fd,
                     const DBusString *buffer,
                     int               start,
                     int               len);
int _dbus_write_two (int               fd,
                     const DBusString *buffer1,
                     int               start1,
                     int               len1,
                     const DBusString *buffer2,
                     int               start2,
                     int               len2);

90 91 92 93 94 95 96 97 98 99 100 101
typedef unsigned long dbus_pid_t;
typedef unsigned long dbus_uid_t;
typedef unsigned long dbus_gid_t;

#define DBUS_PID_UNSET ((dbus_pid_t) -1)
#define DBUS_UID_UNSET ((dbus_uid_t) -1)
#define DBUS_GID_UNSET ((dbus_gid_t) -1)

#define DBUS_PID_FORMAT "%lu"
#define DBUS_UID_FORMAT "%lu"
#define DBUS_GID_FORMAT "%lu"

102 103
#define DBUS_CONSOLE_DIR "/var/run/console/"

104 105 106
/**
 * Struct representing socket credentials
 */
107 108
typedef struct
{
109 110 111
  dbus_pid_t pid; /**< process ID or DBUS_PID_UNSET */
  dbus_uid_t uid; /**< user ID or DBUS_UID_UNSET */
  dbus_gid_t gid; /**< group ID or DBUS_GID_UNSET */
112 113
} DBusCredentials;

114
int _dbus_connect_unix_socket (const char     *path,
115
                               dbus_bool_t     abstract,
116
                               DBusError      *error);
117
int _dbus_listen_unix_socket  (const char     *path,
118
                               dbus_bool_t     abstract,
119
                               DBusError      *error);
120 121
int _dbus_connect_tcp_socket  (const char     *host,
                               dbus_uint32_t   port,
122
                               DBusError      *error);
123 124
int _dbus_listen_tcp_socket   (const char     *host,
                               dbus_uint32_t   port,
125
                               DBusError      *error);
126 127 128 129
int _dbus_accept              (int             listen_fd);

dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
                                                DBusCredentials *credentials,
130
                                                DBusError       *error);
131
dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
132
                                                DBusError       *error);
133 134


135
void        _dbus_credentials_clear                (DBusCredentials       *credentials);
136 137 138
void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
                                                    const DBusCredentials *provided_credentials);
139 140


141 142 143
typedef struct DBusUserInfo  DBusUserInfo;
typedef struct DBusGroupInfo DBusGroupInfo;

144 145 146
/**
 * Information about a UNIX user
 */
147 148 149 150 151 152 153 154 155 156
struct DBusUserInfo
{
  dbus_uid_t  uid;            /**< UID */
  dbus_gid_t  primary_gid;    /**< GID */
  dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
  int         n_group_ids;    /**< Size of group IDs array */
  char       *username;       /**< Username */
  char       *homedir;        /**< Home directory */
};

157 158 159
/**
 * Information about a UNIX group
 */
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
struct DBusGroupInfo
{
  dbus_gid_t  gid;            /**< GID */
  char       *groupname;      /**< Group name */
};

dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
                                      const DBusString *username,
                                      DBusError        *error);
dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
                                      dbus_uid_t        uid,
                                      DBusError        *error);
void        _dbus_user_info_free     (DBusUserInfo     *info);

dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
                                       const DBusString *groupname,
                                       DBusError        *error);
dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
                                       dbus_gid_t        gid,
                                       DBusError        *error);
void        _dbus_group_info_free     (DBusGroupInfo    *info);
181

182

183
unsigned long _dbus_getpid (void);
184 185
dbus_uid_t    _dbus_getuid (void);
dbus_gid_t    _dbus_getgid (void);
186

187
typedef struct DBusAtomic DBusAtomic;
188 189 190 191

/**
 * An atomic integer.
 */
192 193
struct DBusAtomic
{
194
  volatile dbus_int32_t value; /**< Value of the atomic integer. */
195
};
196

197 198
dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
199 200 201 202 203 204 205 206

#define _DBUS_POLLIN      0x0001    /* There is data to read */
#define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
#define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
#define _DBUS_POLLERR     0x0008    /* Error condition */
#define _DBUS_POLLHUP     0x0010    /* Hung up */
#define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */

207 208 209
/**
 * A portable struct pollfd wrapper. 
 */
210 211
typedef struct
{
212 213 214
  int fd;            /**< File descriptor */
  short events;      /**< Events to poll for */
  short revents;     /**< Events that occurred */
215 216 217 218 219 220 221 222
} DBusPollFD;

int _dbus_poll (DBusPollFD *fds,
                int         n_fds,
                int         timeout_milliseconds);

void _dbus_sleep_milliseconds (int milliseconds);

223 224 225
void _dbus_get_current_time (long *tv_sec,
                             long *tv_usec);

226

227 228 229
dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
                                       const DBusString *filename,
                                       DBusError        *error);
230 231 232
dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
                                       const DBusString *filename,
                                       DBusError        *error);
233

234 235 236 237
dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
                                              DBusError        *error);
dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
                                              DBusError        *error);
238 239
dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
                                              DBusError        *error);
240 241
dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
					      DBusError        *error);
242

243 244
dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
                                       const DBusString *next_component);
245 246 247
dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
                                       DBusString       *dirname);
dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
248 249 250 251

typedef struct DBusDirIter DBusDirIter;

DBusDirIter* _dbus_directory_open          (const DBusString *filename,
252
                                            DBusError        *error);
253 254
dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
                                            DBusString       *filename,
255
                                            DBusError        *error);
256 257 258
void         _dbus_directory_close         (DBusDirIter      *iter);


259 260
dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
                                         int         n_bytes);
261 262
dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
                                         int         n_bytes);
263

264 265
const char *_dbus_errno_to_string  (int errnum);
const char* _dbus_error_from_errno (int error_number);
266

267 268
void _dbus_disable_sigpipe (void);

Anders Carlsson's avatar
Anders Carlsson committed
269 270
void _dbus_fd_set_close_on_exec (int fd);

271
void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
272

273 274 275
/**
 * Portable struct with stat() results
 */
276 277
typedef struct
{
278 279 280 281 282 283 284 285
  unsigned long mode;  /**< File mode */
  unsigned long nlink; /**< Number of hard links */
  dbus_uid_t    uid;   /**< User owning file */
  dbus_gid_t    gid;   /**< Group owning file */
  unsigned long size;  /**< Size of file */
  unsigned long atime; /**< Access time */
  unsigned long mtime; /**< Modify time */
  unsigned long ctime; /**< Creation time */
286 287
} DBusStat;

288 289 290 291 292
dbus_bool_t _dbus_stat             (const DBusString *filename,
                                    DBusStat         *statbuf,
                                    DBusError        *error);
dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
                                    int              *fd2,
293
                                    dbus_bool_t       blocking,
294 295 296
                                    DBusError        *error);
dbus_bool_t _dbus_close            (int               fd,
                                    DBusError        *error);
297

298 299
void        _dbus_print_backtrace  (void);

300 301 302 303 304 305 306 307
dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
                                   DBusError        *error);
dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
                                   unsigned long     pid,
                                   DBusError        *error);
dbus_bool_t _dbus_change_identity (unsigned long     uid,
                                   unsigned long     gid,
                                   DBusError        *error);
308

309 310 311 312 313
typedef void (* DBusSignalHandler) (int sig);

void _dbus_set_signal_handler (int               sig,
                               DBusSignalHandler handler);

314 315 316
dbus_bool_t _dbus_file_exists     (const char *file);
dbus_bool_t _dbus_user_at_console (const char *username,
                                   DBusError  *error);
317

318 319 320 321 322 323 324 325 326 327 328 329 330 331
/* Define DBUS_VA_COPY() to do the right thing for copying va_list variables. 
 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy. 
 */
#if !defined (DBUS_VA_COPY)
#  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
#    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
#  elif defined (DBUS_VA_COPY_AS_ARRAY)
#    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
#  else /* va_list is a pointer */
#    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
#  endif /* va_list is a pointer */
#endif /* !DBUS_VA_COPY */


332
DBUS_END_DECLS
333 334

#endif /* DBUS_SYSDEPS_H */