_dbus_getgid: remove, unused
[platform/upstream/dbus.git] / dbus / dbus-sysdeps-unix.h
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 int _dbus_connect_unix_socket (const char     *path,
67                                dbus_bool_t     abstract,
68                                DBusError      *error);
69 int _dbus_listen_unix_socket  (const char     *path,
70                                dbus_bool_t     abstract,
71                                DBusError      *error);
72
73 int _dbus_listen_systemd_sockets (int       **fd,
74                                  DBusError *error);
75
76 dbus_bool_t _dbus_read_credentials (int               client_fd,
77                                     DBusCredentials  *credentials,
78                                     DBusError        *error);
79 dbus_bool_t _dbus_send_credentials (int              server_fd,
80                                     DBusError       *error);
81
82 dbus_bool_t _dbus_lookup_launchd_socket (DBusString *socket_path,
83                                          const char *launchd_env_var,
84                                          DBusError  *error);
85
86 /** Information about a UNIX user */
87 typedef struct DBusUserInfo  DBusUserInfo;
88 /** Information about a UNIX group */
89 typedef struct DBusGroupInfo DBusGroupInfo;
90
91 /**
92  * Information about a UNIX user
93  */
94 struct DBusUserInfo
95 {
96   dbus_uid_t  uid;            /**< UID */
97   dbus_gid_t  primary_gid;    /**< GID */
98   dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
99   int         n_group_ids;    /**< Size of group IDs array */
100   char       *username;       /**< Username */
101   char       *homedir;        /**< Home directory */
102 };
103
104 /**
105  * Information about a UNIX group
106  */
107 struct DBusGroupInfo
108 {
109   dbus_gid_t  gid;            /**< GID */
110   char       *groupname;      /**< Group name */
111 };
112
113 dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
114                                       const DBusString *username,
115                                       DBusError        *error);
116 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
117                                       dbus_uid_t        uid,
118                                       DBusError        *error);
119 void        _dbus_user_info_free     (DBusUserInfo     *info);
120
121 dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
122                                        const DBusString *groupname,
123                                        DBusError        *error);
124 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
125                                        dbus_gid_t        gid,
126                                        DBusError        *error);
127 void        _dbus_group_info_free     (DBusGroupInfo    *info);
128
129 dbus_uid_t    _dbus_getuid (void);
130 dbus_uid_t    _dbus_geteuid (void);
131
132 dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
133                              dbus_uid_t        *uid);
134
135 /** @} */
136
137 DBUS_END_DECLS
138
139 #endif /* DBUS_SYSDEPS_UNIX_H */