D-Bus: dbus-sysdeps-unix.h Source File

D-Bus 1.12.4

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 dbus_uid_t uid;
109 dbus_gid_t primary_gid;
110 dbus_gid_t *group_ids;
111 int n_group_ids;
112 char *username;
113 char *homedir;
114 };
115
119 struct DBusGroupInfo
120 {
121 dbus_gid_t gid;
122 char *groupname;
123 };
124
125 dbus_bool_t _dbus_user_info_fill (DBusUserInfo *info,
126 const DBusString *username,
127 DBusError *error);
128 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo *info,
129 dbus_uid_t uid,
130 DBusError *error);
131 void _dbus_user_info_free (DBusUserInfo *info);
132
133 dbus_bool_t _dbus_group_info_fill (DBusGroupInfo *info,
134 const DBusString *groupname,
135 DBusError *error);
136 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo *info,
137 dbus_gid_t gid,
138 DBusError *error);
139 void _dbus_group_info_free (DBusGroupInfo *info);
140
141 DBUS_PRIVATE_EXPORT
142 dbus_uid_t _dbus_geteuid (void);
143
144 dbus_bool_t _dbus_parse_uid (const DBusString *uid_str,
145 dbus_uid_t *uid);
146
147 DBUS_PRIVATE_EXPORT
148 void _dbus_close_all (void);
149
150 dbus_bool_t _dbus_append_address_from_socket (DBusSocket fd,
151 DBusString *address,
152 DBusError *error);
153
154 DBUS_PRIVATE_EXPORT
155 void _dbus_fd_set_close_on_exec (int fd);
156
157 typedef enum
158 {
159 DBUS_FORCE_STDIN_NULL = (1 << 0),
160 DBUS_FORCE_STDOUT_NULL = (1 << 1),
161 DBUS_FORCE_STDERR_NULL = (1 << 2)
162 } DBusEnsureStandardFdsFlags;
163
164 DBUS_PRIVATE_EXPORT
165 dbus_bool_t _dbus_ensure_standard_fds (DBusEnsureStandardFdsFlags flags,
166 const char **error_str_p);
167
169 typedef void (* DBusSignalHandler) (int sig);
170
171 void _dbus_set_signal_handler (int sig,
172 DBusSignalHandler handler);
173
176 DBUS_END_DECLS
177
178 #endif /* DBUS_SYSDEPS_UNIX_H */
DBusUserInfo::username
char * username
Username.
Definition: dbus-sysdeps-unix.h:112
DBusCredentials
Definition: dbus-credentials.c:48
_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:4373
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_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:764
_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:4496
DBusUserInfo::primary_gid
dbus_gid_t primary_gid
GID.
Definition: dbus-sysdeps-unix.h:109
_dbus_dup
DBUS_PRIVATE_EXPORT int _dbus_dup(int fd, DBusError *error)
Duplicates a file descriptor.
Definition: dbus-sysdeps-unix.c:3242
DBusGroupInfo::groupname
char * groupname
Group name.
Definition: dbus-sysdeps-unix.h:122
_dbus_parse_uid
dbus_bool_t _dbus_parse_uid(const DBusString *uid_str, dbus_uid_t *uid)
Gets a UID from a UID string.
Definition: dbus-sysdeps-unix.c:2706
_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:2589
_dbus_set_signal_handler
void _dbus_set_signal_handler(int sig, DBusSignalHandler handler)
Installs a UNIX signal handler.
Definition: dbus-sysdeps-util-unix.c:517
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:149
DBusUserInfo::group_ids
dbus_gid_t * group_ids
Groups IDs, including above primary group.
Definition: dbus-sysdeps-unix.h:110
_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:3968
DBusString
Definition: dbus-string.h:42
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusUserInfo::n_group_ids
int n_group_ids
Size of group IDs array.
Definition: dbus-sysdeps-unix.h:111
_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:1237
DBusUserInfo::uid
dbus_uid_t uid
UID.
Definition: dbus-sysdeps-unix.h:108
_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:925
_dbus_group_info_free
void _dbus_group_info_free(DBusGroupInfo *info)
Frees the members of info (but not info itself).
Definition: dbus-userdb.c:89
_dbus_user_info_free
void _dbus_user_info_free(DBusUserInfo *info)
Frees the members of info (but not info itself)
Definition: dbus-userdb.c:76
_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:704
DBusError
Object representing an exception.
Definition: dbus-errors.h:48
_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:1005
_dbus_geteuid
DBUS_PRIVATE_EXPORT dbus_uid_t _dbus_geteuid(void)
Gets our effective UID.
Definition: dbus-sysdeps-unix.c:2681
_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:906
DBusUserInfo::homedir
char * homedir
Home directory.
Definition: dbus-sysdeps-unix.h:113
DBusGroupInfo
Information about a UNIX group.
Definition: dbus-sysdeps-unix.h:119
_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:3192
_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:2606
_dbus_close
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_close(int fd, DBusError *error)
Closes a file descriptor.
Definition: dbus-sysdeps-unix.c:3214
_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:810
DBusGroupInfo::gid
dbus_gid_t gid
GID.
Definition: dbus-sysdeps-unix.h:121
DBusSignalHandler
void(* DBusSignalHandler)(int sig)
A UNIX signal handler.
Definition: dbus-sysdeps-unix.h:169
dbus_gid_t
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:110
dbus_uid_t
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:108
_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:909
_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:1111
DBusUserInfo
Information about a UNIX user.
Definition: dbus-sysdeps-unix.h:106
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.