* exec.c (make_tempdir) [_WIN32]: Modified to properly handle
[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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <stdlib.h>
24 #include <stdarg.h>
25 #include <stdio.h>
26 #include <sys/stat.h>
27 #include <sys/types.h>
28 #ifndef EXEC_TEMPFILE_ONLY
29 #include <sys/wait.h>
30 #endif
31 #ifdef HAVE_DOSISH_SYSTEM
32 #include <windows.h>
33 #endif
34 #include <fcntl.h>
35 #include <unistd.h>
36 #include <string.h>
37 #include <errno.h>
38 #include "options.h"
39 #include "memory.h"
40 #include "i18n.h"
41 #include "iobuf.h"
42 #include "util.h"
43 #include "exec.h"
44
45 #ifdef NO_EXEC
46 int exec_write(struct exec_info **info,const char *program,
47                const char *args_in,const char *name,int writeonly,int binary)
48 {
49   log_error(_("no remote program execution supported\n"));
50   return G10ERR_GENERAL;
51 }
52
53 int exec_read(struct exec_info *info) { return G10ERR_GENERAL; }
54 int exec_finish(struct exec_info *info) { return G10ERR_GENERAL; }
55 int set_exec_path(const char *path) { return G10ERR_GENERAL; }
56
57 #else /* ! NO_EXEC */
58
59 #ifndef HAVE_MKDTEMP
60 char *mkdtemp(char *template);
61 #endif
62
63 #if defined (_WIN32)
64 /* This is a nicer system() for windows that waits for programs to
65    return before returning control to the caller.  I hate helpful
66    computers. */
67 static int win_system(const char *command)
68 {
69   PROCESS_INFORMATION pi;
70   STARTUPINFO si;
71   char *string;
72
73   /* We must use a copy of the command as CreateProcess modifies this
74      argument. */
75   string=xstrdup(command);
76
77   memset(&pi,0,sizeof(pi));
78   memset(&si,0,sizeof(si));
79   si.cb=sizeof(si);
80
81   if(!CreateProcess(NULL,string,NULL,NULL,FALSE,0,NULL,NULL,&si,&pi))
82     return -1;
83
84   /* Wait for the child to exit */
85   WaitForSingleObject(pi.hProcess,INFINITE);
86
87   CloseHandle(pi.hProcess);
88   CloseHandle(pi.hThread);
89   xfree(string);
90
91   return 0;
92 }
93 #endif
94
95 /* Replaces current $PATH */
96 int set_exec_path(const char *path)
97 {
98   char *p;
99
100   p=xmalloc(5+strlen(path)+1);
101   strcpy(p,"PATH=");
102   strcat(p,path);
103
104   if(DBG_EXTPROG)
105     log_debug("set_exec_path: %s\n",p);
106
107   /* Notice that path is never freed.  That is intentional due to the
108      way putenv() works.  This leaks a few bytes if we call
109      set_exec_path multiple times. */
110
111   if(putenv(p)!=0)
112     return G10ERR_GENERAL;
113   else
114     return 0;
115 }
116
117 /* Makes a temp directory and filenames */
118 static int make_tempdir(struct exec_info *info)
119 {
120   char *tmp=opt.temp_dir,*namein=info->name,*nameout;
121
122   if(!namein)
123     namein=info->flags.binary?"tempin" EXTSEP_S "bin":"tempin" EXTSEP_S "txt";
124
125   nameout=info->flags.binary?"tempout" EXTSEP_S "bin":"tempout" EXTSEP_S "txt";
126
127   /* Make up the temp dir and files in case we need them */
128
129   if(tmp==NULL)
130     {
131 #if defined (_WIN32)
132       int tmp_siz;
133       int len=0;
134
135       /* Poll temp path length */
136       tmp_siz=GetTempPath(0,NULL);
137       if(tmp_siz)
138         {
139           tmp=xmalloc(tmp_siz);
140           len=GetTempPath(tmp_siz,tmp);
141         }
142
143       if(len==0)
144         tmp=xstrdup("c:\\windows\\temp");
145       else
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=xmalloc(strlen(tmp)+strlen(DIRSEP_S)+10+1);
173
174   sprintf(info->tempdir,"%s" DIRSEP_S "gpg-XXXXXX",tmp);
175
176 #if defined (_WIN32)
177   xfree(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->flags.madedir=1;
186
187       info->tempfile_in=xmalloc(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->flags.writeonly)
192         {
193           info->tempfile_out=xmalloc(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->flags.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->flags.use_temp_files=0;
210   info->flags.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=xmalloc(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->flags.keep_temp_files=1;
232               /* fall through */
233
234             case 'o': /* out */
235               if(!info->flags.madedir)
236                 {
237                   if(make_tempdir(info))
238                     goto fail;
239                 }
240               append=info->tempfile_out;
241               info->flags.use_temp_files=1;
242               break;
243
244             case 'I':
245               info->flags.keep_temp_files=1;
246               /* fall through */
247
248             case 'i': /* in */
249               if(!info->flags.madedir)
250                 {
251                   if(make_tempdir(info))
252                     goto fail;
253                 }
254               append=info->tempfile_in;
255               info->flags.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=xrealloc(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=xrealloc(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 %u, keep %u\n",info->command,
297               info->flags.use_temp_files,info->flags.keep_temp_files);
298
299   return 0;
300
301  fail:
302
303   xfree(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=xmalloc_clear(sizeof(struct exec_info));
339
340   if(name)
341     (*info)->name=xstrdup(name);
342   (*info)->flags.binary=binary;
343   (*info)->flags.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)->flags.use_temp_files)
351     {
352       log_error(_("this platform requires temporary files when calling"
353                   " external 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)->flags.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)->flags.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,(void *)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,(void *)NULL);
425             }
426
427           /* If we get this far the exec failed.  Clean up and return. */
428
429           if(args_in==NULL)
430             log_error(_("unable to execute program `%s': %s\n"),
431                       program,strerror(errno));
432           else
433             log_error(_("unable to execute shell `%s': %s\n"),
434                       shell,strerror(errno));
435
436           /* This mimics the POSIX sh behavior - 127 means "not found"
437              from the shell. */
438           if(errno==ENOENT)
439             _exit(127);
440
441           _exit(1);
442         }
443
444       /* I'm the parent */
445
446       close(to[0]);
447
448       (*info)->tochild=fdopen(to[1],binary?"wb":"w");
449       if((*info)->tochild==NULL)
450         {
451           close(to[1]);
452           ret=G10ERR_WRITE_FILE;
453           goto fail;
454         }
455
456       close(from[1]);
457
458       (*info)->fromchild=iobuf_fdopen(from[0],"r");
459       if((*info)->fromchild==NULL)
460         {
461           close(from[0]);
462           ret=G10ERR_READ_FILE;
463           goto fail;
464         }
465
466       /* fd iobufs are cached?! */
467       iobuf_ioctl((*info)->fromchild,3,1,NULL);
468
469       return 0;
470     }
471 #endif /* !EXEC_TEMPFILE_ONLY */
472
473   if(DBG_EXTPROG)
474     log_debug("using temp file `%s'\n",(*info)->tempfile_in);
475
476   /* It's not fork/exec/pipe, so create a temp file */
477   if( is_secured_filename ((*info)->tempfile_in) )
478     {
479       (*info)->tochild = NULL;
480       errno = EPERM;
481     }
482   else
483     (*info)->tochild=fopen((*info)->tempfile_in,binary?"wb":"w");
484   if((*info)->tochild==NULL)
485     {
486       log_error(_("can't create `%s': %s\n"),
487                 (*info)->tempfile_in,strerror(errno));
488       ret=G10ERR_WRITE_FILE;
489       goto fail;
490     }
491
492   ret=0;
493
494  fail:
495   return ret;
496 }
497
498 int exec_read(struct exec_info *info)
499 {
500   int ret=G10ERR_GENERAL;
501
502   fclose(info->tochild);
503   info->tochild=NULL;
504
505   if(info->flags.use_temp_files)
506     {
507       if(DBG_EXTPROG)
508         log_debug("system() command is %s\n",info->command);
509
510 #if defined (_WIN32)
511       info->progreturn=win_system(info->command);
512 #else
513       info->progreturn=system(info->command);
514 #endif
515
516       if(info->progreturn==-1)
517         {
518           log_error(_("system error while calling external program: %s\n"),
519                     strerror(errno));
520           info->progreturn=127;
521           goto fail;
522         }
523
524 #if defined(WIFEXITED) && defined(WEXITSTATUS)
525       if(WIFEXITED(info->progreturn))
526         info->progreturn=WEXITSTATUS(info->progreturn);
527       else
528         {
529           log_error(_("unnatural exit of external program\n"));
530           info->progreturn=127;
531           goto fail;
532         }
533 #else
534       /* If we don't have the macros, do the best we can. */
535       info->progreturn = (info->progreturn & 0xff00) >> 8;
536 #endif
537
538       /* 127 is the magic value returned from system() to indicate
539          that the shell could not be executed, or from /bin/sh to
540          indicate that the program could not be executed. */
541
542       if(info->progreturn==127)
543         {
544           log_error(_("unable to execute external program\n"));
545           goto fail;
546         }
547
548       if(!info->flags.writeonly)
549         {
550           info->fromchild=iobuf_open(info->tempfile_out);
551           if (info->fromchild
552               && is_secured_file (iobuf_get_fd (info->fromchild)))
553             {
554               iobuf_close (info->fromchild);
555               info->fromchild = NULL;
556               errno = EPERM;
557             }
558           if(info->fromchild==NULL)
559             {
560               log_error(_("unable to read external program response: %s\n"),
561                         strerror(errno));
562               ret=G10ERR_READ_FILE;
563               goto fail;
564             }
565
566           /* Do not cache this iobuf on close */
567           iobuf_ioctl(info->fromchild,3,1,NULL);
568         }
569     }
570
571   ret=0;
572
573  fail:
574   return ret;
575 }
576
577 int exec_finish(struct exec_info *info)
578 {
579   int ret=info->progreturn;
580
581   if(info->fromchild)
582     iobuf_close(info->fromchild);
583
584   if(info->tochild)
585     fclose(info->tochild);
586
587 #ifndef EXEC_TEMPFILE_ONLY
588   if(info->child>0)
589     {
590       if(waitpid(info->child,&info->progreturn,0)!=0 &&
591          WIFEXITED(info->progreturn))
592         ret=WEXITSTATUS(info->progreturn);
593       else
594         {
595           log_error(_("unnatural exit of external program\n"));
596           ret=127;
597         }
598     }
599 #endif
600
601   if(info->flags.madedir && !info->flags.keep_temp_files)
602     {
603       if(info->tempfile_in)
604         {
605           if(unlink(info->tempfile_in)==-1)
606             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
607                      "in",info->tempfile_in,strerror(errno));
608         }
609   
610       if(info->tempfile_out)
611         {
612           if(unlink(info->tempfile_out)==-1)
613             log_info(_("WARNING: unable to remove tempfile (%s) `%s': %s\n"),
614                      "out",info->tempfile_out,strerror(errno));
615         }
616
617       if(rmdir(info->tempdir)==-1)
618         log_info(_("WARNING: unable to remove temp directory `%s': %s\n"),
619                  info->tempdir,strerror(errno));
620     }
621
622   xfree(info->command);
623   xfree(info->name);
624   xfree(info->tempdir);
625   xfree(info->tempfile_in);
626   xfree(info->tempfile_out);
627   xfree(info);
628
629   return ret;
630 }
631 #endif /* ! NO_EXEC */