Reorganized the exechelp code.
[gnupg.git] / common / exechelp-posix.c
1 /* exechelp.c - Fork and exec helpers for POSIX
2  * Copyright (C) 2004, 2007, 2008, 2009,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22
23 #if defined(HAVE_W32_SYSTEM) || defined (HAVE_W32CE_SYSTEM)
24 #error This code is only used on POSIX
25 #endif
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <errno.h>
31 #include <assert.h>
32 #ifdef HAVE_SIGNAL_H
33 # include <signal.h>
34 #endif
35 #include <unistd.h> 
36 #include <fcntl.h>
37
38 #ifdef WITHOUT_GNU_PTH /* Give the Makefile a chance to build without Pth.  */
39 #undef HAVE_PTH
40 #undef USE_GNU_PTH
41 #endif
42
43 #ifdef USE_GNU_PTH      
44 #include <pth.h>
45 #endif
46 #include <sys/wait.h>
47
48 #ifdef HAVE_GETRLIMIT
49 #include <sys/time.h>
50 #include <sys/resource.h>
51 #endif /*HAVE_GETRLIMIT*/
52
53 #ifdef HAVE_STAT
54 # include <sys/stat.h>
55 #endif
56
57 #include "util.h"
58 #include "i18n.h"
59 #include "sysutils.h"
60 #include "exechelp.h"
61
62
63 /* We have the usual problem here: Some modules are linked against pth
64    and some are not.  However we want to use pth_fork and pth_waitpid
65    here. Using a weak symbol works but is not portable - we should
66    provide a an explicit dummy pth module instead of using the
67    pragma.  */ 
68 #pragma weak pth_fork
69 #pragma weak pth_waitpid
70
71
72 /* Return the maximum number of currently allowed open file
73    descriptors.  Only useful on POSIX systems but returns a value on
74    other systems too.  */
75 int
76 get_max_fds (void)
77 {
78   int max_fds = -1;
79 #ifdef HAVE_GETRLIMIT
80   struct rlimit rl;
81
82 # ifdef RLIMIT_NOFILE
83   if (!getrlimit (RLIMIT_NOFILE, &rl))
84     max_fds = rl.rlim_max;
85 # endif
86
87 # ifdef RLIMIT_OFILE
88   if (max_fds == -1 && !getrlimit (RLIMIT_OFILE, &rl))
89     max_fds = rl.rlim_max;
90
91 # endif
92 #endif /*HAVE_GETRLIMIT*/
93
94 #ifdef _SC_OPEN_MAX
95   if (max_fds == -1)
96     {
97       long int scres = sysconf (_SC_OPEN_MAX);
98       if (scres >= 0)
99         max_fds = scres;
100     }
101 #endif
102
103 #ifdef _POSIX_OPEN_MAX
104   if (max_fds == -1)
105     max_fds = _POSIX_OPEN_MAX;
106 #endif
107
108 #ifdef OPEN_MAX
109   if (max_fds == -1)
110     max_fds = OPEN_MAX;
111 #endif
112
113   if (max_fds == -1)
114     max_fds = 256;  /* Arbitrary limit.  */
115
116   return max_fds;
117 }
118
119
120 /* Close all file descriptors starting with descriptor FIRST.  If
121    EXCEPT is not NULL, it is expected to be a list of file descriptors
122    which shall not be closed.  This list shall be sorted in ascending
123    order with the end marked by -1.  */
124 void
125 close_all_fds (int first, int *except)
126 {
127   int max_fd = get_max_fds ();
128   int fd, i, except_start;
129
130   if (except)
131     {
132       except_start = 0;
133       for (fd=first; fd < max_fd; fd++)
134         {
135           for (i=except_start; except[i] != -1; i++)
136             {
137               if (except[i] == fd)
138                 {
139                   /* If we found the descriptor in the exception list
140                      we can start the next compare run at the next
141                      index because the exception list is ordered.  */
142                 except_start = i + 1;
143                 break;
144                 }
145             }
146           if (except[i] == -1)
147             close (fd);
148         }
149     }
150   else
151     {
152       for (fd=first; fd < max_fd; fd++)
153         close (fd);
154     }
155
156   gpg_err_set_errno (0);
157 }
158
159
160 /* Returns an array with all currently open file descriptors.  The end
161    of the array is marked by -1.  The caller needs to release this
162    array using the *standard free* and not with xfree.  This allow the
163    use of this fucntion right at startup even before libgcrypt has
164    been initialized.  Returns NULL on error and sets ERRNO
165    accordingly.  */
166 int *
167 get_all_open_fds (void)
168 {
169   int *array;
170   size_t narray;
171   int fd, max_fd, idx;
172 #ifndef HAVE_STAT
173   array = calloc (1, sizeof *array);
174   if (array)
175     array[0] = -1;
176 #else /*HAVE_STAT*/
177   struct stat statbuf;
178
179   max_fd = get_max_fds ();
180   narray = 32;  /* If you change this change also t-exechelp.c.  */
181   array = calloc (narray, sizeof *array);
182   if (!array)
183     return NULL;
184   
185   /* Note:  The list we return is ordered.  */
186   for (idx=0, fd=0; fd < max_fd; fd++)
187     if (!(fstat (fd, &statbuf) == -1 && errno == EBADF))
188       {
189         if (idx+1 >= narray)
190           {
191             int *tmp;
192
193             narray += (narray < 256)? 32:256;
194             tmp = realloc (array, narray * sizeof *array);
195             if (!tmp)
196               {
197                 free (array);
198                 return NULL;
199               }
200             array = tmp;
201           }
202         array[idx++] = fd;
203       }
204   array[idx] = -1;
205 #endif /*HAVE_STAT*/
206   return array;
207 }
208
209
210 /* The exec core used right after the fork. This will never return. */
211 static void
212 do_exec (const char *pgmname, const char *argv[],
213          int fd_in, int fd_out, int fd_err,
214          void (*preexec)(void) )
215 {
216   char **arg_list;
217   int i, j;
218   int fds[3];
219
220   fds[0] = fd_in;
221   fds[1] = fd_out;
222   fds[2] = fd_err;
223
224   /* Create the command line argument array.  */
225   i = 0;
226   if (argv)
227     while (argv[i])
228       i++;
229   arg_list = xcalloc (i+2, sizeof *arg_list);
230   arg_list[0] = strrchr (pgmname, '/');
231   if (arg_list[0])
232     arg_list[0]++;
233   else
234     arg_list[0] = xstrdup (pgmname);
235   if (argv)
236     for (i=0,j=1; argv[i]; i++, j++)
237       arg_list[j] = (char*)argv[i];
238
239   /* Assign /dev/null to unused FDs. */
240   for (i=0; i <= 2; i++)
241     {
242       if (fds[i] == -1 )
243         {
244           fds[i] = open ("/dev/null", i? O_WRONLY : O_RDONLY);
245           if (fds[i] == -1)
246             log_fatal ("failed to open `%s': %s\n",
247                        "/dev/null", strerror (errno));
248         }
249     }
250
251   /* Connect the standard files.  */
252   for (i=0; i <= 2; i++)
253     {
254       if (fds[i] != i && dup2 (fds[i], i) == -1)
255         log_fatal ("dup2 std%s failed: %s\n",
256                    i==0?"in":i==1?"out":"err", strerror (errno));
257     }
258
259   /* Close all other files. */
260   close_all_fds (3, NULL);
261   
262   if (preexec)
263     preexec ();
264   execv (pgmname, arg_list);
265   /* No way to print anything, as we have closed all streams. */
266   _exit (127);
267 }
268
269
270 static gpg_error_t
271 do_create_pipe (int filedes[2])
272 {
273   gpg_error_t err = 0;
274
275   if (pipe (filedes) == -1)
276     {
277       err = gpg_error_from_syserror ();
278       filedes[0] = filedes[1] = -1;
279     }
280
281   return err;
282 }
283
284 /* Portable function to create a pipe.  Under Windows the write end is
285    inheritable.  */
286 gpg_error_t
287 gnupg_create_inbound_pipe (int filedes[2])
288 {
289   return do_create_pipe (filedes);
290 }
291
292
293 /* Portable function to create a pipe.  Under Windows the read end is
294    inheritable.  */
295 gpg_error_t
296 gnupg_create_outbound_pipe (int filedes[2])
297 {
298   return do_create_pipe (filedes);
299 }
300
301
302 /* Fork and exec the PGMNAME, connect the file descriptor of INFILE to
303    stdin, write the output to OUTFILE, return a new stream in
304    STATUSFILE for stderr and the pid of the process in PID. The
305    arguments for the process are expected in the NULL terminated array
306    ARGV.  The program name itself should not be included there.  If
307    PREEXEC is not NULL, that function will be called right before the
308    exec.  Calling gnupg_wait_process is required.
309
310    FLAGS is a bit vector with just one bit defined for now:
311
312    Bit 7: If set the process will be started as a background process.
313           This flag is only useful under W32 systems, so that no new
314           console is created and pops up a console window when
315           starting the server
316  
317    Bit 6: On W32 run AllowSetForegroundWindow for the child.  Due to
318           error problems this actually allows SetForegroundWindow for
319           childs of this process.
320
321    Returns 0 on success or an error code. */
322 gpg_error_t
323 gnupg_spawn_process (const char *pgmname, const char *argv[],
324                      FILE *infile, estream_t outfile,
325                      void (*preexec)(void), unsigned int flags,
326                      FILE **statusfile, pid_t *pid)
327 {
328   gpg_error_t err;
329   int fd, fdout, rp[2];
330
331   (void)flags; /* Currently not used.  */
332
333   *statusfile = NULL;
334   *pid = (pid_t)(-1);
335   fflush (infile);
336   rewind (infile);
337   fd = fileno (infile);
338   fdout = es_fileno (outfile);
339   if (fd == -1 || fdout == -1)
340     log_fatal ("no file descriptor for file passed to gnupg_spawn_process\n");
341
342   if (pipe (rp) == -1)
343     {
344       err = gpg_error_from_syserror ();
345       log_error (_("error creating a pipe: %s\n"), strerror (errno));
346       return err;
347     }
348
349 #ifdef USE_GNU_PTH      
350   *pid = pth_fork? pth_fork () : fork ();
351 #else
352   *pid = fork ();
353 #endif
354   if (*pid == (pid_t)(-1))
355     {
356       err = gpg_error_from_syserror ();
357       log_error (_("error forking process: %s\n"), strerror (errno));
358       close (rp[0]);
359       close (rp[1]);
360       return err;
361     }
362
363   if (!*pid)
364     { 
365       gcry_control (GCRYCTL_TERM_SECMEM);
366       /* Run child. */
367       do_exec (pgmname, argv, fd, fdout, rp[1], preexec);
368       /*NOTREACHED*/
369     }
370
371   /* Parent. */
372   close (rp[1]);
373
374   *statusfile = fdopen (rp[0], "r");
375   if (!*statusfile)
376     {
377       err = gpg_error_from_syserror ();
378       log_error (_("can't fdopen pipe for reading: %s\n"), strerror (errno));
379       kill (*pid, SIGTERM);
380       *pid = (pid_t)(-1);
381       return err;
382     }
383
384   return 0;
385 }
386
387
388
389 /* Simplified version of gnupg_spawn_process.  This function forks and
390    then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout
391    and ERRFD to stderr (any of them may be -1 to connect them to
392    /dev/null).  The arguments for the process are expected in the NULL
393    terminated array ARGV.  The program name itself should not be
394    included there.  Calling gnupg_wait_process is required.
395
396    Returns 0 on success or an error code. */
397 gpg_error_t
398 gnupg_spawn_process_fd (const char *pgmname, const char *argv[],
399                         int infd, int outfd, int errfd, pid_t *pid)
400 {
401   gpg_error_t err;
402
403 #ifdef USE_GNU_PTH      
404   *pid = pth_fork? pth_fork () : fork ();
405 #else
406   *pid = fork ();
407 #endif
408   if (*pid == (pid_t)(-1))
409     {
410       err = gpg_error_from_syserror ();
411       log_error (_("error forking process: %s\n"), strerror (errno));
412       return err;
413     }
414
415   if (!*pid)
416     { 
417       gcry_control (GCRYCTL_TERM_SECMEM);
418       /* Run child. */
419       do_exec (pgmname, argv, infd, outfd, errfd, NULL);
420       /*NOTREACHED*/
421     }
422
423   return 0;
424 }
425
426
427 /* Wait for the process identified by PID to terminate. PGMNAME should
428    be the same as supplied to the spawn function and is only used for
429    diagnostics. Returns 0 if the process succeeded, GPG_ERR_GENERAL
430    for any failures of the spawned program or other error codes.  If
431    EXITCODE is not NULL the exit code of the process is stored at this
432    address or -1 if it could not be retrieved. */
433 gpg_error_t
434 gnupg_wait_process (const char *pgmname, pid_t pid, int *exitcode)
435 {
436   gpg_err_code_t ec;
437
438   int i, status;
439
440   if (exitcode)
441     *exitcode = -1;
442
443   if (pid == (pid_t)(-1))
444     return gpg_error (GPG_ERR_INV_VALUE);
445
446 #ifdef USE_GNU_PTH
447   i = pth_waitpid ? pth_waitpid (pid, &status, 0) : waitpid (pid, &status, 0);
448 #else
449   while ( (i=waitpid (pid, &status, 0)) == -1 && errno == EINTR)
450     ;
451 #endif
452   if (i == (pid_t)(-1))
453     {
454       log_error (_("waiting for process %d to terminate failed: %s\n"),
455                  (int)pid, strerror (errno));
456       ec = gpg_err_code_from_errno (errno);
457     }
458   else if (WIFEXITED (status) && WEXITSTATUS (status) == 127)
459     {
460       log_error (_("error running `%s': probably not installed\n"), pgmname);
461       ec = GPG_ERR_CONFIGURATION;
462     }
463   else if (WIFEXITED (status) && WEXITSTATUS (status))
464     {
465       log_error (_("error running `%s': exit status %d\n"), pgmname,
466                  WEXITSTATUS (status));
467       if (exitcode)
468         *exitcode = WEXITSTATUS (status);
469       ec = GPG_ERR_GENERAL;
470     }
471   else if (!WIFEXITED (status))
472     {
473       log_error (_("error running `%s': terminated\n"), pgmname);
474       ec = GPG_ERR_GENERAL;
475     }
476   else 
477     {
478       if (exitcode)
479         *exitcode = 0;
480       ec = 0;
481     }
482
483   return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, ec);
484 }
485
486
487 /* Spawn a new process and immediatley detach from it.  The name of
488    the program to exec is PGMNAME and its arguments are in ARGV (the
489    programname is automatically passed as first argument).
490    Environment strings in ENVP are set.  An error is returned if
491    pgmname is not executable; to make this work it is necessary to
492    provide an absolute file name.  All standard file descriptors are
493    connected to /dev/null. */
494 gpg_error_t
495 gnupg_spawn_process_detached (const char *pgmname, const char *argv[],
496                               const char *envp[] )
497 {
498   pid_t pid;
499   int i;
500
501   if (getuid() != geteuid())
502     return gpg_error (GPG_ERR_BUG);
503
504   if (access (pgmname, X_OK))
505     return gpg_error_from_syserror ();
506
507 #ifdef USE_GNU_PTH      
508   pid = pth_fork? pth_fork () : fork ();
509 #else
510   pid = fork ();
511 #endif
512   if (pid == (pid_t)(-1))
513     {
514       log_error (_("error forking process: %s\n"), strerror (errno));
515       return gpg_error_from_syserror ();
516     }
517   if (!pid)
518     {
519       gcry_control (GCRYCTL_TERM_SECMEM);
520       if (setsid() == -1 || chdir ("/"))
521         _exit (1);
522       pid = fork (); /* Double fork to let init takes over the new child. */
523       if (pid == (pid_t)(-1))
524         _exit (1);
525       if (pid)
526         _exit (0);  /* Let the parent exit immediately. */
527
528       if (envp)
529         for (i=0; envp[i]; i++)
530           putenv (xstrdup (envp[i]));
531       
532       do_exec (pgmname, argv, -1, -1, -1, NULL);
533
534       /*NOTREACHED*/
535     }
536   
537   if (waitpid (pid, NULL, 0) == -1)
538     log_error ("waitpid failed in gnupg_spawn_process_detached: %s",
539                strerror (errno));
540
541   return 0;
542 }
543
544
545 /* Kill a process; that is send an appropriate signal to the process.
546    gnupg_wait_process must be called to actually remove the process
547    from the system.  An invalid PID is ignored.  */
548 void
549 gnupg_kill_process (pid_t pid)
550 {
551   if (pid != (pid_t)(-1))
552     {
553       kill (pid, SIGTERM); 
554     }
555 }