_dbus_listen_tcp_socket: unify cleanup for EADDRINUSE and other failures
[platform/upstream/dbus.git] / dbus / dbus-sysdeps-unix.c
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)
3  *
4  * Copyright (C) 2002, 2003, 2006  Red Hat, Inc.
5  * Copyright (C) 2003 CodeFactory AB
6  *
7  * Licensed under the Academic Free License version 2.1
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22  *
23  */
24
25 #include <config.h>
26
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"
38
39 #include <sys/types.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <signal.h>
43 #include <unistd.h>
44 #include <stdio.h>
45 #include <fcntl.h>
46 #include <sys/socket.h>
47 #include <dirent.h>
48 #include <sys/un.h>
49 #include <pwd.h>
50 #include <time.h>
51 #include <locale.h>
52 #include <sys/time.h>
53 #include <sys/stat.h>
54 #include <sys/wait.h>
55 #include <netinet/in.h>
56 #include <netdb.h>
57 #include <grp.h>
58
59 #ifdef HAVE_ERRNO_H
60 #include <errno.h>
61 #endif
62 #ifdef HAVE_WRITEV
63 #include <sys/uio.h>
64 #endif
65 #ifdef HAVE_POLL
66 #include <sys/poll.h>
67 #endif
68 #ifdef HAVE_BACKTRACE
69 #include <execinfo.h>
70 #endif
71 #ifdef HAVE_GETPEERUCRED
72 #include <ucred.h>
73 #endif
74
75 #ifdef HAVE_ADT
76 #include <bsm/adt.h>
77 #endif
78
79 #include "sd-daemon.h"
80
81 #ifndef O_BINARY
82 #define O_BINARY 0
83 #endif
84
85 #ifndef AI_ADDRCONFIG
86 #define AI_ADDRCONFIG 0
87 #endif
88
89 #ifndef HAVE_SOCKLEN_T
90 #define socklen_t int
91 #endif
92
93 static dbus_bool_t
94 _dbus_open_socket (int              *fd_p,
95                    int               domain,
96                    int               type,
97                    int               protocol,
98                    DBusError        *error)
99 {
100 #ifdef SOCK_CLOEXEC
101   dbus_bool_t cloexec_done;
102
103   *fd_p = socket (domain, type | SOCK_CLOEXEC, protocol);
104   cloexec_done = *fd_p >= 0;
105
106   /* Check if kernel seems to be too old to know SOCK_CLOEXEC */
107   if (*fd_p < 0 && errno == EINVAL)
108 #endif
109     {
110       *fd_p = socket (domain, type, protocol);
111     }
112
113   if (*fd_p >= 0)
114     {
115 #ifdef SOCK_CLOEXEC
116       if (!cloexec_done)
117 #endif
118         {
119           _dbus_fd_set_close_on_exec(*fd_p);
120         }
121
122       _dbus_verbose ("socket fd %d opened\n", *fd_p);
123       return TRUE;
124     }
125   else
126     {
127       dbus_set_error(error,
128                      _dbus_error_from_errno (errno),
129                      "Failed to open socket: %s",
130                      _dbus_strerror (errno));
131       return FALSE;
132     }
133 }
134
135 dbus_bool_t
136 _dbus_open_tcp_socket (int              *fd,
137                        DBusError        *error)
138 {
139   return _dbus_open_socket(fd, AF_INET, SOCK_STREAM, 0, error);
140 }
141
142 /**
143  * Opens a UNIX domain socket (as in the socket() call).
144  * Does not bind the socket.
145  *
146  * This will set FD_CLOEXEC for the socket returned
147  *
148  * @param fd return location for socket descriptor
149  * @param error return location for an error
150  * @returns #FALSE if error is set
151  */
152 dbus_bool_t
153 _dbus_open_unix_socket (int              *fd,
154                         DBusError        *error)
155 {
156   return _dbus_open_socket(fd, PF_UNIX, SOCK_STREAM, 0, error);
157 }
158
159 /**
160  * Closes a socket. Should not be used on non-socket
161  * file descriptors or handles.
162  *
163  * @param fd the socket
164  * @param error return location for an error
165  * @returns #FALSE if error is set
166  */
167 dbus_bool_t
168 _dbus_close_socket (int               fd,
169                     DBusError        *error)
170 {
171   return _dbus_close (fd, error);
172 }
173
174 /**
175  * Like _dbus_read(), but only works on sockets so is
176  * available on Windows.
177  *
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
182  */
183 int
184 _dbus_read_socket (int               fd,
185                    DBusString       *buffer,
186                    int               count)
187 {
188   return _dbus_read (fd, buffer, count);
189 }
190
191 /**
192  * Like _dbus_write(), but only supports sockets
193  * and is thus available on Windows.
194  *
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
200  */
201 int
202 _dbus_write_socket (int               fd,
203                     const DBusString *buffer,
204                     int               start,
205                     int               len)
206 {
207 #if HAVE_DECL_MSG_NOSIGNAL
208   const char *data;
209   int bytes_written;
210
211   data = _dbus_string_get_const_data_len (buffer, start, len);
212
213  again:
214
215   bytes_written = send (fd, data, len, MSG_NOSIGNAL);
216
217   if (bytes_written < 0 && errno == EINTR)
218     goto again;
219
220   return bytes_written;
221
222 #else
223   return _dbus_write (fd, buffer, start, len);
224 #endif
225 }
226
227 /**
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.
231  *
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
238  */
239 int
240 _dbus_read_socket_with_unix_fds (int               fd,
241                                  DBusString       *buffer,
242                                  int               count,
243                                  int              *fds,
244                                  int              *n_fds) {
245 #ifndef HAVE_UNIX_FD_PASSING
246   int r;
247
248   if ((r = _dbus_read_socket(fd, buffer, count)) < 0)
249     return r;
250
251   *n_fds = 0;
252   return r;
253
254 #else
255   int bytes_read;
256   int start;
257   struct msghdr m;
258   struct iovec iov;
259
260   _dbus_assert (count >= 0);
261   _dbus_assert (*n_fds >= 0);
262
263   start = _dbus_string_get_length (buffer);
264
265   if (!_dbus_string_lengthen (buffer, count))
266     {
267       errno = ENOMEM;
268       return -1;
269     }
270
271   _DBUS_ZERO(iov);
272   iov.iov_base = _dbus_string_get_data_len (buffer, start, count);
273   iov.iov_len = count;
274
275   _DBUS_ZERO(m);
276   m.msg_iov = &iov;
277   m.msg_iovlen = 1;
278
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));
284
285   /* It's probably safe to assume that systems with SCM_RIGHTS also
286      know alloca() */
287   m.msg_control = alloca(m.msg_controllen);
288   memset(m.msg_control, 0, m.msg_controllen);
289
290  again:
291
292   bytes_read = recvmsg(fd, &m, 0
293 #ifdef MSG_CMSG_CLOEXEC
294                        |MSG_CMSG_CLOEXEC
295 #endif
296                        );
297
298   if (bytes_read < 0)
299     {
300       if (errno == EINTR)
301         goto again;
302       else
303         {
304           /* put length back (note that this doesn't actually realloc anything) */
305           _dbus_string_set_length (buffer, start);
306           return -1;
307         }
308     }
309   else
310     {
311       struct cmsghdr *cm;
312       dbus_bool_t found = FALSE;
313
314       if (m.msg_flags & MSG_CTRUNC)
315         {
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
319              serious error. */
320
321           errno = ENOSPC;
322           _dbus_string_set_length (buffer, start);
323           return -1;
324         }
325
326       for (cm = CMSG_FIRSTHDR(&m); cm; cm = CMSG_NXTHDR(&m, cm))
327         if (cm->cmsg_level == SOL_SOCKET && cm->cmsg_type == SCM_RIGHTS)
328           {
329             unsigned i;
330
331             _dbus_assert(cm->cmsg_len <= CMSG_LEN(*n_fds * sizeof(int)));
332             *n_fds = (cm->cmsg_len - CMSG_LEN(0)) / sizeof(int);
333
334             memcpy(fds, CMSG_DATA(cm), *n_fds * sizeof(int));
335             found = TRUE;
336
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]);
342
343             break;
344           }
345
346       if (!found)
347         *n_fds = 0;
348
349       /* put length back (doesn't actually realloc) */
350       _dbus_string_set_length (buffer, start + bytes_read);
351
352 #if 0
353       if (bytes_read > 0)
354         _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
355 #endif
356
357       return bytes_read;
358     }
359 #endif
360 }
361
362 int
363 _dbus_write_socket_with_unix_fds(int               fd,
364                                  const DBusString *buffer,
365                                  int               start,
366                                  int               len,
367                                  const int        *fds,
368                                  int               n_fds) {
369
370 #ifndef HAVE_UNIX_FD_PASSING
371
372   if (n_fds > 0) {
373     errno = ENOTSUP;
374     return -1;
375   }
376
377   return _dbus_write_socket(fd, buffer, start, len);
378 #else
379   return _dbus_write_socket_with_unix_fds_two(fd, buffer, start, len, NULL, 0, 0, fds, n_fds);
380 #endif
381 }
382
383 int
384 _dbus_write_socket_with_unix_fds_two(int               fd,
385                                      const DBusString *buffer1,
386                                      int               start1,
387                                      int               len1,
388                                      const DBusString *buffer2,
389                                      int               start2,
390                                      int               len2,
391                                      const int        *fds,
392                                      int               n_fds) {
393
394 #ifndef HAVE_UNIX_FD_PASSING
395
396   if (n_fds > 0) {
397     errno = ENOTSUP;
398     return -1;
399   }
400
401   return _dbus_write_socket_two(fd,
402                                 buffer1, start1, len1,
403                                 buffer2, start2, len2);
404 #else
405
406   struct msghdr m;
407   struct cmsghdr *cm;
408   struct iovec iov[2];
409   int bytes_written;
410
411   _dbus_assert (len1 >= 0);
412   _dbus_assert (len2 >= 0);
413   _dbus_assert (n_fds >= 0);
414
415   _DBUS_ZERO(iov);
416   iov[0].iov_base = (char*) _dbus_string_get_const_data_len (buffer1, start1, len1);
417   iov[0].iov_len = len1;
418
419   if (buffer2)
420     {
421       iov[1].iov_base = (char*) _dbus_string_get_const_data_len (buffer2, start2, len2);
422       iov[1].iov_len = len2;
423     }
424
425   _DBUS_ZERO(m);
426   m.msg_iov = iov;
427   m.msg_iovlen = buffer2 ? 2 : 1;
428
429   if (n_fds > 0)
430     {
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);
434
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));
440     }
441
442  again:
443
444   bytes_written = sendmsg (fd, &m, 0
445 #if HAVE_DECL_MSG_NOSIGNAL
446                            |MSG_NOSIGNAL
447 #endif
448                            );
449
450   if (bytes_written < 0 && errno == EINTR)
451     goto again;
452
453 #if 0
454   if (bytes_written > 0)
455     _dbus_verbose_bytes_of_string (buffer, start, bytes_written);
456 #endif
457
458   return bytes_written;
459 #endif
460 }
461
462 /**
463  * Like _dbus_write_two() but only works on sockets and is thus
464  * available on Windows.
465  *
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
474  */
475 int
476 _dbus_write_socket_two (int               fd,
477                         const DBusString *buffer1,
478                         int               start1,
479                         int               len1,
480                         const DBusString *buffer2,
481                         int               start2,
482                         int               len2)
483 {
484 #if HAVE_DECL_MSG_NOSIGNAL
485   struct iovec vectors[2];
486   const char *data1;
487   const char *data2;
488   int bytes_written;
489   struct msghdr m;
490
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);
496
497   data1 = _dbus_string_get_const_data_len (buffer1, start1, len1);
498
499   if (buffer2 != NULL)
500     data2 = _dbus_string_get_const_data_len (buffer2, start2, len2);
501   else
502     {
503       data2 = NULL;
504       start2 = 0;
505       len2 = 0;
506     }
507
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;
512
513   _DBUS_ZERO(m);
514   m.msg_iov = vectors;
515   m.msg_iovlen = data2 ? 2 : 1;
516
517  again:
518
519   bytes_written = sendmsg (fd, &m, MSG_NOSIGNAL);
520
521   if (bytes_written < 0 && errno == EINTR)
522     goto again;
523
524   return bytes_written;
525
526 #else
527   return _dbus_write_two (fd, buffer1, start1, len1,
528                           buffer2, start2, len2);
529 #endif
530 }
531
532 dbus_bool_t
533 _dbus_socket_is_invalid (int fd)
534 {
535     return fd < 0 ? TRUE : FALSE;
536 }
537
538 /**
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.
545  *
546  * Unlike _dbus_read_socket(), _dbus_read() is not available
547  * on Windows.
548  *
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
553  */
554 int
555 _dbus_read (int               fd,
556             DBusString       *buffer,
557             int               count)
558 {
559   int bytes_read;
560   int start;
561   char *data;
562
563   _dbus_assert (count >= 0);
564
565   start = _dbus_string_get_length (buffer);
566
567   if (!_dbus_string_lengthen (buffer, count))
568     {
569       errno = ENOMEM;
570       return -1;
571     }
572
573   data = _dbus_string_get_data_len (buffer, start, count);
574
575  again:
576
577   bytes_read = read (fd, data, count);
578
579   if (bytes_read < 0)
580     {
581       if (errno == EINTR)
582         goto again;
583       else
584         {
585           /* put length back (note that this doesn't actually realloc anything) */
586           _dbus_string_set_length (buffer, start);
587           return -1;
588         }
589     }
590   else
591     {
592       /* put length back (doesn't actually realloc) */
593       _dbus_string_set_length (buffer, start + bytes_read);
594
595 #if 0
596       if (bytes_read > 0)
597         _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
598 #endif
599
600       return bytes_read;
601     }
602 }
603
604 /**
605  * Thin wrapper around the write() system call that writes a part of a
606  * DBusString and handles EINTR for you.
607  *
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
613  */
614 int
615 _dbus_write (int               fd,
616              const DBusString *buffer,
617              int               start,
618              int               len)
619 {
620   const char *data;
621   int bytes_written;
622
623   data = _dbus_string_get_const_data_len (buffer, start, len);
624
625  again:
626
627   bytes_written = write (fd, data, len);
628
629   if (bytes_written < 0 && errno == EINTR)
630     goto again;
631
632 #if 0
633   if (bytes_written > 0)
634     _dbus_verbose_bytes_of_string (buffer, start, bytes_written);
635 #endif
636
637   return bytes_written;
638 }
639
640 /**
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.
650  *
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
659  */
660 int
661 _dbus_write_two (int               fd,
662                  const DBusString *buffer1,
663                  int               start1,
664                  int               len1,
665                  const DBusString *buffer2,
666                  int               start2,
667                  int               len2)
668 {
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);
674
675 #ifdef HAVE_WRITEV
676   {
677     struct iovec vectors[2];
678     const char *data1;
679     const char *data2;
680     int bytes_written;
681
682     data1 = _dbus_string_get_const_data_len (buffer1, start1, len1);
683
684     if (buffer2 != NULL)
685       data2 = _dbus_string_get_const_data_len (buffer2, start2, len2);
686     else
687       {
688         data2 = NULL;
689         start2 = 0;
690         len2 = 0;
691       }
692
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;
697
698   again:
699
700     bytes_written = writev (fd,
701                             vectors,
702                             data2 ? 2 : 1);
703
704     if (bytes_written < 0 && errno == EINTR)
705       goto again;
706
707     return bytes_written;
708   }
709 #else /* HAVE_WRITEV */
710   {
711     int ret1;
712
713     ret1 = _dbus_write (fd, buffer1, start1, len1);
714     if (ret1 == len1 && buffer2 != NULL)
715       {
716         ret2 = _dbus_write (fd, buffer2, start2, len2);
717         if (ret2 < 0)
718           ret2 = 0; /* we can't report an error as the first write was OK */
719
720         return ret1 + ret2;
721       }
722     else
723       return ret1;
724   }
725 #endif /* !HAVE_WRITEV */
726 }
727
728 #define _DBUS_MAX_SUN_PATH_LENGTH 99
729
730 /**
731  * @def _DBUS_MAX_SUN_PATH_LENGTH
732  *
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.
737  *
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.
741  */
742
743 /**
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
746  * nonblocking.
747  *
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.
751  *
752  * This will set FD_CLOEXEC for the socket returned.
753  *
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
758  */
759 int
760 _dbus_connect_unix_socket (const char     *path,
761                            dbus_bool_t     abstract,
762                            DBusError      *error)
763 {
764   int fd;
765   size_t path_len;
766   struct sockaddr_un addr;
767
768   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
769
770   _dbus_verbose ("connecting to unix socket %s abstract=%d\n",
771                  path, abstract);
772
773
774   if (!_dbus_open_unix_socket (&fd, error))
775     {
776       _DBUS_ASSERT_ERROR_IS_SET(error);
777       return -1;
778     }
779   _DBUS_ASSERT_ERROR_IS_CLEAR(error);
780
781   _DBUS_ZERO (addr);
782   addr.sun_family = AF_UNIX;
783   path_len = strlen (path);
784
785   if (abstract)
786     {
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 */
790
791       if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
792         {
793           dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
794                       "Abstract socket name too long\n");
795           _dbus_close (fd, NULL);
796           return -1;
797         }
798
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);
805       return -1;
806 #endif /* ! HAVE_ABSTRACT_SOCKETS */
807     }
808   else
809     {
810       if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
811         {
812           dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
813                       "Socket name too long\n");
814           _dbus_close (fd, NULL);
815           return -1;
816         }
817
818       strncpy (addr.sun_path, path, path_len);
819     }
820
821   if (connect (fd, (struct sockaddr*) &addr, _DBUS_STRUCT_OFFSET (struct sockaddr_un, sun_path) + path_len) < 0)
822     {
823       dbus_set_error (error,
824                       _dbus_error_from_errno (errno),
825                       "Failed to connect to socket %s: %s",
826                       path, _dbus_strerror (errno));
827
828       _dbus_close (fd, NULL);
829       fd = -1;
830
831       return -1;
832     }
833
834   if (!_dbus_set_fd_nonblocking (fd, error))
835     {
836       _DBUS_ASSERT_ERROR_IS_SET (error);
837
838       _dbus_close (fd, NULL);
839       fd = -1;
840
841       return -1;
842     }
843
844   return fd;
845 }
846
847 /**
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.
852  *
853  * @param fd socket on which to change the #LOCAL_CREDS flag.
854  * @param on whether to enable or disable the #LOCAL_CREDS flag.
855  */
856 static dbus_bool_t
857 _dbus_set_local_creds (int fd, dbus_bool_t on)
858 {
859   dbus_bool_t retval = TRUE;
860
861 #if defined(HAVE_CMSGCRED)
862   /* NOOP just to make sure only one codepath is used
863    *      and to prefer CMSGCRED
864    */
865 #elif defined(LOCAL_CREDS)
866   int val = on ? 1 : 0;
867   if (setsockopt (fd, 0, LOCAL_CREDS, &val, sizeof (val)) < 0)
868     {
869       _dbus_verbose ("Unable to set LOCAL_CREDS socket option on fd %d\n", fd);
870       retval = FALSE;
871     }
872   else
873     _dbus_verbose ("LOCAL_CREDS %s for further messages on fd %d\n",
874                    on ? "enabled" : "disabled", fd);
875 #endif
876
877   return retval;
878 }
879
880 /**
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.
884  *
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.
889  *
890  * This will set FD_CLOEXEC for the socket returned
891  *
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
896  */
897 int
898 _dbus_listen_unix_socket (const char     *path,
899                           dbus_bool_t     abstract,
900                           DBusError      *error)
901 {
902   int listen_fd;
903   struct sockaddr_un addr;
904   size_t path_len;
905   unsigned int reuseaddr;
906
907   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
908
909   _dbus_verbose ("listening on unix socket %s abstract=%d\n",
910                  path, abstract);
911
912   if (!_dbus_open_unix_socket (&listen_fd, error))
913     {
914       _DBUS_ASSERT_ERROR_IS_SET(error);
915       return -1;
916     }
917   _DBUS_ASSERT_ERROR_IS_CLEAR(error);
918
919   _DBUS_ZERO (addr);
920   addr.sun_family = AF_UNIX;
921   path_len = strlen (path);
922
923   if (abstract)
924     {
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.
928        */
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 */
931
932       if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
933         {
934           dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
935                       "Abstract socket name too long\n");
936           _dbus_close (listen_fd, NULL);
937           return -1;
938         }
939
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);
946       return -1;
947 #endif /* ! HAVE_ABSTRACT_SOCKETS */
948     }
949   else
950     {
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.
956        *
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.
960        */
961       {
962         struct stat sb;
963
964         if (stat (path, &sb) == 0 &&
965             S_ISSOCK (sb.st_mode))
966           unlink (path);
967       }
968
969       if (path_len > _DBUS_MAX_SUN_PATH_LENGTH)
970         {
971           dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
972                       "Abstract socket name too long\n");
973           _dbus_close (listen_fd, NULL);
974           return -1;
975         }
976
977       strncpy (addr.sun_path, path, path_len);
978     }
979
980   reuseaddr = 1;
981   if (setsockopt  (listen_fd, SOL_SOCKET, SO_REUSEADDR, &reuseaddr, sizeof(reuseaddr))==-1)
982     {
983       _dbus_warn ("Failed to set socket option\"%s\": %s",
984                   path, _dbus_strerror (errno));
985     }
986
987   if (bind (listen_fd, (struct sockaddr*) &addr, _DBUS_STRUCT_OFFSET (struct sockaddr_un, sun_path) + path_len) < 0)
988     {
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);
993       return -1;
994     }
995
996   if (listen (listen_fd, 30 /* backlog */) < 0)
997     {
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);
1002       return -1;
1003     }
1004
1005   if (!_dbus_set_local_creds (listen_fd, TRUE))
1006     {
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));
1010       close (listen_fd);
1011       return -1;
1012     }
1013
1014   if (!_dbus_set_fd_nonblocking (listen_fd, error))
1015     {
1016       _DBUS_ASSERT_ERROR_IS_SET (error);
1017       _dbus_close (listen_fd, NULL);
1018       return -1;
1019     }
1020
1021   /* Try opening up the permissions, but if we can't, just go ahead
1022    * and continue, maybe it will be good enough.
1023    */
1024   if (!abstract && chmod (path, 0777) < 0)
1025     _dbus_warn ("Could not set mode 0777 on socket %s\n",
1026                 path);
1027
1028   return listen_fd;
1029 }
1030
1031 /**
1032  * Acquires one or more sockets passed in from systemd. The sockets
1033  * are set to be nonblocking.
1034  *
1035  * This will set FD_CLOEXEC for the sockets returned.
1036  *
1037  * @oaram fds the file descriptors
1038  * @param error return location for errors
1039  * @returns the number of file descriptors
1040  */
1041 int
1042 _dbus_listen_systemd_sockets (int       **fds,
1043                               DBusError *error)
1044 {
1045   int r, n;
1046   unsigned fd;
1047   int *new_fds;
1048
1049   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1050
1051   n = sd_listen_fds (TRUE);
1052   if (n < 0)
1053     {
1054       dbus_set_error (error, _dbus_error_from_errno (-n),
1055                       "Failed to acquire systemd socket: %s",
1056                       _dbus_strerror (-n));
1057       return -1;
1058     }
1059
1060   if (n <= 0)
1061     {
1062       dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
1063                       "No socket received.");
1064       return -1;
1065     }
1066
1067   for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + n; fd ++)
1068     {
1069       r = sd_is_socket (fd, AF_UNSPEC, SOCK_STREAM, 1);
1070       if (r < 0)
1071         {
1072           dbus_set_error (error, _dbus_error_from_errno (-r),
1073                           "Failed to verify systemd socket type: %s",
1074                           _dbus_strerror (-r));
1075           return -1;
1076         }
1077
1078       if (!r)
1079         {
1080           dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
1081                           "Passed socket has wrong type.");
1082           return -1;
1083         }
1084     }
1085
1086   /* OK, the file descriptors are all good, so let's take posession of
1087      them then. */
1088
1089   new_fds = dbus_new (int, n);
1090   if (!new_fds)
1091     {
1092       dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1093                       "Failed to allocate file handle array.");
1094       goto fail;
1095     }
1096
1097   for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + n; fd ++)
1098     {
1099       if (!_dbus_set_local_creds (fd, TRUE))
1100         {
1101           dbus_set_error (error, _dbus_error_from_errno (errno),
1102                           "Failed to enable LOCAL_CREDS on systemd socket: %s",
1103                           _dbus_strerror (errno));
1104           goto fail;
1105         }
1106
1107       if (!_dbus_set_fd_nonblocking (fd, error))
1108         {
1109           _DBUS_ASSERT_ERROR_IS_SET (error);
1110           goto fail;
1111         }
1112
1113       new_fds[fd - SD_LISTEN_FDS_START] = fd;
1114     }
1115
1116   *fds = new_fds;
1117   return n;
1118
1119  fail:
1120
1121   for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + n; fd ++)
1122     {
1123       _dbus_close (fd, NULL);
1124     }
1125
1126   dbus_free (new_fds);
1127   return -1;
1128 }
1129
1130 /**
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
1133  * nonblocking.
1134  *
1135  * This will set FD_CLOEXEC for the socket returned
1136  *
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
1142  */
1143 int
1144 _dbus_connect_tcp_socket (const char     *host,
1145                           const char     *port,
1146                           const char     *family,
1147                           DBusError      *error)
1148 {
1149     return _dbus_connect_tcp_socket_with_nonce (host, port, family, (const char*)NULL, error);
1150 }
1151
1152 int
1153 _dbus_connect_tcp_socket_with_nonce (const char     *host,
1154                                      const char     *port,
1155                                      const char     *family,
1156                                      const char     *noncefile,
1157                                      DBusError      *error)
1158 {
1159   int saved_errno = 0;
1160   int fd = -1, res;
1161   struct addrinfo hints;
1162   struct addrinfo *ai, *tmp;
1163
1164   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1165
1166   if (!_dbus_open_tcp_socket (&fd, error))
1167     {
1168       _DBUS_ASSERT_ERROR_IS_SET(error);
1169       return -1;
1170     }
1171
1172   _DBUS_ASSERT_ERROR_IS_CLEAR(error);
1173
1174   _DBUS_ZERO (hints);
1175
1176   if (!family)
1177     hints.ai_family = AF_UNSPEC;
1178   else if (!strcmp(family, "ipv4"))
1179     hints.ai_family = AF_INET;
1180   else if (!strcmp(family, "ipv6"))
1181     hints.ai_family = AF_INET6;
1182   else
1183     {
1184       dbus_set_error (error,
1185                       DBUS_ERROR_BAD_ADDRESS,
1186                       "Unknown address family %s", family);
1187       return -1;
1188     }
1189   hints.ai_protocol = IPPROTO_TCP;
1190   hints.ai_socktype = SOCK_STREAM;
1191   hints.ai_flags = AI_ADDRCONFIG;
1192
1193   if ((res = getaddrinfo(host, port, &hints, &ai)) != 0)
1194     {
1195       dbus_set_error (error,
1196                       _dbus_error_from_errno (errno),
1197                       "Failed to lookup host/port: \"%s:%s\": %s (%d)",
1198                       host, port, gai_strerror(res), res);
1199       _dbus_close (fd, NULL);
1200       return -1;
1201     }
1202
1203   tmp = ai;
1204   while (tmp)
1205     {
1206       if (!_dbus_open_socket (&fd, tmp->ai_family, SOCK_STREAM, 0, error))
1207         {
1208           freeaddrinfo(ai);
1209           _DBUS_ASSERT_ERROR_IS_SET(error);
1210           return -1;
1211         }
1212       _DBUS_ASSERT_ERROR_IS_CLEAR(error);
1213
1214       if (connect (fd, (struct sockaddr*) tmp->ai_addr, tmp->ai_addrlen) < 0)
1215         {
1216           saved_errno = errno;
1217           _dbus_close(fd, NULL);
1218           fd = -1;
1219           tmp = tmp->ai_next;
1220           continue;
1221         }
1222
1223       break;
1224     }
1225   freeaddrinfo(ai);
1226
1227   if (fd == -1)
1228     {
1229       dbus_set_error (error,
1230                       _dbus_error_from_errno (saved_errno),
1231                       "Failed to connect to socket \"%s:%s\" %s",
1232                       host, port, _dbus_strerror(saved_errno));
1233       return -1;
1234     }
1235
1236   if (noncefile != NULL)
1237     {
1238       DBusString noncefileStr;
1239       dbus_bool_t ret;
1240       _dbus_string_init_const (&noncefileStr, noncefile);
1241       ret = _dbus_send_nonce (fd, &noncefileStr, error);
1242       _dbus_string_free (&noncefileStr);
1243
1244       if (!ret)
1245     {
1246       _dbus_close (fd, NULL);
1247           return -1;
1248         }
1249     }
1250
1251   if (!_dbus_set_fd_nonblocking (fd, error))
1252     {
1253       _dbus_close (fd, NULL);
1254       return -1;
1255     }
1256
1257   return fd;
1258 }
1259
1260 /**
1261  * Creates a socket and binds it to the given path, then listens on
1262  * the socket. The socket is set to be nonblocking.  In case of port=0
1263  * a random free port is used and returned in the port parameter.
1264  * If inaddr_any is specified, the hostname is ignored.
1265  *
1266  * This will set FD_CLOEXEC for the socket returned
1267  *
1268  * @param host the host name to listen on
1269  * @param port the port to listen on, if zero a free port will be used
1270  * @param family the address family to listen on, NULL for all
1271  * @param retport string to return the actual port listened on
1272  * @param fds_p location to store returned file descriptors
1273  * @param error return location for errors
1274  * @returns the number of listening file descriptors or -1 on error
1275  */
1276 int
1277 _dbus_listen_tcp_socket (const char     *host,
1278                          const char     *port,
1279                          const char     *family,
1280                          DBusString     *retport,
1281                          int           **fds_p,
1282                          DBusError      *error)
1283 {
1284   int saved_errno;
1285   int nlisten_fd = 0, *listen_fd = NULL, res, i;
1286   struct addrinfo hints;
1287   struct addrinfo *ai, *tmp;
1288   unsigned int reuseaddr;
1289
1290   *fds_p = NULL;
1291   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1292
1293   _DBUS_ZERO (hints);
1294
1295   if (!family)
1296     hints.ai_family = AF_UNSPEC;
1297   else if (!strcmp(family, "ipv4"))
1298     hints.ai_family = AF_INET;
1299   else if (!strcmp(family, "ipv6"))
1300     hints.ai_family = AF_INET6;
1301   else
1302     {
1303       dbus_set_error (error,
1304                       DBUS_ERROR_BAD_ADDRESS,
1305                       "Unknown address family %s", family);
1306       return -1;
1307     }
1308
1309   hints.ai_protocol = IPPROTO_TCP;
1310   hints.ai_socktype = SOCK_STREAM;
1311   hints.ai_flags = AI_ADDRCONFIG | AI_PASSIVE;
1312
1313  redo_lookup_with_port:
1314   if ((res = getaddrinfo(host, port, &hints, &ai)) != 0 || !ai)
1315     {
1316       dbus_set_error (error,
1317                       _dbus_error_from_errno (errno),
1318                       "Failed to lookup host/port: \"%s:%s\": %s (%d)",
1319                       host ? host : "*", port, gai_strerror(res), res);
1320       return -1;
1321     }
1322
1323   tmp = ai;
1324   while (tmp)
1325     {
1326       int fd = -1, *newlisten_fd;
1327       if (!_dbus_open_socket (&fd, tmp->ai_family, SOCK_STREAM, 0, error))
1328         {
1329           _DBUS_ASSERT_ERROR_IS_SET(error);
1330           goto failed;
1331         }
1332       _DBUS_ASSERT_ERROR_IS_CLEAR(error);
1333
1334       reuseaddr = 1;
1335       if (setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &reuseaddr, sizeof(reuseaddr))==-1)
1336         {
1337           _dbus_warn ("Failed to set socket option \"%s:%s\": %s",
1338                       host ? host : "*", port, _dbus_strerror (errno));
1339         }
1340
1341       if (bind (fd, (struct sockaddr*) tmp->ai_addr, tmp->ai_addrlen) < 0)
1342         {
1343           saved_errno = errno;
1344           _dbus_close(fd, NULL);
1345           if (saved_errno == EADDRINUSE)
1346             {
1347               /* Depending on kernel policy, it may or may not
1348                  be neccessary to bind to both IPv4 & 6 addresses
1349                  so ignore EADDRINUSE here */
1350               tmp = tmp->ai_next;
1351               continue;
1352             }
1353           dbus_set_error (error, _dbus_error_from_errno (saved_errno),
1354                           "Failed to bind socket \"%s:%s\": %s",
1355                           host ? host : "*", port, _dbus_strerror (saved_errno));
1356           goto failed;
1357         }
1358
1359       if (listen (fd, 30 /* backlog */) < 0)
1360         {
1361           saved_errno = errno;
1362           _dbus_close (fd, NULL);
1363           dbus_set_error (error, _dbus_error_from_errno (saved_errno),
1364                           "Failed to listen on socket \"%s:%s\": %s",
1365                           host ? host : "*", port, _dbus_strerror (saved_errno));
1366           goto failed;
1367         }
1368
1369       newlisten_fd = dbus_realloc(listen_fd, sizeof(int)*(nlisten_fd+1));
1370       if (!newlisten_fd)
1371         {
1372           saved_errno = errno;
1373           _dbus_close (fd, NULL);
1374           dbus_set_error (error, _dbus_error_from_errno (saved_errno),
1375                           "Failed to allocate file handle array: %s",
1376                           _dbus_strerror (saved_errno));
1377           goto failed;
1378         }
1379       listen_fd = newlisten_fd;
1380       listen_fd[nlisten_fd] = fd;
1381       nlisten_fd++;
1382
1383       if (!_dbus_string_get_length(retport))
1384         {
1385           /* If the user didn't specify a port, or used 0, then
1386              the kernel chooses a port. After the first address
1387              is bound to, we need to force all remaining addresses
1388              to use the same port */
1389           if (!port || !strcmp(port, "0"))
1390             {
1391               int result;
1392               struct sockaddr_storage addr;
1393               socklen_t addrlen;
1394               char portbuf[50];
1395
1396               addrlen = sizeof(addr);
1397               result = getsockname(fd, (struct sockaddr*) &addr, &addrlen);
1398
1399               if (result == -1 ||
1400                   (res = getnameinfo ((struct sockaddr*)&addr, addrlen, NULL, 0,
1401                                       portbuf, sizeof(portbuf),
1402                                       NI_NUMERICHOST)) != 0)
1403                 {
1404                   dbus_set_error (error, _dbus_error_from_errno (errno),
1405                                   "Failed to resolve port \"%s:%s\": %s (%s)",
1406                                   host ? host : "*", port, gai_strerror(res), res);
1407                   goto failed;
1408                 }
1409               if (!_dbus_string_append(retport, portbuf))
1410                 {
1411                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1412                   goto failed;
1413                 }
1414
1415               /* Release current address list & redo lookup */
1416               port = _dbus_string_get_const_data(retport);
1417               freeaddrinfo(ai);
1418               goto redo_lookup_with_port;
1419             }
1420           else
1421             {
1422               if (!_dbus_string_append(retport, port))
1423                 {
1424                     dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1425                     goto failed;
1426                 }
1427             }
1428         }
1429
1430       tmp = tmp->ai_next;
1431     }
1432   freeaddrinfo(ai);
1433   ai = NULL;
1434
1435   if (!nlisten_fd)
1436     {
1437       errno = EADDRINUSE;
1438       dbus_set_error (error, _dbus_error_from_errno (errno),
1439                       "Failed to bind socket \"%s:%s\": %s",
1440                       host ? host : "*", port, _dbus_strerror (errno));
1441       goto failed;
1442     }
1443
1444   for (i = 0 ; i < nlisten_fd ; i++)
1445     {
1446       if (!_dbus_set_fd_nonblocking (listen_fd[i], error))
1447         {
1448           goto failed;
1449         }
1450     }
1451
1452   *fds_p = listen_fd;
1453
1454   return nlisten_fd;
1455
1456  failed:
1457   if (ai)
1458     freeaddrinfo(ai);
1459   for (i = 0 ; i < nlisten_fd ; i++)
1460     _dbus_close(listen_fd[i], NULL);
1461   dbus_free(listen_fd);
1462   return -1;
1463 }
1464
1465 static dbus_bool_t
1466 write_credentials_byte (int             server_fd,
1467                         DBusError      *error)
1468 {
1469   int bytes_written;
1470   char buf[1] = { '\0' };
1471 #if defined(HAVE_CMSGCRED)
1472   union {
1473           struct cmsghdr hdr;
1474           char cred[CMSG_SPACE (sizeof (struct cmsgcred))];
1475   } cmsg;
1476   struct iovec iov;
1477   struct msghdr msg;
1478   iov.iov_base = buf;
1479   iov.iov_len = 1;
1480
1481   _DBUS_ZERO(msg);
1482   msg.msg_iov = &iov;
1483   msg.msg_iovlen = 1;
1484
1485   msg.msg_control = (caddr_t) &cmsg;
1486   msg.msg_controllen = CMSG_SPACE (sizeof (struct cmsgcred));
1487   _DBUS_ZERO(cmsg);
1488   cmsg.hdr.cmsg_len = CMSG_LEN (sizeof (struct cmsgcred));
1489   cmsg.hdr.cmsg_level = SOL_SOCKET;
1490   cmsg.hdr.cmsg_type = SCM_CREDS;
1491 #endif
1492
1493   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1494
1495  again:
1496
1497 #if defined(HAVE_CMSGCRED)
1498   bytes_written = sendmsg (server_fd, &msg, 0
1499 #if HAVE_DECL_MSG_NOSIGNAL
1500                            |MSG_NOSIGNAL
1501 #endif
1502                            );
1503 #else
1504   bytes_written = send (server_fd, buf, 1, 0
1505 #if HAVE_DECL_MSG_NOSIGNAL
1506                         |MSG_NOSIGNAL
1507 #endif
1508                         );
1509 #endif
1510
1511   if (bytes_written < 0 && errno == EINTR)
1512     goto again;
1513
1514   if (bytes_written < 0)
1515     {
1516       dbus_set_error (error, _dbus_error_from_errno (errno),
1517                       "Failed to write credentials byte: %s",
1518                      _dbus_strerror (errno));
1519       return FALSE;
1520     }
1521   else if (bytes_written == 0)
1522     {
1523       dbus_set_error (error, DBUS_ERROR_IO_ERROR,
1524                       "wrote zero bytes writing credentials byte");
1525       return FALSE;
1526     }
1527   else
1528     {
1529       _dbus_assert (bytes_written == 1);
1530       _dbus_verbose ("wrote credentials byte\n");
1531       return TRUE;
1532     }
1533 }
1534
1535 /**
1536  * Reads a single byte which must be nul (an error occurs otherwise),
1537  * and reads unix credentials if available. Clears the credentials
1538  * object, then adds pid/uid if available, so any previous credentials
1539  * stored in the object are lost.
1540  *
1541  * Return value indicates whether a byte was read, not whether
1542  * we got valid credentials. On some systems, such as Linux,
1543  * reading/writing the byte isn't actually required, but we do it
1544  * anyway just to avoid multiple codepaths.
1545  *
1546  * Fails if no byte is available, so you must select() first.
1547  *
1548  * The point of the byte is that on some systems we have to
1549  * use sendmsg()/recvmsg() to transmit credentials.
1550  *
1551  * @param client_fd the client file descriptor
1552  * @param credentials object to add client credentials to
1553  * @param error location to store error code
1554  * @returns #TRUE on success
1555  */
1556 dbus_bool_t
1557 _dbus_read_credentials_socket  (int              client_fd,
1558                                 DBusCredentials *credentials,
1559                                 DBusError       *error)
1560 {
1561   struct msghdr msg;
1562   struct iovec iov;
1563   char buf;
1564   dbus_uid_t uid_read;
1565   dbus_pid_t pid_read;
1566   int bytes_read;
1567
1568 #ifdef HAVE_CMSGCRED
1569   union {
1570     struct cmsghdr hdr;
1571     char cred[CMSG_SPACE (sizeof (struct cmsgcred))];
1572   } cmsg;
1573
1574 #elif defined(LOCAL_CREDS)
1575   struct {
1576     struct cmsghdr hdr;
1577     struct sockcred cred;
1578   } cmsg;
1579 #endif
1580
1581   uid_read = DBUS_UID_UNSET;
1582   pid_read = DBUS_PID_UNSET;
1583
1584   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1585
1586   /* The POSIX spec certainly doesn't promise this, but
1587    * we need these assertions to fail as soon as we're wrong about
1588    * it so we can do the porting fixups
1589    */
1590   _dbus_assert (sizeof (pid_t) <= sizeof (dbus_pid_t));
1591   _dbus_assert (sizeof (uid_t) <= sizeof (dbus_uid_t));
1592   _dbus_assert (sizeof (gid_t) <= sizeof (dbus_gid_t));
1593
1594   _dbus_credentials_clear (credentials);
1595
1596   /* Systems supporting LOCAL_CREDS are configured to have this feature
1597    * enabled (if it does not conflict with HAVE_CMSGCRED) prior accepting
1598    * the connection.  Therefore, the received message must carry the
1599    * credentials information without doing anything special.
1600    */
1601
1602   iov.iov_base = &buf;
1603   iov.iov_len = 1;
1604
1605   _DBUS_ZERO(msg);
1606   msg.msg_iov = &iov;
1607   msg.msg_iovlen = 1;
1608
1609 #if defined(HAVE_CMSGCRED) || defined(LOCAL_CREDS)
1610   _DBUS_ZERO(cmsg);
1611   msg.msg_control = (caddr_t) &cmsg;
1612   msg.msg_controllen = CMSG_SPACE (sizeof (struct cmsgcred));
1613 #endif
1614
1615  again:
1616   bytes_read = recvmsg (client_fd, &msg, 0);
1617
1618   if (bytes_read < 0)
1619     {
1620       if (errno == EINTR)
1621         goto again;
1622
1623       /* EAGAIN or EWOULDBLOCK would be unexpected here since we would
1624        * normally only call read_credentials if the socket was ready
1625        * for reading
1626        */
1627
1628       dbus_set_error (error, _dbus_error_from_errno (errno),
1629                       "Failed to read credentials byte: %s",
1630                       _dbus_strerror (errno));
1631       return FALSE;
1632     }
1633   else if (bytes_read == 0)
1634     {
1635       /* this should not happen unless we are using recvmsg wrong,
1636        * so is essentially here for paranoia
1637        */
1638       dbus_set_error (error, DBUS_ERROR_FAILED,
1639                       "Failed to read credentials byte (zero-length read)");
1640       return FALSE;
1641     }
1642   else if (buf != '\0')
1643     {
1644       dbus_set_error (error, DBUS_ERROR_FAILED,
1645                       "Credentials byte was not nul");
1646       return FALSE;
1647     }
1648
1649 #if defined(HAVE_CMSGCRED) || defined(LOCAL_CREDS)
1650   if (cmsg.hdr.cmsg_len < CMSG_LEN (sizeof (struct cmsgcred))
1651                   || cmsg.hdr.cmsg_type != SCM_CREDS)
1652     {
1653       dbus_set_error (error, DBUS_ERROR_FAILED,
1654                       "Message from recvmsg() was not SCM_CREDS");
1655       return FALSE;
1656     }
1657 #endif
1658
1659   _dbus_verbose ("read credentials byte\n");
1660
1661   {
1662 #ifdef SO_PEERCRED
1663     struct ucred cr;
1664     int cr_len = sizeof (cr);
1665
1666     if (getsockopt (client_fd, SOL_SOCKET, SO_PEERCRED, &cr, &cr_len) == 0 &&
1667         cr_len == sizeof (cr))
1668       {
1669         pid_read = cr.pid;
1670         uid_read = cr.uid;
1671       }
1672     else
1673       {
1674         _dbus_verbose ("Failed to getsockopt() credentials, returned len %d/%d: %s\n",
1675                        cr_len, (int) sizeof (cr), _dbus_strerror (errno));
1676       }
1677 #elif defined(HAVE_CMSGCRED)
1678     struct cmsgcred *cred;
1679
1680     cred = (struct cmsgcred *) CMSG_DATA (&cmsg.hdr);
1681     pid_read = cred->cmcred_pid;
1682     uid_read = cred->cmcred_euid;
1683 #elif defined(LOCAL_CREDS)
1684     pid_read = DBUS_PID_UNSET;
1685     uid_read = cmsg.cred.sc_uid;
1686     /* Since we have already got the credentials from this socket, we can
1687      * disable its LOCAL_CREDS flag if it was ever set. */
1688     _dbus_set_local_creds (client_fd, FALSE);
1689 #elif defined(HAVE_GETPEEREID)
1690     uid_t euid;
1691     gid_t egid;
1692     if (getpeereid (client_fd, &euid, &egid) == 0)
1693       {
1694         uid_read = euid;
1695       }
1696     else
1697       {
1698         _dbus_verbose ("Failed to getpeereid() credentials: %s\n", _dbus_strerror (errno));
1699       }
1700 #elif defined(HAVE_GETPEERUCRED)
1701     ucred_t * ucred = NULL;
1702     if (getpeerucred (client_fd, &ucred) == 0)
1703       {
1704         pid_read = ucred_getpid (ucred);
1705         uid_read = ucred_geteuid (ucred);
1706 #ifdef HAVE_ADT
1707         /* generate audit session data based on socket ucred */
1708         adt_session_data_t *adth = NULL;
1709         adt_export_data_t *data = NULL;
1710         size_t size = 0;
1711         if (adt_start_session (&adth, NULL, 0) || (adth == NULL))
1712           {
1713             _dbus_verbose ("Failed to adt_start_session(): %s\n", _dbus_strerror (errno));
1714           }
1715         else
1716           {
1717             if (adt_set_from_ucred (adth, ucred, ADT_NEW))
1718               {
1719                 _dbus_verbose ("Failed to adt_set_from_ucred(): %s\n", _dbus_strerror (errno));
1720               }
1721             else
1722               {
1723                 size = adt_export_session_data (adth, &data);
1724                 if (size <= 0)
1725                   {
1726                     _dbus_verbose ("Failed to adt_export_session_data(): %s\n", _dbus_strerror (errno));
1727                   }
1728                 else
1729                   {
1730                     _dbus_credentials_add_adt_audit_data (credentials, data, size);
1731                     free (data);
1732                   }
1733               }
1734             (void) adt_end_session (adth);
1735           }
1736 #endif /* HAVE_ADT */
1737       }
1738     else
1739       {
1740         _dbus_verbose ("Failed to getpeerucred() credentials: %s\n", _dbus_strerror (errno));
1741       }
1742     if (ucred != NULL)
1743       ucred_free (ucred);
1744 #else /* !SO_PEERCRED && !HAVE_CMSGCRED && !HAVE_GETPEEREID && !HAVE_GETPEERUCRED */
1745     _dbus_verbose ("Socket credentials not supported on this OS\n");
1746 #endif
1747   }
1748
1749   _dbus_verbose ("Credentials:"
1750                  "  pid "DBUS_PID_FORMAT
1751                  "  uid "DBUS_UID_FORMAT
1752                  "\n",
1753                  pid_read,
1754                  uid_read);
1755
1756   if (pid_read != DBUS_PID_UNSET)
1757     {
1758       if (!_dbus_credentials_add_unix_pid (credentials, pid_read))
1759         {
1760           _DBUS_SET_OOM (error);
1761           return FALSE;
1762         }
1763     }
1764
1765   if (uid_read != DBUS_UID_UNSET)
1766     {
1767       if (!_dbus_credentials_add_unix_uid (credentials, uid_read))
1768         {
1769           _DBUS_SET_OOM (error);
1770           return FALSE;
1771         }
1772     }
1773
1774   return TRUE;
1775 }
1776
1777 /**
1778  * Sends a single nul byte with our UNIX credentials as ancillary
1779  * data.  Returns #TRUE if the data was successfully written.  On
1780  * systems that don't support sending credentials, just writes a byte,
1781  * doesn't send any credentials.  On some systems, such as Linux,
1782  * reading/writing the byte isn't actually required, but we do it
1783  * anyway just to avoid multiple codepaths.
1784  *
1785  * Fails if no byte can be written, so you must select() first.
1786  *
1787  * The point of the byte is that on some systems we have to
1788  * use sendmsg()/recvmsg() to transmit credentials.
1789  *
1790  * @param server_fd file descriptor for connection to server
1791  * @param error return location for error code
1792  * @returns #TRUE if the byte was sent
1793  */
1794 dbus_bool_t
1795 _dbus_send_credentials_socket  (int              server_fd,
1796                                 DBusError       *error)
1797 {
1798   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1799
1800   if (write_credentials_byte (server_fd, error))
1801     return TRUE;
1802   else
1803     return FALSE;
1804 }
1805
1806 /**
1807  * Accepts a connection on a listening socket.
1808  * Handles EINTR for you.
1809  *
1810  * This will enable FD_CLOEXEC for the returned socket.
1811  *
1812  * @param listen_fd the listen file descriptor
1813  * @returns the connection fd of the client, or -1 on error
1814  */
1815 int
1816 _dbus_accept  (int listen_fd)
1817 {
1818   int client_fd;
1819   struct sockaddr addr;
1820   socklen_t addrlen;
1821 #ifdef HAVE_ACCEPT4
1822   dbus_bool_t cloexec_done;
1823 #endif
1824
1825   addrlen = sizeof (addr);
1826
1827  retry:
1828
1829 #ifdef HAVE_ACCEPT4
1830   /* We assume that if accept4 is available SOCK_CLOEXEC is too */
1831   client_fd = accept4 (listen_fd, &addr, &addrlen, SOCK_CLOEXEC);
1832   cloexec_done = client_fd >= 0;
1833
1834   if (client_fd < 0 && errno == ENOSYS)
1835 #endif
1836     {
1837       client_fd = accept (listen_fd, &addr, &addrlen);
1838     }
1839
1840   if (client_fd < 0)
1841     {
1842       if (errno == EINTR)
1843         goto retry;
1844     }
1845
1846   _dbus_verbose ("client fd %d accepted\n", client_fd);
1847
1848 #ifdef HAVE_ACCEPT4
1849   if (!cloexec_done)
1850 #endif
1851     {
1852       _dbus_fd_set_close_on_exec(client_fd);
1853     }
1854
1855   return client_fd;
1856 }
1857
1858 /**
1859  * Checks to make sure the given directory is
1860  * private to the user
1861  *
1862  * @param dir the name of the directory
1863  * @param error error return
1864  * @returns #FALSE on failure
1865  **/
1866 dbus_bool_t
1867 _dbus_check_dir_is_private_to_user (DBusString *dir, DBusError *error)
1868 {
1869   const char *directory;
1870   struct stat sb;
1871
1872   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1873
1874   directory = _dbus_string_get_const_data (dir);
1875
1876   if (stat (directory, &sb) < 0)
1877     {
1878       dbus_set_error (error, _dbus_error_from_errno (errno),
1879                       "%s", _dbus_strerror (errno));
1880
1881       return FALSE;
1882     }
1883
1884   if ((S_IROTH & sb.st_mode) || (S_IWOTH & sb.st_mode) ||
1885       (S_IRGRP & sb.st_mode) || (S_IWGRP & sb.st_mode))
1886     {
1887       dbus_set_error (error, DBUS_ERROR_FAILED,
1888                      "%s directory is not private to the user", directory);
1889       return FALSE;
1890     }
1891
1892   return TRUE;
1893 }
1894
1895 static dbus_bool_t
1896 fill_user_info_from_passwd (struct passwd *p,
1897                             DBusUserInfo  *info,
1898                             DBusError     *error)
1899 {
1900   _dbus_assert (p->pw_name != NULL);
1901   _dbus_assert (p->pw_dir != NULL);
1902
1903   info->uid = p->pw_uid;
1904   info->primary_gid = p->pw_gid;
1905   info->username = _dbus_strdup (p->pw_name);
1906   info->homedir = _dbus_strdup (p->pw_dir);
1907
1908   if (info->username == NULL ||
1909       info->homedir == NULL)
1910     {
1911       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1912       return FALSE;
1913     }
1914
1915   return TRUE;
1916 }
1917
1918 static dbus_bool_t
1919 fill_user_info (DBusUserInfo       *info,
1920                 dbus_uid_t          uid,
1921                 const DBusString   *username,
1922                 DBusError          *error)
1923 {
1924   const char *username_c;
1925
1926   /* exactly one of username/uid provided */
1927   _dbus_assert (username != NULL || uid != DBUS_UID_UNSET);
1928   _dbus_assert (username == NULL || uid == DBUS_UID_UNSET);
1929
1930   info->uid = DBUS_UID_UNSET;
1931   info->primary_gid = DBUS_GID_UNSET;
1932   info->group_ids = NULL;
1933   info->n_group_ids = 0;
1934   info->username = NULL;
1935   info->homedir = NULL;
1936
1937   if (username != NULL)
1938     username_c = _dbus_string_get_const_data (username);
1939   else
1940     username_c = NULL;
1941
1942   /* For now assuming that the getpwnam() and getpwuid() flavors
1943    * are always symmetrical, if not we have to add more configure
1944    * checks
1945    */
1946
1947 #if defined (HAVE_POSIX_GETPWNAM_R) || defined (HAVE_NONPOSIX_GETPWNAM_R)
1948   {
1949     struct passwd *p;
1950     int result;
1951     size_t buflen;
1952     char *buf;
1953     struct passwd p_str;
1954
1955     /* retrieve maximum needed size for buf */
1956     buflen = sysconf (_SC_GETPW_R_SIZE_MAX);
1957
1958     /* sysconf actually returns a long, but everything else expects size_t,
1959      * so just recast here.
1960      * https://bugs.freedesktop.org/show_bug.cgi?id=17061
1961      */
1962     if ((long) buflen <= 0)
1963       buflen = 1024;
1964
1965     result = -1;
1966     while (1)
1967       {
1968         buf = dbus_malloc (buflen);
1969         if (buf == NULL)
1970           {
1971             dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1972             return FALSE;
1973           }
1974
1975         p = NULL;
1976 #ifdef HAVE_POSIX_GETPWNAM_R
1977         if (uid != DBUS_UID_UNSET)
1978           result = getpwuid_r (uid, &p_str, buf, buflen,
1979                                &p);
1980         else
1981           result = getpwnam_r (username_c, &p_str, buf, buflen,
1982                                &p);
1983 #else
1984         if (uid != DBUS_UID_UNSET)
1985           p = getpwuid_r (uid, &p_str, buf, buflen);
1986         else
1987           p = getpwnam_r (username_c, &p_str, buf, buflen);
1988         result = 0;
1989 #endif /* !HAVE_POSIX_GETPWNAM_R */
1990         //Try a bigger buffer if ERANGE was returned
1991         if (result == ERANGE && buflen < 512 * 1024)
1992           {
1993             dbus_free (buf);
1994             buflen *= 2;
1995           }
1996         else
1997           {
1998             break;
1999           }
2000       }
2001     if (result == 0 && p == &p_str)
2002       {
2003         if (!fill_user_info_from_passwd (p, info, error))
2004           {
2005             dbus_free (buf);
2006             return FALSE;
2007           }
2008         dbus_free (buf);
2009       }
2010     else
2011       {
2012         dbus_set_error (error, _dbus_error_from_errno (errno),
2013                         "User \"%s\" unknown or no memory to allocate password entry\n",
2014                         username_c ? username_c : "???");
2015         _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
2016         dbus_free (buf);
2017         return FALSE;
2018       }
2019   }
2020 #else /* ! HAVE_GETPWNAM_R */
2021   {
2022     /* I guess we're screwed on thread safety here */
2023     struct passwd *p;
2024
2025     if (uid != DBUS_UID_UNSET)
2026       p = getpwuid (uid);
2027     else
2028       p = getpwnam (username_c);
2029
2030     if (p != NULL)
2031       {
2032         if (!fill_user_info_from_passwd (p, info, error))
2033           {
2034             return FALSE;
2035           }
2036       }
2037     else
2038       {
2039         dbus_set_error (error, _dbus_error_from_errno (errno),
2040                         "User \"%s\" unknown or no memory to allocate password entry\n",
2041                         username_c ? username_c : "???");
2042         _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
2043         return FALSE;
2044       }
2045   }
2046 #endif  /* ! HAVE_GETPWNAM_R */
2047
2048   /* Fill this in so we can use it to get groups */
2049   username_c = info->username;
2050
2051 #ifdef HAVE_GETGROUPLIST
2052   {
2053     gid_t *buf;
2054     int buf_count;
2055     int i;
2056     int initial_buf_count;
2057
2058     initial_buf_count = 17;
2059     buf_count = initial_buf_count;
2060     buf = dbus_new (gid_t, buf_count);
2061     if (buf == NULL)
2062       {
2063         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2064         goto failed;
2065       }
2066
2067     if (getgrouplist (username_c,
2068                       info->primary_gid,
2069                       buf, &buf_count) < 0)
2070       {
2071         gid_t *new;
2072         /* Presumed cause of negative return code: buf has insufficient
2073            entries to hold the entire group list. The Linux behavior in this
2074            case is to pass back the actual number of groups in buf_count, but
2075            on Mac OS X 10.5, buf_count is unhelpfully left alone.
2076            So as a hack, try to help out a bit by guessing a larger
2077            number of groups, within reason.. might still fail, of course,
2078            but we can at least print a more informative message.  I looked up
2079            the "right way" to do this by downloading Apple's own source code
2080            for the "id" command, and it turns out that they use an
2081            undocumented library function getgrouplist_2 (!) which is not
2082            declared in any header in /usr/include (!!). That did not seem
2083            like the way to go here.
2084         */
2085         if (buf_count == initial_buf_count)
2086           {
2087             buf_count *= 16; /* Retry with an arbitrarily scaled-up array */
2088           }
2089         new = dbus_realloc (buf, buf_count * sizeof (buf[0]));
2090         if (new == NULL)
2091           {
2092             dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2093             dbus_free (buf);
2094             goto failed;
2095           }
2096
2097         buf = new;
2098
2099         errno = 0;
2100         if (getgrouplist (username_c, info->primary_gid, buf, &buf_count) < 0)
2101           {
2102             if (errno == 0)
2103               {
2104                 _dbus_warn ("It appears that username \"%s\" is in more than %d groups.\nProceeding with just the first %d groups.",
2105                             username_c, buf_count, buf_count);
2106               }
2107             else
2108               {
2109                 dbus_set_error (error,
2110                                 _dbus_error_from_errno (errno),
2111                                 "Failed to get groups for username \"%s\" primary GID "
2112                                 DBUS_GID_FORMAT ": %s\n",
2113                                 username_c, info->primary_gid,
2114                                 _dbus_strerror (errno));
2115                 dbus_free (buf);
2116                 goto failed;
2117               }
2118           }
2119       }
2120
2121     info->group_ids = dbus_new (dbus_gid_t, buf_count);
2122     if (info->group_ids == NULL)
2123       {
2124         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2125         dbus_free (buf);
2126         goto failed;
2127       }
2128
2129     for (i = 0; i < buf_count; ++i)
2130       info->group_ids[i] = buf[i];
2131
2132     info->n_group_ids = buf_count;
2133
2134     dbus_free (buf);
2135   }
2136 #else  /* HAVE_GETGROUPLIST */
2137   {
2138     /* We just get the one group ID */
2139     info->group_ids = dbus_new (dbus_gid_t, 1);
2140     if (info->group_ids == NULL)
2141       {
2142         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2143         goto failed;
2144       }
2145
2146     info->n_group_ids = 1;
2147
2148     (info->group_ids)[0] = info->primary_gid;
2149   }
2150 #endif /* HAVE_GETGROUPLIST */
2151
2152   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2153
2154   return TRUE;
2155
2156  failed:
2157   _DBUS_ASSERT_ERROR_IS_SET (error);
2158   return FALSE;
2159 }
2160
2161 /**
2162  * Gets user info for the given username.
2163  *
2164  * @param info user info object to initialize
2165  * @param username the username
2166  * @param error error return
2167  * @returns #TRUE on success
2168  */
2169 dbus_bool_t
2170 _dbus_user_info_fill (DBusUserInfo     *info,
2171                       const DBusString *username,
2172                       DBusError        *error)
2173 {
2174   return fill_user_info (info, DBUS_UID_UNSET,
2175                          username, error);
2176 }
2177
2178 /**
2179  * Gets user info for the given user ID.
2180  *
2181  * @param info user info object to initialize
2182  * @param uid the user ID
2183  * @param error error return
2184  * @returns #TRUE on success
2185  */
2186 dbus_bool_t
2187 _dbus_user_info_fill_uid (DBusUserInfo *info,
2188                           dbus_uid_t    uid,
2189                           DBusError    *error)
2190 {
2191   return fill_user_info (info, uid,
2192                          NULL, error);
2193 }
2194
2195 /**
2196  * Adds the credentials of the current process to the
2197  * passed-in credentials object.
2198  *
2199  * @param credentials credentials to add to
2200  * @returns #FALSE if no memory; does not properly roll back on failure, so only some credentials may have been added
2201  */
2202 dbus_bool_t
2203 _dbus_credentials_add_from_current_process (DBusCredentials *credentials)
2204 {
2205   /* The POSIX spec certainly doesn't promise this, but
2206    * we need these assertions to fail as soon as we're wrong about
2207    * it so we can do the porting fixups
2208    */
2209   _dbus_assert (sizeof (pid_t) <= sizeof (dbus_pid_t));
2210   _dbus_assert (sizeof (uid_t) <= sizeof (dbus_uid_t));
2211   _dbus_assert (sizeof (gid_t) <= sizeof (dbus_gid_t));
2212
2213   if (!_dbus_credentials_add_unix_pid(credentials, _dbus_getpid()))
2214     return FALSE;
2215   if (!_dbus_credentials_add_unix_uid(credentials, _dbus_geteuid()))
2216     return FALSE;
2217
2218   return TRUE;
2219 }
2220
2221 /**
2222  * Append to the string the identity we would like to have when we
2223  * authenticate, on UNIX this is the current process UID and on
2224  * Windows something else, probably a Windows SID string.  No escaping
2225  * is required, that is done in dbus-auth.c. The username here
2226  * need not be anything human-readable, it can be the machine-readable
2227  * form i.e. a user id.
2228  *
2229  * @param str the string to append to
2230  * @returns #FALSE on no memory
2231  */
2232 dbus_bool_t
2233 _dbus_append_user_from_current_process (DBusString *str)
2234 {
2235   return _dbus_string_append_uint (str,
2236                                    _dbus_geteuid ());
2237 }
2238
2239 /**
2240  * Gets our process ID
2241  * @returns process ID
2242  */
2243 dbus_pid_t
2244 _dbus_getpid (void)
2245 {
2246   return getpid ();
2247 }
2248
2249 /** Gets our UID
2250  * @returns process UID
2251  */
2252 dbus_uid_t
2253 _dbus_getuid (void)
2254 {
2255   return getuid ();
2256 }
2257
2258 /** Gets our effective UID
2259  * @returns process effective UID
2260  */
2261 dbus_uid_t
2262 _dbus_geteuid (void)
2263 {
2264   return geteuid ();
2265 }
2266
2267 /**
2268  * The only reason this is separate from _dbus_getpid() is to allow it
2269  * on Windows for logging but not for other purposes.
2270  *
2271  * @returns process ID to put in log messages
2272  */
2273 unsigned long
2274 _dbus_pid_for_log (void)
2275 {
2276   return getpid ();
2277 }
2278
2279 /**
2280  * Gets a UID from a UID string.
2281  *
2282  * @param uid_str the UID in string form
2283  * @param uid UID to fill in
2284  * @returns #TRUE if successfully filled in UID
2285  */
2286 dbus_bool_t
2287 _dbus_parse_uid (const DBusString      *uid_str,
2288                  dbus_uid_t            *uid)
2289 {
2290   int end;
2291   long val;
2292
2293   if (_dbus_string_get_length (uid_str) == 0)
2294     {
2295       _dbus_verbose ("UID string was zero length\n");
2296       return FALSE;
2297     }
2298
2299   val = -1;
2300   end = 0;
2301   if (!_dbus_string_parse_int (uid_str, 0, &val,
2302                                &end))
2303     {
2304       _dbus_verbose ("could not parse string as a UID\n");
2305       return FALSE;
2306     }
2307
2308   if (end != _dbus_string_get_length (uid_str))
2309     {
2310       _dbus_verbose ("string contained trailing stuff after UID\n");
2311       return FALSE;
2312     }
2313
2314   *uid = val;
2315
2316   return TRUE;
2317 }
2318
2319 #if !DBUS_USE_SYNC
2320 _DBUS_DEFINE_GLOBAL_LOCK (atomic);
2321 #endif
2322
2323 /**
2324  * Atomically increments an integer
2325  *
2326  * @param atomic pointer to the integer to increment
2327  * @returns the value before incrementing
2328  */
2329 dbus_int32_t
2330 _dbus_atomic_inc (DBusAtomic *atomic)
2331 {
2332 #if DBUS_USE_SYNC
2333   return __sync_add_and_fetch(&atomic->value, 1)-1;
2334 #else
2335   dbus_int32_t res;
2336   _DBUS_LOCK (atomic);
2337   res = atomic->value;
2338   atomic->value += 1;
2339   _DBUS_UNLOCK (atomic);
2340   return res;
2341 #endif
2342 }
2343
2344 /**
2345  * Atomically decrement an integer
2346  *
2347  * @param atomic pointer to the integer to decrement
2348  * @returns the value before decrementing
2349  */
2350 dbus_int32_t
2351 _dbus_atomic_dec (DBusAtomic *atomic)
2352 {
2353 #if DBUS_USE_SYNC
2354   return __sync_sub_and_fetch(&atomic->value, 1)+1;
2355 #else
2356   dbus_int32_t res;
2357
2358   _DBUS_LOCK (atomic);
2359   res = atomic->value;
2360   atomic->value -= 1;
2361   _DBUS_UNLOCK (atomic);
2362   return res;
2363 #endif
2364 }
2365
2366 #ifdef DBUS_BUILD_TESTS
2367 /** Gets our GID
2368  * @returns process GID
2369  */
2370 dbus_gid_t
2371 _dbus_getgid (void)
2372 {
2373   return getgid ();
2374 }
2375 #endif
2376
2377 /**
2378  * Wrapper for poll().
2379  *
2380  * @param fds the file descriptors to poll
2381  * @param n_fds number of descriptors in the array
2382  * @param timeout_milliseconds timeout or -1 for infinite
2383  * @returns numbers of fds with revents, or <0 on error
2384  */
2385 int
2386 _dbus_poll (DBusPollFD *fds,
2387             int         n_fds,
2388             int         timeout_milliseconds)
2389 {
2390 #if defined(HAVE_POLL) && !defined(BROKEN_POLL)
2391   /* This big thing is a constant expression and should get optimized
2392    * out of existence. So it's more robust than a configure check at
2393    * no cost.
2394    */
2395   if (_DBUS_POLLIN == POLLIN &&
2396       _DBUS_POLLPRI == POLLPRI &&
2397       _DBUS_POLLOUT == POLLOUT &&
2398       _DBUS_POLLERR == POLLERR &&
2399       _DBUS_POLLHUP == POLLHUP &&
2400       _DBUS_POLLNVAL == POLLNVAL &&
2401       sizeof (DBusPollFD) == sizeof (struct pollfd) &&
2402       _DBUS_STRUCT_OFFSET (DBusPollFD, fd) ==
2403       _DBUS_STRUCT_OFFSET (struct pollfd, fd) &&
2404       _DBUS_STRUCT_OFFSET (DBusPollFD, events) ==
2405       _DBUS_STRUCT_OFFSET (struct pollfd, events) &&
2406       _DBUS_STRUCT_OFFSET (DBusPollFD, revents) ==
2407       _DBUS_STRUCT_OFFSET (struct pollfd, revents))
2408     {
2409       return poll ((struct pollfd*) fds,
2410                    n_fds,
2411                    timeout_milliseconds);
2412     }
2413   else
2414     {
2415       /* We have to convert the DBusPollFD to an array of
2416        * struct pollfd, poll, and convert back.
2417        */
2418       _dbus_warn ("didn't implement poll() properly for this system yet\n");
2419       return -1;
2420     }
2421 #else /* ! HAVE_POLL */
2422
2423   fd_set read_set, write_set, err_set;
2424   int max_fd = 0;
2425   int i;
2426   struct timeval tv;
2427   int ready;
2428
2429   FD_ZERO (&read_set);
2430   FD_ZERO (&write_set);
2431   FD_ZERO (&err_set);
2432
2433   for (i = 0; i < n_fds; i++)
2434     {
2435       DBusPollFD *fdp = &fds[i];
2436
2437       if (fdp->events & _DBUS_POLLIN)
2438         FD_SET (fdp->fd, &read_set);
2439
2440       if (fdp->events & _DBUS_POLLOUT)
2441         FD_SET (fdp->fd, &write_set);
2442
2443       FD_SET (fdp->fd, &err_set);
2444
2445       max_fd = MAX (max_fd, fdp->fd);
2446     }
2447
2448   tv.tv_sec = timeout_milliseconds / 1000;
2449   tv.tv_usec = (timeout_milliseconds % 1000) * 1000;
2450
2451   ready = select (max_fd + 1, &read_set, &write_set, &err_set,
2452                   timeout_milliseconds < 0 ? NULL : &tv);
2453
2454   if (ready > 0)
2455     {
2456       for (i = 0; i < n_fds; i++)
2457         {
2458           DBusPollFD *fdp = &fds[i];
2459
2460           fdp->revents = 0;
2461
2462           if (FD_ISSET (fdp->fd, &read_set))
2463             fdp->revents |= _DBUS_POLLIN;
2464
2465           if (FD_ISSET (fdp->fd, &write_set))
2466             fdp->revents |= _DBUS_POLLOUT;
2467
2468           if (FD_ISSET (fdp->fd, &err_set))
2469             fdp->revents |= _DBUS_POLLERR;
2470         }
2471     }
2472
2473   return ready;
2474 #endif
2475 }
2476
2477 /**
2478  * Get current time, as in gettimeofday(). Use the monotonic clock if
2479  * available, to avoid problems when the system time changes.
2480  *
2481  * @param tv_sec return location for number of seconds
2482  * @param tv_usec return location for number of microseconds (thousandths)
2483  */
2484 void
2485 _dbus_get_current_time (long *tv_sec,
2486                         long *tv_usec)
2487 {
2488   struct timeval t;
2489
2490 #ifdef HAVE_MONOTONIC_CLOCK
2491   struct timespec ts;
2492   clock_gettime (CLOCK_MONOTONIC, &ts);
2493
2494   if (tv_sec)
2495     *tv_sec = ts.tv_sec;
2496   if (tv_usec)
2497     *tv_usec = ts.tv_nsec / 1000;
2498 #else
2499   gettimeofday (&t, NULL);
2500
2501   if (tv_sec)
2502     *tv_sec = t.tv_sec;
2503   if (tv_usec)
2504     *tv_usec = t.tv_usec;
2505 #endif
2506 }
2507
2508 /**
2509  * Creates a directory; succeeds if the directory
2510  * is created or already existed.
2511  *
2512  * @param filename directory filename
2513  * @param error initialized error object
2514  * @returns #TRUE on success
2515  */
2516 dbus_bool_t
2517 _dbus_create_directory (const DBusString *filename,
2518                         DBusError        *error)
2519 {
2520   const char *filename_c;
2521
2522   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2523
2524   filename_c = _dbus_string_get_const_data (filename);
2525
2526   if (mkdir (filename_c, 0700) < 0)
2527     {
2528       if (errno == EEXIST)
2529         return TRUE;
2530
2531       dbus_set_error (error, DBUS_ERROR_FAILED,
2532                       "Failed to create directory %s: %s\n",
2533                       filename_c, _dbus_strerror (errno));
2534       return FALSE;
2535     }
2536   else
2537     return TRUE;
2538 }
2539
2540 /**
2541  * Appends the given filename to the given directory.
2542  *
2543  * @todo it might be cute to collapse multiple '/' such as "foo//"
2544  * concat "//bar"
2545  *
2546  * @param dir the directory name
2547  * @param next_component the filename
2548  * @returns #TRUE on success
2549  */
2550 dbus_bool_t
2551 _dbus_concat_dir_and_file (DBusString       *dir,
2552                            const DBusString *next_component)
2553 {
2554   dbus_bool_t dir_ends_in_slash;
2555   dbus_bool_t file_starts_with_slash;
2556
2557   if (_dbus_string_get_length (dir) == 0 ||
2558       _dbus_string_get_length (next_component) == 0)
2559     return TRUE;
2560
2561   dir_ends_in_slash = '/' == _dbus_string_get_byte (dir,
2562                                                     _dbus_string_get_length (dir) - 1);
2563
2564   file_starts_with_slash = '/' == _dbus_string_get_byte (next_component, 0);
2565
2566   if (dir_ends_in_slash && file_starts_with_slash)
2567     {
2568       _dbus_string_shorten (dir, 1);
2569     }
2570   else if (!(dir_ends_in_slash || file_starts_with_slash))
2571     {
2572       if (!_dbus_string_append_byte (dir, '/'))
2573         return FALSE;
2574     }
2575
2576   return _dbus_string_copy (next_component, 0, dir,
2577                             _dbus_string_get_length (dir));
2578 }
2579
2580 /** nanoseconds in a second */
2581 #define NANOSECONDS_PER_SECOND       1000000000
2582 /** microseconds in a second */
2583 #define MICROSECONDS_PER_SECOND      1000000
2584 /** milliseconds in a second */
2585 #define MILLISECONDS_PER_SECOND      1000
2586 /** nanoseconds in a millisecond */
2587 #define NANOSECONDS_PER_MILLISECOND  1000000
2588 /** microseconds in a millisecond */
2589 #define MICROSECONDS_PER_MILLISECOND 1000
2590
2591 /**
2592  * Sleeps the given number of milliseconds.
2593  * @param milliseconds number of milliseconds
2594  */
2595 void
2596 _dbus_sleep_milliseconds (int milliseconds)
2597 {
2598 #ifdef HAVE_NANOSLEEP
2599   struct timespec req;
2600   struct timespec rem;
2601
2602   req.tv_sec = milliseconds / MILLISECONDS_PER_SECOND;
2603   req.tv_nsec = (milliseconds % MILLISECONDS_PER_SECOND) * NANOSECONDS_PER_MILLISECOND;
2604   rem.tv_sec = 0;
2605   rem.tv_nsec = 0;
2606
2607   while (nanosleep (&req, &rem) < 0 && errno == EINTR)
2608     req = rem;
2609 #elif defined (HAVE_USLEEP)
2610   usleep (milliseconds * MICROSECONDS_PER_MILLISECOND);
2611 #else /* ! HAVE_USLEEP */
2612   sleep (MAX (milliseconds / 1000, 1));
2613 #endif
2614 }
2615
2616 static dbus_bool_t
2617 _dbus_generate_pseudorandom_bytes (DBusString *str,
2618                                    int         n_bytes)
2619 {
2620   int old_len;
2621   char *p;
2622
2623   old_len = _dbus_string_get_length (str);
2624
2625   if (!_dbus_string_lengthen (str, n_bytes))
2626     return FALSE;
2627
2628   p = _dbus_string_get_data_len (str, old_len, n_bytes);
2629
2630   _dbus_generate_pseudorandom_bytes_buffer (p, n_bytes);
2631
2632   return TRUE;
2633 }
2634
2635 /**
2636  * Generates the given number of random bytes,
2637  * using the best mechanism we can come up with.
2638  *
2639  * @param str the string
2640  * @param n_bytes the number of random bytes to append to string
2641  * @returns #TRUE on success, #FALSE if no memory
2642  */
2643 dbus_bool_t
2644 _dbus_generate_random_bytes (DBusString *str,
2645                              int         n_bytes)
2646 {
2647   int old_len;
2648   int fd;
2649
2650   /* FALSE return means "no memory", if it could
2651    * mean something else then we'd need to return
2652    * a DBusError. So we always fall back to pseudorandom
2653    * if the I/O fails.
2654    */
2655
2656   old_len = _dbus_string_get_length (str);
2657   fd = -1;
2658
2659   /* note, urandom on linux will fall back to pseudorandom */
2660   fd = open ("/dev/urandom", O_RDONLY);
2661   if (fd < 0)
2662     return _dbus_generate_pseudorandom_bytes (str, n_bytes);
2663
2664   _dbus_verbose ("/dev/urandom fd %d opened\n", fd);
2665
2666   if (_dbus_read (fd, str, n_bytes) != n_bytes)
2667     {
2668       _dbus_close (fd, NULL);
2669       _dbus_string_set_length (str, old_len);
2670       return _dbus_generate_pseudorandom_bytes (str, n_bytes);
2671     }
2672
2673   _dbus_verbose ("Read %d bytes from /dev/urandom\n",
2674                  n_bytes);
2675
2676   _dbus_close (fd, NULL);
2677
2678   return TRUE;
2679 }
2680
2681 /**
2682  * Exit the process, returning the given value.
2683  *
2684  * @param code the exit code
2685  */
2686 void
2687 _dbus_exit (int code)
2688 {
2689   _exit (code);
2690 }
2691
2692 /**
2693  * A wrapper around strerror() because some platforms
2694  * may be lame and not have strerror(). Also, never
2695  * returns NULL.
2696  *
2697  * @param error_number errno.
2698  * @returns error description.
2699  */
2700 const char*
2701 _dbus_strerror (int error_number)
2702 {
2703   const char *msg;
2704
2705   msg = strerror (error_number);
2706   if (msg == NULL)
2707     msg = "unknown";
2708
2709   return msg;
2710 }
2711
2712 /**
2713  * signal (SIGPIPE, SIG_IGN);
2714  */
2715 void
2716 _dbus_disable_sigpipe (void)
2717 {
2718   signal (SIGPIPE, SIG_IGN);
2719 }
2720
2721 /**
2722  * Sets the file descriptor to be close
2723  * on exec. Should be called for all file
2724  * descriptors in D-Bus code.
2725  *
2726  * @param fd the file descriptor
2727  */
2728 void
2729 _dbus_fd_set_close_on_exec (intptr_t fd)
2730 {
2731   int val;
2732
2733   val = fcntl (fd, F_GETFD, 0);
2734
2735   if (val < 0)
2736     return;
2737
2738   val |= FD_CLOEXEC;
2739
2740   fcntl (fd, F_SETFD, val);
2741 }
2742
2743 /**
2744  * Closes a file descriptor.
2745  *
2746  * @param fd the file descriptor
2747  * @param error error object
2748  * @returns #FALSE if error set
2749  */
2750 dbus_bool_t
2751 _dbus_close (int        fd,
2752              DBusError *error)
2753 {
2754   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2755
2756  again:
2757   if (close (fd) < 0)
2758     {
2759       if (errno == EINTR)
2760         goto again;
2761
2762       dbus_set_error (error, _dbus_error_from_errno (errno),
2763                       "Could not close fd %d", fd);
2764       return FALSE;
2765     }
2766
2767   return TRUE;
2768 }
2769
2770 /**
2771  * Duplicates a file descriptor. Makes sure the fd returned is >= 3
2772  * (i.e. avoids stdin/stdout/stderr). Sets O_CLOEXEC.
2773  *
2774  * @param fd the file descriptor to duplicate
2775  * @returns duplicated file descriptor
2776  * */
2777 int
2778 _dbus_dup(int        fd,
2779           DBusError *error)
2780 {
2781   int new_fd;
2782
2783 #ifdef F_DUPFD_CLOEXEC
2784   dbus_bool_t cloexec_done;
2785
2786   new_fd = fcntl(fd, F_DUPFD_CLOEXEC, 3);
2787   cloexec_done = new_fd >= 0;
2788
2789   if (new_fd < 0 && errno == EINVAL)
2790 #endif
2791     {
2792       new_fd = fcntl(fd, F_DUPFD, 3);
2793     }
2794
2795   if (new_fd < 0) {
2796
2797     dbus_set_error (error, _dbus_error_from_errno (errno),
2798                     "Could not duplicate fd %d", fd);
2799     return -1;
2800   }
2801
2802 #ifdef F_DUPFD_CLOEXEC
2803   if (!cloexec_done)
2804 #endif
2805     {
2806       _dbus_fd_set_close_on_exec(new_fd);
2807     }
2808
2809   return new_fd;
2810 }
2811
2812 /**
2813  * Sets a file descriptor to be nonblocking.
2814  *
2815  * @param fd the file descriptor.
2816  * @param error address of error location.
2817  * @returns #TRUE on success.
2818  */
2819 dbus_bool_t
2820 _dbus_set_fd_nonblocking (int             fd,
2821                           DBusError      *error)
2822 {
2823   int val;
2824
2825   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2826
2827   val = fcntl (fd, F_GETFL, 0);
2828   if (val < 0)
2829     {
2830       dbus_set_error (error, _dbus_error_from_errno (errno),
2831                       "Failed to get flags from file descriptor %d: %s",
2832                       fd, _dbus_strerror (errno));
2833       _dbus_verbose ("Failed to get flags for fd %d: %s\n", fd,
2834                      _dbus_strerror (errno));
2835       return FALSE;
2836     }
2837
2838   if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
2839     {
2840       dbus_set_error (error, _dbus_error_from_errno (errno),
2841                       "Failed to set nonblocking flag of file descriptor %d: %s",
2842                       fd, _dbus_strerror (errno));
2843       _dbus_verbose ("Failed to set fd %d nonblocking: %s\n",
2844                      fd, _dbus_strerror (errno));
2845
2846       return FALSE;
2847     }
2848
2849   return TRUE;
2850 }
2851
2852 /**
2853  * On GNU libc systems, print a crude backtrace to stderr.  On other
2854  * systems, print "no backtrace support" and block for possible gdb
2855  * attachment if an appropriate environment variable is set.
2856  */
2857 void
2858 _dbus_print_backtrace (void)
2859 {
2860 #if defined (HAVE_BACKTRACE) && defined (DBUS_BUILT_R_DYNAMIC)
2861   void *bt[500];
2862   int bt_size;
2863   int i;
2864   char **syms;
2865
2866   bt_size = backtrace (bt, 500);
2867
2868   syms = backtrace_symbols (bt, bt_size);
2869
2870   i = 0;
2871   while (i < bt_size)
2872     {
2873       /* don't use dbus_warn since it can _dbus_abort() */
2874       fprintf (stderr, "  %s\n", syms[i]);
2875       ++i;
2876     }
2877   fflush (stderr);
2878
2879   free (syms);
2880 #elif defined (HAVE_BACKTRACE) && ! defined (DBUS_BUILT_R_DYNAMIC)
2881   fprintf (stderr, "  D-Bus not built with -rdynamic so unable to print a backtrace\n");
2882 #else
2883   fprintf (stderr, "  D-Bus not compiled with backtrace support so unable to print a backtrace\n");
2884 #endif
2885 }
2886
2887 /**
2888  * Creates a full-duplex pipe (as in socketpair()).
2889  * Sets both ends of the pipe nonblocking.
2890  *
2891  * Marks both file descriptors as close-on-exec
2892  *
2893  * @todo libdbus only uses this for the debug-pipe server, so in
2894  * principle it could be in dbus-sysdeps-util.c, except that
2895  * dbus-sysdeps-util.c isn't in libdbus when tests are enabled and the
2896  * debug-pipe server is used.
2897  *
2898  * @param fd1 return location for one end
2899  * @param fd2 return location for the other end
2900  * @param blocking #TRUE if pipe should be blocking
2901  * @param error error return
2902  * @returns #FALSE on failure (if error is set)
2903  */
2904 dbus_bool_t
2905 _dbus_full_duplex_pipe (int        *fd1,
2906                         int        *fd2,
2907                         dbus_bool_t blocking,
2908                         DBusError  *error)
2909 {
2910 #ifdef HAVE_SOCKETPAIR
2911   int fds[2];
2912   int retval;
2913
2914 #ifdef SOCK_CLOEXEC
2915   dbus_bool_t cloexec_done;
2916
2917   retval = socketpair(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0, fds);
2918   cloexec_done = retval >= 0;
2919
2920   if (retval < 0 && errno == EINVAL)
2921 #endif
2922     {
2923       retval = socketpair(AF_UNIX, SOCK_STREAM, 0, fds);
2924     }
2925
2926   if (retval < 0)
2927     {
2928       dbus_set_error (error, _dbus_error_from_errno (errno),
2929                       "Could not create full-duplex pipe");
2930       return FALSE;
2931     }
2932
2933   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2934
2935 #ifdef SOCK_CLOEXEC
2936   if (!cloexec_done)
2937 #endif
2938     {
2939       _dbus_fd_set_close_on_exec (fds[0]);
2940       _dbus_fd_set_close_on_exec (fds[1]);
2941     }
2942
2943   if (!blocking &&
2944       (!_dbus_set_fd_nonblocking (fds[0], NULL) ||
2945        !_dbus_set_fd_nonblocking (fds[1], NULL)))
2946     {
2947       dbus_set_error (error, _dbus_error_from_errno (errno),
2948                       "Could not set full-duplex pipe nonblocking");
2949
2950       _dbus_close (fds[0], NULL);
2951       _dbus_close (fds[1], NULL);
2952
2953       return FALSE;
2954     }
2955
2956   *fd1 = fds[0];
2957   *fd2 = fds[1];
2958
2959   _dbus_verbose ("full-duplex pipe %d <-> %d\n",
2960                  *fd1, *fd2);
2961
2962   return TRUE;
2963 #else
2964   _dbus_warn ("_dbus_full_duplex_pipe() not implemented on this OS\n");
2965   dbus_set_error (error, DBUS_ERROR_FAILED,
2966                   "_dbus_full_duplex_pipe() not implemented on this OS");
2967   return FALSE;
2968 #endif
2969 }
2970
2971 /**
2972  * Measure the length of the given format string and arguments,
2973  * not including the terminating nul.
2974  *
2975  * @param format a printf-style format string
2976  * @param args arguments for the format string
2977  * @returns length of the given format string and args
2978  */
2979 int
2980 _dbus_printf_string_upper_bound (const char *format,
2981                                  va_list     args)
2982 {
2983   char c;
2984   return vsnprintf (&c, 1, format, args);
2985 }
2986
2987 /**
2988  * Gets the temporary files directory by inspecting the environment variables
2989  * TMPDIR, TMP, and TEMP in that order. If none of those are set "/tmp" is returned
2990  *
2991  * @returns location of temp directory
2992  */
2993 const char*
2994 _dbus_get_tmpdir(void)
2995 {
2996   static const char* tmpdir = NULL;
2997
2998   if (tmpdir == NULL)
2999     {
3000       /* TMPDIR is what glibc uses, then
3001        * glibc falls back to the P_tmpdir macro which
3002        * just expands to "/tmp"
3003        */
3004       if (tmpdir == NULL)
3005         tmpdir = getenv("TMPDIR");
3006
3007       /* These two env variables are probably
3008        * broken, but maybe some OS uses them?
3009        */
3010       if (tmpdir == NULL)
3011         tmpdir = getenv("TMP");
3012       if (tmpdir == NULL)
3013         tmpdir = getenv("TEMP");
3014
3015       /* And this is the sane fallback. */
3016       if (tmpdir == NULL)
3017         tmpdir = "/tmp";
3018     }
3019
3020   _dbus_assert(tmpdir != NULL);
3021
3022   return tmpdir;
3023 }
3024
3025 /**
3026  * Execute a subprocess, returning up to 1024 bytes of output
3027  * into @p result.
3028  *
3029  * If successful, returns #TRUE and appends the output to @p
3030  * result. If a failure happens, returns #FALSE and
3031  * sets an error in @p error.
3032  *
3033  * @note It's not an error if the subprocess terminates normally
3034  * without writing any data to stdout. Verify the @p result length
3035  * before and after this function call to cover this case.
3036  *
3037  * @param progname initial path to exec (may or may not be absolute)
3038  * @param path_fallback if %TRUE, search PATH for executable
3039  * @param argv NULL-terminated list of arguments
3040  * @param result a DBusString where the output can be append
3041  * @param error a DBusError to store the error in case of failure
3042  * @returns #TRUE on success, #FALSE if an error happened
3043  */
3044 static dbus_bool_t
3045 _read_subprocess_line_argv (const char *progpath,
3046                             dbus_bool_t path_fallback,
3047                             char       * const *argv,
3048                             DBusString *result,
3049                             DBusError  *error)
3050 {
3051   int result_pipe[2] = { -1, -1 };
3052   int errors_pipe[2] = { -1, -1 };
3053   pid_t pid;
3054   int ret;
3055   int status;
3056   int orig_len;
3057   int i;
3058
3059   dbus_bool_t retval;
3060   sigset_t new_set, old_set;
3061
3062   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3063   retval = FALSE;
3064
3065   /* We need to block any existing handlers for SIGCHLD temporarily; they
3066    * will cause waitpid() below to fail.
3067    * https://bugs.freedesktop.org/show_bug.cgi?id=21347
3068    */
3069   sigemptyset (&new_set);
3070   sigaddset (&new_set, SIGCHLD);
3071   sigprocmask (SIG_BLOCK, &new_set, &old_set);
3072
3073   orig_len = _dbus_string_get_length (result);
3074
3075 #define READ_END        0
3076 #define WRITE_END       1
3077   if (pipe (result_pipe) < 0)
3078     {
3079       dbus_set_error (error, _dbus_error_from_errno (errno),
3080                       "Failed to create a pipe to call %s: %s",
3081                       progpath, _dbus_strerror (errno));
3082       _dbus_verbose ("Failed to create a pipe to call %s: %s\n",
3083                      progpath, _dbus_strerror (errno));
3084       goto out;
3085     }
3086   if (pipe (errors_pipe) < 0)
3087     {
3088       dbus_set_error (error, _dbus_error_from_errno (errno),
3089                       "Failed to create a pipe to call %s: %s",
3090                       progpath, _dbus_strerror (errno));
3091       _dbus_verbose ("Failed to create a pipe to call %s: %s\n",
3092                      progpath, _dbus_strerror (errno));
3093       goto out;
3094     }
3095
3096   pid = fork ();
3097   if (pid < 0)
3098     {
3099       dbus_set_error (error, _dbus_error_from_errno (errno),
3100                       "Failed to fork() to call %s: %s",
3101                       progpath, _dbus_strerror (errno));
3102       _dbus_verbose ("Failed to fork() to call %s: %s\n",
3103                      progpath, _dbus_strerror (errno));
3104       goto out;
3105     }
3106
3107   if (pid == 0)
3108     {
3109       /* child process */
3110       int maxfds;
3111       int fd;
3112
3113       fd = open ("/dev/null", O_RDWR);
3114       if (fd == -1)
3115         /* huh?! can't open /dev/null? */
3116         _exit (1);
3117
3118       _dbus_verbose ("/dev/null fd %d opened\n", fd);
3119
3120       /* set-up stdXXX */
3121       close (result_pipe[READ_END]);
3122       close (errors_pipe[READ_END]);
3123       close (0);                /* close stdin */
3124       close (1);                /* close stdout */
3125       close (2);                /* close stderr */
3126
3127       if (dup2 (fd, 0) == -1)
3128         _exit (1);
3129       if (dup2 (result_pipe[WRITE_END], 1) == -1)
3130         _exit (1);
3131       if (dup2 (errors_pipe[WRITE_END], 2) == -1)
3132         _exit (1);
3133
3134       maxfds = sysconf (_SC_OPEN_MAX);
3135       /* Pick something reasonable if for some reason sysconf
3136        * says unlimited.
3137        */
3138       if (maxfds < 0)
3139         maxfds = 1024;
3140       /* close all inherited fds */
3141       for (i = 3; i < maxfds; i++)
3142         close (i);
3143
3144       sigprocmask (SIG_SETMASK, &old_set, NULL);
3145
3146       /* If it looks fully-qualified, try execv first */
3147       if (progpath[0] == '/')
3148         {
3149           execv (progpath, argv);
3150           /* Ok, that failed.  Now if path_fallback is given, let's
3151            * try unqualified.  This is mostly a hack to work
3152            * around systems which ship dbus-launch in /usr/bin
3153            * but everything else in /bin (because dbus-launch
3154            * depends on X11).
3155            */
3156           if (path_fallback)
3157             /* We must have a slash, because we checked above */
3158             execvp (strrchr (progpath, '/')+1, argv);
3159         }
3160       else
3161         execvp (progpath, argv);
3162
3163       /* still nothing, we failed */
3164       _exit (1);
3165     }
3166
3167   /* parent process */
3168   close (result_pipe[WRITE_END]);
3169   close (errors_pipe[WRITE_END]);
3170   result_pipe[WRITE_END] = -1;
3171   errors_pipe[WRITE_END] = -1;
3172
3173   ret = 0;
3174   do
3175     {
3176       ret = _dbus_read (result_pipe[READ_END], result, 1024);
3177     }
3178   while (ret > 0);
3179
3180   /* reap the child process to avoid it lingering as zombie */
3181   do
3182     {
3183       ret = waitpid (pid, &status, 0);
3184     }
3185   while (ret == -1 && errno == EINTR);
3186
3187   /* We succeeded if the process exited with status 0 and
3188      anything was read */
3189   if (!WIFEXITED (status) || WEXITSTATUS (status) != 0 )
3190     {
3191       /* The process ended with error */
3192       DBusString error_message;
3193       if (!_dbus_string_init (&error_message))
3194         {
3195           _DBUS_SET_OOM (error);
3196           goto out;
3197         }
3198
3199       ret = 0;
3200       do
3201         {
3202           ret = _dbus_read (errors_pipe[READ_END], &error_message, 1024);
3203         }
3204       while (ret > 0);
3205
3206       _dbus_string_set_length (result, orig_len);
3207       if (_dbus_string_get_length (&error_message) > 0)
3208         dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
3209                         "%s terminated abnormally with the following error: %s",
3210                         progpath, _dbus_string_get_data (&error_message));
3211       else
3212         dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
3213                         "%s terminated abnormally without any error message",
3214                         progpath);
3215       goto out;
3216     }
3217
3218   retval = TRUE;
3219
3220  out:
3221   sigprocmask (SIG_SETMASK, &old_set, NULL);
3222
3223   if (retval)
3224     _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3225   else
3226     _DBUS_ASSERT_ERROR_IS_SET (error);
3227
3228   if (result_pipe[0] != -1)
3229     close (result_pipe[0]);
3230   if (result_pipe[1] != -1)
3231     close (result_pipe[1]);
3232   if (errors_pipe[0] != -1)
3233     close (errors_pipe[0]);
3234   if (errors_pipe[1] != -1)
3235     close (errors_pipe[1]);
3236
3237   return retval;
3238 }
3239
3240 /**
3241  * Returns the address of a new session bus.
3242  *
3243  * If successful, returns #TRUE and appends the address to @p
3244  * address. If a failure happens, returns #FALSE and
3245  * sets an error in @p error.
3246  *
3247  * @param address a DBusString where the address can be stored
3248  * @param error a DBusError to store the error in case of failure
3249  * @returns #TRUE on success, #FALSE if an error happened
3250  */
3251 dbus_bool_t
3252 _dbus_get_autolaunch_address (const char *scope,
3253                               DBusString *address,
3254                               DBusError  *error)
3255 {
3256   static char *argv[6];
3257   int i;
3258   DBusString uuid;
3259   dbus_bool_t retval;
3260
3261   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3262   retval = FALSE;
3263
3264   if (!_dbus_string_init (&uuid))
3265     {
3266       _DBUS_SET_OOM (error);
3267       return FALSE;
3268     }
3269
3270   if (!_dbus_get_local_machine_uuid_encoded (&uuid))
3271     {
3272       _DBUS_SET_OOM (error);
3273       goto out;
3274     }
3275
3276   i = 0;
3277   argv[i] = "dbus-launch";
3278   ++i;
3279   argv[i] = "--autolaunch";
3280   ++i;
3281   argv[i] = _dbus_string_get_data (&uuid);
3282   ++i;
3283   argv[i] = "--binary-syntax";
3284   ++i;
3285   argv[i] = "--close-stderr";
3286   ++i;
3287   argv[i] = NULL;
3288   ++i;
3289
3290   _dbus_assert (i == _DBUS_N_ELEMENTS (argv));
3291
3292   retval = _read_subprocess_line_argv (DBUS_BINDIR "/dbus-launch",
3293                                        TRUE,
3294                                        argv, address, error);
3295
3296  out:
3297   _dbus_string_free (&uuid);
3298   return retval;
3299 }
3300
3301 /**
3302  * Reads the uuid of the machine we're running on from
3303  * the dbus configuration. Optionally try to create it
3304  * (only root can do this usually).
3305  *
3306  * On UNIX, reads a file that gets created by dbus-uuidgen
3307  * in a post-install script. On Windows, if there's a standard
3308  * machine uuid we could just use that, but I can't find one
3309  * with the right properties (the hardware profile guid can change
3310  * without rebooting I believe). If there's no standard one
3311  * we might want to use the registry instead of a file for
3312  * this, and I'm not sure how we'd ensure the uuid gets created.
3313  *
3314  * @param machine_id guid to init with the machine's uuid
3315  * @param create_if_not_found try to create the uuid if it doesn't exist
3316  * @param error the error return
3317  * @returns #FALSE if the error is set
3318  */
3319 dbus_bool_t
3320 _dbus_read_local_machine_uuid (DBusGUID   *machine_id,
3321                                dbus_bool_t create_if_not_found,
3322                                DBusError  *error)
3323 {
3324   DBusString filename;
3325   _dbus_string_init_const (&filename, DBUS_MACHINE_UUID_FILE);
3326   return _dbus_read_uuid_file (&filename, machine_id, create_if_not_found, error);
3327 }
3328
3329 #define DBUS_UNIX_STANDARD_SESSION_SERVICEDIR "/dbus-1/services"
3330 #define DBUS_UNIX_STANDARD_SYSTEM_SERVICEDIR "/dbus-1/system-services"
3331
3332 /**
3333  * quries launchd for a specific env var which holds the socket path.
3334  * @param launchd_env_var the env var to look up
3335  * @param error a DBusError to store the error in case of failure
3336  * @return the value of the env var
3337  */
3338 dbus_bool_t
3339 _dbus_lookup_launchd_socket (DBusString *socket_path,
3340                              const char *launchd_env_var,
3341                              DBusError  *error)
3342 {
3343 #ifdef DBUS_ENABLE_LAUNCHD
3344   char *argv[4];
3345   int i;
3346
3347   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3348
3349   i = 0;
3350   argv[i] = "launchctl";
3351   ++i;
3352   argv[i] = "getenv";
3353   ++i;
3354   argv[i] = (char*)launchd_env_var;
3355   ++i;
3356   argv[i] = NULL;
3357   ++i;
3358
3359   _dbus_assert (i == _DBUS_N_ELEMENTS (argv));
3360
3361   if (!_read_subprocess_line_argv(argv[0], TRUE, argv, socket_path, error))
3362     {
3363       return FALSE;
3364     }
3365
3366   /* no error, but no result either */
3367   if (_dbus_string_get_length(socket_path) == 0)
3368     {
3369       return FALSE;
3370     }
3371
3372   /* strip the carriage-return */
3373   _dbus_string_shorten(socket_path, 1);
3374   return TRUE;
3375 #else /* DBUS_ENABLE_LAUNCHD */
3376   dbus_set_error(error, DBUS_ERROR_NOT_SUPPORTED,
3377                 "can't lookup socket from launchd; launchd support not compiled in");
3378   return FALSE;
3379 #endif
3380 }
3381
3382 static dbus_bool_t
3383 _dbus_lookup_session_address_launchd (DBusString *address, DBusError  *error)
3384 {
3385 #ifdef DBUS_ENABLE_LAUNCHD
3386   dbus_bool_t valid_socket;
3387   DBusString socket_path;
3388
3389   if (!_dbus_string_init (&socket_path))
3390     {
3391       _DBUS_SET_OOM (error);
3392       return FALSE;
3393     }
3394
3395   valid_socket = _dbus_lookup_launchd_socket (&socket_path, "DBUS_LAUNCHD_SESSION_BUS_SOCKET", error);
3396
3397   if (dbus_error_is_set(error))
3398     {
3399       _dbus_string_free(&socket_path);
3400       return FALSE;
3401     }
3402
3403   if (!valid_socket)
3404     {
3405       dbus_set_error(error, "no socket path",
3406                 "launchd did not provide a socket path, "
3407                 "verify that org.freedesktop.dbus-session.plist is loaded!");
3408       _dbus_string_free(&socket_path);
3409       return FALSE;
3410     }
3411   if (!_dbus_string_append (address, "unix:path="))
3412     {
3413       _DBUS_SET_OOM (error);
3414       _dbus_string_free(&socket_path);
3415       return FALSE;
3416     }
3417   if (!_dbus_string_copy (&socket_path, 0, address,
3418                           _dbus_string_get_length (address)))
3419     {
3420       _DBUS_SET_OOM (error);
3421       _dbus_string_free(&socket_path);
3422       return FALSE;
3423     }
3424
3425   _dbus_string_free(&socket_path);
3426   return TRUE;
3427 #else
3428   dbus_set_error(error, DBUS_ERROR_NOT_SUPPORTED,
3429                 "can't lookup session address from launchd; launchd support not compiled in");
3430   return FALSE;
3431 #endif
3432 }
3433
3434 /**
3435  * Determines the address of the session bus by querying a
3436  * platform-specific method.
3437  *
3438  * The first parameter will be a boolean specifying whether
3439  * or not a dynamic session lookup is supported on this platform.
3440  *
3441  * If supported is TRUE and the return value is #TRUE, the
3442  * address will be  appended to @p address.
3443  * If a failure happens, returns #FALSE and sets an error in
3444  * @p error.
3445  *
3446  * If supported is FALSE, ignore the return value.
3447  *
3448  * @param supported returns whether this method is supported
3449  * @param address a DBusString where the address can be stored
3450  * @param error a DBusError to store the error in case of failure
3451  * @returns #TRUE on success, #FALSE if an error happened
3452  */
3453 dbus_bool_t
3454 _dbus_lookup_session_address (dbus_bool_t *supported,
3455                               DBusString  *address,
3456                               DBusError   *error)
3457 {
3458 #ifdef DBUS_ENABLE_LAUNCHD
3459   *supported = TRUE;
3460   return _dbus_lookup_session_address_launchd (address, error);
3461 #else
3462   /* On non-Mac Unix platforms, if the session address isn't already
3463    * set in DBUS_SESSION_BUS_ADDRESS environment variable, we punt and
3464    * fall back to the autolaunch: global default; see
3465    * init_session_address in dbus/dbus-bus.c. */
3466   *supported = FALSE;
3467   return TRUE;
3468 #endif
3469 }
3470
3471 /**
3472  * Returns the standard directories for a session bus to look for service
3473  * activation files
3474  *
3475  * On UNIX this should be the standard xdg freedesktop.org data directories:
3476  *
3477  * XDG_DATA_HOME=${XDG_DATA_HOME-$HOME/.local/share}
3478  * XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}
3479  *
3480  * and
3481  *
3482  * DBUS_DATADIR
3483  *
3484  * @param dirs the directory list we are returning
3485  * @returns #FALSE on OOM
3486  */
3487
3488 dbus_bool_t
3489 _dbus_get_standard_session_servicedirs (DBusList **dirs)
3490 {
3491   const char *xdg_data_home;
3492   const char *xdg_data_dirs;
3493   DBusString servicedir_path;
3494
3495   if (!_dbus_string_init (&servicedir_path))
3496     return FALSE;
3497
3498   xdg_data_home = _dbus_getenv ("XDG_DATA_HOME");
3499   xdg_data_dirs = _dbus_getenv ("XDG_DATA_DIRS");
3500
3501   if (xdg_data_dirs != NULL)
3502     {
3503       if (!_dbus_string_append (&servicedir_path, xdg_data_dirs))
3504         goto oom;
3505
3506       if (!_dbus_string_append (&servicedir_path, ":"))
3507         goto oom;
3508     }
3509   else
3510     {
3511       if (!_dbus_string_append (&servicedir_path, "/usr/local/share:/usr/share:"))
3512         goto oom;
3513     }
3514
3515   /*
3516    * add configured datadir to defaults
3517    * this may be the same as an xdg dir
3518    * however the config parser should take
3519    * care of duplicates
3520    */
3521   if (!_dbus_string_append (&servicedir_path, DBUS_DATADIR":"))
3522         goto oom;
3523
3524   if (xdg_data_home != NULL)
3525     {
3526       if (!_dbus_string_append (&servicedir_path, xdg_data_home))
3527         goto oom;
3528     }
3529   else
3530     {
3531       const DBusString *homedir;
3532       DBusString local_share;
3533
3534       if (!_dbus_homedir_from_current_process (&homedir))
3535         goto oom;
3536
3537       if (!_dbus_string_append (&servicedir_path, _dbus_string_get_const_data (homedir)))
3538         goto oom;
3539
3540       _dbus_string_init_const (&local_share, "/.local/share");
3541       if (!_dbus_concat_dir_and_file (&servicedir_path, &local_share))
3542         goto oom;
3543     }
3544
3545   if (!_dbus_split_paths_and_append (&servicedir_path,
3546                                      DBUS_UNIX_STANDARD_SESSION_SERVICEDIR,
3547                                      dirs))
3548     goto oom;
3549
3550   _dbus_string_free (&servicedir_path);
3551   return TRUE;
3552
3553  oom:
3554   _dbus_string_free (&servicedir_path);
3555   return FALSE;
3556 }
3557
3558
3559 /**
3560  * Returns the standard directories for a system bus to look for service
3561  * activation files
3562  *
3563  * On UNIX this should be the standard xdg freedesktop.org data directories:
3564  *
3565  * XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}
3566  *
3567  * and
3568  *
3569  * DBUS_DATADIR
3570  *
3571  * On Windows there is no system bus and this function can return nothing.
3572  *
3573  * @param dirs the directory list we are returning
3574  * @returns #FALSE on OOM
3575  */
3576
3577 dbus_bool_t
3578 _dbus_get_standard_system_servicedirs (DBusList **dirs)
3579 {
3580   const char *xdg_data_dirs;
3581   DBusString servicedir_path;
3582
3583   if (!_dbus_string_init (&servicedir_path))
3584     return FALSE;
3585
3586   xdg_data_dirs = _dbus_getenv ("XDG_DATA_DIRS");
3587
3588   if (xdg_data_dirs != NULL)
3589     {
3590       if (!_dbus_string_append (&servicedir_path, xdg_data_dirs))
3591         goto oom;
3592
3593       if (!_dbus_string_append (&servicedir_path, ":"))
3594         goto oom;
3595     }
3596   else
3597     {
3598       if (!_dbus_string_append (&servicedir_path, "/usr/local/share:/usr/share:"))
3599         goto oom;
3600     }
3601
3602   /*
3603    * add configured datadir to defaults
3604    * this may be the same as an xdg dir
3605    * however the config parser should take
3606    * care of duplicates
3607    */
3608   if (!_dbus_string_append (&servicedir_path, DBUS_DATADIR":"))
3609         goto oom;
3610
3611   if (!_dbus_split_paths_and_append (&servicedir_path,
3612                                      DBUS_UNIX_STANDARD_SYSTEM_SERVICEDIR,
3613                                      dirs))
3614     goto oom;
3615
3616   _dbus_string_free (&servicedir_path);
3617   return TRUE;
3618
3619  oom:
3620   _dbus_string_free (&servicedir_path);
3621   return FALSE;
3622 }
3623
3624 /**
3625  * Append the absolute path of the system.conf file
3626  * (there is no system bus on Windows so this can just
3627  * return FALSE and print a warning or something)
3628  *
3629  * @param str the string to append to
3630  * @returns #FALSE if no memory
3631  */
3632 dbus_bool_t
3633 _dbus_append_system_config_file (DBusString *str)
3634 {
3635   return _dbus_string_append (str, DBUS_SYSTEM_CONFIG_FILE);
3636 }
3637
3638 /**
3639  * Append the absolute path of the session.conf file.
3640  *
3641  * @param str the string to append to
3642  * @returns #FALSE if no memory
3643  */
3644 dbus_bool_t
3645 _dbus_append_session_config_file (DBusString *str)
3646 {
3647   return _dbus_string_append (str, DBUS_SESSION_CONFIG_FILE);
3648 }
3649
3650 /**
3651  * Called when the bus daemon is signaled to reload its configuration; any
3652  * caches should be nuked. Of course any caches that need explicit reload
3653  * are probably broken, but c'est la vie.
3654  *
3655  *
3656  */
3657 void
3658 _dbus_flush_caches (void)
3659 {
3660   _dbus_user_database_flush_system ();
3661 }
3662
3663 /**
3664  * Appends the directory in which a keyring for the given credentials
3665  * should be stored.  The credentials should have either a Windows or
3666  * UNIX user in them.  The directory should be an absolute path.
3667  *
3668  * On UNIX the directory is ~/.dbus-keyrings while on Windows it should probably
3669  * be something else, since the dotfile convention is not normal on Windows.
3670  *
3671  * @param directory string to append directory to
3672  * @param credentials credentials the directory should be for
3673  *
3674  * @returns #FALSE on no memory
3675  */
3676 dbus_bool_t
3677 _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
3678                                                 DBusCredentials *credentials)
3679 {
3680   DBusString homedir;
3681   DBusString dotdir;
3682   dbus_uid_t uid;
3683
3684   _dbus_assert (credentials != NULL);
3685   _dbus_assert (!_dbus_credentials_are_anonymous (credentials));
3686
3687   if (!_dbus_string_init (&homedir))
3688     return FALSE;
3689
3690   uid = _dbus_credentials_get_unix_uid (credentials);
3691   _dbus_assert (uid != DBUS_UID_UNSET);
3692
3693   if (!_dbus_homedir_from_uid (uid, &homedir))
3694     goto failed;
3695
3696 #ifdef DBUS_BUILD_TESTS
3697   {
3698     const char *override;
3699
3700     override = _dbus_getenv ("DBUS_TEST_HOMEDIR");
3701     if (override != NULL && *override != '\0')
3702       {
3703         _dbus_string_set_length (&homedir, 0);
3704         if (!_dbus_string_append (&homedir, override))
3705           goto failed;
3706
3707         _dbus_verbose ("Using fake homedir for testing: %s\n",
3708                        _dbus_string_get_const_data (&homedir));
3709       }
3710     else
3711       {
3712         static dbus_bool_t already_warned = FALSE;
3713         if (!already_warned)
3714           {
3715             _dbus_warn ("Using your real home directory for testing, set DBUS_TEST_HOMEDIR to avoid\n");
3716             already_warned = TRUE;
3717           }
3718       }
3719   }
3720 #endif
3721
3722   _dbus_string_init_const (&dotdir, ".dbus-keyrings");
3723   if (!_dbus_concat_dir_and_file (&homedir,
3724                                   &dotdir))
3725     goto failed;
3726
3727   if (!_dbus_string_copy (&homedir, 0,
3728                           directory, _dbus_string_get_length (directory))) {
3729     goto failed;
3730   }
3731
3732   _dbus_string_free (&homedir);
3733   return TRUE;
3734
3735  failed:
3736   _dbus_string_free (&homedir);
3737   return FALSE;
3738 }
3739
3740 //PENDING(kdab) docs
3741 dbus_bool_t
3742 _dbus_daemon_publish_session_bus_address (const char* addr,
3743                                           const char *scope)
3744 {
3745   return TRUE;
3746 }
3747
3748 //PENDING(kdab) docs
3749 void
3750 _dbus_daemon_unpublish_session_bus_address (void)
3751 {
3752
3753 }
3754
3755 /**
3756  * See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently
3757  * for Winsock so is abstracted)
3758  *
3759  * @returns #TRUE if errno == EAGAIN or errno == EWOULDBLOCK
3760  */
3761 dbus_bool_t
3762 _dbus_get_is_errno_eagain_or_ewouldblock (void)
3763 {
3764   return errno == EAGAIN || errno == EWOULDBLOCK;
3765 }
3766
3767 /**
3768  * Removes a directory; Directory must be empty
3769  *
3770  * @param filename directory filename
3771  * @param error initialized error object
3772  * @returns #TRUE on success
3773  */
3774 dbus_bool_t
3775 _dbus_delete_directory (const DBusString *filename,
3776                         DBusError        *error)
3777 {
3778   const char *filename_c;
3779
3780   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3781
3782   filename_c = _dbus_string_get_const_data (filename);
3783
3784   if (rmdir (filename_c) != 0)
3785     {
3786       dbus_set_error (error, DBUS_ERROR_FAILED,
3787                       "Failed to remove directory %s: %s\n",
3788                       filename_c, _dbus_strerror (errno));
3789       return FALSE;
3790     }
3791
3792   return TRUE;
3793 }
3794
3795 /**
3796  *  Checks whether file descriptors may be passed via the socket
3797  *
3798  *  @param fd the socket
3799  *  @return TRUE when fd passing over this socket is supported
3800  *
3801  */
3802 dbus_bool_t
3803 _dbus_socket_can_pass_unix_fd(int fd) {
3804
3805 #ifdef SCM_RIGHTS
3806   union {
3807     struct sockaddr sa;
3808     struct sockaddr_storage storage;
3809     struct sockaddr_un un;
3810   } sa_buf;
3811
3812   socklen_t sa_len = sizeof(sa_buf);
3813
3814   _DBUS_ZERO(sa_buf);
3815
3816   if (getsockname(fd, &sa_buf.sa, &sa_len) < 0)
3817     return FALSE;
3818
3819   return sa_buf.sa.sa_family == AF_UNIX;
3820
3821 #else
3822   return FALSE;
3823
3824 #endif
3825 }
3826
3827
3828 /*
3829  * replaces the term DBUS_PREFIX in configure_time_path by the
3830  * current dbus installation directory. On unix this function is a noop
3831  *
3832  * @param configure_time_path
3833  * @return real path
3834  */
3835 const char *
3836 _dbus_replace_install_prefix (const char *configure_time_path)
3837 {
3838   return configure_time_path;
3839 }
3840
3841 /* tests in dbus-sysdeps-util.c */