1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-sysdeps-unix.c Wrappers around UNIX system/libc features (internal to D-Bus implementation)
4 * Copyright (C) 2002, 2003, 2006 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 2.1
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.
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.
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
27 #include "dbus-internals.h"
28 #include "dbus-sysdeps.h"
29 #include "dbus-sysdeps-unix.h"
30 #include "dbus-threads.h"
31 #include "dbus-protocol.h"
32 #include "dbus-transport.h"
33 #include "dbus-string.h"
34 #include "dbus-userdb.h"
35 #include "dbus-list.h"
36 #include "dbus-credentials.h"
37 #include "dbus-nonce.h"
39 #include <sys/types.h>
46 #include <sys/socket.h>
55 #include <netinet/in.h>
71 #ifdef HAVE_GETPEERUCRED
79 #include "sd-daemon.h"
86 #define AI_ADDRCONFIG 0
89 #ifndef HAVE_SOCKLEN_T
94 _dbus_open_socket (int *fd_p,
101 dbus_bool_t cloexec_done;
103 *fd_p = socket (domain, type | SOCK_CLOEXEC, protocol);
104 cloexec_done = *fd_p >= 0;
106 /* Check if kernel seems to be too old to know SOCK_CLOEXEC */
107 if (*fd_p < 0 && errno == EINVAL)
110 *fd_p = socket (domain, type, protocol);
119 _dbus_fd_set_close_on_exec(*fd_p);
122 _dbus_verbose ("socket fd %d opened\n", *fd_p);
127 dbus_set_error(error,
128 _dbus_error_from_errno (errno),
129 "Failed to open socket: %s",
130 _dbus_strerror (errno));
136 _dbus_open_tcp_socket (int *fd,
139 return _dbus_open_socket(fd, AF_INET, SOCK_STREAM, 0, error);
143 * Opens a UNIX domain socket (as in the socket() call).
144 * Does not bind the socket.
146 * This will set FD_CLOEXEC for the socket returned
148 * @param fd return location for socket descriptor
149 * @param error return location for an error
150 * @returns #FALSE if error is set
153 _dbus_open_unix_socket (int *fd,
156 return _dbus_open_socket(fd, PF_UNIX, SOCK_STREAM, 0, error);
160 * Closes a socket. Should not be used on non-socket
161 * file descriptors or handles.
163 * @param fd the socket
164 * @param error return location for an error
165 * @returns #FALSE if error is set
168 _dbus_close_socket (int fd,
171 return _dbus_close (fd, error);
175 * Like _dbus_read(), but only works on sockets so is
176 * available on Windows.
178 * @param fd the socket
179 * @param buffer string to append data to
180 * @param count max amount of data to read
181 * @returns number of bytes appended to the string
184 _dbus_read_socket (int fd,
188 return _dbus_read (fd, buffer, count);
192 * Like _dbus_write(), but only supports sockets
193 * and is thus available on Windows.
195 * @param fd the file descriptor to write
196 * @param buffer the buffer to write data from
197 * @param start the first byte in the buffer to write
198 * @param len the number of bytes to try to write
199 * @returns the number of bytes written or -1 on error
202 _dbus_write_socket (int fd,
203 const DBusString *buffer,
207 #if HAVE_DECL_MSG_NOSIGNAL
211 data = _dbus_string_get_const_data_len (buffer, start, len);
215 bytes_written = send (fd, data, len, MSG_NOSIGNAL);
217 if (bytes_written < 0 && errno == EINTR)
220 return bytes_written;
223 return _dbus_write (fd, buffer, start, len);
228 * Like _dbus_read_socket() but also tries to read unix fds from the
229 * socket. When there are more fds to read than space in the array
230 * passed this function will fail with ENOSPC.
232 * @param fd the socket
233 * @param buffer string to append data to
234 * @param count max amount of data to read
235 * @param fds array to place read file descriptors in
236 * @param n_fds on input space in fds array, on output how many fds actually got read
237 * @returns number of bytes appended to string
240 _dbus_read_socket_with_unix_fds (int fd,
245 #ifndef HAVE_UNIX_FD_PASSING
248 if ((r = _dbus_read_socket(fd, buffer, count)) < 0)
260 _dbus_assert (count >= 0);
261 _dbus_assert (*n_fds >= 0);
263 start = _dbus_string_get_length (buffer);
265 if (!_dbus_string_lengthen (buffer, count))
272 iov.iov_base = _dbus_string_get_data_len (buffer, start, count);
279 /* Hmm, we have no clue how long the control data will actually be
280 that is queued for us. The least we can do is assume that the
281 caller knows. Hence let's make space for the number of fds that
282 we shall read at max plus the cmsg header. */
283 m.msg_controllen = CMSG_SPACE(*n_fds * sizeof(int));
285 /* It's probably safe to assume that systems with SCM_RIGHTS also
287 m.msg_control = alloca(m.msg_controllen);
288 memset(m.msg_control, 0, m.msg_controllen);
292 bytes_read = recvmsg(fd, &m, 0
293 #ifdef MSG_CMSG_CLOEXEC
304 /* put length back (note that this doesn't actually realloc anything) */
305 _dbus_string_set_length (buffer, start);
312 dbus_bool_t found = FALSE;
314 if (m.msg_flags & MSG_CTRUNC)
316 /* Hmm, apparently the control data was truncated. The bad
317 thing is that we might have completely lost a couple of fds
318 without chance to recover them. Hence let's treat this as a
322 _dbus_string_set_length (buffer, start);
326 for (cm = CMSG_FIRSTHDR(&m); cm; cm = CMSG_NXTHDR(&m, cm))
327 if (cm->cmsg_level == SOL_SOCKET && cm->cmsg_type == SCM_RIGHTS)
331 _dbus_assert(cm->cmsg_len <= CMSG_LEN(*n_fds * sizeof(int)));
332 *n_fds = (cm->cmsg_len - CMSG_LEN(0)) / sizeof(int);
334 memcpy(fds, CMSG_DATA(cm), *n_fds * sizeof(int));
337 /* Linux doesn't tell us whether MSG_CMSG_CLOEXEC actually
338 worked, hence we need to go through this list and set
339 CLOEXEC everywhere in any case */
340 for (i = 0; i < *n_fds; i++)
341 _dbus_fd_set_close_on_exec(fds[i]);
349 /* put length back (doesn't actually realloc) */
350 _dbus_string_set_length (buffer, start + bytes_read);
354 _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
363 _dbus_write_socket_with_unix_fds(int fd,
364 const DBusString *buffer,
370 #ifndef HAVE_UNIX_FD_PASSING
377 return _dbus_write_socket(fd, buffer, start, len);
379 return _dbus_write_socket_with_unix_fds_two(fd, buffer, start, len, NULL, 0, 0, fds, n_fds);
384 _dbus_write_socket_with_unix_fds_two(int fd,
385 const DBusString *buffer1,
388 const DBusString *buffer2,
394 #ifndef HAVE_UNIX_FD_PASSING
401 return _dbus_write_socket_two(fd,
402 buffer1, start1, len1,
403 buffer2, start2, len2);
411 _dbus_assert (len1 >= 0);
412 _dbus_assert (len2 >= 0);
413 _dbus_assert (n_fds >= 0);
416 iov[0].iov_base = (char*) _dbus_string_get_const_data_len (buffer1, start1, len1);
417 iov[0].iov_len = len1;
421 iov[1].iov_base = (char*) _dbus_string_get_const_data_len (buffer2, start2, len2);
422 iov[1].iov_len = len2;
427 m.msg_iovlen = buffer2 ? 2 : 1;
431 m.msg_controllen = CMSG_SPACE(n_fds * sizeof(int));
432 m.msg_control = alloca(m.msg_controllen);
433 memset(m.msg_control, 0, m.msg_controllen);
435 cm = CMSG_FIRSTHDR(&m);
436 cm->cmsg_level = SOL_SOCKET;
437 cm->cmsg_type = SCM_RIGHTS;
438 cm->cmsg_len = CMSG_LEN(n_fds * sizeof(int));
439 memcpy(CMSG_DATA(cm), fds, n_fds * sizeof(int));
444 bytes_written = sendmsg (fd, &m, 0
445 #if HAVE_DECL_MSG_NOSIGNAL
450 if (bytes_written < 0 && errno == EINTR)
454 if (bytes_written > 0)
455 _dbus_verbose_bytes_of_string (buffer, start, bytes_written);
458 return bytes_written;
463 * Like _dbus_write_two() but only works on sockets and is thus
464 * available on Windows.
466 * @param fd the file descriptor
467 * @param buffer1 first buffer
468 * @param start1 first byte to write in first buffer
469 * @param len1 number of bytes to write from first buffer
470 * @param buffer2 second buffer, or #NULL
471 * @param start2 first byte to write in second buffer
472 * @param len2 number of bytes to write in second buffer
473 * @returns total bytes written from both buffers, or -1 on error
476 _dbus_write_socket_two (int fd,
477 const DBusString *buffer1,
480 const DBusString *buffer2,
484 #if HAVE_DECL_MSG_NOSIGNAL
485 struct iovec vectors[2];
491 _dbus_assert (buffer1 != NULL);
492 _dbus_assert (start1 >= 0);
493 _dbus_assert (start2 >= 0);
494 _dbus_assert (len1 >= 0);
495 _dbus_assert (len2 >= 0);
497 data1 = _dbus_string_get_const_data_len (buffer1, start1, len1);
500 data2 = _dbus_string_get_const_data_len (buffer2, start2, len2);
508 vectors[0].iov_base = (char*) data1;
509 vectors[0].iov_len = len1;
510 vectors[1].iov_base = (char*) data2;
511 vectors[1].iov_len = len2;
515 m.msg_iovlen = data2 ? 2 : 1;
519 bytes_written = sendmsg (fd, &m, MSG_NOSIGNAL);
521 if (bytes_written < 0 && errno == EINTR)
524 return bytes_written;
527 return _dbus_write_two (fd, buffer1, start1, len1,
528 buffer2, start2, len2);
533 _dbus_socket_is_invalid (int fd)
535 return fd < 0 ? TRUE : FALSE;
539 * Thin wrapper around the read() system call that appends
540 * the data it reads to the DBusString buffer. It appends
541 * up to the given count, and returns the same value
542 * and same errno as read(). The only exception is that
543 * _dbus_read() handles EINTR for you. Also, _dbus_read() can
544 * return ENOMEM, even though regular UNIX read doesn't.
546 * Unlike _dbus_read_socket(), _dbus_read() is not available
549 * @param fd the file descriptor to read from
550 * @param buffer the buffer to append data to
551 * @param count the amount of data to read
552 * @returns the number of bytes read or -1
563 _dbus_assert (count >= 0);
565 start = _dbus_string_get_length (buffer);
567 if (!_dbus_string_lengthen (buffer, count))
573 data = _dbus_string_get_data_len (buffer, start, count);
577 bytes_read = read (fd, data, count);
585 /* put length back (note that this doesn't actually realloc anything) */
586 _dbus_string_set_length (buffer, start);
592 /* put length back (doesn't actually realloc) */
593 _dbus_string_set_length (buffer, start + bytes_read);
597 _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
605 * Thin wrapper around the write() system call that writes a part of a
606 * DBusString and handles EINTR for you.
608 * @param fd the file descriptor to write
609 * @param buffer the buffer to write data from
610 * @param start the first byte in the buffer to write
611 * @param len the number of bytes to try to write
612 * @returns the number of bytes written or -1 on error
616 const DBusString *buffer,
623 data = _dbus_string_get_const_data_len (buffer, start, len);
627 bytes_written = write (fd, data, len);
629 if (bytes_written < 0 && errno == EINTR)
633 if (bytes_written > 0)
634 _dbus_verbose_bytes_of_string (buffer, start, bytes_written);
637 return bytes_written;
641 * Like _dbus_write() but will use writev() if possible
642 * to write both buffers in sequence. The return value
643 * is the number of bytes written in the first buffer,
644 * plus the number written in the second. If the first
645 * buffer is written successfully and an error occurs
646 * writing the second, the number of bytes in the first
647 * is returned (i.e. the error is ignored), on systems that
648 * don't have writev. Handles EINTR for you.
649 * The second buffer may be #NULL.
651 * @param fd the file descriptor
652 * @param buffer1 first buffer
653 * @param start1 first byte to write in first buffer
654 * @param len1 number of bytes to write from first buffer
655 * @param buffer2 second buffer, or #NULL
656 * @param start2 first byte to write in second buffer
657 * @param len2 number of bytes to write in second buffer
658 * @returns total bytes written from both buffers, or -1 on error
661 _dbus_write_two (int fd,
662 const DBusString *buffer1,
665 const DBusString *buffer2,
669 _dbus_assert (buffer1 != NULL);
670 _dbus_assert (start1 >= 0);
671 _dbus_assert (start2 >= 0);
672 _dbus_assert (len1 >= 0);
673 _dbus_assert (len2 >= 0);
677 struct iovec vectors[2];
682 data1 = _dbus_string_get_const_data_len (buffer1, start1, len1);
685 data2 = _dbus_string_get_const_data_len (buffer2, start2, len2);
693 vectors[0].iov_base = (char*) data1;
694 vectors[0].iov_len = len1;
695 vectors[1].iov_base = (char*) data2;
696 vectors[1].iov_len = len2;
700 bytes_written = writev (fd,
704 if (bytes_written < 0 && errno == EINTR)
707 return bytes_written;
709 #else /* HAVE_WRITEV */
713 ret1 = _dbus_write (fd, buffer1, start1, len1);
714 if (ret1 == len1 && buffer2 != NULL)
716 ret2 = _dbus_write (fd, buffer2, start2, len2);
718 ret2 = 0; /* we can't report an error as the first write was OK */
725 #endif /* !HAVE_WRITEV */
728 #define _DBUS_MAX_SUN_PATH_LENGTH 99
731 * @def _DBUS_MAX_SUN_PATH_LENGTH
733 * Maximum length of the path to a UNIX domain socket,
734 * sockaddr_un::sun_path member. POSIX requires that all systems
735 * support at least 100 bytes here, including the nul termination.
736 * We use 99 for the max value to allow for the nul.
738 * We could probably also do sizeof (addr.sun_path)
739 * but this way we are the same on all platforms
740 * which is probably a good idea.
744 * Creates a socket and connects it to the UNIX domain socket at the
745 * given path. The connection fd is returned, and is set up as
748 * Uses abstract sockets instead of filesystem-linked sockets if
749 * requested (it's possible only on Linux; see "man 7 unix" on Linux).
750 * On non-Linux abstract socket usage always fails.
752 * This will set FD_CLOEXEC for the socket returned.
754 * @param path the path to UNIX domain socket
755 * @param abstract #TRUE to use abstract namespace
756 * @param error return location for error code
757 * @returns connection file descriptor or -1 on error
760 _dbus_connect_unix_socket (const char *path,
761 dbus_bool_t abstract,
766 struct sockaddr_un addr;
768 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
770 _dbus_verbose ("connecting to unix socket %s abstract=%d\n",
774 if (!_dbus_open_unix_socket (&fd, error))
776 _DBUS_ASSERT_ERROR_IS_SET(error);
779 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
782 addr.sun_family = AF_UNIX;
783 path_len = strlen (path);
787 #ifdef HAVE_ABSTRACT_SOCKETS
788 addr.sun_path[0] = '\0'; /* this is what says "use abstract" */
789 path_len++; /* Account for the extra nul byte added to the start of sun_path */
791 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
793 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
794 "Abstract socket name too long\n");
795 _dbus_close (fd, NULL);
799 strncpy (&addr.sun_path[1], path, path_len);
800 /* _dbus_verbose_bytes (addr.sun_path, sizeof (addr.sun_path)); */
801 #else /* HAVE_ABSTRACT_SOCKETS */
802 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED,
803 "Operating system does not support abstract socket namespace\n");
804 _dbus_close (fd, NULL);
806 #endif /* ! HAVE_ABSTRACT_SOCKETS */
810 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
812 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
813 "Socket name too long\n");
814 _dbus_close (fd, NULL);
818 strncpy (addr.sun_path, path, path_len);
821 if (connect (fd, (struct sockaddr*) &addr, _DBUS_STRUCT_OFFSET (struct sockaddr_un, sun_path) + path_len) < 0)
823 dbus_set_error (error,
824 _dbus_error_from_errno (errno),
825 "Failed to connect to socket %s: %s",
826 path, _dbus_strerror (errno));
828 _dbus_close (fd, NULL);
834 if (!_dbus_set_fd_nonblocking (fd, error))
836 _DBUS_ASSERT_ERROR_IS_SET (error);
838 _dbus_close (fd, NULL);
848 * Enables or disables the reception of credentials on the given socket during
849 * the next message transmission. This is only effective if the #LOCAL_CREDS
850 * system feature exists, in which case the other side of the connection does
851 * not have to do anything special to send the credentials.
853 * @param fd socket on which to change the #LOCAL_CREDS flag.
854 * @param on whether to enable or disable the #LOCAL_CREDS flag.
857 _dbus_set_local_creds (int fd, dbus_bool_t on)
859 dbus_bool_t retval = TRUE;
861 #if defined(HAVE_CMSGCRED)
862 /* NOOP just to make sure only one codepath is used
863 * and to prefer CMSGCRED
865 #elif defined(LOCAL_CREDS)
866 int val = on ? 1 : 0;
867 if (setsockopt (fd, 0, LOCAL_CREDS, &val, sizeof (val)) < 0)
869 _dbus_verbose ("Unable to set LOCAL_CREDS socket option on fd %d\n", fd);
873 _dbus_verbose ("LOCAL_CREDS %s for further messages on fd %d\n",
874 on ? "enabled" : "disabled", fd);
881 * Creates a socket and binds it to the given path,
882 * then listens on the socket. The socket is
883 * set to be nonblocking.
885 * Uses abstract sockets instead of filesystem-linked
886 * sockets if requested (it's possible only on Linux;
887 * see "man 7 unix" on Linux).
888 * On non-Linux abstract socket usage always fails.
890 * This will set FD_CLOEXEC for the socket returned
892 * @param path the socket name
893 * @param abstract #TRUE to use abstract namespace
894 * @param error return location for errors
895 * @returns the listening file descriptor or -1 on error
898 _dbus_listen_unix_socket (const char *path,
899 dbus_bool_t abstract,
903 struct sockaddr_un addr;
905 unsigned int reuseaddr;
907 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
909 _dbus_verbose ("listening on unix socket %s abstract=%d\n",
912 if (!_dbus_open_unix_socket (&listen_fd, error))
914 _DBUS_ASSERT_ERROR_IS_SET(error);
917 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
920 addr.sun_family = AF_UNIX;
921 path_len = strlen (path);
925 #ifdef HAVE_ABSTRACT_SOCKETS
926 /* remember that abstract names aren't nul-terminated so we rely
927 * on sun_path being filled in with zeroes above.
929 addr.sun_path[0] = '\0'; /* this is what says "use abstract" */
930 path_len++; /* Account for the extra nul byte added to the start of sun_path */
932 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
934 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
935 "Abstract socket name too long\n");
936 _dbus_close (listen_fd, NULL);
940 strncpy (&addr.sun_path[1], path, path_len);
941 /* _dbus_verbose_bytes (addr.sun_path, sizeof (addr.sun_path)); */
942 #else /* HAVE_ABSTRACT_SOCKETS */
943 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED,
944 "Operating system does not support abstract socket namespace\n");
945 _dbus_close (listen_fd, NULL);
947 #endif /* ! HAVE_ABSTRACT_SOCKETS */
951 /* Discussed security implications of this with Nalin,
952 * and we couldn't think of where it would kick our ass, but
953 * it still seems a bit sucky. It also has non-security suckage;
954 * really we'd prefer to exit if the socket is already in use.
955 * But there doesn't seem to be a good way to do this.
957 * Just to be extra careful, I threw in the stat() - clearly
958 * the stat() can't *fix* any security issue, but it at least
959 * avoids inadvertent/accidental data loss.
964 if (stat (path, &sb) == 0 &&
965 S_ISSOCK (sb.st_mode))
969 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
971 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
972 "Abstract socket name too long\n");
973 _dbus_close (listen_fd, NULL);
977 strncpy (addr.sun_path, path, path_len);
981 if (setsockopt (listen_fd, SOL_SOCKET, SO_REUSEADDR, &reuseaddr, sizeof(reuseaddr))==-1)
983 _dbus_warn ("Failed to set socket option\"%s\": %s",
984 path, _dbus_strerror (errno));
987 if (bind (listen_fd, (struct sockaddr*) &addr, _DBUS_STRUCT_OFFSET (struct sockaddr_un, sun_path) + path_len) < 0)
989 dbus_set_error (error, _dbus_error_from_errno (errno),
990 "Failed to bind socket \"%s\": %s",
991 path, _dbus_strerror (errno));
992 _dbus_close (listen_fd, NULL);
996 if (listen (listen_fd, 30 /* backlog */) < 0)
998 dbus_set_error (error, _dbus_error_from_errno (errno),
999 "Failed to listen on socket \"%s\": %s",
1000 path, _dbus_strerror (errno));
1001 _dbus_close (listen_fd, NULL);
1005 if (!_dbus_set_local_creds (listen_fd, TRUE))
1007 dbus_set_error (error, _dbus_error_from_errno (errno),
1008 "Failed to enable LOCAL_CREDS on socket \"%s\": %s",
1009 path, _dbus_strerror (errno));
1014 if (!_dbus_set_fd_nonblocking (listen_fd, error))
1016 _DBUS_ASSERT_ERROR_IS_SET (error);
1017 _dbus_close (listen_fd, NULL);
1021 /* Try opening up the permissions, but if we can't, just go ahead
1022 * and continue, maybe it will be good enough.
1024 if (!abstract && chmod (path, 0777) < 0)
1025 _dbus_warn ("Could not set mode 0777 on socket %s\n",
1032 * Acquires one or more sockets passed in from systemd. The sockets
1033 * are set to be nonblocking.
1035 * This will set FD_CLOEXEC for the sockets returned.
1037 * @oaram fds the file descriptors
1038 * @param error return location for errors
1039 * @returns the number of file descriptors
1042 _dbus_listen_systemd_sockets (int **fds,
1049 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1051 n = sd_listen_fds (TRUE);
1054 dbus_set_error (error, _dbus_error_from_errno (-n),
1055 "Failed to acquire systemd socket: %s",
1056 _dbus_strerror (-n));
1062 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
1063 "No socket received.");
1067 for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + n; fd ++)
1069 r = sd_is_socket (fd, AF_UNSPEC, SOCK_STREAM, 1);
1072 dbus_set_error (error, _dbus_error_from_errno (-r),
1073 "Failed to verify systemd socket type: %s",
1074 _dbus_strerror (-r));
1080 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
1081 "Passed socket has wrong type.");
1086 /* OK, the file descriptors are all good, so let's take posession of
1089 new_fds = dbus_new (int, n);
1092 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1093 "Failed to allocate file handle array.");
1097 for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + n; fd ++)
1099 if (!_dbus_set_local_creds (fd, TRUE))
1101 dbus_set_error (error, _dbus_error_from_errno (errno),
1102 "Failed to enable LOCAL_CREDS on systemd socket: %s",
1103 _dbus_strerror (errno));
1107 if (!_dbus_set_fd_nonblocking (fd, error))
1109 _DBUS_ASSERT_ERROR_IS_SET (error);
1113 new_fds[fd - SD_LISTEN_FDS_START] = fd;
1121 for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + n; fd ++)
1123 _dbus_close (fd, NULL);
1126 dbus_free (new_fds);
1131 * Creates a socket and connects to a socket at the given host
1132 * and port. The connection fd is returned, and is set up as
1135 * This will set FD_CLOEXEC for the socket returned
1137 * @param host the host name to connect to
1138 * @param port the port to connect to
1139 * @param family the address family to listen on, NULL for all
1140 * @param error return location for error code
1141 * @returns connection file descriptor or -1 on error
1144 _dbus_connect_tcp_socket (const char *host,
1149 return _dbus_connect_tcp_socket_with_nonce (host, port, family, (const char*)NULL, error);
1153 _dbus_connect_tcp_socket_with_nonce (const char *host,
1156 const char *noncefile,
1159 int saved_errno = 0;
1161 struct addrinfo hints;
1162 struct addrinfo *ai, *tmp;
1164 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
1169 hints.ai_family = AF_UNSPEC;
1170 else if (!strcmp(family, "ipv4"))
1171 hints.ai_family = AF_INET;
1172 else if (!strcmp(family, "ipv6"))
1173 hints.ai_family = AF_INET6;
1176 dbus_set_error (error,
1177 DBUS_ERROR_BAD_ADDRESS,
1178 "Unknown address family %s", family);
1181 hints.ai_protocol = IPPROTO_TCP;
1182 hints.ai_socktype = SOCK_STREAM;
1183 hints.ai_flags = AI_ADDRCONFIG;
1185 if ((res = getaddrinfo(host, port, &hints, &ai)) != 0)
1187 dbus_set_error (error,
1188 _dbus_error_from_errno (errno),
1189 "Failed to lookup host/port: \"%s:%s\": %s (%d)",
1190 host, port, gai_strerror(res), res);
1191 _dbus_close (fd, NULL);
1198 if (!_dbus_open_socket (&fd, tmp->ai_family, SOCK_STREAM, 0, error))
1201 _DBUS_ASSERT_ERROR_IS_SET(error);
1204 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
1206 if (connect (fd, (struct sockaddr*) tmp->ai_addr, tmp->ai_addrlen) < 0)
1208 saved_errno = errno;
1209 _dbus_close(fd, NULL);
1221 dbus_set_error (error,
1222 _dbus_error_from_errno (saved_errno),
1223 "Failed to connect to socket \"%s:%s\" %s",
1224 host, port, _dbus_strerror(saved_errno));
1228 if (noncefile != NULL)
1230 DBusString noncefileStr;
1232 _dbus_string_init_const (&noncefileStr, noncefile);
1233 ret = _dbus_send_nonce (fd, &noncefileStr, error);
1234 _dbus_string_free (&noncefileStr);
1238 _dbus_close (fd, NULL);
1243 if (!_dbus_set_fd_nonblocking (fd, error))
1245 _dbus_close (fd, NULL);
1253 * Creates a socket and binds it to the given path, then listens on
1254 * the socket. The socket is set to be nonblocking. In case of port=0
1255 * a random free port is used and returned in the port parameter.
1256 * If inaddr_any is specified, the hostname is ignored.
1258 * This will set FD_CLOEXEC for the socket returned
1260 * @param host the host name to listen on
1261 * @param port the port to listen on, if zero a free port will be used
1262 * @param family the address family to listen on, NULL for all
1263 * @param retport string to return the actual port listened on
1264 * @param fds_p location to store returned file descriptors
1265 * @param error return location for errors
1266 * @returns the number of listening file descriptors or -1 on error
1269 _dbus_listen_tcp_socket (const char *host,
1272 DBusString *retport,
1277 int nlisten_fd = 0, *listen_fd = NULL, res, i;
1278 struct addrinfo hints;
1279 struct addrinfo *ai, *tmp;
1280 unsigned int reuseaddr;
1283 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1288 hints.ai_family = AF_UNSPEC;
1289 else if (!strcmp(family, "ipv4"))
1290 hints.ai_family = AF_INET;
1291 else if (!strcmp(family, "ipv6"))
1292 hints.ai_family = AF_INET6;
1295 dbus_set_error (error,
1296 DBUS_ERROR_BAD_ADDRESS,
1297 "Unknown address family %s", family);
1301 hints.ai_protocol = IPPROTO_TCP;
1302 hints.ai_socktype = SOCK_STREAM;
1303 hints.ai_flags = AI_ADDRCONFIG | AI_PASSIVE;
1305 redo_lookup_with_port:
1306 if ((res = getaddrinfo(host, port, &hints, &ai)) != 0 || !ai)
1308 dbus_set_error (error,
1309 _dbus_error_from_errno (errno),
1310 "Failed to lookup host/port: \"%s:%s\": %s (%d)",
1311 host ? host : "*", port, gai_strerror(res), res);
1318 int fd = -1, *newlisten_fd;
1319 if (!_dbus_open_socket (&fd, tmp->ai_family, SOCK_STREAM, 0, error))
1321 _DBUS_ASSERT_ERROR_IS_SET(error);
1324 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
1327 if (setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &reuseaddr, sizeof(reuseaddr))==-1)
1329 _dbus_warn ("Failed to set socket option \"%s:%s\": %s",
1330 host ? host : "*", port, _dbus_strerror (errno));
1333 if (bind (fd, (struct sockaddr*) tmp->ai_addr, tmp->ai_addrlen) < 0)
1335 saved_errno = errno;
1336 _dbus_close(fd, NULL);
1337 if (saved_errno == EADDRINUSE)
1339 /* Depending on kernel policy, it may or may not
1340 be neccessary to bind to both IPv4 & 6 addresses
1341 so ignore EADDRINUSE here */
1345 dbus_set_error (error, _dbus_error_from_errno (saved_errno),
1346 "Failed to bind socket \"%s:%s\": %s",
1347 host ? host : "*", port, _dbus_strerror (saved_errno));
1351 if (listen (fd, 30 /* backlog */) < 0)
1353 saved_errno = errno;
1354 _dbus_close (fd, NULL);
1355 dbus_set_error (error, _dbus_error_from_errno (saved_errno),
1356 "Failed to listen on socket \"%s:%s\": %s",
1357 host ? host : "*", port, _dbus_strerror (saved_errno));
1361 newlisten_fd = dbus_realloc(listen_fd, sizeof(int)*(nlisten_fd+1));
1364 saved_errno = errno;
1365 _dbus_close (fd, NULL);
1366 dbus_set_error (error, _dbus_error_from_errno (saved_errno),
1367 "Failed to allocate file handle array: %s",
1368 _dbus_strerror (saved_errno));
1371 listen_fd = newlisten_fd;
1372 listen_fd[nlisten_fd] = fd;
1375 if (!_dbus_string_get_length(retport))
1377 /* If the user didn't specify a port, or used 0, then
1378 the kernel chooses a port. After the first address
1379 is bound to, we need to force all remaining addresses
1380 to use the same port */
1381 if (!port || !strcmp(port, "0"))
1384 struct sockaddr_storage addr;
1388 addrlen = sizeof(addr);
1389 result = getsockname(fd, (struct sockaddr*) &addr, &addrlen);
1392 (res = getnameinfo ((struct sockaddr*)&addr, addrlen, NULL, 0,
1393 portbuf, sizeof(portbuf),
1394 NI_NUMERICHOST)) != 0)
1396 dbus_set_error (error, _dbus_error_from_errno (errno),
1397 "Failed to resolve port \"%s:%s\": %s (%s)",
1398 host ? host : "*", port, gai_strerror(res), res);
1401 if (!_dbus_string_append(retport, portbuf))
1403 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1407 /* Release current address list & redo lookup */
1408 port = _dbus_string_get_const_data(retport);
1410 goto redo_lookup_with_port;
1414 if (!_dbus_string_append(retport, port))
1416 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1430 dbus_set_error (error, _dbus_error_from_errno (errno),
1431 "Failed to bind socket \"%s:%s\": %s",
1432 host ? host : "*", port, _dbus_strerror (errno));
1436 for (i = 0 ; i < nlisten_fd ; i++)
1438 if (!_dbus_set_fd_nonblocking (listen_fd[i], error))
1451 for (i = 0 ; i < nlisten_fd ; i++)
1452 _dbus_close(listen_fd[i], NULL);
1453 dbus_free(listen_fd);
1458 write_credentials_byte (int server_fd,
1462 char buf[1] = { '\0' };
1463 #if defined(HAVE_CMSGCRED)
1466 char cred[CMSG_SPACE (sizeof (struct cmsgcred))];
1477 msg.msg_control = (caddr_t) &cmsg;
1478 msg.msg_controllen = CMSG_SPACE (sizeof (struct cmsgcred));
1480 cmsg.hdr.cmsg_len = CMSG_LEN (sizeof (struct cmsgcred));
1481 cmsg.hdr.cmsg_level = SOL_SOCKET;
1482 cmsg.hdr.cmsg_type = SCM_CREDS;
1485 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1489 #if defined(HAVE_CMSGCRED)
1490 bytes_written = sendmsg (server_fd, &msg, 0
1491 #if HAVE_DECL_MSG_NOSIGNAL
1496 bytes_written = send (server_fd, buf, 1, 0
1497 #if HAVE_DECL_MSG_NOSIGNAL
1503 if (bytes_written < 0 && errno == EINTR)
1506 if (bytes_written < 0)
1508 dbus_set_error (error, _dbus_error_from_errno (errno),
1509 "Failed to write credentials byte: %s",
1510 _dbus_strerror (errno));
1513 else if (bytes_written == 0)
1515 dbus_set_error (error, DBUS_ERROR_IO_ERROR,
1516 "wrote zero bytes writing credentials byte");
1521 _dbus_assert (bytes_written == 1);
1522 _dbus_verbose ("wrote credentials byte\n");
1528 * Reads a single byte which must be nul (an error occurs otherwise),
1529 * and reads unix credentials if available. Clears the credentials
1530 * object, then adds pid/uid if available, so any previous credentials
1531 * stored in the object are lost.
1533 * Return value indicates whether a byte was read, not whether
1534 * we got valid credentials. On some systems, such as Linux,
1535 * reading/writing the byte isn't actually required, but we do it
1536 * anyway just to avoid multiple codepaths.
1538 * Fails if no byte is available, so you must select() first.
1540 * The point of the byte is that on some systems we have to
1541 * use sendmsg()/recvmsg() to transmit credentials.
1543 * @param client_fd the client file descriptor
1544 * @param credentials object to add client credentials to
1545 * @param error location to store error code
1546 * @returns #TRUE on success
1549 _dbus_read_credentials_socket (int client_fd,
1550 DBusCredentials *credentials,
1556 dbus_uid_t uid_read;
1557 dbus_pid_t pid_read;
1560 #ifdef HAVE_CMSGCRED
1563 char cred[CMSG_SPACE (sizeof (struct cmsgcred))];
1566 #elif defined(LOCAL_CREDS)
1569 struct sockcred cred;
1573 uid_read = DBUS_UID_UNSET;
1574 pid_read = DBUS_PID_UNSET;
1576 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1578 /* The POSIX spec certainly doesn't promise this, but
1579 * we need these assertions to fail as soon as we're wrong about
1580 * it so we can do the porting fixups
1582 _dbus_assert (sizeof (pid_t) <= sizeof (dbus_pid_t));
1583 _dbus_assert (sizeof (uid_t) <= sizeof (dbus_uid_t));
1584 _dbus_assert (sizeof (gid_t) <= sizeof (dbus_gid_t));
1586 _dbus_credentials_clear (credentials);
1588 /* Systems supporting LOCAL_CREDS are configured to have this feature
1589 * enabled (if it does not conflict with HAVE_CMSGCRED) prior accepting
1590 * the connection. Therefore, the received message must carry the
1591 * credentials information without doing anything special.
1594 iov.iov_base = &buf;
1601 #if defined(HAVE_CMSGCRED) || defined(LOCAL_CREDS)
1603 msg.msg_control = (caddr_t) &cmsg;
1604 msg.msg_controllen = CMSG_SPACE (sizeof (struct cmsgcred));
1608 bytes_read = recvmsg (client_fd, &msg, 0);
1615 /* EAGAIN or EWOULDBLOCK would be unexpected here since we would
1616 * normally only call read_credentials if the socket was ready
1620 dbus_set_error (error, _dbus_error_from_errno (errno),
1621 "Failed to read credentials byte: %s",
1622 _dbus_strerror (errno));
1625 else if (bytes_read == 0)
1627 /* this should not happen unless we are using recvmsg wrong,
1628 * so is essentially here for paranoia
1630 dbus_set_error (error, DBUS_ERROR_FAILED,
1631 "Failed to read credentials byte (zero-length read)");
1634 else if (buf != '\0')
1636 dbus_set_error (error, DBUS_ERROR_FAILED,
1637 "Credentials byte was not nul");
1641 #if defined(HAVE_CMSGCRED) || defined(LOCAL_CREDS)
1642 if (cmsg.hdr.cmsg_len < CMSG_LEN (sizeof (struct cmsgcred))
1643 || cmsg.hdr.cmsg_type != SCM_CREDS)
1645 dbus_set_error (error, DBUS_ERROR_FAILED,
1646 "Message from recvmsg() was not SCM_CREDS");
1651 _dbus_verbose ("read credentials byte\n");
1656 struct sockpeercred cr;
1660 int cr_len = sizeof (cr);
1662 if (getsockopt (client_fd, SOL_SOCKET, SO_PEERCRED, &cr, &cr_len) == 0 &&
1663 cr_len == sizeof (cr))
1670 _dbus_verbose ("Failed to getsockopt() credentials, returned len %d/%d: %s\n",
1671 cr_len, (int) sizeof (cr), _dbus_strerror (errno));
1673 #elif defined(HAVE_CMSGCRED)
1674 struct cmsgcred *cred;
1676 cred = (struct cmsgcred *) CMSG_DATA (&cmsg.hdr);
1677 pid_read = cred->cmcred_pid;
1678 uid_read = cred->cmcred_euid;
1679 #elif defined(LOCAL_CREDS)
1680 pid_read = DBUS_PID_UNSET;
1681 uid_read = cmsg.cred.sc_uid;
1682 /* Since we have already got the credentials from this socket, we can
1683 * disable its LOCAL_CREDS flag if it was ever set. */
1684 _dbus_set_local_creds (client_fd, FALSE);
1685 #elif defined(HAVE_GETPEEREID)
1688 if (getpeereid (client_fd, &euid, &egid) == 0)
1694 _dbus_verbose ("Failed to getpeereid() credentials: %s\n", _dbus_strerror (errno));
1696 #elif defined(HAVE_GETPEERUCRED)
1697 ucred_t * ucred = NULL;
1698 if (getpeerucred (client_fd, &ucred) == 0)
1700 pid_read = ucred_getpid (ucred);
1701 uid_read = ucred_geteuid (ucred);
1703 /* generate audit session data based on socket ucred */
1704 adt_session_data_t *adth = NULL;
1705 adt_export_data_t *data = NULL;
1707 if (adt_start_session (&adth, NULL, 0) || (adth == NULL))
1709 _dbus_verbose ("Failed to adt_start_session(): %s\n", _dbus_strerror (errno));
1713 if (adt_set_from_ucred (adth, ucred, ADT_NEW))
1715 _dbus_verbose ("Failed to adt_set_from_ucred(): %s\n", _dbus_strerror (errno));
1719 size = adt_export_session_data (adth, &data);
1722 _dbus_verbose ("Failed to adt_export_session_data(): %s\n", _dbus_strerror (errno));
1726 _dbus_credentials_add_adt_audit_data (credentials, data, size);
1730 (void) adt_end_session (adth);
1732 #endif /* HAVE_ADT */
1736 _dbus_verbose ("Failed to getpeerucred() credentials: %s\n", _dbus_strerror (errno));
1740 #else /* !SO_PEERCRED && !HAVE_CMSGCRED && !HAVE_GETPEEREID && !HAVE_GETPEERUCRED */
1741 _dbus_verbose ("Socket credentials not supported on this OS\n");
1745 _dbus_verbose ("Credentials:"
1746 " pid "DBUS_PID_FORMAT
1747 " uid "DBUS_UID_FORMAT
1752 if (pid_read != DBUS_PID_UNSET)
1754 if (!_dbus_credentials_add_unix_pid (credentials, pid_read))
1756 _DBUS_SET_OOM (error);
1761 if (uid_read != DBUS_UID_UNSET)
1763 if (!_dbus_credentials_add_unix_uid (credentials, uid_read))
1765 _DBUS_SET_OOM (error);
1774 * Sends a single nul byte with our UNIX credentials as ancillary
1775 * data. Returns #TRUE if the data was successfully written. On
1776 * systems that don't support sending credentials, just writes a byte,
1777 * doesn't send any credentials. On some systems, such as Linux,
1778 * reading/writing the byte isn't actually required, but we do it
1779 * anyway just to avoid multiple codepaths.
1781 * Fails if no byte can be written, so you must select() first.
1783 * The point of the byte is that on some systems we have to
1784 * use sendmsg()/recvmsg() to transmit credentials.
1786 * @param server_fd file descriptor for connection to server
1787 * @param error return location for error code
1788 * @returns #TRUE if the byte was sent
1791 _dbus_send_credentials_socket (int server_fd,
1794 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1796 if (write_credentials_byte (server_fd, error))
1803 * Accepts a connection on a listening socket.
1804 * Handles EINTR for you.
1806 * This will enable FD_CLOEXEC for the returned socket.
1808 * @param listen_fd the listen file descriptor
1809 * @returns the connection fd of the client, or -1 on error
1812 _dbus_accept (int listen_fd)
1815 struct sockaddr addr;
1818 dbus_bool_t cloexec_done;
1821 addrlen = sizeof (addr);
1826 /* We assume that if accept4 is available SOCK_CLOEXEC is too */
1827 client_fd = accept4 (listen_fd, &addr, &addrlen, SOCK_CLOEXEC);
1828 cloexec_done = client_fd >= 0;
1830 if (client_fd < 0 && errno == ENOSYS)
1833 client_fd = accept (listen_fd, &addr, &addrlen);
1842 _dbus_verbose ("client fd %d accepted\n", client_fd);
1848 _dbus_fd_set_close_on_exec(client_fd);
1855 * Checks to make sure the given directory is
1856 * private to the user
1858 * @param dir the name of the directory
1859 * @param error error return
1860 * @returns #FALSE on failure
1863 _dbus_check_dir_is_private_to_user (DBusString *dir, DBusError *error)
1865 const char *directory;
1868 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1870 directory = _dbus_string_get_const_data (dir);
1872 if (stat (directory, &sb) < 0)
1874 dbus_set_error (error, _dbus_error_from_errno (errno),
1875 "%s", _dbus_strerror (errno));
1880 if ((S_IROTH & sb.st_mode) || (S_IWOTH & sb.st_mode) ||
1881 (S_IRGRP & sb.st_mode) || (S_IWGRP & sb.st_mode))
1883 dbus_set_error (error, DBUS_ERROR_FAILED,
1884 "%s directory is not private to the user", directory);
1892 fill_user_info_from_passwd (struct passwd *p,
1896 _dbus_assert (p->pw_name != NULL);
1897 _dbus_assert (p->pw_dir != NULL);
1899 info->uid = p->pw_uid;
1900 info->primary_gid = p->pw_gid;
1901 info->username = _dbus_strdup (p->pw_name);
1902 info->homedir = _dbus_strdup (p->pw_dir);
1904 if (info->username == NULL ||
1905 info->homedir == NULL)
1907 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1915 fill_user_info (DBusUserInfo *info,
1917 const DBusString *username,
1920 const char *username_c;
1922 /* exactly one of username/uid provided */
1923 _dbus_assert (username != NULL || uid != DBUS_UID_UNSET);
1924 _dbus_assert (username == NULL || uid == DBUS_UID_UNSET);
1926 info->uid = DBUS_UID_UNSET;
1927 info->primary_gid = DBUS_GID_UNSET;
1928 info->group_ids = NULL;
1929 info->n_group_ids = 0;
1930 info->username = NULL;
1931 info->homedir = NULL;
1933 if (username != NULL)
1934 username_c = _dbus_string_get_const_data (username);
1938 /* For now assuming that the getpwnam() and getpwuid() flavors
1939 * are always symmetrical, if not we have to add more configure
1943 #if defined (HAVE_POSIX_GETPWNAM_R) || defined (HAVE_NONPOSIX_GETPWNAM_R)
1949 struct passwd p_str;
1951 /* retrieve maximum needed size for buf */
1952 buflen = sysconf (_SC_GETPW_R_SIZE_MAX);
1954 /* sysconf actually returns a long, but everything else expects size_t,
1955 * so just recast here.
1956 * https://bugs.freedesktop.org/show_bug.cgi?id=17061
1958 if ((long) buflen <= 0)
1964 buf = dbus_malloc (buflen);
1967 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1972 #ifdef HAVE_POSIX_GETPWNAM_R
1973 if (uid != DBUS_UID_UNSET)
1974 result = getpwuid_r (uid, &p_str, buf, buflen,
1977 result = getpwnam_r (username_c, &p_str, buf, buflen,
1980 if (uid != DBUS_UID_UNSET)
1981 p = getpwuid_r (uid, &p_str, buf, buflen);
1983 p = getpwnam_r (username_c, &p_str, buf, buflen);
1985 #endif /* !HAVE_POSIX_GETPWNAM_R */
1986 //Try a bigger buffer if ERANGE was returned
1987 if (result == ERANGE && buflen < 512 * 1024)
1997 if (result == 0 && p == &p_str)
1999 if (!fill_user_info_from_passwd (p, info, error))
2008 dbus_set_error (error, _dbus_error_from_errno (errno),
2009 "User \"%s\" unknown or no memory to allocate password entry\n",
2010 username_c ? username_c : "???");
2011 _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
2016 #else /* ! HAVE_GETPWNAM_R */
2018 /* I guess we're screwed on thread safety here */
2021 if (uid != DBUS_UID_UNSET)
2024 p = getpwnam (username_c);
2028 if (!fill_user_info_from_passwd (p, info, error))
2035 dbus_set_error (error, _dbus_error_from_errno (errno),
2036 "User \"%s\" unknown or no memory to allocate password entry\n",
2037 username_c ? username_c : "???");
2038 _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
2042 #endif /* ! HAVE_GETPWNAM_R */
2044 /* Fill this in so we can use it to get groups */
2045 username_c = info->username;
2047 #ifdef HAVE_GETGROUPLIST
2052 int initial_buf_count;
2054 initial_buf_count = 17;
2055 buf_count = initial_buf_count;
2056 buf = dbus_new (gid_t, buf_count);
2059 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2063 if (getgrouplist (username_c,
2065 buf, &buf_count) < 0)
2068 /* Presumed cause of negative return code: buf has insufficient
2069 entries to hold the entire group list. The Linux behavior in this
2070 case is to pass back the actual number of groups in buf_count, but
2071 on Mac OS X 10.5, buf_count is unhelpfully left alone.
2072 So as a hack, try to help out a bit by guessing a larger
2073 number of groups, within reason.. might still fail, of course,
2074 but we can at least print a more informative message. I looked up
2075 the "right way" to do this by downloading Apple's own source code
2076 for the "id" command, and it turns out that they use an
2077 undocumented library function getgrouplist_2 (!) which is not
2078 declared in any header in /usr/include (!!). That did not seem
2079 like the way to go here.
2081 if (buf_count == initial_buf_count)
2083 buf_count *= 16; /* Retry with an arbitrarily scaled-up array */
2085 new = dbus_realloc (buf, buf_count * sizeof (buf[0]));
2088 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2096 if (getgrouplist (username_c, info->primary_gid, buf, &buf_count) < 0)
2100 _dbus_warn ("It appears that username \"%s\" is in more than %d groups.\nProceeding with just the first %d groups.",
2101 username_c, buf_count, buf_count);
2105 dbus_set_error (error,
2106 _dbus_error_from_errno (errno),
2107 "Failed to get groups for username \"%s\" primary GID "
2108 DBUS_GID_FORMAT ": %s\n",
2109 username_c, info->primary_gid,
2110 _dbus_strerror (errno));
2117 info->group_ids = dbus_new (dbus_gid_t, buf_count);
2118 if (info->group_ids == NULL)
2120 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2125 for (i = 0; i < buf_count; ++i)
2126 info->group_ids[i] = buf[i];
2128 info->n_group_ids = buf_count;
2132 #else /* HAVE_GETGROUPLIST */
2134 /* We just get the one group ID */
2135 info->group_ids = dbus_new (dbus_gid_t, 1);
2136 if (info->group_ids == NULL)
2138 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2142 info->n_group_ids = 1;
2144 (info->group_ids)[0] = info->primary_gid;
2146 #endif /* HAVE_GETGROUPLIST */
2148 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2153 _DBUS_ASSERT_ERROR_IS_SET (error);
2158 * Gets user info for the given username.
2160 * @param info user info object to initialize
2161 * @param username the username
2162 * @param error error return
2163 * @returns #TRUE on success
2166 _dbus_user_info_fill (DBusUserInfo *info,
2167 const DBusString *username,
2170 return fill_user_info (info, DBUS_UID_UNSET,
2175 * Gets user info for the given user ID.
2177 * @param info user info object to initialize
2178 * @param uid the user ID
2179 * @param error error return
2180 * @returns #TRUE on success
2183 _dbus_user_info_fill_uid (DBusUserInfo *info,
2187 return fill_user_info (info, uid,
2192 * Adds the credentials of the current process to the
2193 * passed-in credentials object.
2195 * @param credentials credentials to add to
2196 * @returns #FALSE if no memory; does not properly roll back on failure, so only some credentials may have been added
2199 _dbus_credentials_add_from_current_process (DBusCredentials *credentials)
2201 /* The POSIX spec certainly doesn't promise this, but
2202 * we need these assertions to fail as soon as we're wrong about
2203 * it so we can do the porting fixups
2205 _dbus_assert (sizeof (pid_t) <= sizeof (dbus_pid_t));
2206 _dbus_assert (sizeof (uid_t) <= sizeof (dbus_uid_t));
2207 _dbus_assert (sizeof (gid_t) <= sizeof (dbus_gid_t));
2209 if (!_dbus_credentials_add_unix_pid(credentials, _dbus_getpid()))
2211 if (!_dbus_credentials_add_unix_uid(credentials, _dbus_geteuid()))
2218 * Append to the string the identity we would like to have when we
2219 * authenticate, on UNIX this is the current process UID and on
2220 * Windows something else, probably a Windows SID string. No escaping
2221 * is required, that is done in dbus-auth.c. The username here
2222 * need not be anything human-readable, it can be the machine-readable
2223 * form i.e. a user id.
2225 * @param str the string to append to
2226 * @returns #FALSE on no memory
2229 _dbus_append_user_from_current_process (DBusString *str)
2231 return _dbus_string_append_uint (str,
2236 * Gets our process ID
2237 * @returns process ID
2246 * @returns process UID
2254 /** Gets our effective UID
2255 * @returns process effective UID
2258 _dbus_geteuid (void)
2264 * The only reason this is separate from _dbus_getpid() is to allow it
2265 * on Windows for logging but not for other purposes.
2267 * @returns process ID to put in log messages
2270 _dbus_pid_for_log (void)
2276 * Gets a UID from a UID string.
2278 * @param uid_str the UID in string form
2279 * @param uid UID to fill in
2280 * @returns #TRUE if successfully filled in UID
2283 _dbus_parse_uid (const DBusString *uid_str,
2289 if (_dbus_string_get_length (uid_str) == 0)
2291 _dbus_verbose ("UID string was zero length\n");
2297 if (!_dbus_string_parse_int (uid_str, 0, &val,
2300 _dbus_verbose ("could not parse string as a UID\n");
2304 if (end != _dbus_string_get_length (uid_str))
2306 _dbus_verbose ("string contained trailing stuff after UID\n");
2316 _DBUS_DEFINE_GLOBAL_LOCK (atomic);
2320 * Atomically increments an integer
2322 * @param atomic pointer to the integer to increment
2323 * @returns the value before incrementing
2326 _dbus_atomic_inc (DBusAtomic *atomic)
2329 return __sync_add_and_fetch(&atomic->value, 1)-1;
2332 _DBUS_LOCK (atomic);
2333 res = atomic->value;
2335 _DBUS_UNLOCK (atomic);
2341 * Atomically decrement an integer
2343 * @param atomic pointer to the integer to decrement
2344 * @returns the value before decrementing
2347 _dbus_atomic_dec (DBusAtomic *atomic)
2350 return __sync_sub_and_fetch(&atomic->value, 1)+1;
2354 _DBUS_LOCK (atomic);
2355 res = atomic->value;
2357 _DBUS_UNLOCK (atomic);
2362 #ifdef DBUS_BUILD_TESTS
2364 * @returns process GID
2374 * Wrapper for poll().
2376 * @param fds the file descriptors to poll
2377 * @param n_fds number of descriptors in the array
2378 * @param timeout_milliseconds timeout or -1 for infinite
2379 * @returns numbers of fds with revents, or <0 on error
2382 _dbus_poll (DBusPollFD *fds,
2384 int timeout_milliseconds)
2386 #if defined(HAVE_POLL) && !defined(BROKEN_POLL)
2387 /* This big thing is a constant expression and should get optimized
2388 * out of existence. So it's more robust than a configure check at
2391 if (_DBUS_POLLIN == POLLIN &&
2392 _DBUS_POLLPRI == POLLPRI &&
2393 _DBUS_POLLOUT == POLLOUT &&
2394 _DBUS_POLLERR == POLLERR &&
2395 _DBUS_POLLHUP == POLLHUP &&
2396 _DBUS_POLLNVAL == POLLNVAL &&
2397 sizeof (DBusPollFD) == sizeof (struct pollfd) &&
2398 _DBUS_STRUCT_OFFSET (DBusPollFD, fd) ==
2399 _DBUS_STRUCT_OFFSET (struct pollfd, fd) &&
2400 _DBUS_STRUCT_OFFSET (DBusPollFD, events) ==
2401 _DBUS_STRUCT_OFFSET (struct pollfd, events) &&
2402 _DBUS_STRUCT_OFFSET (DBusPollFD, revents) ==
2403 _DBUS_STRUCT_OFFSET (struct pollfd, revents))
2405 return poll ((struct pollfd*) fds,
2407 timeout_milliseconds);
2411 /* We have to convert the DBusPollFD to an array of
2412 * struct pollfd, poll, and convert back.
2414 _dbus_warn ("didn't implement poll() properly for this system yet\n");
2417 #else /* ! HAVE_POLL */
2419 fd_set read_set, write_set, err_set;
2425 FD_ZERO (&read_set);
2426 FD_ZERO (&write_set);
2429 for (i = 0; i < n_fds; i++)
2431 DBusPollFD *fdp = &fds[i];
2433 if (fdp->events & _DBUS_POLLIN)
2434 FD_SET (fdp->fd, &read_set);
2436 if (fdp->events & _DBUS_POLLOUT)
2437 FD_SET (fdp->fd, &write_set);
2439 FD_SET (fdp->fd, &err_set);
2441 max_fd = MAX (max_fd, fdp->fd);
2444 tv.tv_sec = timeout_milliseconds / 1000;
2445 tv.tv_usec = (timeout_milliseconds % 1000) * 1000;
2447 ready = select (max_fd + 1, &read_set, &write_set, &err_set,
2448 timeout_milliseconds < 0 ? NULL : &tv);
2452 for (i = 0; i < n_fds; i++)
2454 DBusPollFD *fdp = &fds[i];
2458 if (FD_ISSET (fdp->fd, &read_set))
2459 fdp->revents |= _DBUS_POLLIN;
2461 if (FD_ISSET (fdp->fd, &write_set))
2462 fdp->revents |= _DBUS_POLLOUT;
2464 if (FD_ISSET (fdp->fd, &err_set))
2465 fdp->revents |= _DBUS_POLLERR;
2474 * Get current time, as in gettimeofday(). Use the monotonic clock if
2475 * available, to avoid problems when the system time changes.
2477 * @param tv_sec return location for number of seconds
2478 * @param tv_usec return location for number of microseconds (thousandths)
2481 _dbus_get_current_time (long *tv_sec,
2486 #ifdef HAVE_MONOTONIC_CLOCK
2488 clock_gettime (CLOCK_MONOTONIC, &ts);
2491 *tv_sec = ts.tv_sec;
2493 *tv_usec = ts.tv_nsec / 1000;
2495 gettimeofday (&t, NULL);
2500 *tv_usec = t.tv_usec;
2505 * Creates a directory; succeeds if the directory
2506 * is created or already existed.
2508 * @param filename directory filename
2509 * @param error initialized error object
2510 * @returns #TRUE on success
2513 _dbus_create_directory (const DBusString *filename,
2516 const char *filename_c;
2518 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2520 filename_c = _dbus_string_get_const_data (filename);
2522 if (mkdir (filename_c, 0700) < 0)
2524 if (errno == EEXIST)
2527 dbus_set_error (error, DBUS_ERROR_FAILED,
2528 "Failed to create directory %s: %s\n",
2529 filename_c, _dbus_strerror (errno));
2537 * Appends the given filename to the given directory.
2539 * @todo it might be cute to collapse multiple '/' such as "foo//"
2542 * @param dir the directory name
2543 * @param next_component the filename
2544 * @returns #TRUE on success
2547 _dbus_concat_dir_and_file (DBusString *dir,
2548 const DBusString *next_component)
2550 dbus_bool_t dir_ends_in_slash;
2551 dbus_bool_t file_starts_with_slash;
2553 if (_dbus_string_get_length (dir) == 0 ||
2554 _dbus_string_get_length (next_component) == 0)
2557 dir_ends_in_slash = '/' == _dbus_string_get_byte (dir,
2558 _dbus_string_get_length (dir) - 1);
2560 file_starts_with_slash = '/' == _dbus_string_get_byte (next_component, 0);
2562 if (dir_ends_in_slash && file_starts_with_slash)
2564 _dbus_string_shorten (dir, 1);
2566 else if (!(dir_ends_in_slash || file_starts_with_slash))
2568 if (!_dbus_string_append_byte (dir, '/'))
2572 return _dbus_string_copy (next_component, 0, dir,
2573 _dbus_string_get_length (dir));
2576 /** nanoseconds in a second */
2577 #define NANOSECONDS_PER_SECOND 1000000000
2578 /** microseconds in a second */
2579 #define MICROSECONDS_PER_SECOND 1000000
2580 /** milliseconds in a second */
2581 #define MILLISECONDS_PER_SECOND 1000
2582 /** nanoseconds in a millisecond */
2583 #define NANOSECONDS_PER_MILLISECOND 1000000
2584 /** microseconds in a millisecond */
2585 #define MICROSECONDS_PER_MILLISECOND 1000
2588 * Sleeps the given number of milliseconds.
2589 * @param milliseconds number of milliseconds
2592 _dbus_sleep_milliseconds (int milliseconds)
2594 #ifdef HAVE_NANOSLEEP
2595 struct timespec req;
2596 struct timespec rem;
2598 req.tv_sec = milliseconds / MILLISECONDS_PER_SECOND;
2599 req.tv_nsec = (milliseconds % MILLISECONDS_PER_SECOND) * NANOSECONDS_PER_MILLISECOND;
2603 while (nanosleep (&req, &rem) < 0 && errno == EINTR)
2605 #elif defined (HAVE_USLEEP)
2606 usleep (milliseconds * MICROSECONDS_PER_MILLISECOND);
2607 #else /* ! HAVE_USLEEP */
2608 sleep (MAX (milliseconds / 1000, 1));
2613 _dbus_generate_pseudorandom_bytes (DBusString *str,
2619 old_len = _dbus_string_get_length (str);
2621 if (!_dbus_string_lengthen (str, n_bytes))
2624 p = _dbus_string_get_data_len (str, old_len, n_bytes);
2626 _dbus_generate_pseudorandom_bytes_buffer (p, n_bytes);
2632 * Generates the given number of random bytes,
2633 * using the best mechanism we can come up with.
2635 * @param str the string
2636 * @param n_bytes the number of random bytes to append to string
2637 * @returns #TRUE on success, #FALSE if no memory
2640 _dbus_generate_random_bytes (DBusString *str,
2646 /* FALSE return means "no memory", if it could
2647 * mean something else then we'd need to return
2648 * a DBusError. So we always fall back to pseudorandom
2652 old_len = _dbus_string_get_length (str);
2655 /* note, urandom on linux will fall back to pseudorandom */
2656 fd = open ("/dev/urandom", O_RDONLY);
2658 return _dbus_generate_pseudorandom_bytes (str, n_bytes);
2660 _dbus_verbose ("/dev/urandom fd %d opened\n", fd);
2662 if (_dbus_read (fd, str, n_bytes) != n_bytes)
2664 _dbus_close (fd, NULL);
2665 _dbus_string_set_length (str, old_len);
2666 return _dbus_generate_pseudorandom_bytes (str, n_bytes);
2669 _dbus_verbose ("Read %d bytes from /dev/urandom\n",
2672 _dbus_close (fd, NULL);
2678 * Exit the process, returning the given value.
2680 * @param code the exit code
2683 _dbus_exit (int code)
2689 * A wrapper around strerror() because some platforms
2690 * may be lame and not have strerror(). Also, never
2693 * @param error_number errno.
2694 * @returns error description.
2697 _dbus_strerror (int error_number)
2701 msg = strerror (error_number);
2709 * signal (SIGPIPE, SIG_IGN);
2712 _dbus_disable_sigpipe (void)
2714 signal (SIGPIPE, SIG_IGN);
2718 * Sets the file descriptor to be close
2719 * on exec. Should be called for all file
2720 * descriptors in D-Bus code.
2722 * @param fd the file descriptor
2725 _dbus_fd_set_close_on_exec (intptr_t fd)
2729 val = fcntl (fd, F_GETFD, 0);
2736 fcntl (fd, F_SETFD, val);
2740 * Closes a file descriptor.
2742 * @param fd the file descriptor
2743 * @param error error object
2744 * @returns #FALSE if error set
2747 _dbus_close (int fd,
2750 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2758 dbus_set_error (error, _dbus_error_from_errno (errno),
2759 "Could not close fd %d", fd);
2767 * Duplicates a file descriptor. Makes sure the fd returned is >= 3
2768 * (i.e. avoids stdin/stdout/stderr). Sets O_CLOEXEC.
2770 * @param fd the file descriptor to duplicate
2771 * @returns duplicated file descriptor
2779 #ifdef F_DUPFD_CLOEXEC
2780 dbus_bool_t cloexec_done;
2782 new_fd = fcntl(fd, F_DUPFD_CLOEXEC, 3);
2783 cloexec_done = new_fd >= 0;
2785 if (new_fd < 0 && errno == EINVAL)
2788 new_fd = fcntl(fd, F_DUPFD, 3);
2793 dbus_set_error (error, _dbus_error_from_errno (errno),
2794 "Could not duplicate fd %d", fd);
2798 #ifdef F_DUPFD_CLOEXEC
2802 _dbus_fd_set_close_on_exec(new_fd);
2809 * Sets a file descriptor to be nonblocking.
2811 * @param fd the file descriptor.
2812 * @param error address of error location.
2813 * @returns #TRUE on success.
2816 _dbus_set_fd_nonblocking (int fd,
2821 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2823 val = fcntl (fd, F_GETFL, 0);
2826 dbus_set_error (error, _dbus_error_from_errno (errno),
2827 "Failed to get flags from file descriptor %d: %s",
2828 fd, _dbus_strerror (errno));
2829 _dbus_verbose ("Failed to get flags for fd %d: %s\n", fd,
2830 _dbus_strerror (errno));
2834 if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
2836 dbus_set_error (error, _dbus_error_from_errno (errno),
2837 "Failed to set nonblocking flag of file descriptor %d: %s",
2838 fd, _dbus_strerror (errno));
2839 _dbus_verbose ("Failed to set fd %d nonblocking: %s\n",
2840 fd, _dbus_strerror (errno));
2849 * On GNU libc systems, print a crude backtrace to stderr. On other
2850 * systems, print "no backtrace support" and block for possible gdb
2851 * attachment if an appropriate environment variable is set.
2854 _dbus_print_backtrace (void)
2856 #if defined (HAVE_BACKTRACE) && defined (DBUS_BUILT_R_DYNAMIC)
2862 bt_size = backtrace (bt, 500);
2864 syms = backtrace_symbols (bt, bt_size);
2869 /* don't use dbus_warn since it can _dbus_abort() */
2870 fprintf (stderr, " %s\n", syms[i]);
2876 #elif defined (HAVE_BACKTRACE) && ! defined (DBUS_BUILT_R_DYNAMIC)
2877 fprintf (stderr, " D-Bus not built with -rdynamic so unable to print a backtrace\n");
2879 fprintf (stderr, " D-Bus not compiled with backtrace support so unable to print a backtrace\n");
2884 * Creates a full-duplex pipe (as in socketpair()).
2885 * Sets both ends of the pipe nonblocking.
2887 * Marks both file descriptors as close-on-exec
2889 * @todo libdbus only uses this for the debug-pipe server, so in
2890 * principle it could be in dbus-sysdeps-util.c, except that
2891 * dbus-sysdeps-util.c isn't in libdbus when tests are enabled and the
2892 * debug-pipe server is used.
2894 * @param fd1 return location for one end
2895 * @param fd2 return location for the other end
2896 * @param blocking #TRUE if pipe should be blocking
2897 * @param error error return
2898 * @returns #FALSE on failure (if error is set)
2901 _dbus_full_duplex_pipe (int *fd1,
2903 dbus_bool_t blocking,
2906 #ifdef HAVE_SOCKETPAIR
2911 dbus_bool_t cloexec_done;
2913 retval = socketpair(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0, fds);
2914 cloexec_done = retval >= 0;
2916 if (retval < 0 && errno == EINVAL)
2919 retval = socketpair(AF_UNIX, SOCK_STREAM, 0, fds);
2924 dbus_set_error (error, _dbus_error_from_errno (errno),
2925 "Could not create full-duplex pipe");
2929 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2935 _dbus_fd_set_close_on_exec (fds[0]);
2936 _dbus_fd_set_close_on_exec (fds[1]);
2940 (!_dbus_set_fd_nonblocking (fds[0], NULL) ||
2941 !_dbus_set_fd_nonblocking (fds[1], NULL)))
2943 dbus_set_error (error, _dbus_error_from_errno (errno),
2944 "Could not set full-duplex pipe nonblocking");
2946 _dbus_close (fds[0], NULL);
2947 _dbus_close (fds[1], NULL);
2955 _dbus_verbose ("full-duplex pipe %d <-> %d\n",
2960 _dbus_warn ("_dbus_full_duplex_pipe() not implemented on this OS\n");
2961 dbus_set_error (error, DBUS_ERROR_FAILED,
2962 "_dbus_full_duplex_pipe() not implemented on this OS");
2968 * Measure the length of the given format string and arguments,
2969 * not including the terminating nul.
2971 * @param format a printf-style format string
2972 * @param args arguments for the format string
2973 * @returns length of the given format string and args
2976 _dbus_printf_string_upper_bound (const char *format,
2980 return vsnprintf (&c, 1, format, args);
2984 * Gets the temporary files directory by inspecting the environment variables
2985 * TMPDIR, TMP, and TEMP in that order. If none of those are set "/tmp" is returned
2987 * @returns location of temp directory
2990 _dbus_get_tmpdir(void)
2992 static const char* tmpdir = NULL;
2996 /* TMPDIR is what glibc uses, then
2997 * glibc falls back to the P_tmpdir macro which
2998 * just expands to "/tmp"
3001 tmpdir = getenv("TMPDIR");
3003 /* These two env variables are probably
3004 * broken, but maybe some OS uses them?
3007 tmpdir = getenv("TMP");
3009 tmpdir = getenv("TEMP");
3011 /* And this is the sane fallback. */
3016 _dbus_assert(tmpdir != NULL);
3022 * Execute a subprocess, returning up to 1024 bytes of output
3025 * If successful, returns #TRUE and appends the output to @p
3026 * result. If a failure happens, returns #FALSE and
3027 * sets an error in @p error.
3029 * @note It's not an error if the subprocess terminates normally
3030 * without writing any data to stdout. Verify the @p result length
3031 * before and after this function call to cover this case.
3033 * @param progname initial path to exec (may or may not be absolute)
3034 * @param path_fallback if %TRUE, search PATH for executable
3035 * @param argv NULL-terminated list of arguments
3036 * @param result a DBusString where the output can be append
3037 * @param error a DBusError to store the error in case of failure
3038 * @returns #TRUE on success, #FALSE if an error happened
3041 _read_subprocess_line_argv (const char *progpath,
3042 dbus_bool_t path_fallback,
3047 int result_pipe[2] = { -1, -1 };
3048 int errors_pipe[2] = { -1, -1 };
3056 sigset_t new_set, old_set;
3058 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3061 /* We need to block any existing handlers for SIGCHLD temporarily; they
3062 * will cause waitpid() below to fail.
3063 * https://bugs.freedesktop.org/show_bug.cgi?id=21347
3065 sigemptyset (&new_set);
3066 sigaddset (&new_set, SIGCHLD);
3067 sigprocmask (SIG_BLOCK, &new_set, &old_set);
3069 orig_len = _dbus_string_get_length (result);
3073 if (pipe (result_pipe) < 0)
3075 dbus_set_error (error, _dbus_error_from_errno (errno),
3076 "Failed to create a pipe to call %s: %s",
3077 progpath, _dbus_strerror (errno));
3078 _dbus_verbose ("Failed to create a pipe to call %s: %s\n",
3079 progpath, _dbus_strerror (errno));
3082 if (pipe (errors_pipe) < 0)
3084 dbus_set_error (error, _dbus_error_from_errno (errno),
3085 "Failed to create a pipe to call %s: %s",
3086 progpath, _dbus_strerror (errno));
3087 _dbus_verbose ("Failed to create a pipe to call %s: %s\n",
3088 progpath, _dbus_strerror (errno));
3095 dbus_set_error (error, _dbus_error_from_errno (errno),
3096 "Failed to fork() to call %s: %s",
3097 progpath, _dbus_strerror (errno));
3098 _dbus_verbose ("Failed to fork() to call %s: %s\n",
3099 progpath, _dbus_strerror (errno));
3109 fd = open ("/dev/null", O_RDWR);
3111 /* huh?! can't open /dev/null? */
3114 _dbus_verbose ("/dev/null fd %d opened\n", fd);
3117 close (result_pipe[READ_END]);
3118 close (errors_pipe[READ_END]);
3119 close (0); /* close stdin */
3120 close (1); /* close stdout */
3121 close (2); /* close stderr */
3123 if (dup2 (fd, 0) == -1)
3125 if (dup2 (result_pipe[WRITE_END], 1) == -1)
3127 if (dup2 (errors_pipe[WRITE_END], 2) == -1)
3130 maxfds = sysconf (_SC_OPEN_MAX);
3131 /* Pick something reasonable if for some reason sysconf
3136 /* close all inherited fds */
3137 for (i = 3; i < maxfds; i++)
3140 sigprocmask (SIG_SETMASK, &old_set, NULL);
3142 /* If it looks fully-qualified, try execv first */
3143 if (progpath[0] == '/')
3145 execv (progpath, argv);
3146 /* Ok, that failed. Now if path_fallback is given, let's
3147 * try unqualified. This is mostly a hack to work
3148 * around systems which ship dbus-launch in /usr/bin
3149 * but everything else in /bin (because dbus-launch
3153 /* We must have a slash, because we checked above */
3154 execvp (strrchr (progpath, '/')+1, argv);
3157 execvp (progpath, argv);
3159 /* still nothing, we failed */
3163 /* parent process */
3164 close (result_pipe[WRITE_END]);
3165 close (errors_pipe[WRITE_END]);
3166 result_pipe[WRITE_END] = -1;
3167 errors_pipe[WRITE_END] = -1;
3172 ret = _dbus_read (result_pipe[READ_END], result, 1024);
3176 /* reap the child process to avoid it lingering as zombie */
3179 ret = waitpid (pid, &status, 0);
3181 while (ret == -1 && errno == EINTR);
3183 /* We succeeded if the process exited with status 0 and
3184 anything was read */
3185 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0 )
3187 /* The process ended with error */
3188 DBusString error_message;
3189 if (!_dbus_string_init (&error_message))
3191 _DBUS_SET_OOM (error);
3198 ret = _dbus_read (errors_pipe[READ_END], &error_message, 1024);
3202 _dbus_string_set_length (result, orig_len);
3203 if (_dbus_string_get_length (&error_message) > 0)
3204 dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
3205 "%s terminated abnormally with the following error: %s",
3206 progpath, _dbus_string_get_data (&error_message));
3208 dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
3209 "%s terminated abnormally without any error message",
3217 sigprocmask (SIG_SETMASK, &old_set, NULL);
3220 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3222 _DBUS_ASSERT_ERROR_IS_SET (error);
3224 if (result_pipe[0] != -1)
3225 close (result_pipe[0]);
3226 if (result_pipe[1] != -1)
3227 close (result_pipe[1]);
3228 if (errors_pipe[0] != -1)
3229 close (errors_pipe[0]);
3230 if (errors_pipe[1] != -1)
3231 close (errors_pipe[1]);
3237 * Returns the address of a new session bus.
3239 * If successful, returns #TRUE and appends the address to @p
3240 * address. If a failure happens, returns #FALSE and
3241 * sets an error in @p error.
3243 * @param address a DBusString where the address can be stored
3244 * @param error a DBusError to store the error in case of failure
3245 * @returns #TRUE on success, #FALSE if an error happened
3248 _dbus_get_autolaunch_address (const char *scope,
3249 DBusString *address,
3252 #ifdef DBUS_ENABLE_X11_AUTOLAUNCH
3253 /* Perform X11-based autolaunch. (We also support launchd-based autolaunch,
3254 * but that's done elsewhere, and if it worked, this function wouldn't
3256 const char *display;
3257 static char *argv[6];
3262 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3265 /* fd.o #19997: if $DISPLAY isn't set to something useful, then
3266 * dbus-launch-x11 is just going to fail. Rather than trying to
3267 * run it, we might as well bail out early with a nice error. */
3268 display = _dbus_getenv ("DISPLAY");
3270 if (display == NULL || display[0] == '\0')
3272 dbus_set_error_const (error, DBUS_ERROR_NOT_SUPPORTED,
3273 "Unable to autolaunch a dbus-daemon without a $DISPLAY for X11");
3277 if (!_dbus_string_init (&uuid))
3279 _DBUS_SET_OOM (error);
3283 if (!_dbus_get_local_machine_uuid_encoded (&uuid))
3285 _DBUS_SET_OOM (error);
3290 argv[i] = "dbus-launch";
3292 argv[i] = "--autolaunch";
3294 argv[i] = _dbus_string_get_data (&uuid);
3296 argv[i] = "--binary-syntax";
3298 argv[i] = "--close-stderr";
3303 _dbus_assert (i == _DBUS_N_ELEMENTS (argv));
3305 retval = _read_subprocess_line_argv (DBUS_BINDIR "/dbus-launch",
3307 argv, address, error);
3310 _dbus_string_free (&uuid);
3313 dbus_set_error_const (error, DBUS_ERROR_NOT_SUPPORTED,
3314 "Using X11 for dbus-daemon autolaunch was disabled at compile time, "
3315 "set your DBUS_SESSION_BUS_ADDRESS instead");
3321 * Reads the uuid of the machine we're running on from
3322 * the dbus configuration. Optionally try to create it
3323 * (only root can do this usually).
3325 * On UNIX, reads a file that gets created by dbus-uuidgen
3326 * in a post-install script. On Windows, if there's a standard
3327 * machine uuid we could just use that, but I can't find one
3328 * with the right properties (the hardware profile guid can change
3329 * without rebooting I believe). If there's no standard one
3330 * we might want to use the registry instead of a file for
3331 * this, and I'm not sure how we'd ensure the uuid gets created.
3333 * @param machine_id guid to init with the machine's uuid
3334 * @param create_if_not_found try to create the uuid if it doesn't exist
3335 * @param error the error return
3336 * @returns #FALSE if the error is set
3339 _dbus_read_local_machine_uuid (DBusGUID *machine_id,
3340 dbus_bool_t create_if_not_found,
3343 DBusString filename;
3346 _dbus_string_init_const (&filename, DBUS_MACHINE_UUID_FILE);
3348 b = _dbus_read_uuid_file (&filename, machine_id, create_if_not_found, error);
3352 dbus_error_free (error);
3354 /* Fallback to the system machine ID */
3355 _dbus_string_init_const (&filename, "/etc/machine-id");
3356 return _dbus_read_uuid_file (&filename, machine_id, FALSE, error);
3359 #define DBUS_UNIX_STANDARD_SESSION_SERVICEDIR "/dbus-1/services"
3360 #define DBUS_UNIX_STANDARD_SYSTEM_SERVICEDIR "/dbus-1/system-services"
3363 * quries launchd for a specific env var which holds the socket path.
3364 * @param launchd_env_var the env var to look up
3365 * @param error a DBusError to store the error in case of failure
3366 * @return the value of the env var
3369 _dbus_lookup_launchd_socket (DBusString *socket_path,
3370 const char *launchd_env_var,
3373 #ifdef DBUS_ENABLE_LAUNCHD
3377 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3380 argv[i] = "launchctl";
3384 argv[i] = (char*)launchd_env_var;
3389 _dbus_assert (i == _DBUS_N_ELEMENTS (argv));
3391 if (!_read_subprocess_line_argv(argv[0], TRUE, argv, socket_path, error))
3396 /* no error, but no result either */
3397 if (_dbus_string_get_length(socket_path) == 0)
3402 /* strip the carriage-return */
3403 _dbus_string_shorten(socket_path, 1);
3405 #else /* DBUS_ENABLE_LAUNCHD */
3406 dbus_set_error(error, DBUS_ERROR_NOT_SUPPORTED,
3407 "can't lookup socket from launchd; launchd support not compiled in");
3413 _dbus_lookup_session_address_launchd (DBusString *address, DBusError *error)
3415 #ifdef DBUS_ENABLE_LAUNCHD
3416 dbus_bool_t valid_socket;
3417 DBusString socket_path;
3419 if (!_dbus_string_init (&socket_path))
3421 _DBUS_SET_OOM (error);
3425 valid_socket = _dbus_lookup_launchd_socket (&socket_path, "DBUS_LAUNCHD_SESSION_BUS_SOCKET", error);
3427 if (dbus_error_is_set(error))
3429 _dbus_string_free(&socket_path);
3435 dbus_set_error(error, "no socket path",
3436 "launchd did not provide a socket path, "
3437 "verify that org.freedesktop.dbus-session.plist is loaded!");
3438 _dbus_string_free(&socket_path);
3441 if (!_dbus_string_append (address, "unix:path="))
3443 _DBUS_SET_OOM (error);
3444 _dbus_string_free(&socket_path);
3447 if (!_dbus_string_copy (&socket_path, 0, address,
3448 _dbus_string_get_length (address)))
3450 _DBUS_SET_OOM (error);
3451 _dbus_string_free(&socket_path);
3455 _dbus_string_free(&socket_path);
3458 dbus_set_error(error, DBUS_ERROR_NOT_SUPPORTED,
3459 "can't lookup session address from launchd; launchd support not compiled in");
3465 * Determines the address of the session bus by querying a
3466 * platform-specific method.
3468 * The first parameter will be a boolean specifying whether
3469 * or not a dynamic session lookup is supported on this platform.
3471 * If supported is TRUE and the return value is #TRUE, the
3472 * address will be appended to @p address.
3473 * If a failure happens, returns #FALSE and sets an error in
3476 * If supported is FALSE, ignore the return value.
3478 * @param supported returns whether this method is supported
3479 * @param address a DBusString where the address can be stored
3480 * @param error a DBusError to store the error in case of failure
3481 * @returns #TRUE on success, #FALSE if an error happened
3484 _dbus_lookup_session_address (dbus_bool_t *supported,
3485 DBusString *address,
3488 #ifdef DBUS_ENABLE_LAUNCHD
3490 return _dbus_lookup_session_address_launchd (address, error);
3492 /* On non-Mac Unix platforms, if the session address isn't already
3493 * set in DBUS_SESSION_BUS_ADDRESS environment variable, we punt and
3494 * fall back to the autolaunch: global default; see
3495 * init_session_address in dbus/dbus-bus.c. */
3502 * Returns the standard directories for a session bus to look for service
3505 * On UNIX this should be the standard xdg freedesktop.org data directories:
3507 * XDG_DATA_HOME=${XDG_DATA_HOME-$HOME/.local/share}
3508 * XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}
3514 * @param dirs the directory list we are returning
3515 * @returns #FALSE on OOM
3519 _dbus_get_standard_session_servicedirs (DBusList **dirs)
3521 const char *xdg_data_home;
3522 const char *xdg_data_dirs;
3523 DBusString servicedir_path;
3525 if (!_dbus_string_init (&servicedir_path))
3528 xdg_data_home = _dbus_getenv ("XDG_DATA_HOME");
3529 xdg_data_dirs = _dbus_getenv ("XDG_DATA_DIRS");
3531 if (xdg_data_home != NULL)
3533 if (!_dbus_string_append (&servicedir_path, xdg_data_home))
3538 const DBusString *homedir;
3539 DBusString local_share;
3541 if (!_dbus_homedir_from_current_process (&homedir))
3544 if (!_dbus_string_append (&servicedir_path, _dbus_string_get_const_data (homedir)))
3547 _dbus_string_init_const (&local_share, "/.local/share");
3548 if (!_dbus_concat_dir_and_file (&servicedir_path, &local_share))
3552 if (!_dbus_string_append (&servicedir_path, ":"))
3555 if (xdg_data_dirs != NULL)
3557 if (!_dbus_string_append (&servicedir_path, xdg_data_dirs))
3560 if (!_dbus_string_append (&servicedir_path, ":"))
3565 if (!_dbus_string_append (&servicedir_path, "/usr/local/share:/usr/share:"))
3570 * add configured datadir to defaults
3571 * this may be the same as an xdg dir
3572 * however the config parser should take
3573 * care of duplicates
3575 if (!_dbus_string_append (&servicedir_path, DBUS_DATADIR))
3578 if (!_dbus_split_paths_and_append (&servicedir_path,
3579 DBUS_UNIX_STANDARD_SESSION_SERVICEDIR,
3583 _dbus_string_free (&servicedir_path);
3587 _dbus_string_free (&servicedir_path);
3593 * Returns the standard directories for a system bus to look for service
3596 * On UNIX this should be the standard xdg freedesktop.org data directories:
3598 * XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}
3604 * On Windows there is no system bus and this function can return nothing.
3606 * @param dirs the directory list we are returning
3607 * @returns #FALSE on OOM
3611 _dbus_get_standard_system_servicedirs (DBusList **dirs)
3613 const char *xdg_data_dirs;
3614 DBusString servicedir_path;
3616 if (!_dbus_string_init (&servicedir_path))
3619 xdg_data_dirs = _dbus_getenv ("XDG_DATA_DIRS");
3621 if (xdg_data_dirs != NULL)
3623 if (!_dbus_string_append (&servicedir_path, xdg_data_dirs))
3626 if (!_dbus_string_append (&servicedir_path, ":"))
3631 if (!_dbus_string_append (&servicedir_path, "/usr/local/share:/usr/share:"))
3636 * Add configured datadir to defaults. This may be the same as one
3637 * of the XDG directories. However, the config parser should take
3638 * care of the duplicates.
3640 * Also, append /lib as counterpart of /usr/share on the root
3641 * directory (the root directory does not know /share), in order to
3642 * facilitate early boot system bus activation where /usr might not
3645 if (!_dbus_string_append (&servicedir_path,
3650 if (!_dbus_split_paths_and_append (&servicedir_path,
3651 DBUS_UNIX_STANDARD_SYSTEM_SERVICEDIR,
3655 _dbus_string_free (&servicedir_path);
3659 _dbus_string_free (&servicedir_path);
3664 * Append the absolute path of the system.conf file
3665 * (there is no system bus on Windows so this can just
3666 * return FALSE and print a warning or something)
3668 * @param str the string to append to
3669 * @returns #FALSE if no memory
3672 _dbus_append_system_config_file (DBusString *str)
3674 return _dbus_string_append (str, DBUS_SYSTEM_CONFIG_FILE);
3678 * Append the absolute path of the session.conf file.
3680 * @param str the string to append to
3681 * @returns #FALSE if no memory
3684 _dbus_append_session_config_file (DBusString *str)
3686 return _dbus_string_append (str, DBUS_SESSION_CONFIG_FILE);
3690 * Called when the bus daemon is signaled to reload its configuration; any
3691 * caches should be nuked. Of course any caches that need explicit reload
3692 * are probably broken, but c'est la vie.
3697 _dbus_flush_caches (void)
3699 _dbus_user_database_flush_system ();
3703 * Appends the directory in which a keyring for the given credentials
3704 * should be stored. The credentials should have either a Windows or
3705 * UNIX user in them. The directory should be an absolute path.
3707 * On UNIX the directory is ~/.dbus-keyrings while on Windows it should probably
3708 * be something else, since the dotfile convention is not normal on Windows.
3710 * @param directory string to append directory to
3711 * @param credentials credentials the directory should be for
3713 * @returns #FALSE on no memory
3716 _dbus_append_keyring_directory_for_credentials (DBusString *directory,
3717 DBusCredentials *credentials)
3723 _dbus_assert (credentials != NULL);
3724 _dbus_assert (!_dbus_credentials_are_anonymous (credentials));
3726 if (!_dbus_string_init (&homedir))
3729 uid = _dbus_credentials_get_unix_uid (credentials);
3730 _dbus_assert (uid != DBUS_UID_UNSET);
3732 if (!_dbus_homedir_from_uid (uid, &homedir))
3735 #ifdef DBUS_BUILD_TESTS
3737 const char *override;
3739 override = _dbus_getenv ("DBUS_TEST_HOMEDIR");
3740 if (override != NULL && *override != '\0')
3742 _dbus_string_set_length (&homedir, 0);
3743 if (!_dbus_string_append (&homedir, override))
3746 _dbus_verbose ("Using fake homedir for testing: %s\n",
3747 _dbus_string_get_const_data (&homedir));
3751 static dbus_bool_t already_warned = FALSE;
3752 if (!already_warned)
3754 _dbus_warn ("Using your real home directory for testing, set DBUS_TEST_HOMEDIR to avoid\n");
3755 already_warned = TRUE;
3761 _dbus_string_init_const (&dotdir, ".dbus-keyrings");
3762 if (!_dbus_concat_dir_and_file (&homedir,
3766 if (!_dbus_string_copy (&homedir, 0,
3767 directory, _dbus_string_get_length (directory))) {
3771 _dbus_string_free (&homedir);
3775 _dbus_string_free (&homedir);
3779 //PENDING(kdab) docs
3781 _dbus_daemon_publish_session_bus_address (const char* addr,
3787 //PENDING(kdab) docs
3789 _dbus_daemon_unpublish_session_bus_address (void)
3795 * See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently
3796 * for Winsock so is abstracted)
3798 * @returns #TRUE if errno == EAGAIN or errno == EWOULDBLOCK
3801 _dbus_get_is_errno_eagain_or_ewouldblock (void)
3803 return errno == EAGAIN || errno == EWOULDBLOCK;
3807 * Removes a directory; Directory must be empty
3809 * @param filename directory filename
3810 * @param error initialized error object
3811 * @returns #TRUE on success
3814 _dbus_delete_directory (const DBusString *filename,
3817 const char *filename_c;
3819 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3821 filename_c = _dbus_string_get_const_data (filename);
3823 if (rmdir (filename_c) != 0)
3825 dbus_set_error (error, DBUS_ERROR_FAILED,
3826 "Failed to remove directory %s: %s\n",
3827 filename_c, _dbus_strerror (errno));
3835 * Checks whether file descriptors may be passed via the socket
3837 * @param fd the socket
3838 * @return TRUE when fd passing over this socket is supported
3842 _dbus_socket_can_pass_unix_fd(int fd) {
3847 struct sockaddr_storage storage;
3848 struct sockaddr_un un;
3851 socklen_t sa_len = sizeof(sa_buf);
3855 if (getsockname(fd, &sa_buf.sa, &sa_len) < 0)
3858 return sa_buf.sa.sa_family == AF_UNIX;
3868 * replaces the term DBUS_PREFIX in configure_time_path by the
3869 * current dbus installation directory. On unix this function is a noop
3871 * @param configure_time_path
3875 _dbus_replace_install_prefix (const char *configure_time_path)
3877 return configure_time_path;
3880 /* tests in dbus-sysdeps-util.c */