1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-sysdeps.h Wrappers around system/libc features (internal to D-BUS implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 1.2
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.
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.
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
25 #ifndef DBUS_SYSDEPS_H
26 #define DBUS_SYSDEPS_H
28 #include <dbus/dbus-errors.h>
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.
35 /* and it would just be annoying to abstract this */
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
49 typedef struct DBusString DBusString;
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__))
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__ */
67 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
69 const char* _dbus_getenv (const char *varname);
70 dbus_bool_t _dbus_setenv (const char *varname,
73 int _dbus_read (int fd,
76 int _dbus_write (int fd,
77 const DBusString *buffer,
80 int _dbus_write_two (int fd,
81 const DBusString *buffer1,
84 const DBusString *buffer2,
88 typedef unsigned long dbus_pid_t;
89 typedef unsigned long dbus_uid_t;
90 typedef unsigned long dbus_gid_t;
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)
96 #define DBUS_PID_FORMAT "%lu"
97 #define DBUS_UID_FORMAT "%lu"
98 #define DBUS_GID_FORMAT "%lu"
101 * Struct representing socket credentials
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 */
110 int _dbus_connect_unix_socket (const char *path,
111 dbus_bool_t abstract,
113 int _dbus_listen_unix_socket (const char *path,
114 dbus_bool_t abstract,
116 int _dbus_connect_tcp_socket (const char *host,
119 int _dbus_listen_tcp_socket (const char *host,
122 int _dbus_accept (int listen_fd);
124 dbus_bool_t _dbus_read_credentials_unix_socket (int client_fd,
125 DBusCredentials *credentials,
127 dbus_bool_t _dbus_send_credentials_unix_socket (int server_fd,
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);
137 typedef struct DBusUserInfo DBusUserInfo;
138 typedef struct DBusGroupInfo DBusGroupInfo;
141 * Information about a UNIX user
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 */
154 * Information about a UNIX group
158 dbus_gid_t gid; /**< GID */
159 char *groupname; /**< Group name */
162 dbus_bool_t _dbus_user_info_fill (DBusUserInfo *info,
163 const DBusString *username,
165 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo *info,
168 void _dbus_user_info_free (DBusUserInfo *info);
170 dbus_bool_t _dbus_group_info_fill (DBusGroupInfo *info,
171 const DBusString *groupname,
173 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo *info,
176 void _dbus_group_info_free (DBusGroupInfo *info);
179 unsigned long _dbus_getpid (void);
180 dbus_uid_t _dbus_getuid (void);
181 dbus_gid_t _dbus_getgid (void);
183 typedef struct DBusAtomic DBusAtomic;
190 volatile dbus_int32_t value; /**< Value of the atomic integer. */
193 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
194 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
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 */
204 * A portable struct pollfd wrapper.
208 int fd; /**< File descriptor */
209 short events; /**< Events to poll for */
210 short revents; /**< Events that occurred */
213 int _dbus_poll (DBusPollFD *fds,
215 int timeout_milliseconds);
217 void _dbus_sleep_milliseconds (int milliseconds);
219 void _dbus_get_current_time (long *tv_sec,
223 dbus_bool_t _dbus_file_get_contents (DBusString *str,
224 const DBusString *filename,
226 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
227 const DBusString *filename,
230 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
232 dbus_bool_t _dbus_delete_file (const DBusString *filename,
234 dbus_bool_t _dbus_create_directory (const DBusString *filename,
237 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
238 const DBusString *next_component);
239 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
240 DBusString *dirname);
241 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
243 typedef struct DBusDirIter DBusDirIter;
245 DBusDirIter* _dbus_directory_open (const DBusString *filename,
247 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
248 DBusString *filename,
250 void _dbus_directory_close (DBusDirIter *iter);
253 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
255 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
258 const char *_dbus_errno_to_string (int errnum);
259 const char* _dbus_error_from_errno (int error_number);
261 void _dbus_disable_sigpipe (void);
263 void _dbus_fd_set_close_on_exec (int fd);
265 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
268 * Portable struct with stat() results
272 unsigned long mode; /**< File mode */
273 unsigned long nlink; /**< Number of hard links */
274 dbus_uid_t uid; /**< User owning file */
275 dbus_gid_t gid; /**< Group owning file */
276 unsigned long size; /**< Size of file */
277 unsigned long atime; /**< Access time */
278 unsigned long mtime; /**< Modify time */
279 unsigned long ctime; /**< Creation time */
282 dbus_bool_t _dbus_stat (const DBusString *filename,
285 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
287 dbus_bool_t blocking,
289 dbus_bool_t _dbus_close (int fd,
292 void _dbus_print_backtrace (void);
294 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
296 dbus_bool_t _dbus_write_pid_file (const DBusString *filename,
299 dbus_bool_t _dbus_change_identity (unsigned long uid,
303 typedef void (* DBusSignalHandler) (int sig);
305 void _dbus_set_signal_handler (int sig,
306 DBusSignalHandler handler);
311 #endif /* DBUS_SYSDEPS_H */