auto start the agent if --use-standard-socket is in use.
[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, see exechelp.h for details.  */
303 gpg_error_t
304 gnupg_spawn_process (const char *pgmname, const char *argv[],
305                      estream_t infile, estream_t outfile,
306                      void (*preexec)(void), unsigned int flags,
307                      estream_t *statusfile, pid_t *pid)
308 {
309   gpg_error_t err;
310   int fd, fdout, rp[2];
311
312   (void)flags; /* Currently not used.  */
313
314   *statusfile = NULL;
315   *pid = (pid_t)(-1);
316   es_fflush (infile);
317   es_rewind (infile);
318   fd = es_fileno (infile);
319   fdout = es_fileno (outfile);
320   if (fd == -1 || fdout == -1)
321     log_fatal ("no file descriptor for file passed to gnupg_spawn_process\n");
322
323   if (pipe (rp) == -1)
324     {
325       err = gpg_error_from_syserror ();
326       log_error (_("error creating a pipe: %s\n"), strerror (errno));
327       return err;
328     }
329
330 #ifdef USE_GNU_PTH      
331   *pid = pth_fork? pth_fork () : fork ();
332 #else
333   *pid = fork ();
334 #endif
335   if (*pid == (pid_t)(-1))
336     {
337       err = gpg_error_from_syserror ();
338       log_error (_("error forking process: %s\n"), strerror (errno));
339       close (rp[0]);
340       close (rp[1]);
341       return err;
342     }
343
344   if (!*pid)
345     { 
346       gcry_control (GCRYCTL_TERM_SECMEM);
347       /* Run child. */
348       do_exec (pgmname, argv, fd, fdout, rp[1], preexec);
349       /*NOTREACHED*/
350     }
351
352   /* Parent. */
353   close (rp[1]);
354
355   *statusfile = es_fdopen (rp[0], "r");
356   if (!*statusfile)
357     {
358       err = gpg_error_from_syserror ();
359       log_error (_("can't fdopen pipe for reading: %s\n"), strerror (errno));
360       kill (*pid, SIGTERM);
361       *pid = (pid_t)(-1);
362       return err;
363     }
364
365   return 0;
366 }
367
368
369
370 /* Simplified version of gnupg_spawn_process.  This function forks and
371    then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout
372    and ERRFD to stderr (any of them may be -1 to connect them to
373    /dev/null).  The arguments for the process are expected in the NULL
374    terminated array ARGV.  The program name itself should not be
375    included there.  Calling gnupg_wait_process is required.
376
377    Returns 0 on success or an error code. */
378 gpg_error_t
379 gnupg_spawn_process_fd (const char *pgmname, const char *argv[],
380                         int infd, int outfd, int errfd, pid_t *pid)
381 {
382   gpg_error_t err;
383
384 #ifdef USE_GNU_PTH      
385   *pid = pth_fork? pth_fork () : fork ();
386 #else
387   *pid = fork ();
388 #endif
389   if (*pid == (pid_t)(-1))
390     {
391       err = gpg_error_from_syserror ();
392       log_error (_("error forking process: %s\n"), strerror (errno));
393       return err;
394     }
395
396   if (!*pid)
397     { 
398       gcry_control (GCRYCTL_TERM_SECMEM);
399       /* Run child. */
400       do_exec (pgmname, argv, infd, outfd, errfd, NULL);
401       /*NOTREACHED*/
402     }
403
404   return 0;
405 }
406
407
408 /* Wait for the process identified by PID to terminate. PGMNAME should
409    be the same as supplied to the spawn function and is only used for
410    diagnostics. Returns 0 if the process succeeded, GPG_ERR_GENERAL
411    for any failures of the spawned program or other error codes.  If
412    EXITCODE is not NULL the exit code of the process is stored at this
413    address or -1 if it could not be retrieved and no error message is
414    logged.  */
415 gpg_error_t
416 gnupg_wait_process (const char *pgmname, pid_t pid, int *exitcode)
417 {
418   gpg_err_code_t ec;
419
420   int i, status;
421
422   if (exitcode)
423     *exitcode = -1;
424
425   if (pid == (pid_t)(-1))
426     return gpg_error (GPG_ERR_INV_VALUE);
427
428 #ifdef USE_GNU_PTH
429   i = pth_waitpid ? pth_waitpid (pid, &status, 0) : waitpid (pid, &status, 0);
430 #else
431   while ( (i=waitpid (pid, &status, 0)) == -1 && errno == EINTR)
432     ;
433 #endif
434   if (i == (pid_t)(-1))
435     {
436       log_error (_("waiting for process %d to terminate failed: %s\n"),
437                  (int)pid, strerror (errno));
438       ec = gpg_err_code_from_errno (errno);
439     }
440   else if (WIFEXITED (status) && WEXITSTATUS (status) == 127)
441     {
442       log_error (_("error running `%s': probably not installed\n"), pgmname);
443       ec = GPG_ERR_CONFIGURATION;
444     }
445   else if (WIFEXITED (status) && WEXITSTATUS (status))
446     {
447       if (!exitcode)
448         log_error (_("error running `%s': exit status %d\n"), pgmname,
449                    WEXITSTATUS (status));
450       else
451         *exitcode = WEXITSTATUS (status);
452       ec = GPG_ERR_GENERAL;
453     }
454   else if (!WIFEXITED (status))
455     {
456       log_error (_("error running `%s': terminated\n"), pgmname);
457       ec = GPG_ERR_GENERAL;
458     }
459   else 
460     {
461       if (exitcode)
462         *exitcode = 0;
463       ec = 0;
464     }
465
466   return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, ec);
467 }
468
469
470 /* Spawn a new process and immediatley detach from it.  The name of
471    the program to exec is PGMNAME and its arguments are in ARGV (the
472    programname is automatically passed as first argument).
473    Environment strings in ENVP are set.  An error is returned if
474    pgmname is not executable; to make this work it is necessary to
475    provide an absolute file name.  All standard file descriptors are
476    connected to /dev/null. */
477 gpg_error_t
478 gnupg_spawn_process_detached (const char *pgmname, const char *argv[],
479                               const char *envp[] )
480 {
481   pid_t pid;
482   int i;
483
484   if (getuid() != geteuid())
485     return gpg_error (GPG_ERR_BUG);
486
487   if (access (pgmname, X_OK))
488     return gpg_error_from_syserror ();
489
490 #ifdef USE_GNU_PTH      
491   pid = pth_fork? pth_fork () : fork ();
492 #else
493   pid = fork ();
494 #endif
495   if (pid == (pid_t)(-1))
496     {
497       log_error (_("error forking process: %s\n"), strerror (errno));
498       return gpg_error_from_syserror ();
499     }
500   if (!pid)
501     {
502       pid_t pid2;
503
504       gcry_control (GCRYCTL_TERM_SECMEM);
505       if (setsid() == -1 || chdir ("/"))
506         _exit (1);
507
508       pid2 = fork (); /* Double fork to let init take over the new child. */
509       if (pid2 == (pid_t)(-1))
510         _exit (1);
511       if (pid2)
512         _exit (0);  /* Let the parent exit immediately. */
513
514       if (envp)
515         for (i=0; envp[i]; i++)
516           putenv (xstrdup (envp[i]));
517       
518       do_exec (pgmname, argv, -1, -1, -1, NULL);
519
520       /*NOTREACHED*/
521     }
522   
523   if (waitpid (pid, NULL, 0) == -1)
524     log_error ("waitpid failed in gnupg_spawn_process_detached: %s",
525                strerror (errno));
526
527   return 0;
528 }
529
530
531 /* Kill a process; that is send an appropriate signal to the process.
532    gnupg_wait_process must be called to actually remove the process
533    from the system.  An invalid PID is ignored.  */
534 void
535 gnupg_kill_process (pid_t pid)
536 {
537   if (pid != (pid_t)(-1))
538     {
539       kill (pid, SIGTERM); 
540     }
541 }