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