Cleanups and minor fixes.
[gnupg.git] / g10 / exec.c
1 /* exec.c - generic call-a-program code
2  * Copyright (C) 2001, 2002 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdlib.h>
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <sys/stat.h>
26 #include <sys/types.h>
27 #ifndef EXEC_TEMPFILE_ONLY
28 #include <sys/wait.h>
29 #endif
30 #ifdef HAVE_DOSISH_SYSTEM
31 #include <windows.h>
32 #endif
33 #include <fcntl.h>
34 #include <unistd.h>
35 #include <string.h>
36 #include <errno.h>
37 #include "options.h"
38 #include "memory.h"
39 #include "i18n.h"
40 #include "iobuf.h"
41 #include "util.h"
42 #include "exec.h"
43
44 #ifdef NO_EXEC
45 int exec_write(struct exec_info **info,const char *program,
46                const char *args_in,const char *name,int writeonly,int binary)
47 {
48   log_error(_("no remote program execution supported\n"));
49   return G10ERR_GENERAL;
50 }
51
52 int exec_read(struct exec_info *info) { return G10ERR_GENERAL; }
53 int exec_finish(struct exec_info *info) { return G10ERR_GENERAL; }
54 int set_exec_path(const char *path,int method) { return G10ERR_GENERAL; }
55
56 #else /* ! NO_EXEC */
57
58 #ifndef HAVE_MKDTEMP
59 char *mkdtemp(char *template);
60 #endif
61
62 #if defined (__MINGW32__) || defined (__CYGWIN32__)
63 /* This is a nicer system() for windows that waits for programs to
64    return before returning control to the caller.  I hate helpful
65    computers. */
66 static int win_system(const char *command)
67 {
68   PROCESS_INFORMATION pi;
69   STARTUPINFO si;
70   char *string;
71
72   /* We must use a copy of the command as CreateProcess modifies this
73      argument. */
74   string=m_strdup(command);
75
76   memset(&pi,0,sizeof(pi));
77   memset(&si,0,sizeof(si));
78   si.cb=sizeof(si);
79
80   if(!CreateProcess(NULL,string,NULL,NULL,FALSE,0,NULL,NULL,&si,&pi))
81     return -1;
82
83   /* Wait for the child to exit */
84   WaitForSingleObject(pi.hProcess,INFINITE);
85
86   CloseHandle(pi.hProcess);
87   CloseHandle(pi.hThread);
88   m_free(string);
89
90   return 0;
91 }
92 #endif
93
94 /* method==0 to replace current $PATH, and 1 to append to current
95    $PATH.  */
96 int set_exec_path(const char *path,int method)
97 {
98   char *p,*curpath=NULL;
99   size_t curlen=0;
100
101   if(method==1 && (curpath=getenv("PATH")))
102     curlen=strlen(curpath)+1;
103
104   p=m_alloc(5+curlen+strlen(path)+1);
105   strcpy(p,"PATH=");
106
107   if(curpath)
108     {
109       strcat(p,curpath);
110       strcat(p,":");
111     }
112
113   strcat(p,path);
114
115   /* Notice that path is never freed.  That is intentional due to the
116      way putenv() works.  This leaks a few bytes if we call
117      set_exec_path multiple times. */
118
119   if(putenv(p)!=0)
120     return G10ERR_GENERAL;
121   else
122     return 0;
123 }
124
125 /* Makes a temp directory and filenames */
126 static int make_tempdir(struct exec_info *info)
127 {
128   char *tmp=opt.temp_dir,*namein=info->name,*nameout;
129
130   if(!namein)
131     namein=info->binary?"tempin" EXTSEP_S "bin":"tempin" EXTSEP_S "txt";
132
133   nameout=info->binary?"tempout" EXTSEP_S "bin":"tempout" EXTSEP_S "txt";
134
135   /* Make up the temp dir and files in case we need them */
136
137   if(tmp==NULL)
138     {
139 #if defined (__MINGW32__) || defined (__CYGWIN32__)
140       tmp=m_alloc(256);
141       if(GetTempPath(256,tmp)==0)
142         strcpy(tmp,"c:\\windows\\temp");
143       else
144         {
145           int len=strlen(tmp);
146
147           /* GetTempPath may return with \ on the end */
148           while(len>0 && tmp[len-1]=='\\')
149             {
150               tmp[len-1]='\0';
151               len--;
152             }
153         }
154 #else /* More unixish systems */
155       tmp=getenv("TMPDIR");
156       if(tmp==NULL)
157         {
158           tmp=getenv("TMP");
159           if(tmp==NULL)
160             {
161 #ifdef __riscos__
162               tmp="<Wimp$ScrapDir>.GnuPG";
163               mkdir(tmp,0700); /* Error checks occur later on */
164 #else
165               tmp="/tmp";
166 #endif
167             }
168         }
169 #endif
170     }
171
172   info->tempdir=m_alloc(strlen(tmp)+strlen(DIRSEP_S)+10+1);
173
174   sprintf(info->tempdir,"%s" DIRSEP_S "gpg-XXXXXX",tmp);
175
176 #if defined (__MINGW32__) || defined (__CYGWIN32__)
177   m_free(tmp);
178 #endif
179
180   if(mkdtemp(info->tempdir)==NULL)
181     log_error(_("can't create directory `%s': %s\n"),
182               info->tempdir,strerror(errno));
183   else
184     {
185       info->madedir=1;
186
187       info->tempfile_in=m_alloc(strlen(info->tempdir)+
188                                 strlen(DIRSEP_S)+strlen(namein)+1);
189       sprintf(info->tempfile_in,"%s" DIRSEP_S "%s",info->tempdir,namein);
190
191       if(!info->writeonly)
192         {
193           info->tempfile_out=m_alloc(strlen(info->tempdir)+
194                                      strlen(DIRSEP_S)+strlen(nameout)+1);
195           sprintf(info->tempfile_out,"%s" DIRSEP_S "%s",info->tempdir,nameout);
196         }
197     }
198
199   return info->madedir?0:G10ERR_GENERAL;
200 }
201
202 /* Expands %i and %o in the args to the full temp files within the
203    temp directory. */
204 static int expand_args(struct exec_info *info,const char *args_in)
205 {
206   const char *ch=args_in;
207   unsigned int size,len;
208
209   info->use_temp_files=0;
210   info->keep_temp_files=0;
211
212   if(DBG_EXTPROG)
213     log_debug("expanding string \"%s\"\n",args_in);
214
215   size=100;
216   info->command=m_alloc(size);
217   len=0;
218   info->command[0]='\0';
219
220   while(*ch!='\0')
221     {
222       if(*ch=='%')
223         {
224           char *append=NULL;
225
226           ch++;
227
228           switch(*ch)
229             {
230             case 'O':
231               info->keep_temp_files=1;
232               /* fall through */
233
234             case 'o': /* out */
235               if(!info->madedir)
236                 {
237                   if(make_tempdir(info))
238                     goto fail;
239                 }
240               append=info->tempfile_out;
241               info->use_temp_files=1;
242               break;
243
244             case 'I':
245               info->keep_temp_files=1;
246               /* fall through */
247
248             case 'i': /* in */
249               if(!info->madedir)
250                 {
251                   if(make_tempdir(info))
252                     goto fail;
253                 }
254               append=info->tempfile_in;
255               info->use_temp_files=1;
256               break;
257
258             case '%':
259               append="%";
260               break;
261             }
262
263           if(append)
264             {
265               /* FIXME: Why do we need a loop? -wk */
266               while(strlen(append)+len>size-1)
267                 {
268                   size+=100;
269                   info->command=m_realloc(info->command,size);
270                 }
271
272               strcat(info->command,append);
273               len+=strlen(append);
274             }
275         }
276       else
277         {
278           if(len==size-1) /* leave room for the \0 */
279             {
280               size+=100;
281               info->command=m_realloc(info->command,size);
282             }
283
284           info->command[len++]=*ch;
285           info->command[len]='\0';
286         }
287
288       ch++;
289     }
290
291   if(DBG_EXTPROG)
292     log_debug("args expanded to \"%s\", use %d, keep %d\n",
293               info->command,info->use_temp_files,info->keep_temp_files);
294
295   return 0;
296
297  fail:
298
299   m_free(info->command);
300   info->command=NULL;
301
302   return G10ERR_GENERAL;
303 }
304
305 /* Either handles the tempfile creation, or the fork/exec.  If it
306    returns ok, then info->tochild is a FILE * that can be written to.
307    The rules are: if there are no args, then it's a fork/exec/pipe.
308    If there are args, but no tempfiles, then it's a fork/exec/pipe via
309    shell -c.  If there are tempfiles, then it's a system. */
310
311 int 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=m_alloc_clear(sizeof(struct exec_info));
335
336   if(name)
337     (*info)->name=m_strdup(name);
338   (*info)->binary=binary;
339   (*info)->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)->use_temp_files)
347     {
348       log_error(_("this platform requires temp files when calling external "
349                   "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)->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)->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,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,NULL);
421             }
422
423           /* If we get this far the exec failed.  Clean up and return. */
424
425           log_error(_("unable to execute %s \"%s\": %s\n"),
426                     args_in==NULL?"program":"shell",
427                     args_in==NULL?program:shell,
428                     strerror(errno));
429
430           /* This mimics the POSIX sh behavior - 127 means "not found"
431              from the shell. */
432           if(errno==ENOENT)
433             _exit(127);
434
435           _exit(1);
436         }
437
438       /* I'm the parent */
439
440       close(to[0]);
441
442       (*info)->tochild=fdopen(to[1],binary?"wb":"w");
443       if((*info)->tochild==NULL)
444         {
445           close(to[1]);
446           ret=G10ERR_WRITE_FILE;
447           goto fail;
448         }
449
450       close(from[1]);
451
452       (*info)->fromchild=iobuf_fdopen(from[0],"r");
453       if((*info)->fromchild==NULL)
454         {
455           close(from[0]);
456           ret=G10ERR_READ_FILE;
457           goto fail;
458         }
459
460       /* fd iobufs are cached?! */
461       iobuf_ioctl((*info)->fromchild,3,1,NULL);
462
463       return 0;
464     }
465 #endif /* !EXEC_TEMPFILE_ONLY */
466
467   if(DBG_EXTPROG)
468     log_debug("using temp file `%s'\n",(*info)->tempfile_in);
469
470   /* It's not fork/exec/pipe, so create a temp file */
471   (*info)->tochild=fopen((*info)->tempfile_in,binary?"wb":"w");
472   if((*info)->tochild==NULL)
473     {
474       log_error(_("can't create '%s': %s\n"),
475                 (*info)->tempfile_in,strerror(errno));
476       ret=G10ERR_WRITE_FILE;
477       goto fail;
478     }
479
480   ret=0;
481
482  fail:
483   return ret;
484 }
485
486 int exec_read(struct exec_info *info)
487 {
488   int ret=G10ERR_GENERAL;
489
490   fclose(info->tochild);
491   info->tochild=NULL;
492
493   if(info->use_temp_files)
494     {
495       if(DBG_EXTPROG)
496         log_debug("system() command is %s\n",info->command);
497
498 #if defined (__MINGW32__) || defined (__CYGWIN32__)
499       info->progreturn=win_system(info->command);
500 #else
501       info->progreturn=system(info->command);
502 #endif
503
504       if(info->progreturn==-1)
505         {
506           log_error(_("system error while calling external program: %s\n"),
507                     strerror(errno));
508           info->progreturn=127;
509           goto fail;
510         }
511
512 #if defined(WIFEXITED) && defined(WEXITSTATUS)
513       if(WIFEXITED(info->progreturn))
514         info->progreturn=WEXITSTATUS(info->progreturn);
515       else
516         {
517           log_error(_("unnatural exit of external program\n"));
518           info->progreturn=127;
519           goto fail;
520         }
521 #else
522       /* If we don't have the macros, do the best we can. */
523       info->progreturn = (info->progreturn & 0xff00) >> 8;
524 #endif
525
526       /* 127 is the magic value returned from system() to indicate
527          that the shell could not be executed, or from /bin/sh to
528          indicate that the program could not be executed. */
529
530       if(info->progreturn==127)
531         {
532           log_error(_("unable to execute external program\n"));
533           goto fail;
534         }
535
536       if(!info->writeonly)
537         {
538           info->fromchild=iobuf_open(info->tempfile_out);
539           if(info->fromchild==NULL)
540             {
541               log_error(_("unable to read external program response: %s\n"),
542                         strerror(errno));
543               ret=G10ERR_READ_FILE;
544               goto fail;
545             }
546
547           /* Do not cache this iobuf on close */
548           iobuf_ioctl(info->fromchild,3,1,NULL);
549         }
550     }
551
552   ret=0;
553
554  fail:
555   return ret;
556 }
557
558 int exec_finish(struct exec_info *info)
559 {
560   int ret=info->progreturn;
561
562   if(info->fromchild)
563     iobuf_close(info->fromchild);
564
565   if(info->tochild)
566     fclose(info->tochild);
567
568 #ifndef EXEC_TEMPFILE_ONLY
569   if(info->child>0)
570     {
571       if(waitpid(info->child,&info->progreturn,0)!=0 &&
572          WIFEXITED(info->progreturn))
573         ret=WEXITSTATUS(info->progreturn);
574       else
575         {
576           log_error(_("unnatural exit of external program\n"));
577           ret=127;
578         }
579     }
580 #endif
581
582   if(info->madedir && !info->keep_temp_files)
583     {
584       if(info->tempfile_in)
585         {
586           if(unlink(info->tempfile_in)==-1)
587             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
588                      "in",info->tempfile_in,strerror(errno));
589         }
590   
591       if(info->tempfile_out)
592         {
593           if(unlink(info->tempfile_out)==-1)
594             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
595                      "out",info->tempfile_out,strerror(errno));
596         }
597
598       if(rmdir(info->tempdir)==-1)
599         log_info(_("WARNING: unable to remove temp directory `%s': %s\n"),
600                  info->tempdir,strerror(errno));
601     }
602
603   m_free(info->command);
604   m_free(info->name);
605   m_free(info->tempdir);
606   m_free(info->tempfile_in);
607   m_free(info->tempfile_out);
608   m_free(info);
609
610   return ret;
611 }
612 #endif /* ! NO_EXEC */
613