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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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"
38 #include <sys/types.h>
45 #include <sys/socket.h>
54 #include <netinet/in.h>
70 #ifdef HAVE_GETPEERUCRED
83 #define AI_ADDRCONFIG 0
86 #ifndef HAVE_SOCKLEN_T
91 _dbus_open_socket (int *fd_p,
97 *fd_p = socket (domain, type, protocol);
100 _dbus_verbose ("socket fd %d opened\n", *fd_p);
105 dbus_set_error(error,
106 _dbus_error_from_errno (errno),
107 "Failed to open socket: %s",
108 _dbus_strerror (errno));
114 _dbus_open_tcp_socket (int *fd,
117 return _dbus_open_socket(fd, AF_INET, SOCK_STREAM, 0, error);
121 * Opens a UNIX domain socket (as in the socket() call).
122 * Does not bind the socket.
123 * @param fd return location for socket descriptor
124 * @param error return location for an error
125 * @returns #FALSE if error is set
128 _dbus_open_unix_socket (int *fd,
131 return _dbus_open_socket(fd, PF_UNIX, SOCK_STREAM, 0, error);
135 * Closes a socket. Should not be used on non-socket
136 * file descriptors or handles.
138 * @param fd the socket
139 * @param error return location for an error
140 * @returns #FALSE if error is set
143 _dbus_close_socket (int fd,
146 return _dbus_close (fd, error);
150 * Like _dbus_read(), but only works on sockets so is
151 * available on Windows.
153 * @param fd the socket
154 * @param buffer string to append data to
155 * @param count max amount of data to read
156 * @returns number of bytes appended to the string
159 _dbus_read_socket (int fd,
163 return _dbus_read (fd, buffer, count);
167 * Like _dbus_write(), but only supports sockets
168 * and is thus available on Windows.
170 * @param fd the file descriptor to write
171 * @param buffer the buffer to write data from
172 * @param start the first byte in the buffer to write
173 * @param len the number of bytes to try to write
174 * @returns the number of bytes written or -1 on error
177 _dbus_write_socket (int fd,
178 const DBusString *buffer,
182 return _dbus_write (fd, buffer, start, len);
186 * write data to a pipe.
188 * @param pipe the pipe instance
189 * @param buffer the buffer to write data from
190 * @param start the first byte in the buffer to write
191 * @param len the number of bytes to try to write
192 * @param error error return
193 * @returns the number of bytes written or -1 on error
196 _dbus_pipe_write (DBusPipe *pipe,
197 const DBusString *buffer,
204 written = _dbus_write (pipe->fd_or_handle, buffer, start, len);
207 dbus_set_error (error, DBUS_ERROR_FAILED,
208 "Writing to pipe: %s\n",
209 _dbus_strerror (errno));
217 * @param pipe the pipe instance
218 * @param error return location for an error
219 * @returns #FALSE if error is set
222 _dbus_pipe_close (DBusPipe *pipe,
225 if (_dbus_close (pipe->fd_or_handle, error) < 0)
231 _dbus_pipe_invalidate (pipe);
237 * Like _dbus_write_two() but only works on sockets and is thus
238 * available on Windows.
240 * @param fd the file descriptor
241 * @param buffer1 first buffer
242 * @param start1 first byte to write in first buffer
243 * @param len1 number of bytes to write from first buffer
244 * @param buffer2 second buffer, or #NULL
245 * @param start2 first byte to write in second buffer
246 * @param len2 number of bytes to write in second buffer
247 * @returns total bytes written from both buffers, or -1 on error
250 _dbus_write_socket_two (int fd,
251 const DBusString *buffer1,
254 const DBusString *buffer2,
258 return _dbus_write_two (fd, buffer1, start1, len1,
259 buffer2, start2, len2);
264 * Thin wrapper around the read() system call that appends
265 * the data it reads to the DBusString buffer. It appends
266 * up to the given count, and returns the same value
267 * and same errno as read(). The only exception is that
268 * _dbus_read() handles EINTR for you. Also, _dbus_read() can
269 * return ENOMEM, even though regular UNIX read doesn't.
271 * Unlike _dbus_read_socket(), _dbus_read() is not available
274 * @param fd the file descriptor to read from
275 * @param buffer the buffer to append data to
276 * @param count the amount of data to read
277 * @returns the number of bytes read or -1
288 _dbus_assert (count >= 0);
290 start = _dbus_string_get_length (buffer);
292 if (!_dbus_string_lengthen (buffer, count))
298 data = _dbus_string_get_data_len (buffer, start, count);
302 bytes_read = read (fd, data, count);
310 /* put length back (note that this doesn't actually realloc anything) */
311 _dbus_string_set_length (buffer, start);
317 /* put length back (doesn't actually realloc) */
318 _dbus_string_set_length (buffer, start + bytes_read);
322 _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
330 * Thin wrapper around the write() system call that writes a part of a
331 * DBusString and handles EINTR for you.
333 * @param fd the file descriptor to write
334 * @param buffer the buffer to write data from
335 * @param start the first byte in the buffer to write
336 * @param len the number of bytes to try to write
337 * @returns the number of bytes written or -1 on error
341 const DBusString *buffer,
348 data = _dbus_string_get_const_data_len (buffer, start, len);
352 bytes_written = write (fd, data, len);
354 if (bytes_written < 0 && errno == EINTR)
358 if (bytes_written > 0)
359 _dbus_verbose_bytes_of_string (buffer, start, bytes_written);
362 return bytes_written;
366 * Like _dbus_write() but will use writev() if possible
367 * to write both buffers in sequence. The return value
368 * is the number of bytes written in the first buffer,
369 * plus the number written in the second. If the first
370 * buffer is written successfully and an error occurs
371 * writing the second, the number of bytes in the first
372 * is returned (i.e. the error is ignored), on systems that
373 * don't have writev. Handles EINTR for you.
374 * The second buffer may be #NULL.
376 * @param fd the file descriptor
377 * @param buffer1 first buffer
378 * @param start1 first byte to write in first buffer
379 * @param len1 number of bytes to write from first buffer
380 * @param buffer2 second buffer, or #NULL
381 * @param start2 first byte to write in second buffer
382 * @param len2 number of bytes to write in second buffer
383 * @returns total bytes written from both buffers, or -1 on error
386 _dbus_write_two (int fd,
387 const DBusString *buffer1,
390 const DBusString *buffer2,
394 _dbus_assert (buffer1 != NULL);
395 _dbus_assert (start1 >= 0);
396 _dbus_assert (start2 >= 0);
397 _dbus_assert (len1 >= 0);
398 _dbus_assert (len2 >= 0);
402 struct iovec vectors[2];
407 data1 = _dbus_string_get_const_data_len (buffer1, start1, len1);
410 data2 = _dbus_string_get_const_data_len (buffer2, start2, len2);
418 vectors[0].iov_base = (char*) data1;
419 vectors[0].iov_len = len1;
420 vectors[1].iov_base = (char*) data2;
421 vectors[1].iov_len = len2;
425 bytes_written = writev (fd,
429 if (bytes_written < 0 && errno == EINTR)
432 return bytes_written;
434 #else /* HAVE_WRITEV */
438 ret1 = _dbus_write (fd, buffer1, start1, len1);
439 if (ret1 == len1 && buffer2 != NULL)
441 ret2 = _dbus_write (fd, buffer2, start2, len2);
443 ret2 = 0; /* we can't report an error as the first write was OK */
450 #endif /* !HAVE_WRITEV */
453 #define _DBUS_MAX_SUN_PATH_LENGTH 99
456 * @def _DBUS_MAX_SUN_PATH_LENGTH
458 * Maximum length of the path to a UNIX domain socket,
459 * sockaddr_un::sun_path member. POSIX requires that all systems
460 * support at least 100 bytes here, including the nul termination.
461 * We use 99 for the max value to allow for the nul.
463 * We could probably also do sizeof (addr.sun_path)
464 * but this way we are the same on all platforms
465 * which is probably a good idea.
469 * Creates a socket and connects it to the UNIX domain socket at the
470 * given path. The connection fd is returned, and is set up as
473 * Uses abstract sockets instead of filesystem-linked sockets if
474 * requested (it's possible only on Linux; see "man 7 unix" on Linux).
475 * On non-Linux abstract socket usage always fails.
477 * @param path the path to UNIX domain socket
478 * @param abstract #TRUE to use abstract namespace
479 * @param error return location for error code
480 * @returns connection file descriptor or -1 on error
483 _dbus_connect_unix_socket (const char *path,
484 dbus_bool_t abstract,
489 struct sockaddr_un addr;
491 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
493 _dbus_verbose ("connecting to unix socket %s abstract=%d\n",
497 if (!_dbus_open_unix_socket (&fd, error))
499 _DBUS_ASSERT_ERROR_IS_SET(error);
502 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
505 addr.sun_family = AF_UNIX;
506 path_len = strlen (path);
510 #ifdef HAVE_ABSTRACT_SOCKETS
511 addr.sun_path[0] = '\0'; /* this is what says "use abstract" */
512 path_len++; /* Account for the extra nul byte added to the start of sun_path */
514 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
516 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
517 "Abstract socket name too long\n");
518 _dbus_close (fd, NULL);
522 strncpy (&addr.sun_path[1], path, path_len);
523 /* _dbus_verbose_bytes (addr.sun_path, sizeof (addr.sun_path)); */
524 #else /* HAVE_ABSTRACT_SOCKETS */
525 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED,
526 "Operating system does not support abstract socket namespace\n");
527 _dbus_close (fd, NULL);
529 #endif /* ! HAVE_ABSTRACT_SOCKETS */
533 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
535 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
536 "Socket name too long\n");
537 _dbus_close (fd, NULL);
541 strncpy (addr.sun_path, path, path_len);
544 if (connect (fd, (struct sockaddr*) &addr, _DBUS_STRUCT_OFFSET (struct sockaddr_un, sun_path) + path_len) < 0)
546 dbus_set_error (error,
547 _dbus_error_from_errno (errno),
548 "Failed to connect to socket %s: %s",
549 path, _dbus_strerror (errno));
551 _dbus_close (fd, NULL);
557 if (!_dbus_set_fd_nonblocking (fd, error))
559 _DBUS_ASSERT_ERROR_IS_SET (error);
561 _dbus_close (fd, NULL);
571 * Enables or disables the reception of credentials on the given socket during
572 * the next message transmission. This is only effective if the #LOCAL_CREDS
573 * system feature exists, in which case the other side of the connection does
574 * not have to do anything special to send the credentials.
576 * @param fd socket on which to change the #LOCAL_CREDS flag.
577 * @param on whether to enable or disable the #LOCAL_CREDS flag.
580 _dbus_set_local_creds (int fd, dbus_bool_t on)
582 dbus_bool_t retval = TRUE;
584 #if defined(HAVE_CMSGCRED)
585 /* NOOP just to make sure only one codepath is used
586 * and to prefer CMSGCRED
588 #elif defined(LOCAL_CREDS)
589 int val = on ? 1 : 0;
590 if (setsockopt (fd, 0, LOCAL_CREDS, &val, sizeof (val)) < 0)
592 _dbus_verbose ("Unable to set LOCAL_CREDS socket option on fd %d\n", fd);
596 _dbus_verbose ("LOCAL_CREDS %s for further messages on fd %d\n",
597 on ? "enabled" : "disabled", fd);
604 * Creates a socket and binds it to the given path,
605 * then listens on the socket. The socket is
606 * set to be nonblocking.
608 * Uses abstract sockets instead of filesystem-linked
609 * sockets if requested (it's possible only on Linux;
610 * see "man 7 unix" on Linux).
611 * On non-Linux abstract socket usage always fails.
613 * @param path the socket name
614 * @param abstract #TRUE to use abstract namespace
615 * @param error return location for errors
616 * @returns the listening file descriptor or -1 on error
619 _dbus_listen_unix_socket (const char *path,
620 dbus_bool_t abstract,
624 struct sockaddr_un addr;
627 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
629 _dbus_verbose ("listening on unix socket %s abstract=%d\n",
632 if (!_dbus_open_unix_socket (&listen_fd, error))
634 _DBUS_ASSERT_ERROR_IS_SET(error);
637 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
640 addr.sun_family = AF_UNIX;
641 path_len = strlen (path);
645 #ifdef HAVE_ABSTRACT_SOCKETS
646 /* remember that abstract names aren't nul-terminated so we rely
647 * on sun_path being filled in with zeroes above.
649 addr.sun_path[0] = '\0'; /* this is what says "use abstract" */
650 path_len++; /* Account for the extra nul byte added to the start of sun_path */
652 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
654 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
655 "Abstract socket name too long\n");
656 _dbus_close (listen_fd, NULL);
660 strncpy (&addr.sun_path[1], path, path_len);
661 /* _dbus_verbose_bytes (addr.sun_path, sizeof (addr.sun_path)); */
662 #else /* HAVE_ABSTRACT_SOCKETS */
663 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED,
664 "Operating system does not support abstract socket namespace\n");
665 _dbus_close (listen_fd, NULL);
667 #endif /* ! HAVE_ABSTRACT_SOCKETS */
671 /* Discussed security implications of this with Nalin,
672 * and we couldn't think of where it would kick our ass, but
673 * it still seems a bit sucky. It also has non-security suckage;
674 * really we'd prefer to exit if the socket is already in use.
675 * But there doesn't seem to be a good way to do this.
677 * Just to be extra careful, I threw in the stat() - clearly
678 * the stat() can't *fix* any security issue, but it at least
679 * avoids inadvertent/accidental data loss.
684 if (stat (path, &sb) == 0 &&
685 S_ISSOCK (sb.st_mode))
689 if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
691 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
692 "Abstract socket name too long\n");
693 _dbus_close (listen_fd, NULL);
697 strncpy (addr.sun_path, path, path_len);
700 if (bind (listen_fd, (struct sockaddr*) &addr, _DBUS_STRUCT_OFFSET (struct sockaddr_un, sun_path) + path_len) < 0)
702 dbus_set_error (error, _dbus_error_from_errno (errno),
703 "Failed to bind socket \"%s\": %s",
704 path, _dbus_strerror (errno));
705 _dbus_close (listen_fd, NULL);
709 if (listen (listen_fd, 30 /* backlog */) < 0)
711 dbus_set_error (error, _dbus_error_from_errno (errno),
712 "Failed to listen on socket \"%s\": %s",
713 path, _dbus_strerror (errno));
714 _dbus_close (listen_fd, NULL);
718 if (!_dbus_set_local_creds (listen_fd, TRUE))
720 dbus_set_error (error, _dbus_error_from_errno (errno),
721 "Failed to enable LOCAL_CREDS on socket \"%s\": %s",
722 path, _dbus_strerror (errno));
727 if (!_dbus_set_fd_nonblocking (listen_fd, error))
729 _DBUS_ASSERT_ERROR_IS_SET (error);
730 _dbus_close (listen_fd, NULL);
734 /* Try opening up the permissions, but if we can't, just go ahead
735 * and continue, maybe it will be good enough.
737 if (!abstract && chmod (path, 0777) < 0)
738 _dbus_warn ("Could not set mode 0777 on socket %s\n",
745 * Creates a socket and connects to a socket at the given host
746 * and port. The connection fd is returned, and is set up as
749 * @param host the host name to connect to
750 * @param port the port to connect to
751 * @param family the address family to listen on, NULL for all
752 * @param error return location for error code
753 * @returns connection file descriptor or -1 on error
756 _dbus_connect_tcp_socket (const char *host,
762 struct addrinfo hints;
763 struct addrinfo *ai, *tmp;
765 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
767 if (!_dbus_open_tcp_socket (&fd, error))
769 _DBUS_ASSERT_ERROR_IS_SET(error);
773 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
778 hints.ai_family = AF_UNSPEC;
779 else if (!strcmp(family, "ipv4"))
780 hints.ai_family = AF_INET;
781 else if (!strcmp(family, "ipv6"))
782 hints.ai_family = AF_INET6;
785 dbus_set_error (error,
786 _dbus_error_from_errno (errno),
787 "Unknown address family %s", family);
790 hints.ai_protocol = IPPROTO_TCP;
791 hints.ai_socktype = SOCK_STREAM;
792 hints.ai_flags = AI_ADDRCONFIG;
794 if ((res = getaddrinfo(host, port, &hints, &ai)) != 0)
796 dbus_set_error (error,
797 _dbus_error_from_errno (errno),
798 "Failed to lookup host/port: \"%s:%s\": %s (%d)",
799 host, port, gai_strerror(res), res);
800 _dbus_close (fd, NULL);
807 if (!_dbus_open_socket (&fd, tmp->ai_family, SOCK_STREAM, 0, error))
810 _DBUS_ASSERT_ERROR_IS_SET(error);
813 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
815 if (connect (fd, (struct sockaddr*) tmp->ai_addr, tmp->ai_addrlen) < 0)
817 _dbus_close(fd, NULL);
829 dbus_set_error (error,
830 _dbus_error_from_errno (errno),
831 "Failed to connect to socket \"%s:%s\" %s",
832 host, port, _dbus_strerror(errno));
837 if (!_dbus_set_fd_nonblocking (fd, error))
839 _dbus_close (fd, NULL);
849 * Creates a socket and binds it to the given path, then listens on
850 * the socket. The socket is set to be nonblocking. In case of port=0
851 * a random free port is used and returned in the port parameter.
852 * If inaddr_any is specified, the hostname is ignored.
854 * @param host the host name to listen on
855 * @param port the port to listen on, if zero a free port will be used
856 * @param family the address family to listen on, NULL for all
857 * @param retport string to return the actual port listened on
858 * @param fds_p location to store returned file descriptors
859 * @param error return location for errors
860 * @returns the number of listening file descriptors or -1 on error
863 _dbus_listen_tcp_socket (const char *host,
870 int nlisten_fd = 0, *listen_fd = NULL, res, i;
871 struct addrinfo hints;
872 struct addrinfo *ai, *tmp;
875 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
880 hints.ai_family = AF_UNSPEC;
881 else if (!strcmp(family, "ipv4"))
882 hints.ai_family = AF_INET;
883 else if (!strcmp(family, "ipv6"))
884 hints.ai_family = AF_INET6;
887 dbus_set_error (error,
888 _dbus_error_from_errno (errno),
889 "Unknown address family %s", family);
893 hints.ai_protocol = IPPROTO_TCP;
894 hints.ai_socktype = SOCK_STREAM;
895 hints.ai_flags = AI_ADDRCONFIG | AI_PASSIVE;
897 redo_lookup_with_port:
898 if ((res = getaddrinfo(host, port, &hints, &ai)) != 0 || !ai)
900 dbus_set_error (error,
901 _dbus_error_from_errno (errno),
902 "Failed to lookup host/port: \"%s:%s\": %s (%d)",
903 host ? host : "*", port, gai_strerror(res), res);
910 int fd = -1, *newlisten_fd;
911 if (!_dbus_open_socket (&fd, tmp->ai_family, SOCK_STREAM, 0, error))
913 _DBUS_ASSERT_ERROR_IS_SET(error);
916 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
918 if (bind (fd, (struct sockaddr*) tmp->ai_addr, tmp->ai_addrlen) < 0)
920 _dbus_close(fd, NULL);
921 if (errno == EADDRINUSE)
923 /* Depending on kernel policy, it may or may not
924 be neccessary to bind to both IPv4 & 6 addresses
925 so ignore EADDRINUSE here */
929 dbus_set_error (error, _dbus_error_from_errno (errno),
930 "Failed to bind socket \"%s:%s\": %s",
931 host ? host : "*", port, _dbus_strerror (errno));
935 if (listen (fd, 30 /* backlog */) < 0)
937 _dbus_close (fd, NULL);
938 dbus_set_error (error, _dbus_error_from_errno (errno),
939 "Failed to listen on socket \"%s:%s\": %s",
940 host ? host : "*", port, _dbus_strerror (errno));
944 newlisten_fd = dbus_realloc(listen_fd, sizeof(int)*(nlisten_fd+1));
947 _dbus_close (fd, NULL);
948 dbus_set_error (error, _dbus_error_from_errno (errno),
949 "Failed to allocate file handle array: %s",
950 _dbus_strerror (errno));
953 listen_fd = newlisten_fd;
954 listen_fd[nlisten_fd] = fd;
957 if (!_dbus_string_get_length(retport))
959 /* If the user didn't specify a port, or used 0, then
960 the kernel chooses a port. After the first address
961 is bound to, we need to force all remaining addresses
962 to use the same port */
963 if (!port || !strcmp(port, "0"))
965 struct sockaddr_storage addr;
969 addrlen = sizeof(addr);
970 getsockname(fd, (struct sockaddr*) &addr, &addrlen);
972 if ((res = getnameinfo((struct sockaddr*)&addr, addrlen, NULL, 0,
973 portbuf, sizeof(portbuf),
974 NI_NUMERICHOST)) != 0)
976 dbus_set_error (error, _dbus_error_from_errno (errno),
977 "Failed to resolve port \"%s:%s\": %s (%s)",
978 host ? host : "*", port, gai_strerror(res), res);
981 if (!_dbus_string_append(retport, portbuf))
983 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
987 /* Release current address list & redo lookup */
988 port = _dbus_string_get_const_data(retport);
990 goto redo_lookup_with_port;
994 if (!_dbus_string_append(retport, port))
996 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1010 dbus_set_error (error, _dbus_error_from_errno (errno),
1011 "Failed to bind socket \"%s:%s\": %s",
1012 host ? host : "*", port, _dbus_strerror (errno));
1016 for (i = 0 ; i < nlisten_fd ; i++)
1018 if (!_dbus_set_fd_nonblocking (listen_fd[i], error))
1031 for (i = 0 ; i < nlisten_fd ; i++)
1032 _dbus_close(listen_fd[i], NULL);
1033 dbus_free(listen_fd);
1038 write_credentials_byte (int server_fd,
1042 char buf[1] = { '\0' };
1043 #if defined(HAVE_CMSGCRED)
1046 struct cmsgcred cred;
1053 memset (&msg, 0, sizeof (msg));
1057 msg.msg_control = &cmsg;
1058 msg.msg_controllen = sizeof (cmsg);
1059 memset (&cmsg, 0, sizeof (cmsg));
1060 cmsg.hdr.cmsg_len = sizeof (cmsg);
1061 cmsg.hdr.cmsg_level = SOL_SOCKET;
1062 cmsg.hdr.cmsg_type = SCM_CREDS;
1065 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1069 #if defined(HAVE_CMSGCRED)
1070 bytes_written = sendmsg (server_fd, &msg, 0);
1072 bytes_written = write (server_fd, buf, 1);
1075 if (bytes_written < 0 && errno == EINTR)
1078 if (bytes_written < 0)
1080 dbus_set_error (error, _dbus_error_from_errno (errno),
1081 "Failed to write credentials byte: %s",
1082 _dbus_strerror (errno));
1085 else if (bytes_written == 0)
1087 dbus_set_error (error, DBUS_ERROR_IO_ERROR,
1088 "wrote zero bytes writing credentials byte");
1093 _dbus_assert (bytes_written == 1);
1094 _dbus_verbose ("wrote credentials byte\n");
1100 * Reads a single byte which must be nul (an error occurs otherwise),
1101 * and reads unix credentials if available. Clears the credentials
1102 * object, then adds pid/uid if available, so any previous credentials
1103 * stored in the object are lost.
1105 * Return value indicates whether a byte was read, not whether
1106 * we got valid credentials. On some systems, such as Linux,
1107 * reading/writing the byte isn't actually required, but we do it
1108 * anyway just to avoid multiple codepaths.
1110 * Fails if no byte is available, so you must select() first.
1112 * The point of the byte is that on some systems we have to
1113 * use sendmsg()/recvmsg() to transmit credentials.
1115 * @param client_fd the client file descriptor
1116 * @param credentials object to add client credentials to
1117 * @param error location to store error code
1118 * @returns #TRUE on success
1121 _dbus_read_credentials_socket (int client_fd,
1122 DBusCredentials *credentials,
1128 dbus_uid_t uid_read;
1129 dbus_pid_t pid_read;
1132 uid_read = DBUS_UID_UNSET;
1133 pid_read = DBUS_PID_UNSET;
1135 #ifdef HAVE_CMSGCRED
1138 struct cmsgcred cred;
1141 #elif defined(LOCAL_CREDS)
1144 struct sockcred cred;
1148 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1150 /* The POSIX spec certainly doesn't promise this, but
1151 * we need these assertions to fail as soon as we're wrong about
1152 * it so we can do the porting fixups
1154 _dbus_assert (sizeof (pid_t) <= sizeof (dbus_pid_t));
1155 _dbus_assert (sizeof (uid_t) <= sizeof (dbus_uid_t));
1156 _dbus_assert (sizeof (gid_t) <= sizeof (dbus_gid_t));
1158 _dbus_credentials_clear (credentials);
1160 /* Systems supporting LOCAL_CREDS are configured to have this feature
1161 * enabled (if it does not conflict with HAVE_CMSGCRED) prior accepting
1162 * the connection. Therefore, the received message must carry the
1163 * credentials information without doing anything special.
1166 iov.iov_base = &buf;
1169 memset (&msg, 0, sizeof (msg));
1173 #if defined(HAVE_CMSGCRED) || defined(LOCAL_CREDS)
1174 memset (&cmsg, 0, sizeof (cmsg));
1175 msg.msg_control = &cmsg;
1176 msg.msg_controllen = sizeof (cmsg);
1180 bytes_read = recvmsg (client_fd, &msg, 0);
1187 /* EAGAIN or EWOULDBLOCK would be unexpected here since we would
1188 * normally only call read_credentials if the socket was ready
1192 dbus_set_error (error, _dbus_error_from_errno (errno),
1193 "Failed to read credentials byte: %s",
1194 _dbus_strerror (errno));
1197 else if (bytes_read == 0)
1199 /* this should not happen unless we are using recvmsg wrong,
1200 * so is essentially here for paranoia
1202 dbus_set_error (error, DBUS_ERROR_FAILED,
1203 "Failed to read credentials byte (zero-length read)");
1206 else if (buf != '\0')
1208 dbus_set_error (error, DBUS_ERROR_FAILED,
1209 "Credentials byte was not nul");
1213 #if defined(HAVE_CMSGCRED) || defined(LOCAL_CREDS)
1214 if (cmsg.hdr.cmsg_len < sizeof (cmsg) || cmsg.hdr.cmsg_type != SCM_CREDS)
1216 dbus_set_error (error, DBUS_ERROR_FAILED,
1217 "Message from recvmsg() was not SCM_CREDS");
1222 _dbus_verbose ("read credentials byte\n");
1227 int cr_len = sizeof (cr);
1229 if (getsockopt (client_fd, SOL_SOCKET, SO_PEERCRED, &cr, &cr_len) == 0 &&
1230 cr_len == sizeof (cr))
1237 _dbus_verbose ("Failed to getsockopt() credentials, returned len %d/%d: %s\n",
1238 cr_len, (int) sizeof (cr), _dbus_strerror (errno));
1240 #elif defined(HAVE_CMSGCRED)
1241 pid_read = cmsg.cred.cmcred_pid;
1242 uid_read = cmsg.cred.cmcred_euid;
1243 #elif defined(LOCAL_CREDS)
1244 pid_read = DBUS_PID_UNSET;
1245 uid_read = cmsg.cred.sc_uid;
1246 /* Since we have already got the credentials from this socket, we can
1247 * disable its LOCAL_CREDS flag if it was ever set. */
1248 _dbus_set_local_creds (client_fd, FALSE);
1249 #elif defined(HAVE_GETPEEREID)
1252 if (getpeereid (client_fd, &euid, &egid) == 0)
1258 _dbus_verbose ("Failed to getpeereid() credentials: %s\n", _dbus_strerror (errno));
1260 #elif defined(HAVE_GETPEERUCRED)
1261 ucred_t * ucred = NULL;
1262 if (getpeerucred (client_fd, &ucred) == 0)
1264 pid_read = ucred_getpid (ucred);
1265 uid_read = ucred_geteuid (ucred);
1267 /* generate audit session data based on socket ucred */
1268 adt_session_data_t *adth = NULL;
1269 adt_export_data_t *data = NULL;
1271 if (adt_start_session (&adth, NULL, 0) || (adth == NULL))
1273 _dbus_verbose ("Failed to adt_start_session(): %s\n", _dbus_strerror (errno));
1277 if (adt_set_from_ucred (adth, ucred, ADT_NEW))
1279 _dbus_verbose ("Failed to adt_set_from_ucred(): %s\n", _dbus_strerror (errno));
1283 size = adt_export_session_data (adth, &data);
1286 _dbus_verbose ("Failed to adt_export_session_data(): %s\n", _dbus_strerror (errno));
1290 _dbus_credentials_add_adt_audit_data (credentials, data, size);
1294 (void) adt_end_session (adth);
1296 #endif /* HAVE_ADT */
1300 _dbus_verbose ("Failed to getpeerucred() credentials: %s\n", _dbus_strerror (errno));
1304 #else /* !SO_PEERCRED && !HAVE_CMSGCRED && !HAVE_GETPEEREID && !HAVE_GETPEERUCRED */
1305 _dbus_verbose ("Socket credentials not supported on this OS\n");
1309 _dbus_verbose ("Credentials:"
1310 " pid "DBUS_PID_FORMAT
1311 " uid "DBUS_UID_FORMAT
1316 if (pid_read != DBUS_PID_UNSET)
1318 if (!_dbus_credentials_add_unix_pid (credentials, pid_read))
1320 _DBUS_SET_OOM (error);
1325 if (uid_read != DBUS_UID_UNSET)
1327 if (!_dbus_credentials_add_unix_uid (credentials, uid_read))
1329 _DBUS_SET_OOM (error);
1338 * Sends a single nul byte with our UNIX credentials as ancillary
1339 * data. Returns #TRUE if the data was successfully written. On
1340 * systems that don't support sending credentials, just writes a byte,
1341 * doesn't send any credentials. On some systems, such as Linux,
1342 * reading/writing the byte isn't actually required, but we do it
1343 * anyway just to avoid multiple codepaths.
1345 * Fails if no byte can be written, so you must select() first.
1347 * The point of the byte is that on some systems we have to
1348 * use sendmsg()/recvmsg() to transmit credentials.
1350 * @param server_fd file descriptor for connection to server
1351 * @param error return location for error code
1352 * @returns #TRUE if the byte was sent
1355 _dbus_send_credentials_socket (int server_fd,
1358 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1360 if (write_credentials_byte (server_fd, error))
1367 * Accepts a connection on a listening socket.
1368 * Handles EINTR for you.
1370 * @param listen_fd the listen file descriptor
1371 * @returns the connection fd of the client, or -1 on error
1374 _dbus_accept (int listen_fd)
1377 struct sockaddr addr;
1380 addrlen = sizeof (addr);
1383 client_fd = accept (listen_fd, &addr, &addrlen);
1391 _dbus_verbose ("client fd %d accepted\n", client_fd);
1397 * Checks to make sure the given directory is
1398 * private to the user
1400 * @param dir the name of the directory
1401 * @param error error return
1402 * @returns #FALSE on failure
1405 _dbus_check_dir_is_private_to_user (DBusString *dir, DBusError *error)
1407 const char *directory;
1410 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1412 directory = _dbus_string_get_const_data (dir);
1414 if (stat (directory, &sb) < 0)
1416 dbus_set_error (error, _dbus_error_from_errno (errno),
1417 "%s", _dbus_strerror (errno));
1422 if ((S_IROTH & sb.st_mode) || (S_IWOTH & sb.st_mode) ||
1423 (S_IRGRP & sb.st_mode) || (S_IWGRP & sb.st_mode))
1425 dbus_set_error (error, DBUS_ERROR_FAILED,
1426 "%s directory is not private to the user", directory);
1434 fill_user_info_from_passwd (struct passwd *p,
1438 _dbus_assert (p->pw_name != NULL);
1439 _dbus_assert (p->pw_dir != NULL);
1441 info->uid = p->pw_uid;
1442 info->primary_gid = p->pw_gid;
1443 info->username = _dbus_strdup (p->pw_name);
1444 info->homedir = _dbus_strdup (p->pw_dir);
1446 if (info->username == NULL ||
1447 info->homedir == NULL)
1449 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1457 fill_user_info (DBusUserInfo *info,
1459 const DBusString *username,
1462 const char *username_c;
1464 /* exactly one of username/uid provided */
1465 _dbus_assert (username != NULL || uid != DBUS_UID_UNSET);
1466 _dbus_assert (username == NULL || uid == DBUS_UID_UNSET);
1468 info->uid = DBUS_UID_UNSET;
1469 info->primary_gid = DBUS_GID_UNSET;
1470 info->group_ids = NULL;
1471 info->n_group_ids = 0;
1472 info->username = NULL;
1473 info->homedir = NULL;
1475 if (username != NULL)
1476 username_c = _dbus_string_get_const_data (username);
1480 /* For now assuming that the getpwnam() and getpwuid() flavors
1481 * are always symmetrical, if not we have to add more configure
1485 #if defined (HAVE_POSIX_GETPWNAM_R) || defined (HAVE_NONPOSIX_GETPWNAM_R)
1491 struct passwd p_str;
1493 /* retrieve maximum needed size for buf */
1494 buflen = sysconf (_SC_GETPW_R_SIZE_MAX);
1496 /* sysconf actually returns a long, but everything else expects size_t,
1497 * so just recast here.
1498 * https://bugs.freedesktop.org/show_bug.cgi?id=17061
1500 if ((long) buflen <= 0)
1506 buf = dbus_malloc (buflen);
1509 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1514 #ifdef HAVE_POSIX_GETPWNAM_R
1515 if (uid != DBUS_UID_UNSET)
1516 result = getpwuid_r (uid, &p_str, buf, buflen,
1519 result = getpwnam_r (username_c, &p_str, buf, buflen,
1522 if (uid != DBUS_UID_UNSET)
1523 p = getpwuid_r (uid, &p_str, buf, buflen);
1525 p = getpwnam_r (username_c, &p_str, buf, buflen);
1527 #endif /* !HAVE_POSIX_GETPWNAM_R */
1528 //Try a bigger buffer if ERANGE was returned
1529 if (result == ERANGE && buflen < 512 * 1024)
1539 if (result == 0 && p == &p_str)
1541 if (!fill_user_info_from_passwd (p, info, error))
1550 dbus_set_error (error, _dbus_error_from_errno (errno),
1551 "User \"%s\" unknown or no memory to allocate password entry\n",
1552 username_c ? username_c : "???");
1553 _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
1558 #else /* ! HAVE_GETPWNAM_R */
1560 /* I guess we're screwed on thread safety here */
1563 if (uid != DBUS_UID_UNSET)
1566 p = getpwnam (username_c);
1570 if (!fill_user_info_from_passwd (p, info, error))
1577 dbus_set_error (error, _dbus_error_from_errno (errno),
1578 "User \"%s\" unknown or no memory to allocate password entry\n",
1579 username_c ? username_c : "???");
1580 _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
1584 #endif /* ! HAVE_GETPWNAM_R */
1586 /* Fill this in so we can use it to get groups */
1587 username_c = info->username;
1589 #ifdef HAVE_GETGROUPLIST
1596 buf = dbus_new (gid_t, buf_count);
1599 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1603 if (getgrouplist (username_c,
1605 buf, &buf_count) < 0)
1607 gid_t *new = dbus_realloc (buf, buf_count * sizeof (buf[0]));
1610 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1618 if (getgrouplist (username_c, info->primary_gid, buf, &buf_count) < 0)
1620 dbus_set_error (error,
1621 _dbus_error_from_errno (errno),
1622 "Failed to get groups for username \"%s\" primary GID "
1623 DBUS_GID_FORMAT ": %s\n",
1624 username_c, info->primary_gid,
1625 _dbus_strerror (errno));
1631 info->group_ids = dbus_new (dbus_gid_t, buf_count);
1632 if (info->group_ids == NULL)
1634 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1639 for (i = 0; i < buf_count; ++i)
1640 info->group_ids[i] = buf[i];
1642 info->n_group_ids = buf_count;
1646 #else /* HAVE_GETGROUPLIST */
1648 /* We just get the one group ID */
1649 info->group_ids = dbus_new (dbus_gid_t, 1);
1650 if (info->group_ids == NULL)
1652 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1656 info->n_group_ids = 1;
1658 (info->group_ids)[0] = info->primary_gid;
1660 #endif /* HAVE_GETGROUPLIST */
1662 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1667 _DBUS_ASSERT_ERROR_IS_SET (error);
1672 * Gets user info for the given username.
1674 * @param info user info object to initialize
1675 * @param username the username
1676 * @param error error return
1677 * @returns #TRUE on success
1680 _dbus_user_info_fill (DBusUserInfo *info,
1681 const DBusString *username,
1684 return fill_user_info (info, DBUS_UID_UNSET,
1689 * Gets user info for the given user ID.
1691 * @param info user info object to initialize
1692 * @param uid the user ID
1693 * @param error error return
1694 * @returns #TRUE on success
1697 _dbus_user_info_fill_uid (DBusUserInfo *info,
1701 return fill_user_info (info, uid,
1706 * Adds the credentials of the current process to the
1707 * passed-in credentials object.
1709 * @param credentials credentials to add to
1710 * @returns #FALSE if no memory; does not properly roll back on failure, so only some credentials may have been added
1713 _dbus_credentials_add_from_current_process (DBusCredentials *credentials)
1715 /* The POSIX spec certainly doesn't promise this, but
1716 * we need these assertions to fail as soon as we're wrong about
1717 * it so we can do the porting fixups
1719 _dbus_assert (sizeof (pid_t) <= sizeof (dbus_pid_t));
1720 _dbus_assert (sizeof (uid_t) <= sizeof (dbus_uid_t));
1721 _dbus_assert (sizeof (gid_t) <= sizeof (dbus_gid_t));
1723 if (!_dbus_credentials_add_unix_pid(credentials, _dbus_getpid()))
1725 if (!_dbus_credentials_add_unix_uid(credentials, _dbus_geteuid()))
1732 * Append to the string the identity we would like to have when we
1733 * authenticate, on UNIX this is the current process UID and on
1734 * Windows something else, probably a Windows SID string. No escaping
1735 * is required, that is done in dbus-auth.c. The username here
1736 * need not be anything human-readable, it can be the machine-readable
1737 * form i.e. a user id.
1739 * @param str the string to append to
1740 * @returns #FALSE on no memory
1743 _dbus_append_user_from_current_process (DBusString *str)
1745 return _dbus_string_append_uint (str,
1750 * Gets our process ID
1751 * @returns process ID
1760 * @returns process UID
1768 /** Gets our effective UID
1769 * @returns process effective UID
1772 _dbus_geteuid (void)
1778 * The only reason this is separate from _dbus_getpid() is to allow it
1779 * on Windows for logging but not for other purposes.
1781 * @returns process ID to put in log messages
1784 _dbus_pid_for_log (void)
1790 * Gets a UID from a UID string.
1792 * @param uid_str the UID in string form
1793 * @param uid UID to fill in
1794 * @returns #TRUE if successfully filled in UID
1797 _dbus_parse_uid (const DBusString *uid_str,
1803 if (_dbus_string_get_length (uid_str) == 0)
1805 _dbus_verbose ("UID string was zero length\n");
1811 if (!_dbus_string_parse_int (uid_str, 0, &val,
1814 _dbus_verbose ("could not parse string as a UID\n");
1818 if (end != _dbus_string_get_length (uid_str))
1820 _dbus_verbose ("string contained trailing stuff after UID\n");
1830 _DBUS_DEFINE_GLOBAL_LOCK (atomic);
1832 #if DBUS_USE_ATOMIC_INT_486_COND
1833 /* Taken from CVS version 1.7 of glibc's sysdeps/i386/i486/atomicity.h */
1834 /* Since the asm stuff here is gcc-specific we go ahead and use "inline" also */
1835 static inline dbus_int32_t
1836 atomic_exchange_and_add (DBusAtomic *atomic,
1837 volatile dbus_int32_t val)
1839 register dbus_int32_t result;
1841 __asm__ __volatile__ ("lock; xaddl %0,%1"
1842 : "=r" (result), "=m" (atomic->value)
1843 : "0" (val), "m" (atomic->value));
1849 * Atomically increments an integer
1851 * @param atomic pointer to the integer to increment
1852 * @returns the value before incrementing
1854 * @todo implement arch-specific faster atomic ops
1857 _dbus_atomic_inc (DBusAtomic *atomic)
1859 #if DBUS_USE_ATOMIC_INT_486_COND
1860 return atomic_exchange_and_add (atomic, 1);
1863 _DBUS_LOCK (atomic);
1864 res = atomic->value;
1866 _DBUS_UNLOCK (atomic);
1872 * Atomically decrement an integer
1874 * @param atomic pointer to the integer to decrement
1875 * @returns the value before decrementing
1877 * @todo implement arch-specific faster atomic ops
1880 _dbus_atomic_dec (DBusAtomic *atomic)
1882 #if DBUS_USE_ATOMIC_INT_486_COND
1883 return atomic_exchange_and_add (atomic, -1);
1887 _DBUS_LOCK (atomic);
1888 res = atomic->value;
1890 _DBUS_UNLOCK (atomic);
1895 #ifdef DBUS_BUILD_TESTS
1897 * @returns process GID
1907 * Wrapper for poll().
1909 * @param fds the file descriptors to poll
1910 * @param n_fds number of descriptors in the array
1911 * @param timeout_milliseconds timeout or -1 for infinite
1912 * @returns numbers of fds with revents, or <0 on error
1915 _dbus_poll (DBusPollFD *fds,
1917 int timeout_milliseconds)
1919 #if defined(HAVE_POLL) && !defined(BROKEN_POLL)
1920 /* This big thing is a constant expression and should get optimized
1921 * out of existence. So it's more robust than a configure check at
1924 if (_DBUS_POLLIN == POLLIN &&
1925 _DBUS_POLLPRI == POLLPRI &&
1926 _DBUS_POLLOUT == POLLOUT &&
1927 _DBUS_POLLERR == POLLERR &&
1928 _DBUS_POLLHUP == POLLHUP &&
1929 _DBUS_POLLNVAL == POLLNVAL &&
1930 sizeof (DBusPollFD) == sizeof (struct pollfd) &&
1931 _DBUS_STRUCT_OFFSET (DBusPollFD, fd) ==
1932 _DBUS_STRUCT_OFFSET (struct pollfd, fd) &&
1933 _DBUS_STRUCT_OFFSET (DBusPollFD, events) ==
1934 _DBUS_STRUCT_OFFSET (struct pollfd, events) &&
1935 _DBUS_STRUCT_OFFSET (DBusPollFD, revents) ==
1936 _DBUS_STRUCT_OFFSET (struct pollfd, revents))
1938 return poll ((struct pollfd*) fds,
1940 timeout_milliseconds);
1944 /* We have to convert the DBusPollFD to an array of
1945 * struct pollfd, poll, and convert back.
1947 _dbus_warn ("didn't implement poll() properly for this system yet\n");
1950 #else /* ! HAVE_POLL */
1952 fd_set read_set, write_set, err_set;
1958 FD_ZERO (&read_set);
1959 FD_ZERO (&write_set);
1962 for (i = 0; i < n_fds; i++)
1964 DBusPollFD *fdp = &fds[i];
1966 if (fdp->events & _DBUS_POLLIN)
1967 FD_SET (fdp->fd, &read_set);
1969 if (fdp->events & _DBUS_POLLOUT)
1970 FD_SET (fdp->fd, &write_set);
1972 FD_SET (fdp->fd, &err_set);
1974 max_fd = MAX (max_fd, fdp->fd);
1977 tv.tv_sec = timeout_milliseconds / 1000;
1978 tv.tv_usec = (timeout_milliseconds % 1000) * 1000;
1980 ready = select (max_fd + 1, &read_set, &write_set, &err_set,
1981 timeout_milliseconds < 0 ? NULL : &tv);
1985 for (i = 0; i < n_fds; i++)
1987 DBusPollFD *fdp = &fds[i];
1991 if (FD_ISSET (fdp->fd, &read_set))
1992 fdp->revents |= _DBUS_POLLIN;
1994 if (FD_ISSET (fdp->fd, &write_set))
1995 fdp->revents |= _DBUS_POLLOUT;
1997 if (FD_ISSET (fdp->fd, &err_set))
1998 fdp->revents |= _DBUS_POLLERR;
2007 * Get current time, as in gettimeofday().
2009 * @param tv_sec return location for number of seconds
2010 * @param tv_usec return location for number of microseconds (thousandths)
2013 _dbus_get_current_time (long *tv_sec,
2018 gettimeofday (&t, NULL);
2023 *tv_usec = t.tv_usec;
2027 * Appends the contents of the given file to the string,
2028 * returning error code. At the moment, won't open a file
2029 * more than a megabyte in size.
2031 * @param str the string to append to
2032 * @param filename filename to load
2033 * @param error place to set an error
2034 * @returns #FALSE if error was set
2037 _dbus_file_get_contents (DBusString *str,
2038 const DBusString *filename,
2045 const char *filename_c;
2047 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2049 filename_c = _dbus_string_get_const_data (filename);
2051 /* O_BINARY useful on Cygwin */
2052 fd = open (filename_c, O_RDONLY | O_BINARY);
2055 dbus_set_error (error, _dbus_error_from_errno (errno),
2056 "Failed to open \"%s\": %s",
2058 _dbus_strerror (errno));
2062 _dbus_verbose ("file fd %d opened\n", fd);
2064 if (fstat (fd, &sb) < 0)
2066 dbus_set_error (error, _dbus_error_from_errno (errno),
2067 "Failed to stat \"%s\": %s",
2069 _dbus_strerror (errno));
2071 _dbus_verbose ("fstat() failed: %s",
2072 _dbus_strerror (errno));
2074 _dbus_close (fd, NULL);
2079 if (sb.st_size > _DBUS_ONE_MEGABYTE)
2081 dbus_set_error (error, DBUS_ERROR_FAILED,
2082 "File size %lu of \"%s\" is too large.",
2083 (unsigned long) sb.st_size, filename_c);
2084 _dbus_close (fd, NULL);
2089 orig_len = _dbus_string_get_length (str);
2090 if (sb.st_size > 0 && S_ISREG (sb.st_mode))
2094 while (total < (int) sb.st_size)
2096 bytes_read = _dbus_read (fd, str,
2097 sb.st_size - total);
2098 if (bytes_read <= 0)
2100 dbus_set_error (error, _dbus_error_from_errno (errno),
2101 "Error reading \"%s\": %s",
2103 _dbus_strerror (errno));
2105 _dbus_verbose ("read() failed: %s",
2106 _dbus_strerror (errno));
2108 _dbus_close (fd, NULL);
2109 _dbus_string_set_length (str, orig_len);
2113 total += bytes_read;
2116 _dbus_close (fd, NULL);
2119 else if (sb.st_size != 0)
2121 _dbus_verbose ("Can only open regular files at the moment.\n");
2122 dbus_set_error (error, DBUS_ERROR_FAILED,
2123 "\"%s\" is not a regular file",
2125 _dbus_close (fd, NULL);
2130 _dbus_close (fd, NULL);
2136 * Writes a string out to a file. If the file exists,
2137 * it will be atomically overwritten by the new data.
2139 * @param str the string to write out
2140 * @param filename the file to save string to
2141 * @param error error to be filled in on failure
2142 * @returns #FALSE on failure
2145 _dbus_string_save_to_file (const DBusString *str,
2146 const DBusString *filename,
2151 const char *filename_c;
2152 DBusString tmp_filename;
2153 const char *tmp_filename_c;
2155 dbus_bool_t need_unlink;
2158 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2162 need_unlink = FALSE;
2164 if (!_dbus_string_init (&tmp_filename))
2166 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2170 if (!_dbus_string_copy (filename, 0, &tmp_filename, 0))
2172 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2173 _dbus_string_free (&tmp_filename);
2177 if (!_dbus_string_append (&tmp_filename, "."))
2179 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2180 _dbus_string_free (&tmp_filename);
2184 #define N_TMP_FILENAME_RANDOM_BYTES 8
2185 if (!_dbus_generate_random_ascii (&tmp_filename, N_TMP_FILENAME_RANDOM_BYTES))
2187 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2188 _dbus_string_free (&tmp_filename);
2192 filename_c = _dbus_string_get_const_data (filename);
2193 tmp_filename_c = _dbus_string_get_const_data (&tmp_filename);
2195 fd = open (tmp_filename_c, O_WRONLY | O_BINARY | O_EXCL | O_CREAT,
2199 dbus_set_error (error, _dbus_error_from_errno (errno),
2200 "Could not create %s: %s", tmp_filename_c,
2201 _dbus_strerror (errno));
2205 _dbus_verbose ("tmp file fd %d opened\n", fd);
2210 bytes_to_write = _dbus_string_get_length (str);
2212 while (total < bytes_to_write)
2216 bytes_written = _dbus_write (fd, str, total,
2217 bytes_to_write - total);
2219 if (bytes_written <= 0)
2221 dbus_set_error (error, _dbus_error_from_errno (errno),
2222 "Could not write to %s: %s", tmp_filename_c,
2223 _dbus_strerror (errno));
2228 total += bytes_written;
2233 dbus_set_error (error, _dbus_error_from_errno (errno),
2234 "Could not synchronize file %s: %s",
2235 tmp_filename_c, _dbus_strerror (errno));
2240 if (!_dbus_close (fd, NULL))
2242 dbus_set_error (error, _dbus_error_from_errno (errno),
2243 "Could not close file %s: %s",
2244 tmp_filename_c, _dbus_strerror (errno));
2251 if (rename (tmp_filename_c, filename_c) < 0)
2253 dbus_set_error (error, _dbus_error_from_errno (errno),
2254 "Could not rename %s to %s: %s",
2255 tmp_filename_c, filename_c,
2256 _dbus_strerror (errno));
2261 need_unlink = FALSE;
2266 /* close first, then unlink, to prevent ".nfs34234235" garbage
2271 _dbus_close (fd, NULL);
2273 if (need_unlink && unlink (tmp_filename_c) < 0)
2274 _dbus_verbose ("Failed to unlink temp file %s: %s\n",
2275 tmp_filename_c, _dbus_strerror (errno));
2277 _dbus_string_free (&tmp_filename);
2280 _DBUS_ASSERT_ERROR_IS_SET (error);
2285 /** Makes the file readable by every user in the system.
2287 * @param filename the filename
2288 * @param error error location
2289 * @returns #TRUE if the file's permissions could be changed.
2292 _dbus_make_file_world_readable(const DBusString *filename,
2295 const char *filename_c;
2297 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2299 filename_c = _dbus_string_get_const_data (filename);
2300 if (chmod (filename_c, 0644) == -1)
2302 dbus_set_error (error,
2304 "Could not change permissions of file %s: %s\n",
2306 _dbus_strerror (errno));
2312 /** Creates the given file, failing if the file already exists.
2314 * @param filename the filename
2315 * @param error error location
2316 * @returns #TRUE if we created the file and it didn't exist
2319 _dbus_create_file_exclusively (const DBusString *filename,
2323 const char *filename_c;
2325 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2327 filename_c = _dbus_string_get_const_data (filename);
2329 fd = open (filename_c, O_WRONLY | O_BINARY | O_EXCL | O_CREAT,
2333 dbus_set_error (error,
2335 "Could not create file %s: %s\n",
2337 _dbus_strerror (errno));
2341 _dbus_verbose ("exclusive file fd %d opened\n", fd);
2343 if (!_dbus_close (fd, NULL))
2345 dbus_set_error (error,
2347 "Could not close file %s: %s\n",
2349 _dbus_strerror (errno));
2357 * Deletes the given file.
2359 * @param filename the filename
2360 * @param error error location
2362 * @returns #TRUE if unlink() succeeded
2365 _dbus_delete_file (const DBusString *filename,
2368 const char *filename_c;
2370 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2372 filename_c = _dbus_string_get_const_data (filename);
2374 if (unlink (filename_c) < 0)
2376 dbus_set_error (error, DBUS_ERROR_FAILED,
2377 "Failed to delete file %s: %s\n",
2378 filename_c, _dbus_strerror (errno));
2386 * Creates a directory; succeeds if the directory
2387 * is created or already existed.
2389 * @param filename directory filename
2390 * @param error initialized error object
2391 * @returns #TRUE on success
2394 _dbus_create_directory (const DBusString *filename,
2397 const char *filename_c;
2399 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2401 filename_c = _dbus_string_get_const_data (filename);
2403 if (mkdir (filename_c, 0700) < 0)
2405 if (errno == EEXIST)
2408 dbus_set_error (error, DBUS_ERROR_FAILED,
2409 "Failed to create directory %s: %s\n",
2410 filename_c, _dbus_strerror (errno));
2418 * Appends the given filename to the given directory.
2420 * @todo it might be cute to collapse multiple '/' such as "foo//"
2423 * @param dir the directory name
2424 * @param next_component the filename
2425 * @returns #TRUE on success
2428 _dbus_concat_dir_and_file (DBusString *dir,
2429 const DBusString *next_component)
2431 dbus_bool_t dir_ends_in_slash;
2432 dbus_bool_t file_starts_with_slash;
2434 if (_dbus_string_get_length (dir) == 0 ||
2435 _dbus_string_get_length (next_component) == 0)
2438 dir_ends_in_slash = '/' == _dbus_string_get_byte (dir,
2439 _dbus_string_get_length (dir) - 1);
2441 file_starts_with_slash = '/' == _dbus_string_get_byte (next_component, 0);
2443 if (dir_ends_in_slash && file_starts_with_slash)
2445 _dbus_string_shorten (dir, 1);
2447 else if (!(dir_ends_in_slash || file_starts_with_slash))
2449 if (!_dbus_string_append_byte (dir, '/'))
2453 return _dbus_string_copy (next_component, 0, dir,
2454 _dbus_string_get_length (dir));
2457 /** nanoseconds in a second */
2458 #define NANOSECONDS_PER_SECOND 1000000000
2459 /** microseconds in a second */
2460 #define MICROSECONDS_PER_SECOND 1000000
2461 /** milliseconds in a second */
2462 #define MILLISECONDS_PER_SECOND 1000
2463 /** nanoseconds in a millisecond */
2464 #define NANOSECONDS_PER_MILLISECOND 1000000
2465 /** microseconds in a millisecond */
2466 #define MICROSECONDS_PER_MILLISECOND 1000
2469 * Sleeps the given number of milliseconds.
2470 * @param milliseconds number of milliseconds
2473 _dbus_sleep_milliseconds (int milliseconds)
2475 #ifdef HAVE_NANOSLEEP
2476 struct timespec req;
2477 struct timespec rem;
2479 req.tv_sec = milliseconds / MILLISECONDS_PER_SECOND;
2480 req.tv_nsec = (milliseconds % MILLISECONDS_PER_SECOND) * NANOSECONDS_PER_MILLISECOND;
2484 while (nanosleep (&req, &rem) < 0 && errno == EINTR)
2486 #elif defined (HAVE_USLEEP)
2487 usleep (milliseconds * MICROSECONDS_PER_MILLISECOND);
2488 #else /* ! HAVE_USLEEP */
2489 sleep (MAX (milliseconds / 1000, 1));
2494 _dbus_generate_pseudorandom_bytes (DBusString *str,
2500 old_len = _dbus_string_get_length (str);
2502 if (!_dbus_string_lengthen (str, n_bytes))
2505 p = _dbus_string_get_data_len (str, old_len, n_bytes);
2507 _dbus_generate_pseudorandom_bytes_buffer (p, n_bytes);
2513 * Generates the given number of random bytes,
2514 * using the best mechanism we can come up with.
2516 * @param str the string
2517 * @param n_bytes the number of random bytes to append to string
2518 * @returns #TRUE on success, #FALSE if no memory
2521 _dbus_generate_random_bytes (DBusString *str,
2527 /* FALSE return means "no memory", if it could
2528 * mean something else then we'd need to return
2529 * a DBusError. So we always fall back to pseudorandom
2533 old_len = _dbus_string_get_length (str);
2536 /* note, urandom on linux will fall back to pseudorandom */
2537 fd = open ("/dev/urandom", O_RDONLY);
2539 return _dbus_generate_pseudorandom_bytes (str, n_bytes);
2541 _dbus_verbose ("/dev/urandom fd %d opened\n", fd);
2543 if (_dbus_read (fd, str, n_bytes) != n_bytes)
2545 _dbus_close (fd, NULL);
2546 _dbus_string_set_length (str, old_len);
2547 return _dbus_generate_pseudorandom_bytes (str, n_bytes);
2550 _dbus_verbose ("Read %d bytes from /dev/urandom\n",
2553 _dbus_close (fd, NULL);
2559 * Exit the process, returning the given value.
2561 * @param code the exit code
2564 _dbus_exit (int code)
2570 * A wrapper around strerror() because some platforms
2571 * may be lame and not have strerror(). Also, never
2574 * @param error_number errno.
2575 * @returns error description.
2578 _dbus_strerror (int error_number)
2582 msg = strerror (error_number);
2590 * signal (SIGPIPE, SIG_IGN);
2593 _dbus_disable_sigpipe (void)
2595 signal (SIGPIPE, SIG_IGN);
2599 * Sets the file descriptor to be close
2600 * on exec. Should be called for all file
2601 * descriptors in D-Bus code.
2603 * @param fd the file descriptor
2606 _dbus_fd_set_close_on_exec (int fd)
2610 val = fcntl (fd, F_GETFD, 0);
2617 fcntl (fd, F_SETFD, val);
2621 * Closes a file descriptor.
2623 * @param fd the file descriptor
2624 * @param error error object
2625 * @returns #FALSE if error set
2628 _dbus_close (int fd,
2631 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2639 dbus_set_error (error, _dbus_error_from_errno (errno),
2640 "Could not close fd %d", fd);
2648 * Sets a file descriptor to be nonblocking.
2650 * @param fd the file descriptor.
2651 * @param error address of error location.
2652 * @returns #TRUE on success.
2655 _dbus_set_fd_nonblocking (int fd,
2660 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2662 val = fcntl (fd, F_GETFL, 0);
2665 dbus_set_error (error, _dbus_error_from_errno (errno),
2666 "Failed to get flags from file descriptor %d: %s",
2667 fd, _dbus_strerror (errno));
2668 _dbus_verbose ("Failed to get flags for fd %d: %s\n", fd,
2669 _dbus_strerror (errno));
2673 if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
2675 dbus_set_error (error, _dbus_error_from_errno (errno),
2676 "Failed to set nonblocking flag of file descriptor %d: %s",
2677 fd, _dbus_strerror (errno));
2678 _dbus_verbose ("Failed to set fd %d nonblocking: %s\n",
2679 fd, _dbus_strerror (errno));
2688 * On GNU libc systems, print a crude backtrace to stderr. On other
2689 * systems, print "no backtrace support" and block for possible gdb
2690 * attachment if an appropriate environment variable is set.
2693 _dbus_print_backtrace (void)
2695 #if defined (HAVE_BACKTRACE) && defined (DBUS_BUILT_R_DYNAMIC)
2701 bt_size = backtrace (bt, 500);
2703 syms = backtrace_symbols (bt, bt_size);
2708 /* don't use dbus_warn since it can _dbus_abort() */
2709 fprintf (stderr, " %s\n", syms[i]);
2715 #elif defined (HAVE_BACKTRACE) && ! defined (DBUS_BUILT_R_DYNAMIC)
2716 fprintf (stderr, " D-Bus not built with -rdynamic so unable to print a backtrace\n");
2718 fprintf (stderr, " D-Bus not compiled with backtrace support so unable to print a backtrace\n");
2723 * Creates a full-duplex pipe (as in socketpair()).
2724 * Sets both ends of the pipe nonblocking.
2726 * @todo libdbus only uses this for the debug-pipe server, so in
2727 * principle it could be in dbus-sysdeps-util.c, except that
2728 * dbus-sysdeps-util.c isn't in libdbus when tests are enabled and the
2729 * debug-pipe server is used.
2731 * @param fd1 return location for one end
2732 * @param fd2 return location for the other end
2733 * @param blocking #TRUE if pipe should be blocking
2734 * @param error error return
2735 * @returns #FALSE on failure (if error is set)
2738 _dbus_full_duplex_pipe (int *fd1,
2740 dbus_bool_t blocking,
2743 #ifdef HAVE_SOCKETPAIR
2746 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2748 if (socketpair (AF_UNIX, SOCK_STREAM, 0, fds) < 0)
2750 dbus_set_error (error, _dbus_error_from_errno (errno),
2751 "Could not create full-duplex pipe");
2756 (!_dbus_set_fd_nonblocking (fds[0], NULL) ||
2757 !_dbus_set_fd_nonblocking (fds[1], NULL)))
2759 dbus_set_error (error, _dbus_error_from_errno (errno),
2760 "Could not set full-duplex pipe nonblocking");
2762 _dbus_close (fds[0], NULL);
2763 _dbus_close (fds[1], NULL);
2771 _dbus_verbose ("full-duplex pipe %d <-> %d\n",
2776 _dbus_warn ("_dbus_full_duplex_pipe() not implemented on this OS\n");
2777 dbus_set_error (error, DBUS_ERROR_FAILED,
2778 "_dbus_full_duplex_pipe() not implemented on this OS");
2784 * Measure the length of the given format string and arguments,
2785 * not including the terminating nul.
2787 * @param format a printf-style format string
2788 * @param args arguments for the format string
2789 * @returns length of the given format string and args
2792 _dbus_printf_string_upper_bound (const char *format,
2796 return vsnprintf (&c, 1, format, args);
2800 * Gets the temporary files directory by inspecting the environment variables
2801 * TMPDIR, TMP, and TEMP in that order. If none of those are set "/tmp" is returned
2803 * @returns location of temp directory
2806 _dbus_get_tmpdir(void)
2808 static const char* tmpdir = NULL;
2812 /* TMPDIR is what glibc uses, then
2813 * glibc falls back to the P_tmpdir macro which
2814 * just expands to "/tmp"
2817 tmpdir = getenv("TMPDIR");
2819 /* These two env variables are probably
2820 * broken, but maybe some OS uses them?
2823 tmpdir = getenv("TMP");
2825 tmpdir = getenv("TEMP");
2827 /* And this is the sane fallback. */
2832 _dbus_assert(tmpdir != NULL);
2838 * Determines the address of the session bus by querying a
2839 * platform-specific method.
2841 * If successful, returns #TRUE and appends the address to @p
2842 * address. If a failure happens, returns #FALSE and
2843 * sets an error in @p error.
2845 * @param address a DBusString where the address can be stored
2846 * @param error a DBusError to store the error in case of failure
2847 * @returns #TRUE on success, #FALSE if an error happened
2850 _dbus_get_autolaunch_address (DBusString *address,
2853 static char *argv[6];
2854 int address_pipe[2] = { -1, -1 };
2855 int errors_pipe[2] = { -1, -1 };
2864 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2867 if (!_dbus_string_init (&uuid))
2869 _DBUS_SET_OOM (error);
2873 if (!_dbus_get_local_machine_uuid_encoded (&uuid))
2875 _DBUS_SET_OOM (error);
2880 argv[i] = "dbus-launch";
2882 argv[i] = "--autolaunch";
2884 argv[i] = _dbus_string_get_data (&uuid);
2886 argv[i] = "--binary-syntax";
2888 argv[i] = "--close-stderr";
2893 _dbus_assert (i == _DBUS_N_ELEMENTS (argv));
2895 orig_len = _dbus_string_get_length (address);
2899 if (pipe (address_pipe) < 0)
2901 dbus_set_error (error, _dbus_error_from_errno (errno),
2902 "Failed to create a pipe: %s",
2903 _dbus_strerror (errno));
2904 _dbus_verbose ("Failed to create a pipe to call dbus-launch: %s\n",
2905 _dbus_strerror (errno));
2908 if (pipe (errors_pipe) < 0)
2910 dbus_set_error (error, _dbus_error_from_errno (errno),
2911 "Failed to create a pipe: %s",
2912 _dbus_strerror (errno));
2913 _dbus_verbose ("Failed to create a pipe to call dbus-launch: %s\n",
2914 _dbus_strerror (errno));
2921 dbus_set_error (error, _dbus_error_from_errno (errno),
2922 "Failed to fork(): %s",
2923 _dbus_strerror (errno));
2924 _dbus_verbose ("Failed to fork() to call dbus-launch: %s\n",
2925 _dbus_strerror (errno));
2935 fd = open ("/dev/null", O_RDWR);
2937 /* huh?! can't open /dev/null? */
2940 _dbus_verbose ("/dev/null fd %d opened\n", fd);
2943 close (address_pipe[READ_END]);
2944 close (errors_pipe[READ_END]);
2945 close (0); /* close stdin */
2946 close (1); /* close stdout */
2947 close (2); /* close stderr */
2949 if (dup2 (fd, 0) == -1)
2951 if (dup2 (address_pipe[WRITE_END], 1) == -1)
2953 if (dup2 (errors_pipe[WRITE_END], 2) == -1)
2956 maxfds = sysconf (_SC_OPEN_MAX);
2957 /* Pick something reasonable if for some reason sysconf
2962 /* close all inherited fds */
2963 for (i = 3; i < maxfds; i++)
2966 execv (DBUS_BINDIR "/dbus-launch", argv);
2968 /* failed, try searching PATH */
2969 execvp ("dbus-launch", argv);
2971 /* still nothing, we failed */
2975 /* parent process */
2976 close (address_pipe[WRITE_END]);
2977 close (errors_pipe[WRITE_END]);
2978 address_pipe[WRITE_END] = -1;
2979 errors_pipe[WRITE_END] = -1;
2984 ret = _dbus_read (address_pipe[READ_END], address, 1024);
2988 /* reap the child process to avoid it lingering as zombie */
2991 ret = waitpid (pid, &status, 0);
2993 while (ret == -1 && errno == EINTR);
2995 /* We succeeded if the process exited with status 0 and
2996 anything was read */
2997 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0 ||
2998 _dbus_string_get_length (address) == orig_len)
3000 /* The process ended with error */
3001 DBusString error_message;
3002 _dbus_string_init (&error_message);
3006 ret = _dbus_read (errors_pipe[READ_END], &error_message, 1024);
3010 _dbus_string_set_length (address, orig_len);
3011 if (_dbus_string_get_length (&error_message) > 0)
3012 dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
3013 "dbus-launch failed to autolaunch D-Bus session: %s",
3014 _dbus_string_get_data (&error_message));
3016 dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
3017 "Failed to execute dbus-launch to autolaunch D-Bus session");
3025 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3027 _DBUS_ASSERT_ERROR_IS_SET (error);
3029 if (address_pipe[0] != -1)
3030 close (address_pipe[0]);
3031 if (address_pipe[1] != -1)
3032 close (address_pipe[1]);
3033 if (errors_pipe[0] != -1)
3034 close (errors_pipe[0]);
3035 if (errors_pipe[1] != -1)
3036 close (errors_pipe[1]);
3038 _dbus_string_free (&uuid);
3043 * Reads the uuid of the machine we're running on from
3044 * the dbus configuration. Optionally try to create it
3045 * (only root can do this usually).
3047 * On UNIX, reads a file that gets created by dbus-uuidgen
3048 * in a post-install script. On Windows, if there's a standard
3049 * machine uuid we could just use that, but I can't find one
3050 * with the right properties (the hardware profile guid can change
3051 * without rebooting I believe). If there's no standard one
3052 * we might want to use the registry instead of a file for
3053 * this, and I'm not sure how we'd ensure the uuid gets created.
3055 * @param machine_id guid to init with the machine's uuid
3056 * @param create_if_not_found try to create the uuid if it doesn't exist
3057 * @param error the error return
3058 * @returns #FALSE if the error is set
3061 _dbus_read_local_machine_uuid (DBusGUID *machine_id,
3062 dbus_bool_t create_if_not_found,
3065 DBusString filename;
3066 _dbus_string_init_const (&filename, DBUS_MACHINE_UUID_FILE);
3067 return _dbus_read_uuid_file (&filename, machine_id, create_if_not_found, error);
3070 #define DBUS_UNIX_STANDARD_SESSION_SERVICEDIR "/dbus-1/services"
3071 #define DBUS_UNIX_STANDARD_SYSTEM_SERVICEDIR "/dbus-1/system-services"
3075 * Returns the standard directories for a session bus to look for service
3078 * On UNIX this should be the standard xdg freedesktop.org data directories:
3080 * XDG_DATA_HOME=${XDG_DATA_HOME-$HOME/.local/share}
3081 * XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}
3087 * @param dirs the directory list we are returning
3088 * @returns #FALSE on OOM
3092 _dbus_get_standard_session_servicedirs (DBusList **dirs)
3094 const char *xdg_data_home;
3095 const char *xdg_data_dirs;
3096 DBusString servicedir_path;
3098 if (!_dbus_string_init (&servicedir_path))
3101 xdg_data_home = _dbus_getenv ("XDG_DATA_HOME");
3102 xdg_data_dirs = _dbus_getenv ("XDG_DATA_DIRS");
3104 if (xdg_data_dirs != NULL)
3106 if (!_dbus_string_append (&servicedir_path, xdg_data_dirs))
3109 if (!_dbus_string_append (&servicedir_path, ":"))
3114 if (!_dbus_string_append (&servicedir_path, "/usr/local/share:/usr/share:"))
3119 * add configured datadir to defaults
3120 * this may be the same as an xdg dir
3121 * however the config parser should take
3122 * care of duplicates
3124 if (!_dbus_string_append (&servicedir_path, DBUS_DATADIR":"))
3127 if (xdg_data_home != NULL)
3129 if (!_dbus_string_append (&servicedir_path, xdg_data_home))
3134 const DBusString *homedir;
3135 DBusString local_share;
3137 if (!_dbus_homedir_from_current_process (&homedir))
3140 if (!_dbus_string_append (&servicedir_path, _dbus_string_get_const_data (homedir)))
3143 _dbus_string_init_const (&local_share, "/.local/share");
3144 if (!_dbus_concat_dir_and_file (&servicedir_path, &local_share))
3148 if (!_dbus_split_paths_and_append (&servicedir_path,
3149 DBUS_UNIX_STANDARD_SESSION_SERVICEDIR,
3153 _dbus_string_free (&servicedir_path);
3157 _dbus_string_free (&servicedir_path);
3163 * Returns the standard directories for a system bus to look for service
3166 * On UNIX this should be the standard xdg freedesktop.org data directories:
3168 * XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}
3174 * On Windows there is no system bus and this function can return nothing.
3176 * @param dirs the directory list we are returning
3177 * @returns #FALSE on OOM
3181 _dbus_get_standard_system_servicedirs (DBusList **dirs)
3183 const char *xdg_data_dirs;
3184 DBusString servicedir_path;
3186 if (!_dbus_string_init (&servicedir_path))
3189 xdg_data_dirs = _dbus_getenv ("XDG_DATA_DIRS");
3191 if (xdg_data_dirs != NULL)
3193 if (!_dbus_string_append (&servicedir_path, xdg_data_dirs))
3196 if (!_dbus_string_append (&servicedir_path, ":"))
3201 if (!_dbus_string_append (&servicedir_path, "/usr/local/share:/usr/share:"))
3206 * add configured datadir to defaults
3207 * this may be the same as an xdg dir
3208 * however the config parser should take
3209 * care of duplicates
3211 if (!_dbus_string_append (&servicedir_path, DBUS_DATADIR":"))
3214 if (!_dbus_split_paths_and_append (&servicedir_path,
3215 DBUS_UNIX_STANDARD_SYSTEM_SERVICEDIR,
3219 _dbus_string_free (&servicedir_path);
3223 _dbus_string_free (&servicedir_path);
3228 * Append the absolute path of the system.conf file
3229 * (there is no system bus on Windows so this can just
3230 * return FALSE and print a warning or something)
3232 * @param str the string to append to
3233 * @returns #FALSE if no memory
3236 _dbus_append_system_config_file (DBusString *str)
3238 return _dbus_string_append (str, DBUS_SYSTEM_CONFIG_FILE);
3242 * Append the absolute path of the session.conf file.
3244 * @param str the string to append to
3245 * @returns #FALSE if no memory
3248 _dbus_append_session_config_file (DBusString *str)
3250 return _dbus_string_append (str, DBUS_SESSION_CONFIG_FILE);
3254 * Called when the bus daemon is signaled to reload its configuration; any
3255 * caches should be nuked. Of course any caches that need explicit reload
3256 * are probably broken, but c'est la vie.
3261 _dbus_flush_caches (void)
3263 _dbus_user_database_flush_system ();
3267 * Appends the directory in which a keyring for the given credentials
3268 * should be stored. The credentials should have either a Windows or
3269 * UNIX user in them. The directory should be an absolute path.
3271 * On UNIX the directory is ~/.dbus-keyrings while on Windows it should probably
3272 * be something else, since the dotfile convention is not normal on Windows.
3274 * @param directory string to append directory to
3275 * @param credentials credentials the directory should be for
3277 * @returns #FALSE on no memory
3280 _dbus_append_keyring_directory_for_credentials (DBusString *directory,
3281 DBusCredentials *credentials)
3287 _dbus_assert (credentials != NULL);
3288 _dbus_assert (!_dbus_credentials_are_anonymous (credentials));
3290 if (!_dbus_string_init (&homedir))
3293 uid = _dbus_credentials_get_unix_uid (credentials);
3294 _dbus_assert (uid != DBUS_UID_UNSET);
3296 if (!_dbus_homedir_from_uid (uid, &homedir))
3299 #ifdef DBUS_BUILD_TESTS
3301 const char *override;
3303 override = _dbus_getenv ("DBUS_TEST_HOMEDIR");
3304 if (override != NULL && *override != '\0')
3306 _dbus_string_set_length (&homedir, 0);
3307 if (!_dbus_string_append (&homedir, override))
3310 _dbus_verbose ("Using fake homedir for testing: %s\n",
3311 _dbus_string_get_const_data (&homedir));
3315 static dbus_bool_t already_warned = FALSE;
3316 if (!already_warned)
3318 _dbus_warn ("Using your real home directory for testing, set DBUS_TEST_HOMEDIR to avoid\n");
3319 already_warned = TRUE;
3325 _dbus_string_init_const (&dotdir, ".dbus-keyrings");
3326 if (!_dbus_concat_dir_and_file (&homedir,
3330 if (!_dbus_string_copy (&homedir, 0,
3331 directory, _dbus_string_get_length (directory))) {
3335 _dbus_string_free (&homedir);
3339 _dbus_string_free (&homedir);
3345 * See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently
3346 * for Winsock so is abstracted)
3348 * @returns #TRUE if errno == EAGAIN or errno == EWOULDBLOCK
3351 _dbus_get_is_errno_eagain_or_ewouldblock (void)
3353 return errno == EAGAIN || errno == EWOULDBLOCK;
3356 /* tests in dbus-sysdeps-util.c */