5c51b3f9f8b62126c3b5ec73339225e2292a0325
[gnupg.git] / g10 / exec.c
1 /* exec.c - generic call-a-program code
2  * Copyright (C) 2001, 2002, 2003 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 (_WIN32)
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   if(DBG_EXTPROG)
116     log_debug("set_exec_path method %d: %s\n",method,p);
117
118   /* Notice that path is never freed.  That is intentional due to the
119      way putenv() works.  This leaks a few bytes if we call
120      set_exec_path multiple times. */
121
122   if(putenv(p)!=0)
123     return G10ERR_GENERAL;
124   else
125     return 0;
126 }
127
128 /* Makes a temp directory and filenames */
129 static int make_tempdir(struct exec_info *info)
130 {
131   char *tmp=opt.temp_dir,*namein=info->name,*nameout;
132
133   if(!namein)
134     namein=info->binary?"tempin" EXTSEP_S "bin":"tempin" EXTSEP_S "txt";
135
136   nameout=info->binary?"tempout" EXTSEP_S "bin":"tempout" EXTSEP_S "txt";
137
138   /* Make up the temp dir and files in case we need them */
139
140   if(tmp==NULL)
141     {
142 #if defined (_WIN32)
143       tmp=m_alloc(256);
144       if(GetTempPath(256,tmp)==0)
145         strcpy(tmp,"c:\\windows\\temp");
146       else
147         {
148           int len=strlen(tmp);
149
150           /* GetTempPath may return with \ on the end */
151           while(len>0 && tmp[len-1]=='\\')
152             {
153               tmp[len-1]='\0';
154               len--;
155             }
156         }
157 #else /* More unixish systems */
158       tmp=getenv("TMPDIR");
159       if(tmp==NULL)
160         {
161           tmp=getenv("TMP");
162           if(tmp==NULL)
163             {
164 #ifdef __riscos__
165               tmp="<Wimp$ScrapDir>.GnuPG";
166               mkdir(tmp,0700); /* Error checks occur later on */
167 #else
168               tmp="/tmp";
169 #endif
170             }
171         }
172 #endif
173     }
174
175   info->tempdir=m_alloc(strlen(tmp)+strlen(DIRSEP_S)+10+1);
176
177   sprintf(info->tempdir,"%s" DIRSEP_S "gpg-XXXXXX",tmp);
178
179 #if defined (_WIN32)
180   m_free(tmp);
181 #endif
182
183   if(mkdtemp(info->tempdir)==NULL)
184     log_error(_("can't create directory `%s': %s\n"),
185               info->tempdir,strerror(errno));
186   else
187     {
188       info->madedir=1;
189
190       info->tempfile_in=m_alloc(strlen(info->tempdir)+
191                                 strlen(DIRSEP_S)+strlen(namein)+1);
192       sprintf(info->tempfile_in,"%s" DIRSEP_S "%s",info->tempdir,namein);
193
194       if(!info->writeonly)
195         {
196           info->tempfile_out=m_alloc(strlen(info->tempdir)+
197                                      strlen(DIRSEP_S)+strlen(nameout)+1);
198           sprintf(info->tempfile_out,"%s" DIRSEP_S "%s",info->tempdir,nameout);
199         }
200     }
201
202   return info->madedir?0:G10ERR_GENERAL;
203 }
204
205 /* Expands %i and %o in the args to the full temp files within the
206    temp directory. */
207 static int expand_args(struct exec_info *info,const char *args_in)
208 {
209   const char *ch=args_in;
210   unsigned int size,len;
211
212   info->use_temp_files=0;
213   info->keep_temp_files=0;
214
215   if(DBG_EXTPROG)
216     log_debug("expanding string \"%s\"\n",args_in);
217
218   size=100;
219   info->command=m_alloc(size);
220   len=0;
221   info->command[0]='\0';
222
223   while(*ch!='\0')
224     {
225       if(*ch=='%')
226         {
227           char *append=NULL;
228
229           ch++;
230
231           switch(*ch)
232             {
233             case 'O':
234               info->keep_temp_files=1;
235               /* fall through */
236
237             case 'o': /* out */
238               if(!info->madedir)
239                 {
240                   if(make_tempdir(info))
241                     goto fail;
242                 }
243               append=info->tempfile_out;
244               info->use_temp_files=1;
245               break;
246
247             case 'I':
248               info->keep_temp_files=1;
249               /* fall through */
250
251             case 'i': /* in */
252               if(!info->madedir)
253                 {
254                   if(make_tempdir(info))
255                     goto fail;
256                 }
257               append=info->tempfile_in;
258               info->use_temp_files=1;
259               break;
260
261             case '%':
262               append="%";
263               break;
264             }
265
266           if(append)
267             {
268               size_t applen=strlen(append);
269
270               if(applen+len>size-1)
271                 {
272                   if(applen<100)
273                     applen=100;
274
275                   size+=applen;
276                   info->command=m_realloc(info->command,size);
277                 }
278
279               strcat(info->command,append);
280               len+=strlen(append);
281             }
282         }
283       else
284         {
285           if(len==size-1) /* leave room for the \0 */
286             {
287               size+=100;
288               info->command=m_realloc(info->command,size);
289             }
290
291           info->command[len++]=*ch;
292           info->command[len]='\0';
293         }
294
295       ch++;
296     }
297
298   if(DBG_EXTPROG)
299     log_debug("args expanded to \"%s\", use %d, keep %d\n",
300               info->command,info->use_temp_files,info->keep_temp_files);
301
302   return 0;
303
304  fail:
305
306   m_free(info->command);
307   info->command=NULL;
308
309   return G10ERR_GENERAL;
310 }
311
312 /* Either handles the tempfile creation, or the fork/exec.  If it
313    returns ok, then info->tochild is a FILE * that can be written to.
314    The rules are: if there are no args, then it's a fork/exec/pipe.
315    If there are args, but no tempfiles, then it's a fork/exec/pipe via
316    shell -c.  If there are tempfiles, then it's a system. */
317
318 int exec_write(struct exec_info **info,const char *program,
319                const char *args_in,const char *name,int writeonly,int binary)
320 {
321   int ret=G10ERR_GENERAL;
322
323   if(opt.exec_disable && !opt.no_perm_warn)
324     {
325       log_info(_("external program calls are disabled due to unsafe "
326                  "options file permissions\n"));
327
328       return ret;
329     }
330
331 #if defined(HAVE_GETUID) && defined(HAVE_GETEUID)
332   /* There should be no way to get to this spot while still carrying
333      setuid privs.  Just in case, bomb out if we are. */
334   if(getuid()!=geteuid())
335     BUG();
336 #endif
337
338   if(program==NULL && args_in==NULL)
339     BUG();
340
341   *info=m_alloc_clear(sizeof(struct exec_info));
342
343   if(name)
344     (*info)->name=m_strdup(name);
345   (*info)->binary=binary;
346   (*info)->writeonly=writeonly;
347
348   /* Expand the args, if any */
349   if(args_in && expand_args(*info,args_in))
350     goto fail;
351
352 #ifdef EXEC_TEMPFILE_ONLY
353   if(!(*info)->use_temp_files)
354     {
355       log_error(_("this platform requires temporary files when calling"
356                   " external programs\n"));
357       goto fail;
358     }
359
360 #else /* !EXEC_TEMPFILE_ONLY */
361
362   /* If there are no args, or there are args, but no temp files, we
363      can use fork/exec/pipe */
364   if(args_in==NULL || (*info)->use_temp_files==0)
365     {
366       int to[2],from[2];
367
368       if(pipe(to)==-1)
369         goto fail;
370
371       if(pipe(from)==-1)
372         {
373           close(to[0]);
374           close(to[1]);
375           goto fail;
376         }
377
378       if(((*info)->child=fork())==-1)
379         {
380           close(to[0]);
381           close(to[1]);
382           close(from[0]);
383           close(from[1]);
384           goto fail;
385         }
386
387       if((*info)->child==0)
388         {
389           char *shell=getenv("SHELL");
390
391           if(shell==NULL)
392             shell="/bin/sh";
393
394           /* I'm the child */
395
396           /* If the program isn't going to respond back, they get to
397              keep their stdout/stderr */
398           if(!(*info)->writeonly)
399             {
400               /* implied close of STDERR */
401               if(dup2(STDOUT_FILENO,STDERR_FILENO)==-1)
402                 _exit(1);
403
404               /* implied close of STDOUT */
405               close(from[0]);
406               if(dup2(from[1],STDOUT_FILENO)==-1)
407                 _exit(1);
408             }
409
410           /* implied close of STDIN */
411           close(to[1]);
412           if(dup2(to[0],STDIN_FILENO)==-1)
413             _exit(1);
414
415           if(args_in==NULL)
416             {
417               if(DBG_EXTPROG)
418                 log_debug("execlp: %s\n",program);
419
420               execlp(program,program,(void *)NULL);
421             }
422           else
423             {
424               if(DBG_EXTPROG)
425                 log_debug("execlp: %s -c %s\n",shell,(*info)->command);
426
427               execlp(shell,shell,"-c",(*info)->command,(void *)NULL);
428             }
429
430           /* If we get this far the exec failed.  Clean up and return. */
431
432           if(args_in==NULL)
433             log_error(_("unable to execute program `%s': %s\n"),
434                       program,strerror(errno));
435           else
436             log_error(_("unable to execute shell `%s': %s\n"),
437                       shell,strerror(errno));
438
439           /* This mimics the POSIX sh behavior - 127 means "not found"
440              from the shell. */
441           if(errno==ENOENT)
442             _exit(127);
443
444           _exit(1);
445         }
446
447       /* I'm the parent */
448
449       close(to[0]);
450
451       (*info)->tochild=fdopen(to[1],binary?"wb":"w");
452       if((*info)->tochild==NULL)
453         {
454           close(to[1]);
455           ret=G10ERR_WRITE_FILE;
456           goto fail;
457         }
458
459       close(from[1]);
460
461       (*info)->fromchild=iobuf_fdopen(from[0],"r");
462       if((*info)->fromchild==NULL)
463         {
464           close(from[0]);
465           ret=G10ERR_READ_FILE;
466           goto fail;
467         }
468
469       /* fd iobufs are cached?! */
470       iobuf_ioctl((*info)->fromchild,3,1,NULL);
471
472       return 0;
473     }
474 #endif /* !EXEC_TEMPFILE_ONLY */
475
476   if(DBG_EXTPROG)
477     log_debug("using temp file `%s'\n",(*info)->tempfile_in);
478
479   /* It's not fork/exec/pipe, so create a temp file */
480   (*info)->tochild=fopen((*info)->tempfile_in,binary?"wb":"w");
481   if((*info)->tochild==NULL)
482     {
483       log_error(_("can't create file `%s': %s\n"),
484                 (*info)->tempfile_in,strerror(errno));
485       ret=G10ERR_WRITE_FILE;
486       goto fail;
487     }
488
489   ret=0;
490
491  fail:
492   return ret;
493 }
494
495 int exec_read(struct exec_info *info)
496 {
497   int ret=G10ERR_GENERAL;
498
499   fclose(info->tochild);
500   info->tochild=NULL;
501
502   if(info->use_temp_files)
503     {
504       if(DBG_EXTPROG)
505         log_debug("system() command is %s\n",info->command);
506
507 #if defined (_WIN32)
508       info->progreturn=win_system(info->command);
509 #else
510       info->progreturn=system(info->command);
511 #endif
512
513       if(info->progreturn==-1)
514         {
515           log_error(_("system error while calling external program: %s\n"),
516                     strerror(errno));
517           info->progreturn=127;
518           goto fail;
519         }
520
521 #if defined(WIFEXITED) && defined(WEXITSTATUS)
522       if(WIFEXITED(info->progreturn))
523         info->progreturn=WEXITSTATUS(info->progreturn);
524       else
525         {
526           log_error(_("unnatural exit of external program\n"));
527           info->progreturn=127;
528           goto fail;
529         }
530 #else
531       /* If we don't have the macros, do the best we can. */
532       info->progreturn = (info->progreturn & 0xff00) >> 8;
533 #endif
534
535       /* 127 is the magic value returned from system() to indicate
536          that the shell could not be executed, or from /bin/sh to
537          indicate that the program could not be executed. */
538
539       if(info->progreturn==127)
540         {
541           log_error(_("unable to execute external program\n"));
542           goto fail;
543         }
544
545       if(!info->writeonly)
546         {
547           info->fromchild=iobuf_open(info->tempfile_out);
548           if(info->fromchild==NULL)
549             {
550               log_error(_("unable to read external program response: %s\n"),
551                         strerror(errno));
552               ret=G10ERR_READ_FILE;
553               goto fail;
554             }
555
556           /* Do not cache this iobuf on close */
557           iobuf_ioctl(info->fromchild,3,1,NULL);
558         }
559     }
560
561   ret=0;
562
563  fail:
564   return ret;
565 }
566
567 int exec_finish(struct exec_info *info)
568 {
569   int ret=info->progreturn;
570
571   if(info->fromchild)
572     iobuf_close(info->fromchild);
573
574   if(info->tochild)
575     fclose(info->tochild);
576
577 #ifndef EXEC_TEMPFILE_ONLY
578   if(info->child>0)
579     {
580       if(waitpid(info->child,&info->progreturn,0)!=0 &&
581          WIFEXITED(info->progreturn))
582         ret=WEXITSTATUS(info->progreturn);
583       else
584         {
585           log_error(_("unnatural exit of external program\n"));
586           ret=127;
587         }
588     }
589 #endif
590
591   if(info->madedir && !info->keep_temp_files)
592     {
593       if(info->tempfile_in)
594         {
595           if(unlink(info->tempfile_in)==-1)
596             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
597                      "in",info->tempfile_in,strerror(errno));
598         }
599   
600       if(info->tempfile_out)
601         {
602           if(unlink(info->tempfile_out)==-1)
603             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
604                      "out",info->tempfile_out,strerror(errno));
605         }
606
607       if(rmdir(info->tempdir)==-1)
608         log_info(_("WARNING: unable to remove temp directory `%s': %s\n"),
609                  info->tempdir,strerror(errno));
610     }
611
612   m_free(info->command);
613   m_free(info->name);
614   m_free(info->tempdir);
615   m_free(info->tempfile_in);
616   m_free(info->tempfile_out);
617   m_free(info);
618
619   return ret;
620 }
621 #endif /* ! NO_EXEC */