2 This file is part of GNUnet.
3 (C) 2006-2014 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file src/util/os_installation.c
23 * @brief get paths used by the program
30 #include <unistr.h> /* for u16_to_u8 */
33 #include "gnunet_util_lib.h"
35 #include <mach-o/ldsyms.h>
36 #include <mach-o/dyld.h>
42 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
44 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
49 * Try to determine path by reading /proc/PID/exe
51 * @return NULL on error
54 get_path_from_proc_maps ()
62 GNUNET_snprintf (fn, sizeof (fn), "/proc/%u/maps", getpid ());
63 if (NULL == (f = FOPEN (fn, "r")))
65 while (NULL != fgets (line, sizeof (line), f))
68 SSCANF (line, "%*x-%*x %*c%*c%*c%*c %*x %*2x:%*2x %*u%*[ ]%1023s", dir)) &&
69 (NULL != (lgu = strstr (dir, "libgnunetutil"))))
73 return GNUNET_strdup (dir);
82 * Try to determine path by reading /proc/PID/exe
84 * @return NULL on error
87 get_path_from_proc_exe ()
93 GNUNET_snprintf (fn, sizeof (fn), "/proc/%u/exe", getpid ());
94 size = readlink (fn, lnk, sizeof (lnk) - 1);
97 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "readlink", fn);
100 GNUNET_assert (size < sizeof (lnk));
102 while ((lnk[size] != '/') && (size > 0))
104 /* test for being in lib/gnunet/libexec/ or lib/MULTIARCH/gnunet/libexec */
105 if ( (size > strlen ("/gnunet/libexec/")) &&
106 (0 == strcmp ("/gnunet/libexec/",
107 &lnk[size - strlen ("/gnunet/libexec/")])) )
108 size -= strlen ("gnunet/libexec/");
109 if ((size < 4) || (lnk[size - 4] != '/'))
111 /* not installed in "/bin/" -- binary path probably useless */
115 return GNUNET_strdup (lnk);
121 static HINSTANCE dll_instance;
125 * GNUNET_util_cl_init() in common_logging.c is preferred.
126 * This function is only for thread-local storage (not used in GNUnet)
127 * and hInstance saving.
130 DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
134 case DLL_PROCESS_ATTACH:
135 dll_instance = hinstDLL;
137 case DLL_THREAD_ATTACH:
139 case DLL_THREAD_DETACH:
141 case DLL_PROCESS_DETACH:
149 * Try to determine path with win32-specific function
151 * @return NULL on error
154 get_path_from_module_filename ()
156 size_t pathlen = 512;
159 wchar_t *modulepath = NULL;
162 size_t u8_string_length;
164 /* This braindead function won't tell us how much space it needs, so
165 * we start at 1024 and double the space up if it doesn't fit, until
166 * it fits, or we exceed the threshold.
170 pathlen = pathlen * 2;
171 modulepath = GNUNET_realloc (modulepath, pathlen * sizeof (wchar_t));
173 real_pathlen = GetModuleFileNameW (dll_instance, modulepath, pathlen * sizeof (wchar_t));
174 } while (real_pathlen >= pathlen && pathlen < 16*1024);
175 if (real_pathlen >= pathlen)
178 modulepath[real_pathlen] = '\0';
180 idx = modulepath + real_pathlen;
181 while ((idx > modulepath) && (*idx != L'\\') && (*idx != L'/'))
185 /* Now modulepath holds full path to the directory where libgnunetutil is.
186 * This directory should look like <GNUNET_PREFIX>/bin or <GNUNET_PREFIX>.
188 if (wcschr (modulepath, L'/') || wcschr (modulepath, L'\\'))
190 /* At least one directory component (i.e. we're not in a root directory) */
191 wchar_t *dirname = idx;
192 while ((dirname > modulepath) && (*dirname != L'\\') && (*dirname != L'/'))
195 if (dirname > modulepath)
198 /* Now modulepath holds full path to the parent directory of the directory
199 * where libgnunetutil is.
200 * dirname holds the name of the directory where libgnunetutil is.
202 if (wcsicmp (dirname, L"bin") == 0)
208 /* Roll back our changes to modulepath */
215 /* modulepath is GNUNET_PREFIX */
216 u8_string = u16_to_u8 (modulepath, wcslen (modulepath), NULL, &u8_string_length);
217 if (NULL == u8_string)
220 upath = GNUNET_malloc (u8_string_length + 1);
221 memcpy (upath, u8_string, u8_string_length);
222 upath[u8_string_length] = '\0';
225 GNUNET_free (modulepath);
234 * Signature of the '_NSGetExecutablePath" function.
236 * @param buf where to write the path
237 * @param number of bytes available in 'buf'
238 * @return 0 on success, otherwise desired number of bytes is stored in 'bufsize'
240 typedef int (*MyNSGetExecutablePathProto) (char *buf, size_t * bufsize);
244 * Try to obtain the path of our executable using '_NSGetExecutablePath'.
246 * @return NULL on error
249 get_path_from_NSGetExecutablePath ()
251 static char zero = '\0';
254 MyNSGetExecutablePathProto func;
258 (MyNSGetExecutablePathProto) dlsym (RTLD_DEFAULT, "_NSGetExecutablePath")))
262 /* get the path len, including the trailing \0 */
263 (void) func (path, &len);
266 path = GNUNET_malloc (len);
267 if (0 != func (path, &len))
273 while ((path[len] != '/') && (len > 0))
281 * Try to obtain the path of our executable using '_dyld_image' API.
283 * @return NULL on error
286 get_path_from_dyld_image ()
294 c = _dyld_image_count ();
295 for (i = 0; i < c; i++)
297 if (((const void *) _dyld_get_image_header (i)) != (const void *)&_mh_dylib_header)
299 path = _dyld_get_image_name (i);
300 if ( (NULL == path) || (0 == strlen (path)) )
302 p = GNUNET_strdup (path);
304 while ((s > p) && ('/' != *s))
316 * Return the actual path to a file found in the current
317 * PATH environment variable.
319 * @param binary the name of the file to find
320 * @return path to binary, NULL if not found
323 get_path_from_PATH (const char *binary)
331 if (NULL == (p = getenv ("PATH")))
334 /* On W32 look in CWD first. */
335 GNUNET_asprintf (&path, ".%c%s", PATH_SEPARATOR, p);
337 path = GNUNET_strdup (p); /* because we write on it */
339 buf = GNUNET_malloc (strlen (path) + strlen (binary) + 1 + 1);
341 while (NULL != (end = strchr (pos, PATH_SEPARATOR)))
344 sprintf (buf, "%s/%s", pos, binary);
345 if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
347 pos = GNUNET_strdup (pos);
354 sprintf (buf, "%s/%s", pos, binary);
355 if (GNUNET_YES == GNUNET_DISK_file_test (buf))
357 pos = GNUNET_strdup (pos);
369 * Try to obtain the installation path using the "GNUNET_PREFIX" environment
372 * @return NULL on error (environment variable not set)
375 get_path_from_GNUNET_PREFIX ()
379 if (NULL != (p = getenv ("GNUNET_PREFIX")))
380 return GNUNET_strdup (p);
386 * @brief get the path to GNUnet bin/ or lib/, prefering the lib/ path
389 * @return a pointer to the executable path, or NULL on error
392 os_get_gnunet_path ()
396 if (NULL != (ret = get_path_from_GNUNET_PREFIX ()))
399 if (NULL != (ret = get_path_from_proc_maps ()))
401 /* try path *first*, before /proc/exe, as /proc/exe can be wrong */
402 if (NULL != (ret = get_path_from_PATH ("gnunet-arm")))
404 if (NULL != (ret = get_path_from_proc_exe ()))
408 if (NULL != (ret = get_path_from_module_filename ()))
412 if (NULL != (ret = get_path_from_dyld_image ()))
414 if (NULL != (ret = get_path_from_NSGetExecutablePath ()))
417 if (NULL != (ret = get_path_from_PATH ("gnunet-arm")))
419 /* other attempts here */
420 LOG (GNUNET_ERROR_TYPE_ERROR,
421 _("Could not determine installation path for %s. Set `%s' environment variable.\n"),
422 "GNUnet", "GNUNET_PREFIX");
428 * @brief get the path to current app's bin/
431 * @return a pointer to the executable path, or NULL on error
439 if (NULL != (ret = get_path_from_proc_exe ()))
443 if (NULL != (ret = get_path_from_module_filename ()))
447 if (NULL != (ret = get_path_from_NSGetExecutablePath ()))
450 /* other attempts here */
456 * @brief get the path to a specific GNUnet installation directory or,
457 * with #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation directory
459 * @return a pointer to the dir path (to be freed by the caller)
462 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind)
466 char *execpath = NULL;
472 /* if wanted, try to get the current app's bin/ */
473 if (dirkind == GNUNET_OS_IPK_SELF_PREFIX)
474 execpath = os_get_exec_path ();
476 /* try to get GNUnet's bin/ or lib/, or if previous was unsuccessful some
477 * guess for the current app */
478 if (NULL == execpath)
479 execpath = os_get_gnunet_path ();
481 if (NULL == execpath)
484 n = strlen (execpath);
487 /* should never happen, but better safe than sorry */
488 GNUNET_free (execpath);
491 /* remove filename itself */
492 while ((n > 1) && (DIR_SEPARATOR == execpath[n - 1]))
493 execpath[--n] = '\0';
497 ((0 == strcasecmp (&execpath[n - 6], "/lib32")) ||
498 (0 == strcasecmp (&execpath[n - 6], "/lib64"))))
500 if ( (GNUNET_OS_IPK_LIBDIR != dirkind) &&
501 (GNUNET_OS_IPK_LIBEXECDIR != dirkind) )
503 /* strip '/lib32' or '/lib64' */
504 execpath[n - 6] = '\0';
511 ((0 == strcasecmp (&execpath[n - 4], "/bin")) ||
512 (0 == strcasecmp (&execpath[n - 4], "/lib"))))
514 /* strip '/bin' or '/lib' */
515 execpath[n - 4] = '\0';
519 if (NULL != (libdir = strstr (execpath, "/lib/")))
521 /* test for multi-arch path of the form "PREFIX/lib/MULTIARCH/";
522 here we need to re-add 'multiarch' to lib and libexec paths later! */
523 multiarch = &libdir[5];
524 if (NULL == strchr (multiarch, '/'))
525 libdir[0] = '\0'; /* Debian multiarch format, cut of from 'execpath' but preserve in multicarch */
527 multiarch = NULL; /* maybe not, multiarch still has a '/', which is not OK */
529 /* in case this was a directory named foo-bin, remove "foo-" */
530 while ((n > 1) && (execpath[n - 1] == DIR_SEPARATOR))
531 execpath[--n] = '\0';
534 case GNUNET_OS_IPK_PREFIX:
535 case GNUNET_OS_IPK_SELF_PREFIX:
536 dirname = DIR_SEPARATOR_STR;
538 case GNUNET_OS_IPK_BINDIR:
539 dirname = DIR_SEPARATOR_STR "bin" DIR_SEPARATOR_STR;
541 case GNUNET_OS_IPK_LIBDIR:
544 GNUNET_asprintf (&tmp,
547 DIR_SEPARATOR_STR "lib",
548 (NULL != multiarch) ? DIR_SEPARATOR_STR : "",
549 (NULL != multiarch) ? multiarch : "",
550 DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR);
552 GNUNET_DISK_directory_test (tmp, GNUNET_YES))
554 GNUNET_free (execpath);
559 if (4 == sizeof (void *))
562 DIR_SEPARATOR_STR "lib32" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
563 GNUNET_asprintf (&tmp,
568 if (8 == sizeof (void *))
571 DIR_SEPARATOR_STR "lib64" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
572 GNUNET_asprintf (&tmp,
578 if ( (NULL != tmp) &&
580 GNUNET_DISK_directory_test (tmp, GNUNET_YES)) )
582 GNUNET_free (execpath);
587 dirname = DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
589 case GNUNET_OS_IPK_DATADIR:
591 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
593 case GNUNET_OS_IPK_LOCALEDIR:
595 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "locale" DIR_SEPARATOR_STR;
597 case GNUNET_OS_IPK_ICONDIR:
599 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "icons" DIR_SEPARATOR_STR;
601 case GNUNET_OS_IPK_DOCDIR:
603 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "doc" DIR_SEPARATOR_STR \
604 "gnunet" DIR_SEPARATOR_STR;
606 case GNUNET_OS_IPK_LIBEXECDIR:
610 DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR "libexec" DIR_SEPARATOR_STR;
611 GNUNET_asprintf (&tmp,
614 DIR_SEPARATOR_STR "lib" DIR_SEPARATOR_STR,
615 (NULL != multiarch) ? multiarch : "",
618 GNUNET_DISK_directory_test (tmp, GNUNET_YES))
620 GNUNET_free (execpath);
625 if (4 == sizeof (void *))
628 DIR_SEPARATOR_STR "lib32" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
629 "libexec" DIR_SEPARATOR_STR;
630 GNUNET_asprintf (&tmp,
635 if (8 == sizeof (void *))
638 DIR_SEPARATOR_STR "lib64" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
639 "libexec" DIR_SEPARATOR_STR;
640 GNUNET_asprintf (&tmp,
645 if ( (NULL != tmp) &&
647 GNUNET_DISK_directory_test (tmp, GNUNET_YES)) )
649 GNUNET_free (execpath);
656 DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
657 "libexec" DIR_SEPARATOR_STR;
660 GNUNET_free (execpath);
663 GNUNET_asprintf (&tmp,
667 GNUNET_free (execpath);
673 * Given the name of a gnunet-helper, gnunet-service or gnunet-daemon
674 * binary, try to prefix it with the libexec/-directory to get the
677 * @param progname name of the binary
678 * @return full path to the binary, if possible, otherwise copy of 'progname'
681 GNUNET_OS_get_libexec_binary_path (const char *progname)
687 if ( (DIR_SEPARATOR == progname[0]) ||
688 (GNUNET_YES == GNUNET_STRINGS_path_is_absolute (progname, GNUNET_NO, NULL, NULL)) )
689 return GNUNET_strdup (progname);
693 libexecdir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LIBEXECDIR);
694 if (NULL == libexecdir)
695 return GNUNET_strdup (progname);
696 GNUNET_asprintf (&binary,
706 * Check whether an executable exists and possibly
707 * if the suid bit is set on the file.
708 * Attempts to find the file using the current
709 * PATH environment variable as a search path.
711 * @param binary the name of the file to check.
712 * W32: must not have an .exe suffix.
713 * @param check_suid input true if the binary should be checked for SUID (*nix)
714 * W32: checks if the program has sufficient privileges by executing this
715 * binary with the -d flag. -d omits a programs main loop and only
716 * executes all privileged operations in an binary.
717 * @param params parameters used for w32 privilege checking (can be NULL for != w32 )
718 * @return #GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32),
719 * #GNUNET_NO if not SUID (but binary exists),
720 * #GNUNET_SYSERR on error (no such binary or not executable)
723 GNUNET_OS_check_helper_binary (const char *binary, int check_suid, const char *params)
731 GNUNET_asprintf (&binaryexe, "%s.exe", binary);
732 if ( (GNUNET_YES == GNUNET_STRINGS_path_is_absolute (binaryexe, GNUNET_NO,
734 (0 == strncmp (binary, "./", 2)) )
735 p = GNUNET_strdup (binaryexe);
738 p = get_path_from_PATH (binaryexe);
741 GNUNET_asprintf (&pf, "%s/%s", p, binaryexe);
746 GNUNET_free (binaryexe);
748 if ( (GNUNET_YES == GNUNET_STRINGS_path_is_absolute (binary, GNUNET_NO,
750 (0 == strncmp (binary, "./", 2)) )
751 p = GNUNET_strdup (binary);
754 p = get_path_from_PATH (binary);
757 GNUNET_asprintf (&pf, "%s/%s", p, binary);
765 LOG (GNUNET_ERROR_TYPE_INFO,
766 _("Could not find binary `%s' in PATH!\n"),
768 return GNUNET_SYSERR;
770 if (0 != ACCESS (p, X_OK))
772 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "access", p);
774 return GNUNET_SYSERR;
779 /* as we run as root, we don't insist on SUID */
784 if (0 != STAT (p, &statbuf))
786 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", p);
788 return GNUNET_SYSERR;
792 if ((0 != (statbuf.st_mode & S_ISUID)) && (0 == statbuf.st_uid))
797 /* binary exists, but not SUID */
800 char parameters[512];
801 PROCESS_INFORMATION proc;
804 GNUNET_snprintf (parameters,
807 memset (&start, 0, sizeof (start));
808 start.cb = sizeof (start);
809 memset (&proc, 0, sizeof (proc));
812 // Start the child process.
813 if ( ! (CreateProcess( p, // current windows (2k3 and up can handle / instead of \ in paths))
814 parameters, // execute dryrun/priviliege checking mode
815 NULL, // Process handle not inheritable
816 NULL, // Thread handle not inheritable
817 FALSE, // Set handle inheritance to FALSE
818 CREATE_DEFAULT_ERROR_MODE, // No creation flags
819 NULL, // Use parent's environment block
820 NULL, // Use parent's starting directory
821 &start, // Pointer to STARTUPINFO structure
822 &proc ) // Pointer to PROCESS_INFORMATION structure
825 LOG (GNUNET_ERROR_TYPE_ERROR,
826 _("CreateProcess failed for binary %s (%d).\n"),
828 return GNUNET_SYSERR;
831 // Wait until child process exits.
832 WaitForSingleObject( proc.hProcess, INFINITE );
834 if ( ! GetExitCodeProcess (proc.hProcess, &exit_value)){
835 LOG (GNUNET_ERROR_TYPE_ERROR,
836 _("GetExitCodeProcess failed for binary %s (%d).\n"),
838 return GNUNET_SYSERR;
840 // Close process and thread handles.
841 CloseHandle( proc.hProcess );
842 CloseHandle( proc.hThread );
853 /* end of os_installation.c */