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