g10/exec.c

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