Remove use of gnulib (part 1)
[gnupg.git] / g10 / exec.c
1 /* exec.c - generic call-a-program code
2  * Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 /*
21    FIXME: We should replace most code in this module by our
22    spawn implementation from common/exechelp.c.
23  */
24
25
26 #include <config.h>
27 #include <stdlib.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #include <sys/stat.h>
31 #include <sys/types.h>
32 #ifndef EXEC_TEMPFILE_ONLY
33 #include <sys/wait.h>
34 #endif
35 #ifdef HAVE_DOSISH_SYSTEM
36 # ifdef HAVE_WINSOCK2_H
37 #  include <winsock2.h>
38 # endif
39 # include <windows.h>
40 #endif
41 #include <fcntl.h>
42 #include <unistd.h>
43 #include <string.h>
44 #include <errno.h>
45
46 #include "gpg.h"
47 #include "options.h"
48 #include "i18n.h"
49 #include "iobuf.h"
50 #include "util.h"
51 #include "membuf.h"
52 #include "exec.h"
53
54 #ifdef NO_EXEC
55 int
56 exec_write(struct exec_info **info,const char *program,
57                const char *args_in,const char *name,int writeonly,int binary)
58 {
59   log_error(_("no remote program execution supported\n"));
60   return G10ERR_GENERAL;
61 }
62
63 int
64 exec_read(struct exec_info *info) { return G10ERR_GENERAL; }
65 int
66 exec_finish(struct exec_info *info) { return G10ERR_GENERAL; }
67 int
68 set_exec_path(const char *path) { return G10ERR_GENERAL; }
69
70 #else /* ! NO_EXEC */
71
72 #if defined (_WIN32)
73 /* This is a nicer system() for windows that waits for programs to
74    return before returning control to the caller.  I hate helpful
75    computers. */
76 static int
77 w32_system(const char *command)
78 {
79 #ifdef HAVE_W32CE_SYSTEM
80 #warning Change this code to use common/exechelp.c
81 #else
82   PROCESS_INFORMATION pi;
83   STARTUPINFO si;
84   char *string;
85
86   /* We must use a copy of the command as CreateProcess modifies this
87      argument. */
88   string=xstrdup(command);
89
90   memset(&pi,0,sizeof(pi));
91   memset(&si,0,sizeof(si));
92   si.cb=sizeof(si);
93
94   if(!CreateProcess(NULL,string,NULL,NULL,FALSE,
95                     DETACHED_PROCESS,
96                     NULL,NULL,&si,&pi))
97     return -1;
98
99   /* Wait for the child to exit */
100   WaitForSingleObject(pi.hProcess,INFINITE);
101
102   CloseHandle(pi.hProcess);
103   CloseHandle(pi.hThread);
104   xfree(string);
105
106   return 0;
107 #endif
108 }
109 #endif
110
111 /* Replaces current $PATH */
112 int
113 set_exec_path(const char *path)
114 {
115 #ifdef HAVE_W32CE_SYSTEM
116 #warning Change this code to use common/exechelp.c
117 #else
118   char *p;
119
120   p=xmalloc(5+strlen(path)+1);
121   strcpy(p,"PATH=");
122   strcat(p,path);
123
124   if(DBG_EXTPROG)
125     log_debug("set_exec_path: %s\n",p);
126
127   /* Notice that path is never freed.  That is intentional due to the
128      way putenv() works.  This leaks a few bytes if we call
129      set_exec_path multiple times. */
130
131   if(putenv(p)!=0)
132     return G10ERR_GENERAL;
133   else
134     return 0;
135 #endif
136 }
137
138 /* Makes a temp directory and filenames */
139 static int
140 make_tempdir(struct exec_info *info)
141 {
142   char *tmp=opt.temp_dir,*namein=info->name,*nameout;
143
144   if(!namein)
145     namein=info->flags.binary?"tempin" EXTSEP_S "bin":"tempin" EXTSEP_S "txt";
146
147   nameout=info->flags.binary?"tempout" EXTSEP_S "bin":"tempout" EXTSEP_S "txt";
148
149   /* Make up the temp dir and files in case we need them */
150
151   if(tmp==NULL)
152     {
153 #if defined (_WIN32)
154       int err;
155
156       tmp=xmalloc(MAX_PATH+2);
157       err=GetTempPath(MAX_PATH+1,tmp);
158       if(err==0 || err>MAX_PATH+1)
159         strcpy(tmp,"c:\\windows\\temp");
160       else
161         {
162           int len=strlen(tmp);
163
164           /* GetTempPath may return with \ on the end */
165           while(len>0 && tmp[len-1]=='\\')
166             {
167               tmp[len-1]='\0';
168               len--;
169             }
170         }
171 #else /* More unixish systems */
172       tmp=getenv("TMPDIR");
173       if(tmp==NULL)
174         {
175           tmp=getenv("TMP");
176           if(tmp==NULL)
177             {
178 #ifdef __riscos__
179               tmp="<Wimp$ScrapDir>.GnuPG";
180               mkdir(tmp,0700); /* Error checks occur later on */
181 #else
182               tmp="/tmp";
183 #endif
184             }
185         }
186 #endif
187     }
188
189   info->tempdir=xmalloc(strlen(tmp)+strlen(DIRSEP_S)+10+1);
190
191   sprintf(info->tempdir,"%s" DIRSEP_S "gpg-XXXXXX",tmp);
192
193 #if defined (_WIN32)
194   xfree(tmp);
195 #endif
196
197   if(mkdtemp(info->tempdir)==NULL)
198     log_error(_("can't create directory '%s': %s\n"),
199               info->tempdir,strerror(errno));
200   else
201     {
202       info->flags.madedir=1;
203
204       info->tempfile_in=xmalloc(strlen(info->tempdir)+
205                                 strlen(DIRSEP_S)+strlen(namein)+1);
206       sprintf(info->tempfile_in,"%s" DIRSEP_S "%s",info->tempdir,namein);
207
208       if(!info->flags.writeonly)
209         {
210           info->tempfile_out=xmalloc(strlen(info->tempdir)+
211                                      strlen(DIRSEP_S)+strlen(nameout)+1);
212           sprintf(info->tempfile_out,"%s" DIRSEP_S "%s",info->tempdir,nameout);
213         }
214     }
215
216   return info->flags.madedir?0:G10ERR_GENERAL;
217 }
218
219 /* Expands %i and %o in the args to the full temp files within the
220    temp directory. */
221 static int
222 expand_args(struct exec_info *info,const char *args_in)
223 {
224   const char *ch = args_in;
225   membuf_t command;
226
227   info->flags.use_temp_files=0;
228   info->flags.keep_temp_files=0;
229
230   if(DBG_EXTPROG)
231     log_debug("expanding string \"%s\"\n",args_in);
232
233   init_membuf (&command, 100);
234
235   while(*ch!='\0')
236     {
237       if(*ch=='%')
238         {
239           char *append=NULL;
240
241           ch++;
242
243           switch(*ch)
244             {
245             case 'O':
246               info->flags.keep_temp_files=1;
247               /* fall through */
248
249             case 'o': /* out */
250               if(!info->flags.madedir)
251                 {
252                   if(make_tempdir(info))
253                     goto fail;
254                 }
255               append=info->tempfile_out;
256               info->flags.use_temp_files=1;
257               break;
258
259             case 'I':
260               info->flags.keep_temp_files=1;
261               /* fall through */
262
263             case 'i': /* in */
264               if(!info->flags.madedir)
265                 {
266                   if(make_tempdir(info))
267                     goto fail;
268                 }
269               append=info->tempfile_in;
270               info->flags.use_temp_files=1;
271               break;
272
273             case '%':
274               append="%";
275               break;
276             }
277
278           if(append)
279             put_membuf_str (&command, append);
280         }
281       else
282         put_membuf (&command, ch, 1);
283
284       ch++;
285     }
286
287   put_membuf (&command, "", 1);  /* Terminate string.  */
288
289   info->command = get_membuf (&command, NULL);
290   if (!info->command)
291     return gpg_error_from_syserror ();
292
293   if(DBG_EXTPROG)
294     log_debug("args expanded to \"%s\", use %u, keep %u\n",info->command,
295               info->flags.use_temp_files,info->flags.keep_temp_files);
296
297   return 0;
298
299  fail:
300   xfree (get_membuf (&command, NULL));
301   return G10ERR_GENERAL;
302 }
303
304 /* Either handles the tempfile creation, or the fork/exec.  If it
305    returns ok, then info->tochild is a FILE * that can be written to.
306    The rules are: if there are no args, then it's a fork/exec/pipe.
307    If there are args, but no tempfiles, then it's a fork/exec/pipe via
308    shell -c.  If there are tempfiles, then it's a system. */
309
310 int
311 exec_write(struct exec_info **info,const char *program,
312            const char *args_in,const char *name,int writeonly,int binary)
313 {
314   int ret=G10ERR_GENERAL;
315
316   if(opt.exec_disable && !opt.no_perm_warn)
317     {
318       log_info(_("external program calls are disabled due to unsafe "
319                  "options file permissions\n"));
320
321       return ret;
322     }
323
324 #if defined(HAVE_GETUID) && defined(HAVE_GETEUID)
325   /* There should be no way to get to this spot while still carrying
326      setuid privs.  Just in case, bomb out if we are. */
327   if ( getuid () != geteuid ())
328     BUG ();
329 #endif
330
331   if(program==NULL && args_in==NULL)
332     BUG();
333
334   *info=xmalloc_clear(sizeof(struct exec_info));
335
336   if(name)
337     (*info)->name=xstrdup(name);
338   (*info)->flags.binary=binary;
339   (*info)->flags.writeonly=writeonly;
340
341   /* Expand the args, if any */
342   if(args_in && expand_args(*info,args_in))
343     goto fail;
344
345 #ifdef EXEC_TEMPFILE_ONLY
346   if(!(*info)->flags.use_temp_files)
347     {
348       log_error(_("this platform requires temporary files when calling"
349                   " external programs\n"));
350       goto fail;
351     }
352
353 #else /* !EXEC_TEMPFILE_ONLY */
354
355   /* If there are no args, or there are args, but no temp files, we
356      can use fork/exec/pipe */
357   if(args_in==NULL || (*info)->flags.use_temp_files==0)
358     {
359       int to[2],from[2];
360
361       if(pipe(to)==-1)
362         goto fail;
363
364       if(pipe(from)==-1)
365         {
366           close(to[0]);
367           close(to[1]);
368           goto fail;
369         }
370
371       if(((*info)->child=fork())==-1)
372         {
373           close(to[0]);
374           close(to[1]);
375           close(from[0]);
376           close(from[1]);
377           goto fail;
378         }
379
380       if((*info)->child==0)
381         {
382           char *shell=getenv("SHELL");
383
384           if(shell==NULL)
385             shell="/bin/sh";
386
387           /* I'm the child */
388
389           /* If the program isn't going to respond back, they get to
390              keep their stdout/stderr */
391           if(!(*info)->flags.writeonly)
392             {
393               /* implied close of STDERR */
394               if(dup2(STDOUT_FILENO,STDERR_FILENO)==-1)
395                 _exit(1);
396
397               /* implied close of STDOUT */
398               close(from[0]);
399               if(dup2(from[1],STDOUT_FILENO)==-1)
400                 _exit(1);
401             }
402
403           /* implied close of STDIN */
404           close(to[1]);
405           if(dup2(to[0],STDIN_FILENO)==-1)
406             _exit(1);
407
408           if(args_in==NULL)
409             {
410               if(DBG_EXTPROG)
411                 log_debug("execlp: %s\n",program);
412
413               execlp(program,program,(void *)NULL);
414             }
415           else
416             {
417               if(DBG_EXTPROG)
418                 log_debug("execlp: %s -c %s\n",shell,(*info)->command);
419
420               execlp(shell,shell,"-c",(*info)->command,(void *)NULL);
421             }
422
423           /* If we get this far the exec failed.  Clean up and return. */
424
425           if(args_in==NULL)
426             log_error(_("unable to execute program '%s': %s\n"),
427                       program,strerror(errno));
428           else
429             log_error(_("unable to execute shell '%s': %s\n"),
430                       shell,strerror(errno));
431
432           /* This mimics the POSIX sh behavior - 127 means "not found"
433              from the shell. */
434           if(errno==ENOENT)
435             _exit(127);
436
437           _exit(1);
438         }
439
440       /* I'm the parent */
441
442       close(to[0]);
443
444       (*info)->tochild=fdopen(to[1],binary?"wb":"w");
445       if((*info)->tochild==NULL)
446         {
447           ret = gpg_error_from_syserror ();
448           close(to[1]);
449           goto fail;
450         }
451
452       close(from[1]);
453
454       (*info)->fromchild=iobuf_fdopen(from[0],"r");
455       if((*info)->fromchild==NULL)
456         {
457           ret = gpg_error_from_syserror ();
458           close(from[0]);
459           goto fail;
460         }
461
462       /* fd iobufs are cached! */
463       iobuf_ioctl((*info)->fromchild, IOBUF_IOCTL_NO_CACHE, 1, NULL);
464
465       return 0;
466     }
467 #endif /* !EXEC_TEMPFILE_ONLY */
468
469   if(DBG_EXTPROG)
470     log_debug("using temp file '%s'\n",(*info)->tempfile_in);
471
472   /* It's not fork/exec/pipe, so create a temp file */
473   if( is_secured_filename ((*info)->tempfile_in) )
474     {
475       (*info)->tochild = NULL;
476       gpg_err_set_errno (EPERM);
477     }
478   else
479     (*info)->tochild=fopen((*info)->tempfile_in,binary?"wb":"w");
480   if((*info)->tochild==NULL)
481     {
482       ret = gpg_error_from_syserror ();
483       log_error(_("can't create '%s': %s\n"),
484                 (*info)->tempfile_in,strerror(errno));
485       goto fail;
486     }
487
488   ret=0;
489
490  fail:
491   if (ret)
492     {
493       xfree (*info);
494       *info = NULL;
495     }
496   return ret;
497 }
498
499 int
500 exec_read(struct exec_info *info)
501 {
502   int ret=G10ERR_GENERAL;
503
504   fclose(info->tochild);
505   info->tochild=NULL;
506
507   if(info->flags.use_temp_files)
508     {
509       if(DBG_EXTPROG)
510         log_debug("system() command is %s\n",info->command);
511
512 #if defined (_WIN32)
513       info->progreturn=w32_system(info->command);
514 #else
515       info->progreturn=system(info->command);
516 #endif
517
518       if(info->progreturn==-1)
519         {
520           log_error(_("system error while calling external program: %s\n"),
521                     strerror(errno));
522           info->progreturn=127;
523           goto fail;
524         }
525
526 #if defined(WIFEXITED) && defined(WEXITSTATUS)
527       if(WIFEXITED(info->progreturn))
528         info->progreturn=WEXITSTATUS(info->progreturn);
529       else
530         {
531           log_error(_("unnatural exit of external program\n"));
532           info->progreturn=127;
533           goto fail;
534         }
535 #else
536       /* If we don't have the macros, do the best we can. */
537       info->progreturn = (info->progreturn & 0xff00) >> 8;
538 #endif
539
540       /* 127 is the magic value returned from system() to indicate
541          that the shell could not be executed, or from /bin/sh to
542          indicate that the program could not be executed. */
543
544       if(info->progreturn==127)
545         {
546           log_error(_("unable to execute external program\n"));
547           goto fail;
548         }
549
550       if(!info->flags.writeonly)
551         {
552           info->fromchild=iobuf_open(info->tempfile_out);
553           if (info->fromchild
554               && is_secured_file (iobuf_get_fd (info->fromchild)))
555             {
556               iobuf_close (info->fromchild);
557               info->fromchild = NULL;
558               gpg_err_set_errno (EPERM);
559             }
560           if(info->fromchild==NULL)
561             {
562               ret = gpg_error_from_syserror ();
563               log_error(_("unable to read external program response: %s\n"),
564                         strerror(errno));
565               goto fail;
566             }
567
568           /* Do not cache this iobuf on close */
569           iobuf_ioctl(info->fromchild, IOBUF_IOCTL_NO_CACHE, 1, NULL);
570         }
571     }
572
573   ret=0;
574
575  fail:
576   return ret;
577 }
578
579 int
580 exec_finish(struct exec_info *info)
581 {
582   int ret=info->progreturn;
583
584   if(info->fromchild)
585     iobuf_close(info->fromchild);
586
587   if(info->tochild)
588     fclose(info->tochild);
589
590 #ifndef EXEC_TEMPFILE_ONLY
591   if(info->child>0)
592     {
593       if(waitpid(info->child,&info->progreturn,0)!=0 &&
594          WIFEXITED(info->progreturn))
595         ret=WEXITSTATUS(info->progreturn);
596       else
597         {
598           log_error(_("unnatural exit of external program\n"));
599           ret=127;
600         }
601     }
602 #endif
603
604   if(info->flags.madedir && !info->flags.keep_temp_files)
605     {
606       if(info->tempfile_in)
607         {
608           if(unlink(info->tempfile_in)==-1)
609             log_info(_("WARNING: unable to remove tempfile (%s) '%s': %s\n"),
610                      "in",info->tempfile_in,strerror(errno));
611         }
612
613       if(info->tempfile_out)
614         {
615           if(unlink(info->tempfile_out)==-1)
616             log_info(_("WARNING: unable to remove tempfile (%s) '%s': %s\n"),
617                      "out",info->tempfile_out,strerror(errno));
618         }
619
620       if(rmdir(info->tempdir)==-1)
621         log_info(_("WARNING: unable to remove temp directory '%s': %s\n"),
622                  info->tempdir,strerror(errno));
623     }
624
625   xfree(info->command);
626   xfree(info->name);
627   xfree(info->tempdir);
628   xfree(info->tempfile_in);
629   xfree(info->tempfile_out);
630   xfree(info);
631
632   return ret;
633 }
634 #endif /* ! NO_EXEC */