D-Bus  1.13.7
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 
35 
43 DBUS_PRIVATE_EXPORT
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 
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 
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;
102 
107 {
112  char *username;
113  char *homedir;
114 };
115 
120 {
122  char *groupname;
123 };
124 
126  const DBusString *username,
127  DBusError *error);
129  dbus_uid_t uid,
130  DBusError *error);
132 
134  const DBusString *groupname,
135  DBusError *error);
137  dbus_gid_t gid,
138  DBusError *error);
140 
141 DBUS_PRIVATE_EXPORT
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 DBUS_PRIVATE_EXPORT
151 DBUS_PRIVATE_EXPORT
152 void _dbus_fd_clear_close_on_exec (int fd);
153 
155  DBusString *address,
156  DBusError *error);
157 
158 DBUS_PRIVATE_EXPORT
159 void _dbus_fd_set_close_on_exec (int fd);
160 
161 typedef enum
162 {
163  DBUS_FORCE_STDIN_NULL = (1 << 0),
164  DBUS_FORCE_STDOUT_NULL = (1 << 1),
165  DBUS_FORCE_STDERR_NULL = (1 << 2)
166 } DBusEnsureStandardFdsFlags;
167 
168 DBUS_PRIVATE_EXPORT
169 dbus_bool_t _dbus_ensure_standard_fds (DBusEnsureStandardFdsFlags flags,
170  const char **error_str_p);
171 
173 typedef void (* DBusSignalHandler) (int sig);
174 
175 void _dbus_set_signal_handler (int sig,
176  DBusSignalHandler handler);
177 
181 
182 #endif /* DBUS_SYSDEPS_UNIX_H */
char * username
Username.
DBUS_PRIVATE_EXPORT void _dbus_close_all(void)
Closes all file descriptors except the first three (i.e.
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
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 ...
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 ...
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.
dbus_gid_t primary_gid
GID.
DBUS_PRIVATE_EXPORT int _dbus_dup(int fd, DBusError *error)
Duplicates a file descriptor.
char * groupname
Group name.
dbus_bool_t _dbus_parse_uid(const DBusString *uid_str, dbus_uid_t *uid)
Gets a UID from a UID string.
dbus_bool_t _dbus_user_info_fill(DBusUserInfo *info, const DBusString *username, DBusError *error)
Gets user info for the given username.
void _dbus_set_signal_handler(int sig, DBusSignalHandler handler)
Installs a UNIX signal handler.
Socket interface.
Definition: dbus-sysdeps.h:178
dbus_gid_t * group_ids
Groups IDs, including above primary group.
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.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
int n_group_ids
Size of group IDs array.
DBUS_PRIVATE_EXPORT void _dbus_fd_clear_close_on_exec(int fd)
Sets the file descriptor to not be close-on-exec.
int _dbus_listen_systemd_sockets(DBusSocket **fd, DBusError *error)
Acquires one or more sockets passed in from systemd.
dbus_uid_t uid
UID.
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...
void _dbus_group_info_free(DBusGroupInfo *info)
Frees the members of info (but not info itself).
Definition: dbus-userdb.c:96
void _dbus_user_info_free(DBusUserInfo *info)
Frees the members of info (but not info itself)
Definition: dbus-userdb.c:83
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...
Object representing an exception.
Definition: dbus-errors.h:48
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. ...
DBUS_PRIVATE_EXPORT void _dbus_fd_set_all_close_on_exec(void)
Sets all file descriptors except the first three (i.e.
DBUS_PRIVATE_EXPORT dbus_uid_t _dbus_geteuid(void)
Gets our effective UID.
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...
char * homedir
Home directory.
Information about a UNIX group.
DBUS_PRIVATE_EXPORT void _dbus_fd_set_close_on_exec(int fd)
Sets the file descriptor to be close on exec.
dbus_bool_t _dbus_user_info_fill_uid(DBusUserInfo *info, dbus_uid_t uid, DBusError *error)
Gets user info for the given user ID.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_close(int fd, DBusError *error)
Closes a file descriptor.
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.
dbus_gid_t gid
GID.
void(* DBusSignalHandler)(int sig)
A UNIX signal handler.
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:136
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:134
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.
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.
Information about a UNIX user.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.