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