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
34DBUS_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
43dbus_bool_t
44_dbus_close     (int               fd,
45                 DBusError        *error);
46int _dbus_dup   (int               fd,
47                 DBusError        *error);
48int
49_dbus_read      (int               fd,
50                 DBusString       *buffer,
51                 int               count);
52int
53_dbus_write     (int               fd,
54                 const DBusString *buffer,
55                 int               start,
56                 int               len);
57int
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
66int _dbus_connect_unix_socket (const char     *path,
67                               dbus_bool_t     abstract,
68                               DBusError      *error);
69int _dbus_listen_unix_socket  (const char     *path,
70                               dbus_bool_t     abstract,
71                               DBusError      *error);
72
73int _dbus_connect_exec (const char     *path,
74                        char *const    argv[],
75                        DBusError      *error);
76
77int _dbus_listen_systemd_sockets (int       **fd,
78                                 DBusError *error);
79
80dbus_bool_t _dbus_read_credentials (int               client_fd,
81                                    DBusCredentials  *credentials,
82                                    DBusError        *error);
83dbus_bool_t _dbus_send_credentials (int              server_fd,
84                                    DBusError       *error);
85
86dbus_bool_t _dbus_lookup_launchd_socket (DBusString *socket_path,
87                                         const char *launchd_env_var,
88                                         DBusError  *error);
89
90/** Information about a UNIX user */
91typedef struct DBusUserInfo  DBusUserInfo;
92/** Information about a UNIX group */
93typedef struct DBusGroupInfo DBusGroupInfo;
94
95/**
96 * Information about a UNIX user
97 */
98struct DBusUserInfo
99{
100  dbus_uid_t  uid;            /**< UID */
101  dbus_gid_t  primary_gid;    /**< GID */
102  dbus_gid_t *group_ids;      /**< Groups IDs, *including* above primary group */
103  int         n_group_ids;    /**< Size of group IDs array */
104  char       *username;       /**< Username */
105  char       *homedir;        /**< Home directory */
106};
107
108/**
109 * Information about a UNIX group
110 */
111struct DBusGroupInfo
112{
113  dbus_gid_t  gid;            /**< GID */
114  char       *groupname;      /**< Group name */
115};
116
117dbus_bool_t _dbus_user_info_fill     (DBusUserInfo     *info,
118                                      const DBusString *username,
119                                      DBusError        *error);
120dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo     *info,
121                                      dbus_uid_t        uid,
122                                      DBusError        *error);
123void        _dbus_user_info_free     (DBusUserInfo     *info);
124
125dbus_bool_t _dbus_group_info_fill     (DBusGroupInfo    *info,
126                                       const DBusString *groupname,
127                                       DBusError        *error);
128dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo    *info,
129                                       dbus_gid_t        gid,
130                                       DBusError        *error);
131void        _dbus_group_info_free     (DBusGroupInfo    *info);
132
133dbus_uid_t    _dbus_getuid (void);
134dbus_uid_t    _dbus_geteuid (void);
135
136dbus_bool_t _dbus_parse_uid (const DBusString  *uid_str,
137                             dbus_uid_t        *uid);
138
139void _dbus_close_all (void);
140
141/** @} */
142
143DBUS_END_DECLS
144
145#endif /* DBUS_SYSDEPS_UNIX_H */
146