Change all quotes in strings and comments to the new GNU standard.
[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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 /*
21    FIXME: We should replace most code in this module by our
22    spawn implementation from common/exechelp.c.
23  */
24
25
26 #include <config.h>
27 #include <stdlib.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #include <sys/stat.h>
31 #include <sys/types.h>
32 #ifndef EXEC_TEMPFILE_ONLY
33 #include <sys/wait.h>
34 #endif
35 #ifdef HAVE_DOSISH_SYSTEM
36 #include <windows.h>
37 #endif
38 #include <fcntl.h>
39 #include <unistd.h>
40 #include <string.h>
41 #include <errno.h>
42
43 #include "gpg.h"
44 #include "options.h"
45 #include "i18n.h"
46 #include "iobuf.h"
47 #include "util.h"
48 #include "mkdtemp.h"  /* From gnulib. */
49 #include "membuf.h"
50 #include "exec.h"
51
52 #ifdef NO_EXEC
53 int
54 exec_write(struct exec_info **info,const char *program,
55                const char *args_in,const char *name,int writeonly,int binary)
56 {
57   log_error(_("no remote program execution supported\n"));
58   return G10ERR_GENERAL;
59 }
60
61 int
62 exec_read(struct exec_info *info) { return G10ERR_GENERAL; }
63 int
64 exec_finish(struct exec_info *info) { return G10ERR_GENERAL; }
65 int
66 set_exec_path(const char *path) { return G10ERR_GENERAL; }
67
68 #else /* ! NO_EXEC */
69
70 #if defined (_WIN32)
71 /* This is a nicer system() for windows that waits for programs to
72    return before returning control to the caller.  I hate helpful
73    computers. */
74 static int
75 w32_system(const char *command)
76 {
77 #ifdef HAVE_W32CE_SYSTEM
78 #warning Change this code to use common/exechelp.c
79 #else
80   PROCESS_INFORMATION pi;
81   STARTUPINFO si;
82   char *string;
83
84   /* We must use a copy of the command as CreateProcess modifies this
85      argument. */
86   string=xstrdup(command);
87
88   memset(&pi,0,sizeof(pi));
89   memset(&si,0,sizeof(si));
90   si.cb=sizeof(si);
91
92   if(!CreateProcess(NULL,string,NULL,NULL,FALSE,
93                     DETACHED_PROCESS,
94                     NULL,NULL,&si,&pi))
95     return -1;
96
97   /* Wait for the child to exit */
98   WaitForSingleObject(pi.hProcess,INFINITE);
99
100   CloseHandle(pi.hProcess);
101   CloseHandle(pi.hThread);
102   xfree(string);
103
104   return 0;
105 #endif
106 }
107 #endif
108
109 /* Replaces current $PATH */
110 int
111 set_exec_path(const char *path)
112 {
113 #ifdef HAVE_W32CE_SYSTEM
114 #warning Change this code to use common/exechelp.c
115 #else
116   char *p;
117
118   p=xmalloc(5+strlen(path)+1);
119   strcpy(p,"PATH=");
120   strcat(p,path);
121
122   if(DBG_EXTPROG)
123     log_debug("set_exec_path: %s\n",p);
124
125   /* Notice that path is never freed.  That is intentional due to the
126      way putenv() works.  This leaks a few bytes if we call
127      set_exec_path multiple times. */
128
129   if(putenv(p)!=0)
130     return G10ERR_GENERAL;
131   else
132     return 0;
133 #endif
134 }
135
136 /* Makes a temp directory and filenames */
137 static int
138 make_tempdir(struct exec_info *info)
139 {
140   char *tmp=opt.temp_dir,*namein=info->name,*nameout;
141
142   if(!namein)
143     namein=info->flags.binary?"tempin" EXTSEP_S "bin":"tempin" EXTSEP_S "txt";
144
145   nameout=info->flags.binary?"tempout" EXTSEP_S "bin":"tempout" EXTSEP_S "txt";
146
147   /* Make up the temp dir and files in case we need them */
148
149   if(tmp==NULL)
150     {
151 #if defined (_WIN32)
152       int err;
153
154       tmp=xmalloc(MAX_PATH+2);
155       err=GetTempPath(MAX_PATH+1,tmp);
156       if(err==0 || err>MAX_PATH+1)
157         strcpy(tmp,"c:\\windows\\temp");
158       else
159         {
160           int len=strlen(tmp);
161
162           /* GetTempPath may return with \ on the end */
163           while(len>0 && tmp[len-1]=='\\')
164             {
165               tmp[len-1]='\0';
166               len--;
167             }
168         }
169 #else /* More unixish systems */
170       tmp=getenv("TMPDIR");
171       if(tmp==NULL)
172         {
173           tmp=getenv("TMP");
174           if(tmp==NULL)
175             {
176 #ifdef __riscos__
177               tmp="<Wimp$ScrapDir>.GnuPG";
178               mkdir(tmp,0700); /* Error checks occur later on */
179 #else
180               tmp="/tmp";
181 #endif
182             }
183         }
184 #endif
185     }
186
187   info->tempdir=xmalloc(strlen(tmp)+strlen(DIRSEP_S)+10+1);
188
189   sprintf(info->tempdir,"%s" DIRSEP_S "gpg-XXXXXX",tmp);
190
191 #if defined (_WIN32)
192   xfree(tmp);
193 #endif
194
195   if(mkdtemp(info->tempdir)==NULL)
196     log_error(_("can't create directory '%s': %s\n"),
197               info->tempdir,strerror(errno));
198   else
199     {
200       info->flags.madedir=1;
201
202       info->tempfile_in=xmalloc(strlen(info->tempdir)+
203                                 strlen(DIRSEP_S)+strlen(namein)+1);
204       sprintf(info->tempfile_in,"%s" DIRSEP_S "%s",info->tempdir,namein);
205
206       if(!info->flags.writeonly)
207         {
208           info->tempfile_out=xmalloc(strlen(info->tempdir)+
209                                      strlen(DIRSEP_S)+strlen(nameout)+1);
210           sprintf(info->tempfile_out,"%s" DIRSEP_S "%s",info->tempdir,nameout);
211         }
212     }
213
214   return info->flags.madedir?0:G10ERR_GENERAL;
215 }
216
217 /* Expands %i and %o in the args to the full temp files within the
218    temp directory. */
219 static int
220 expand_args(struct exec_info *info,const char *args_in)
221 {
222   const char *ch = args_in;
223   membuf_t command;
224
225   info->flags.use_temp_files=0;
226   info->flags.keep_temp_files=0;
227
228   if(DBG_EXTPROG)
229     log_debug("expanding string \"%s\"\n",args_in);
230
231   init_membuf (&command, 100);
232
233   while(*ch!='\0')
234     {
235       if(*ch=='%')
236         {
237           char *append=NULL;
238
239           ch++;
240
241           switch(*ch)
242             {
243             case 'O':
244               info->flags.keep_temp_files=1;
245               /* fall through */
246
247             case 'o': /* out */
248               if(!info->flags.madedir)
249                 {
250                   if(make_tempdir(info))
251                     goto fail;
252                 }
253               append=info->tempfile_out;
254               info->flags.use_temp_files=1;
255               break;
256
257             case 'I':
258               info->flags.keep_temp_files=1;
259               /* fall through */
260
261             case 'i': /* in */
262               if(!info->flags.madedir)
263                 {
264                   if(make_tempdir(info))
265                     goto fail;
266                 }
267               append=info->tempfile_in;
268               info->flags.use_temp_files=1;
269               break;
270
271             case '%':
272               append="%";
273               break;
274             }
275
276           if(append)
277             put_membuf_str (&command, append);
278         }
279       else
280         put_membuf (&command, ch, 1);
281
282       ch++;
283     }
284
285   put_membuf (&command, "", 1);  /* Terminate string.  */
286
287   info->command = get_membuf (&command, NULL);
288   if (!info->command)
289     return gpg_error_from_syserror ();
290
291   if(DBG_EXTPROG)
292     log_debug("args expanded to \"%s\", use %u, keep %u\n",info->command,
293               info->flags.use_temp_files,info->flags.keep_temp_files);
294
295   return 0;
296
297  fail:
298   xfree (get_membuf (&command, NULL));
299   return G10ERR_GENERAL;
300 }
301
302 /* Either handles the tempfile creation, or the fork/exec.  If it
303    returns ok, then info->tochild is a FILE * that can be written to.
304    The rules are: if there are no args, then it's a fork/exec/pipe.
305    If there are args, but no tempfiles, then it's a fork/exec/pipe via
306    shell -c.  If there are tempfiles, then it's a system. */
307
308 int
309 exec_write(struct exec_info **info,const char *program,
310            const char *args_in,const char *name,int writeonly,int binary)
311 {
312   int ret=G10ERR_GENERAL;
313
314   if(opt.exec_disable && !opt.no_perm_warn)
315     {
316       log_info(_("external program calls are disabled due to unsafe "
317                  "options file permissions\n"));
318
319       return ret;
320     }
321
322 #if defined(HAVE_GETUID) && defined(HAVE_GETEUID)
323   /* There should be no way to get to this spot while still carrying
324      setuid privs.  Just in case, bomb out if we are. */
325   if ( getuid () != geteuid ())
326     BUG ();
327 #endif
328
329   if(program==NULL && args_in==NULL)
330     BUG();
331
332   *info=xmalloc_clear(sizeof(struct exec_info));
333
334   if(name)
335     (*info)->name=xstrdup(name);
336   (*info)->flags.binary=binary;
337   (*info)->flags.writeonly=writeonly;
338
339   /* Expand the args, if any */
340   if(args_in && expand_args(*info,args_in))
341     goto fail;
342
343 #ifdef EXEC_TEMPFILE_ONLY
344   if(!(*info)->flags.use_temp_files)
345     {
346       log_error(_("this platform requires temporary files when calling"
347                   " external programs\n"));
348       goto fail;
349     }
350
351 #else /* !EXEC_TEMPFILE_ONLY */
352
353   /* If there are no args, or there are args, but no temp files, we
354      can use fork/exec/pipe */
355   if(args_in==NULL || (*info)->flags.use_temp_files==0)
356     {
357       int to[2],from[2];
358
359       if(pipe(to)==-1)
360         goto fail;
361
362       if(pipe(from)==-1)
363         {
364           close(to[0]);
365           close(to[1]);
366           goto fail;
367         }
368
369       if(((*info)->child=fork())==-1)
370         {
371           close(to[0]);
372           close(to[1]);
373           close(from[0]);
374           close(from[1]);
375           goto fail;
376         }
377
378       if((*info)->child==0)
379         {
380           char *shell=getenv("SHELL");
381
382           if(shell==NULL)
383             shell="/bin/sh";
384
385           /* I'm the child */
386
387           /* If the program isn't going to respond back, they get to
388              keep their stdout/stderr */
389           if(!(*info)->flags.writeonly)
390             {
391               /* implied close of STDERR */
392               if(dup2(STDOUT_FILENO,STDERR_FILENO)==-1)
393                 _exit(1);
394
395               /* implied close of STDOUT */
396               close(from[0]);
397               if(dup2(from[1],STDOUT_FILENO)==-1)
398                 _exit(1);
399             }
400
401           /* implied close of STDIN */
402           close(to[1]);
403           if(dup2(to[0],STDIN_FILENO)==-1)
404             _exit(1);
405
406           if(args_in==NULL)
407             {
408               if(DBG_EXTPROG)
409                 log_debug("execlp: %s\n",program);
410
411               execlp(program,program,(void *)NULL);
412             }
413           else
414             {
415               if(DBG_EXTPROG)
416                 log_debug("execlp: %s -c %s\n",shell,(*info)->command);
417
418               execlp(shell,shell,"-c",(*info)->command,(void *)NULL);
419             }
420
421           /* If we get this far the exec failed.  Clean up and return. */
422
423           if(args_in==NULL)
424             log_error(_("unable to execute program '%s': %s\n"),
425                       program,strerror(errno));
426           else
427             log_error(_("unable to execute shell '%s': %s\n"),
428                       shell,strerror(errno));
429
430           /* This mimics the POSIX sh behavior - 127 means "not found"
431              from the shell. */
432           if(errno==ENOENT)
433             _exit(127);
434
435           _exit(1);
436         }
437
438       /* I'm the parent */
439
440       close(to[0]);
441
442       (*info)->tochild=fdopen(to[1],binary?"wb":"w");
443       if((*info)->tochild==NULL)
444         {
445           ret = gpg_error_from_syserror ();
446           close(to[1]);
447           goto fail;
448         }
449
450       close(from[1]);
451
452       (*info)->fromchild=iobuf_fdopen(from[0],"r");
453       if((*info)->fromchild==NULL)
454         {
455           ret = gpg_error_from_syserror ();
456           close(from[0]);
457           goto fail;
458         }
459
460       /* fd iobufs are cached! */
461       iobuf_ioctl((*info)->fromchild, IOBUF_IOCTL_NO_CACHE, 1, NULL);
462
463       return 0;
464     }
465 #endif /* !EXEC_TEMPFILE_ONLY */
466
467   if(DBG_EXTPROG)
468     log_debug("using temp file '%s'\n",(*info)->tempfile_in);
469
470   /* It's not fork/exec/pipe, so create a temp file */
471   if( is_secured_filename ((*info)->tempfile_in) )
472     {
473       (*info)->tochild = NULL;
474       gpg_err_set_errno (EPERM);
475     }
476   else
477     (*info)->tochild=fopen((*info)->tempfile_in,binary?"wb":"w");
478   if((*info)->tochild==NULL)
479     {
480       ret = gpg_error_from_syserror ();
481       log_error(_("can't create '%s': %s\n"),
482                 (*info)->tempfile_in,strerror(errno));
483       goto fail;
484     }
485
486   ret=0;
487
488  fail:
489   if (ret)
490     {
491       xfree (*info);
492       *info = NULL;
493     }
494   return ret;
495 }
496
497 int
498 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=w32_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               gpg_err_set_errno (EPERM);
557             }
558           if(info->fromchild==NULL)
559             {
560               ret = gpg_error_from_syserror ();
561               log_error(_("unable to read external program response: %s\n"),
562                         strerror(errno));
563               goto fail;
564             }
565
566           /* Do not cache this iobuf on close */
567           iobuf_ioctl(info->fromchild, IOBUF_IOCTL_NO_CACHE, 1, NULL);
568         }
569     }
570
571   ret=0;
572
573  fail:
574   return ret;
575 }
576
577 int
578 exec_finish(struct exec_info *info)
579 {
580   int ret=info->progreturn;
581
582   if(info->fromchild)
583     iobuf_close(info->fromchild);
584
585   if(info->tochild)
586     fclose(info->tochild);
587
588 #ifndef EXEC_TEMPFILE_ONLY
589   if(info->child>0)
590     {
591       if(waitpid(info->child,&info->progreturn,0)!=0 &&
592          WIFEXITED(info->progreturn))
593         ret=WEXITSTATUS(info->progreturn);
594       else
595         {
596           log_error(_("unnatural exit of external program\n"));
597           ret=127;
598         }
599     }
600 #endif
601
602   if(info->flags.madedir && !info->flags.keep_temp_files)
603     {
604       if(info->tempfile_in)
605         {
606           if(unlink(info->tempfile_in)==-1)
607             log_info(_("WARNING: unable to remove tempfile (%s) '%s': %s\n"),
608                      "in",info->tempfile_in,strerror(errno));
609         }
610
611       if(info->tempfile_out)
612         {
613           if(unlink(info->tempfile_out)==-1)
614             log_info(_("WARNING: unable to remove tempfile (%s) '%s': %s\n"),
615                      "out",info->tempfile_out,strerror(errno));
616         }
617
618       if(rmdir(info->tempdir)==-1)
619         log_info(_("WARNING: unable to remove temp directory '%s': %s\n"),
620                  info->tempdir,strerror(errno));
621     }
622
623   xfree(info->command);
624   xfree(info->name);
625   xfree(info->tempdir);
626   xfree(info->tempfile_in);
627   xfree(info->tempfile_out);
628   xfree(info);
629
630   return ret;
631 }
632 #endif /* ! NO_EXEC */