diff --git a/common/exechelp-posix.c b/common/exechelp-posix.c index e3f8a15f4..0c09abbf4 100644 --- a/common/exechelp-posix.c +++ b/common/exechelp-posix.c @@ -1,1569 +1,1555 @@ /* exechelp.c - Fork and exec helpers for POSIX * Copyright (C) 2004, 2007-2009, 2010 Free Software Foundation, Inc. * Copyright (C) 2004, 2006-2012, 2014-2017 g10 Code GmbH * * This file is part of GnuPG. * * This file is free software; you can redistribute it and/or modify * it under the terms of either * * - the GNU Lesser General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at * your option) any later version. * * or * * - the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at * your option) any later version. * * or both in parallel, as here. * * This file is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . * SPDX-License-Identifier: (LGPL-3.0+ OR GPL-2.0+) */ #include #if defined(HAVE_W32_SYSTEM) #error This code is only used on POSIX #endif #include #include #include #include #include #include #ifdef HAVE_SIGNAL_H # include #endif #include #include #ifdef WITHOUT_NPTH /* Give the Makefile a chance to build without Pth. */ #undef HAVE_NPTH #undef USE_NPTH #endif #ifdef HAVE_NPTH #include #endif #include #ifdef HAVE_GETRLIMIT #include #include #endif /*HAVE_GETRLIMIT*/ #ifdef HAVE_STAT # include #endif #if __linux__ # include # include #endif /*__linux__ */ #include "util.h" #include "i18n.h" #include "sysutils.h" #include "exechelp.h" /* Helper */ static inline gpg_error_t my_error_from_syserror (void) { return gpg_err_make (default_errsource, gpg_err_code_from_syserror ()); } static inline gpg_error_t my_error (int errcode) { return gpg_err_make (default_errsource, errcode); } /* Return the maximum number of currently allowed open file descriptors. Only useful on POSIX systems but returns a value on other systems too. */ int get_max_fds (void) { int max_fds = -1; #ifdef HAVE_GETRLIMIT struct rlimit rl; /* Under Linux we can figure out the highest used file descriptor by * reading /proc/PID/fd. This is in the common cases much fast than * for example doing 4096 close calls where almost all of them will * fail. On a system with a limit of 4096 files and only 8 files * open with the highest number being 10, we speedup close_all_fds * from 125ms to 0.4ms including readdir. * * Another option would be to close the file descriptors as returned * from reading that directory - however then we need to snapshot * that list before starting to close them. */ #ifdef __linux__ { DIR *dir = NULL; struct dirent *dir_entry; const char *s; int x; dir = opendir ("/proc/self/fd"); if (dir) { while ((dir_entry = readdir (dir))) { s = dir_entry->d_name; if ( *s < '0' || *s > '9') continue; x = atoi (s); if (x > max_fds) max_fds = x; } closedir (dir); } if (max_fds != -1) return max_fds + 1; } #endif /* __linux__ */ # ifdef RLIMIT_NOFILE if (!getrlimit (RLIMIT_NOFILE, &rl)) max_fds = rl.rlim_max; # endif # ifdef RLIMIT_OFILE if (max_fds == -1 && !getrlimit (RLIMIT_OFILE, &rl)) max_fds = rl.rlim_max; # endif #endif /*HAVE_GETRLIMIT*/ #ifdef _SC_OPEN_MAX if (max_fds == -1) { long int scres = sysconf (_SC_OPEN_MAX); if (scres >= 0) max_fds = scres; } #endif #ifdef _POSIX_OPEN_MAX if (max_fds == -1) max_fds = _POSIX_OPEN_MAX; #endif #ifdef OPEN_MAX if (max_fds == -1) max_fds = OPEN_MAX; #endif if (max_fds == -1) max_fds = 256; /* Arbitrary limit. */ /* AIX returns INT32_MAX instead of a proper value. We assume that this is always an error and use an arbitrary limit. */ #ifdef INT32_MAX if (max_fds == INT32_MAX) max_fds = 256; #endif return max_fds; } /* Close all file descriptors starting with descriptor FIRST. If EXCEPT is not NULL, it is expected to be a list of file descriptors which shall not be closed. This list shall be sorted in ascending order with the end marked by -1. */ void close_all_fds (int first, int *except) { int max_fd = get_max_fds (); int fd, i, except_start; if (except) { except_start = 0; for (fd=first; fd < max_fd; fd++) { for (i=except_start; except[i] != -1; i++) { if (except[i] == fd) { /* If we found the descriptor in the exception list we can start the next compare run at the next index because the exception list is ordered. */ except_start = i + 1; break; } } if (except[i] == -1) close (fd); } } else { for (fd=first; fd < max_fd; fd++) close (fd); } gpg_err_set_errno (0); } /* Returns an array with all currently open file descriptors. The end of the array is marked by -1. The caller needs to release this array using the *standard free* and not with xfree. This allow the use of this function right at startup even before libgcrypt has been initialized. Returns NULL on error and sets ERRNO accordingly. */ int * get_all_open_fds (void) { int *array; size_t narray; int fd, max_fd, idx; #ifndef HAVE_STAT array = calloc (1, sizeof *array); if (array) array[0] = -1; #else /*HAVE_STAT*/ struct stat statbuf; max_fd = get_max_fds (); narray = 32; /* If you change this change also t-exechelp.c. */ array = calloc (narray, sizeof *array); if (!array) return NULL; /* Note: The list we return is ordered. */ for (idx=0, fd=0; fd < max_fd; fd++) if (!(fstat (fd, &statbuf) == -1 && errno == EBADF)) { if (idx+1 >= narray) { int *tmp; narray += (narray < 256)? 32:256; tmp = realloc (array, narray * sizeof *array); if (!tmp) { free (array); return NULL; } array = tmp; } array[idx++] = fd; } array[idx] = -1; #endif /*HAVE_STAT*/ return array; } /* The exec core used right after the fork. This will never return. */ static void do_exec (const char *pgmname, const char *argv[], int fd_in, int fd_out, int fd_err, int *except, unsigned int flags) { char **arg_list; int i, j; int fds[3]; int nodevnull[3]; fds[0] = fd_in; fds[1] = fd_out; fds[2] = fd_err; nodevnull[0] = !!(flags & GNUPG_SPAWN_KEEP_STDIN); nodevnull[1] = !!(flags & GNUPG_SPAWN_KEEP_STDOUT); nodevnull[2] = !!(flags & GNUPG_SPAWN_KEEP_STDERR); /* Create the command line argument array. */ i = 0; if (argv) while (argv[i]) i++; arg_list = xcalloc (i+2, sizeof *arg_list); arg_list[0] = strrchr (pgmname, '/'); if (arg_list[0]) arg_list[0]++; else arg_list[0] = xstrdup (pgmname); if (argv) for (i=0,j=1; argv[i]; i++, j++) arg_list[j] = (char*)argv[i]; /* Assign /dev/null to unused FDs. */ for (i=0; i <= 2; i++) { if (nodevnull[i]) continue; if (fds[i] == -1) { fds[i] = open ("/dev/null", i? O_WRONLY : O_RDONLY); if (fds[i] == -1) log_fatal ("failed to open '%s': %s\n", "/dev/null", strerror (errno)); } } /* Connect the standard files. */ for (i=0; i <= 2; i++) { if (nodevnull[i]) continue; if (fds[i] != i && dup2 (fds[i], i) == -1) log_fatal ("dup2 std%s failed: %s\n", i==0?"in":i==1?"out":"err", strerror (errno)); } /* Close all other files. */ close_all_fds (3, except); execv (pgmname, arg_list); /* No way to print anything, as we have closed all streams. */ _exit (127); } static gpg_error_t do_create_pipe (int filedes[2]) { gpg_error_t err = 0; if (pipe (filedes) == -1) { err = my_error_from_syserror (); filedes[0] = filedes[1] = -1; } return err; } static gpg_error_t create_pipe_and_estream (int filedes[2], estream_t *r_fp, int outbound, int nonblock) { gpg_error_t err; if (pipe (filedes) == -1) { err = my_error_from_syserror (); log_error (_("error creating a pipe: %s\n"), gpg_strerror (err)); filedes[0] = filedes[1] = -1; *r_fp = NULL; return err; } if (!outbound) *r_fp = es_fdopen (filedes[0], nonblock? "r,nonblock" : "r"); else *r_fp = es_fdopen (filedes[1], nonblock? "w,nonblock" : "w"); if (!*r_fp) { err = my_error_from_syserror (); log_error (_("error creating a stream for a pipe: %s\n"), gpg_strerror (err)); close (filedes[0]); close (filedes[1]); filedes[0] = filedes[1] = -1; return err; } return 0; } /* Portable function to create a pipe. Under Windows the write end is inheritable. If R_FP is not NULL, an estream is created for the read end and stored at R_FP. */ gpg_error_t gnupg_create_inbound_pipe (int filedes[2], estream_t *r_fp, int nonblock) { if (r_fp) return create_pipe_and_estream (filedes, r_fp, 0, nonblock); else return do_create_pipe (filedes); } /* Portable function to create a pipe. Under Windows the read end is inheritable. If R_FP is not NULL, an estream is created for the write end and stored at R_FP. */ gpg_error_t gnupg_create_outbound_pipe (int filedes[2], estream_t *r_fp, int nonblock) { if (r_fp) return create_pipe_and_estream (filedes, r_fp, 1, nonblock); else return do_create_pipe (filedes); } /* Portable function to create a pipe. Under Windows both ends are inheritable. */ gpg_error_t gnupg_create_pipe (int filedes[2]) { return do_create_pipe (filedes); } /* Close the end of a pipe. */ void gnupg_close_pipe (int fd) { if (fd != -1) close (fd); } /* Fork and exec the PGMNAME, see exechelp.h for details. */ gpg_error_t gnupg_spawn_process (const char *pgmname, const char *argv[], int *except, unsigned int flags, estream_t *r_infp, estream_t *r_outfp, estream_t *r_errfp, pid_t *pid) { gpg_error_t err; int inpipe[2] = {-1, -1}; int outpipe[2] = {-1, -1}; int errpipe[2] = {-1, -1}; estream_t infp = NULL; estream_t outfp = NULL; estream_t errfp = NULL; int nonblock = !!(flags & GNUPG_SPAWN_NONBLOCK); if (r_infp) *r_infp = NULL; if (r_outfp) *r_outfp = NULL; if (r_errfp) *r_errfp = NULL; *pid = (pid_t)(-1); /* Always required. */ if (r_infp) { err = create_pipe_and_estream (inpipe, &infp, 1, nonblock); if (err) return err; } if (r_outfp) { err = create_pipe_and_estream (outpipe, &outfp, 0, nonblock); if (err) { if (infp) es_fclose (infp); else if (inpipe[1] != -1) close (inpipe[1]); if (inpipe[0] != -1) close (inpipe[0]); return err; } } if (r_errfp) { err = create_pipe_and_estream (errpipe, &errfp, 0, nonblock); if (err) { if (infp) es_fclose (infp); else if (inpipe[1] != -1) close (inpipe[1]); if (inpipe[0] != -1) close (inpipe[0]); if (outfp) es_fclose (outfp); else if (outpipe[0] != -1) close (outpipe[0]); if (outpipe[1] != -1) close (outpipe[1]); return err; } } *pid = fork (); if (*pid == (pid_t)(-1)) { err = my_error_from_syserror (); log_error (_("error forking process: %s\n"), gpg_strerror (err)); if (infp) es_fclose (infp); else if (inpipe[1] != -1) close (inpipe[1]); if (inpipe[0] != -1) close (inpipe[0]); if (outfp) es_fclose (outfp); else if (outpipe[0] != -1) close (outpipe[0]); if (outpipe[1] != -1) close (outpipe[1]); if (errfp) es_fclose (errfp); else if (errpipe[0] != -1) close (errpipe[0]); if (errpipe[1] != -1) close (errpipe[1]); return err; } if (!*pid) { /* This is the child. */ gcry_control (GCRYCTL_TERM_SECMEM); es_fclose (infp); es_fclose (outfp); es_fclose (errfp); do_exec (pgmname, argv, inpipe[0], outpipe[1], errpipe[1], except, flags); /*NOTREACHED*/ } /* This is the parent. */ if (inpipe[0] != -1) close (inpipe[0]); if (outpipe[1] != -1) close (outpipe[1]); if (errpipe[1] != -1) close (errpipe[1]); if (r_infp) *r_infp = infp; if (r_outfp) *r_outfp = outfp; if (r_errfp) *r_errfp = errfp; return 0; } /* Simplified version of gnupg_spawn_process. This function forks and then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout and ERRFD to stderr (any of them may be -1 to connect them to /dev/null). The arguments for the process are expected in the NULL terminated array ARGV. The program name itself should not be included there. Calling gnupg_wait_process is required. Returns 0 on success or an error code. */ gpg_error_t gnupg_spawn_process_fd (const char *pgmname, const char *argv[], int infd, int outfd, int errfd, pid_t *pid) { gpg_error_t err; *pid = fork (); if (*pid == (pid_t)(-1)) { err = my_error_from_syserror (); log_error (_("error forking process: %s\n"), strerror (errno)); return err; } if (!*pid) { gcry_control (GCRYCTL_TERM_SECMEM); /* Run child. */ do_exec (pgmname, argv, infd, outfd, errfd, NULL, 0); /*NOTREACHED*/ } return 0; } /* Waiting for child processes. waitpid(2) may return information about terminated children that we did not yet request, and there is no portable way to wait for a specific set of children. As a workaround, we store the results of children for later use. XXX: This assumes that PIDs are not reused too quickly. */ struct terminated_child { pid_t pid; int exitcode; struct terminated_child *next; }; struct terminated_child *terminated_children; static gpg_error_t store_result (pid_t pid, int exitcode) { struct terminated_child *c; c = xtrymalloc (sizeof *c); if (c == NULL) return gpg_err_code_from_syserror (); c->pid = pid; c->exitcode = exitcode; c->next = terminated_children; terminated_children = c; return 0; } static int get_result (pid_t pid, int *r_exitcode) { struct terminated_child *c, **prevp; for (prevp = &terminated_children, c = terminated_children; c; prevp = &c->next, c = c->next) if (c->pid == pid) { *prevp = c->next; *r_exitcode = c->exitcode; xfree (c); return 1; } return 0; } /* See exechelp.h for a description. */ gpg_error_t gnupg_wait_process (const char *pgmname, pid_t pid, int hang, int *r_exitcode) { gpg_err_code_t ec; int i, status; if (r_exitcode) *r_exitcode = -1; if (pid == (pid_t)(-1)) return gpg_error (GPG_ERR_INV_VALUE); #ifdef USE_NPTH i = npth_waitpid (pid, &status, hang? 0:WNOHANG); #else while ((i=waitpid (pid, &status, hang? 0:WNOHANG)) == (pid_t)(-1) && errno == EINTR); #endif if (i == (pid_t)(-1)) { ec = gpg_err_code_from_errno (errno); log_error (_("waiting for process %d to terminate failed: %s\n"), (int)pid, strerror (errno)); } else if (!i) { ec = GPG_ERR_TIMEOUT; /* Still running. */ } else if (WIFEXITED (status) && WEXITSTATUS (status) == 127) { log_error (_("error running '%s': probably not installed\n"), pgmname); ec = GPG_ERR_CONFIGURATION; } else if (WIFEXITED (status) && WEXITSTATUS (status)) { if (!r_exitcode) log_error (_("error running '%s': exit status %d\n"), pgmname, WEXITSTATUS (status)); else *r_exitcode = WEXITSTATUS (status); ec = GPG_ERR_GENERAL; } else if (!WIFEXITED (status)) { log_error (_("error running '%s': terminated\n"), pgmname); ec = GPG_ERR_GENERAL; } else { if (r_exitcode) *r_exitcode = 0; ec = 0; } return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, ec); } /* See exechelp.h for a description. */ gpg_error_t gnupg_wait_processes (const char **pgmnames, pid_t *pids, size_t count, int hang, int *r_exitcodes) { gpg_err_code_t ec = 0; size_t i, left; int *dummy = NULL; if (r_exitcodes == NULL) { dummy = r_exitcodes = xtrymalloc (sizeof *r_exitcodes * count); if (dummy == NULL) return gpg_err_code_from_syserror (); } for (i = 0, left = count; i < count; i++) { int status = -1; /* Skip invalid PID. */ if (pids[i] == (pid_t)(-1)) { r_exitcodes[i] = -1; left -= 1; continue; } /* See if there was a previously stored result for this pid. */ if (get_result (pids[i], &status)) left -= 1; r_exitcodes[i] = status; } while (left > 0) { pid_t pid; int status; #ifdef USE_NPTH pid = npth_waitpid (-1, &status, hang ? 0 : WNOHANG); #else while ((pid = waitpid (-1, &status, hang ? 0 : WNOHANG)) == (pid_t)(-1) && errno == EINTR); #endif if (pid == (pid_t)(-1)) { ec = gpg_err_code_from_errno (errno); log_error (_("waiting for processes to terminate failed: %s\n"), strerror (errno)); break; } else if (!pid) { ec = GPG_ERR_TIMEOUT; /* Still running. */ break; } else { for (i = 0; i < count; i++) if (pid == pids[i]) break; if (i == count) { /* No match, store this result. */ ec = store_result (pid, status); if (ec) break; continue; } /* Process PIDS[i] died. */ if (r_exitcodes[i] != (pid_t) -1) { log_error ("PID %d was reused", pid); ec = GPG_ERR_GENERAL; break; } left -= 1; r_exitcodes[i] = status; } } for (i = 0; i < count; i++) { if (r_exitcodes[i] == -1) continue; if (WIFEXITED (r_exitcodes[i]) && WEXITSTATUS (r_exitcodes[i]) == 127) { log_error (_("error running '%s': probably not installed\n"), pgmnames[i]); ec = GPG_ERR_CONFIGURATION; } else if (WIFEXITED (r_exitcodes[i]) && WEXITSTATUS (r_exitcodes[i])) { if (dummy) log_error (_("error running '%s': exit status %d\n"), pgmnames[i], WEXITSTATUS (r_exitcodes[i])); else r_exitcodes[i] = WEXITSTATUS (r_exitcodes[i]); ec = GPG_ERR_GENERAL; } else if (!WIFEXITED (r_exitcodes[i])) { log_error (_("error running '%s': terminated\n"), pgmnames[i]); ec = GPG_ERR_GENERAL; } } xfree (dummy); return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, ec); } void gnupg_release_process (pid_t pid) { (void)pid; } /* Spawn a new process and immediately detach from it. The name of the program to exec is PGMNAME and its arguments are in ARGV (the programname is automatically passed as first argument). Environment strings in ENVP are set. An error is returned if pgmname is not executable; to make this work it is necessary to provide an absolute file name. All standard file descriptors are connected to /dev/null. */ gpg_error_t gnupg_spawn_process_detached (const char *pgmname, const char *argv[], const char *envp[] ) { gpg_err_code_t ec; pid_t pid; int i; if (getuid() != geteuid()) return my_error (GPG_ERR_BUG); if ((ec = gnupg_access (pgmname, X_OK))) return gpg_err_make (default_errsource, ec); pid = fork (); if (pid == (pid_t)(-1)) { log_error (_("error forking process: %s\n"), strerror (errno)); return my_error_from_syserror (); } if (!pid) { pid_t pid2; gcry_control (GCRYCTL_TERM_SECMEM); if (setsid() == -1 || chdir ("/")) _exit (1); pid2 = fork (); /* Double fork to let init take over the new child. */ if (pid2 == (pid_t)(-1)) _exit (1); if (pid2) _exit (0); /* Let the parent exit immediately. */ if (envp) for (i=0; envp[i]; i++) putenv (xstrdup (envp[i])); do_exec (pgmname, argv, -1, -1, -1, NULL, 0); /*NOTREACHED*/ } if (waitpid (pid, NULL, 0) == -1) log_error ("waitpid failed in gnupg_spawn_process_detached: %s", strerror (errno)); return 0; } /* Kill a process; that is send an appropriate signal to the process. gnupg_wait_process must be called to actually remove the process from the system. An invalid PID is ignored. */ void gnupg_kill_process (pid_t pid) { if (pid != (pid_t)(-1)) { kill (pid, SIGTERM); } } #include struct gnupg_process { const char *pgmname; unsigned int terminated :1; /* or detached */ unsigned int flags; pid_t pid; int fd_in; int fd_out; int fd_err; int wstatus; }; static int gnupg_process_syscall_func_initialized; /* Functions called before and after blocking syscalls. */ static void (*pre_syscall_func) (void); static void (*post_syscall_func) (void); static void check_syscall_func (void) { if (!gnupg_process_syscall_func_initialized) { gpgrt_get_syscall_clamp (&pre_syscall_func, &post_syscall_func); gnupg_process_syscall_func_initialized = 1; } } static void pre_syscall (void) { if (pre_syscall_func) pre_syscall_func (); } static void post_syscall (void) { if (post_syscall_func) post_syscall_func (); } static gpg_err_code_t do_create_socketpair (int filedes[2]) { gpg_error_t err = 0; pre_syscall (); if (socketpair (AF_LOCAL, SOCK_STREAM, 0, filedes) == -1) { err = gpg_err_code_from_syserror (); filedes[0] = filedes[1] = -1; } post_syscall (); return err; } static int posix_open_null (int for_write) { int fd; fd = open ("/dev/null", for_write? O_WRONLY : O_RDONLY); if (fd == -1) log_fatal ("failed to open '/dev/null': %s\n", strerror (errno)); return fd; } static void my_exec (const char *pgmname, const char *argv[], - int fd_in, int fd_out, int fd_err, int ask_inherit) + int fd_in, int fd_out, int fd_err, + int (*spawn_cb) (void *), void *spawn_cb_arg) { int i; int fds[3]; + int ask_inherit = 0; fds[0] = fd_in; fds[1] = fd_out; fds[2] = fd_err; /* Assign /dev/null to unused FDs. */ for (i = 0; i <= 2; i++) if (fds[i] == -1) fds[i] = posix_open_null (i); /* Connect the standard files. */ for (i = 0; i <= 2; i++) if (fds[i] != i) { if (dup2 (fds[i], i) == -1) log_fatal ("dup2 std%s failed: %s\n", i==0?"in":i==1?"out":"err", strerror (errno)); close (fds[i]); } + if (spawn_cb) + ask_inherit = (*spawn_cb) (spawn_cb_arg); + /* Close all other files. */ if (!ask_inherit) close_all_fds (3, NULL); execv (pgmname, (char *const *)argv); /* No way to print anything, as we have may have closed all streams. */ _exit (127); } static gpg_err_code_t spawn_detached (gnupg_process_t process, const char *pgmname, const char *argv[], - int (*spawn_cb) (struct spawn_cb_arg *), void *spawn_cb_arg) + int (*spawn_cb) (void *), void *spawn_cb_arg) { gpg_err_code_t ec; pid_t pid; /* FIXME: Is this GnuPG specific or should we keep it. */ if (getuid() != geteuid()) { xfree (process); xfree (argv); return GPG_ERR_BUG; } if (access (pgmname, X_OK)) { ec = gpg_err_code_from_syserror (); xfree (process); xfree (argv); return ec; } pre_syscall (); pid = fork (); post_syscall (); if (pid == (pid_t)(-1)) { ec = gpg_err_code_from_syserror (); log_error (_("error forking process: %s\n"), gpg_strerror (ec)); xfree (process); xfree (argv); return ec; } if (!pid) { pid_t pid2; - struct spawn_cb_arg arg; - int ask_inherit = 0; - - arg.std_fds[0] = arg.std_fds[1] = arg.std_fds[2] = -1; - arg.arg = spawn_cb_arg; - - if (spawn_cb) - ask_inherit = (*spawn_cb) (&arg); if (setsid() == -1 || chdir ("/")) _exit (1); pid2 = fork (); /* Double fork to let init take over the new child. */ if (pid2 == (pid_t)(-1)) _exit (1); if (pid2) _exit (0); /* Let the parent exit immediately. */ - my_exec (pgmname, argv, -1, -1, -1, ask_inherit); + my_exec (pgmname, argv, -1, -1, -1, spawn_cb, spawn_cb_arg); /*NOTREACHED*/ } pre_syscall (); if (waitpid (pid, NULL, 0) == -1) { post_syscall (); ec = gpg_err_code_from_syserror (); log_error ("waitpid failed in gpgrt_spawn_process_detached: %s", gpg_strerror (ec)); return ec; } else post_syscall (); process->pid = (pid_t)-1; process->fd_in = -1; process->fd_out = -1; process->fd_err = -1; process->wstatus = -1; process->terminated = 1; return 0; } gpg_err_code_t gnupg_process_spawn (const char *pgmname, const char *argv1[], unsigned int flags, - int (*spawn_cb) (struct spawn_cb_arg *), - void *spawn_cb_arg, + int (*spawn_cb) (void *), void *spawn_cb_arg, gnupg_process_t *r_process) { gpg_err_code_t ec; gnupg_process_t process; int fd_in[2]; int fd_out[2]; int fd_err[2]; pid_t pid; const char **argv; int i, j; check_syscall_func (); *r_process = NULL; /* Create the command line argument array. */ i = 0; if (argv1) while (argv1[i]) i++; argv = xtrycalloc (i+2, sizeof *argv); if (!argv) return gpg_err_code_from_syserror (); argv[0] = strrchr (pgmname, '/'); if (argv[0]) argv[0]++; else argv[0] = pgmname; if (argv1) for (i=0, j=1; argv1[i]; i++, j++) argv[j] = argv1[i]; process = xtrycalloc (1, sizeof (struct gnupg_process)); if (process == NULL) { xfree (argv); return gpg_err_code_from_syserror (); } process->pgmname = pgmname; process->flags = flags; if ((flags & GNUPG_PROCESS_DETACHED)) { if ((flags & GNUPG_PROCESS_STDFDS_SETTING)) { xfree (process); xfree (argv); return GPG_ERR_INV_FLAG; } *r_process = process; return spawn_detached (process, pgmname, argv, spawn_cb, spawn_cb_arg); } if ((flags & GNUPG_PROCESS_STDINOUT_SOCKETPAIR)) { ec = do_create_socketpair (fd_in); if (ec) { xfree (process); xfree (argv); return ec; } fd_out[0] = dup (fd_in[0]); fd_out[1] = dup (fd_in[1]); } else { if ((flags & GNUPG_PROCESS_STDIN_PIPE)) { ec = do_create_pipe (fd_in); if (ec) { xfree (process); xfree (argv); return ec; } } else if ((flags & GNUPG_PROCESS_STDIN_NULL)) { fd_in[0] = -1; fd_in[1] = -1; } else { fd_in[0] = 0; fd_in[1] = -1; } if ((flags & GNUPG_PROCESS_STDOUT_PIPE)) { ec = do_create_pipe (fd_out); if (ec) { if (fd_in[0] >= 0 && fd_in[0] != 0) close (fd_in[0]); if (fd_in[1] >= 0) close (fd_in[1]); xfree (process); xfree (argv); return ec; } } else if ((flags & GNUPG_PROCESS_STDOUT_NULL)) { fd_out[0] = -1; fd_out[1] = -1; } else { fd_out[0] = -1; fd_out[1] = 1; } } if ((flags & GNUPG_PROCESS_STDERR_PIPE)) { ec = do_create_pipe (fd_err); if (ec) { if (fd_in[0] >= 0 && fd_in[0] != 0) close (fd_in[0]); if (fd_in[1] >= 0) close (fd_in[1]); if (fd_out[0] >= 0) close (fd_out[0]); if (fd_out[1] >= 0 && fd_out[1] != 1) close (fd_out[1]); xfree (process); xfree (argv); return ec; } } else if ((flags & GNUPG_PROCESS_STDERR_NULL)) { fd_err[0] = -1; fd_err[1] = -1; } else { fd_err[0] = -1; fd_err[1] = 2; } pre_syscall (); pid = fork (); post_syscall (); if (pid == (pid_t)(-1)) { ec = gpg_err_code_from_syserror (); log_error (_("error forking process: %s\n"), gpg_strerror (ec)); if (fd_in[0] >= 0 && fd_in[0] != 0) close (fd_in[0]); if (fd_in[1] >= 0) close (fd_in[1]); if (fd_out[0] >= 0) close (fd_out[0]); if (fd_out[1] >= 0 && fd_out[1] != 1) close (fd_out[1]); if (fd_err[0] >= 0) close (fd_err[0]); if (fd_err[1] >= 0 && fd_err[1] != 2) close (fd_err[1]); xfree (process); xfree (argv); return ec; } if (!pid) { - struct spawn_cb_arg arg; - int ask_inherit = 0; - - arg.std_fds[0] = fd_in[0]; - arg.std_fds[1] = fd_out[1]; - arg.std_fds[2] = fd_err[1]; - arg.arg = spawn_cb_arg; - if (fd_in[1] >= 0) close (fd_in[1]); if (fd_out[0] >= 0) close (fd_out[0]); if (fd_err[0] >= 0) close (fd_err[0]); - if (spawn_cb) - ask_inherit = (*spawn_cb) (&arg); - /* Run child. */ - my_exec (pgmname, argv, fd_in[0], fd_out[1], fd_err[1], ask_inherit); + my_exec (pgmname, argv, fd_in[0], fd_out[1], fd_err[1], + spawn_cb, spawn_cb_arg); /*NOTREACHED*/ } xfree (argv); process->pid = pid; if (fd_in[0] >= 0 && fd_in[0] != 0) close (fd_in[0]); if (fd_out[1] >= 0 && fd_out[1] != 1) close (fd_out[1]); if (fd_err[1] >= 0 && fd_err[1] != 2) close (fd_err[1]); process->fd_in = fd_in[1]; process->fd_out = fd_out[0]; process->fd_err = fd_err[0]; process->wstatus = -1; process->terminated = 0; *r_process = process; return 0; } static gpg_err_code_t process_kill (gnupg_process_t process, int sig) { gpg_err_code_t ec = 0; pid_t pid = process->pid; pre_syscall (); if (kill (pid, sig) < 0) ec = gpg_err_code_from_syserror (); post_syscall (); return ec; } gpg_err_code_t gnupg_process_terminate (gnupg_process_t process) { return process_kill (process, SIGTERM); } gpg_err_code_t gnupg_process_get_fds (gnupg_process_t process, unsigned int flags, int *r_fd_in, int *r_fd_out, int *r_fd_err) { (void)flags; if (r_fd_in) { *r_fd_in = process->fd_in; process->fd_in = -1; } if (r_fd_out) { *r_fd_out = process->fd_out; process->fd_out = -1; } if (r_fd_err) { *r_fd_err = process->fd_err; process->fd_err = -1; } return 0; } gpg_err_code_t gnupg_process_get_streams (gnupg_process_t process, unsigned int flags, gpgrt_stream_t *r_fp_in, gpgrt_stream_t *r_fp_out, gpgrt_stream_t *r_fp_err) { int nonblock = (flags & GNUPG_PROCESS_STREAM_NONBLOCK)? 1: 0; if (r_fp_in) { *r_fp_in = es_fdopen (process->fd_in, nonblock? "w,nonblock" : "w"); process->fd_in = -1; } if (r_fp_out) { *r_fp_out = es_fdopen (process->fd_out, nonblock? "r,nonblock" : "r"); process->fd_out = -1; } if (r_fp_err) { *r_fp_err = es_fdopen (process->fd_err, nonblock? "r,nonblock" : "r"); process->fd_err = -1; } return 0; } static gpg_err_code_t process_vctl (gnupg_process_t process, unsigned int request, va_list arg_ptr) { switch (request) { case GNUPG_PROCESS_NOP: return 0; case GNUPG_PROCESS_GET_ID: { int *r_id = va_arg (arg_ptr, int *); if (r_id == NULL) return GPG_ERR_INV_VALUE; *r_id = (int)process->pid; return 0; } case GNUPG_PROCESS_GET_EXIT_ID: { int status = process->wstatus; int *r_exit_status = va_arg (arg_ptr, int *); if (!process->terminated) return GPG_ERR_UNFINISHED; if (WIFEXITED (status)) { if (r_exit_status) *r_exit_status = WEXITSTATUS (status); } else *r_exit_status = -1; return 0; } case GNUPG_PROCESS_GET_PID: { pid_t *r_pid = va_arg (arg_ptr, pid_t *); if (r_pid == NULL) return GPG_ERR_INV_VALUE; *r_pid = process->pid; return 0; } case GNUPG_PROCESS_GET_WSTATUS: { int status = process->wstatus; int *r_if_exited = va_arg (arg_ptr, int *); int *r_if_signaled = va_arg (arg_ptr, int *); int *r_exit_status = va_arg (arg_ptr, int *); int *r_termsig = va_arg (arg_ptr, int *); if (!process->terminated) return GPG_ERR_UNFINISHED; if (WIFEXITED (status)) { if (r_if_exited) *r_if_exited = 1; if (r_if_signaled) *r_if_signaled = 0; if (r_exit_status) *r_exit_status = WEXITSTATUS (status); if (r_termsig) *r_termsig = 0; } else if (WIFSIGNALED (status)) { if (r_if_exited) *r_if_exited = 0; if (r_if_signaled) *r_if_signaled = 1; if (r_exit_status) *r_exit_status = 0; if (r_termsig) *r_termsig = WTERMSIG (status); } return 0; } case GNUPG_PROCESS_KILL: { int sig = va_arg (arg_ptr, int); return process_kill (process, sig); } default: break; } return GPG_ERR_UNKNOWN_COMMAND; } gpg_err_code_t gnupg_process_ctl (gnupg_process_t process, unsigned int request, ...) { va_list arg_ptr; gpg_err_code_t ec; va_start (arg_ptr, request); ec = process_vctl (process, request, arg_ptr); va_end (arg_ptr); return ec; } gpg_err_code_t gnupg_process_wait (gnupg_process_t process, int hang) { gpg_err_code_t ec; int status; pid_t pid; if (process->terminated) /* Already terminated. */ return 0; pre_syscall (); while ((pid = waitpid (process->pid, &status, hang? 0: WNOHANG)) == (pid_t)(-1) && errno == EINTR); post_syscall (); if (pid == (pid_t)(-1)) { ec = gpg_err_code_from_syserror (); log_error (_("waiting for process %d to terminate failed: %s\n"), (int)pid, gpg_strerror (ec)); } else if (!pid) { ec = GPG_ERR_TIMEOUT; /* Still running. */ } else { process->terminated = 1; process->wstatus = status; ec = 0; } return ec; } void gnupg_process_release (gnupg_process_t process) { if (process->terminated) gnupg_process_wait (process, 0); xfree (process); } gpg_err_code_t gnupg_process_wait_list (gnupg_process_t *process_list, int count, int hang) { gpg_err_code_t ec = 0; int i; for (i = 0; i < count; i++) { if (process_list[i]->terminated) continue; ec = gnupg_process_wait (process_list[i], hang); if (ec) break; } return ec; } diff --git a/common/exechelp-w32.c b/common/exechelp-w32.c index 587c96af2..14cf84ce5 100644 --- a/common/exechelp-w32.c +++ b/common/exechelp-w32.c @@ -1,1715 +1,1701 @@ /* exechelp-w32.c - Fork and exec helpers for W32. * Copyright (C) 2004, 2007-2009, 2010 Free Software Foundation, Inc. * Copyright (C) 2004, 2006-2012, 2014-2017 g10 Code GmbH * * This file is part of GnuPG. * * This file is free software; you can redistribute it and/or modify * it under the terms of either * * - the GNU Lesser General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at * your option) any later version. * * or * * - the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at * your option) any later version. * * or both in parallel, as here. * * This file is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . * SPDX-License-Identifier: (LGPL-3.0+ OR GPL-2.0+) */ #include #if !defined(HAVE_W32_SYSTEM) #error This code is only used on W32. #endif #include #include #include #include #include #ifdef HAVE_SIGNAL_H # include #endif #include #include #ifdef WITHOUT_NPTH /* Give the Makefile a chance to build without Pth. */ #undef HAVE_NPTH #undef USE_NPTH #endif #ifdef HAVE_NPTH #include #endif #ifdef HAVE_STAT # include #endif #include "util.h" #include "i18n.h" #include "sysutils.h" #include "exechelp.h" #include /* Define to 1 do enable debugging. */ #define DEBUG_W32_SPAWN 0 /* It seems Vista doesn't grok X_OK and so fails access() tests. Previous versions interpreted X_OK as F_OK anyway, so we'll just use F_OK directly. */ #undef X_OK #define X_OK F_OK /* We assume that a HANDLE can be represented by an intptr_t which should be true for all systems (HANDLE is defined as void *). Further we assume that -1 denotes an invalid handle. */ # define fd_to_handle(a) ((HANDLE)(a)) # define handle_to_fd(a) ((intptr_t)(a)) # define pid_to_handle(a) ((HANDLE)(a)) # define handle_to_pid(a) ((int)(a)) /* Helper */ static inline gpg_error_t my_error_from_syserror (void) { return gpg_err_make (default_errsource, gpg_err_code_from_syserror ()); } static inline gpg_error_t my_error (int errcode) { return gpg_err_make (default_errsource, errcode); } /* Return the maximum number of currently allowed open file descriptors. Only useful on POSIX systems but returns a value on other systems too. */ int get_max_fds (void) { int max_fds = -1; #ifdef OPEN_MAX if (max_fds == -1) max_fds = OPEN_MAX; #endif if (max_fds == -1) max_fds = 256; /* Arbitrary limit. */ return max_fds; } /* Under Windows this is a dummy function. */ void close_all_fds (int first, int *except) { (void)first; (void)except; } /* Returns an array with all currently open file descriptors. The end * of the array is marked by -1. The caller needs to release this * array using the *standard free* and not with xfree. This allow the * use of this function right at startup even before libgcrypt has * been initialized. Returns NULL on error and sets ERRNO * accordingly. Note that fstat prints a warning to DebugView for all * invalid fds which is a bit annoying. We actually do not need this * function in real code (close_all_fds is a dummy anyway) but we keep * it for use by t-exechelp.c. */ int * get_all_open_fds (void) { int *array; size_t narray; int fd, max_fd, idx; #ifndef HAVE_STAT array = calloc (1, sizeof *array); if (array) array[0] = -1; #else /*HAVE_STAT*/ struct stat statbuf; max_fd = get_max_fds (); narray = 32; /* If you change this change also t-exechelp.c. */ array = calloc (narray, sizeof *array); if (!array) return NULL; /* Note: The list we return is ordered. */ for (idx=0, fd=0; fd < max_fd; fd++) if (!(fstat (fd, &statbuf) == -1 && errno == EBADF)) { if (idx+1 >= narray) { int *tmp; narray += (narray < 256)? 32:256; tmp = realloc (array, narray * sizeof *array); if (!tmp) { free (array); return NULL; } array = tmp; } array[idx++] = fd; } array[idx] = -1; #endif /*HAVE_STAT*/ return array; } /* Helper function to build_w32_commandline. */ static char * build_w32_commandline_copy (char *buffer, const char *string) { char *p = buffer; const char *s; if (!*string) /* Empty string. */ p = stpcpy (p, "\"\""); else if (strpbrk (string, " \t\n\v\f\"")) { /* Need to do some kind of quoting. */ p = stpcpy (p, "\""); for (s=string; *s; s++) { *p++ = *s; if (*s == '\"') *p++ = *s; } *p++ = '\"'; *p = 0; } else p = stpcpy (p, string); return p; } /* Build a command line for use with W32's CreateProcess. On success CMDLINE gets the address of a newly allocated string. */ static gpg_error_t build_w32_commandline (const char *pgmname, const char * const *argv, char **cmdline) { int i, n; const char *s; char *buf, *p; *cmdline = NULL; n = 0; s = pgmname; n += strlen (s) + 1 + 2; /* (1 space, 2 quoting */ for (; *s; s++) if (*s == '\"') n++; /* Need to double inner quotes. */ for (i=0; (s=argv[i]); i++) { n += strlen (s) + 1 + 2; /* (1 space, 2 quoting */ for (; *s; s++) if (*s == '\"') n++; /* Need to double inner quotes. */ } n++; buf = p = xtrymalloc (n); if (!buf) return my_error_from_syserror (); p = build_w32_commandline_copy (p, pgmname); for (i=0; argv[i]; i++) { *p++ = ' '; p = build_w32_commandline_copy (p, argv[i]); } *cmdline= buf; return 0; } #define INHERIT_READ 1 #define INHERIT_WRITE 2 #define INHERIT_BOTH (INHERIT_READ|INHERIT_WRITE) /* Create pipe. FLAGS indicates which ends are inheritable. */ static int create_inheritable_pipe (HANDLE filedes[2], int flags) { HANDLE r, w; SECURITY_ATTRIBUTES sec_attr; memset (&sec_attr, 0, sizeof sec_attr ); sec_attr.nLength = sizeof sec_attr; sec_attr.bInheritHandle = TRUE; if (!CreatePipe (&r, &w, &sec_attr, 0)) return -1; if ((flags & INHERIT_READ) == 0) if (! SetHandleInformation (r, HANDLE_FLAG_INHERIT, 0)) goto fail; if ((flags & INHERIT_WRITE) == 0) if (! SetHandleInformation (w, HANDLE_FLAG_INHERIT, 0)) goto fail; filedes[0] = r; filedes[1] = w; return 0; fail: log_error ("SetHandleInformation failed: %s\n", w32_strerror (-1)); CloseHandle (r); CloseHandle (w); return -1; } static HANDLE w32_open_null (int for_write) { HANDLE hfile; hfile = CreateFileW (L"nul", for_write? GENERIC_WRITE : GENERIC_READ, FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL); if (hfile == INVALID_HANDLE_VALUE) log_debug ("can't open 'nul': %s\n", w32_strerror (-1)); return hfile; } static gpg_error_t create_pipe_and_estream (int filedes[2], int flags, estream_t *r_fp, int outbound, int nonblock) { gpg_error_t err = 0; HANDLE fds[2]; es_syshd_t syshd; filedes[0] = filedes[1] = -1; err = my_error (GPG_ERR_GENERAL); if (!create_inheritable_pipe (fds, flags)) { filedes[0] = _open_osfhandle (handle_to_fd (fds[0]), O_RDONLY); if (filedes[0] == -1) { log_error ("failed to translate osfhandle %p\n", fds[0]); CloseHandle (fds[1]); } else { filedes[1] = _open_osfhandle (handle_to_fd (fds[1]), O_APPEND); if (filedes[1] == -1) { log_error ("failed to translate osfhandle %p\n", fds[1]); close (filedes[0]); filedes[0] = -1; CloseHandle (fds[1]); } else err = 0; } } if (! err && r_fp) { syshd.type = ES_SYSHD_HANDLE; if (!outbound) { syshd.u.handle = fds[0]; *r_fp = es_sysopen (&syshd, nonblock? "r,nonblock" : "r"); } else { syshd.u.handle = fds[1]; *r_fp = es_sysopen (&syshd, nonblock? "w,nonblock" : "w"); } if (!*r_fp) { err = my_error_from_syserror (); log_error (_("error creating a stream for a pipe: %s\n"), gpg_strerror (err)); close (filedes[0]); close (filedes[1]); filedes[0] = filedes[1] = -1; return err; } } return err; } /* Portable function to create a pipe. Under Windows the write end is inheritable. If R_FP is not NULL, an estream is created for the read end and stored at R_FP. */ gpg_error_t gnupg_create_inbound_pipe (int filedes[2], estream_t *r_fp, int nonblock) { return create_pipe_and_estream (filedes, INHERIT_WRITE, r_fp, 0, nonblock); } /* Portable function to create a pipe. Under Windows the read end is inheritable. If R_FP is not NULL, an estream is created for the write end and stored at R_FP. */ gpg_error_t gnupg_create_outbound_pipe (int filedes[2], estream_t *r_fp, int nonblock) { return create_pipe_and_estream (filedes, INHERIT_READ, r_fp, 1, nonblock); } /* Portable function to create a pipe. Under Windows both ends are inheritable. */ gpg_error_t gnupg_create_pipe (int filedes[2]) { return create_pipe_and_estream (filedes, INHERIT_BOTH, NULL, 0, 0); } /* Close the end of a pipe. */ void gnupg_close_pipe (int fd) { if (fd != -1) close (fd); } /* Fork and exec the PGMNAME, see exechelp.h for details. */ gpg_error_t gnupg_spawn_process (const char *pgmname, const char *argv[], int *except, unsigned int flags, estream_t *r_infp, estream_t *r_outfp, estream_t *r_errfp, pid_t *pid) { gpg_error_t err; SECURITY_ATTRIBUTES sec_attr; PROCESS_INFORMATION pi = { NULL, /* Returns process handle. */ 0, /* Returns primary thread handle. */ 0, /* Returns pid. */ 0 /* Returns tid. */ }; STARTUPINFOW si; int cr_flags; char *cmdline; wchar_t *wcmdline = NULL; wchar_t *wpgmname = NULL; HANDLE inpipe[2] = {INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE}; HANDLE outpipe[2] = {INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE}; HANDLE errpipe[2] = {INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE}; estream_t infp = NULL; estream_t outfp = NULL; estream_t errfp = NULL; HANDLE nullhd[3] = {INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE}; int i, rc; es_syshd_t syshd; gpg_err_source_t errsource = default_errsource; int nonblock = !!(flags & GNUPG_SPAWN_NONBLOCK); (void)except; /* Not yet used. */ if (r_infp) *r_infp = NULL; if (r_outfp) *r_outfp = NULL; if (r_errfp) *r_errfp = NULL; *pid = (pid_t)(-1); /* Always required. */ if (r_infp) { if (create_inheritable_pipe (inpipe, INHERIT_READ)) { err = gpg_err_make (errsource, GPG_ERR_GENERAL); log_error (_("error creating a pipe: %s\n"), gpg_strerror (err)); return err; } syshd.type = ES_SYSHD_HANDLE; syshd.u.handle = inpipe[1]; infp = es_sysopen (&syshd, nonblock? "w,nonblock" : "w"); if (!infp) { err = gpg_err_make (errsource, gpg_err_code_from_syserror ()); log_error (_("error creating a stream for a pipe: %s\n"), gpg_strerror (err)); CloseHandle (inpipe[0]); CloseHandle (inpipe[1]); inpipe[0] = inpipe[1] = INVALID_HANDLE_VALUE; return err; } } if (r_outfp) { if (create_inheritable_pipe (outpipe, INHERIT_WRITE)) { err = gpg_err_make (errsource, GPG_ERR_GENERAL); log_error (_("error creating a pipe: %s\n"), gpg_strerror (err)); return err; } syshd.type = ES_SYSHD_HANDLE; syshd.u.handle = outpipe[0]; outfp = es_sysopen (&syshd, nonblock? "r,nonblock" : "r"); if (!outfp) { err = gpg_err_make (errsource, gpg_err_code_from_syserror ()); log_error (_("error creating a stream for a pipe: %s\n"), gpg_strerror (err)); CloseHandle (outpipe[0]); CloseHandle (outpipe[1]); outpipe[0] = outpipe[1] = INVALID_HANDLE_VALUE; if (infp) es_fclose (infp); else if (inpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (inpipe[1]); if (inpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (inpipe[0]); return err; } } if (r_errfp) { if (create_inheritable_pipe (errpipe, INHERIT_WRITE)) { err = gpg_err_make (errsource, GPG_ERR_GENERAL); log_error (_("error creating a pipe: %s\n"), gpg_strerror (err)); return err; } syshd.type = ES_SYSHD_HANDLE; syshd.u.handle = errpipe[0]; errfp = es_sysopen (&syshd, nonblock? "r,nonblock" : "r"); if (!errfp) { err = gpg_err_make (errsource, gpg_err_code_from_syserror ()); log_error (_("error creating a stream for a pipe: %s\n"), gpg_strerror (err)); CloseHandle (errpipe[0]); CloseHandle (errpipe[1]); errpipe[0] = errpipe[1] = INVALID_HANDLE_VALUE; if (outfp) es_fclose (outfp); else if (outpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (outpipe[0]); if (outpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (outpipe[1]); if (infp) es_fclose (infp); else if (inpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (inpipe[1]); if (inpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (inpipe[0]); return err; } } /* Prepare security attributes. */ memset (&sec_attr, 0, sizeof sec_attr ); sec_attr.nLength = sizeof sec_attr; sec_attr.bInheritHandle = FALSE; /* Build the command line. */ err = build_w32_commandline (pgmname, argv, &cmdline); if (err) return err; if (inpipe[0] == INVALID_HANDLE_VALUE) nullhd[0] = ((flags & GNUPG_SPAWN_KEEP_STDIN)? GetStdHandle (STD_INPUT_HANDLE) : w32_open_null (0)); if (outpipe[1] == INVALID_HANDLE_VALUE) nullhd[1] = ((flags & GNUPG_SPAWN_KEEP_STDOUT)? GetStdHandle (STD_OUTPUT_HANDLE) : w32_open_null (1)); if (errpipe[1] == INVALID_HANDLE_VALUE) nullhd[2] = ((flags & GNUPG_SPAWN_KEEP_STDOUT)? GetStdHandle (STD_ERROR_HANDLE) : w32_open_null (1)); memset (&si, 0, sizeof si); si.cb = sizeof (si); si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW; si.wShowWindow = DEBUG_W32_SPAWN? SW_SHOW : SW_HIDE; si.hStdInput = inpipe[0] == INVALID_HANDLE_VALUE? nullhd[0] : inpipe[0]; si.hStdOutput = outpipe[1] == INVALID_HANDLE_VALUE? nullhd[1] : outpipe[1]; si.hStdError = errpipe[1] == INVALID_HANDLE_VALUE? nullhd[2] : errpipe[1]; cr_flags = (CREATE_DEFAULT_ERROR_MODE | ((flags & GNUPG_SPAWN_DETACHED)? DETACHED_PROCESS : 0) | GetPriorityClass (GetCurrentProcess ()) | CREATE_SUSPENDED); /* log_debug ("CreateProcess, path='%s' cmdline='%s'\n", */ /* pgmname, cmdline); */ /* Take care: CreateProcessW may modify wpgmname */ if (!(wpgmname = utf8_to_wchar (pgmname))) rc = 0; else if (!(wcmdline = utf8_to_wchar (cmdline))) rc = 0; else rc = CreateProcessW (wpgmname, /* Program to start. */ wcmdline, /* Command line arguments. */ &sec_attr, /* Process security attributes. */ &sec_attr, /* Thread security attributes. */ TRUE, /* Inherit handles. */ cr_flags, /* Creation flags. */ NULL, /* Environment. */ NULL, /* Use current drive/directory. */ &si, /* Startup information. */ &pi /* Returns process information. */ ); if (!rc) { if (!wpgmname || !wcmdline) log_error ("CreateProcess failed (utf8_to_wchar): %s\n", strerror (errno)); else log_error ("CreateProcess failed: %s\n", w32_strerror (-1)); xfree (wpgmname); xfree (wcmdline); xfree (cmdline); if (infp) es_fclose (infp); else if (inpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (outpipe[1]); if (inpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (inpipe[0]); if (outfp) es_fclose (outfp); else if (outpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (outpipe[0]); if (outpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (outpipe[1]); if (errfp) es_fclose (errfp); else if (errpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (errpipe[0]); if (errpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (errpipe[1]); return gpg_err_make (errsource, GPG_ERR_GENERAL); } xfree (wpgmname); xfree (wcmdline); xfree (cmdline); cmdline = NULL; /* Close the inherited handles to /dev/null. */ for (i=0; i < DIM (nullhd); i++) if (nullhd[i] != INVALID_HANDLE_VALUE) CloseHandle (nullhd[i]); /* Close the inherited ends of the pipes. */ if (inpipe[0] != INVALID_HANDLE_VALUE) CloseHandle (inpipe[0]); if (outpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (outpipe[1]); if (errpipe[1] != INVALID_HANDLE_VALUE) CloseHandle (errpipe[1]); /* log_debug ("CreateProcess ready: hProcess=%p hThread=%p" */ /* " dwProcessID=%d dwThreadId=%d\n", */ /* pi.hProcess, pi.hThread, */ /* (int) pi.dwProcessId, (int) pi.dwThreadId); */ /* log_debug (" outfp=%p errfp=%p\n", outfp, errfp); */ /* Fixme: For unknown reasons AllowSetForegroundWindow returns an invalid argument error if we pass it the correct processID. As a workaround we use -1 (ASFW_ANY). */ if ((flags & GNUPG_SPAWN_RUN_ASFW)) gnupg_allow_set_foregound_window ((pid_t)(-1)/*pi.dwProcessId*/); /* Process has been created suspended; resume it now. */ ResumeThread (pi.hThread); CloseHandle (pi.hThread); if (r_infp) *r_infp = infp; if (r_outfp) *r_outfp = outfp; if (r_errfp) *r_errfp = errfp; *pid = handle_to_pid (pi.hProcess); return 0; } /* Simplified version of gnupg_spawn_process. This function forks and then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout and ERRFD to stderr (any of them may be -1 to connect them to /dev/null). The arguments for the process are expected in the NULL terminated array ARGV. The program name itself should not be included there. Calling gnupg_wait_process is required. Returns 0 on success or an error code. */ gpg_error_t gnupg_spawn_process_fd (const char *pgmname, const char *argv[], int infd, int outfd, int errfd, pid_t *pid) { gpg_error_t err; SECURITY_ATTRIBUTES sec_attr; PROCESS_INFORMATION pi = { NULL, 0, 0, 0 }; STARTUPINFOW si; char *cmdline; wchar_t *wcmdline = NULL; wchar_t *wpgmname = NULL; int i, rc; HANDLE stdhd[3]; /* Setup return values. */ *pid = (pid_t)(-1); /* Prepare security attributes. */ memset (&sec_attr, 0, sizeof sec_attr ); sec_attr.nLength = sizeof sec_attr; sec_attr.bInheritHandle = FALSE; /* Build the command line. */ err = build_w32_commandline (pgmname, argv, &cmdline); if (err) return err; memset (&si, 0, sizeof si); si.cb = sizeof (si); si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW; si.wShowWindow = DEBUG_W32_SPAWN? SW_SHOW : SW_MINIMIZE; stdhd[0] = infd == -1? w32_open_null (0) : INVALID_HANDLE_VALUE; stdhd[1] = outfd == -1? w32_open_null (1) : INVALID_HANDLE_VALUE; stdhd[2] = errfd == -1? w32_open_null (1) : INVALID_HANDLE_VALUE; si.hStdInput = infd == -1? stdhd[0] : (void*)_get_osfhandle (infd); si.hStdOutput = outfd == -1? stdhd[1] : (void*)_get_osfhandle (outfd); si.hStdError = errfd == -1? stdhd[2] : (void*)_get_osfhandle (errfd); /* log_debug ("CreateProcess, path='%s' cmdline='%s'\n", pgmname, cmdline); */ /* Take care: CreateProcessW may modify wpgmname */ if (!(wpgmname = utf8_to_wchar (pgmname))) rc = 0; else if (!(wcmdline = utf8_to_wchar (cmdline))) rc = 0; else rc = CreateProcessW (wpgmname, /* Program to start. */ wcmdline, /* Command line arguments. */ &sec_attr, /* Process security attributes. */ &sec_attr, /* Thread security attributes. */ TRUE, /* Inherit handles. */ (CREATE_DEFAULT_ERROR_MODE | GetPriorityClass (GetCurrentProcess ()) | CREATE_SUSPENDED | DETACHED_PROCESS), NULL, /* Environment. */ NULL, /* Use current drive/directory. */ &si, /* Startup information. */ &pi /* Returns process information. */ ); if (!rc) { if (!wpgmname || !wcmdline) log_error ("CreateProcess failed (utf8_to_wchar): %s\n", strerror (errno)); else log_error ("CreateProcess failed: %s\n", w32_strerror (-1)); err = my_error (GPG_ERR_GENERAL); } else err = 0; xfree (wpgmname); xfree (wcmdline); xfree (cmdline); for (i=0; i < 3; i++) if (stdhd[i] != INVALID_HANDLE_VALUE) CloseHandle (stdhd[i]); if (err) return err; /* log_debug ("CreateProcess ready: hProcess=%p hThread=%p" */ /* " dwProcessID=%d dwThreadId=%d\n", */ /* pi.hProcess, pi.hThread, */ /* (int) pi.dwProcessId, (int) pi.dwThreadId); */ /* Process has been created suspended; resume it now. */ ResumeThread (pi.hThread); CloseHandle (pi.hThread); *pid = handle_to_pid (pi.hProcess); return 0; } /* See exechelp.h for a description. */ gpg_error_t gnupg_wait_process (const char *pgmname, pid_t pid, int hang, int *r_exitcode) { return gnupg_wait_processes (&pgmname, &pid, 1, hang, r_exitcode); } /* See exechelp.h for a description. */ gpg_error_t gnupg_wait_processes (const char **pgmnames, pid_t *pids, size_t count, int hang, int *r_exitcodes) { gpg_err_code_t ec = 0; size_t i; HANDLE *procs; int code; procs = xtrycalloc (count, sizeof *procs); if (procs == NULL) return my_error_from_syserror (); for (i = 0; i < count; i++) { if (r_exitcodes) r_exitcodes[i] = -1; if (pids[i] == (pid_t)(-1)) return my_error (GPG_ERR_INV_VALUE); procs[i] = pid_to_handle (pids[i]); } /* FIXME: We should do a pth_waitpid here. However this has not yet been implemented. A special W32 pth system call would even be better. */ code = WaitForMultipleObjects (count, procs, TRUE, hang? INFINITE : 0); switch (code) { case WAIT_TIMEOUT: ec = GPG_ERR_TIMEOUT; goto leave; case WAIT_FAILED: log_error (_("waiting for processes to terminate failed: %s\n"), w32_strerror (-1)); ec = GPG_ERR_GENERAL; goto leave; case WAIT_OBJECT_0: for (i = 0; i < count; i++) { DWORD exc; if (! GetExitCodeProcess (procs[i], &exc)) { log_error (_("error getting exit code of process %d: %s\n"), (int) pids[i], w32_strerror (-1) ); ec = GPG_ERR_GENERAL; } else if (exc) { if (!r_exitcodes) log_error (_("error running '%s': exit status %d\n"), pgmnames[i], (int)exc); else r_exitcodes[i] = (int)exc; ec = GPG_ERR_GENERAL; } else { if (r_exitcodes) r_exitcodes[i] = 0; } } break; default: log_error ("WaitForMultipleObjects returned unexpected " "code %d\n", code); ec = GPG_ERR_GENERAL; break; } leave: return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, ec); } void gnupg_release_process (pid_t pid) { if (pid != (pid_t)INVALID_HANDLE_VALUE) { HANDLE process = (HANDLE)pid; CloseHandle (process); } } /* Spawn a new process and immediately detach from it. The name of the program to exec is PGMNAME and its arguments are in ARGV (the programname is automatically passed as first argument). Environment strings in ENVP are set. An error is returned if pgmname is not executable; to make this work it is necessary to provide an absolute file name. All standard file descriptors are connected to /dev/null. */ gpg_error_t gnupg_spawn_process_detached (const char *pgmname, const char *argv[], const char *envp[] ) { gpg_error_t err; SECURITY_ATTRIBUTES sec_attr; PROCESS_INFORMATION pi = { NULL, /* Returns process handle. */ 0, /* Returns primary thread handle. */ 0, /* Returns pid. */ 0 /* Returns tid. */ }; STARTUPINFOW si; int cr_flags; char *cmdline; wchar_t *wcmdline = NULL; wchar_t *wpgmname = NULL; BOOL in_job = FALSE; gpg_err_code_t ec; int rc; int jobdebug; /* We don't use ENVP. */ (void)envp; cmdline = getenv ("GNUPG_EXEC_DEBUG_FLAGS"); jobdebug = (cmdline && (atoi (cmdline) & 1)); if ((ec = gnupg_access (pgmname, X_OK))) return gpg_err_make (default_errsource, ec); /* Prepare security attributes. */ memset (&sec_attr, 0, sizeof sec_attr ); sec_attr.nLength = sizeof sec_attr; sec_attr.bInheritHandle = FALSE; /* Build the command line. */ err = build_w32_commandline (pgmname, argv, &cmdline); if (err) return err; /* Start the process. */ memset (&si, 0, sizeof si); si.cb = sizeof (si); si.dwFlags = STARTF_USESHOWWINDOW; si.wShowWindow = DEBUG_W32_SPAWN? SW_SHOW : SW_MINIMIZE; cr_flags = (CREATE_DEFAULT_ERROR_MODE | GetPriorityClass (GetCurrentProcess ()) | CREATE_NEW_PROCESS_GROUP | DETACHED_PROCESS); /* Check if we were spawned as part of a Job. * In a job we need to add CREATE_BREAKAWAY_FROM_JOB * to the cr_flags, otherwise our child processes * are killed when we terminate. */ if (!IsProcessInJob (GetCurrentProcess(), NULL, &in_job)) { log_error ("IsProcessInJob() failed: %s\n", w32_strerror (-1)); in_job = FALSE; } if (in_job) { /* Only try to break away from job if it is allowed, otherwise * CreateProcess() would fail with an "Access is denied" error. */ JOBOBJECT_EXTENDED_LIMIT_INFORMATION info; if (!QueryInformationJobObject (NULL, JobObjectExtendedLimitInformation, &info, sizeof info, NULL)) { log_error ("QueryInformationJobObject() failed: %s\n", w32_strerror (-1)); } else if ((info.BasicLimitInformation.LimitFlags & JOB_OBJECT_LIMIT_BREAKAWAY_OK)) { if (jobdebug) log_debug ("Using CREATE_BREAKAWAY_FROM_JOB flag\n"); cr_flags |= CREATE_BREAKAWAY_FROM_JOB; } else if ((info.BasicLimitInformation.LimitFlags & JOB_OBJECT_LIMIT_SILENT_BREAKAWAY_OK)) { /* The child process should automatically detach from the job. */ if (jobdebug) log_debug ("Not using CREATE_BREAKAWAY_FROM_JOB flag; " "JOB_OBJECT_LIMIT_SILENT_BREAKAWAY_OK is set\n"); } else { /* It seems that the child process must remain in the job. * This is not necessarily an error, although it can cause premature * termination of the child process when the job is closed. */ if (jobdebug) log_debug ("Not using CREATE_BREAKAWAY_FROM_JOB flag\n"); } } else { if (jobdebug) log_debug ("Process is not in a Job\n"); } /* log_debug ("CreateProcess(detached), path='%s' cmdline='%s'\n", */ /* pgmname, cmdline); */ /* Take care: CreateProcessW may modify wpgmname */ if (!(wpgmname = utf8_to_wchar (pgmname))) rc = 0; else if (!(wcmdline = utf8_to_wchar (cmdline))) rc = 0; else rc = CreateProcessW (wpgmname, /* Program to start. */ wcmdline, /* Command line arguments. */ &sec_attr, /* Process security attributes. */ &sec_attr, /* Thread security attributes. */ FALSE, /* Inherit handles. */ cr_flags, /* Creation flags. */ NULL, /* Environment. */ NULL, /* Use current drive/directory. */ &si, /* Startup information. */ &pi /* Returns process information. */ ); if (!rc) { if (!wpgmname || !wcmdline) log_error ("CreateProcess failed (utf8_to_wchar): %s\n", strerror (errno)); else log_error ("CreateProcess(detached) failed: %s\n", w32_strerror (-1)); xfree (wpgmname); xfree (wcmdline); xfree (cmdline); return my_error (GPG_ERR_GENERAL); } xfree (wpgmname); xfree (wcmdline); xfree (cmdline); cmdline = NULL; /* log_debug ("CreateProcess(detached) ready: hProcess=%p hThread=%p" */ /* " dwProcessID=%d dwThreadId=%d\n", */ /* pi.hProcess, pi.hThread, */ /* (int) pi.dwProcessId, (int) pi.dwThreadId); */ CloseHandle (pi.hThread); CloseHandle (pi.hProcess); return 0; } /* Kill a process; that is send an appropriate signal to the process. gnupg_wait_process must be called to actually remove the process from the system. An invalid PID is ignored. */ void gnupg_kill_process (pid_t pid) { if (pid != (pid_t) INVALID_HANDLE_VALUE) { HANDLE process = (HANDLE) pid; /* Arbitrary error code. */ TerminateProcess (process, 1); } } struct gnupg_process { const char *pgmname; unsigned int terminated :1; /* or detached */ unsigned int flags; HANDLE hProcess; HANDLE hd_in; HANDLE hd_out; HANDLE hd_err; int exitcode; }; static int gnupg_process_syscall_func_initialized; /* Functions called before and after blocking syscalls. */ static void (*pre_syscall_func) (void); static void (*post_syscall_func) (void); static void check_syscall_func (void) { if (!gnupg_process_syscall_func_initialized) { gpgrt_get_syscall_clamp (&pre_syscall_func, &post_syscall_func); gnupg_process_syscall_func_initialized = 1; } } static void pre_syscall (void) { if (pre_syscall_func) pre_syscall_func (); } static void post_syscall (void) { if (post_syscall_func) post_syscall_func (); } static gpg_err_code_t spawn_detached (gnupg_process_t process, const char *pgmname, char *cmdline, - int (*spawn_cb) (struct spawn_cb_arg *), void *spawn_cb_arg) + int (*spawn_cb) (void *), void *spawn_cb_arg) { SECURITY_ATTRIBUTES sec_attr; PROCESS_INFORMATION pi = { NULL, 0, 0, 0 }; STARTUPINFOW si; int cr_flags; wchar_t *wcmdline = NULL; wchar_t *wpgmname = NULL; int ask_inherit = 0; gpg_err_code_t ec; int ret; ec = gnupg_access (pgmname, X_OK); if (ec) { xfree (process); xfree (cmdline); return ec; } if (spawn_cb) - { - struct spawn_cb_arg arg; - - arg.std_fds[0] = arg.std_fds[1] = arg.std_fds[2] = -1; - arg.arg = spawn_cb_arg; - - ask_inherit = (*spawn_cb) (&arg); - } + ask_inherit = (*spawn_cb) (spawn_cb_arg); /* Prepare security attributes. */ memset (&sec_attr, 0, sizeof sec_attr ); sec_attr.nLength = sizeof sec_attr; if (ask_inherit) sec_attr.bInheritHandle = TRUE; else sec_attr.bInheritHandle = FALSE; /* Start the process. */ memset (&si, 0, sizeof si); si.cb = sizeof (si); si.dwFlags = STARTF_USESHOWWINDOW; si.wShowWindow = DEBUG_W32_SPAWN? SW_SHOW : SW_MINIMIZE; cr_flags = (CREATE_DEFAULT_ERROR_MODE | GetPriorityClass (GetCurrentProcess ()) | CREATE_NEW_PROCESS_GROUP | DETACHED_PROCESS); log_debug ("CreateProcess(detached), path='%s' cmdline='%s'\n", pgmname, cmdline); /* Take care: CreateProcessW may modify wpgmname */ if (!(wpgmname = utf8_to_wchar (pgmname))) ret = 0; else if (!(wcmdline = utf8_to_wchar (cmdline))) ret = 0; else ret = CreateProcessW (wpgmname, /* Program to start. */ wcmdline, /* Command line arguments. */ &sec_attr, /* Process security attributes. */ &sec_attr, /* Thread security attributes. */ FALSE, /* Inherit handles. */ cr_flags, /* Creation flags. */ NULL, /* Environment. */ NULL, /* Use current drive/directory. */ &si, /* Startup information. */ &pi /* Returns process information. */ ); if (!ret) { if (!wpgmname || !wcmdline) log_error ("CreateProcess failed (utf8_to_wchar): %s\n", strerror (errno)); else log_error ("CreateProcess(detached) failed: %d\n", (int)GetLastError ()); xfree (wpgmname); xfree (wcmdline); xfree (cmdline); return GPG_ERR_GENERAL; } xfree (wpgmname); xfree (wcmdline); xfree (cmdline); log_debug ("CreateProcess(detached) ready: hProcess=%p hThread=%p" " dwProcessID=%d dwThreadId=%d\n", pi.hProcess, pi.hThread, (int) pi.dwProcessId, (int) pi.dwThreadId); CloseHandle (pi.hThread); CloseHandle (pi.hProcess); process->hProcess = INVALID_HANDLE_VALUE; process->hd_in = INVALID_HANDLE_VALUE; process->hd_out = INVALID_HANDLE_VALUE; process->hd_err = INVALID_HANDLE_VALUE; process->exitcode = -1; process->terminated = 1; return 0; } gpg_err_code_t gnupg_process_spawn (const char *pgmname, const char *argv[], unsigned int flags, - int (*spawn_cb) (struct spawn_cb_arg *), + int (*spawn_cb) (void *), void *spawn_cb_arg, gnupg_process_t *r_process) { gpg_err_code_t ec; gnupg_process_t process; SECURITY_ATTRIBUTES sec_attr; PROCESS_INFORMATION pi = { NULL, 0, 0, 0 }; STARTUPINFOW si; int cr_flags; char *cmdline; wchar_t *wcmdline = NULL; wchar_t *wpgmname = NULL; int ret; int ask_inherit = 0; HANDLE hd_in[2]; HANDLE hd_out[2]; HANDLE hd_err[2]; check_syscall_func (); *r_process = NULL; /* Build the command line. */ ec = build_w32_commandline (pgmname, argv, &cmdline); if (ec) return ec; process = xtrymalloc (sizeof (struct gnupg_process)); if (process == NULL) return gpg_err_code_from_syserror (); process->pgmname = pgmname; process->flags = flags; if ((flags & GNUPG_PROCESS_DETACHED)) { if ((flags & GNUPG_PROCESS_STDFDS_SETTING)) { xfree (process); xfree (cmdline); return GPG_ERR_INV_FLAG; } *r_process = process; return spawn_detached (process, pgmname, cmdline, spawn_cb, spawn_cb_arg); } if ((flags & GNUPG_PROCESS_STDINOUT_SOCKETPAIR)) { xfree (process); xfree (cmdline); return GPG_ERR_NOT_SUPPORTED; } if ((flags & GNUPG_PROCESS_STDIN_PIPE)) { ec = create_inheritable_pipe (hd_in, INHERIT_READ); if (ec) { xfree (process); xfree (cmdline); return ec; } } else if ((flags & GNUPG_PROCESS_STDIN_NULL)) { hd_in[0] = w32_open_null (0); hd_in[1] = INVALID_HANDLE_VALUE; } else { hd_in[0] = GetStdHandle (STD_INPUT_HANDLE); hd_in[1] = INVALID_HANDLE_VALUE; } if ((flags & GNUPG_PROCESS_STDOUT_PIPE)) { ec = create_inheritable_pipe (hd_out, INHERIT_WRITE); if (ec) { if (hd_in[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[0]); if (hd_in[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[1]); xfree (process); xfree (cmdline); return ec; } } else if ((flags & GNUPG_PROCESS_STDOUT_NULL)) { hd_out[0] = INVALID_HANDLE_VALUE; hd_out[1] = w32_open_null (1); } else { hd_out[0] = INVALID_HANDLE_VALUE; hd_out[1] = GetStdHandle (STD_OUTPUT_HANDLE); } if ((flags & GNUPG_PROCESS_STDERR_PIPE)) { ec = create_inheritable_pipe (hd_err, INHERIT_WRITE); if (ec) { if (hd_in[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[0]); if (hd_in[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[1]); if (hd_out[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_out[0]); if (hd_out[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_out[1]); xfree (process); xfree (cmdline); return ec; } } else if ((flags & GNUPG_PROCESS_STDERR_NULL)) { hd_err[0] = INVALID_HANDLE_VALUE; hd_err[1] = w32_open_null (1); } else { hd_err[0] = INVALID_HANDLE_VALUE; hd_err[1] = GetStdHandle (STD_ERROR_HANDLE); } if (spawn_cb) - { - struct spawn_cb_arg arg; - - arg.std_fds[0] = arg.std_fds[1] = arg.std_fds[2] = -1; - arg.arg = spawn_cb_arg; - - ask_inherit = (*spawn_cb) (&arg); - } + ask_inherit = (*spawn_cb) (spawn_cb_arg); /* Prepare security attributes. */ memset (&sec_attr, 0, sizeof sec_attr ); sec_attr.nLength = sizeof sec_attr; if (ask_inherit) sec_attr.bInheritHandle = TRUE; else sec_attr.bInheritHandle = FALSE; /* Start the process. */ memset (&si, 0, sizeof si); si.cb = sizeof (si); si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW; si.wShowWindow = DEBUG_W32_SPAWN? SW_SHOW : SW_HIDE; si.hStdInput = hd_in[0]; si.hStdOutput = hd_out[1]; si.hStdError = hd_err[1]; log_debug ("CreateProcess, path='%s' cmdline='%s'\n", pgmname, cmdline); cr_flags = (CREATE_DEFAULT_ERROR_MODE | GetPriorityClass (GetCurrentProcess ()) | CREATE_SUSPENDED); if (!(wpgmname = utf8_to_wchar (pgmname))) ret = 0; else if (!(wcmdline = utf8_to_wchar (cmdline))) ret = 0; else ret = CreateProcessW (wpgmname, /* Program to start. */ wcmdline, /* Command line arguments. */ &sec_attr, /* Process security attributes. */ &sec_attr, /* Thread security attributes. */ TRUE, /* Inherit handles. */ cr_flags, /* Creation flags. */ NULL, /* Environment. */ NULL, /* Use current drive/directory. */ &si, /* Startup information. */ &pi /* Returns process information. */ ); if (!ret) { if (!wpgmname || !wcmdline) log_error ("CreateProcess failed (utf8_to_wchar): %s\n", strerror (errno)); else log_error ("CreateProcess failed: ec=%d\n", (int)GetLastError ()); if (hd_in[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[0]); if (hd_in[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[1]); if (hd_out[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_out[0]); if (hd_out[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_out[1]); if (hd_err[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_err[0]); if (hd_err[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_err[1]); xfree (wpgmname); xfree (wcmdline); xfree (process); xfree (cmdline); return GPG_ERR_GENERAL; } xfree (wpgmname); xfree (wcmdline); xfree (cmdline); if (hd_in[0] != INVALID_HANDLE_VALUE) CloseHandle (hd_in[0]); if (hd_out[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_out[1]); if (hd_err[1] != INVALID_HANDLE_VALUE) CloseHandle (hd_err[1]); log_debug ("CreateProcess ready: hProcess=%p hThread=%p" " dwProcessID=%d dwThreadId=%d\n", pi.hProcess, pi.hThread, (int) pi.dwProcessId, (int) pi.dwThreadId); if ((flags & GNUPG_PROCESS_WINDOWS_ASFW)) { /* Fixme: For unknown reasons AllowSetForegroundWindow returns * an invalid argument error if we pass it the correct * processID. As a workaround we use -1 (ASFW_ANY). */ if (!AllowSetForegroundWindow (ASFW_ANY /*pi.dwProcessId*/)) log_info ("AllowSetForegroundWindow() failed: ec=%d\n", (int)GetLastError ()); } /* Process has been created suspended; resume it now. */ pre_syscall (); ResumeThread (pi.hThread); CloseHandle (pi.hThread); post_syscall (); process->hProcess = pi.hProcess; process->hd_in = hd_in[1]; process->hd_out = hd_out[0]; process->hd_err = hd_err[0]; process->exitcode = -1; process->terminated = 0; *r_process = process; return 0; } gpg_err_code_t gnupg_process_get_fds (gnupg_process_t process, unsigned int flags, int *r_fd_in, int *r_fd_out, int *r_fd_err) { (void)flags; if (r_fd_in) { *r_fd_in = _open_osfhandle ((intptr_t)process->hd_in, O_APPEND); process->hd_in = INVALID_HANDLE_VALUE; } if (r_fd_out) { *r_fd_out = _open_osfhandle ((intptr_t)process->hd_out, O_RDONLY); process->hd_out = INVALID_HANDLE_VALUE; } if (r_fd_err) { *r_fd_err = _open_osfhandle ((intptr_t)process->hd_err, O_RDONLY); process->hd_err = INVALID_HANDLE_VALUE; } return 0; } gpg_err_code_t gnupg_process_get_streams (gnupg_process_t process, unsigned int flags, estream_t *r_fp_in, estream_t *r_fp_out, estream_t *r_fp_err) { int nonblock = (flags & GNUPG_PROCESS_STREAM_NONBLOCK)? 1: 0; es_syshd_t syshd; syshd.type = ES_SYSHD_HANDLE; if (r_fp_in) { syshd.u.handle = process->hd_in; *r_fp_in = es_sysopen (&syshd, nonblock? "w,nonblock" : "w"); process->hd_in = INVALID_HANDLE_VALUE; } if (r_fp_out) { syshd.u.handle = process->hd_out; *r_fp_out = es_sysopen (&syshd, nonblock? "r,nonblock" : "r"); process->hd_out = INVALID_HANDLE_VALUE; } if (r_fp_err) { syshd.u.handle = process->hd_err; *r_fp_err = es_sysopen (&syshd, nonblock? "r,nonblock" : "r"); process->hd_err = INVALID_HANDLE_VALUE; } return 0; } static gpg_err_code_t process_kill (gnupg_process_t process, unsigned int exitcode) { gpg_err_code_t ec = 0; pre_syscall (); if (TerminateProcess (process->hProcess, exitcode)) ec = gpg_err_code_from_syserror (); post_syscall (); return ec; } static gpg_err_code_t process_vctl (gnupg_process_t process, unsigned int request, va_list arg_ptr) { switch (request) { case GNUPG_PROCESS_NOP: return 0; case GNUPG_PROCESS_GET_ID: { int *r_id = va_arg (arg_ptr, int *); if (r_id == NULL) return GPG_ERR_INV_VALUE; *r_id = (int)process->hProcess; return 0; } case GNUPG_PROCESS_GET_EXIT_ID: { int *r_exit_status = va_arg (arg_ptr, int *); unsigned long exit_code; *r_exit_status = -1; if (!process->terminated) return GPG_ERR_UNFINISHED; if (process->hProcess == INVALID_HANDLE_VALUE) return 0; if (GetExitCodeProcess (process->hProcess, &exit_code)) return gpg_err_code_from_syserror (); *r_exit_status = (int)exit_code; return 0; } case GNUPG_PROCESS_GET_P_HANDLE: { HANDLE *r_hProcess = va_arg (arg_ptr, HANDLE *); if (r_hProcess == NULL) return GPG_ERR_INV_VALUE; *r_hProcess = process->hProcess; process->hProcess = INVALID_HANDLE_VALUE; return 0; } case GNUPG_PROCESS_GET_HANDLES: { HANDLE *r_hd_in = va_arg (arg_ptr, HANDLE *); HANDLE *r_hd_out = va_arg (arg_ptr, HANDLE *); HANDLE *r_hd_err = va_arg (arg_ptr, HANDLE *); if (r_hd_in) { *r_hd_in = process->hd_in; process->hd_in = INVALID_HANDLE_VALUE; } if (r_hd_out) { *r_hd_out = process->hd_out; process->hd_out = INVALID_HANDLE_VALUE; } if (r_hd_err) { *r_hd_err = process->hd_err; process->hd_err = INVALID_HANDLE_VALUE; } return 0; } case GNUPG_PROCESS_GET_EXIT_CODE: { unsigned long *r_exitcode = va_arg (arg_ptr, unsigned long *); if (!process->terminated) return GPG_ERR_UNFINISHED; if (process->hProcess == INVALID_HANDLE_VALUE) { *r_exitcode = (unsigned long)-1; return 0; } if (GetExitCodeProcess (process->hProcess, r_exitcode)) return gpg_err_code_from_syserror (); return 0; } case GNUPG_PROCESS_KILL_WITH_EC: { unsigned int exitcode = va_arg (arg_ptr, unsigned int); if (process->terminated) return 0; if (process->hProcess == INVALID_HANDLE_VALUE) return 0; return process_kill (process, exitcode); } default: break; } return GPG_ERR_UNKNOWN_COMMAND; } gpg_err_code_t gnupg_process_ctl (gnupg_process_t process, unsigned int request, ...) { va_list arg_ptr; gpg_err_code_t ec; va_start (arg_ptr, request); ec = process_vctl (process, request, arg_ptr); va_end (arg_ptr); return ec; } gpg_err_code_t gnupg_process_wait (gnupg_process_t process, int hang) { gpg_err_code_t ec; int code; if (process->hProcess == INVALID_HANDLE_VALUE) return 0; pre_syscall (); code = WaitForSingleObject (process->hProcess, hang? INFINITE : 0); post_syscall (); switch (code) { case WAIT_TIMEOUT: ec = GPG_ERR_TIMEOUT; /* Still running. */ break; case WAIT_FAILED: log_error (_("waiting for process to terminate failed: ec=%d\n"), (int)GetLastError ()); ec = GPG_ERR_GENERAL; break; case WAIT_OBJECT_0: process->terminated = 1; ec = 0; break; default: log_debug ("WaitForSingleObject returned unexpected code %d\n", code); ec = GPG_ERR_GENERAL; break; } return ec; } gpg_err_code_t gnupg_process_terminate (gnupg_process_t process) { return process_kill (process, 1); } void gnupg_process_release (gnupg_process_t process) { if (process->terminated) gnupg_process_wait (process, 0); xfree (process); } gpg_err_code_t gnupg_process_wait_list (gnupg_process_t *process_list, int count, int hang) { gpg_err_code_t ec = 0; int i; for (i = 0; i < count; i++) { if (process_list[i]->terminated) continue; ec = gnupg_process_wait (process_list[i], hang); if (ec) break; } return ec; } diff --git a/common/exechelp.h b/common/exechelp.h index df0952e7d..69b085fca 100644 --- a/common/exechelp.h +++ b/common/exechelp.h @@ -1,299 +1,295 @@ /* exechelp.h - Definitions for the fork and exec helpers * Copyright (C) 2004, 2009, 2010 Free Software Foundation, Inc. * Copyright (C) 2004, 2006-2012, 2014-2017 g10 Code GmbH * * This file is part of GnuPG. * * This file is free software; you can redistribute it and/or modify * it under the terms of either * * - the GNU Lesser General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at * your option) any later version. * * or * * - the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at * your option) any later version. * * or both in parallel, as here. * * This file is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . * SPDX-License-Identifier: (LGPL-3.0+ OR GPL-2.0+) */ #ifndef GNUPG_COMMON_EXECHELP_H #define GNUPG_COMMON_EXECHELP_H /* Return the maximum number of currently allowed file descriptors. Only useful on POSIX systems. */ int get_max_fds (void); /* Close all file descriptors starting with descriptor FIRST. If EXCEPT is not NULL, it is expected to be a list of file descriptors which are not to close. This list shall be sorted in ascending order with its end marked by -1. */ void close_all_fds (int first, int *except); /* Returns an array with all currently open file descriptors. The end of the array is marked by -1. The caller needs to release this array using the *standard free* and not with xfree. This allow the use of this function right at startup even before libgcrypt has been initialized. Returns NULL on error and sets ERRNO accordingly. */ int *get_all_open_fds (void); /* Portable function to create a pipe. Under Windows the write end is inheritable. If R_FP is not NULL, an estream is created for the write end and stored at R_FP. */ gpg_error_t gnupg_create_inbound_pipe (int filedes[2], estream_t *r_fp, int nonblock); /* Portable function to create a pipe. Under Windows the read end is inheritable. If R_FP is not NULL, an estream is created for the write end and stored at R_FP. */ gpg_error_t gnupg_create_outbound_pipe (int filedes[2], estream_t *r_fp, int nonblock); /* Portable function to create a pipe. Under Windows both ends are inheritable. */ gpg_error_t gnupg_create_pipe (int filedes[2]); /* Close the end of a pipe. */ void gnupg_close_pipe (int fd); #define GNUPG_SPAWN_NONBLOCK 16 #define GNUPG_SPAWN_RUN_ASFW 64 #define GNUPG_SPAWN_DETACHED 128 #define GNUPG_SPAWN_KEEP_STDIN 256 #define GNUPG_SPAWN_KEEP_STDOUT 512 #define GNUPG_SPAWN_KEEP_STDERR 1024 /* Fork and exec the program PGMNAME. If R_INFP is NULL connect stdin of the new process to /dev/null; if it is not NULL store the address of a pointer to a new estream there. If R_OUTFP is NULL connect stdout of the new process to /dev/null; if it is not NULL store the address of a pointer to a new estream there. If R_ERRFP is NULL connect stderr of the new process to /dev/null; if it is not NULL store the address of a pointer to a new estream there. On success the pid of the new process is stored at PID. On error -1 is stored at PID and if R_OUTFP or R_ERRFP are not NULL, NULL is stored there. The arguments for the process are expected in the NULL terminated array ARGV. The program name itself should not be included there. If PREEXEC is not NULL, the given function will be called right before the exec. IF EXCEPT is not NULL, it is expected to be an ordered list of file descriptors, terminated by an entry with the value (-1). These file descriptors won't be closed before spawning a new program. Returns 0 on success or an error code. Calling gnupg_wait_process and gnupg_release_process is required if the function succeeded. FLAGS is a bit vector: GNUPG_SPAWN_NONBLOCK If set the two output streams are created in non-blocking mode and the input stream is switched to non-blocking mode. This is merely a convenience feature because the caller could do the same with gpgrt_set_nonblock. Does not yet work for Windows. GNUPG_SPAWN_DETACHED If set the process will be started as a background process. This flag is only useful under W32 (but not W32CE) systems, so that no new console is created and pops up a console window when starting the server. Does not work on W32CE. GNUPG_SPAWN_RUN_ASFW On W32 (but not on W32CE) run AllowSetForegroundWindow for the child. Note that due to unknown problems this actually allows SetForegroundWindow for all children of this process. GNUPG_SPAWN_KEEP_STDIN GNUPG_SPAWN_KEEP_STDOUT GNUPG_SPAWN_KEEP_STDERR Do not assign /dev/null to a non-required standard file descriptor. */ gpg_error_t gnupg_spawn_process (const char *pgmname, const char *argv[], int *execpt, unsigned int flags, estream_t *r_infp, estream_t *r_outfp, estream_t *r_errfp, pid_t *pid); /* Simplified version of gnupg_spawn_process. This function forks and then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout and ERRFD to stderr (any of them may be -1 to connect them to /dev/null). The arguments for the process are expected in the NULL terminated array ARGV. The program name itself should not be included there. Calling gnupg_wait_process and gnupg_release_process is required. Returns 0 on success or an error code. */ gpg_error_t gnupg_spawn_process_fd (const char *pgmname, const char *argv[], int infd, int outfd, int errfd, pid_t *pid); /* If HANG is true, waits for the process identified by PID to exit; if HANG is false, checks whether the process has terminated. PGMNAME should be the same as supplied to the spawn function and is only used for diagnostics. Return values: 0 The process exited successful. 0 is stored at R_EXITCODE. GPG_ERR_GENERAL The process exited without success. The exit code of process is then stored at R_EXITCODE. An exit code of -1 indicates that the process terminated abnormally (e.g. due to a signal). GPG_ERR_TIMEOUT The process is still running (returned only if HANG is false). GPG_ERR_INV_VALUE An invalid PID has been specified. Other error codes may be returned as well. Unless otherwise noted, -1 will be stored at R_EXITCODE. R_EXITCODE may be passed as NULL if the exit code is not required (in that case an error message will be printed). Note that under Windows PID is not the process id but the handle of the process. */ gpg_error_t gnupg_wait_process (const char *pgmname, pid_t pid, int hang, int *r_exitcode); /* Like gnupg_wait_process, but for COUNT processes. */ gpg_error_t gnupg_wait_processes (const char **pgmnames, pid_t *pids, size_t count, int hang, int *r_exitcodes); /* Kill a process; that is send an appropriate signal to the process. gnupg_wait_process must be called to actually remove the process from the system. An invalid PID is ignored. */ void gnupg_kill_process (pid_t pid); /* Release the process identified by PID. This function is actually only required for Windows but it does not harm to always call it. It is a nop if PID is invalid. */ void gnupg_release_process (pid_t pid); /* Spawn a new process and immediately detach from it. The name of the program to exec is PGMNAME and its arguments are in ARGV (the programname is automatically passed as first argument). Environment strings in ENVP are set. An error is returned if pgmname is not executable; to make this work it is necessary to provide an absolute file name. */ gpg_error_t gnupg_spawn_process_detached (const char *pgmname, const char *argv[], const char *envp[] ); /* The opaque type for a subprocess. */ typedef struct gnupg_process *gnupg_process_t; -struct spawn_cb_arg { - int std_fds[3]; - void *arg; -}; /* Internal flag to ihnerit file descriptor/handle */ #define GNUPG_PROCESS_INHERIT_FILE (1 << 0) #define GNUPG_PROCESS_DETACHED (1 << 1) /**/ #define GNUPG_PROCESS_WINDOWS_ASFW (1 << 7) /* Specify how to keep/connect standard fds. */ #define GNUPG_PROCESS_STDIN_PIPE (1 << 8) #define GNUPG_PROCESS_STDOUT_PIPE (1 << 9) #define GNUPG_PROCESS_STDERR_PIPE (1 << 10) #define GNUPG_PROCESS_STDINOUT_SOCKETPAIR (1 << 11) #define GNUPG_PROCESS_STDIN_NULL (1 << 12) #define GNUPG_PROCESS_STDOUT_NULL (1 << 13) #define GNUPG_PROCESS_STDERR_NULL (1 << 14) #define GNUPG_PROCESS_STDFDS_SETTING ( GNUPG_PROCESS_STDIN_PIPE \ | GNUPG_PROCESS_STDOUT_PIPE | GNUPG_PROCESS_STDERR_PIPE \ | GNUPG_PROCESS_STDINOUT_SOCKETPAIR | GNUPG_PROCESS_STDIN_NULL \ | GNUPG_PROCESS_STDOUT_NULL | GNUPG_PROCESS_STDERR_NULL) #define GNUPG_PROCESS_STREAM_NONBLOCK (1 << 16) /* Spawn PGMNAME. */ gpg_err_code_t gnupg_process_spawn (const char *pgmname, const char *argv[], unsigned int flags, - int (*spawn_cb) (struct spawn_cb_arg *), + int (*spawn_cb) (void *), void *spawn_cb_arg, gnupg_process_t *r_process); /* Get FDs for subprocess I/O. It is the caller which should care FDs (closing FDs). */ gpg_err_code_t gnupg_process_get_fds (gnupg_process_t process, unsigned int flags, int *r_fd_in, int *r_fd_out, int *r_fd_err); /* Get STREAMs for subprocess I/O. It is the caller which should care STREAMs (closing STREAMs). */ gpg_err_code_t gnupg_process_get_streams (gnupg_process_t process, unsigned int flags, gpgrt_stream_t *r_fp_in, gpgrt_stream_t *r_fp_out, gpgrt_stream_t *r_fp_err); enum gnupg_process_requests { /* Portable requests */ GNUPG_PROCESS_NOP = 0, GNUPG_PROCESS_GET_ID = 1, GNUPG_PROCESS_GET_EXIT_ID = 2, /* POSIX only */ GNUPG_PROCESS_GET_PID = 16, GNUPG_PROCESS_GET_WSTATUS = 17, GNUPG_PROCESS_KILL = 18, /* Windows only */ GNUPG_PROCESS_GET_P_HANDLE = 32, GNUPG_PROCESS_GET_HANDLES = 33, GNUPG_PROCESS_GET_EXIT_CODE = 34, GNUPG_PROCESS_KILL_WITH_EC = 35 }; /* Control of a process. */ gpg_err_code_t gnupg_process_ctl (gnupg_process_t process, unsigned int request, ...); /* Wait for a single PROCESS. */ gpg_err_code_t gnupg_process_wait (gnupg_process_t process, int hang); /* Terminate a PROCESS. */ gpg_err_code_t gnupg_process_terminate (gnupg_process_t process); /* Release PROCESS resources. */ void gnupg_process_release (gnupg_process_t process); /* Wait for a multiple processes. */ gpg_err_code_t gnupg_process_wait_list (gnupg_process_t *process_list, int count, int hang); #endif /*GNUPG_COMMON_EXECHELP_H*/ diff --git a/common/exectool.c b/common/exectool.c index 8eb68acaf..a09747d88 100644 --- a/common/exectool.c +++ b/common/exectool.c @@ -1,702 +1,678 @@ /* exectool.c - Utility functions to execute a helper tool * Copyright (C) 2015 Werner Koch * Copyright (C) 2016 g10 Code GmbH * * This file is part of GnuPG. * * This file is free software; you can redistribute it and/or modify * it under the terms of either * * - the GNU Lesser General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at * your option) any later version. * * or * * - the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at * your option) any later version. * * or both in parallel, as here. * * This file is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . */ #include #include #include #include #include #include #include #include #include #include "i18n.h" #include "logging.h" #include "membuf.h" #include "mischelp.h" #include "exechelp.h" #include "sysutils.h" #include "util.h" #include "exectool.h" typedef struct { const char *pgmname; exec_tool_status_cb_t status_cb; void *status_cb_value; int cont; int quiet; size_t used; size_t buffer_size; char *buffer; } read_and_log_buffer_t; static inline gpg_error_t my_error_from_syserror (void) { return gpg_err_make (default_errsource, gpg_err_code_from_syserror ()); } static void read_and_log_stderr (read_and_log_buffer_t *state, es_poll_t *fderr) { gpg_error_t err; int c; if (!fderr) { /* Flush internal buffer. */ if (state->used) { const char *pname; int len; state->buffer[state->used] = 0; state->used = 0; pname = strrchr (state->pgmname, '/'); if (pname && pname != state->pgmname && pname[1]) pname++; else pname = state->pgmname; len = strlen (pname); if (state->status_cb && !strncmp (state->buffer, "[GNUPG:] ", 9) && state->buffer[9] >= 'A' && state->buffer[9] <= 'Z') { char *rest; rest = strchr (state->buffer + 9, ' '); if (!rest) { /* Set REST to an empty string. */ rest = state->buffer + strlen (state->buffer); } else { *rest++ = 0; trim_spaces (rest); } state->status_cb (state->status_cb_value, state->buffer + 9, rest); } else if (state->quiet) ; else if (!state->cont && !strncmp (state->buffer, pname, len) && strlen (state->buffer) > strlen (pname) && state->buffer[len] == ':' ) { /* PGMNAME plus colon is identical to the start of the output: print only the output. */ log_info ("%s\n", state->buffer); } else log_info ("%s%c %s\n", pname, state->cont? '+':':', state->buffer); } state->cont = 0; return; } for (;;) { c = es_fgetc (fderr->stream); if (c == EOF) { if (es_feof (fderr->stream)) { fderr->ignore = 1; /* Not anymore needed. */ } else if (es_ferror (fderr->stream)) { err = my_error_from_syserror (); log_error ("error reading stderr of '%s': %s\n", state->pgmname, gpg_strerror (err)); fderr->ignore = 1; /* Disable. */ } break; } else if (c == '\n') { read_and_log_stderr (state, NULL); } else { if (state->used >= state->buffer_size - 1) { if (state->status_cb) { /* A status callback requires that we have a full * line. Thus we need to enlarget the buffer in * this case. */ char *newbuffer; size_t newsize = state->buffer_size + 256; newbuffer = xtrymalloc (newsize); if (!newbuffer) { log_error ("error allocating memory for status cb: %s\n", gpg_strerror (my_error_from_syserror ())); /* We better disable the status CB in this case. */ state->status_cb = NULL; read_and_log_stderr (state, NULL); state->cont = 1; } else { memcpy (newbuffer, state->buffer, state->used); xfree (state->buffer); state->buffer = newbuffer; state->buffer_size = newsize; } } else { read_and_log_stderr (state, NULL); state->cont = 1; } } state->buffer[state->used++] = c; } } } /* A buffer to copy from one stream to another. */ struct copy_buffer { char buffer[4096]; char *writep; size_t nread; }; /* Initialize a copy buffer. */ static void copy_buffer_init (struct copy_buffer *c) { c->writep = c->buffer; c->nread = 0; } /* Securely wipe a copy buffer. */ static void copy_buffer_shred (struct copy_buffer *c) { if (c == NULL) return; wipememory (c->buffer, sizeof c->buffer); c->writep = NULL; c->nread = ~0U; } /* Copy data from SOURCE to SINK using copy buffer C. */ static gpg_error_t copy_buffer_do_copy (struct copy_buffer *c, estream_t source, estream_t sink) { gpg_error_t err; size_t nwritten = 0; if (c->nread == 0) { c->writep = c->buffer; if (es_read (source, c->buffer, sizeof c->buffer, &c->nread)) { err = my_error_from_syserror (); if (gpg_err_code (err) == GPG_ERR_EAGAIN) return 0; /* We will just retry next time. */ return err; } log_assert (c->nread <= sizeof c->buffer); } if (c->nread == 0) return 0; /* Done copying. */ nwritten = 0; if (sink && es_write (sink, c->writep, c->nread, &nwritten)) err = my_error_from_syserror (); else err = 0; log_assert (nwritten <= c->nread); c->writep += nwritten; c->nread -= nwritten; log_assert (c->writep - c->buffer <= sizeof c->buffer); if (err) { if (gpg_err_code (err) == GPG_ERR_EAGAIN) return 0; /* We will just retry next time. */ return err; } if (sink && es_fflush (sink) && errno != EAGAIN) err = my_error_from_syserror (); return err; } /* Flush the remaining data to SINK. */ static gpg_error_t copy_buffer_flush (struct copy_buffer *c, estream_t sink) { gpg_error_t err = 0; size_t nwritten = 0; if (es_write (sink, c->writep, c->nread, &nwritten)) err = my_error_from_syserror (); log_assert (nwritten <= c->nread); c->writep += nwritten; c->nread -= nwritten; log_assert (c->writep - c->buffer <= sizeof c->buffer); if (err) return err; if (es_fflush (sink)) err = my_error_from_syserror (); return err; } static int -close_all_except (struct spawn_cb_arg *arg) +close_all_except (void *arg) { - int except[32]; - int i = 0; - int fd_in = arg->std_fds[0]; - int fd_out = arg->std_fds[1]; - int fd_err = arg->std_fds[2]; - int *exceptclose = arg->arg; - - if (fd_in >= 0) - except[i++] = fd_in; - if (fd_out >= 0) - except[i++] = fd_out; - if (fd_err >= 0) - except[i++] = fd_err; - - for (; i < 31; i++) - { - int fd = *exceptclose++; - - if (fd < 0) - break; - else - except[i] = fd; - } - - except[i++] = -1; + int *exceptclose = arg; - close_all_fds (3, except); + close_all_fds (3, exceptclose); return 1; } /* Run the program PGMNAME with the command line arguments given in * the NULL terminates array ARGV. If INPUT is not NULL it will be * fed to stdin of the process. stderr is logged using log_info and * the process's stdout is written to OUTPUT. If OUTPUT is NULL the * output is discarded. If INEXTRA is given, an additional input * stream will be passed to the child; to tell the child about this * ARGV is scanned and the first occurrence of an argument * "-&@INEXTRA@" is replaced by the concatenation of "-&" and the * child's file descriptor of the pipe created for the INEXTRA stream. * * On error a diagnostic is printed and an error code returned. */ gpg_error_t gnupg_exec_tool_stream (const char *pgmname, const char *argv[], estream_t input, estream_t inextra, estream_t output, exec_tool_status_cb_t status_cb, void *status_cb_value) { gpg_error_t err; gnupg_process_t proc = NULL; estream_t infp = NULL; estream_t extrafp = NULL; estream_t outfp = NULL, errfp = NULL; es_poll_t fds[4]; int exceptclose[2]; int extrapipe[2] = {-1, -1}; char extrafdbuf[20]; const char *argsave = NULL; int argsaveidx; int count; read_and_log_buffer_t fderrstate; struct copy_buffer *cpbuf_in = NULL, *cpbuf_out = NULL, *cpbuf_extra = NULL; int quiet = 0; memset (fds, 0, sizeof fds); memset (&fderrstate, 0, sizeof fderrstate); /* If the first argument to the program is "--quiet" avoid all extra * diagnostics. */ quiet = (argv && argv[0] && !strcmp (argv[0], "--quiet")); cpbuf_in = xtrymalloc (sizeof *cpbuf_in); if (cpbuf_in == NULL) { err = my_error_from_syserror (); goto leave; } copy_buffer_init (cpbuf_in); cpbuf_out = xtrymalloc (sizeof *cpbuf_out); if (cpbuf_out == NULL) { err = my_error_from_syserror (); goto leave; } copy_buffer_init (cpbuf_out); cpbuf_extra = xtrymalloc (sizeof *cpbuf_extra); if (cpbuf_extra == NULL) { err = my_error_from_syserror (); goto leave; } copy_buffer_init (cpbuf_extra); fderrstate.pgmname = pgmname; fderrstate.quiet = quiet; fderrstate.status_cb = status_cb; fderrstate.status_cb_value = status_cb_value; fderrstate.buffer_size = 256; fderrstate.buffer = xtrymalloc (fderrstate.buffer_size); if (!fderrstate.buffer) { err = my_error_from_syserror (); goto leave; } if (inextra) { err = gnupg_create_outbound_pipe (extrapipe, &extrafp, 1); if (err) { log_error ("error creating outbound pipe for extra fp: %s\n", gpg_strerror (err)); goto leave; } exceptclose[0] = extrapipe[0]; /* Do not close in child. */ exceptclose[1] = -1; /* Now find the argument marker and replace by the pipe's fd. Yeah, that is an ugly non-thread safe hack but it safes us to create a copy of the array. */ #ifdef HAVE_W32_SYSTEM snprintf (extrafdbuf, sizeof extrafdbuf, "-&%lu", (unsigned long)_get_osfhandle (extrapipe[0])); #else snprintf (extrafdbuf, sizeof extrafdbuf, "-&%d", extrapipe[0]); #endif for (argsaveidx=0; argv[argsaveidx]; argsaveidx++) if (!strcmp (argv[argsaveidx], "-&@INEXTRA@")) { argsave = argv[argsaveidx]; argv[argsaveidx] = extrafdbuf; break; } } else exceptclose[0] = -1; err = gnupg_process_spawn (pgmname, argv, ((input ? GNUPG_PROCESS_STDIN_PIPE : GNUPG_PROCESS_STDIN_NULL) | GNUPG_PROCESS_STDOUT_PIPE | GNUPG_PROCESS_STDERR_PIPE), close_all_except, exceptclose, &proc); gnupg_process_get_streams (proc, GNUPG_PROCESS_STREAM_NONBLOCK, input? &infp : NULL, &outfp, &errfp); if (extrapipe[0] != -1) close (extrapipe[0]); if (argsave) argv[argsaveidx] = argsave; if (err) { if (!quiet) log_error ("error running '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } fds[0].stream = infp; fds[0].want_write = 1; if (!input) fds[0].ignore = 1; fds[1].stream = outfp; fds[1].want_read = 1; fds[2].stream = errfp; fds[2].want_read = 1; fds[3].stream = extrafp; fds[3].want_write = 1; if (!inextra) fds[3].ignore = 1; /* Now read as long as we have something to poll. We continue reading even after EOF or error on stdout so that we get the other error messages or remaining output. */ while (! (fds[1].ignore && fds[2].ignore)) { count = es_poll (fds, DIM(fds), -1); if (count == -1) { err = my_error_from_syserror (); log_error ("error polling '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } if (!count) { log_debug ("unexpected timeout while polling '%s'\n", pgmname); break; } if (fds[0].got_write) { err = copy_buffer_do_copy (cpbuf_in, input, fds[0].stream); if (err) { log_error ("error feeding data to '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } if (es_feof (input)) { err = copy_buffer_flush (cpbuf_in, fds[0].stream); if (gpg_err_code (err) == GPG_ERR_EAGAIN) continue; /* Retry next time. */ if (err) { log_error ("error feeding data to '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } fds[0].ignore = 1; /* ready. */ es_fclose (infp); infp = NULL; } } if (fds[3].got_write) { log_assert (inextra); err = copy_buffer_do_copy (cpbuf_extra, inextra, fds[3].stream); if (err) { log_error ("error feeding data to '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } if (es_feof (inextra)) { err = copy_buffer_flush (cpbuf_extra, fds[3].stream); if (gpg_err_code (err) == GPG_ERR_EAGAIN) continue; /* Retry next time. */ if (err) { log_error ("error feeding data to '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } fds[3].ignore = 1; /* ready. */ es_fclose (extrafp); extrafp = NULL; } } if (fds[1].got_read) { err = copy_buffer_do_copy (cpbuf_out, fds[1].stream, output); if (err) { log_error ("error reading data from '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } if (es_feof (fds[1].stream)) { err = copy_buffer_flush (cpbuf_out, output); if (err) { log_error ("error reading data from '%s': %s\n", pgmname, gpg_strerror (err)); goto leave; } fds[1].ignore = 1; /* ready. */ } } if (fds[2].got_read) read_and_log_stderr (&fderrstate, fds + 2); } read_and_log_stderr (&fderrstate, NULL); /* Flush. */ es_fclose (infp); infp = NULL; es_fclose (extrafp); extrafp = NULL; es_fclose (outfp); outfp = NULL; es_fclose (errfp); errfp = NULL; err = gnupg_process_wait (proc, 1); if (!err) { /* To be compatible to old wait_process. */ int status; gnupg_process_ctl (proc, GNUPG_PROCESS_GET_EXIT_ID, &status); if (status) err = gpg_error (GPG_ERR_GENERAL); } leave: if (err && proc) gnupg_process_terminate (proc); es_fclose (infp); es_fclose (extrafp); es_fclose (outfp); es_fclose (errfp); gnupg_process_release (proc); copy_buffer_shred (cpbuf_in); xfree (cpbuf_in); copy_buffer_shred (cpbuf_out); xfree (cpbuf_out); copy_buffer_shred (cpbuf_extra); xfree (cpbuf_extra); xfree (fderrstate.buffer); return err; } /* A dummy free function to pass to 'es_mopen'. */ static void nop_free (void *ptr) { (void) ptr; } /* Run the program PGMNAME with the command line arguments given in the NULL terminates array ARGV. If INPUT_STRING is not NULL it will be fed to stdin of the process. stderr is logged using log_info and the process's stdout is returned in a newly malloced buffer RESULT with the length stored at RESULTLEN if not given as NULL. A hidden Nul is appended to the output. On error NULL is stored at RESULT, a diagnostic is printed, and an error code returned. */ gpg_error_t gnupg_exec_tool (const char *pgmname, const char *argv[], const char *input_string, char **result, size_t *resultlen) { gpg_error_t err; estream_t input = NULL; estream_t output; size_t len; size_t nread; *result = NULL; if (resultlen) *resultlen = 0; if (input_string) { len = strlen (input_string); input = es_mopen ((char *) input_string, len, len, 0 /* don't grow */, NULL, nop_free, "rb"); if (! input) return my_error_from_syserror (); } output = es_fopenmem (0, "wb"); if (! output) { err = my_error_from_syserror (); goto leave; } err = gnupg_exec_tool_stream (pgmname, argv, input, NULL, output, NULL, NULL); if (err) goto leave; len = es_ftello (output); err = es_fseek (output, 0, SEEK_SET); if (err) goto leave; *result = xtrymalloc (len + 1); if (!*result) { err = my_error_from_syserror (); goto leave; } if (len) { if (es_read (output, *result, len, &nread)) { err = my_error_from_syserror (); goto leave; } if (nread != len) log_fatal ("%s: short read from memstream\n", __func__); } (*result)[len] = 0; if (resultlen) *resultlen = len; leave: es_fclose (input); es_fclose (output); if (err) { xfree (*result); *result = NULL; } return err; }