added fast-import to import-options
[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               size_t applen=strlen(append);
266
267               if(applen+len>size-1)
268                 {
269                   if(applen<100)
270                     applen=100;
271
272                   size+=applen;
273                   info->command=m_realloc(info->command,size);
274                 }
275
276               strcat(info->command,append);
277               len+=strlen(append);
278             }
279         }
280       else
281         {
282           if(len==size-1) /* leave room for the \0 */
283             {
284               size+=100;
285               info->command=m_realloc(info->command,size);
286             }
287
288           info->command[len++]=*ch;
289           info->command[len]='\0';
290         }
291
292       ch++;
293     }
294
295   if(DBG_EXTPROG)
296     log_debug("args expanded to \"%s\", use %d, keep %d\n",
297               info->command,info->use_temp_files,info->keep_temp_files);
298
299   return 0;
300
301  fail:
302
303   m_free(info->command);
304   info->command=NULL;
305
306   return G10ERR_GENERAL;
307 }
308
309 /* Either handles the tempfile creation, or the fork/exec.  If it
310    returns ok, then info->tochild is a FILE * that can be written to.
311    The rules are: if there are no args, then it's a fork/exec/pipe.
312    If there are args, but no tempfiles, then it's a fork/exec/pipe via
313    shell -c.  If there are tempfiles, then it's a system. */
314
315 int exec_write(struct exec_info **info,const char *program,
316                const char *args_in,const char *name,int writeonly,int binary)
317 {
318   int ret=G10ERR_GENERAL;
319
320   if(opt.exec_disable && !opt.no_perm_warn)
321     {
322       log_info(_("external program calls are disabled due to unsafe "
323                  "options file permissions\n"));
324
325       return ret;
326     }
327
328 #if defined(HAVE_GETUID) && defined(HAVE_GETEUID)
329   /* There should be no way to get to this spot while still carrying
330      setuid privs.  Just in case, bomb out if we are. */
331   if(getuid()!=geteuid())
332     BUG();
333 #endif
334
335   if(program==NULL && args_in==NULL)
336     BUG();
337
338   *info=m_alloc_clear(sizeof(struct exec_info));
339
340   if(name)
341     (*info)->name=m_strdup(name);
342   (*info)->binary=binary;
343   (*info)->writeonly=writeonly;
344
345   /* Expand the args, if any */
346   if(args_in && expand_args(*info,args_in))
347     goto fail;
348
349 #ifdef EXEC_TEMPFILE_ONLY
350   if(!(*info)->use_temp_files)
351     {
352       log_error(_("this platform requires temp files when calling external "
353                   "programs\n"));
354       goto fail;
355     }
356
357 #else /* !EXEC_TEMPFILE_ONLY */
358
359   /* If there are no args, or there are args, but no temp files, we
360      can use fork/exec/pipe */
361   if(args_in==NULL || (*info)->use_temp_files==0)
362     {
363       int to[2],from[2];
364
365       if(pipe(to)==-1)
366         goto fail;
367
368       if(pipe(from)==-1)
369         {
370           close(to[0]);
371           close(to[1]);
372           goto fail;
373         }
374
375       if(((*info)->child=fork())==-1)
376         {
377           close(to[0]);
378           close(to[1]);
379           close(from[0]);
380           close(from[1]);
381           goto fail;
382         }
383
384       if((*info)->child==0)
385         {
386           char *shell=getenv("SHELL");
387
388           if(shell==NULL)
389             shell="/bin/sh";
390
391           /* I'm the child */
392
393           /* If the program isn't going to respond back, they get to
394              keep their stdout/stderr */
395           if(!(*info)->writeonly)
396             {
397               /* implied close of STDERR */
398               if(dup2(STDOUT_FILENO,STDERR_FILENO)==-1)
399                 _exit(1);
400
401               /* implied close of STDOUT */
402               close(from[0]);
403               if(dup2(from[1],STDOUT_FILENO)==-1)
404                 _exit(1);
405             }
406
407           /* implied close of STDIN */
408           close(to[1]);
409           if(dup2(to[0],STDIN_FILENO)==-1)
410             _exit(1);
411
412           if(args_in==NULL)
413             {
414               if(DBG_EXTPROG)
415                 log_debug("execlp: %s\n",program);
416
417               execlp(program,program,NULL);
418             }
419           else
420             {
421               if(DBG_EXTPROG)
422                 log_debug("execlp: %s -c %s\n",shell,(*info)->command);
423
424               execlp(shell,shell,"-c",(*info)->command,NULL);
425             }
426
427           /* If we get this far the exec failed.  Clean up and return. */
428
429           log_error(_("unable to execute %s \"%s\": %s\n"),
430                     args_in==NULL?"program":"shell",
431                     args_in==NULL?program:shell,
432                     strerror(errno));
433
434           /* This mimics the POSIX sh behavior - 127 means "not found"
435              from the shell. */
436           if(errno==ENOENT)
437             _exit(127);
438
439           _exit(1);
440         }
441
442       /* I'm the parent */
443
444       close(to[0]);
445
446       (*info)->tochild=fdopen(to[1],binary?"wb":"w");
447       if((*info)->tochild==NULL)
448         {
449           close(to[1]);
450           ret=G10ERR_WRITE_FILE;
451           goto fail;
452         }
453
454       close(from[1]);
455
456       (*info)->fromchild=iobuf_fdopen(from[0],"r");
457       if((*info)->fromchild==NULL)
458         {
459           close(from[0]);
460           ret=G10ERR_READ_FILE;
461           goto fail;
462         }
463
464       /* fd iobufs are cached?! */
465       iobuf_ioctl((*info)->fromchild,3,1,NULL);
466
467       return 0;
468     }
469 #endif /* !EXEC_TEMPFILE_ONLY */
470
471   if(DBG_EXTPROG)
472     log_debug("using temp file `%s'\n",(*info)->tempfile_in);
473
474   /* It's not fork/exec/pipe, so create a temp file */
475   (*info)->tochild=fopen((*info)->tempfile_in,binary?"wb":"w");
476   if((*info)->tochild==NULL)
477     {
478       log_error(_("can't create `%s': %s\n"),
479                 (*info)->tempfile_in,strerror(errno));
480       ret=G10ERR_WRITE_FILE;
481       goto fail;
482     }
483
484   ret=0;
485
486  fail:
487   return ret;
488 }
489
490 int exec_read(struct exec_info *info)
491 {
492   int ret=G10ERR_GENERAL;
493
494   fclose(info->tochild);
495   info->tochild=NULL;
496
497   if(info->use_temp_files)
498     {
499       if(DBG_EXTPROG)
500         log_debug("system() command is %s\n",info->command);
501
502 #if defined (__MINGW32__) || defined (__CYGWIN32__)
503       info->progreturn=win_system(info->command);
504 #else
505       info->progreturn=system(info->command);
506 #endif
507
508       if(info->progreturn==-1)
509         {
510           log_error(_("system error while calling external program: %s\n"),
511                     strerror(errno));
512           info->progreturn=127;
513           goto fail;
514         }
515
516 #if defined(WIFEXITED) && defined(WEXITSTATUS)
517       if(WIFEXITED(info->progreturn))
518         info->progreturn=WEXITSTATUS(info->progreturn);
519       else
520         {
521           log_error(_("unnatural exit of external program\n"));
522           info->progreturn=127;
523           goto fail;
524         }
525 #else
526       /* If we don't have the macros, do the best we can. */
527       info->progreturn = (info->progreturn & 0xff00) >> 8;
528 #endif
529
530       /* 127 is the magic value returned from system() to indicate
531          that the shell could not be executed, or from /bin/sh to
532          indicate that the program could not be executed. */
533
534       if(info->progreturn==127)
535         {
536           log_error(_("unable to execute external program\n"));
537           goto fail;
538         }
539
540       if(!info->writeonly)
541         {
542           info->fromchild=iobuf_open(info->tempfile_out);
543           if(info->fromchild==NULL)
544             {
545               log_error(_("unable to read external program response: %s\n"),
546                         strerror(errno));
547               ret=G10ERR_READ_FILE;
548               goto fail;
549             }
550
551           /* Do not cache this iobuf on close */
552           iobuf_ioctl(info->fromchild,3,1,NULL);
553         }
554     }
555
556   ret=0;
557
558  fail:
559   return ret;
560 }
561
562 int exec_finish(struct exec_info *info)
563 {
564   int ret=info->progreturn;
565
566   if(info->fromchild)
567     iobuf_close(info->fromchild);
568
569   if(info->tochild)
570     fclose(info->tochild);
571
572 #ifndef EXEC_TEMPFILE_ONLY
573   if(info->child>0)
574     {
575       if(waitpid(info->child,&info->progreturn,0)!=0 &&
576          WIFEXITED(info->progreturn))
577         ret=WEXITSTATUS(info->progreturn);
578       else
579         {
580           log_error(_("unnatural exit of external program\n"));
581           ret=127;
582         }
583     }
584 #endif
585
586   if(info->madedir && !info->keep_temp_files)
587     {
588       if(info->tempfile_in)
589         {
590           if(unlink(info->tempfile_in)==-1)
591             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
592                      "in",info->tempfile_in,strerror(errno));
593         }
594   
595       if(info->tempfile_out)
596         {
597           if(unlink(info->tempfile_out)==-1)
598             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
599                      "out",info->tempfile_out,strerror(errno));
600         }
601
602       if(rmdir(info->tempdir)==-1)
603         log_info(_("WARNING: unable to remove temp directory `%s': %s\n"),
604                  info->tempdir,strerror(errno));
605     }
606
607   m_free(info->command);
608   m_free(info->name);
609   m_free(info->tempdir);
610   m_free(info->tempfile_in);
611   m_free(info->tempfile_out);
612   m_free(info);
613
614   return ret;
615 }
616 #endif /* ! NO_EXEC */
617