D-Bus: dbus-server-unix.c Source File

D-Bus 1.14.4

dbus-server-unix.c
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-server-unix.c Server implementation for Unix network protocols.
3 *
4 * Copyright (C) 2002, 2003, 2004 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23
24#include <config.h>
25#include "dbus-internals.h"
26#include "dbus-server-unix.h"
27#include "dbus-server-socket.h"
28#include "dbus-server-launchd.h"
29#include "dbus-transport-unix.h"
30#include "dbus-connection-internal.h"
31#include "dbus-sysdeps-unix.h"
32#include "dbus-string.h"
33
53DBusServerListenResult
54_dbus_server_listen_platform_specific (DBusAddressEntry *entry,
55 DBusServer **server_p,
56 DBusError *error)
57{
58 const char *method;
59
60 *server_p = NULL;
61
62 method = dbus_address_entry_get_method (entry);
63
64 if (strcmp (method, "unix") == 0)
65 {
66 const char *path = dbus_address_entry_get_value (entry, "path");
67 const char *dir = dbus_address_entry_get_value (entry, "dir");
68 const char *tmpdir = dbus_address_entry_get_value (entry, "tmpdir");
69 const char *abstract = dbus_address_entry_get_value (entry, "abstract");
70 const char *runtime = dbus_address_entry_get_value (entry, "runtime");
71 int mutually_exclusive_modes = 0;
72
73 mutually_exclusive_modes = (path != NULL) + (tmpdir != NULL) +
74 (abstract != NULL) + (runtime != NULL) + (dir != NULL);
75
76 if (mutually_exclusive_modes < 1)
77 {
78 _dbus_set_bad_address(error, "unix",
79 "path or tmpdir or abstract or runtime or dir",
80 NULL);
81 return DBUS_SERVER_LISTEN_BAD_ADDRESS;
82 }
83
84 if (mutually_exclusive_modes > 1)
85 {
86 _dbus_set_bad_address(error, NULL, NULL,
87 "cannot specify two of \"path\", \"tmpdir\", \"abstract\", \"runtime\" and \"dir\" at the same time");
88 return DBUS_SERVER_LISTEN_BAD_ADDRESS;
89 }
90
91 if (runtime != NULL)
92 {
93 DBusString full_path;
94 DBusString filename;
95 const char *runtimedir;
96
97 if (strcmp (runtime, "yes") != 0)
98 {
99 _dbus_set_bad_address(error, NULL, NULL,
100 "if given, the only value allowed for \"runtime\" is \"yes\"");
101 return DBUS_SERVER_LISTEN_BAD_ADDRESS;
102 }
103
104 runtimedir = _dbus_getenv ("XDG_RUNTIME_DIR");
105
106 if (runtimedir == NULL)
107 {
108 dbus_set_error (error,
109 DBUS_ERROR_NOT_SUPPORTED, "\"XDG_RUNTIME_DIR\" is not set");
110 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
111 }
112
113 _dbus_string_init_const (&filename, "bus");
114
115 if (!_dbus_string_init (&full_path))
116 {
117 _DBUS_SET_OOM (error);
118 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
119 }
120
121 if (!_dbus_string_append (&full_path, runtimedir) ||
122 !_dbus_concat_dir_and_file (&full_path, &filename))
123 {
124 _dbus_string_free (&full_path);
125 _DBUS_SET_OOM (error);
126 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
127 }
128
129 /* We can safely use filesystem sockets in the runtime directory,
130 * and they are preferred because they can be bind-mounted between
131 * Linux containers. */
132 *server_p = _dbus_server_new_for_domain_socket (
133 _dbus_string_get_const_data (&full_path),
134 FALSE, error);
135
136 _dbus_string_free (&full_path);
137 }
138 else if (tmpdir != NULL || dir != NULL)
139 {
140 DBusString full_path;
141 DBusString filename;
142
143 /* tmpdir is now equivalent to dir. Previously it would try to
144 * use an abstract socket. */
145 if (tmpdir != NULL)
146 dir = tmpdir;
147
148 if (!_dbus_string_init (&full_path))
149 {
150 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
151 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
152 }
153
154 if (!_dbus_string_init (&filename))
155 {
156 _dbus_string_free (&full_path);
157 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
158 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
159 }
160
161 if (!_dbus_string_append (&filename, "dbus-"))
162 {
163 _dbus_string_free (&full_path);
164 _dbus_string_free (&filename);
165 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
166 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
167 }
168
169 if (!_dbus_generate_random_ascii (&filename, 10, error))
170 {
171 _dbus_string_free (&full_path);
172 _dbus_string_free (&filename);
173 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
174 }
175
176 if (!_dbus_string_append (&full_path, dir) ||
177 !_dbus_concat_dir_and_file (&full_path, &filename))
178 {
179 _dbus_string_free (&full_path);
180 _dbus_string_free (&filename);
181 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
182 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
183 }
184
185 *server_p =
186 _dbus_server_new_for_domain_socket (_dbus_string_get_const_data (&full_path),
187 FALSE,
188 error);
189
190 _dbus_string_free (&full_path);
191 _dbus_string_free (&filename);
192 }
193 else
194 {
195 if (path)
196 *server_p = _dbus_server_new_for_domain_socket (path, FALSE, error);
197 else
198 *server_p = _dbus_server_new_for_domain_socket (abstract, TRUE, error);
199 }
200
201 if (*server_p != NULL)
202 {
203 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
204 return DBUS_SERVER_LISTEN_OK;
205 }
206 else
207 {
208 _DBUS_ASSERT_ERROR_IS_SET(error);
209 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
210 }
211 }
212 else if (strcmp (method, "systemd") == 0)
213 {
214 int i, n;
215 DBusSocket *fds;
216 DBusString address;
217
218 n = _dbus_listen_systemd_sockets (&fds, error);
219 if (n < 0)
220 {
221 _DBUS_ASSERT_ERROR_IS_SET (error);
222 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
223 }
224
225 if (!_dbus_string_init (&address))
226 goto systemd_oom;
227
228 for (i = 0; i < n; i++)
229 {
230 if (i > 0)
231 {
232 if (!_dbus_string_append (&address, ";"))
233 goto systemd_oom;
234 }
235 if (!_dbus_append_address_from_socket (fds[i], &address, error))
236 goto systemd_err;
237 }
238
239 *server_p = _dbus_server_new_for_socket (fds, n, &address, NULL, error);
240 if (*server_p == NULL)
241 goto systemd_err;
242
243 dbus_free (fds);
244 _dbus_string_free (&address);
245
246 return DBUS_SERVER_LISTEN_OK;
247
248 systemd_oom:
249 _DBUS_SET_OOM (error);
250 systemd_err:
251 for (i = 0; i < n; i++)
252 {
253 _dbus_close_socket (fds[i], NULL);
254 }
255 dbus_free (fds);
256 _dbus_string_free (&address);
257
258 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
259 }
260#ifdef DBUS_ENABLE_LAUNCHD
261 else if (strcmp (method, "launchd") == 0)
262 {
263 const char *launchd_env_var = dbus_address_entry_get_value (entry, "env");
264 if (launchd_env_var == NULL)
265 {
266 _dbus_set_bad_address (error, "launchd", "env", NULL);
267 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
268 }
269 *server_p = _dbus_server_new_for_launchd (launchd_env_var, error);
270
271 if (*server_p != NULL)
272 {
273 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
274 return DBUS_SERVER_LISTEN_OK;
275 }
276 else
277 {
278 _DBUS_ASSERT_ERROR_IS_SET(error);
279 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
280 }
281 }
282#endif
283 else
284 {
285 /* If we don't handle the method, we return NULL with the
286 * error unset
287 */
288 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
289 return DBUS_SERVER_LISTEN_NOT_HANDLED;
290 }
291}
292
301 DBusServer*
302_dbus_server_new_for_domain_socket (const char *path,
303 dbus_bool_t abstract,
304 DBusError *error)
305{
306 DBusServer *server;
307 DBusSocket listen_fd;
308 DBusString address;
309 char *path_copy;
310 DBusString path_str;
311
312 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
313
314 if (!_dbus_string_init (&address))
315 {
316 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
317 return NULL;
318 }
319
320 _dbus_string_init_const (&path_str, path);
321 if ((abstract &&
322 !_dbus_string_append (&address, "unix:abstract=")) ||
323 (!abstract &&
324 !_dbus_string_append (&address, "unix:path=")) ||
325 !_dbus_address_append_escaped (&address, &path_str))
326 {
327 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
328 goto failed_0;
329 }
330
331 if (abstract)
332 {
333 path_copy = NULL;
334 }
335 else
336 {
337 path_copy = _dbus_strdup (path);
338 if (path_copy == NULL)
339 {
340 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
341 goto failed_0;
342 }
343 }
344
345 listen_fd.fd = _dbus_listen_unix_socket (path, abstract, error);
346
347 if (listen_fd.fd < 0)
348 {
349 _DBUS_ASSERT_ERROR_IS_SET (error);
350 goto failed_1;
351 }
352
353 server = _dbus_server_new_for_socket (&listen_fd, 1, &address, 0, error);
354 if (server == NULL)
355 {
356 goto failed_2;
357 }
358
359 if (path_copy != NULL)
360 _dbus_server_socket_own_filename(server, path_copy);
361
362 _dbus_string_free (&address);
363
364 return server;
365
366 failed_2:
367 _dbus_close_socket (listen_fd, NULL);
368 failed_1:
369 dbus_free (path_copy);
370 failed_0:
371 _dbus_string_free (&address);
372
373 return NULL;
374}
375
_dbus_address_append_escaped
dbus_bool_t _dbus_address_append_escaped(DBusString *escaped, const DBusString *unescaped)
Appends an escaped version of one string to another string, using the D-Bus address escaping mechanis...
Definition: dbus-address.c:107
_dbus_set_bad_address
void _dbus_set_bad_address(DBusError *error, const char *address_problem_type, const char *address_problem_field, const char *address_problem_other)
Sets DBUS_ERROR_BAD_ADDRESS.
Definition: dbus-address.c:68
dbus_address_entry_get_method
const char * dbus_address_entry_get_method(DBusAddressEntry *entry)
Returns the method string of an address entry.
Definition: dbus-address.c:230
dbus_address_entry_get_value
const char * dbus_address_entry_get_value(DBusAddressEntry *entry, const char *key)
Returns a value from a key of an entry.
Definition: dbus-address.c:247
dbus_set_error
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:354
_dbus_strdup
char * _dbus_strdup(const char *str)
Duplicates a string.
Definition: dbus-internals.c:589
_dbus_generate_random_ascii
dbus_bool_t _dbus_generate_random_ascii(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of random bytes, where the bytes are chosen from the alphanumeric ASCII su...
Definition: dbus-sysdeps.c:559
NULL
#define NULL
A null pointer, defined appropriately for C or C++.
TRUE
#define TRUE
Expands to "1".
FALSE
#define FALSE
Expands to "0".
dbus_free
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:692
DBUS_ERROR_NOT_SUPPORTED
#define DBUS_ERROR_NOT_SUPPORTED
Requested operation isn't supported (like ENOSYS on UNIX).
Definition: dbus-protocol.h:373
DBUS_ERROR_NO_MEMORY
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
Definition: dbus-protocol.h:361
_dbus_server_new_for_launchd
DBusServer * _dbus_server_new_for_launchd(const char *launchd_env_var, DBusError *error)
Creates a new server from launchd.
Definition: dbus-server-launchd.c:67
_dbus_server_new_for_socket
DBusServer * _dbus_server_new_for_socket(DBusSocket *fds, int n_fds, const DBusString *address, DBusNonceFile *noncefile, DBusError *error)
Creates a new server listening on the given file descriptor.
Definition: dbus-server-socket.c:286
_dbus_server_socket_own_filename
void _dbus_server_socket_own_filename(DBusServer *server, char *filename)
This is a bad hack since it's really unix domain socket specific.
Definition: dbus-server-socket.c:591
_dbus_server_new_for_domain_socket
DBusServer * _dbus_server_new_for_domain_socket(const char *path, dbus_bool_t abstract, DBusError *error)
Creates a new server listening on the given Unix domain socket.
Definition: dbus-server-unix.c:302
_dbus_server_listen_platform_specific
DBusServerListenResult _dbus_server_listen_platform_specific(DBusAddressEntry *entry, DBusServer **server_p, DBusError *error)
Tries to interpret the address entry in a platform-specific way, creating a platform-specific server ...
Definition: dbus-server-unix.c:54
_dbus_string_append
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
Definition: dbus-string.c:966
_dbus_string_init
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:182
_dbus_string_init_const
void _dbus_string_init_const(DBusString *str, const char *value)
Initializes a constant string.
Definition: dbus-string.c:197
_dbus_string_free
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init(), and fills it with the same contents as #_DBUS_STRING_I...
Definition: dbus-string.c:278
_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_listen_systemd_sockets
int _dbus_listen_systemd_sockets(DBusSocket **fds, DBusError *error)
Acquires one or more sockets passed in from systemd.
Definition: dbus-sysdeps-unix.c:1271
_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:4875
_dbus_close_socket
dbus_bool_t _dbus_close_socket(DBusSocket fd, DBusError *error)
Closes a socket.
Definition: dbus-sysdeps-unix.c:286
_dbus_getenv
const char * _dbus_getenv(const char *varname)
Wrapper for getenv().
Definition: dbus-sysdeps.c:195
_dbus_concat_dir_and_file
dbus_bool_t _dbus_concat_dir_and_file(DBusString *dir, const DBusString *next_component)
Appends the given filename to the given directory.
Definition: dbus-sysdeps-unix.c:3336
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusAddressEntry
Internals of DBusAddressEntry.
Definition: dbus-address.c:47
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusServer
Internals of DBusServer object.
Definition: dbus-server-protected.h:57
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:181
DBusString
Definition: dbus-string.h:43