1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-sysdeps-util-unix.c Would be in dbus-sysdeps-unix.c, but not used in libdbus
4 * Copyright (C) 2002, 2003, 2004, 2005 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "dbus-sysdeps.h"
25 #include "dbus-sysdeps-unix.h"
26 #include "dbus-internals.h"
27 #include "dbus-protocol.h"
28 #include "dbus-string.h"
29 #define DBUS_USERDB_INCLUDES_PRIVATE 1
30 #include "dbus-userdb.h"
31 #include "dbus-test.h"
33 #include <sys/types.h>
43 #include <sys/socket.h>
48 #ifdef HAVE_SYS_SYSLIMITS_H
49 #include <sys/syslimits.h>
57 * @addtogroup DBusInternalsUtils
63 * Does the chdir, fork, setsid, etc. to become a daemon process.
65 * @param pidfile #NULL, or pidfile to create
66 * @param print_pid_pipe pipe to print daemon's pid to, or -1 for none
67 * @param error return location for errors
68 * @param keep_umask #TRUE to keep the original umask
69 * @returns #FALSE on failure
72 _dbus_become_daemon (const DBusString *pidfile,
73 DBusPipe *print_pid_pipe,
75 dbus_bool_t keep_umask)
81 _dbus_verbose ("Becoming a daemon...\n");
83 _dbus_verbose ("chdir to /\n");
86 dbus_set_error (error, DBUS_ERROR_FAILED,
87 "Could not chdir() to root directory");
91 _dbus_verbose ("forking...\n");
92 switch ((child_pid = fork ()))
95 _dbus_verbose ("fork failed\n");
96 dbus_set_error (error, _dbus_error_from_errno (errno),
97 "Failed to fork daemon: %s", _dbus_strerror (errno));
102 _dbus_verbose ("in child, closing std file descriptors\n");
104 /* silently ignore failures here, if someone
105 * doesn't have /dev/null we may as well try
109 dev_null_fd = open ("/dev/null", O_RDWR);
110 if (dev_null_fd >= 0)
112 dup2 (dev_null_fd, 0);
113 dup2 (dev_null_fd, 1);
115 s = _dbus_getenv ("DBUS_DEBUG_OUTPUT");
116 if (s == NULL || *s == '\0')
117 dup2 (dev_null_fd, 2);
119 _dbus_verbose ("keeping stderr open due to DBUS_DEBUG_OUTPUT\n");
124 /* Get a predictable umask */
125 _dbus_verbose ("setting umask\n");
129 _dbus_verbose ("calling setsid()\n");
131 _dbus_assert_not_reached ("setsid() failed");
136 if (!_dbus_write_pid_to_file_and_pipe (pidfile, print_pid_pipe,
139 _dbus_verbose ("pid file or pipe write failed: %s\n",
141 kill (child_pid, SIGTERM);
145 _dbus_verbose ("parent exiting\n");
155 * Creates a file containing the process ID.
157 * @param filename the filename to write to
158 * @param pid our process ID
159 * @param error return location for errors
160 * @returns #FALSE on failure
163 _dbus_write_pid_file (const DBusString *filename,
167 const char *cfilename;
171 cfilename = _dbus_string_get_const_data (filename);
173 fd = open (cfilename, O_WRONLY|O_CREAT|O_EXCL|O_BINARY, 0644);
177 dbus_set_error (error, _dbus_error_from_errno (errno),
178 "Failed to open \"%s\": %s", cfilename,
179 _dbus_strerror (errno));
183 if ((f = fdopen (fd, "w")) == NULL)
185 dbus_set_error (error, _dbus_error_from_errno (errno),
186 "Failed to fdopen fd %d: %s", fd, _dbus_strerror (errno));
187 _dbus_close (fd, NULL);
191 if (fprintf (f, "%lu\n", pid) < 0)
193 dbus_set_error (error, _dbus_error_from_errno (errno),
194 "Failed to write to \"%s\": %s", cfilename,
195 _dbus_strerror (errno));
201 if (fclose (f) == EOF)
203 dbus_set_error (error, _dbus_error_from_errno (errno),
204 "Failed to close \"%s\": %s", cfilename,
205 _dbus_strerror (errno));
213 * Writes the given pid_to_write to a pidfile (if non-NULL) and/or to a
214 * pipe (if non-NULL). Does nothing if pidfile and print_pid_pipe are both
217 * @param pidfile the file to write to or #NULL
218 * @param print_pid_pipe the pipe to write to or #NULL
219 * @param pid_to_write the pid to write out
220 * @param error error on failure
221 * @returns FALSE if error is set
224 _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
225 DBusPipe *print_pid_pipe,
226 dbus_pid_t pid_to_write,
231 _dbus_verbose ("writing pid file %s\n", _dbus_string_get_const_data (pidfile));
232 if (!_dbus_write_pid_file (pidfile,
236 _dbus_verbose ("pid file write failed\n");
237 _DBUS_ASSERT_ERROR_IS_SET(error);
243 _dbus_verbose ("No pid file requested\n");
246 if (print_pid_pipe != NULL && _dbus_pipe_is_valid (print_pid_pipe))
251 _dbus_verbose ("writing our pid to pipe %d\n", print_pid_pipe->fd_or_handle);
253 if (!_dbus_string_init (&pid))
255 _DBUS_SET_OOM (error);
259 if (!_dbus_string_append_int (&pid, pid_to_write) ||
260 !_dbus_string_append (&pid, "\n"))
262 _dbus_string_free (&pid);
263 _DBUS_SET_OOM (error);
267 bytes = _dbus_string_get_length (&pid);
268 if (_dbus_pipe_write (print_pid_pipe, &pid, 0, bytes, error) != bytes)
270 /* _dbus_pipe_write sets error only on failure, not short write */
271 if (error != NULL && !dbus_error_is_set(error))
273 dbus_set_error (error, DBUS_ERROR_FAILED,
274 "Printing message bus PID: did not write enough bytes\n");
276 _dbus_string_free (&pid);
280 _dbus_string_free (&pid);
284 _dbus_verbose ("No pid pipe to write to\n");
291 * Verify that after the fork we can successfully change to this user.
293 * @param user the username given in the daemon configuration
294 * @returns #TRUE if username is valid
297 _dbus_verify_daemon_user (const char *user)
301 _dbus_string_init_const (&u, user);
303 return _dbus_get_user_id_and_primary_group (&u, NULL, NULL);
307 /* The HAVE_LIBAUDIT case lives in selinux.c */
308 #ifndef HAVE_LIBAUDIT
310 * Changes the user and group the bus is running as.
312 * @param user the user to become
313 * @param error return location for errors
314 * @returns #FALSE on failure
317 _dbus_change_to_daemon_user (const char *user,
324 _dbus_string_init_const (&u, user);
326 if (!_dbus_get_user_id_and_primary_group (&u, &uid, &gid))
328 dbus_set_error (error, DBUS_ERROR_FAILED,
329 "User '%s' does not appear to exist?",
334 /* setgroups() only works if we are a privileged process,
335 * so we don't return error on failure; the only possible
336 * failure is that we don't have perms to do it.
338 * not sure this is right, maybe if setuid()
339 * is going to work then setgroups() should also work.
341 if (setgroups (0, NULL) < 0)
342 _dbus_warn ("Failed to drop supplementary groups: %s\n",
343 _dbus_strerror (errno));
345 /* Set GID first, or the setuid may remove our permission
348 if (setgid (gid) < 0)
350 dbus_set_error (error, _dbus_error_from_errno (errno),
351 "Failed to set GID to %lu: %s", gid,
352 _dbus_strerror (errno));
356 if (setuid (uid) < 0)
358 dbus_set_error (error, _dbus_error_from_errno (errno),
359 "Failed to set UID to %lu: %s", uid,
360 _dbus_strerror (errno));
366 #endif /* !HAVE_LIBAUDIT */
369 _dbus_init_system_log (void)
371 openlog ("dbus", LOG_PID, LOG_DAEMON);
375 * Log an informative message. Intended for use primarily by
378 * @param msg a printf-style format string
379 * @param args arguments for the format string
382 _dbus_log_info (const char *msg, va_list args)
384 vsyslog (LOG_DAEMON|LOG_NOTICE, msg, args);
388 * Log a security-related message. Intended for use primarily by
391 * @param msg a printf-style format string
392 * @param args arguments for the format string
395 _dbus_log_security (const char *msg, va_list args)
397 vsyslog (LOG_AUTH|LOG_NOTICE, msg, args);
400 /** Installs a UNIX signal handler
402 * @param sig the signal to handle
403 * @param handler the handler
406 _dbus_set_signal_handler (int sig,
407 DBusSignalHandler handler)
409 struct sigaction act;
412 sigemptyset (&empty_mask);
413 act.sa_handler = handler;
414 act.sa_mask = empty_mask;
416 sigaction (sig, &act, NULL);
419 /** Checks if a file exists
421 * @param file full path to the file
422 * @returns #TRUE if file exists
425 _dbus_file_exists (const char *file)
427 return (access (file, F_OK) == 0);
430 /** Checks if user is at the console
432 * @param username user to check
433 * @param error return location for errors
434 * @returns #TRUE is the user is at the consolei and there are no errors
437 _dbus_user_at_console (const char *username,
445 if (!_dbus_string_init (&f))
447 _DBUS_SET_OOM (error);
451 if (!_dbus_string_append (&f, DBUS_CONSOLE_AUTH_DIR))
453 _DBUS_SET_OOM (error);
458 if (!_dbus_string_append (&f, username))
460 _DBUS_SET_OOM (error);
464 result = _dbus_file_exists (_dbus_string_get_const_data (&f));
467 _dbus_string_free (&f);
474 * Checks whether the filename is an absolute path
476 * @param filename the filename
477 * @returns #TRUE if an absolute path
480 _dbus_path_is_absolute (const DBusString *filename)
482 if (_dbus_string_get_length (filename) > 0)
483 return _dbus_string_get_byte (filename, 0) == '/';
491 * @param filename the filename to stat
492 * @param statbuf the stat info to fill in
493 * @param error return location for error
494 * @returns #FALSE if error was set
497 _dbus_stat (const DBusString *filename,
501 const char *filename_c;
504 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
506 filename_c = _dbus_string_get_const_data (filename);
508 if (stat (filename_c, &sb) < 0)
510 dbus_set_error (error, _dbus_error_from_errno (errno),
511 "%s", _dbus_strerror (errno));
515 statbuf->mode = sb.st_mode;
516 statbuf->nlink = sb.st_nlink;
517 statbuf->uid = sb.st_uid;
518 statbuf->gid = sb.st_gid;
519 statbuf->size = sb.st_size;
520 statbuf->atime = sb.st_atime;
521 statbuf->mtime = sb.st_mtime;
522 statbuf->ctime = sb.st_ctime;
529 * Internals of directory iterator
533 DIR *d; /**< The DIR* from opendir() */
538 * Open a directory to iterate over.
540 * @param filename the directory name
541 * @param error exception return object or #NULL
542 * @returns new iterator, or #NULL on error
545 _dbus_directory_open (const DBusString *filename,
550 const char *filename_c;
552 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
554 filename_c = _dbus_string_get_const_data (filename);
556 d = opendir (filename_c);
559 dbus_set_error (error, _dbus_error_from_errno (errno),
560 "Failed to read directory \"%s\": %s",
562 _dbus_strerror (errno));
565 iter = dbus_new0 (DBusDirIter, 1);
569 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
570 "Could not allocate memory for directory iterator");
579 /* Calculate the required buffer size (in bytes) for directory
580 * entries read from the given directory handle. Return -1 if this
581 * this cannot be done.
583 * If you use autoconf, include fpathconf and dirfd in your
584 * AC_CHECK_FUNCS list. Otherwise use some other method to detect
585 * and use them where available.
588 dirent_buf_size(DIR * dirp, size_t *size)
591 # if defined(HAVE_FPATHCONF) && defined(_PC_NAME_MAX)
592 # if defined(HAVE_DIRFD)
593 name_max = fpathconf(dirfd(dirp), _PC_NAME_MAX);
594 # elif defined(HAVE_DDFD)
595 name_max = fpathconf(dirp->dd_fd, _PC_NAME_MAX);
597 name_max = fpathconf(dirp->__dd_fd, _PC_NAME_MAX);
598 # endif /* HAVE_DIRFD */
600 # if defined(NAME_MAX)
605 # elif defined(MAXNAMELEN)
606 name_max = MAXNAMELEN;
608 # if defined(NAME_MAX)
611 # error "buffer size for readdir_r cannot be determined"
615 *size = (size_t)offsetof(struct dirent, d_name) + name_max + 1;
623 * Get next file in the directory. Will not return "." or ".." on
624 * UNIX. If an error occurs, the contents of "filename" are
625 * undefined. The error is never set if the function succeeds.
627 * @param iter the iterator
628 * @param filename string to be set to the next file in the dir
629 * @param error return location for error
630 * @returns #TRUE if filename was filled in with a new filename
633 _dbus_directory_get_next_file (DBusDirIter *iter,
634 DBusString *filename,
637 struct dirent *d, *ent;
641 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
643 if (!dirent_buf_size (iter->d, &buf_size))
645 dbus_set_error (error, DBUS_ERROR_FAILED,
646 "Can't calculate buffer size when reading directory");
650 d = (struct dirent *)dbus_malloc (buf_size);
653 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
654 "No memory to read directory entry");
659 err = readdir_r (iter->d, d, &ent);
663 dbus_set_error (error,
664 _dbus_error_from_errno (err),
665 "%s", _dbus_strerror (err));
670 else if (ent->d_name[0] == '.' &&
671 (ent->d_name[1] == '\0' ||
672 (ent->d_name[1] == '.' && ent->d_name[2] == '\0')))
676 _dbus_string_set_length (filename, 0);
677 if (!_dbus_string_append (filename, ent->d_name))
679 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
680 "No memory to read directory entry");
693 * Closes a directory iteration.
696 _dbus_directory_close (DBusDirIter *iter)
703 fill_user_info_from_group (struct group *g,
707 _dbus_assert (g->gr_name != NULL);
709 info->gid = g->gr_gid;
710 info->groupname = _dbus_strdup (g->gr_name);
712 /* info->members = dbus_strdupv (g->gr_mem) */
714 if (info->groupname == NULL)
716 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
724 fill_group_info (DBusGroupInfo *info,
726 const DBusString *groupname,
729 const char *group_c_str;
731 _dbus_assert (groupname != NULL || gid != DBUS_GID_UNSET);
732 _dbus_assert (groupname == NULL || gid == DBUS_GID_UNSET);
735 group_c_str = _dbus_string_get_const_data (groupname);
739 /* For now assuming that the getgrnam() and getgrgid() flavors
740 * always correspond to the pwnam flavors, if not we have
741 * to add more configure checks.
744 #if defined (HAVE_POSIX_GETPWNAM_R) || defined (HAVE_NONPOSIX_GETPWNAM_R)
753 /* retrieve maximum needed size for buf */
754 buflen = sysconf (_SC_GETGR_R_SIZE_MAX);
756 /* sysconf actually returns a long, but everything else expects size_t,
757 * so just recast here.
758 * https://bugs.freedesktop.org/show_bug.cgi?id=17061
760 if ((long) buflen <= 0)
766 buf = dbus_malloc (buflen);
769 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
774 #ifdef HAVE_POSIX_GETPWNAM_R
776 result = getgrnam_r (group_c_str, &g_str, buf, buflen,
779 result = getgrgid_r (gid, &g_str, buf, buflen,
782 g = getgrnam_r (group_c_str, &g_str, buf, buflen);
784 #endif /* !HAVE_POSIX_GETPWNAM_R */
785 /* Try a bigger buffer if ERANGE was returned:
786 https://bugs.freedesktop.org/show_bug.cgi?id=16727
788 if (result == ERANGE && buflen < 512 * 1024)
799 if (result == 0 && g == &g_str)
801 b = fill_user_info_from_group (g, info, error);
807 dbus_set_error (error, _dbus_error_from_errno (errno),
808 "Group %s unknown or failed to look it up\n",
809 group_c_str ? group_c_str : "???");
814 #else /* ! HAVE_GETPWNAM_R */
816 /* I guess we're screwed on thread safety here */
819 g = getgrnam (group_c_str);
823 return fill_user_info_from_group (g, info, error);
827 dbus_set_error (error, _dbus_error_from_errno (errno),
828 "Group %s unknown or failed to look it up\n",
829 group_c_str ? group_c_str : "???");
833 #endif /* ! HAVE_GETPWNAM_R */
837 * Initializes the given DBusGroupInfo struct
838 * with information about the given group name.
840 * @param info the group info struct
841 * @param groupname name of group
842 * @param error the error return
843 * @returns #FALSE if error is set
846 _dbus_group_info_fill (DBusGroupInfo *info,
847 const DBusString *groupname,
850 return fill_group_info (info, DBUS_GID_UNSET,
856 * Initializes the given DBusGroupInfo struct
857 * with information about the given group ID.
859 * @param info the group info struct
860 * @param gid group ID
861 * @param error the error return
862 * @returns #FALSE if error is set
865 _dbus_group_info_fill_gid (DBusGroupInfo *info,
869 return fill_group_info (info, gid, NULL, error);
873 * Parse a UNIX user from the bus config file. On Windows, this should
874 * simply always fail (just return #FALSE).
876 * @param username the username text
877 * @param uid_p place to return the uid
878 * @returns #TRUE on success
881 _dbus_parse_unix_user_from_config (const DBusString *username,
884 return _dbus_get_user_id (username, uid_p);
889 * Parse a UNIX group from the bus config file. On Windows, this should
890 * simply always fail (just return #FALSE).
892 * @param groupname the groupname text
893 * @param gid_p place to return the gid
894 * @returns #TRUE on success
897 _dbus_parse_unix_group_from_config (const DBusString *groupname,
900 return _dbus_get_group_id (groupname, gid_p);
904 * Gets all groups corresponding to the given UNIX user ID. On UNIX,
905 * just calls _dbus_groups_from_uid(). On Windows, should always
906 * fail since we don't know any UNIX groups.
909 * @param group_ids return location for array of group IDs
910 * @param n_group_ids return location for length of returned array
911 * @returns #TRUE if the UID existed and we got some credentials
914 _dbus_unix_groups_from_uid (dbus_uid_t uid,
915 dbus_gid_t **group_ids,
918 return _dbus_groups_from_uid (uid, group_ids, n_group_ids);
922 * Checks to see if the UNIX user ID is at the console.
923 * Should always fail on Windows (set the error to
924 * #DBUS_ERROR_NOT_SUPPORTED).
926 * @param uid UID of person to check
927 * @param error return location for errors
928 * @returns #TRUE if the UID is the same as the console user and there are no errors
931 _dbus_unix_user_is_at_console (dbus_uid_t uid,
934 return _dbus_is_console_user (uid, error);
939 * Checks to see if the UNIX user ID matches the UID of
940 * the process. Should always return #FALSE on Windows.
942 * @param uid the UNIX user ID
943 * @returns #TRUE if this uid owns the process.
946 _dbus_unix_user_is_process_owner (dbus_uid_t uid)
948 return uid == _dbus_geteuid ();
952 * Checks to see if the Windows user SID matches the owner of
953 * the process. Should always return #FALSE on UNIX.
955 * @param windows_sid the Windows user SID
956 * @returns #TRUE if this user owns the process.
959 _dbus_windows_user_is_process_owner (const char *windows_sid)
964 /** @} */ /* End of DBusInternalsUtils functions */
967 * @addtogroup DBusString
972 * Get the directory name from a complete filename
973 * @param filename the filename
974 * @param dirname string to append directory name to
975 * @returns #FALSE if no memory
978 _dbus_string_get_dirname (const DBusString *filename,
983 _dbus_assert (filename != dirname);
984 _dbus_assert (filename != NULL);
985 _dbus_assert (dirname != NULL);
987 /* Ignore any separators on the end */
988 sep = _dbus_string_get_length (filename);
990 return _dbus_string_append (dirname, "."); /* empty string passed in */
992 while (sep > 0 && _dbus_string_get_byte (filename, sep - 1) == '/')
995 _dbus_assert (sep >= 0);
998 return _dbus_string_append (dirname, "/");
1000 /* Now find the previous separator */
1001 _dbus_string_find_byte_backward (filename, sep, '/', &sep);
1003 return _dbus_string_append (dirname, ".");
1005 /* skip multiple separators */
1006 while (sep > 0 && _dbus_string_get_byte (filename, sep - 1) == '/')
1009 _dbus_assert (sep >= 0);
1012 _dbus_string_get_byte (filename, 0) == '/')
1013 return _dbus_string_append (dirname, "/");
1015 return _dbus_string_copy_len (filename, 0, sep - 0,
1016 dirname, _dbus_string_get_length (dirname));
1018 /** @} */ /* DBusString stuff */
1021 string_squash_nonprintable (DBusString *str)
1026 buf = _dbus_string_get_data (str);
1027 len = _dbus_string_get_length (str);
1029 for (i = 0; i < len; i++)
1031 unsigned char c = (unsigned char) buf[i];
1034 else if (c < 0x20 || c > 127)
1040 * Get a printable string describing the command used to execute
1041 * the process with pid. This string should only be used for
1042 * informative purposes such as logging; it may not be trusted.
1044 * The command is guaranteed to be printable ASCII and no longer
1047 * @param pid Process id
1048 * @param str Append command to this string
1049 * @param max_len Maximum length of returned command
1050 * @param error return location for errors
1051 * @returns #FALSE on error
1054 _dbus_command_for_pid (unsigned long pid,
1059 /* This is all Linux-specific for now */
1064 if (!_dbus_string_init (&path))
1066 _DBUS_SET_OOM (error);
1070 if (!_dbus_string_init (&cmdline))
1072 _DBUS_SET_OOM (error);
1073 _dbus_string_free (&path);
1077 if (!_dbus_string_append_printf (&path, "/proc/%ld/cmdline", pid))
1080 fd = open (_dbus_string_get_const_data (&path), O_RDONLY);
1083 dbus_set_error (error,
1084 _dbus_error_from_errno (errno),
1085 "Failed to open \"%s\": %s",
1086 _dbus_string_get_const_data (&path),
1087 _dbus_strerror (errno));
1091 if (!_dbus_read (fd, &cmdline, max_len))
1093 dbus_set_error (error,
1094 _dbus_error_from_errno (errno),
1095 "Failed to read from \"%s\": %s",
1096 _dbus_string_get_const_data (&path),
1097 _dbus_strerror (errno));
1101 if (!_dbus_close (fd, error))
1104 string_squash_nonprintable (&cmdline);
1106 if (!_dbus_string_copy (&cmdline, 0, str, _dbus_string_get_length (str)))
1109 _dbus_string_free (&cmdline);
1110 _dbus_string_free (&path);
1113 _DBUS_SET_OOM (error);
1115 _dbus_string_free (&cmdline);
1116 _dbus_string_free (&path);