1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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 2.1
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
30 #include <dbus/dbus-errors.h>
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.
39 /* AIX sys/poll.h does #define events reqevents, and other
40 * wonderousness, so must include sys/poll before declaring
50 #define _DBUS_PATH_SEPARATOR ";"
52 #define _DBUS_PATH_SEPARATOR ":"
55 /* Forward declarations */
57 /** An opaque string type */
58 typedef struct DBusString DBusString;
60 /** An opaque list type */
61 typedef struct DBusList DBusList;
63 /** Object that contains a list of credentials such as UNIX or Windows user ID */
64 typedef struct DBusCredentials DBusCredentials;
67 * @addtogroup DBusSysdeps
72 /* The idea of this file is to encapsulate everywhere that we're
73 * relying on external libc features, for ease of security
74 * auditing. The idea is from vsftpd. This also gives us a chance to
75 * make things more convenient to use, e.g. by reading into a
76 * DBusString. Operating system headers aren't intended to be used
77 * outside of this file and a limited number of others (such as
81 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
82 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
83 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
84 #define _DBUS_GNUC_NORETURN \
85 __attribute__((__noreturn__))
87 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
88 #define _DBUS_GNUC_NORETURN
89 #endif /* !__GNUC__ */
91 /** @def _DBUS_GNUC_PRINTF
92 * used to tell gcc about printf format strings
94 /** @def _DBUS_GNUC_NORETURN
95 * used to tell gcc about functions that never return, such as _dbus_abort()
98 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
100 const char* _dbus_getenv (const char *varname);
101 dbus_bool_t _dbus_setenv (const char *varname,
103 dbus_bool_t _dbus_clearenv (void);
104 char ** _dbus_get_environment (void);
107 typedef unsigned long dbus_pid_t;
109 typedef unsigned long dbus_uid_t;
111 typedef unsigned long dbus_gid_t;
113 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
114 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
115 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
116 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
117 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
118 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
120 /** an appropriate printf format for dbus_pid_t */
121 #define DBUS_PID_FORMAT "%lu"
122 /** an appropriate printf format for dbus_uid_t */
123 #define DBUS_UID_FORMAT "%lu"
124 /** an appropriate printf format for dbus_gid_t */
125 #define DBUS_GID_FORMAT "%lu"
131 * @todo Use for the file descriptors a struct
132 * - struct DBusSocket{ int d; }; -
133 * instead of int to get type-safety which
134 * will be checked by the compiler.
138 dbus_bool_t _dbus_open_tcp_socket (int *fd,
140 dbus_bool_t _dbus_close_socket (int fd,
142 int _dbus_read_socket (int fd,
145 int _dbus_write_socket (int fd,
146 const DBusString *buffer,
149 int _dbus_write_socket_two (int fd,
150 const DBusString *buffer1,
153 const DBusString *buffer2,
156 int _dbus_connect_tcp_socket (const char *host,
160 int _dbus_listen_tcp_socket (const char *host,
166 int _dbus_accept (int listen_fd);
169 dbus_bool_t _dbus_read_credentials_socket (int client_fd,
170 DBusCredentials *credentials,
172 dbus_bool_t _dbus_send_credentials_socket (int server_fd,
175 dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials,
176 const DBusString *username);
177 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
178 dbus_bool_t _dbus_append_user_from_current_process (DBusString *str);
180 dbus_bool_t _dbus_parse_unix_user_from_config (const DBusString *username,
182 dbus_bool_t _dbus_parse_unix_group_from_config (const DBusString *groupname,
184 dbus_bool_t _dbus_unix_groups_from_uid (dbus_uid_t uid,
185 dbus_gid_t **group_ids,
187 dbus_bool_t _dbus_unix_user_is_at_console (dbus_uid_t uid,
189 dbus_bool_t _dbus_unix_user_is_process_owner (dbus_uid_t uid);
190 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
192 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString *directory,
193 DBusCredentials *credentials);
195 /** Opaque type representing an atomically-modifiable integer
196 * that can be used from multiple threads.
198 typedef struct DBusAtomic DBusAtomic;
201 * An atomic integer safe to increment or decrement from multiple threads.
206 volatile long value; /**< Value of the atomic integer. */
208 volatile dbus_int32_t value; /**< Value of the atomic integer. */
212 /* The value we get from autofoo is in the form of a cpp expression;
213 * convert that to a conventional defined/undef switch. (We can't get
214 * the conventional defined/undef because of multiarch builds only running
215 * ./configure once, on Darwin.) */
216 #if DBUS_HAVE_ATOMIC_INT_COND
217 # define DBUS_HAVE_ATOMIC_INT 1
219 # undef DBUS_HAVE_ATOMIC_INT
222 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
223 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
226 /* AIX uses different values for poll */
229 /** There is data to read */
230 #define _DBUS_POLLIN 0x0001
231 /** There is urgent data to read */
232 #define _DBUS_POLLPRI 0x0004
233 /** Writing now will not block */
234 #define _DBUS_POLLOUT 0x0002
235 /** Error condition */
236 #define _DBUS_POLLERR 0x4000
238 #define _DBUS_POLLHUP 0x2000
239 /** Invalid request: fd not open */
240 #define _DBUS_POLLNVAL 0x8000
242 /** There is data to read */
243 #define _DBUS_POLLIN 0x0001
244 /** There is urgent data to read */
245 #define _DBUS_POLLPRI 0x0002
246 /** Writing now will not block */
247 #define _DBUS_POLLOUT 0x0004
248 /** Error condition */
249 #define _DBUS_POLLERR 0x0008
251 #define _DBUS_POLLHUP 0x0010
252 /** Invalid request: fd not open */
253 #define _DBUS_POLLNVAL 0x0020
257 * A portable struct pollfd wrapper.
261 int fd; /**< File descriptor */
262 short events; /**< Events to poll for */
263 short revents; /**< Events that occurred */
266 int _dbus_poll (DBusPollFD *fds,
268 int timeout_milliseconds);
270 void _dbus_sleep_milliseconds (int milliseconds);
272 void _dbus_get_current_time (long *tv_sec,
276 * File/directory interface
278 dbus_bool_t _dbus_file_exists (const char *file);
279 dbus_bool_t _dbus_file_get_contents (DBusString *str,
280 const DBusString *filename,
282 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
283 const DBusString *filename,
286 dbus_bool_t _dbus_make_file_world_readable (const DBusString *filename,
289 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
291 dbus_bool_t _dbus_delete_file (const DBusString *filename,
293 dbus_bool_t _dbus_create_directory (const DBusString *filename,
295 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
298 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
299 const DBusString *next_component);
300 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
301 DBusString *dirname);
302 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
304 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
305 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
307 dbus_bool_t _dbus_append_system_config_file (DBusString *str);
308 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
314 void _dbus_pipe_init (DBusPipe *pipe,
316 void _dbus_pipe_init_stdout (DBusPipe *pipe);
317 int _dbus_pipe_write (DBusPipe *pipe,
318 const DBusString *buffer,
322 int _dbus_pipe_close (DBusPipe *pipe,
324 dbus_bool_t _dbus_pipe_is_valid (DBusPipe *pipe);
325 void _dbus_pipe_invalidate (DBusPipe *pipe);
326 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe *pipe);
329 /** Opaque type for reading a directory listing */
330 typedef struct DBusDirIter DBusDirIter;
332 DBusDirIter* _dbus_directory_open (const DBusString *filename,
334 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
335 DBusString *filename,
337 void _dbus_directory_close (DBusDirIter *iter);
339 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
342 void _dbus_fd_set_close_on_exec (int fd);
344 const char* _dbus_get_tmpdir (void);
349 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
351 void _dbus_generate_random_bytes_buffer (char *buffer,
353 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
355 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
358 const char* _dbus_error_from_errno (int error_number);
360 void _dbus_set_errno_to_zero (void);
361 dbus_bool_t _dbus_get_is_errno_nonzero (void);
362 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
363 dbus_bool_t _dbus_get_is_errno_enomem (void);
364 dbus_bool_t _dbus_get_is_errno_eintr (void);
365 const char* _dbus_strerror_from_errno (void);
367 void _dbus_disable_sigpipe (void);
370 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
372 int _dbus_printf_string_upper_bound (const char *format,
377 * Portable struct with stat() results
381 unsigned long mode; /**< File mode */
382 unsigned long nlink; /**< Number of hard links */
383 dbus_uid_t uid; /**< User owning file */
384 dbus_gid_t gid; /**< Group owning file */
385 unsigned long size; /**< Size of file */
386 unsigned long atime; /**< Access time */
387 unsigned long mtime; /**< Modify time */
388 unsigned long ctime; /**< Creation time */
391 dbus_bool_t _dbus_stat (const DBusString *filename,
394 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
396 dbus_bool_t blocking,
399 void _dbus_print_backtrace (void);
401 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
402 DBusPipe *print_pid_pipe,
404 dbus_bool_t keep_umask);
406 dbus_bool_t _dbus_verify_daemon_user (const char *user);
407 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
410 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
411 DBusPipe *print_pid_pipe,
412 dbus_pid_t pid_to_write,
415 dbus_bool_t _dbus_command_for_pid (unsigned long pid,
420 /** A UNIX signal handler */
421 typedef void (* DBusSignalHandler) (int sig);
423 void _dbus_set_signal_handler (int sig,
424 DBusSignalHandler handler);
426 dbus_bool_t _dbus_user_at_console (const char *username,
429 void _dbus_init_system_log (void);
430 void _dbus_log_info (const char *msg, va_list args);
431 void _dbus_log_security (const char *msg, va_list args);
433 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
434 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
436 #if !defined (DBUS_VA_COPY)
437 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
438 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
439 # elif defined (DBUS_VA_COPY_AS_ARRAY)
440 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
441 # else /* va_list is a pointer */
442 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
443 # endif /* va_list is a pointer */
444 #endif /* !DBUS_VA_COPY */
448 * Casts a primitive C type to a byte array and then indexes
449 * a particular byte of the array.
451 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
452 (((const char*)&(p))[(i)])
453 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
454 * or b in an 80-bit register, thus failing to compare the two 64-bit
455 * doubles for bitwise equality. So this macro compares the two doubles
458 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
459 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
460 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
461 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
462 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
463 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
464 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
465 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
466 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
468 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
471 /** Type representing a universally unique ID
472 * @todo rename to UUID instead of GUID
474 typedef union DBusGUID DBusGUID;
476 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
477 dbus_bool_t create_if_not_found,
481 * Initialize threads as in dbus_threads_init_default(), appropriately
483 * @returns #FALSE if no memory
485 dbus_bool_t _dbus_threads_init_platform_specific (void);
487 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
489 DBusList **dir_list);
491 unsigned long _dbus_pid_for_log (void);
493 /* FIXME move back to dbus-sysdeps-unix.h probably -
494 * the PID file handling just needs a little more abstraction
495 * in the bus daemon first.
497 dbus_pid_t _dbus_getpid (void);
499 void _dbus_flush_caches (void);
505 #endif /* DBUS_SYSDEPS_H */