2 This file is part of GNUnet.
3 (C) 2006 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)
48 * Try to determine path by reading /proc/PID/exe
50 * @return NULL on error
53 get_path_from_proc_maps ()
61 GNUNET_snprintf (fn, sizeof (fn), "/proc/%u/maps", getpid ());
62 if (NULL == (f = FOPEN (fn, "r")))
64 while (NULL != fgets (line, sizeof (line), f))
67 SSCANF (line, "%*x-%*x %*c%*c%*c%*c %*x %*2u:%*2u %*u%*[ ]%1023s", dir)) &&
68 (NULL != (lgu = strstr (dir, "libgnunetutil"))))
72 return GNUNET_strdup (dir);
81 * Try to determine path by reading /proc/PID/exe
83 * @return NULL on error
86 get_path_from_proc_exe ()
92 GNUNET_snprintf (fn, sizeof (fn), "/proc/%u/exe", getpid ());
93 size = readlink (fn, lnk, sizeof (lnk) - 1);
96 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "readlink", fn);
99 GNUNET_assert (size < sizeof (lnk));
101 while ((lnk[size] != '/') && (size > 0))
103 /* test for being in lib/gnunet/libexec/ */
104 if ( (size > strlen ("/gnunet/libexec/")) &&
105 (0 == strcmp ("/gnunet/libexec/",
106 &lnk[size - strlen ("/gnunet/libexec/")])) )
107 size -= strlen ("gnunet/libexec/");
108 if ((size < 4) || (lnk[size - 4] != '/'))
110 /* not installed in "/bin/" -- binary path probably useless */
114 return GNUNET_strdup (lnk);
120 static HINSTANCE dll_instance;
123 /* GNUNET_util_cl_init() in common_logging.c is preferred.
124 * This function is only for thread-local storage (not used in GNUnet)
125 * and hInstance saving.
128 DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
132 case DLL_PROCESS_ATTACH:
133 dll_instance = hinstDLL;
135 case DLL_THREAD_ATTACH:
137 case DLL_THREAD_DETACH:
139 case DLL_PROCESS_DETACH:
147 * Try to determine path with win32-specific function
149 * @return NULL on error
152 get_path_from_module_filename ()
154 size_t pathlen = 512;
157 wchar_t *modulepath = NULL;
160 size_t u8_string_length;
162 /* This braindead function won't tell us how much space it needs, so
163 * we start at 1024 and double the space up if it doesn't fit, until
164 * it fits, or we exceed the threshold.
168 pathlen = pathlen * 2;
169 modulepath = GNUNET_realloc (modulepath, pathlen * sizeof (wchar_t));
171 real_pathlen = GetModuleFileNameW (dll_instance, modulepath, pathlen * sizeof (wchar_t));
172 } while (real_pathlen >= pathlen && pathlen < 16*1024);
173 if (real_pathlen >= pathlen)
176 modulepath[real_pathlen] = '\0';
178 idx = modulepath + real_pathlen;
179 while ((idx > modulepath) && (*idx != L'\\') && (*idx != L'/'))
183 /* Now modulepath holds full path to the directory where libgnunetutil is.
184 * This directory should look like <GNUNET_PREFIX>/bin or <GNUNET_PREFIX>.
186 if (wcschr (modulepath, L'/') || wcschr (modulepath, L'\\'))
188 /* At least one directory component (i.e. we're not in a root directory) */
189 wchar_t *dirname = idx;
190 while ((dirname > modulepath) && (*dirname != L'\\') && (*dirname != L'/'))
193 if (dirname > modulepath)
196 /* Now modulepath holds full path to the parent directory of the directory
197 * where libgnunetutil is.
198 * dirname holds the name of the directory where libgnunetutil is.
200 if (wcsicmp (dirname, L"bin") == 0)
206 /* Roll back our changes to modulepath */
213 /* modulepath is GNUNET_PREFIX */
214 u8_string = u16_to_u8 (modulepath, wcslen (modulepath), NULL, &u8_string_length);
215 if (NULL == u8_string)
218 upath = GNUNET_malloc (u8_string_length + 1);
219 memcpy (upath, u8_string, u8_string_length);
220 upath[u8_string_length] = '\0';
223 GNUNET_free (modulepath);
231 * Signature of the '_NSGetExecutablePath" function.
233 * @param buf where to write the path
234 * @param number of bytes available in 'buf'
235 * @return 0 on success, otherwise desired number of bytes is stored in 'bufsize'
237 typedef int (*MyNSGetExecutablePathProto) (char *buf, size_t * bufsize);
241 * Try to obtain the path of our executable using '_NSGetExecutablePath'.
243 * @return NULL on error
246 get_path_from_NSGetExecutablePath ()
248 static char zero = '\0';
251 MyNSGetExecutablePathProto func;
255 (MyNSGetExecutablePathProto) dlsym (RTLD_DEFAULT, "_NSGetExecutablePath")))
259 /* get the path len, including the trailing \0 */
260 (void) func (path, &len);
263 path = GNUNET_malloc (len);
264 if (0 != func (path, &len))
270 while ((path[len] != '/') && (len > 0))
278 * Try to obtain the path of our executable using '_dyld_image' API.
280 * @return NULL on error
283 get_path_from_dyld_image ()
291 c = _dyld_image_count ();
292 for (i = 0; i < c; i++)
294 if (((const void *) _dyld_get_image_header (i)) != (const void *)&_mh_dylib_header)
296 path = _dyld_get_image_name (i);
297 if ( (NULL == path) || (0 == strlen (path)) )
299 p = GNUNET_strdup (path);
301 while ((s > p) && ('/' != *s))
313 * Return the actual path to a file found in the current
314 * PATH environment variable.
316 * @param binary the name of the file to find
317 * @return path to binary, NULL if not found
320 get_path_from_PATH (const char *binary)
328 if (NULL == (p = getenv ("PATH")))
331 /* On W32 look in CWD first. */
332 GNUNET_asprintf (&path, ".%c%s", PATH_SEPARATOR, p);
334 path = GNUNET_strdup (p); /* because we write on it */
336 buf = GNUNET_malloc (strlen (path) + strlen (binary) + 1 + 1);
338 while (NULL != (end = strchr (pos, PATH_SEPARATOR)))
341 sprintf (buf, "%s/%s", pos, binary);
342 if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
344 pos = GNUNET_strdup (pos);
351 sprintf (buf, "%s/%s", pos, binary);
352 if (GNUNET_YES == GNUNET_DISK_file_test (buf))
354 pos = GNUNET_strdup (pos);
366 * Try to obtain the installation path using the "GNUNET_PREFIX" environment
369 * @return NULL on error (environment variable not set)
372 get_path_from_GNUNET_PREFIX ()
376 if (NULL != (p = getenv ("GNUNET_PREFIX")))
377 return GNUNET_strdup (p);
383 * @brief get the path to GNUnet bin/ or lib/, prefering the lib/ path
386 * @return a pointer to the executable path, or NULL on error
389 os_get_gnunet_path ()
393 if (NULL != (ret = get_path_from_GNUNET_PREFIX ()))
396 if (NULL != (ret = get_path_from_proc_maps ()))
398 /* try path *first*, before /proc/exe, as /proc/exe can be wrong */
399 if (NULL != (ret = get_path_from_PATH ("gnunet-arm")))
401 if (NULL != (ret = get_path_from_proc_exe ()))
405 if (NULL != (ret = get_path_from_module_filename ()))
409 if (NULL != (ret = get_path_from_dyld_image ()))
411 if (NULL != (ret = get_path_from_NSGetExecutablePath ()))
414 if (NULL != (ret = get_path_from_PATH ("gnunet-arm")))
416 /* other attempts here */
417 LOG (GNUNET_ERROR_TYPE_ERROR,
419 ("Could not determine installation path for %s. Set `%s' environment variable.\n"),
420 "GNUnet", "GNUNET_PREFIX");
426 * @brief get the path to current app's bin/
429 * @return a pointer to the executable path, or NULL on error
437 if (NULL != (ret = get_path_from_proc_exe ()))
441 if (NULL != (ret = get_path_from_module_filename ()))
445 if (NULL != (ret = get_path_from_NSGetExecutablePath ()))
448 /* other attempts here */
454 * @brief get the path to a specific GNUnet installation directory or,
455 * with GNUNET_IPK_SELF_PREFIX, the current running apps installation directory
457 * @return a pointer to the dir path (to be freed by the caller)
460 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind)
464 char *execpath = NULL;
468 /* if wanted, try to get the current app's bin/ */
469 if (dirkind == GNUNET_OS_IPK_SELF_PREFIX)
470 execpath = os_get_exec_path ();
472 /* try to get GNUnet's bin/ or lib/, or if previous was unsuccessful some
473 * guess for the current app */
474 if (NULL == execpath)
475 execpath = os_get_gnunet_path ();
477 if (NULL == execpath)
480 n = strlen (execpath);
483 /* should never happen, but better safe than sorry */
484 GNUNET_free (execpath);
487 /* remove filename itself */
488 while ((n > 1) && (DIR_SEPARATOR == execpath[n - 1]))
489 execpath[--n] = '\0';
493 ((0 == strcasecmp (&execpath[n - 6], "/lib32")) ||
494 (0 == strcasecmp (&execpath[n - 6], "/lib64"))))
496 if ( (GNUNET_OS_IPK_LIBDIR != dirkind) &&
497 (GNUNET_OS_IPK_LIBEXECDIR != dirkind) )
499 /* strip '/lib32' or '/lib64' */
500 execpath[n - 6] = '\0';
507 ((0 == strcasecmp (&execpath[n - 4], "/bin")) ||
508 (0 == strcasecmp (&execpath[n - 4], "/lib"))))
510 /* strip '/bin' or '/lib' */
511 execpath[n - 4] = '\0';
514 /* in case this was a directory named foo-bin, remove "foo-" */
515 while ((n > 1) && (execpath[n - 1] == DIR_SEPARATOR))
516 execpath[--n] = '\0';
519 case GNUNET_OS_IPK_PREFIX:
520 case GNUNET_OS_IPK_SELF_PREFIX:
521 dirname = DIR_SEPARATOR_STR;
523 case GNUNET_OS_IPK_BINDIR:
524 dirname = DIR_SEPARATOR_STR "bin" DIR_SEPARATOR_STR;
526 case GNUNET_OS_IPK_LIBDIR:
530 DIR_SEPARATOR_STR "lib" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
531 tmp = GNUNET_malloc (strlen (execpath) + strlen (dirname) + 1);
532 sprintf (tmp, "%s%s", execpath, dirname);
534 GNUNET_DISK_directory_test (tmp, GNUNET_YES)) &&
535 (4 == sizeof (void *)) )
539 DIR_SEPARATOR_STR "lib32" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
540 tmp = GNUNET_malloc (strlen (execpath) + strlen (dirname) + 1);
541 sprintf (tmp, "%s%s", execpath, dirname);
544 GNUNET_DISK_directory_test (tmp, GNUNET_YES)) &&
545 (8 == sizeof (void *)) )
548 DIR_SEPARATOR_STR "lib64" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
553 dirname = DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
555 case GNUNET_OS_IPK_DATADIR:
557 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR;
559 case GNUNET_OS_IPK_LOCALEDIR:
561 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "locale" DIR_SEPARATOR_STR;
563 case GNUNET_OS_IPK_ICONDIR:
565 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "icons" DIR_SEPARATOR_STR;
567 case GNUNET_OS_IPK_DOCDIR:
569 DIR_SEPARATOR_STR "share" DIR_SEPARATOR_STR "doc" DIR_SEPARATOR_STR \
570 "gnunet" DIR_SEPARATOR_STR;
572 case GNUNET_OS_IPK_LIBEXECDIR:
576 DIR_SEPARATOR_STR "lib" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
577 "libexec" DIR_SEPARATOR_STR;
578 tmp = GNUNET_malloc (strlen (execpath) + strlen (dirname) + 1);
579 sprintf (tmp, "%s%s", execpath, dirname);
581 GNUNET_DISK_directory_test (tmp, GNUNET_YES)) &&
582 (4 == sizeof (void *)) )
586 DIR_SEPARATOR_STR "lib32" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
587 "libexec" DIR_SEPARATOR_STR;
588 tmp = GNUNET_malloc (strlen (execpath) + strlen (dirname) + 1);
589 sprintf (tmp, "%s%s", execpath, dirname);
592 GNUNET_DISK_directory_test (tmp, GNUNET_YES)) &&
593 (8 == sizeof (void *)) )
596 DIR_SEPARATOR_STR "lib64" DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
597 "libexec" DIR_SEPARATOR_STR;
603 DIR_SEPARATOR_STR "gnunet" DIR_SEPARATOR_STR \
604 "libexec" DIR_SEPARATOR_STR;
607 GNUNET_free (execpath);
610 tmp = GNUNET_malloc (strlen (execpath) + strlen (dirname) + 1);
611 sprintf (tmp, "%s%s", execpath, dirname);
612 GNUNET_free (execpath);
618 * Given the name of a gnunet-helper, gnunet-service or gnunet-daemon
619 * binary, try to prefix it with the libexec/-directory to get the
622 * @param progname name of the binary
623 * @return full path to the binary, if possible, otherwise copy of 'progname'
626 GNUNET_OS_get_libexec_binary_path (const char *progname)
631 if (DIR_SEPARATOR == progname[0])
632 return GNUNET_strdup (progname);
633 if (GNUNET_YES == GNUNET_STRINGS_path_is_absolute (progname, GNUNET_NO, NULL, NULL))
634 return GNUNET_strdup (progname);
635 libexecdir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LIBEXECDIR);
636 if (NULL == libexecdir)
637 return GNUNET_strdup (progname);
638 GNUNET_asprintf (&binary,
642 GNUNET_free (libexecdir);
648 * Check whether an executable exists and possibly
649 * if the suid bit is set on the file.
650 * Attempts to find the file using the current
651 * PATH environment variable as a search path.
653 * @param binary the name of the file to check.
654 * W32: must not have an .exe suffix.
655 * @param check_suid input true if the binary should be checked for SUID (*nix)
656 * W32: checks if the program has sufficient privileges by executing this
657 * binary with the -d flag. -d omits a programs main loop and only
658 * executes all privileged operations in an binary.
659 * @param params parameters used for w32 privilege checking (can be NULL for != w32 )
660 * @return GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32),
661 * GNUNET_NO if not SUID (but binary exists),
662 * GNUNET_SYSERR on error (no such binary or not executable)
665 GNUNET_OS_check_helper_binary (const char *binary, int check_suid, const char *params)
673 GNUNET_asprintf (&binaryexe, "%s.exe", binary);
674 if ( (GNUNET_YES == GNUNET_STRINGS_path_is_absolute (binaryexe, GNUNET_NO,
676 (0 == strncmp (binary, "./", 2)) )
677 p = GNUNET_strdup (binaryexe);
680 p = get_path_from_PATH (binaryexe);
683 GNUNET_asprintf (&pf, "%s/%s", p, binaryexe);
688 GNUNET_free (binaryexe);
690 if ( (GNUNET_YES == GNUNET_STRINGS_path_is_absolute (binary, GNUNET_NO,
692 (0 == strncmp (binary, "./", 2)) )
693 p = GNUNET_strdup (binary);
696 p = get_path_from_PATH (binary);
699 GNUNET_asprintf (&pf, "%s/%s", p, binary);
707 LOG (GNUNET_ERROR_TYPE_INFO, _("Could not find binary `%s' in PATH!\n"),
709 return GNUNET_SYSERR;
711 if (0 != ACCESS (p, X_OK))
713 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "access", p);
715 return GNUNET_SYSERR;
720 /* as we run as root, we don't insist on SUID */
725 if (0 != STAT (p, &statbuf))
727 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", p);
729 return GNUNET_SYSERR;
733 if ((0 != (statbuf.st_mode & S_ISUID)) && (0 == statbuf.st_uid))
738 /* binary exists, but not SUID */
741 char parameters[512];
742 PROCESS_INFORMATION proc;
745 GNUNET_snprintf (parameters,
748 memset (&start, 0, sizeof (start));
749 start.cb = sizeof (start);
750 memset (&proc, 0, sizeof (proc));
753 // Start the child process.
754 if ( ! (CreateProcess( p, // current windows (2k3 and up can handle / instead of \ in paths))
755 parameters, // execute dryrun/priviliege checking mode
756 NULL, // Process handle not inheritable
757 NULL, // Thread handle not inheritable
758 FALSE, // Set handle inheritance to FALSE
759 CREATE_DEFAULT_ERROR_MODE, // No creation flags
760 NULL, // Use parent's environment block
761 NULL, // Use parent's starting directory
762 &start, // Pointer to STARTUPINFO structure
763 &proc ) // Pointer to PROCESS_INFORMATION structure
766 LOG (GNUNET_ERROR_TYPE_ERROR,
767 _("CreateProcess failed for binary %s (%d).\n"),
769 return GNUNET_SYSERR;
772 // Wait until child process exits.
773 WaitForSingleObject( proc.hProcess, INFINITE );
775 if ( ! GetExitCodeProcess (proc.hProcess, &exit_value)){
776 LOG (GNUNET_ERROR_TYPE_ERROR,
777 _("GetExitCodeProcess failed for binary %s (%d).\n"),
779 return GNUNET_SYSERR;
781 // Close process and thread handles.
782 CloseHandle( proc.hProcess );
783 CloseHandle( proc.hThread );
794 /* end of os_installation.c */