Home | History | Annotate | Download | only in dbus
      1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
      2 /* dbus-sysdeps-unix.h UNIX-specific wrappers around system/libc features (internal to D-Bus implementation)
      3  *
      4  * Copyright (C) 2002, 2003, 2006  Red Hat, Inc.
      5  * Copyright (C) 2003 CodeFactory AB
      6  *
      7  * Licensed under the Academic Free License version 2.1
      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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
     22  *
     23  */
     24 
     25 #ifndef DBUS_SYSDEPS_UNIX_H
     26 #define DBUS_SYSDEPS_UNIX_H
     27 
     28 #include <dbus/dbus-sysdeps.h>
     29 
     30 #ifdef DBUS_WIN
     31 #error "Don't include this on Windows"
     32 #endif
     33 
     34 DBUS_BEGIN_DECLS
     35 
     36 /**
     37  * @defgroup DBusSysdepsUnix UNIX-specific internal API
     38  * @ingroup DBusInternals
     39  * @brief Internal system-dependent API available on UNIX only
     40  * @{
     41  */
     42 
     43 dbus_bool_t
     44 _dbus_close     (int               fd,
     45                  DBusError        *error);
     46 int _dbus_dup   (int               fd,
     47                  DBusError        *error);
     48 int
     49 _dbus_read      (int               fd,
     50                  DBusString       *buffer,
     51                  int               count);
     52 int
     53 _dbus_write     (int               fd,
     54                  const DBusString *buffer,
     55                  int               start,
     56                  int               len);
     57 int
     58 _dbus_write_two (int               fd,
     59                  const DBusString *buffer1,
     60                  int               start1,
     61                  int               len1,
     62                  const DBusString *buffer2,
     63                  int               start2,
     64                  int               len2);
     65 
     66 dbus_bool_t _dbus_open_unix_socket (int              *fd,
     67                                     DBusError        *error);
     68 int _dbus_connect_unix_socket (const char     *path,
     69                                dbus_bool_t     abstract,
     70                                DBusError      *error);
     71 int _dbus_listen_unix_socket  (const char     *path,
     72                                dbus_bool_t     abstract,
     73                                DBusError      *error);
     74 
     75 int _dbus_listen_systemd_sockets (int       **fd,
     76                                  DBusError *error);
     77 
     78 dbus_bool_t _dbus_read_credentials (int               client_fd,
     79                                     DBusCredentials  *credentials,
     80                                     DBusError        *error);
     81 dbus_bool_t _dbus_send_credentials (int              server_fd,
     82                                     DBusError       *error);
     83 
     84 /** Information about a UNIX user */
     85 typedef struct DBusUserInfo  DBusUserInfo;
     86 /** Information about a UNIX group */
     87 typedef struct DBusGroupInfo DBusGroupInfo;
     88 
     89 /**
     90  * Information about a UNIX user
     91  */
     92 struct DBusUserInfo
     93 {
     94   dbus_uid_t  uid;            /**< UID */
     95   dbus_gid_t  primary_gid;    /**< GID */
     96   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
     97   int         n_group_ids;    /**< Size of group IDs array */
     98   char       *username;       /**< Username */
     99   char       *homedir;        /**< Home directory */
    100 };
    101 
    102 /**
    103  * Information about a UNIX group
    104  */
    105 struct DBusGroupInfo
    106 {
    107   dbus_gid_t  gid;            /**< GID */
    108   char       *groupname;      /**< Group name */
    109 };
    110 
    111 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
    112                                       const DBusString *username,
    113                                       DBusError        *error);
    114 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
    115                                       dbus_uid_t        uid,
    116                                       DBusError        *error);
    117 void        _dbus_user_info_free     (DBusUserInfo     *info);
    118 
    119 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
    120                                        const DBusString *groupname,
    121                                        DBusError        *error);
    122 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
    123                                        dbus_gid_t        gid,
    124                                        DBusError        *error);
    125 void        _dbus_group_info_free     (DBusGroupInfo    *info);
    126 
    127 dbus_uid_t    _dbus_getuid (void);
    128 dbus_uid_t    _dbus_geteuid (void);
    129 dbus_gid_t    _dbus_getgid (void);
    130 
    131 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
    132                              dbus_uid_t        *uid);
    133 
    134 /** @} */
    135 
    136 DBUS_END_DECLS
    137 
    138 #endif /* DBUS_SYSDEPS_UNIX_H */
    139