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-string.h>
  29 #include <dbus/dbus-errors.h>
  30
  31 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
  32  * stuff straight out of string.h, so have this here for now.
  33  */
  34 #include <string.h>
  35
  36 /* and it would just be annoying to abstract this */
  37 #include <errno.h>
  38
  39 DBUS_BEGIN_DECLS;
  40
  41 /* The idea of this file is to encapsulate everywhere that we're
  42  * relying on external libc features, for ease of security
  43  * auditing. The idea is from vsftpd. This also gives us a chance to
  44  * make things more convenient to use, e.g.  by reading into a
  45  * DBusString. Operating system headers aren't intended to be used
  46  * outside of this file and a limited number of others (such as
  47  * dbus-memory.c)
  48  */
  49
  50 void _dbus_abort (void);
  51
  52 const char* _dbus_getenv (const char *varname);
  53 dbus_bool_t _dbus_setenv (const char *varname,
  54                           const char *value);
  55
  56 int _dbus_read      (int               fd,
  57                      DBusString       *buffer,
  58                      int               count);
  59 int _dbus_write     (int               fd,
  60                      const DBusString *buffer,
  61                      int               start,
  62                      int               len);
  63 int _dbus_write_two (int               fd,
  64                      const DBusString *buffer1,
  65                      int               start1,
  66                      int               len1,
  67                      const DBusString *buffer2,
  68                      int               start2,
  69                      int               len2);
  70
  71 typedef struct
  72 {
  73   /* -1 if not available */
  74   int pid;
  75   int uid;
  76   int gid;
  77 } DBusCredentials;
  78
  79 int _dbus_connect_unix_socket (const char     *path,
  80                                DBusError      *error);
  81 int _dbus_listen_unix_socket  (const char     *path,
  82                                DBusError      *error);
  83 int _dbus_connect_tcp_socket  (const char     *host,
  84                                dbus_uint32_t   port,
  85                                DBusError      *error);
  86 int _dbus_listen_tcp_socket   (const char     *host,
  87                                dbus_uint32_t   port,
  88                                DBusError      *error);
  89 int _dbus_accept              (int             listen_fd);
  90
  91 dbus_bool_t _dbus_read_credentials_unix_socket (int              client_fd,
  92                                                 DBusCredentials *credentials,
  93                                                 DBusError       *error);
  94 dbus_bool_t _dbus_send_credentials_unix_socket (int              server_fd,
  95                                                 DBusError       *error);
  96
  97
  98 dbus_bool_t _dbus_credentials_from_username        (const DBusString      *username,
  99                                                     DBusCredentials       *credentials);
 100 dbus_bool_t _dbus_credentials_from_user_id         (unsigned long          user_id,
 101                                                     DBusCredentials       *credentials);
 102 dbus_bool_t _dbus_credentials_from_uid_string      (const DBusString      *uid_str,
 103                                                     DBusCredentials       *credentials);
 104 void        _dbus_credentials_from_current_process (DBusCredentials       *credentials);
 105 dbus_bool_t _dbus_credentials_match                (const DBusCredentials *expected_credentials,
 106                                                     const DBusCredentials *provided_credentials);
 107
 108 dbus_bool_t _dbus_string_append_our_uid (DBusString *str);
 109
 110 dbus_bool_t _dbus_homedir_from_username          (const DBusString       *username,
 111                                                   DBusString             *homedir);
 112 dbus_bool_t _dbus_user_info_from_current_process (const DBusString      **username,
 113                                                   const DBusString      **homedir,
 114                                                   const DBusCredentials **credentials);
 115
 116 dbus_bool_t _dbus_get_group_id (const DBusString  *group_name,
 117                                 unsigned long     *gid);
 118 dbus_bool_t _dbus_get_groups   (unsigned long      uid,
 119                                 unsigned long    **group_ids,
 120                                 int               *n_group_ids);
 121
 122 unsigned long _dbus_getpid (void);
 123
 124 typedef int dbus_atomic_t;
 125
 126 dbus_atomic_t _dbus_atomic_inc (dbus_atomic_t *atomic);
 127 dbus_atomic_t _dbus_atomic_dec (dbus_atomic_t *atomic);
 128
 129 #define _DBUS_POLLIN      0x0001    /* There is data to read */
 130 #define _DBUS_POLLPRI     0x0002    /* There is urgent data to read */
 131 #define _DBUS_POLLOUT     0x0004    /* Writing now will not block */
 132 #define _DBUS_POLLERR     0x0008    /* Error condition */
 133 #define _DBUS_POLLHUP     0x0010    /* Hung up */
 134 #define _DBUS_POLLNVAL    0x0020    /* Invalid request: fd not open */
 135
 136 typedef struct
 137 {
 138   int fd;
 139   short events;
 140   short revents;
 141 } DBusPollFD;
 142
 143 int _dbus_poll (DBusPollFD *fds,
 144                 int         n_fds,
 145                 int         timeout_milliseconds);
 146
 147 void _dbus_sleep_milliseconds (int milliseconds);
 148
 149 void _dbus_get_current_time (long *tv_sec,
 150                              long *tv_usec);
 151
 152
 153 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 154                                        const DBusString *filename,
 155                                        DBusError        *error);
 156 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 157                                        const DBusString *filename,
 158                                        DBusError        *error);
 159
 160 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 161                                               DBusError        *error);
 162 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 163                                               DBusError        *error);
 164 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 165                                               DBusError        *error);
 166
 167 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 168                                        const DBusString *next_component);
 169 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 170                                        DBusString       *dirname);
 171 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 172
 173 typedef struct DBusDirIter DBusDirIter;
 174
 175 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 176                                             DBusError        *error);
 177 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 178                                             DBusString       *filename,
 179                                             DBusError        *error);
 180 void         _dbus_directory_close         (DBusDirIter      *iter);
 181
 182
 183 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
 184                                          int         n_bytes);
 185 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
 186                                          int         n_bytes);
 187
 188 const char *_dbus_errno_to_string  (int errnum);
 189 const char* _dbus_error_from_errno (int error_number);
 190
 191 void _dbus_disable_sigpipe (void);
 192
 193 void _dbus_fd_set_close_on_exec (int fd);
 194
 195 void _dbus_exit (int code);
 196
 197 typedef struct
 198 {
 199   unsigned long mode;
 200   unsigned long nlink;
 201   unsigned long uid;
 202   unsigned long gid;
 203   unsigned long size;
 204   unsigned long atime;
 205   unsigned long mtime;
 206   unsigned long ctime;
 207 } DBusStat;
 208
 209 dbus_bool_t _dbus_stat             (const DBusString *filename,
 210                                     DBusStat         *statbuf,
 211                                     DBusError        *error);
 212 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 213                                     int              *fd2,
 214                                     dbus_bool_t       blocking,
 215                                     DBusError        *error);
 216 dbus_bool_t _dbus_close            (int               fd,
 217                                     DBusError        *error);
 218
 219 void        _dbus_print_backtrace  (void);
 220
 221 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 222                                    DBusError        *error);
 223 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 224                                    unsigned long     pid,
 225                                    DBusError        *error);
 226 dbus_bool_t _dbus_change_identity (unsigned long     uid,
 227                                    unsigned long     gid,
 228                                    DBusError        *error);
 229
 230 typedef void (* DBusSignalHandler) (int sig);
 231
 232 void _dbus_set_signal_handler (int               sig,
 233                                DBusSignalHandler handler);
 234
 235
 236 DBUS_END_DECLS;
 237
 238 #endif /* DBUS_SYSDEPS_H */