D-Bus 1.13.18

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
43 DBUS_PRIVATE_EXPORT
44 dbus_bool_t
45 _dbus_close (int fd,
46 DBusError *error);
47 DBUS_PRIVATE_EXPORT
48 int _dbus_dup (int fd,
49 DBusError *error);
50 DBUS_PRIVATE_EXPORT
51 int
52 _dbus_read (int fd,
53 DBusString *buffer,
54 int count);
55 int
56 _dbus_write (int fd,
57 const DBusString *buffer,
58 int start,
59 int len);
60 int
61 _dbus_write_two (int fd,
62 const DBusString *buffer1,
63 int start1,
64 int len1,
65 const DBusString *buffer2,
66 int start2,
67 int len2);
68
69 int _dbus_connect_unix_socket (const char *path,
70 dbus_bool_t abstract,
71 DBusError *error);
72 int _dbus_listen_unix_socket (const char *path,
73 dbus_bool_t abstract,
74 DBusError *error);
75
76 int _dbus_connect_exec (const char *path,
77 char *const argv[],
78 DBusError *error);
79
80 int _dbus_listen_systemd_sockets (DBusSocket **fd,
81 DBusError *error);
82
83 dbus_bool_t _dbus_read_credentials (int client_fd,
84 DBusCredentials *credentials,
85 DBusError *error);
86 dbus_bool_t _dbus_send_credentials (int server_fd,
87 DBusError *error);
88
89 dbus_bool_t _dbus_lookup_launchd_socket (DBusString *socket_path,
90 const char *launchd_env_var,
91 DBusError *error);
92
93 DBUS_PRIVATE_EXPORT
94 dbus_bool_t _dbus_lookup_user_bus (dbus_bool_t *supported,
95 DBusString *address,
96 DBusError *error);
97
99 typedef struct DBusUserInfo DBusUserInfo;
101 typedef struct DBusGroupInfo DBusGroupInfo;
102
106 struct DBusUserInfo
107 {
108 size_t refcount;
109 dbus_uid_t uid;
110 dbus_gid_t primary_gid;
111 dbus_gid_t *group_ids;
112 int n_group_ids;
113 char *username;
114 char *homedir;
115 };
116
120 struct DBusGroupInfo
121 {
122 size_t refcount;
123 dbus_gid_t gid;
124 char *groupname;
125 };
126
127 dbus_bool_t _dbus_user_info_fill (DBusUserInfo *info,
128 const DBusString *username,
129 DBusError *error);
130 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo *info,
131 dbus_uid_t uid,
132 DBusError *error);
133 void _dbus_user_info_free (DBusUserInfo *info);
134
135 dbus_bool_t _dbus_group_info_fill (DBusGroupInfo *info,
136 const DBusString *groupname,
137 DBusError *error);
138 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo *info,
139 dbus_gid_t gid,
140 DBusError *error);
141 void _dbus_group_info_free (DBusGroupInfo *info);
142
143 DBUS_PRIVATE_EXPORT
144 dbus_uid_t _dbus_geteuid (void);
145
146 DBUS_PRIVATE_EXPORT
147 void _dbus_close_all (void);
148 DBUS_PRIVATE_EXPORT
149 void _dbus_fd_set_all_close_on_exec (void);
150 DBUS_PRIVATE_EXPORT
151 void _dbus_fd_clear_close_on_exec (int fd);
152
153 dbus_bool_t _dbus_append_address_from_socket (DBusSocket fd,
154 DBusString *address,
155 DBusError *error);
156
157 DBUS_PRIVATE_EXPORT
158 void _dbus_fd_set_close_on_exec (int fd);
159
160 typedef enum
161 {
162 DBUS_FORCE_STDIN_NULL = (1 << 0),
163 DBUS_FORCE_STDOUT_NULL = (1 << 1),
164 DBUS_FORCE_STDERR_NULL = (1 << 2)
165 } DBusEnsureStandardFdsFlags;
166
167 DBUS_PRIVATE_EXPORT
168 dbus_bool_t _dbus_ensure_standard_fds (DBusEnsureStandardFdsFlags flags,
169 const char **error_str_p);
170
172 typedef void (* DBusSignalHandler) (int sig);
173
174 void _dbus_set_signal_handler (int sig,
175 DBusSignalHandler handler);
176
179 DBUS_END_DECLS
180
181 #endif /* DBUS_SYSDEPS_UNIX_H */
_dbus_user_info_fill
dbus_bool_t _dbus_user_info_fill(DBusUserInfo *info, const DBusString *username, DBusError *error)
Gets user info for the given username.
Definition: dbus-sysdeps-unix.c:2903
DBusUserInfo::group_ids
dbus_gid_t * group_ids
Groups IDs, including above primary group.
Definition: dbus-sysdeps-unix.h:111
_dbus_user_info_fill_uid
dbus_bool_t _dbus_user_info_fill_uid(DBusUserInfo *info, dbus_uid_t uid, DBusError *error)
Gets user info for the given user ID.
Definition: dbus-sysdeps-unix.c:2920
DBusUserInfo::n_group_ids
int n_group_ids
Size of group IDs array.
Definition: dbus-sysdeps-unix.h:112
_dbus_ensure_standard_fds
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_ensure_standard_fds(DBusEnsureStandardFdsFlags flags, const char **error_str_p)
Ensure that the standard file descriptors stdin, stdout and stderr are open, by opening /dev/null if ...
Definition: dbus-sysdeps-unix.c:155
_dbus_append_address_from_socket
dbus_bool_t _dbus_append_address_from_socket(DBusSocket fd, DBusString *address, DBusError *error)
Read the address from the socket and append it to the string.
Definition: dbus-sysdeps-unix.c:4884
_dbus_lookup_launchd_socket
dbus_bool_t _dbus_lookup_launchd_socket(DBusString *socket_path, const char *launchd_env_var, DBusError *error)
quries launchd for a specific env var which holds the socket path.
Definition: dbus-sysdeps-unix.c:4322
_dbus_listen_systemd_sockets
int _dbus_listen_systemd_sockets(DBusSocket **fd, DBusError *error)
Acquires one or more sockets passed in from systemd.
Definition: dbus-sysdeps-unix.c:1271
_dbus_write
int _dbus_write(int fd, const DBusString *buffer, int start, int len)
Thin wrapper around the write() system call that writes a part of a DBusString and handles EINTR for ...
Definition: dbus-sysdeps-unix.c:791
_dbus_group_info_free
void _dbus_group_info_free(DBusGroupInfo *info)
Frees the members of info (but not info itself).
Definition: dbus-userdb.c:119
DBusGroupInfo::gid
dbus_gid_t gid
GID.
Definition: dbus-sysdeps-unix.h:123
_dbus_connect_unix_socket
int _dbus_connect_unix_socket(const char *path, dbus_bool_t abstract, DBusError *error)
Creates a socket and connects it to the UNIX domain socket at the given path.
Definition: dbus-sysdeps-unix.c:936
_dbus_user_info_free
void _dbus_user_info_free(DBusUserInfo *info)
Frees the members of info (but not info itself)
Definition: dbus-userdb.c:106
DBUS_END_DECLS
#define DBUS_END_DECLS
DBusGroupInfo
Information about a UNIX group.
Definition: dbus-sysdeps-unix.h:121
DBusUserInfo::uid
dbus_uid_t uid
UID.
Definition: dbus-sysdeps-unix.h:109
_dbus_listen_unix_socket
int _dbus_listen_unix_socket(const char *path, dbus_bool_t abstract, DBusError *error)
Creates a socket and binds it to the given path, then listens on the socket.
Definition: dbus-sysdeps-unix.c:1144
dbus_gid_t
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:139
DBusUserInfo::refcount
size_t refcount
Reference count.
Definition: dbus-sysdeps-unix.h:108
_dbus_connect_exec
int _dbus_connect_exec(const char *path, char *const argv[], DBusError *error)
Creates a UNIX domain socket and connects it to the specified process to execute.
Definition: dbus-sysdeps-unix.c:1033
_dbus_dup
DBUS_PRIVATE_EXPORT int _dbus_dup(int fd, DBusError *error)
Duplicates a file descriptor.
Definition: dbus-sysdeps-unix.c:3594
DBusGroupInfo::refcount
size_t refcount
Reference count.
Definition: dbus-sysdeps-unix.h:122
DBusUserInfo::username
char * username
Username.
Definition: dbus-sysdeps-unix.h:113
_dbus_read
DBUS_PRIVATE_EXPORT int _dbus_read(int fd, DBusString *buffer, int count)
Thin wrapper around the read() system call that appends the data it reads to the DBusString buffer.
Definition: dbus-sysdeps-unix.c:731
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
_dbus_set_signal_handler
void _dbus_set_signal_handler(int sig, DBusSignalHandler handler)
Installs a UNIX signal handler.
Definition: dbus-sysdeps-util-unix.c:540
DBusString
Definition: dbus-string.h:43
DBusUserInfo::homedir
char * homedir
Home directory.
Definition: dbus-sysdeps-unix.h:114
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:181
DBusCredentials
Definition: dbus-credentials.c:49
dbus_uid_t
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:137
_dbus_write_two
int _dbus_write_two(int fd, const DBusString *buffer1, int start1, int len1, const DBusString *buffer2, int start2, int len2)
Like _dbus_write() but will use writev() if possible to write both buffers in sequence.
Definition: dbus-sysdeps-unix.c:837
_dbus_group_info_fill_gid
dbus_bool_t _dbus_group_info_fill_gid(DBusGroupInfo *info, dbus_gid_t gid, DBusError *error)
Initializes the given DBusGroupInfo struct with information about the given group ID.
Definition: dbus-sysdeps-util-unix.c:945
_dbus_fd_set_close_on_exec
DBUS_PRIVATE_EXPORT void _dbus_fd_set_close_on_exec(int fd)
Sets the file descriptor to be close on exec.
Definition: dbus-sysdeps-unix.c:3522
DBusUserInfo
Information about a UNIX user.
Definition: dbus-sysdeps-unix.h:107
_dbus_close
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_close(int fd, DBusError *error)
Closes a file descriptor.
Definition: dbus-sysdeps-unix.c:3566
_dbus_geteuid
DBUS_PRIVATE_EXPORT dbus_uid_t _dbus_geteuid(void)
Gets our effective UID.
Definition: dbus-sysdeps-unix.c:3001
_dbus_fd_clear_close_on_exec
DBUS_PRIVATE_EXPORT void _dbus_fd_clear_close_on_exec(int fd)
Sets the file descriptor to not be close-on-exec.
Definition: dbus-sysdeps-unix.c:3544
DBusSignalHandler
void(* DBusSignalHandler)(int sig)
A UNIX signal handler.
Definition: dbus-sysdeps-unix.h:172
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusUserInfo::primary_gid
dbus_gid_t primary_gid
GID.
Definition: dbus-sysdeps-unix.h:110
_dbus_fd_set_all_close_on_exec
DBUS_PRIVATE_EXPORT void _dbus_fd_set_all_close_on_exec(void)
Sets all file descriptors except the first three (i.e.
Definition: dbus-sysdeps-unix.c:4816
_dbus_group_info_fill
dbus_bool_t _dbus_group_info_fill(DBusGroupInfo *info, const DBusString *groupname, DBusError *error)
Initializes the given DBusGroupInfo struct with information about the given group name.
Definition: dbus-sysdeps-util-unix.c:926
_dbus_close_all
DBUS_PRIVATE_EXPORT void _dbus_close_all(void)
Closes all file descriptors except the first three (i.e.
Definition: dbus-sysdeps-unix.c:4806
DBusGroupInfo::groupname
char * groupname
Group name.
Definition: dbus-sysdeps-unix.h:124
dbus_bool_t
dbus_uint32_t dbus_bool_t
Definition: dbus-types.h:35