lib/roken/simple_exec_w32.c

   1 /***********************************************************************
   2  * Copyright (c) 2009, Secure Endpoints Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  28  * OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  **********************************************************************/
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include <config.h>
  34 RCSID("$Id$");
  35 #endif
  36
  37 #include <roken.h>
  38 #include <strsafe.h>
  39
  40 #ifndef _WIN32
  41 #error This implementation is Windows specific.
  42 #endif
  43
  44 /**
  45  * wait_for_process_timed waits for a process to terminate or until a
  46  * specified timeout occurs.
  47  *
  48  * @param[in] pid Process id for the monitored process
  49
  50  * @param[in] func Timeout callback function.  When the wait times out,
  51  *     the callback function is called.  The possible return values
  52  *     from the callback function are:
  53  *
  54  * - ((time_t) -2) Exit loop without killing child and return SE_E_EXECTIMEOUT.
  55  * - ((time_t) -1) Kill child with SIGTERM and wait for child to exit.
  56  * - 0             Don't timeout again
  57  * - n             Seconds to next timeout
  58  *
  59  * @param[in] ptr Optional parameter for func()
  60  *
  61  * @param[in] timeout Seconds to first timeout.
  62  *
  63  * @retval SE_E_UNSPECIFIED   Unspecified system error
  64  * @retval SE_E_FORKFAILED    Fork failure (not applicable for _WIN32 targets)
  65  * @retval SE_E_WAITPIDFAILED waitpid errors
  66  * @retval SE_E_EXECTIMEOUT   exec timeout
  67  * @retval 0 <= Return value  from subprocess
  68  * @retval SE_E_NOTFOUND      The program coudln't be found
  69  * @retval 128- The signal that killed the subprocess +128.
  70  */
  71 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
  72 wait_for_process_timed(pid_t pid, time_t (*func)(void *),
  73                        void *ptr, time_t timeout)
  74 {
  75     HANDLE hProcess;
  76     DWORD wrv = 0;
  77     DWORD dtimeout;
  78     int rv = 0;
  79
  80     hProcess = OpenProcess(SYNCHRONIZE, FALSE, pid);
  81
  82     if (hProcess == NULL) {
  83         return SE_E_WAITPIDFAILED;
  84     }
  85
  86     dtimeout = (DWORD) ((timeout == 0)? INFINITE: timeout * 1000);
  87
  88     do {
  89         wrv = WaitForSingleObject(hProcess, dtimeout);
  90
  91         if (wrv == WAIT_OBJECT_0) {
  92
  93             DWORD prv = 0;
  94
  95             GetExitCodeProcess(hProcess, &prv);
  96             rv = (int) prv;
  97             break;
  98
  99         } else if (wrv == WAIT_TIMEOUT) {
 100
 101             if (func == NULL)
 102                 continue;
 103
 104             timeout = (*func)(ptr);
 105
 106             if (timeout == (time_t)-1) {
 107
 108                 if (TerminateProcess(hProcess, 128 + 9)) {
 109                     dtimeout = INFINITE;
 110                     continue;
 111                 }
 112                 rv = SE_E_UNSPECIFIED;
 113                 break;
 114
 115             } else if (timeout == (time_t) -2) {
 116
 117                 rv = SE_E_EXECTIMEOUT;
 118                 break;
 119
 120             } else {
 121
 122                 dtimeout = (DWORD) ((timeout == 0)? INFINITE: timeout * 1000);
 123                 continue;
 124
 125             }
 126
 127         } else {
 128
 129             rv = SE_E_UNSPECIFIED;
 130             break;
 131
 132         }
 133
 134     } while(TRUE);
 135
 136     CloseHandle(hProcess);
 137
 138     return rv;
 139 }
 140
 141 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 142 wait_for_process(pid_t pid)
 143 {
 144     return wait_for_process_timed(pid, NULL, NULL, 0);
 145 }
 146
 147 static char *
 148 collect_commandline(const char * fn, va_list * ap)
 149 {
 150     size_t len = 0;
 151     size_t alloc_len = 0;
 152     const char * s;
 153     char * cmd = NULL;
 154
 155     for (s = fn; s; s = (char *) va_arg(*ap, char *)) {
 156         size_t cmp_len;
 157         int need_quote = FALSE;
 158
 159         if (FAILED(StringCchLength(s, MAX_PATH, &cmp_len))) {
 160             if (cmd)
 161                 free(cmd);
 162             return NULL;
 163         }
 164
 165         if (cmp_len == 0)
 166             continue;
 167
 168         if (strchr(s, ' ') &&   /* need to quote any component that
 169                                    has embedded spaces, but not if
 170                                    they are already quoted. */
 171             s[0] != '"' &&
 172             s[cmp_len - 1] != '"') {
 173             need_quote = TRUE;
 174             cmp_len += 2 * sizeof(char);
 175         }
 176
 177         if (s != fn)
 178             cmp_len += 1 * sizeof(char);
 179
 180         if (alloc_len < len + cmp_len + 1) {
 181             char * nc;
 182
 183             alloc_len += ((len + cmp_len - alloc_len) / MAX_PATH + 1) * MAX_PATH;
 184             nc = (char *) realloc(cmd, alloc_len * sizeof(char));
 185             if (nc == NULL) {
 186                 if (cmd)
 187                     free(cmd);
 188                 return NULL;
 189             }
 190         }
 191
 192         if (cmd == NULL)
 193             return NULL;
 194
 195         if (s != fn)
 196             cmd[len++] = ' ';
 197
 198         if (need_quote) {
 199             StringCchPrintf(cmd + len, alloc_len - len, "\"%s\"", s);
 200         } else {
 201             StringCchCopy(cmd + len, alloc_len - len, s);
 202         }
 203
 204         len += cmp_len;
 205     }
 206
 207     return cmd;
 208 }
 209
 210 ROKEN_LIB_FUNCTION pid_t ROKEN_LIB_CALL
 211 pipe_execv(FILE **stdin_fd, FILE **stdout_fd, FILE **stderr_fd,
 212            const char *file, ...)
 213 {
 214     HANDLE  hOut_r = NULL;
 215     HANDLE  hOut_w = NULL;
 216     HANDLE  hIn_r  = NULL;
 217     HANDLE  hIn_w  = NULL;
 218     HANDLE  hErr_r = NULL;
 219     HANDLE  hErr_w = NULL;
 220
 221     SECURITY_ATTRIBUTES sa;
 222     STARTUPINFO si;
 223     PROCESS_INFORMATION pi;
 224
 225     char * commandline = NULL;
 226
 227     pid_t rv = (pid_t) -1;
 228
 229     {
 230         va_list ap;
 231
 232         va_start(ap, file);
 233         commandline = collect_commandline(file, &ap);
 234
 235         if (commandline == NULL)
 236             return rv;
 237     }
 238
 239     ZeroMemory(&si, sizeof(si));
 240     ZeroMemory(&pi, sizeof(pi));
 241     ZeroMemory(&sa, sizeof(sa));
 242
 243     pi.hProcess = NULL;
 244     pi.hThread = NULL;
 245
 246     sa.nLength = sizeof(sa);
 247     sa.bInheritHandle = TRUE;
 248     sa.lpSecurityDescriptor = NULL;
 249
 250     if ((stdout_fd && !CreatePipe(&hOut_r, &hOut_w, &sa, 0 /* Use default */)) ||
 251
 252         (stdin_fd && !CreatePipe(&hIn_r, &hIn_w, &sa, 0)) ||
 253
 254         (stderr_fd && !CreatePipe(&hErr_r, &hErr_w, &sa, 0)) ||
 255
 256         (!stdout_fd && (hOut_w = CreateFile("CON", GENERIC_WRITE, FILE_SHARE_READ|FILE_SHARE_WRITE,
 257                                             &sa, OPEN_EXISTING, 0, NULL)) == INVALID_HANDLE_VALUE) ||
 258
 259         (!stdin_fd && (hIn_r = CreateFile("CON",GENERIC_READ, FILE_SHARE_READ|FILE_SHARE_WRITE,
 260                                           &sa, OPEN_EXISTING, 0, NULL)) == INVALID_HANDLE_VALUE) ||
 261
 262         (!stderr_fd && (hErr_w = CreateFile("CON", GENERIC_WRITE, FILE_SHARE_READ|FILE_SHARE_WRITE,
 263                                             &sa, OPEN_EXISTING, 0, NULL)) == INVALID_HANDLE_VALUE))
 264
 265         goto _exit;
 266
 267     /* We don't want the child processes inheriting these */
 268     if (hOut_r)
 269         SetHandleInformation(hOut_r, HANDLE_FLAG_INHERIT, FALSE);
 270
 271     if (hIn_w)
 272         SetHandleInformation(hIn_w, HANDLE_FLAG_INHERIT, FALSE);
 273
 274     if (hErr_r)
 275         SetHandleInformation(hErr_r, HANDLE_FLAG_INHERIT, FALSE);
 276
 277     si.cb = sizeof(si);
 278     si.lpReserved = NULL;
 279     si.lpDesktop = NULL;
 280     si.lpTitle = NULL;
 281     si.dwFlags = STARTF_USESTDHANDLES;
 282     si.hStdInput = hIn_r;
 283     si.hStdOutput = hOut_w;
 284     si.hStdError = hErr_w;
 285
 286     if (!CreateProcess(file, commandline, NULL, NULL,
 287                        TRUE,    /* bInheritHandles */
 288                        CREATE_NO_WINDOW, /* dwCreationFlags */
 289                        NULL,             /* lpEnvironment */
 290                        NULL,             /* lpCurrentDirectory */
 291                        &si,
 292                        &pi)) {
 293
 294         rv = (pid_t) (GetLastError() == ERROR_FILE_NOT_FOUND)? 127 : -1;
 295         goto _exit;
 296     }
 297
 298     if (stdin_fd) {
 299         *stdin_fd = _fdopen(_open_osfhandle((intptr_t) hIn_w, 0), "wb");
 300         if (*stdin_fd)
 301             hIn_w = NULL;
 302     }
 303
 304     if (stdout_fd) {
 305         *stdout_fd = _fdopen(_open_osfhandle((intptr_t) hOut_r, _O_RDONLY), "rb");
 306         if (*stdout_fd)
 307             hOut_r = NULL;
 308     }
 309
 310     if (stderr_fd) {
 311         *stderr_fd = _fdopen(_open_osfhandle((intptr_t) hErr_r, _O_RDONLY), "rb");
 312         if (*stderr_fd)
 313             hErr_r = NULL;
 314     }
 315
 316     rv = (pid_t) pi.dwProcessId;
 317
 318  _exit:
 319
 320     if (pi.hProcess) CloseHandle(pi.hProcess);
 321
 322     if (pi.hThread) CloseHandle(pi.hThread);
 323
 324     if (hIn_r) CloseHandle(hIn_r);
 325
 326     if (hIn_w) CloseHandle(hIn_w);
 327
 328     if (hOut_r) CloseHandle(hOut_r);
 329
 330     if (hOut_w) CloseHandle(hOut_w);
 331
 332     if (hErr_r) CloseHandle(hErr_r);
 333
 334     if (hErr_w) CloseHandle(hErr_w);
 335
 336     return rv;
 337 }
 338
 339
 340 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 341 simple_execvp_timed(const char *file, char *const args[],
 342                     time_t (*func)(void *), void *ptr, time_t timeout)
 343 {
 344     intptr_t hp;
 345     int rv;
 346
 347     hp = spawnvp(_P_NOWAIT, file, args);
 348
 349     if (hp == -1)
 350         return (errno == ENOENT)? 127: 126;
 351     else if (hp == 0)
 352         return 0;
 353
 354     rv = wait_for_process_timed(GetProcessId((HANDLE) hp), func, ptr, timeout);
 355
 356     CloseHandle((HANDLE) hp);
 357
 358     return rv;
 359 }
 360
 361
 362 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 363 simple_execvp(const char *file, char *const args[])
 364 {
 365     return simple_execvp_timed(file, args, NULL, NULL, 0);
 366 }
 367
 368
 369 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 370 simple_execve_timed(const char *file, char *const args[], char *const envp[],
 371                     time_t (*func)(void *), void *ptr, time_t timeout)
 372 {
 373     intptr_t hp;
 374     int rv;
 375
 376     hp = spawnve(_P_NOWAIT, file, args, envp);
 377
 378     if (hp == -1)
 379         return (errno == ENOENT)? 127: 126;
 380     else if (hp == 0)
 381         return 0;
 382
 383     rv = wait_for_process_timed(GetProcessId((HANDLE) hp), func, ptr, timeout);
 384
 385     CloseHandle((HANDLE) hp);
 386
 387     return rv;
 388 }
 389
 390
 391 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 392 simple_execve(const char *file, char *const args[], char *const envp[])
 393 {
 394     return simple_execve_timed(file, args, envp, NULL, NULL, 0);
 395 }
 396
 397
 398 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 399 simple_execlp(const char *file, ...)
 400 {
 401     va_list ap;
 402     char **argv;
 403     int ret;
 404
 405     va_start(ap, file);
 406     argv = vstrcollect(&ap);
 407     va_end(ap);
 408     if(argv == NULL)
 409         return SE_E_UNSPECIFIED;
 410     ret = simple_execvp(file, argv);
 411     free(argv);
 412     return ret;
 413 }
 414
 415
 416 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 417 simple_execle(const char *file, ... /* ,char *const envp[] */)
 418 {
 419     va_list ap;
 420     char **argv;
 421     char *const* envp;
 422     int ret;
 423
 424     va_start(ap, file);
 425     argv = vstrcollect(&ap);
 426     envp = va_arg(ap, char **);
 427     va_end(ap);
 428     if(argv == NULL)
 429         return SE_E_UNSPECIFIED;
 430     ret = simple_execve(file, argv, envp);
 431     free(argv);
 432     return ret;
 433 }