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