common/iobuf.c: Replace use of literals with symbolic constants.
[gnupg.git] / common / iobuf.c
1 /* iobuf.c  -  File Handling for OpenPGP.
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003, 2004, 2006, 2007, 2008,
3  *               2009, 2010, 2011  Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * This file is free software; you can redistribute it and/or modify
8  * it under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * This file is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, see <http://www.gnu.org/licenses/>.
29  */
30
31 #include <config.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <errno.h>
36 #include <ctype.h>
37 #include <assert.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <fcntl.h>
41 #include <unistd.h>
42 #ifdef HAVE_W32_SYSTEM
43 # ifdef HAVE_WINSOCK2_H
44 #  include <winsock2.h>
45 # endif
46 # include <windows.h>
47 #endif
48 #ifdef __riscos__
49 # include <kernel.h>
50 # include <swis.h>
51 #endif /* __riscos__ */
52
53 #include <assuan.h>
54
55 #include "util.h"
56 #include "sysutils.h"
57 #include "iobuf.h"
58
59 /*-- Begin configurable part.  --*/
60
61 /* The size of the internal buffers.
62    NOTE: If you change this value you MUST also adjust the regression
63    test "armored_key_8192" in armor.test! */
64 #define IOBUF_BUFFER_SIZE  8192
65
66 /* To avoid a potential DoS with compression packets we better limit
67    the number of filters in a chain.  */
68 #define MAX_NESTING_FILTER 64
69
70 /*-- End configurable part.  --*/
71
72
73 #ifdef HAVE_W32_SYSTEM
74 # ifdef HAVE_W32CE_SYSTEM
75 #  define FD_FOR_STDIN  (es_fileno (es_stdin))
76 #  define FD_FOR_STDOUT (es_fileno (es_stdout))
77 # else
78 #  define FD_FOR_STDIN  (GetStdHandle (STD_INPUT_HANDLE))
79 #  define FD_FOR_STDOUT (GetStdHandle (STD_OUTPUT_HANDLE))
80 # endif
81 #else /*!HAVE_W32_SYSTEM*/
82 # define FD_FOR_STDIN  (0)
83 # define FD_FOR_STDOUT (1)
84 #endif /*!HAVE_W32_SYSTEM*/
85
86
87 /* The context used by the file filter.  */
88 typedef struct
89 {
90   gnupg_fd_t fp;       /* Open file pointer or handle.  */
91   int keep_open;
92   int no_cache;
93   int eof_seen;
94   int print_only_name; /* Flags indicating that fname is not a real file.  */
95   char fname[1];       /* Name of the file.  */
96 } file_filter_ctx_t;
97
98 /* The context used by the estream filter.  */
99 typedef struct
100 {
101   estream_t fp;        /* Open estream handle.  */
102   int keep_open;
103   int no_cache;
104   int eof_seen;
105   int print_only_name; /* Flags indicating that fname is not a real file.  */
106   char fname[1];       /* Name of the file.  */
107 } file_es_filter_ctx_t;
108
109
110 /* Object to control the "close cache".  */
111 struct close_cache_s
112 {
113   struct close_cache_s *next;
114   gnupg_fd_t fp;
115   char fname[1];
116 };
117 typedef struct close_cache_s *close_cache_t;
118 static close_cache_t close_cache;
119
120
121
122 #ifdef HAVE_W32_SYSTEM
123 typedef struct
124 {
125   int sock;
126   int keep_open;
127   int no_cache;
128   int eof_seen;
129   int print_only_name;  /* Flag indicating that fname is not a real file.  */
130   char fname[1];        /* Name of the file */
131
132 } sock_filter_ctx_t;
133 #endif /*HAVE_W32_SYSTEM*/
134
135 /* The first partial length header block must be of size 512
136  * to make it easier (and efficienter) we use a min. block size of 512
137  * for all chunks (but the last one) */
138 #define OP_MIN_PARTIAL_CHUNK      512
139 #define OP_MIN_PARTIAL_CHUNK_2POW 9
140
141 enum
142   {
143     BLOCK_FILTER_INPUT=1,
144     BLOCK_FILTER_OUTPUT=2,
145     BLOCK_FILTER_TEMP=3
146   };
147
148 /* The context we use for the block filter (used to handle OpenPGP
149    length information header).  */
150 typedef struct
151 {
152   int use;
153   size_t size;
154   size_t count;
155   int partial;     /* 1 = partial header, 2 in last partial packet.  */
156   char *buffer;    /* Used for partial header.  */
157   size_t buflen;   /* Used size of buffer.  */
158   int first_c;     /* First character of a partial header (which is > 0).  */
159   int eof;
160 }
161 block_filter_ctx_t;
162
163
164 /* Global flag to tell whether special file names are enabled.  See
165    gpg.c for an explanation of these file names.  FIXME: it does not
166    belong into the iobuf subsystem. */
167 static int special_names_enabled;
168
169 /* Local prototypes.  */
170 static int underflow (iobuf_t a);
171 static int translate_file_handle (int fd, int for_write);
172
173
174 \f
175 /* This is a replacement for strcmp.  Under W32 it does not
176    distinguish between backslash and slash.  */
177 static int
178 fd_cache_strcmp (const char *a, const char *b)
179 {
180 #ifdef HAVE_DOSISH_SYSTEM
181   for (; *a && *b; a++, b++)
182     {
183       if (*a != *b && !((*a == '/' && *b == '\\')
184                         || (*a == '\\' && *b == '/')) )
185         break;
186     }
187   return *(const unsigned char *)a - *(const unsigned char *)b;
188 #else
189   return strcmp (a, b);
190 #endif
191 }
192
193 /*
194  * Invalidate (i.e. close) a cached iobuf
195  */
196 static int
197 fd_cache_invalidate (const char *fname)
198 {
199   close_cache_t cc;
200   int rc = 0;
201
202   assert (fname);
203   if (DBG_IOBUF)
204     log_debug ("fd_cache_invalidate (%s)\n", fname);
205
206   for (cc = close_cache; cc; cc = cc->next)
207     {
208       if (cc->fp != GNUPG_INVALID_FD && !fd_cache_strcmp (cc->fname, fname))
209         {
210           if (DBG_IOBUF)
211             log_debug ("                did (%s)\n", cc->fname);
212 #ifdef HAVE_W32_SYSTEM
213           if (!CloseHandle (cc->fp))
214             rc = -1;
215 #else
216           rc = close (cc->fp);
217 #endif
218           cc->fp = GNUPG_INVALID_FD;
219         }
220     }
221   return rc;
222 }
223
224
225 /* Try to sync changes to the disk.  This is to avoid data loss during
226    a system crash in write/close/rename cycle on some file
227    systems.  */
228 static int
229 fd_cache_synchronize (const char *fname)
230 {
231   int err = 0;
232
233 #ifdef HAVE_FSYNC
234   close_cache_t cc;
235
236   if (DBG_IOBUF)
237     log_debug ("fd_cache_synchronize (%s)\n", fname);
238
239   for (cc=close_cache; cc; cc = cc->next )
240     {
241       if (cc->fp != GNUPG_INVALID_FD && !fd_cache_strcmp (cc->fname, fname))
242         {
243           if (DBG_IOBUF)
244             log_debug ("                 did (%s)\n", cc->fname);
245
246           err = fsync (cc->fp);
247         }
248     }
249 #else
250   (void)fname;
251 #endif /*HAVE_FSYNC*/
252
253   return err;
254 }
255
256
257 static gnupg_fd_t
258 direct_open (const char *fname, const char *mode, int mode700)
259 {
260 #ifdef HAVE_W32_SYSTEM
261   unsigned long da, cd, sm;
262   HANDLE hfile;
263
264   /* Note, that we do not handle all mode combinations */
265
266   /* According to the ReactOS source it seems that open() of the
267    * standard MSW32 crt does open the file in shared mode which is
268    * something new for MS applications ;-)
269    */
270   if (strchr (mode, '+'))
271     {
272       if (fd_cache_invalidate (fname))
273         return GNUPG_INVALID_FD;
274       da = GENERIC_READ | GENERIC_WRITE;
275       cd = OPEN_EXISTING;
276       sm = FILE_SHARE_READ | FILE_SHARE_WRITE;
277     }
278   else if (strchr (mode, 'w'))
279     {
280       if (fd_cache_invalidate (fname))
281         return GNUPG_INVALID_FD;
282       da = GENERIC_WRITE;
283       cd = CREATE_ALWAYS;
284       sm = FILE_SHARE_WRITE;
285     }
286   else
287     {
288       da = GENERIC_READ;
289       cd = OPEN_EXISTING;
290       sm = FILE_SHARE_READ;
291     }
292
293 #ifdef HAVE_W32CE_SYSTEM
294   {
295     wchar_t *wfname = utf8_to_wchar (fname);
296     if (wfname)
297       {
298         hfile = CreateFile (wfname, da, sm, NULL, cd,
299                             FILE_ATTRIBUTE_NORMAL, NULL);
300         xfree (wfname);
301       }
302     else
303       hfile = INVALID_HANDLE_VALUE;
304   }
305 #else
306   hfile = CreateFile (fname, da, sm, NULL, cd, FILE_ATTRIBUTE_NORMAL, NULL);
307 #endif
308   return hfile;
309
310 #else /*!HAVE_W32_SYSTEM*/
311
312   int oflag;
313   int cflag = S_IRUSR | S_IWUSR;
314
315   if (!mode700)
316     cflag |= S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
317
318   /* Note, that we do not handle all mode combinations */
319   if (strchr (mode, '+'))
320     {
321       if (fd_cache_invalidate (fname))
322         return GNUPG_INVALID_FD;
323       oflag = O_RDWR;
324     }
325   else if (strchr (mode, 'w'))
326     {
327       if (fd_cache_invalidate (fname))
328         return GNUPG_INVALID_FD;
329       oflag = O_WRONLY | O_CREAT | O_TRUNC;
330     }
331   else
332     {
333       oflag = O_RDONLY;
334     }
335 #ifdef O_BINARY
336   if (strchr (mode, 'b'))
337     oflag |= O_BINARY;
338 #endif
339
340 #ifdef __riscos__
341   {
342     struct stat buf;
343
344     /* Don't allow iobufs on directories */
345     if (!stat (fname, &buf) && S_ISDIR (buf.st_mode) && !S_ISREG (buf.st_mode))
346       return __set_errno (EISDIR);
347   }
348 #endif
349   return open (fname, oflag, cflag);
350
351 #endif /*!HAVE_W32_SYSTEM*/
352 }
353
354
355 /*
356  * Instead of closing an FD we keep it open and cache it for later reuse
357  * Note that this caching strategy only works if the process does not chdir.
358  */
359 static void
360 fd_cache_close (const char *fname, gnupg_fd_t fp)
361 {
362   close_cache_t cc;
363
364   assert (fp);
365   if (!fname || !*fname)
366     {
367 #ifdef HAVE_W32_SYSTEM
368       CloseHandle (fp);
369 #else
370       close (fp);
371 #endif
372       if (DBG_IOBUF)
373         log_debug ("fd_cache_close (%d) real\n", (int)fp);
374       return;
375     }
376   /* try to reuse a slot */
377   for (cc = close_cache; cc; cc = cc->next)
378     {
379       if (cc->fp == GNUPG_INVALID_FD && !fd_cache_strcmp (cc->fname, fname))
380         {
381           cc->fp = fp;
382           if (DBG_IOBUF)
383             log_debug ("fd_cache_close (%s) used existing slot\n", fname);
384           return;
385         }
386     }
387   /* add a new one */
388   if (DBG_IOBUF)
389     log_debug ("fd_cache_close (%s) new slot created\n", fname);
390   cc = xcalloc (1, sizeof *cc + strlen (fname));
391   strcpy (cc->fname, fname);
392   cc->fp = fp;
393   cc->next = close_cache;
394   close_cache = cc;
395 }
396
397 /*
398  * Do an direct_open on FNAME but first try to reuse one from the fd_cache
399  */
400 static gnupg_fd_t
401 fd_cache_open (const char *fname, const char *mode)
402 {
403   close_cache_t cc;
404
405   assert (fname);
406   for (cc = close_cache; cc; cc = cc->next)
407     {
408       if (cc->fp != GNUPG_INVALID_FD && !fd_cache_strcmp (cc->fname, fname))
409         {
410           gnupg_fd_t fp = cc->fp;
411           cc->fp = GNUPG_INVALID_FD;
412           if (DBG_IOBUF)
413             log_debug ("fd_cache_open (%s) using cached fp\n", fname);
414 #ifdef HAVE_W32_SYSTEM
415           if (SetFilePointer (fp, 0, NULL, FILE_BEGIN) == 0xffffffff)
416             {
417               log_error ("rewind file failed on handle %p: ec=%d\n",
418                          fp, (int) GetLastError ());
419               fp = GNUPG_INVALID_FD;
420             }
421 #else
422           if (lseek (fp, 0, SEEK_SET) == (off_t) - 1)
423             {
424               log_error ("can't rewind fd %d: %s\n", fp, strerror (errno));
425               fp = GNUPG_INVALID_FD;
426             }
427 #endif
428           return fp;
429         }
430     }
431   if (DBG_IOBUF)
432     log_debug ("fd_cache_open (%s) not cached\n", fname);
433   return direct_open (fname, mode, 0);
434 }
435
436
437 /****************
438  * Read data from a file into buf which has an allocated length of *LEN.
439  * return the number of read bytes in *LEN. OPAQUE is the FILE * of
440  * the stream. A is not used.
441  * control may be:
442  * IOBUFCTRL_INIT: called just before the function is linked into the
443  *                 list of function. This can be used to prepare internal
444  *                 data structures of the function.
445  * IOBUFCTRL_FREE: called just before the function is removed from the
446  *                  list of functions and can be used to release internal
447  *                  data structures or close a file etc.
448  * IOBUFCTRL_UNDERFLOW: called by iobuf_underflow to fill the buffer
449  *                  with new stuff. *RET_LEN is the available size of the
450  *                  buffer, and should be set to the number of bytes
451  *                  which were put into the buffer. The function
452  *                  returns 0 to indicate success, -1 on EOF and
453  *                  GPG_ERR_xxxxx for other errors.
454  *
455  * IOBUFCTRL_FLUSH: called by iobuf_flush() to write out the collected stuff.
456  *                  *RET_LAN is the number of bytes in BUF.
457  *
458  * IOBUFCTRL_CANCEL: send to all filters on behalf of iobuf_cancel.  The
459  *                  filter may take appropriate action on this message.
460  */
461 static int
462 file_filter (void *opaque, int control, iobuf_t chain, byte * buf,
463              size_t * ret_len)
464 {
465   file_filter_ctx_t *a = opaque;
466   gnupg_fd_t f = a->fp;
467   size_t size = *ret_len;
468   size_t nbytes = 0;
469   int rc = 0;
470
471   (void)chain; /* Not used.  */
472
473   if (control == IOBUFCTRL_UNDERFLOW)
474     {
475       assert (size); /* We need a buffer.  */
476       if (a->eof_seen)
477         {
478           rc = -1;
479           *ret_len = 0;
480         }
481       else
482         {
483 #ifdef HAVE_W32_SYSTEM
484           unsigned long nread;
485
486           nbytes = 0;
487           if (!ReadFile (f, buf, size, &nread, NULL))
488             {
489               int ec = (int) GetLastError ();
490               if (ec != ERROR_BROKEN_PIPE)
491                 {
492                   rc = gpg_error_from_errno (ec);
493                   log_error ("%s: read error: ec=%d\n", a->fname, ec);
494                 }
495             }
496           else if (!nread)
497             {
498               a->eof_seen = 1;
499               rc = -1;
500             }
501           else
502             {
503               nbytes = nread;
504             }
505
506 #else
507
508           int n;
509
510           nbytes = 0;
511           do
512             {
513               n = read (f, buf, size);
514             }
515           while (n == -1 && errno == EINTR);
516           if (n == -1)
517             {                   /* error */
518               if (errno != EPIPE)
519                 {
520                   rc = gpg_error_from_syserror ();
521                   log_error ("%s: read error: %s\n",
522                              a->fname, strerror (errno));
523                 }
524             }
525           else if (!n)
526             {                   /* eof */
527               a->eof_seen = 1;
528               rc = -1;
529             }
530           else
531             {
532               nbytes = n;
533             }
534 #endif
535           *ret_len = nbytes;
536         }
537     }
538   else if (control == IOBUFCTRL_FLUSH)
539     {
540       if (size)
541         {
542 #ifdef HAVE_W32_SYSTEM
543           byte *p = buf;
544           unsigned long n;
545
546           nbytes = size;
547           do
548             {
549               if (size && !WriteFile (f, p, nbytes, &n, NULL))
550                 {
551                   int ec = (int) GetLastError ();
552                   rc = gpg_error_from_errno (ec);
553                   log_error ("%s: write error: ec=%d\n", a->fname, ec);
554                   break;
555                 }
556               p += n;
557               nbytes -= n;
558             }
559           while (nbytes);
560           nbytes = p - buf;
561 #else
562           byte *p = buf;
563           int n;
564
565           nbytes = size;
566           do
567             {
568               do
569                 {
570                   n = write (f, p, nbytes);
571                 }
572               while (n == -1 && errno == EINTR);
573               if (n > 0)
574                 {
575                   p += n;
576                   nbytes -= n;
577                 }
578             }
579           while (n != -1 && nbytes);
580           if (n == -1)
581             {
582               rc = gpg_error_from_syserror ();
583               log_error ("%s: write error: %s\n", a->fname, strerror (errno));
584             }
585           nbytes = p - buf;
586 #endif
587         }
588       *ret_len = nbytes;
589     }
590   else if (control == IOBUFCTRL_INIT)
591     {
592       a->eof_seen = 0;
593       a->keep_open = 0;
594       a->no_cache = 0;
595     }
596   else if (control == IOBUFCTRL_DESC)
597     {
598       *(char **) buf = "file_filter(fd)";
599     }
600   else if (control == IOBUFCTRL_FREE)
601     {
602       if (f != FD_FOR_STDIN && f != FD_FOR_STDOUT)
603         {
604           if (DBG_IOBUF)
605             log_debug ("%s: close fd/handle %d\n", a->fname, FD2INT (f));
606           if (!a->keep_open)
607             fd_cache_close (a->no_cache ? NULL : a->fname, f);
608         }
609       f = GNUPG_INVALID_FD;
610       xfree (a); /* We can free our context now. */
611     }
612
613   return rc;
614 }
615
616
617 /* Similar to file_filter but using the estream system.  */
618 static int
619 file_es_filter (void *opaque, int control, iobuf_t chain, byte * buf,
620                 size_t * ret_len)
621 {
622   file_es_filter_ctx_t *a = opaque;
623   estream_t f = a->fp;
624   size_t size = *ret_len;
625   size_t nbytes = 0;
626   int rc = 0;
627
628   (void)chain; /* Not used.  */
629
630   if (control == IOBUFCTRL_UNDERFLOW)
631     {
632       assert (size); /* We need a buffer.  */
633       if (a->eof_seen)
634         {
635           rc = -1;
636           *ret_len = 0;
637         }
638       else
639         {
640           nbytes = 0;
641           rc = es_read (f, buf, size, &nbytes);
642           if (rc == -1)
643             {                   /* error */
644               rc = gpg_error_from_syserror ();
645               log_error ("%s: read error: %s\n", a->fname, strerror (errno));
646             }
647           else if (!nbytes)
648             {                   /* eof */
649               a->eof_seen = 1;
650               rc = -1;
651             }
652           *ret_len = nbytes;
653         }
654     }
655   else if (control == IOBUFCTRL_FLUSH)
656     {
657       if (size)
658         {
659           byte *p = buf;
660           size_t nwritten;
661
662           nbytes = size;
663           do
664             {
665               nwritten = 0;
666               if (es_write (f, p, nbytes, &nwritten))
667                 {
668                   rc = gpg_error_from_syserror ();
669                   log_error ("%s: write error: %s\n",
670                              a->fname, strerror (errno));
671                   break;
672                 }
673               p += nwritten;
674               nbytes -= nwritten;
675             }
676           while (nbytes);
677           nbytes = p - buf;
678         }
679       *ret_len = nbytes;
680     }
681   else if (control == IOBUFCTRL_INIT)
682     {
683       a->eof_seen = 0;
684       a->no_cache = 0;
685     }
686   else if (control == IOBUFCTRL_DESC)
687     {
688       *(char **) buf = "estream_filter";
689     }
690   else if (control == IOBUFCTRL_FREE)
691     {
692       if (f != es_stdin && f != es_stdout)
693         {
694           if (DBG_IOBUF)
695             log_debug ("%s: es_fclose %p\n", a->fname, f);
696           if (!a->keep_open)
697             es_fclose (f);
698         }
699       f = NULL;
700       xfree (a); /* We can free our context now. */
701     }
702
703   return rc;
704 }
705
706
707 #ifdef HAVE_W32_SYSTEM
708 /* Because network sockets are special objects under Lose32 we have to
709    use a dedicated filter for them. */
710 static int
711 sock_filter (void *opaque, int control, iobuf_t chain, byte * buf,
712              size_t * ret_len)
713 {
714   sock_filter_ctx_t *a = opaque;
715   size_t size = *ret_len;
716   size_t nbytes = 0;
717   int rc = 0;
718
719   (void)chain;
720
721   if (control == IOBUFCTRL_UNDERFLOW)
722     {
723       assert (size);            /* need a buffer */
724       if (a->eof_seen)
725         {
726           rc = -1;
727           *ret_len = 0;
728         }
729       else
730         {
731           int nread;
732
733           nread = recv (a->sock, buf, size, 0);
734           if (nread == SOCKET_ERROR)
735             {
736               int ec = (int) WSAGetLastError ();
737               rc = gpg_error_from_errno (ec);
738               log_error ("socket read error: ec=%d\n", ec);
739             }
740           else if (!nread)
741             {
742               a->eof_seen = 1;
743               rc = -1;
744             }
745           else
746             {
747               nbytes = nread;
748             }
749           *ret_len = nbytes;
750         }
751     }
752   else if (control == IOBUFCTRL_FLUSH)
753     {
754       if (size)
755         {
756           byte *p = buf;
757           int n;
758
759           nbytes = size;
760           do
761             {
762               n = send (a->sock, p, nbytes, 0);
763               if (n == SOCKET_ERROR)
764                 {
765                   int ec = (int) WSAGetLastError ();
766                   rc = gpg_error_from_errno (ec);
767                   log_error ("socket write error: ec=%d\n", ec);
768                   break;
769                 }
770               p += n;
771               nbytes -= n;
772             }
773           while (nbytes);
774           nbytes = p - buf;
775         }
776       *ret_len = nbytes;
777     }
778   else if (control == IOBUFCTRL_INIT)
779     {
780       a->eof_seen = 0;
781       a->keep_open = 0;
782       a->no_cache = 0;
783     }
784   else if (control == IOBUFCTRL_DESC)
785     {
786       *(char **) buf = "sock_filter";
787     }
788   else if (control == IOBUFCTRL_FREE)
789     {
790       if (!a->keep_open)
791         closesocket (a->sock);
792       xfree (a);                /* we can free our context now */
793     }
794   return rc;
795 }
796 #endif /*HAVE_W32_SYSTEM*/
797
798 /****************
799  * This is used to implement the block write mode.
800  * Block reading is done on a byte by byte basis in readbyte(),
801  * without a filter
802  */
803 static int
804 block_filter (void *opaque, int control, iobuf_t chain, byte * buffer,
805               size_t * ret_len)
806 {
807   block_filter_ctx_t *a = opaque;
808   char *buf = (char *)buffer;
809   size_t size = *ret_len;
810   int c, needed, rc = 0;
811   char *p;
812
813   if (control == IOBUFCTRL_UNDERFLOW)
814     {
815       size_t n = 0;
816
817       p = buf;
818       assert (size);            /* need a buffer */
819       if (a->eof)               /* don't read any further */
820         rc = -1;
821       while (!rc && size)
822         {
823           if (!a->size)
824             {                   /* get the length bytes */
825               if (a->partial == 2)
826                 {
827                   a->eof = 1;
828                   if (!n)
829                     rc = -1;
830                   break;
831                 }
832               else if (a->partial)
833                 {
834                   /* These OpenPGP introduced huffman like encoded length
835                    * bytes are really a mess :-( */
836                   if (a->first_c)
837                     {
838                       c = a->first_c;
839                       a->first_c = 0;
840                     }
841                   else if ((c = iobuf_get (chain)) == -1)
842                     {
843                       log_error ("block_filter: 1st length byte missing\n");
844                       rc = GPG_ERR_BAD_DATA;
845                       break;
846                     }
847                   if (c < 192)
848                     {
849                       a->size = c;
850                       a->partial = 2;
851                       if (!a->size)
852                         {
853                           a->eof = 1;
854                           if (!n)
855                             rc = -1;
856                           break;
857                         }
858                     }
859                   else if (c < 224)
860                     {
861                       a->size = (c - 192) * 256;
862                       if ((c = iobuf_get (chain)) == -1)
863                         {
864                           log_error
865                             ("block_filter: 2nd length byte missing\n");
866                           rc = GPG_ERR_BAD_DATA;
867                           break;
868                         }
869                       a->size += c + 192;
870                       a->partial = 2;
871                       if (!a->size)
872                         {
873                           a->eof = 1;
874                           if (!n)
875                             rc = -1;
876                           break;
877                         }
878                     }
879                   else if (c == 255)
880                     {
881                       a->size = (size_t)iobuf_get (chain) << 24;
882                       a->size |= iobuf_get (chain) << 16;
883                       a->size |= iobuf_get (chain) << 8;
884                       if ((c = iobuf_get (chain)) == -1)
885                         {
886                           log_error ("block_filter: invalid 4 byte length\n");
887                           rc = GPG_ERR_BAD_DATA;
888                           break;
889                         }
890                       a->size |= c;
891                       a->partial = 2;
892                       if (!a->size)
893                         {
894                           a->eof = 1;
895                           if (!n)
896                             rc = -1;
897                           break;
898                         }
899                     }
900                   else
901                     { /* Next partial body length. */
902                       a->size = 1 << (c & 0x1f);
903                     }
904                   /*  log_debug("partial: ctx=%p c=%02x size=%u\n", a, c, a->size); */
905                 }
906               else
907                 BUG ();
908             }
909
910           while (!rc && size && a->size)
911             {
912               needed = size < a->size ? size : a->size;
913               c = iobuf_read (chain, p, needed);
914               if (c < needed)
915                 {
916                   if (c == -1)
917                     c = 0;
918                   log_error
919                     ("block_filter %p: read error (size=%lu,a->size=%lu)\n",
920                      a, (ulong) size + c, (ulong) a->size + c);
921                   rc = GPG_ERR_BAD_DATA;
922                 }
923               else
924                 {
925                   size -= c;
926                   a->size -= c;
927                   p += c;
928                   n += c;
929                 }
930             }
931         }
932       *ret_len = n;
933     }
934   else if (control == IOBUFCTRL_FLUSH)
935     {
936       if (a->partial)
937         {                       /* the complicated openpgp scheme */
938           size_t blen, n, nbytes = size + a->buflen;
939
940           assert (a->buflen <= OP_MIN_PARTIAL_CHUNK);
941           if (nbytes < OP_MIN_PARTIAL_CHUNK)
942             {
943               /* not enough to write a partial block out; so we store it */
944               if (!a->buffer)
945                 a->buffer = xmalloc (OP_MIN_PARTIAL_CHUNK);
946               memcpy (a->buffer + a->buflen, buf, size);
947               a->buflen += size;
948             }
949           else
950             {                   /* okay, we can write out something */
951               /* do this in a loop to use the most efficient block lengths */
952               p = buf;
953               do
954                 {
955                   /* find the best matching block length - this is limited
956                    * by the size of the internal buffering */
957                   for (blen = OP_MIN_PARTIAL_CHUNK * 2,
958                        c = OP_MIN_PARTIAL_CHUNK_2POW + 1; blen <= nbytes;
959                        blen *= 2, c++)
960                     ;
961                   blen /= 2;
962                   c--;
963                   /* write the partial length header */
964                   assert (c <= 0x1f);   /*;-) */
965                   c |= 0xe0;
966                   iobuf_put (chain, c);
967                   if ((n = a->buflen))
968                     {           /* write stuff from the buffer */
969                       assert (n == OP_MIN_PARTIAL_CHUNK);
970                       if (iobuf_write (chain, a->buffer, n))
971                         rc = gpg_error_from_syserror ();
972                       a->buflen = 0;
973                       nbytes -= n;
974                     }
975                   if ((n = nbytes) > blen)
976                     n = blen;
977                   if (n && iobuf_write (chain, p, n))
978                     rc = gpg_error_from_syserror ();
979                   p += n;
980                   nbytes -= n;
981                 }
982               while (!rc && nbytes >= OP_MIN_PARTIAL_CHUNK);
983               /* store the rest in the buffer */
984               if (!rc && nbytes)
985                 {
986                   assert (!a->buflen);
987                   assert (nbytes < OP_MIN_PARTIAL_CHUNK);
988                   if (!a->buffer)
989                     a->buffer = xmalloc (OP_MIN_PARTIAL_CHUNK);
990                   memcpy (a->buffer, p, nbytes);
991                   a->buflen = nbytes;
992                 }
993             }
994         }
995       else
996         BUG ();
997     }
998   else if (control == IOBUFCTRL_INIT)
999     {
1000       if (DBG_IOBUF)
1001         log_debug ("init block_filter %p\n", a);
1002       if (a->partial)
1003         a->count = 0;
1004       else if (a->use == BLOCK_FILTER_INPUT)
1005         a->count = a->size = 0;
1006       else
1007         a->count = a->size;     /* force first length bytes */
1008       a->eof = 0;
1009       a->buffer = NULL;
1010       a->buflen = 0;
1011     }
1012   else if (control == IOBUFCTRL_DESC)
1013     {
1014       *(char **) buf = "block_filter";
1015     }
1016   else if (control == IOBUFCTRL_FREE)
1017     {
1018       if (a->use == BLOCK_FILTER_OUTPUT)
1019         {                       /* write the end markers */
1020           if (a->partial)
1021             {
1022               u32 len;
1023               /* write out the remaining bytes without a partial header
1024                * the length of this header may be 0 - but if it is
1025                * the first block we are not allowed to use a partial header
1026                * and frankly we can't do so, because this length must be
1027                * a power of 2. This is _really_ complicated because we
1028                * have to check the possible length of a packet prior
1029                * to it's creation: a chain of filters becomes complicated
1030                * and we need a lot of code to handle compressed packets etc.
1031                *   :-(((((((
1032                */
1033               /* construct header */
1034               len = a->buflen;
1035               /*log_debug("partial: remaining length=%u\n", len ); */
1036               if (len < 192)
1037                 rc = iobuf_put (chain, len);
1038               else if (len < 8384)
1039                 {
1040                   if (!(rc = iobuf_put (chain, ((len - 192) / 256) + 192)))
1041                     rc = iobuf_put (chain, ((len - 192) % 256));
1042                 }
1043               else
1044                 {               /* use a 4 byte header */
1045                   if (!(rc = iobuf_put (chain, 0xff)))
1046                     if (!(rc = iobuf_put (chain, (len >> 24) & 0xff)))
1047                       if (!(rc = iobuf_put (chain, (len >> 16) & 0xff)))
1048                         if (!(rc = iobuf_put (chain, (len >> 8) & 0xff)))
1049                           rc = iobuf_put (chain, len & 0xff);
1050                 }
1051               if (!rc && len)
1052                 rc = iobuf_write (chain, a->buffer, len);
1053               if (rc)
1054                 {
1055                   log_error ("block_filter: write error: %s\n",
1056                              strerror (errno));
1057                   rc = gpg_error_from_syserror ();
1058                 }
1059               xfree (a->buffer);
1060               a->buffer = NULL;
1061               a->buflen = 0;
1062             }
1063           else
1064             BUG ();
1065         }
1066       else if (a->size)
1067         {
1068           log_error ("block_filter: pending bytes!\n");
1069         }
1070       if (DBG_IOBUF)
1071         log_debug ("free block_filter %p\n", a);
1072       xfree (a);                /* we can free our context now */
1073     }
1074
1075   return rc;
1076 }
1077
1078
1079 static void
1080 print_chain (iobuf_t a)
1081 {
1082   if (!DBG_IOBUF)
1083     return;
1084   for (; a; a = a->chain)
1085     {
1086       size_t dummy_len = 0;
1087       const char *desc = "[none]";
1088
1089       if (a->filter)
1090         a->filter (a->filter_ov, IOBUFCTRL_DESC, NULL,
1091                    (byte *) & desc, &dummy_len);
1092
1093       log_debug ("iobuf chain: %d.%d '%s' filter_eof=%d start=%d len=%d\n",
1094                  a->no, a->subno, desc?desc:"?", a->filter_eof,
1095                  (int) a->d.start, (int) a->d.len);
1096     }
1097 }
1098
1099 int
1100 iobuf_print_chain (iobuf_t a)
1101 {
1102   print_chain (a);
1103   return 0;
1104 }
1105
1106 /* Allocate a new io buffer, with no function assigned.
1107
1108    USE is the desired usage: BLOCK_FILTER_INPUT for input,
1109    BLOCK_FILTER_OUTPUT for output, or BLOCK_FILTER_TEMP for a temp
1110    buffer.
1111
1112    BUFSIZE is a suggested buffer size.
1113  */
1114 iobuf_t
1115 iobuf_alloc (int use, size_t bufsize)
1116 {
1117   iobuf_t a;
1118   static int number = 0;
1119
1120   assert (use == BLOCK_FILTER_INPUT
1121           || use == BLOCK_FILTER_OUTPUT
1122           || use == BLOCK_FILTER_TEMP);
1123
1124   a = xcalloc (1, sizeof *a);
1125   a->use = use;
1126   a->d.buf = xmalloc (bufsize);
1127   a->d.size = bufsize;
1128   a->no = ++number;
1129   a->subno = 0;
1130   a->opaque = NULL;
1131   a->real_fname = NULL;
1132   return a;
1133 }
1134
1135 int
1136 iobuf_close (iobuf_t a)
1137 {
1138   iobuf_t a2;
1139   size_t dummy_len = 0;
1140   int rc = 0;
1141
1142   if (a && a->directfp)
1143     {
1144       fclose (a->directfp);
1145       xfree (a->real_fname);
1146       if (DBG_IOBUF)
1147         log_debug ("iobuf_close -> %p\n", a->directfp);
1148       return 0;
1149     }
1150
1151   for (; a && !rc; a = a2)
1152     {
1153       a2 = a->chain;
1154       if (a->use == BLOCK_FILTER_OUTPUT && (rc = iobuf_flush (a)))
1155         log_error ("iobuf_flush failed on close: %s\n", gpg_strerror (rc));
1156
1157       if (DBG_IOBUF)
1158         log_debug ("iobuf-%d.%d: close '%s'\n", a->no, a->subno,
1159                    a->desc?a->desc:"?");
1160       if (a->filter && (rc = a->filter (a->filter_ov, IOBUFCTRL_FREE,
1161                                         a->chain, NULL, &dummy_len)))
1162         log_error ("IOBUFCTRL_FREE failed on close: %s\n", gpg_strerror (rc));
1163       xfree (a->real_fname);
1164       if (a->d.buf)
1165         {
1166           memset (a->d.buf, 0, a->d.size);      /* erase the buffer */
1167           xfree (a->d.buf);
1168         }
1169       xfree (a);
1170     }
1171   return rc;
1172 }
1173
1174 int
1175 iobuf_cancel (iobuf_t a)
1176 {
1177   const char *s;
1178   iobuf_t a2;
1179   int rc;
1180 #if defined(HAVE_W32_SYSTEM) || defined(__riscos__)
1181   char *remove_name = NULL;
1182 #endif
1183
1184   if (a && a->use == BLOCK_FILTER_OUTPUT)
1185     {
1186       s = iobuf_get_real_fname (a);
1187       if (s && *s)
1188         {
1189 #if defined(HAVE_W32_SYSTEM) || defined(__riscos__)
1190           remove_name = xstrdup (s);
1191 #else
1192           remove (s);
1193 #endif
1194         }
1195     }
1196
1197   /* send a cancel message to all filters */
1198   for (a2 = a; a2; a2 = a2->chain)
1199     {
1200       size_t dummy;
1201       if (a2->filter)
1202         a2->filter (a2->filter_ov, IOBUFCTRL_CANCEL, a2->chain, NULL, &dummy);
1203     }
1204
1205   rc = iobuf_close (a);
1206 #if defined(HAVE_W32_SYSTEM) || defined(__riscos__)
1207   if (remove_name)
1208     {
1209       /* Argg, MSDOS does not allow to remove open files.  So
1210        * we have to do it here */
1211 #ifdef HAVE_W32CE_SYSTEM
1212       wchar_t *wtmp = utf8_to_wchar (remove_name);
1213       if (wtmp)
1214         DeleteFile (wtmp);
1215       xfree (wtmp);
1216 #else
1217       remove (remove_name);
1218 #endif
1219       xfree (remove_name);
1220     }
1221 #endif
1222   return rc;
1223 }
1224
1225
1226 /****************
1227  * create a temporary iobuf, which can be used to collect stuff
1228  * in an iobuf and later be written by iobuf_write_temp() to another
1229  * iobuf.
1230  */
1231 iobuf_t
1232 iobuf_temp ()
1233 {
1234   iobuf_t a;
1235
1236   a = iobuf_alloc (3, IOBUF_BUFFER_SIZE);
1237
1238   return a;
1239 }
1240
1241 iobuf_t
1242 iobuf_temp_with_content (const char *buffer, size_t length)
1243 {
1244   iobuf_t a;
1245   int i;
1246
1247   a = iobuf_alloc (3, length);
1248   /* memcpy (a->d.buf, buffer, length); */
1249   for (i=0; i < length; i++)
1250     a->d.buf[i] = buffer[i];
1251   a->d.len = length;
1252
1253   return a;
1254 }
1255
1256 void
1257 iobuf_enable_special_filenames (int yes)
1258 {
1259   special_names_enabled = yes;
1260 }
1261
1262
1263 /* See whether the filename has the form "-&nnnn", where n is a
1264    non-zero number.  Returns this number or -1 if it is not the
1265    case.  */
1266 static int
1267 check_special_filename (const char *fname)
1268 {
1269   if (special_names_enabled && fname && *fname == '-' && fname[1] == '&')
1270     {
1271       int i;
1272
1273       fname += 2;
1274       for (i = 0; digitp (fname+i); i++)
1275         ;
1276       if (!fname[i])
1277         return atoi (fname);
1278     }
1279   return -1;
1280 }
1281
1282
1283 /* This fucntion returns true if FNAME indicates a PIPE (stdout or
1284    stderr) or a special file name if those are enabled. */
1285 int
1286 iobuf_is_pipe_filename (const char *fname)
1287 {
1288   if (!fname || (*fname=='-' && !fname[1]) )
1289     return 1;
1290   return check_special_filename (fname) != -1;
1291 }
1292
1293
1294 /* Either open the file specified by the file descriptor FD or - if FD
1295    is -1, the file with name FNAME.  As of now MODE is assumed to be
1296    "rb" if FNAME is used.  In contrast to iobuf_fdopen the file
1297    descriptor FD will not be closed during an iobuf_close.  */
1298 iobuf_t
1299 iobuf_open_fd_or_name (gnupg_fd_t fd, const char *fname, const char *mode)
1300 {
1301   iobuf_t a;
1302
1303   if (fd == GNUPG_INVALID_FD)
1304     a = iobuf_open (fname);
1305   else
1306     a = iobuf_fdopen_nc (FD2INT(fd), mode);
1307   return a;
1308 }
1309
1310
1311 /****************
1312  * Create a head iobuf for reading from a file
1313  * returns: NULL if an error occures and sets errno
1314  */
1315 iobuf_t
1316 iobuf_open (const char *fname)
1317 {
1318   iobuf_t a;
1319   gnupg_fd_t fp;
1320   file_filter_ctx_t *fcx;
1321   size_t len = 0;
1322   int print_only = 0;
1323   int fd;
1324
1325   if (!fname || (*fname == '-' && !fname[1]))
1326     {
1327       fp = FD_FOR_STDIN;
1328       fname = "[stdin]";
1329       print_only = 1;
1330     }
1331   else if ((fd = check_special_filename (fname)) != -1)
1332     return iobuf_fdopen (translate_file_handle (fd, 0), "rb");
1333   else if ((fp = fd_cache_open (fname, "rb")) == GNUPG_INVALID_FD)
1334     return NULL;
1335   a = iobuf_alloc (1, IOBUF_BUFFER_SIZE);
1336   fcx = xmalloc (sizeof *fcx + strlen (fname));
1337   fcx->fp = fp;
1338   fcx->print_only_name = print_only;
1339   strcpy (fcx->fname, fname);
1340   if (!print_only)
1341     a->real_fname = xstrdup (fname);
1342   a->filter = file_filter;
1343   a->filter_ov = fcx;
1344   file_filter (fcx, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &len);
1345   file_filter (fcx, IOBUFCTRL_INIT, NULL, NULL, &len);
1346   if (DBG_IOBUF)
1347     log_debug ("iobuf-%d.%d: open '%s' fd=%d\n",
1348                a->no, a->subno, fname, FD2INT (fcx->fp));
1349
1350   return a;
1351 }
1352
1353
1354 static iobuf_t
1355 do_iobuf_fdopen (int fd, const char *mode, int keep_open)
1356 {
1357   iobuf_t a;
1358   gnupg_fd_t fp;
1359   file_filter_ctx_t *fcx;
1360   size_t len;
1361
1362   fp = INT2FD (fd);
1363
1364   a = iobuf_alloc (strchr (mode, 'w') ? 2 : 1, IOBUF_BUFFER_SIZE);
1365   fcx = xmalloc (sizeof *fcx + 20);
1366   fcx->fp = fp;
1367   fcx->print_only_name = 1;
1368   fcx->keep_open = keep_open;
1369   sprintf (fcx->fname, "[fd %d]", fd);
1370   a->filter = file_filter;
1371   a->filter_ov = fcx;
1372   file_filter (fcx, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &len);
1373   file_filter (fcx, IOBUFCTRL_INIT, NULL, NULL, &len);
1374   if (DBG_IOBUF)
1375     log_debug ("iobuf-%d.%d: fdopen%s '%s'\n",
1376                a->no, a->subno, keep_open? "_nc":"", fcx->fname);
1377   iobuf_ioctl (a, IOBUF_IOCTL_NO_CACHE, 1, NULL);
1378   return a;
1379 }
1380
1381
1382 /* Create a head iobuf for reading or writing from/to a file Returns:
1383  * NULL and sets ERRNO if an error occured.  */
1384 iobuf_t
1385 iobuf_fdopen (int fd, const char *mode)
1386 {
1387   return do_iobuf_fdopen (fd, mode, 0);
1388 }
1389
1390 iobuf_t
1391 iobuf_fdopen_nc (int fd, const char *mode)
1392 {
1393   return do_iobuf_fdopen (fd, mode, 1);
1394 }
1395
1396
1397 iobuf_t
1398 iobuf_esopen (estream_t estream, const char *mode, int keep_open)
1399 {
1400   iobuf_t a;
1401   file_es_filter_ctx_t *fcx;
1402   size_t len;
1403
1404   a = iobuf_alloc (strchr (mode, 'w') ? 2 : 1, IOBUF_BUFFER_SIZE);
1405   fcx = xtrymalloc (sizeof *fcx + 30);
1406   fcx->fp = estream;
1407   fcx->print_only_name = 1;
1408   fcx->keep_open = keep_open;
1409   sprintf (fcx->fname, "[fd %p]", estream);
1410   a->filter = file_es_filter;
1411   a->filter_ov = fcx;
1412   file_es_filter (fcx, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &len);
1413   file_es_filter (fcx, IOBUFCTRL_INIT, NULL, NULL, &len);
1414   if (DBG_IOBUF)
1415     log_debug ("iobuf-%d.%d: esopen%s '%s'\n",
1416                a->no, a->subno, keep_open? "_nc":"", fcx->fname);
1417   return a;
1418 }
1419
1420
1421 iobuf_t
1422 iobuf_sockopen (int fd, const char *mode)
1423 {
1424   iobuf_t a;
1425 #ifdef HAVE_W32_SYSTEM
1426   sock_filter_ctx_t *scx;
1427   size_t len;
1428
1429   a = iobuf_alloc (strchr (mode, 'w') ? 2 : 1, IOBUF_BUFFER_SIZE);
1430   scx = xmalloc (sizeof *scx + 25);
1431   scx->sock = fd;
1432   scx->print_only_name = 1;
1433   sprintf (scx->fname, "[sock %d]", fd);
1434   a->filter = sock_filter;
1435   a->filter_ov = scx;
1436   sock_filter (scx, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &len);
1437   sock_filter (scx, IOBUFCTRL_INIT, NULL, NULL, &len);
1438   if (DBG_IOBUF)
1439     log_debug ("iobuf-%d.%d: sockopen '%s'\n", a->no, a->subno, scx->fname);
1440   iobuf_ioctl (a, IOBUF_IOCTL_NO_CACHE, 1, NULL);
1441 #else
1442   a = iobuf_fdopen (fd, mode);
1443 #endif
1444   return a;
1445 }
1446
1447 /****************
1448  * Create an iobuf for writing to a file; the file will be created.
1449  * With MODE700 set the file is created with that mode (Unix only).
1450  */
1451 iobuf_t
1452 iobuf_create (const char *fname, int mode700)
1453 {
1454   iobuf_t a;
1455   gnupg_fd_t fp;
1456   file_filter_ctx_t *fcx;
1457   size_t len;
1458   int print_only = 0;
1459   int fd;
1460
1461   if (!fname || (*fname == '-' && !fname[1]))
1462     {
1463       fp = FD_FOR_STDOUT;
1464       fname = "[stdout]";
1465       print_only = 1;
1466     }
1467   else if ((fd = check_special_filename (fname)) != -1)
1468     return iobuf_fdopen (translate_file_handle (fd, 1), "wb");
1469   else if ((fp = direct_open (fname, "wb", mode700)) == GNUPG_INVALID_FD)
1470     return NULL;
1471   a = iobuf_alloc (2, IOBUF_BUFFER_SIZE);
1472   fcx = xmalloc (sizeof *fcx + strlen (fname));
1473   fcx->fp = fp;
1474   fcx->print_only_name = print_only;
1475   strcpy (fcx->fname, fname);
1476   if (!print_only)
1477     a->real_fname = xstrdup (fname);
1478   a->filter = file_filter;
1479   a->filter_ov = fcx;
1480   file_filter (fcx, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &len);
1481   file_filter (fcx, IOBUFCTRL_INIT, NULL, NULL, &len);
1482   if (DBG_IOBUF)
1483     log_debug ("iobuf-%d.%d: create '%s'\n", a->no, a->subno,
1484                a->desc?a->desc:"?");
1485
1486   return a;
1487 }
1488
1489
1490 iobuf_t
1491 iobuf_openrw (const char *fname)
1492 {
1493   iobuf_t a;
1494   gnupg_fd_t fp;
1495   file_filter_ctx_t *fcx;
1496   size_t len;
1497
1498   if (!fname)
1499     return NULL;
1500   else if ((fp = direct_open (fname, "r+b", 0)) == GNUPG_INVALID_FD)
1501     return NULL;
1502   a = iobuf_alloc (2, IOBUF_BUFFER_SIZE);
1503   fcx = xmalloc (sizeof *fcx + strlen (fname));
1504   fcx->fp = fp;
1505   strcpy (fcx->fname, fname);
1506   a->real_fname = xstrdup (fname);
1507   a->filter = file_filter;
1508   a->filter_ov = fcx;
1509   file_filter (fcx, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &len);
1510   file_filter (fcx, IOBUFCTRL_INIT, NULL, NULL, &len);
1511   if (DBG_IOBUF)
1512     log_debug ("iobuf-%d.%d: openrw '%s'\n", a->no, a->subno,
1513                a->desc?a->desc:"?");
1514
1515   return a;
1516 }
1517
1518
1519 int
1520 iobuf_ioctl (iobuf_t a, iobuf_ioctl_t cmd, int intval, void *ptrval)
1521 {
1522   if (cmd == IOBUF_IOCTL_KEEP_OPEN)
1523     {
1524       /* Keep system filepointer/descriptor open.  This was used in
1525          the past by http.c; this ioctl is not directly used
1526          anymore.  */
1527       if (DBG_IOBUF)
1528         log_debug ("iobuf-%d.%d: ioctl '%s' keep_open=%d\n",
1529                    a ? a->no : -1, a ? a->subno : -1,
1530                    a && a->desc ? a->desc : "?",
1531                    intval);
1532       for (; a; a = a->chain)
1533         if (!a->chain && a->filter == file_filter)
1534           {
1535             file_filter_ctx_t *b = a->filter_ov;
1536             b->keep_open = intval;
1537             return 0;
1538           }
1539 #ifdef HAVE_W32_SYSTEM
1540         else if (!a->chain && a->filter == sock_filter)
1541           {
1542             sock_filter_ctx_t *b = a->filter_ov;
1543             b->keep_open = intval;
1544             return 0;
1545           }
1546 #endif
1547     }
1548   else if (cmd == IOBUF_IOCTL_INVALIDATE_CACHE)
1549     {
1550       if (DBG_IOBUF)
1551         log_debug ("iobuf-*.*: ioctl '%s' invalidate\n",
1552                    ptrval ? (char *) ptrval : "?");
1553       if (!a && !intval && ptrval)
1554         {
1555           if (fd_cache_invalidate (ptrval))
1556             return -1;
1557           return 0;
1558         }
1559     }
1560   else if (cmd == IOBUF_IOCTL_NO_CACHE)
1561     {
1562       if (DBG_IOBUF)
1563         log_debug ("iobuf-%d.%d: ioctl '%s' no_cache=%d\n",
1564                    a ? a->no : -1, a ? a->subno : -1,
1565                    a && a->desc? a->desc : "?",
1566                    intval);
1567       for (; a; a = a->chain)
1568         if (!a->chain && a->filter == file_filter)
1569           {
1570             file_filter_ctx_t *b = a->filter_ov;
1571             b->no_cache = intval;
1572             return 0;
1573           }
1574 #ifdef HAVE_W32_SYSTEM
1575         else if (!a->chain && a->filter == sock_filter)
1576           {
1577             sock_filter_ctx_t *b = a->filter_ov;
1578             b->no_cache = intval;
1579             return 0;
1580           }
1581 #endif
1582     }
1583   else if (cmd == IOBUF_IOCTL_FSYNC)
1584     {
1585       /* Do a fsync on the open fd and return any errors to the caller
1586          of iobuf_ioctl.  Note that we work on a file name here. */
1587       if (DBG_IOBUF)
1588         log_debug ("iobuf-*.*: ioctl '%s' fsync\n",
1589                    ptrval? (const char*)ptrval:"<null>");
1590
1591         if (!a && !intval && ptrval)
1592           {
1593             return fd_cache_synchronize (ptrval);
1594           }
1595       }
1596
1597
1598   return -1;
1599 }
1600
1601
1602 /****************
1603  * Register an i/o filter.
1604  */
1605 int
1606 iobuf_push_filter (iobuf_t a,
1607                    int (*f) (void *opaque, int control,
1608                              iobuf_t chain, byte * buf, size_t * len),
1609                    void *ov)
1610 {
1611   return iobuf_push_filter2 (a, f, ov, 0);
1612 }
1613
1614 int
1615 iobuf_push_filter2 (iobuf_t a,
1616                     int (*f) (void *opaque, int control,
1617                               iobuf_t chain, byte * buf, size_t * len),
1618                     void *ov, int rel_ov)
1619 {
1620   iobuf_t b;
1621   size_t dummy_len = 0;
1622   int rc = 0;
1623
1624   if (a->directfp)
1625     BUG ();
1626
1627   if (a->use == BLOCK_FILTER_OUTPUT && (rc = iobuf_flush (a)))
1628     return rc;
1629
1630   if (a->subno >= MAX_NESTING_FILTER)
1631     {
1632       log_error ("i/o filter too deeply nested - corrupted data?\n");
1633       return GPG_ERR_BAD_DATA;
1634     }
1635
1636   /* make a copy of the current stream, so that
1637    * A is the new stream and B the original one.
1638    * The contents of the buffers are transferred to the
1639    * new stream.
1640    */
1641   b = xmalloc (sizeof *b);
1642   memcpy (b, a, sizeof *b);
1643   /* fixme: it is stupid to keep a copy of the name at every level
1644    * but we need the name somewhere because the name known by file_filter
1645    * may have been released when we need the name of the file */
1646   b->real_fname = a->real_fname ? xstrdup (a->real_fname) : NULL;
1647   /* remove the filter stuff from the new stream */
1648   a->filter = NULL;
1649   a->filter_ov = NULL;
1650   a->filter_ov_owner = 0;
1651   a->filter_eof = 0;
1652   if (a->use == BLOCK_FILTER_TEMP)
1653     /* make a write stream from a temp stream */
1654     a->use = BLOCK_FILTER_OUTPUT;
1655
1656   if (a->use == BLOCK_FILTER_OUTPUT)
1657     {                           /* allocate a fresh buffer for the
1658                                    original stream */
1659       b->d.buf = xmalloc (a->d.size);
1660       b->d.len = 0;
1661       b->d.start = 0;
1662     }
1663   else
1664     {                           /* allocate a fresh buffer for the new
1665                                    stream */
1666       a->d.buf = xmalloc (a->d.size);
1667       a->d.len = 0;
1668       a->d.start = 0;
1669     }
1670   /* disable nlimit for the new stream */
1671   a->ntotal = b->ntotal + b->nbytes;
1672   a->nlimit = a->nbytes = 0;
1673   a->nofast &= ~1;
1674   /* make a link from the new stream to the original stream */
1675   a->chain = b;
1676   a->opaque = b->opaque;
1677
1678   /* setup the function on the new stream */
1679   a->filter = f;
1680   a->filter_ov = ov;
1681   a->filter_ov_owner = rel_ov;
1682
1683   a->subno = b->subno + 1;
1684   f (ov, IOBUFCTRL_DESC, NULL, (byte *) & a->desc, &dummy_len);
1685
1686   if (DBG_IOBUF)
1687     {
1688       log_debug ("iobuf-%d.%d: push '%s'\n", a->no, a->subno,
1689                  a->desc?a->desc:"?");
1690       print_chain (a);
1691     }
1692
1693   /* now we can initialize the new function if we have one */
1694   if (a->filter && (rc = a->filter (a->filter_ov, IOBUFCTRL_INIT, a->chain,
1695                                     NULL, &dummy_len)))
1696     log_error ("IOBUFCTRL_INIT failed: %s\n", gpg_strerror (rc));
1697   return rc;
1698 }
1699
1700 /****************
1701  * Remove an i/o filter.
1702  */
1703 static int
1704 pop_filter (iobuf_t a, int (*f) (void *opaque, int control,
1705                                iobuf_t chain, byte * buf, size_t * len),
1706             void *ov)
1707 {
1708   iobuf_t b;
1709   size_t dummy_len = 0;
1710   int rc = 0;
1711
1712   if (a->directfp)
1713     BUG ();
1714
1715   if (DBG_IOBUF)
1716     log_debug ("iobuf-%d.%d: pop '%s'\n", a->no, a->subno,
1717                a->desc?a->desc:"?");
1718   if (!a->filter)
1719     {                           /* this is simple */
1720       b = a->chain;
1721       assert (b);
1722       xfree (a->d.buf);
1723       xfree (a->real_fname);
1724       memcpy (a, b, sizeof *a);
1725       xfree (b);
1726       return 0;
1727     }
1728   for (b = a; b; b = b->chain)
1729     if (b->filter == f && (!ov || b->filter_ov == ov))
1730       break;
1731   if (!b)
1732     log_bug ("pop_filter(): filter function not found\n");
1733
1734   /* flush this stream if it is an output stream */
1735   if (a->use == BLOCK_FILTER_OUTPUT && (rc = iobuf_flush (b)))
1736     {
1737       log_error ("iobuf_flush failed in pop_filter: %s\n", gpg_strerror (rc));
1738       return rc;
1739     }
1740   /* and tell the filter to free it self */
1741   if (b->filter && (rc = b->filter (b->filter_ov, IOBUFCTRL_FREE, b->chain,
1742                                     NULL, &dummy_len)))
1743     {
1744       log_error ("IOBUFCTRL_FREE failed: %s\n", gpg_strerror (rc));
1745       return rc;
1746     }
1747   if (b->filter_ov && b->filter_ov_owner)
1748     {
1749       xfree (b->filter_ov);
1750       b->filter_ov = NULL;
1751     }
1752
1753
1754   /* and see how to remove it */
1755   if (a == b && !b->chain)
1756     log_bug ("can't remove the last filter from the chain\n");
1757   else if (a == b)
1758     {                           /* remove the first iobuf from the chain */
1759       /* everything from b is copied to a. This is save because
1760        * a flush has been done on the to be removed entry
1761        */
1762       b = a->chain;
1763       xfree (a->d.buf);
1764       xfree (a->real_fname);
1765       memcpy (a, b, sizeof *a);
1766       xfree (b);
1767       if (DBG_IOBUF)
1768         log_debug ("iobuf-%d.%d: popped filter\n", a->no, a->subno);
1769     }
1770   else if (!b->chain)
1771     {                           /* remove the last iobuf from the chain */
1772       log_bug ("Ohh jeee, trying to remove a head filter\n");
1773     }
1774   else
1775     {                           /* remove an intermediate iobuf from the chain */
1776       log_bug ("Ohh jeee, trying to remove an intermediate filter\n");
1777     }
1778
1779   return rc;
1780 }
1781
1782
1783 /****************
1784  * read underflow: read more bytes into the buffer and return
1785  * the first byte or -1 on EOF.
1786  */
1787 static int
1788 underflow (iobuf_t a)
1789 {
1790   size_t len;
1791   int rc;
1792
1793   assert (a->d.start == a->d.len);
1794   if (a->use == BLOCK_FILTER_TEMP)
1795     return -1;                  /* EOF because a temp buffer can't do an underflow */
1796
1797   if (a->filter_eof)
1798     {
1799       if (a->chain)
1800         {
1801           iobuf_t b = a->chain;
1802           if (DBG_IOBUF)
1803             log_debug ("iobuf-%d.%d: pop '%s' in underflow\n",
1804                        a->no, a->subno, a->desc?a->desc:"?");
1805           xfree (a->d.buf);
1806           xfree (a->real_fname);
1807           memcpy (a, b, sizeof *a);
1808           xfree (b);
1809           print_chain (a);
1810         }
1811       else
1812         a->filter_eof = 0;      /* for the top level filter */
1813       if (DBG_IOBUF)
1814         log_debug ("iobuf-%d.%d: underflow: eof (due to filter eof)\n",
1815                    a->no, a->subno);
1816       return -1;                /* return one(!) EOF */
1817     }
1818   if (a->error)
1819     {
1820       if (DBG_IOBUF)
1821         log_debug ("iobuf-%d.%d: error\n", a->no, a->subno);
1822       return -1;
1823     }
1824
1825   if (a->directfp)
1826     {
1827       FILE *fp = a->directfp;
1828
1829       len = fread (a->d.buf, 1, a->d.size, fp);
1830       if (len < a->d.size)
1831         {
1832           if (ferror (fp))
1833             a->error = gpg_error_from_syserror ();
1834         }
1835       a->d.len = len;
1836       a->d.start = 0;
1837       return len ? a->d.buf[a->d.start++] : -1;
1838     }
1839
1840
1841   if (a->filter)
1842     {
1843       len = a->d.size;
1844       if (DBG_IOBUF)
1845         log_debug ("iobuf-%d.%d: underflow: req=%lu\n",
1846                    a->no, a->subno, (ulong) len);
1847       rc = a->filter (a->filter_ov, IOBUFCTRL_UNDERFLOW, a->chain,
1848                       a->d.buf, &len);
1849       if (DBG_IOBUF)
1850         {
1851           log_debug ("iobuf-%d.%d: underflow: got=%lu rc=%d\n",
1852                      a->no, a->subno, (ulong) len, rc);
1853 /*          if( a->no == 1 ) */
1854 /*                   log_hexdump ("     data:", a->d.buf, len); */
1855         }
1856       if (a->use == BLOCK_FILTER_INPUT && rc == -1)
1857         {                       /* EOF: we can remove the filter */
1858           size_t dummy_len = 0;
1859
1860           /* and tell the filter to free itself */
1861           if ((rc = a->filter (a->filter_ov, IOBUFCTRL_FREE, a->chain,
1862                                NULL, &dummy_len)))
1863             log_error ("IOBUFCTRL_FREE failed: %s\n", gpg_strerror (rc));
1864           if (a->filter_ov && a->filter_ov_owner)
1865             {
1866               xfree (a->filter_ov);
1867               a->filter_ov = NULL;
1868             }
1869           a->filter = NULL;
1870           a->desc = NULL;
1871           a->filter_ov = NULL;
1872           a->filter_eof = 1;
1873           if (!len && a->chain)
1874             {
1875               iobuf_t b = a->chain;
1876               if (DBG_IOBUF)
1877                 log_debug ("iobuf-%d.%d: pop in underflow (!len)\n",
1878                            a->no, a->subno);
1879               xfree (a->d.buf);
1880               xfree (a->real_fname);
1881               memcpy (a, b, sizeof *a);
1882               xfree (b);
1883               print_chain (a);
1884             }
1885         }
1886       else if (rc)
1887         a->error = rc;
1888
1889       if (!len)
1890         {
1891           if (DBG_IOBUF)
1892             log_debug ("iobuf-%d.%d: underflow: eof\n", a->no, a->subno);
1893           return -1;
1894         }
1895       a->d.len = len;
1896       a->d.start = 0;
1897       return a->d.buf[a->d.start++];
1898     }
1899   else
1900     {
1901       if (DBG_IOBUF)
1902         log_debug ("iobuf-%d.%d: underflow: eof (no filter)\n",
1903                    a->no, a->subno);
1904       return -1;                /* no filter; return EOF */
1905     }
1906 }
1907
1908
1909 int
1910 iobuf_flush (iobuf_t a)
1911 {
1912   size_t len;
1913   int rc;
1914
1915   if (a->directfp)
1916     return 0;
1917
1918   if (a->use == BLOCK_FILTER_TEMP)
1919     {                           /* increase the temp buffer */
1920       unsigned char *newbuf;
1921       size_t newsize = a->d.size + IOBUF_BUFFER_SIZE;
1922
1923       if (DBG_IOBUF)
1924         log_debug ("increasing temp iobuf from %lu to %lu\n",
1925                    (ulong) a->d.size, (ulong) newsize);
1926       newbuf = xmalloc (newsize);
1927       memcpy (newbuf, a->d.buf, a->d.len);
1928       xfree (a->d.buf);
1929       a->d.buf = newbuf;
1930       a->d.size = newsize;
1931       return 0;
1932     }
1933   else if (a->use != BLOCK_FILTER_OUTPUT)
1934     log_bug ("flush on non-output iobuf\n");
1935   else if (!a->filter)
1936     log_bug ("iobuf_flush: no filter\n");
1937   len = a->d.len;
1938   rc = a->filter (a->filter_ov, IOBUFCTRL_FLUSH, a->chain, a->d.buf, &len);
1939   if (!rc && len != a->d.len)
1940     {
1941       log_info ("iobuf_flush did not write all!\n");
1942       rc = GPG_ERR_INTERNAL;
1943     }
1944   else if (rc)
1945     a->error = rc;
1946   a->d.len = 0;
1947
1948   return rc;
1949 }
1950
1951
1952 /****************
1953  * Read a byte from the iobuf; returns -1 on EOF
1954  */
1955 int
1956 iobuf_readbyte (iobuf_t a)
1957 {
1958   int c;
1959
1960   if (a->nlimit && a->nbytes >= a->nlimit)
1961     return -1;                  /* forced EOF */
1962
1963   if (a->d.start < a->d.len)
1964     {
1965       c = a->d.buf[a->d.start++];
1966     }
1967   else if ((c = underflow (a)) == -1)
1968     return -1;                  /* EOF */
1969
1970   a->nbytes++;
1971   return c;
1972 }
1973
1974
1975 int
1976 iobuf_read (iobuf_t a, void *buffer, unsigned int buflen)
1977 {
1978   unsigned char *buf = (unsigned char *)buffer;
1979   int c, n;
1980
1981   if (a->nlimit)
1982     {
1983       /* Handle special cases. */
1984       for (n = 0; n < buflen; n++)
1985         {
1986           if ((c = iobuf_readbyte (a)) == -1)
1987             {
1988               if (!n)
1989                 return -1;      /* eof */
1990               break;
1991             }
1992           else if (buf)
1993             *buf = c;
1994           if (buf)
1995             buf++;
1996         }
1997       return n;
1998     }
1999
2000   n = 0;
2001   do
2002     {
2003       if (n < buflen && a->d.start < a->d.len)
2004         {
2005           unsigned size = a->d.len - a->d.start;
2006           if (size > buflen - n)
2007             size = buflen - n;
2008           if (buf)
2009             memcpy (buf, a->d.buf + a->d.start, size);
2010           n += size;
2011           a->d.start += size;
2012           if (buf)
2013             buf += size;
2014         }
2015       if (n < buflen)
2016         {
2017           if ((c = underflow (a)) == -1)
2018             {
2019               a->nbytes += n;
2020               return n ? n : -1 /*EOF*/;
2021             }
2022           if (buf)
2023             *buf++ = c;
2024           n++;
2025         }
2026     }
2027   while (n < buflen);
2028   a->nbytes += n;
2029   return n;
2030 }
2031
2032
2033
2034 /****************
2035  * Have a look at the iobuf.
2036  * NOTE: This only works in special cases.
2037  */
2038 int
2039 iobuf_peek (iobuf_t a, byte * buf, unsigned buflen)
2040 {
2041   int n = 0;
2042
2043   if (a->filter_eof)
2044     return -1;
2045
2046   if (!(a->d.start < a->d.len))
2047     {
2048       if (underflow (a) == -1)
2049         return -1;
2050       /* And unget this character. */
2051       assert (a->d.start == 1);
2052       a->d.start = 0;
2053     }
2054
2055   for (n = 0; n < buflen && (a->d.start + n) < a->d.len; n++, buf++)
2056     *buf = a->d.buf[n];
2057   return n;
2058 }
2059
2060
2061
2062
2063 int
2064 iobuf_writebyte (iobuf_t a, unsigned int c)
2065 {
2066   int rc;
2067
2068   if (a->directfp)
2069     BUG ();
2070
2071   if (a->d.len == a->d.size)
2072     if ((rc=iobuf_flush (a)))
2073       return rc;
2074
2075   assert (a->d.len < a->d.size);
2076   a->d.buf[a->d.len++] = c;
2077   return 0;
2078 }
2079
2080
2081 int
2082 iobuf_write (iobuf_t a, const void *buffer, unsigned int buflen)
2083 {
2084   const unsigned char *buf = (const unsigned char *)buffer;
2085   int rc;
2086
2087   if (a->directfp)
2088     BUG ();
2089
2090   do
2091     {
2092       if (buflen && a->d.len < a->d.size)
2093         {
2094           unsigned size = a->d.size - a->d.len;
2095           if (size > buflen)
2096             size = buflen;
2097           memcpy (a->d.buf + a->d.len, buf, size);
2098           buflen -= size;
2099           buf += size;
2100           a->d.len += size;
2101         }
2102       if (buflen)
2103         {
2104           rc = iobuf_flush (a);
2105           if (rc)
2106             return rc;
2107         }
2108     }
2109   while (buflen);
2110   return 0;
2111 }
2112
2113
2114 int
2115 iobuf_writestr (iobuf_t a, const char *buf)
2116 {
2117   int rc;
2118
2119   for (; *buf; buf++)
2120     if ((rc=iobuf_writebyte (a, *buf)))
2121       return rc;
2122   return 0;
2123 }
2124
2125
2126
2127 /****************
2128  * copy the contents of TEMP to A.
2129  */
2130 int
2131 iobuf_write_temp (iobuf_t a, iobuf_t temp)
2132 {
2133   while (temp->chain)
2134     pop_filter (temp, temp->filter, NULL);
2135   return iobuf_write (a, temp->d.buf, temp->d.len);
2136 }
2137
2138 /****************
2139  * copy the contents of the temp io stream to BUFFER.
2140  */
2141 size_t
2142 iobuf_temp_to_buffer (iobuf_t a, byte * buffer, size_t buflen)
2143 {
2144   size_t n = a->d.len;
2145
2146   if (n > buflen)
2147     n = buflen;
2148   memcpy (buffer, a->d.buf, n);
2149   return n;
2150 }
2151
2152
2153 /****************
2154  * Call this function to terminate processing of the temp stream
2155  * without closing it.  This removes all filters from the stream
2156  * makes sure that iobuf_get_temp_{buffer,length}() returns correct
2157  * values.
2158  */
2159 void
2160 iobuf_flush_temp (iobuf_t temp)
2161 {
2162   while (temp->chain)
2163     pop_filter (temp, temp->filter, NULL);
2164 }
2165
2166
2167 /****************
2168  * Set a limit on how many bytes may be read from the input stream A.
2169  * Setting the limit to 0 disables this feature.
2170  */
2171 void
2172 iobuf_set_limit (iobuf_t a, off_t nlimit)
2173 {
2174   if (nlimit)
2175     a->nofast |= 1;
2176   else
2177     a->nofast &= ~1;
2178   a->nlimit = nlimit;
2179   a->ntotal += a->nbytes;
2180   a->nbytes = 0;
2181 }
2182
2183
2184
2185 /* Return the length of an open file A.  IF OVERFLOW is not NULL it
2186    will be set to true if the file is larger than what off_t can cope
2187    with.  The function return 0 on error or on overflow condition.  */
2188 off_t
2189 iobuf_get_filelength (iobuf_t a, int *overflow)
2190 {
2191   struct stat st;
2192
2193   if (overflow)
2194     *overflow = 0;
2195
2196   if ( a->directfp )
2197     {
2198       FILE *fp = a->directfp;
2199
2200       if ( !fstat(fileno(fp), &st) )
2201         return st.st_size;
2202       log_error("fstat() failed: %s\n", strerror(errno) );
2203       return 0;
2204     }
2205
2206   /* Hmmm: file_filter may have already been removed */
2207   for ( ; a; a = a->chain )
2208     if ( !a->chain && a->filter == file_filter )
2209       {
2210         file_filter_ctx_t *b = a->filter_ov;
2211         gnupg_fd_t fp = b->fp;
2212
2213 #if defined(HAVE_W32_SYSTEM)
2214         ulong size;
2215         static int (* __stdcall get_file_size_ex) (void *handle,
2216                                                    LARGE_INTEGER *r_size);
2217         static int get_file_size_ex_initialized;
2218
2219         if (!get_file_size_ex_initialized)
2220           {
2221             void *handle;
2222
2223             handle = dlopen ("kernel32.dll", RTLD_LAZY);
2224             if (handle)
2225               {
2226                 get_file_size_ex = dlsym (handle, "GetFileSizeEx");
2227                 if (!get_file_size_ex)
2228                   dlclose (handle);
2229               }
2230             get_file_size_ex_initialized = 1;
2231           }
2232
2233         if (get_file_size_ex)
2234           {
2235             /* This is a newer system with GetFileSizeEx; we use this
2236                then because it seem that GetFileSize won't return a
2237                proper error in case a file is larger than 4GB. */
2238             LARGE_INTEGER exsize;
2239
2240             if (get_file_size_ex (fp, &exsize))
2241               {
2242                 if (!exsize.u.HighPart)
2243                   return exsize.u.LowPart;
2244                 if (overflow)
2245                   *overflow = 1;
2246                 return 0;
2247               }
2248           }
2249         else
2250           {
2251             if ((size=GetFileSize (fp, NULL)) != 0xffffffff)
2252               return size;
2253           }
2254         log_error ("GetFileSize for handle %p failed: %s\n",
2255                    fp, w32_strerror (0));
2256 #else
2257         if ( !fstat (FD2INT (fp), &st) )
2258           return st.st_size;
2259         log_error("fstat() failed: %s\n", strerror(errno) );
2260 #endif
2261         break/*the for loop*/;
2262       }
2263
2264     return 0;
2265 }
2266
2267
2268 /* Return the file descriptor of the underlying file or -1 if it is
2269    not available.  */
2270 int
2271 iobuf_get_fd (iobuf_t a)
2272 {
2273   if (a->directfp)
2274     return fileno ( (FILE*)a->directfp );
2275
2276   for ( ; a; a = a->chain )
2277     if (!a->chain && a->filter == file_filter)
2278       {
2279         file_filter_ctx_t *b = a->filter_ov;
2280         gnupg_fd_t fp = b->fp;
2281
2282         return FD2INT (fp);
2283       }
2284
2285   return -1;
2286 }
2287
2288
2289
2290 /****************
2291  * Tell the file position, where the next read will take place
2292  */
2293 off_t
2294 iobuf_tell (iobuf_t a)
2295 {
2296   return a->ntotal + a->nbytes;
2297 }
2298
2299
2300 #if !defined(HAVE_FSEEKO) && !defined(fseeko)
2301
2302 #ifdef HAVE_LIMITS_H
2303 # include <limits.h>
2304 #endif
2305 #ifndef LONG_MAX
2306 # define LONG_MAX ((long) ((unsigned long) -1 >> 1))
2307 #endif
2308 #ifndef LONG_MIN
2309 # define LONG_MIN (-1 - LONG_MAX)
2310 #endif
2311
2312 /****************
2313  * A substitute for fseeko, for hosts that don't have it.
2314  */
2315 static int
2316 fseeko (FILE * stream, off_t newpos, int whence)
2317 {
2318   while (newpos != (long) newpos)
2319     {
2320       long pos = newpos < 0 ? LONG_MIN : LONG_MAX;
2321       if (fseek (stream, pos, whence) != 0)
2322         return -1;
2323       newpos -= pos;
2324       whence = SEEK_CUR;
2325     }
2326   return fseek (stream, (long) newpos, whence);
2327 }
2328 #endif
2329
2330 /****************
2331  * This is a very limited implementation. It simply discards all internal
2332  * buffering and removes all filters but the first one.
2333  */
2334 int
2335 iobuf_seek (iobuf_t a, off_t newpos)
2336 {
2337   file_filter_ctx_t *b = NULL;
2338
2339   if (a->directfp)
2340     {
2341       FILE *fp = a->directfp;
2342       if (fseeko (fp, newpos, SEEK_SET))
2343         {
2344           log_error ("can't seek: %s\n", strerror (errno));
2345           return -1;
2346         }
2347       clearerr (fp);
2348     }
2349   else if (a->use != BLOCK_FILTER_TEMP)
2350     {
2351       for (; a; a = a->chain)
2352         {
2353           if (!a->chain && a->filter == file_filter)
2354             {
2355               b = a->filter_ov;
2356               break;
2357             }
2358         }
2359       if (!a)
2360         return -1;
2361 #ifdef HAVE_W32_SYSTEM
2362       if (SetFilePointer (b->fp, newpos, NULL, FILE_BEGIN) == 0xffffffff)
2363         {
2364           log_error ("SetFilePointer failed on handle %p: ec=%d\n",
2365                      b->fp, (int) GetLastError ());
2366           return -1;
2367         }
2368 #else
2369       if (lseek (b->fp, newpos, SEEK_SET) == (off_t) - 1)
2370         {
2371           log_error ("can't lseek: %s\n", strerror (errno));
2372           return -1;
2373         }
2374 #endif
2375     }
2376   /* Discard the buffer unless it is a temp stream.  */
2377   if (a->use != BLOCK_FILTER_TEMP)
2378     a->d.len = 0;
2379   a->d.start = 0;
2380   a->nbytes = 0;
2381   a->nlimit = 0;
2382   a->nofast &= ~1;
2383   a->ntotal = newpos;
2384   a->error = 0;
2385   /* remove filters, but the last */
2386   if (a->chain)
2387     log_debug ("pop_filter called in iobuf_seek - please report\n");
2388   while (a->chain)
2389     pop_filter (a, a->filter, NULL);
2390
2391   return 0;
2392 }
2393
2394
2395
2396
2397
2398
2399 /****************
2400  * Retrieve the real filename.  This is the filename actually used on
2401  * disk and not a made up one.  Returns NULL if no real filename is
2402  * available.
2403  */
2404 const char *
2405 iobuf_get_real_fname (iobuf_t a)
2406 {
2407   if (a->real_fname)
2408     return a->real_fname;
2409
2410   /* the old solution */
2411   for (; a; a = a->chain)
2412     if (!a->chain && a->filter == file_filter)
2413       {
2414         file_filter_ctx_t *b = a->filter_ov;
2415         return b->print_only_name ? NULL : b->fname;
2416       }
2417
2418   return NULL;
2419 }
2420
2421
2422 /****************
2423  * Retrieve the filename.  This name should only be used in diagnostics.
2424  */
2425 const char *
2426 iobuf_get_fname (iobuf_t a)
2427 {
2428   for (; a; a = a->chain)
2429     if (!a->chain && a->filter == file_filter)
2430       {
2431         file_filter_ctx_t *b = a->filter_ov;
2432         return b->fname;
2433       }
2434   return NULL;
2435 }
2436
2437 /* Same as iobuf_get_fname but never returns NULL.  */
2438 const char *
2439 iobuf_get_fname_nonnull (iobuf_t a)
2440 {
2441   const char *fname;
2442
2443   fname = iobuf_get_fname (a);
2444   return fname? fname : "[?]";
2445 }
2446
2447
2448 /****************
2449  * enable partial block mode as described in the OpenPGP draft.
2450  * LEN is the first length byte on read, but ignored on writes.
2451  */
2452 void
2453 iobuf_set_partial_block_mode (iobuf_t a, size_t len)
2454 {
2455   block_filter_ctx_t *ctx = xcalloc (1, sizeof *ctx);
2456
2457   assert (a->use == BLOCK_FILTER_INPUT || a->use == BLOCK_FILTER_OUTPUT);
2458   ctx->use = a->use;
2459   if (!len)
2460     {
2461       if (a->use == BLOCK_FILTER_INPUT)
2462         log_debug ("pop_filter called in set_partial_block_mode"
2463                    " - please report\n");
2464       pop_filter (a, block_filter, NULL);
2465     }
2466   else
2467     {
2468       ctx->partial = 1;
2469       ctx->size = 0;
2470       ctx->first_c = len;
2471       iobuf_push_filter (a, block_filter, ctx);
2472     }
2473 }
2474
2475
2476
2477 /****************
2478  * Same as fgets() but if the buffer is too short a larger one will
2479  * be allocated up to some limit *max_length.
2480  * A line is considered a byte stream ending in a LF.
2481  * Returns the length of the line. EOF is indicated by a line of
2482  * length zero. The last LF may be missing due to an EOF.
2483  * is max_length is zero on return, the line has been truncated.
2484  *
2485  * Note: The buffer is allocated with enough space to append a CR,LF,EOL
2486  */
2487 unsigned int
2488 iobuf_read_line (iobuf_t a, byte ** addr_of_buffer,
2489                  unsigned *length_of_buffer, unsigned *max_length)
2490 {
2491   int c;
2492   char *buffer = (char *)*addr_of_buffer;
2493   unsigned length = *length_of_buffer;
2494   unsigned nbytes = 0;
2495   unsigned maxlen = *max_length;
2496   char *p;
2497
2498   if (!buffer)
2499     {                           /* must allocate a new buffer */
2500       length = 256;
2501       buffer = xmalloc (length);
2502       *addr_of_buffer = (unsigned char *)buffer;
2503       *length_of_buffer = length;
2504     }
2505
2506   length -= 3;                  /* reserve 3 bytes (cr,lf,eol) */
2507   p = buffer;
2508   while ((c = iobuf_get (a)) != -1)
2509     {
2510       if (nbytes == length)
2511         {                       /* increase the buffer */
2512           if (length > maxlen)
2513             {                   /* this is out limit */
2514               /* skip the rest of the line */
2515               while (c != '\n' && (c = iobuf_get (a)) != -1)
2516                 ;
2517               *p++ = '\n';      /* always append a LF (we have reserved space) */
2518               nbytes++;
2519               *max_length = 0;  /* indicate truncation */
2520               break;
2521             }
2522           length += 3;          /* correct for the reserved byte */
2523           length += length < 1024 ? 256 : 1024;
2524           buffer = xrealloc (buffer, length);
2525           *addr_of_buffer = (unsigned char *)buffer;
2526           *length_of_buffer = length;
2527           length -= 3;          /* and reserve again */
2528           p = buffer + nbytes;
2529         }
2530       *p++ = c;
2531       nbytes++;
2532       if (c == '\n')
2533         break;
2534     }
2535   *p = 0;                       /* make sure the line is a string */
2536
2537   return nbytes;
2538 }
2539
2540 static int
2541 translate_file_handle (int fd, int for_write)
2542 {
2543 #if defined(HAVE_W32CE_SYSTEM)
2544   /* This is called only with one of the special filenames.  Under
2545      W32CE the FD here is not a file descriptor but a rendezvous id,
2546      thus we need to finish the pipe first.  */
2547   fd = _assuan_w32ce_finish_pipe (fd, for_write);
2548 #elif defined(HAVE_W32_SYSTEM)
2549   {
2550     int x;
2551
2552     (void)for_write;
2553
2554     if (fd == 0)
2555       x = (int) GetStdHandle (STD_INPUT_HANDLE);
2556     else if (fd == 1)
2557       x = (int) GetStdHandle (STD_OUTPUT_HANDLE);
2558     else if (fd == 2)
2559       x = (int) GetStdHandle (STD_ERROR_HANDLE);
2560     else
2561       x = fd;
2562
2563     if (x == -1)
2564       log_debug ("GetStdHandle(%d) failed: ec=%d\n",
2565                  fd, (int) GetLastError ());
2566
2567     fd = x;
2568   }
2569 #else
2570   (void)for_write;
2571 #endif
2572   return fd;
2573 }
2574
2575
2576 void
2577 iobuf_skip_rest (iobuf_t a, unsigned long n, int partial)
2578 {
2579   if ( partial )
2580     {
2581       for (;;)
2582         {
2583           if (a->nofast || a->d.start >= a->d.len)
2584             {
2585               if (iobuf_readbyte (a) == -1)
2586                 {
2587                   break;
2588                 }
2589             }
2590           else
2591             {
2592               unsigned long count = a->d.len - a->d.start;
2593               a->nbytes += count;
2594               a->d.start = a->d.len;
2595             }
2596         }
2597     }
2598   else
2599     {
2600       unsigned long remaining = n;
2601       while (remaining > 0)
2602         {
2603           if (a->nofast || a->d.start >= a->d.len)
2604             {
2605               if (iobuf_readbyte (a) == -1)
2606                 {
2607                   break;
2608                 }
2609               --remaining;
2610             }
2611           else
2612             {
2613               unsigned long count = a->d.len - a->d.start;
2614               if (count > remaining)
2615                 {
2616                   count = remaining;
2617                 }
2618               a->nbytes += count;
2619               a->d.start += count;
2620               remaining -= count;
2621             }
2622         }
2623     }
2624 }