• Main Page
  • Related Pages
  • Modules
  • Data Structures
  • Files
  • File List

dbus-sysdeps.h

00001 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
00002 /* dbus-sysdeps.h Wrappers around system/libc features (internal to D-Bus implementation)
00003  * 
00004  * Copyright (C) 2002, 2003  Red Hat, Inc.
00005  * Copyright (C) 2003 CodeFactory AB
00006  *
00007  * Licensed under the Academic Free License version 2.1
00008  * 
00009  * This program is free software; you can redistribute it and/or modify
00010  * it under the terms of the GNU General Public License as published by
00011  * the Free Software Foundation; either version 2 of the License, or
00012  * (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  * 
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00022  *
00023  */
00024 
00025 #ifndef DBUS_SYSDEPS_H
00026 #define DBUS_SYSDEPS_H
00027 
00028 #include <config.h>
00029 
00030 #include <dbus/dbus-errors.h>
00031 
00032 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
00033  * stuff straight out of string.h, so have this here for now.
00034  */
00035 #include <string.h>
00036 #include <stdarg.h>
00037 
00038  
00039 /* AIX sys/poll.h does #define events reqevents, and other
00040  * wonderousness, so must include sys/poll before declaring
00041  * DBusPollFD
00042  */ 
00043 #ifdef HAVE_POLL
00044 #include <sys/poll.h>
00045 #endif
00046 
00047 DBUS_BEGIN_DECLS
00048 
00049 #ifdef DBUS_WIN
00050 #define _DBUS_PATH_SEPARATOR ";"
00051 #else
00052 #define _DBUS_PATH_SEPARATOR ":"
00053 #endif
00054 
00055 /* Forward declarations */
00056 
00058 typedef struct DBusString DBusString;
00059 
00061 typedef struct DBusList DBusList;
00062 
00064 typedef struct DBusCredentials DBusCredentials;
00065 
00072 /* The idea of this file is to encapsulate everywhere that we're
00073  * relying on external libc features, for ease of security
00074  * auditing. The idea is from vsftpd. This also gives us a chance to
00075  * make things more convenient to use, e.g.  by reading into a
00076  * DBusString. Operating system headers aren't intended to be used
00077  * outside of this file and a limited number of others (such as
00078  * dbus-memory.c)
00079  */
00080 
00081 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
00082 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
00083   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
00084 #define _DBUS_GNUC_NORETURN                         \
00085   __attribute__((__noreturn__))
00086 #else   /* !__GNUC__ */
00087 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
00088 #define _DBUS_GNUC_NORETURN
00089 #endif  /* !__GNUC__ */
00090 
00098 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
00099 
00100 dbus_bool_t _dbus_check_setuid (void);
00101 const char* _dbus_getenv (const char *varname);
00102 dbus_bool_t _dbus_setenv (const char *varname,
00103                           const char *value);
00104 dbus_bool_t _dbus_clearenv (void);
00105 char **     _dbus_get_environment (void);
00106 
00108 typedef unsigned long dbus_pid_t;
00110 typedef unsigned long dbus_uid_t;
00112 typedef unsigned long dbus_gid_t;
00113 
00115 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
00116 
00117 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
00118 
00119 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
00120 
00122 #define DBUS_PID_FORMAT "%lu"
00123 
00124 #define DBUS_UID_FORMAT "%lu"
00125 
00126 #define DBUS_GID_FORMAT "%lu"
00127 
00128 
00139 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
00140                                     DBusError        *error);
00141 dbus_bool_t _dbus_close_socket     (int               fd,
00142                                     DBusError        *error);
00143 int         _dbus_read_socket      (int               fd,
00144                                     DBusString       *buffer,
00145                                     int               count);
00146 int         _dbus_write_socket     (int               fd,
00147                                     const DBusString *buffer,
00148                                     int               start,
00149                                     int               len);
00150 int         _dbus_write_socket_two (int               fd,
00151                                     const DBusString *buffer1,
00152                                     int               start1,
00153                                     int               len1,
00154                                     const DBusString *buffer2,
00155                                     int               start2,
00156                                     int               len2);
00157 int _dbus_connect_tcp_socket  (const char     *host,
00158                                const char     *port,
00159                                const char     *family,
00160                                DBusError      *error);
00161 int _dbus_listen_tcp_socket   (const char     *host,
00162                                const char     *port,
00163                                const char     *family,
00164                                DBusString     *retport,
00165                                int           **fds_p,
00166                                DBusError      *error);
00167 int _dbus_accept              (int             listen_fd);
00168 
00169 
00170 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
00171                                            DBusCredentials  *credentials,
00172                                            DBusError        *error);
00173 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
00174                                            DBusError       *error);
00175 
00176 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
00177                                                         const DBusString *username);
00178 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
00179 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
00180 
00181 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
00182                                                  dbus_uid_t        *uid_p);
00183 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
00184                                                  dbus_gid_t        *gid_p);
00185 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
00186                                                  dbus_gid_t       **group_ids,
00187                                                  int               *n_group_ids);
00188 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
00189                                                  DBusError         *error);
00190 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
00191 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
00192 
00193 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
00194                                                             DBusCredentials *credentials);
00195 
00199 typedef struct DBusAtomic DBusAtomic;
00200 
00204 struct DBusAtomic
00205 {
00206 #ifdef DBUS_WIN
00207   volatile long value; 
00208 #else
00209   volatile dbus_int32_t value; 
00210 #endif
00211 };
00212 
00213 /* The value we get from autofoo is in the form of a cpp expression;
00214  * convert that to a conventional defined/undef switch. (We can't get
00215  * the conventional defined/undef because of multiarch builds only running
00216  * ./configure once, on Darwin.) */
00217 #if DBUS_HAVE_ATOMIC_INT_COND
00218 #   define DBUS_HAVE_ATOMIC_INT 1
00219 #else
00220 #   undef DBUS_HAVE_ATOMIC_INT
00221 #endif
00222 
00223 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
00224 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
00225 
00226 
00227 /* AIX uses different values for poll */
00228 
00229 #ifdef _AIX
00230 
00231 #define _DBUS_POLLIN      0x0001
00232 
00233 #define _DBUS_POLLPRI     0x0004
00234 
00235 #define _DBUS_POLLOUT     0x0002
00236 
00237 #define _DBUS_POLLERR     0x4000
00238 
00239 #define _DBUS_POLLHUP     0x2000
00240 
00241 #define _DBUS_POLLNVAL    0x8000
00242 #elif defined(__HAIKU__)
00243 
00244 #define _DBUS_POLLIN      0x0001
00245 
00246 #define _DBUS_POLLOUT     0x0002
00247 
00248 #define _DBUS_POLLERR     0x0004
00249 
00250 #define _DBUS_POLLPRI     0x0020
00251 
00252 #define _DBUS_POLLHUP     0x0080
00253 
00254 #define _DBUS_POLLNVAL    0x1000
00255 #else
00256 
00257 #define _DBUS_POLLIN      0x0001
00258 
00259 #define _DBUS_POLLPRI     0x0002
00260 
00261 #define _DBUS_POLLOUT     0x0004
00262 
00263 #define _DBUS_POLLERR     0x0008
00264 
00265 #define _DBUS_POLLHUP     0x0010
00266 
00267 #define _DBUS_POLLNVAL    0x0020
00268 #endif
00269 
00273 typedef struct
00274 {
00275   int fd;            
00276   short events;      
00277   short revents;     
00278 } DBusPollFD;
00279 
00280 int _dbus_poll (DBusPollFD *fds,
00281                 int         n_fds,
00282                 int         timeout_milliseconds);
00283 
00284 void _dbus_sleep_milliseconds (int milliseconds);
00285 
00286 void _dbus_get_current_time (long *tv_sec,
00287                              long *tv_usec);
00288 
00292 dbus_bool_t _dbus_file_exists         (const char       *file);
00293 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
00294                                        const DBusString *filename,
00295                                        DBusError        *error);
00296 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
00297                                        const DBusString *filename,
00298                                        DBusError        *error);
00299 
00300 dbus_bool_t _dbus_make_file_world_readable   (const DBusString *filename,
00301                                               DBusError *error);
00302 
00303 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
00304                                               DBusError        *error);
00305 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
00306                                               DBusError        *error);
00307 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
00308                                               DBusError        *error);
00309 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
00310                                               DBusError        *error);
00311 
00312 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
00313                                        const DBusString *next_component);
00314 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
00315                                        DBusString       *dirname);
00316 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
00317 
00318 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
00319 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
00320 
00321 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
00322 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
00323 
00324 typedef struct {
00325   int fd_or_handle;
00326 } DBusPipe;
00327 
00328 void        _dbus_pipe_init                (DBusPipe         *pipe,
00329                                             int               fd);
00330 void        _dbus_pipe_init_stdout         (DBusPipe         *pipe);
00331 int         _dbus_pipe_write               (DBusPipe         *pipe,
00332                                             const DBusString *buffer,
00333                                             int               start,
00334                                             int               len,
00335                                             DBusError        *error);
00336 int         _dbus_pipe_close               (DBusPipe         *pipe,
00337                                             DBusError        *error);
00338 dbus_bool_t _dbus_pipe_is_valid            (DBusPipe         *pipe);
00339 void        _dbus_pipe_invalidate          (DBusPipe         *pipe);
00340 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe         *pipe);
00341 
00342 
00344 typedef struct DBusDirIter DBusDirIter;
00345 
00346 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
00347                                             DBusError        *error);
00348 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
00349                                             DBusString       *filename,
00350                                             DBusError        *error);
00351 void         _dbus_directory_close         (DBusDirIter      *iter);
00352 
00353 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
00354                                                     DBusError *error);
00355 
00356 void _dbus_fd_set_close_on_exec (int fd);
00357 
00358 const char* _dbus_get_tmpdir      (void);
00359 
00363 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
00364                                                       int   n_bytes);
00365 void        _dbus_generate_random_bytes_buffer (char       *buffer,
00366                                                 int         n_bytes);
00367 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
00368                                                 int         n_bytes);
00369 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
00370                                                 int         n_bytes);
00371 
00372 const char* _dbus_error_from_errno (int error_number);
00373 
00374 void        _dbus_set_errno_to_zero                  (void);
00375 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
00376 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
00377 dbus_bool_t _dbus_get_is_errno_enomem                (void);
00378 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
00379 dbus_bool_t _dbus_get_is_errno_epipe                 (void);
00380 const char* _dbus_strerror_from_errno                (void);
00381 
00382 void _dbus_disable_sigpipe (void);
00383 
00384 
00385 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
00386 
00387 int _dbus_printf_string_upper_bound (const char *format,
00388                                      va_list args);
00389 
00390 
00394 typedef struct
00395 {
00396   unsigned long mode;  
00397   unsigned long nlink; 
00398   dbus_uid_t    uid;   
00399   dbus_gid_t    gid;   
00400   unsigned long size;  
00401   unsigned long atime; 
00402   unsigned long mtime; 
00403   unsigned long ctime; 
00404 } DBusStat;
00405 
00406 dbus_bool_t _dbus_stat             (const DBusString *filename,
00407                                     DBusStat         *statbuf,
00408                                     DBusError        *error);
00409 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
00410                                     int              *fd2,
00411                                     dbus_bool_t       blocking,
00412                                     DBusError        *error);
00413 
00414 void        _dbus_print_backtrace  (void);
00415 
00416 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
00417                                    DBusPipe         *print_pid_pipe,
00418                                    DBusError        *error,
00419                                    dbus_bool_t       keep_umask);
00420 
00421 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
00422 
00423 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
00424                                               DBusPipe         *print_pid_pipe,
00425                                               dbus_pid_t        pid_to_write,
00426                                               DBusError        *error);
00427 
00428 dbus_bool_t _dbus_command_for_pid (unsigned long  pid,
00429                                    DBusString    *str,
00430                                    int            max_len,
00431                                    DBusError     *error);
00432 
00434 typedef void (* DBusSignalHandler) (int sig);
00435 
00436 void _dbus_set_signal_handler (int               sig,
00437                                DBusSignalHandler handler);
00438 
00439 dbus_bool_t _dbus_user_at_console (const char *username,
00440                                    DBusError  *error);
00441 
00442 void _dbus_init_system_log (void);
00443 
00444 typedef enum {
00445   DBUS_SYSTEM_LOG_INFO,
00446   DBUS_SYSTEM_LOG_SECURITY,
00447   DBUS_SYSTEM_LOG_FATAL
00448 } DBusSystemLogSeverity;
00449 
00450 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
00451 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
00452 
00453 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
00454  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
00455  */
00456 #if !defined (DBUS_VA_COPY)
00457 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
00458 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
00459 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
00460 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
00461 #  else /* va_list is a pointer */
00462 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
00463 #  endif /* va_list is a pointer */
00464 #endif /* !DBUS_VA_COPY */
00465 
00466 
00471 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
00472     (((const char*)&(p))[(i)])
00473 
00478 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
00479      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
00480       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
00481       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
00482       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
00483       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
00484       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
00485       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
00486       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
00487 
00488 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address, 
00489                                           DBusError *error);
00490 
00491 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
00492                                           DBusString  *address,
00493                                           DBusError   *error);
00494 
00498 typedef union DBusGUID DBusGUID;
00499 
00500 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
00501                                              dbus_bool_t       create_if_not_found,
00502                                              DBusError        *error);
00503 
00509 dbus_bool_t _dbus_threads_init_platform_specific (void);
00510 
00511 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs, 
00512                                           const char *suffix, 
00513                                           DBusList **dir_list);
00514 
00515 unsigned long _dbus_pid_for_log (void);
00516 
00517 /* FIXME move back to dbus-sysdeps-unix.h probably -
00518  * the PID file handling just needs a little more abstraction
00519  * in the bus daemon first.
00520  */
00521 dbus_pid_t    _dbus_getpid (void);
00522 
00523 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
00524                                          DBusError  *error);
00525 
00526 void _dbus_flush_caches (void);
00527 
00530 DBUS_END_DECLS
00531 
00532 #endif /* DBUS_SYSDEPS_H */

Generated on Wed Nov 19 2014 17:15:21 for D-Bus by  doxygen 1.7.1