* iobuf.c (pop_filter): Make static.
[gnupg.git] / util / iobuf.c
1 /* iobuf.c  -  file handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2004 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <ctype.h>
28 #include <assert.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <fcntl.h> 
32 #include <unistd.h>
33 #ifdef HAVE_DOSISH_SYSTEM
34 #include <windows.h>
35 #endif
36 #ifdef __riscos__
37 #include <kernel.h>
38 #include <swis.h>
39 #endif /* __riscos__ */
40
41 #include "memory.h"
42 #include "util.h"
43 #include "iobuf.h"
44
45 #undef FILE_FILTER_USES_STDIO
46
47 #ifdef HAVE_DOSISH_SYSTEM
48 #define USE_SETMODE 1
49 #endif
50
51 #ifdef FILE_FILTER_USES_STDIO
52 #define my_fileno(a)  fileno ((a))
53 #define my_fopen_ro(a,b) fopen ((a),(b))
54 #define my_fopen(a,b)    fopen ((a),(b))
55 typedef FILE *FILEP_OR_FD;
56 #define INVALID_FP    NULL
57 #define FILEP_OR_FD_FOR_STDIN  (stdin)
58 #define FILEP_OR_FD_FOR_STDOUT  (stdout)
59 typedef struct {
60      FILE *fp;     /* open file handle */
61      int keep_open;
62      int no_cache;
63      int  print_only_name; /* flags indicating that fname is not a real file*/
64      char fname[1]; /* name of the file */
65  } file_filter_ctx_t ;
66 #else
67 #define my_fileno(a)  (a)
68 #define my_fopen_ro(a,b) fd_cache_open ((a),(b)) 
69 #define my_fopen(a,b) direct_open ((a),(b)) 
70 #ifdef HAVE_DOSISH_SYSTEM
71 typedef HANDLE FILEP_OR_FD;
72 #define INVALID_FP  ((HANDLE)-1)
73 #define FILEP_OR_FD_FOR_STDIN  (GetStdHandle (STD_INPUT_HANDLE))
74 #define FILEP_OR_FD_FOR_STDOUT (GetStdHandle (STD_OUTPUT_HANDLE))
75 #undef USE_SETMODE
76 #else
77 typedef int FILEP_OR_FD;
78 #define INVALID_FP  (-1)
79 #define FILEP_OR_FD_FOR_STDIN  (0)
80 #define FILEP_OR_FD_FOR_STDOUT (1)
81 #endif
82 typedef struct {
83      FILEP_OR_FD  fp;      /* open file handle */
84      int keep_open;
85      int no_cache;
86      int eof_seen;
87      int  print_only_name; /* flags indicating that fname is not a real file*/
88      char fname[1]; /* name of the file */
89  } file_filter_ctx_t ;
90
91  struct close_cache_s { 
92     struct close_cache_s *next;
93     FILEP_OR_FD fp;
94     char fname[1];
95  };
96  typedef struct close_cache_s *CLOSE_CACHE;
97  static CLOSE_CACHE close_cache;
98 #endif
99
100 #ifdef _WIN32
101 typedef struct {
102     int sock;
103     int keep_open;
104     int no_cache;
105     int eof_seen;
106     int  print_only_name; /* flags indicating that fname is not a real file*/
107     char fname[1]; /* name of the file */
108 } sock_filter_ctx_t ;
109 #endif /*_WIN32*/
110
111 /* The first partial length header block must be of size 512
112  * to make it easier (and efficienter) we use a min. block size of 512
113  * for all chunks (but the last one) */
114 #define OP_MIN_PARTIAL_CHUNK      512
115 #define OP_MIN_PARTIAL_CHUNK_2POW 9
116
117 typedef struct {
118     int use;
119     size_t size;
120     size_t count;
121     int partial;  /* 1 = partial header, 2 in last partial packet */
122     char *buffer;    /* used for partial header */
123     size_t buflen;   /* used size of buffer */
124     int first_c;     /* of partial header (which is > 0)*/
125     int eof;
126 } block_filter_ctx_t;
127
128 static int special_names_enabled;
129
130 static int underflow(IOBUF a);
131 static int translate_file_handle ( int fd, int for_write );
132
133 #ifndef FILE_FILTER_USES_STDIO
134
135 /*
136  * Invalidate (i.e. close) a cached iobuf
137  */
138 static void
139 fd_cache_invalidate (const char *fname)
140 {
141     CLOSE_CACHE cc;
142
143     assert (fname);
144     if( DBG_IOBUF )
145         log_debug ("fd_cache_invalidate (%s)\n", fname);
146
147     for (cc=close_cache; cc; cc = cc->next ) {
148         if ( cc->fp != INVALID_FP && !strcmp (cc->fname, fname) ) {
149             if( DBG_IOBUF )
150                 log_debug ("                did (%s)\n", cc->fname);
151 #ifdef HAVE_DOSISH_SYSTEM
152             CloseHandle (cc->fp);
153 #else
154             close(cc->fp);
155 #endif
156             cc->fp = INVALID_FP;
157         }
158     }
159 }
160
161
162
163 static FILEP_OR_FD
164 direct_open (const char *fname, const char *mode)
165 {
166 #ifdef HAVE_DOSISH_SYSTEM
167     unsigned long da, cd, sm;
168     HANDLE hfile;
169
170     /* Note, that we do not handle all mode combinations */
171
172     /* According to the ReactOS source it seems that open() of the
173      * standard MSW32 crt does open the file in share mode which is
174      * something new for MS applications ;-)
175      */
176     if ( strchr (mode, '+') ) {
177         fd_cache_invalidate (fname);
178         da = GENERIC_READ|GENERIC_WRITE;
179         cd = OPEN_EXISTING;
180         sm = FILE_SHARE_READ | FILE_SHARE_WRITE;
181     }
182     else if ( strchr (mode, 'w') ) {
183         fd_cache_invalidate (fname);
184         da = GENERIC_WRITE;
185         cd = CREATE_ALWAYS;
186         sm = FILE_SHARE_WRITE;
187     }
188     else {
189         da = GENERIC_READ;
190         cd = OPEN_EXISTING;
191         sm = FILE_SHARE_READ;
192     }
193
194     hfile = CreateFile (fname, da, sm, NULL, cd, FILE_ATTRIBUTE_NORMAL, NULL);
195     return hfile;
196 #else
197     int oflag;
198     int cflag = S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH;
199
200     /* Note, that we do not handle all mode combinations */
201     if ( strchr (mode, '+') ) {
202         fd_cache_invalidate (fname);
203         oflag = O_RDWR;
204     }
205     else if ( strchr (mode, 'w') ) {
206         fd_cache_invalidate (fname);
207         oflag = O_WRONLY | O_CREAT | O_TRUNC;
208     }
209     else {
210         oflag = O_RDONLY;
211     }
212 #ifdef O_BINARY
213     if (strchr (mode, 'b'))
214       oflag |= O_BINARY;
215 #endif
216 #ifndef __riscos__
217     return open (fname, oflag, cflag );
218 #else
219     {
220         struct stat buf;
221         int rc = stat( fname, &buf );
222         
223         /* Don't allow iobufs on directories */
224         if( !rc && S_ISDIR(buf.st_mode) && !S_ISREG(buf.st_mode) )
225             return __set_errno( EISDIR );
226         else
227             return open( fname, oflag, cflag );
228     }
229 #endif
230 #endif
231 }
232
233
234 /*
235  * Instead of closing an FD we keep it open and cache it for later reuse 
236  * Note that this caching strategy only works if the process does not chdir.
237  */
238 static void
239 fd_cache_close (const char *fname, FILEP_OR_FD fp)
240 {
241     CLOSE_CACHE cc;
242
243     assert (fp);
244     if ( !fname || !*fname ) {
245 #ifdef HAVE_DOSISH_SYSTEM
246         CloseHandle (fp);
247 #else
248         close(fp);
249 #endif
250         if( DBG_IOBUF )
251             log_debug ("fd_cache_close (%p) real\n", (void*)fp);
252         return;
253     }
254     /* try to reuse a slot */
255     for (cc=close_cache; cc; cc = cc->next ) {
256         if ( cc->fp == INVALID_FP && !strcmp (cc->fname, fname) ) {
257             cc->fp = fp;
258             if( DBG_IOBUF )
259                 log_debug ("fd_cache_close (%s) used existing slot\n", fname);
260             return;
261         }
262     }
263     /* add a new one */
264     if( DBG_IOBUF )
265         log_debug ("fd_cache_close (%s) new slot created\n", fname);
266     cc = m_alloc_clear (sizeof *cc + strlen (fname));
267     strcpy (cc->fname, fname);
268     cc->fp = fp;
269     cc->next = close_cache;
270     close_cache = cc;
271 }
272
273 /*
274  * Do an direct_open on FNAME but first try to reuse one from the fd_cache
275  */
276 static FILEP_OR_FD
277 fd_cache_open (const char *fname, const char *mode)
278 {
279     CLOSE_CACHE cc;
280
281     assert (fname);
282     for (cc=close_cache; cc; cc = cc->next ) {
283         if ( cc->fp != INVALID_FP && !strcmp (cc->fname, fname) ) {
284             FILEP_OR_FD fp = cc->fp;
285             cc->fp = INVALID_FP;
286             if( DBG_IOBUF )
287                 log_debug ("fd_cache_open (%s) using cached fp\n", fname);
288 #ifdef HAVE_DOSISH_SYSTEM
289             if (SetFilePointer (fp, 0, NULL, FILE_BEGIN) == 0xffffffff ) {
290                 log_error ("rewind file failed on handle %p: ec=%d\n",
291                            fp, (int)GetLastError () );
292                 fp = INVALID_FP;
293             }
294 #else
295             if ( lseek (fp, 0, SEEK_SET) == (off_t)-1 ) {
296                 log_error("can't rewind fd %d: %s\n", fp, strerror(errno) );
297                 fp = INVALID_FP;
298             }
299 #endif
300             return fp;
301         }
302     }
303     if( DBG_IOBUF )
304         log_debug ("fd_cache_open (%s) not cached\n", fname);
305     return direct_open (fname, mode);
306 }
307
308
309 #endif /*FILE_FILTER_USES_STDIO*/
310
311
312 /****************
313  * Read data from a file into buf which has an allocated length of *LEN.
314  * return the number of read bytes in *LEN. OPAQUE is the FILE * of
315  * the stream. A is not used.
316  * control may be:
317  * IOBUFCTRL_INIT: called just before the function is linked into the
318  *                 list of function. This can be used to prepare internal
319  *                 data structures of the function.
320  * IOBUFCTRL_FREE: called just before the function is removed from the
321  *                  list of functions and can be used to release internal
322  *                  data structures or close a file etc.
323  * IOBUFCTRL_UNDERFLOW: called by iobuf_underflow to fill the buffer
324  *                  with new stuff. *RET_LEN is the available size of the
325  *                  buffer, and should be set to the number of bytes
326  *                  which were put into the buffer. The function
327  *                  returns 0 to indicate success, -1 on EOF and
328  *                  G10ERR_xxxxx for other errors.
329  *
330  * IOBUFCTRL_FLUSH: called by iobuf_flush() to write out the collected stuff.
331  *                  *RET_LAN is the number of bytes in BUF.
332  *
333  * IOBUFCTRL_CANCEL: send to all filters on behalf of iobuf_cancel.  The
334  *                  filter may take appropriate action on this message.
335  */
336 static int
337 file_filter(void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
338 {
339     file_filter_ctx_t *a = opaque;
340     FILEP_OR_FD f = a->fp;
341     size_t size = *ret_len;
342     size_t nbytes = 0;
343     int rc = 0;
344
345 #ifdef FILE_FILTER_USES_STDIO
346     if( control == IOBUFCTRL_UNDERFLOW ) {
347         assert( size ); /* need a buffer */
348         if ( feof(f)) { /* On terminals you could easiely read as many EOFs as you call         */
349             rc = -1;            /* fread() or fgetc() repeatly. Every call will block until you press   */
350             *ret_len = 0;       /* CTRL-D. So we catch this case before we call fread() again.          */
351         }
352         else {
353             clearerr( f );
354             nbytes = fread( buf, 1, size, f );
355             if( feof(f) && !nbytes ) {
356                 rc = -1; /* okay: we can return EOF now. */
357             }
358             else if( ferror(f) && errno != EPIPE  ) {
359                 log_error("%s: read error: %s\n",
360                           a->fname, strerror(errno));
361                 rc = G10ERR_READ_FILE;
362             }
363             *ret_len = nbytes;
364         }
365     }
366     else if( control == IOBUFCTRL_FLUSH ) {
367         if( size ) {
368             clearerr( f );
369             nbytes = fwrite( buf, 1, size, f );
370             if( ferror(f) ) {
371                 log_error("%s: write error: %s\n", a->fname, strerror(errno));
372                 rc = G10ERR_WRITE_FILE;
373             }
374         }
375         *ret_len = nbytes;
376     }
377     else if( control == IOBUFCTRL_INIT ) {
378         a->keep_open = a->no_cache = 0;
379     }
380     else if( control == IOBUFCTRL_DESC ) {
381         *(char**)buf = "file_filter";
382     }
383     else if( control == IOBUFCTRL_FREE ) {
384         if( f != stdin && f != stdout ) {
385             if( DBG_IOBUF )
386                 log_debug("%s: close fd %d\n", a->fname, fileno(f) );
387             if (!a->keep_open)
388                 fclose(f);
389         }
390         f = NULL;
391         m_free(a); /* we can free our context now */
392     }
393 #else /* !stdio implementation */
394
395     if( control == IOBUFCTRL_UNDERFLOW ) {
396         assert( size ); /* need a buffer */
397         if ( a->eof_seen) {
398             rc = -1;            
399             *ret_len = 0;       
400         }
401         else {
402 #ifdef HAVE_DOSISH_SYSTEM
403             unsigned long nread;
404
405             nbytes = 0;
406             if ( !ReadFile ( f, buf, size, &nread, NULL ) ) {
407                 int ec = (int)GetLastError ();
408                 if ( ec != ERROR_BROKEN_PIPE ) {
409                     log_error("%s: read error: ec=%d\n", a->fname, ec);
410                     rc = G10ERR_READ_FILE;
411                 }
412             }
413             else if ( !nread ) {
414                 a->eof_seen = 1;
415                 rc = -1;
416             }
417             else {
418                 nbytes = nread;
419             }
420
421 #else
422
423             int n;
424
425             nbytes = 0;
426             do {
427                 n = read ( f, buf, size );
428             } while (n == -1 && errno == EINTR );
429             if ( n == -1 ) { /* error */
430                 if (errno != EPIPE) {
431                     log_error("%s: read error: %s\n",
432                               a->fname, strerror(errno));
433                     rc = G10ERR_READ_FILE;
434                 }
435             }
436             else if ( !n ) { /* eof */
437                 a->eof_seen = 1;
438                 rc = -1;
439             }
440             else {
441                 nbytes = n;
442             }
443 #endif
444             *ret_len = nbytes;
445         }
446     }
447     else if( control == IOBUFCTRL_FLUSH ) {
448         if( size ) {
449 #ifdef HAVE_DOSISH_SYSTEM
450             byte *p = buf;
451             unsigned long n;
452
453             nbytes = size;
454             do {
455                 if ( size && !WriteFile ( f,  p, nbytes, &n, NULL) ) {
456                     int ec = (int)GetLastError ();
457                     log_error("%s: write error: ec=%d\n", a->fname, ec);
458                     rc = G10ERR_WRITE_FILE;
459                     break;
460                 }
461                 p += n;
462                 nbytes -= n;
463             } while ( nbytes );
464             nbytes = p - buf;
465 #else
466             byte *p = buf;
467             int n;
468
469             nbytes = size;
470             do {
471                 do {
472                     n = write ( f, p, nbytes );
473                 } while ( n == -1 && errno == EINTR );
474                 if ( n > 0 ) {
475                     p += n;
476                     nbytes -= n;
477                 }
478             } while ( n != -1 && nbytes );
479             if( n == -1 ) {
480                 log_error("%s: write error: %s\n", a->fname, strerror(errno));
481                 rc = G10ERR_WRITE_FILE;
482             }
483             nbytes = p - buf;
484 #endif
485         }
486         *ret_len = nbytes;
487     }
488     else if ( control == IOBUFCTRL_INIT ) {
489         a->eof_seen = 0;
490         a->keep_open = 0;
491         a->no_cache = 0;
492     }
493     else if ( control == IOBUFCTRL_DESC ) {
494         *(char**)buf = "file_filter(fd)";
495     }
496     else if ( control == IOBUFCTRL_FREE ) {
497 #ifdef HAVE_DOSISH_SYSTEM
498         if ( f != FILEP_OR_FD_FOR_STDIN && f != FILEP_OR_FD_FOR_STDOUT ) {
499             if( DBG_IOBUF )
500                 log_debug("%s: close handle %p\n", a->fname, f );
501             if (!a->keep_open)
502                 fd_cache_close (a->no_cache?NULL:a->fname, f);
503         }
504 #else
505         if ( (int)f != 0 && (int)f != 1 ) {
506             if( DBG_IOBUF )
507                 log_debug("%s: close fd %d\n", a->fname, f );
508             if (!a->keep_open)
509                 fd_cache_close (a->no_cache?NULL:a->fname, f);
510         }
511         f = INVALID_FP;
512 #endif
513         m_free (a); /* we can free our context now */
514     }
515 #endif /* !stdio implementation */
516     return rc;
517 }
518
519 #ifdef _WIN32
520 /* Becuase sockets are an special object under Lose32 we have to
521  * use a special filter */
522 static int
523 sock_filter (void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
524 {
525     sock_filter_ctx_t *a = opaque;
526     size_t size = *ret_len;
527     size_t nbytes = 0;
528     int rc = 0;
529
530     if( control == IOBUFCTRL_UNDERFLOW ) {
531         assert( size ); /* need a buffer */
532         if ( a->eof_seen) {
533             rc = -1;            
534             *ret_len = 0;       
535         }
536         else {
537             int nread;
538
539             nread = recv ( a->sock, buf, size, 0 );
540             if ( nread == SOCKET_ERROR ) {
541                 int ec = (int)WSAGetLastError ();
542                 log_error("socket read error: ec=%d\n", ec);
543                 rc = G10ERR_READ_FILE;
544             }
545             else if ( !nread ) {
546                 a->eof_seen = 1;
547                 rc = -1;
548             }
549             else {
550                 nbytes = nread;
551             }
552             *ret_len = nbytes;
553         }
554     }
555     else if( control == IOBUFCTRL_FLUSH ) {
556         if( size ) {
557             byte *p = buf;
558             int n;
559
560             nbytes = size;
561             do {
562                 n = send (a->sock, p, nbytes, 0);
563                 if ( n == SOCKET_ERROR ) {
564                     int ec = (int)WSAGetLastError ();
565                     log_error("socket write error: ec=%d\n", ec);
566                     rc = G10ERR_WRITE_FILE;
567                     break;
568                 }
569                 p += n;
570                 nbytes -= n;
571             } while ( nbytes );
572             nbytes = p - buf;
573         }
574         *ret_len = nbytes;
575     }
576     else if ( control == IOBUFCTRL_INIT ) {
577         a->eof_seen = 0;
578         a->keep_open = 0;
579         a->no_cache = 0;
580     }
581     else if ( control == IOBUFCTRL_DESC ) {
582         *(char**)buf = "sock_filter";
583     }
584     else if ( control == IOBUFCTRL_FREE ) {
585         if (!a->keep_open)
586             closesocket (a->sock);
587         m_free (a); /* we can free our context now */
588     }
589     return rc;
590 }
591 #endif /*_WIN32*/
592
593 /****************
594  * This is used to implement the block write mode.
595  * Block reading is done on a byte by byte basis in readbyte(),
596  * without a filter
597  */
598 static int
599 block_filter(void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
600 {
601     block_filter_ctx_t *a = opaque;
602     size_t size = *ret_len;
603     int c, needed, rc = 0;
604     char *p;
605
606     if( control == IOBUFCTRL_UNDERFLOW ) {
607         size_t n=0;
608
609         p = buf;
610         assert( size ); /* need a buffer */
611         if( a->eof ) /* don't read any further */
612             rc = -1;
613         while( !rc && size ) {
614             if( !a->size ) { /* get the length bytes */
615                 if( a->partial == 2 ) {
616                     a->eof = 1;
617                     if( !n )
618                         rc = -1;
619                     break;
620                 }
621                 else if( a->partial ) {
622                     /* These OpenPGP introduced huffman like encoded length
623                      * bytes are really a mess :-( */
624                     if( a->first_c ) {
625                         c = a->first_c;
626                         a->first_c = 0;
627                     }
628                     else if( (c = iobuf_get(chain)) == -1 ) {
629                         log_error("block_filter: 1st length byte missing\n");
630                         rc = G10ERR_READ_FILE;
631                         break;
632                     }
633                     if( c < 192 ) {
634                         a->size = c;
635                         a->partial = 2;
636                         if( !a->size ) {
637                             a->eof = 1;
638                             if( !n )
639                                 rc = -1;
640                             break;
641                         }
642                     }
643                     else if( c < 224 ) {
644                         a->size = (c - 192) * 256;
645                         if( (c = iobuf_get(chain)) == -1 ) {
646                             log_error("block_filter: 2nd length byte missing\n");
647                             rc = G10ERR_READ_FILE;
648                             break;
649                         }
650                         a->size += c + 192;
651                         a->partial = 2;
652                         if( !a->size ) {
653                             a->eof = 1;
654                             if( !n )
655                                 rc = -1;
656                             break;
657                         }
658                     }
659                     else if( c == 255 ) {
660                         a->size  = iobuf_get(chain) << 24;
661                         a->size |= iobuf_get(chain) << 16;
662                         a->size |= iobuf_get(chain) << 8;
663                         if( (c = iobuf_get(chain)) == -1 ) {
664                             log_error("block_filter: invalid 4 byte length\n");
665                             rc = G10ERR_READ_FILE;
666                             break;
667                         }
668                         a->size |= c;
669                         a->partial = 2;
670                         if( !a->size ) {
671                             a->eof = 1;
672                             if( !n )
673                                 rc = -1;
674                             break;
675                         }
676                     }
677                     else { /* next partial body length */
678                         a->size = 1 << (c & 0x1f);
679                     }
680             /*  log_debug("partial: ctx=%p c=%02x size=%u\n", a, c, a->size);*/
681                 }
682                 else
683                   BUG();
684             }
685
686             while( !rc && size && a->size ) {
687                 needed = size < a->size ? size : a->size;
688                 c = iobuf_read( chain, p, needed );
689                 if( c < needed ) {
690                     if( c == -1 ) c = 0;
691                     log_error("block_filter %p: read error (size=%lu,a->size=%lu)\n",
692                               a,  (ulong)size+c, (ulong)a->size+c);
693                     rc = G10ERR_READ_FILE;
694                 }
695                 else {
696                     size -= c;
697                     a->size -= c;
698                     p += c;
699                     n += c;
700                 }
701             }
702         }
703         *ret_len = n;
704     }
705     else if( control == IOBUFCTRL_FLUSH ) {
706         if( a->partial ) { /* the complicated openpgp scheme */
707             size_t blen, n, nbytes = size + a->buflen;
708
709             assert( a->buflen <= OP_MIN_PARTIAL_CHUNK );
710             if( nbytes < OP_MIN_PARTIAL_CHUNK ) {
711                 /* not enough to write a partial block out; so we store it*/
712                 if( !a->buffer )
713                     a->buffer = m_alloc( OP_MIN_PARTIAL_CHUNK );
714                 memcpy( a->buffer + a->buflen, buf, size );
715                 a->buflen += size;
716             }
717             else { /* okay, we can write out something */
718                 /* do this in a loop to use the most efficient block lengths */
719                 p = buf;
720                 do {
721                     /* find the best matching block length - this is limited
722                      * by the size of the internal buffering */
723                     for( blen=OP_MIN_PARTIAL_CHUNK*2,
724                             c=OP_MIN_PARTIAL_CHUNK_2POW+1; blen <= nbytes;
725                                                             blen *=2, c++ )
726                         ;
727                     blen /= 2; c--;
728                     /* write the partial length header */
729                     assert( c <= 0x1f ); /*;-)*/
730                     c |= 0xe0;
731                     iobuf_put( chain, c );
732                     if( (n=a->buflen) ) { /* write stuff from the buffer */
733                         assert( n == OP_MIN_PARTIAL_CHUNK);
734                         if( iobuf_write(chain, a->buffer, n ) )
735                             rc = G10ERR_WRITE_FILE;
736                         a->buflen = 0;
737                         nbytes -= n;
738                     }
739                     if( (n = nbytes) > blen )
740                         n = blen;
741                     if( n && iobuf_write(chain, p, n ) )
742                         rc = G10ERR_WRITE_FILE;
743                     p += n;
744                     nbytes -= n;
745                 } while( !rc && nbytes >= OP_MIN_PARTIAL_CHUNK );
746                 /* store the rest in the buffer */
747                 if( !rc && nbytes ) {
748                     assert( !a->buflen );
749                     assert( nbytes < OP_MIN_PARTIAL_CHUNK );
750                     if( !a->buffer )
751                         a->buffer = m_alloc( OP_MIN_PARTIAL_CHUNK );
752                     memcpy( a->buffer, p, nbytes );
753                     a->buflen = nbytes;
754                 }
755             }
756         }
757         else
758           BUG();
759     }
760     else if( control == IOBUFCTRL_INIT ) {
761         if( DBG_IOBUF )
762             log_debug("init block_filter %p\n", a );
763         if( a->partial )
764             a->count = 0;
765         else if( a->use == 1 )
766             a->count = a->size = 0;
767         else
768             a->count = a->size; /* force first length bytes */
769         a->eof = 0;
770         a->buffer = NULL;
771         a->buflen = 0;
772     }
773     else if( control == IOBUFCTRL_DESC ) {
774         *(char**)buf = "block_filter";
775     }
776     else if( control == IOBUFCTRL_FREE ) {
777         if( a->use == 2 ) { /* write the end markers */
778             if( a->partial ) {
779                 u32 len;
780                 /* write out the remaining bytes without a partial header
781                  * the length of this header may be 0 - but if it is
782                  * the first block we are not allowed to use a partial header
783                  * and frankly we can't do so, because this length must be
784                  * a power of 2. This is _really_ complicated because we
785                  * have to check the possible length of a packet prior
786                  * to it's creation: a chain of filters becomes complicated
787                  * and we need a lot of code to handle compressed packets etc.
788                  *   :-(((((((
789                  */
790                 /* construct header */
791                 len = a->buflen;
792                 /*log_debug("partial: remaining length=%u\n", len );*/
793                 if( len < 192 )
794                     rc = iobuf_put(chain, len );
795                 else if( len < 8384 ) {
796                     if( !(rc=iobuf_put( chain, ((len-192) / 256) + 192)) )
797                         rc = iobuf_put( chain, ((len-192) % 256));
798                 }
799                 else { /* use a 4 byte header */
800                     if( !(rc=iobuf_put( chain, 0xff )) )
801                         if( !(rc=iobuf_put( chain, (len >> 24)&0xff )) )
802                             if( !(rc=iobuf_put( chain, (len >> 16)&0xff )) )
803                                 if( !(rc=iobuf_put( chain, (len >> 8)&0xff )))
804                                     rc=iobuf_put( chain, len & 0xff );
805                 }
806                 if( !rc && len )
807                     rc = iobuf_write(chain, a->buffer, len );
808                 if( rc ) {
809                     log_error("block_filter: write error: %s\n",strerror(errno));
810                     rc = G10ERR_WRITE_FILE;
811                 }
812                 m_free( a->buffer ); a->buffer = NULL; a->buflen = 0;
813             }
814             else
815               BUG();
816         }
817         else if( a->size ) {
818             log_error("block_filter: pending bytes!\n");
819         }
820         if( DBG_IOBUF )
821             log_debug("free block_filter %p\n", a );
822         m_free(a); /* we can free our context now */
823     }
824
825     return rc;
826 }
827
828
829 static void
830 print_chain( IOBUF a )
831 {
832     if( !DBG_IOBUF )
833         return;
834     for(; a; a = a->chain ) {
835         size_t dummy_len = 0;
836         const char *desc = "[none]";
837
838         if( a->filter )
839             a->filter( a->filter_ov, IOBUFCTRL_DESC, NULL,
840                                                 (byte*)&desc, &dummy_len );
841
842         log_debug("iobuf chain: %d.%d `%s' filter_eof=%d start=%d len=%d\n",
843                    a->no, a->subno, desc, a->filter_eof,
844                    (int)a->d.start, (int)a->d.len );
845     }
846 }
847
848 int
849 iobuf_print_chain( IOBUF a )
850 {
851     print_chain(a);
852     return 0;
853 }
854
855 /****************
856  * Allocate a new io buffer, with no function assigned.
857  * Use is the desired usage: 1 for input, 2 for output, 3 for temp buffer
858  * BUFSIZE is a suggested buffer size.
859  */
860 IOBUF
861 iobuf_alloc(int use, size_t bufsize)
862 {
863     IOBUF a;
864     static int number=0;
865
866     a = m_alloc_clear(sizeof *a);
867     a->use = use;
868     a->d.buf = m_alloc( bufsize );
869     a->d.size = bufsize;
870     a->no = ++number;
871     a->subno = 0;
872     a->opaque = NULL;
873     a->real_fname = NULL;
874     return a;
875 }
876
877 int
878 iobuf_close ( IOBUF a )
879 {
880     IOBUF a2;
881     size_t dummy_len=0;
882     int rc=0;
883
884     if( a && a->directfp ) {
885         fclose( a->directfp );
886         m_free( a->real_fname );
887         if( DBG_IOBUF )
888             log_debug("iobuf_close -> %p\n", a->directfp );
889         return 0;
890     }
891
892     for( ; a && !rc ; a = a2 ) {
893         a2 = a->chain;
894         if( a->use == 2 && (rc=iobuf_flush(a)) )
895             log_error("iobuf_flush failed on close: %s\n", g10_errstr(rc));
896
897         if( DBG_IOBUF )
898             log_debug("iobuf-%d.%d: close `%s'\n", a->no, a->subno, a->desc );
899         if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE,
900                                          a->chain, NULL, &dummy_len)) )
901             log_error("IOBUFCTRL_FREE failed on close: %s\n", g10_errstr(rc) );
902         m_free(a->real_fname);
903         if (a->d.buf) {
904             memset (a->d.buf, 0, a->d.size); /* erase the buffer */
905             m_free(a->d.buf);
906         }
907         m_free(a);
908     }
909     return rc;
910 }
911
912 int
913 iobuf_cancel( IOBUF a )
914 {
915     const char *s;
916     IOBUF a2;
917     int rc;
918 #if defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
919     char *remove_name = NULL;
920 #endif
921
922     if( a && a->use == 2 ) {
923         s = iobuf_get_real_fname(a);
924         if( s && *s ) {
925 #if defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
926             remove_name = m_strdup ( s );
927 #else
928             remove(s);
929 #endif
930         }
931     }
932
933     /* send a cancel message to all filters */
934     for( a2 = a; a2 ; a2 = a2->chain ) {
935         size_t dummy;
936         if( a2->filter )
937             a2->filter( a2->filter_ov, IOBUFCTRL_CANCEL, a2->chain,
938                                                          NULL, &dummy );
939     }
940
941     rc = iobuf_close(a);
942 #if defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
943     if ( remove_name ) {
944         /* Argg, MSDOS does not allow to remove open files.  So
945          * we have to do it here */
946         remove ( remove_name );
947         m_free ( remove_name );
948     }
949 #endif
950     return rc;
951 }
952
953
954 /****************
955  * create a temporary iobuf, which can be used to collect stuff
956  * in an iobuf and later be written by iobuf_write_temp() to another
957  * iobuf.
958  */
959 IOBUF
960 iobuf_temp()
961 {
962     IOBUF a;
963
964     a = iobuf_alloc(3, 8192 );
965
966     return a;
967 }
968
969 IOBUF
970 iobuf_temp_with_content( const char *buffer, size_t length )
971 {
972     IOBUF a;
973
974     a = iobuf_alloc(3, length );
975     memcpy( a->d.buf, buffer, length );
976     a->d.len = length;
977
978     return a;
979 }
980
981 void
982 iobuf_enable_special_filenames ( int yes )
983 {
984     special_names_enabled = yes;
985 }
986
987 /*
988  * see whether the filename has the for "-&nnnn", where n is a
989  * non-zero number.
990  * Returns this number or -1 if it is not the case.
991  */
992 static int
993 check_special_filename ( const char *fname )
994 {
995     if ( special_names_enabled
996          && fname && *fname == '-' && fname[1] == '&' ) {
997         int i;
998
999         fname += 2;
1000         for (i=0; digitp (fname+i); i++ )
1001             ;
1002         if ( !fname[i] ) 
1003             return atoi (fname);
1004     }
1005     return -1;
1006 }
1007
1008 /****************
1009  * Create a head iobuf for reading from a file
1010  * returns: NULL if an error occures and sets errno
1011  */
1012 IOBUF
1013 iobuf_open( const char *fname )
1014 {
1015     IOBUF a;
1016     FILEP_OR_FD fp;
1017     file_filter_ctx_t *fcx;
1018     size_t len;
1019     int print_only = 0;
1020     int fd;
1021
1022     if( !fname || (*fname=='-' && !fname[1])  ) {
1023         fp = FILEP_OR_FD_FOR_STDIN;
1024 #ifdef USE_SETMODE
1025         setmode ( my_fileno(fp) , O_BINARY );
1026 #endif
1027         fname = "[stdin]";
1028         print_only = 1;
1029     }
1030     else if ( (fd = check_special_filename ( fname )) != -1 )
1031         return iobuf_fdopen ( translate_file_handle (fd,0), "rb" );
1032     else if( (fp = my_fopen_ro(fname, "rb")) == INVALID_FP )
1033         return NULL;
1034     a = iobuf_alloc(1, 8192 );
1035     fcx = m_alloc( sizeof *fcx + strlen(fname) );
1036     fcx->fp = fp;
1037     fcx->print_only_name = print_only;
1038     strcpy(fcx->fname, fname );
1039     if( !print_only )
1040         a->real_fname = m_strdup( fname );
1041     a->filter = file_filter;
1042     a->filter_ov = fcx;
1043     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
1044     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
1045     if( DBG_IOBUF )
1046         log_debug("iobuf-%d.%d: open `%s' fd=%d\n",
1047                    a->no, a->subno, fname, (int)my_fileno(fcx->fp) );
1048
1049     return a;
1050 }
1051
1052 /****************
1053  * Create a head iobuf for reading from a file
1054  * returns: NULL if an error occures and sets errno
1055  */
1056 IOBUF
1057 iobuf_fdopen( int fd, const char *mode )
1058 {
1059     IOBUF a;
1060     FILEP_OR_FD fp;
1061     file_filter_ctx_t *fcx;
1062     size_t len;
1063
1064 #ifdef FILE_FILTER_USES_STDIO
1065     if( !(fp = fdopen(fd, mode)) )
1066         return NULL;
1067 #else
1068     fp = (FILEP_OR_FD)fd;
1069 #endif
1070     a = iobuf_alloc( strchr( mode, 'w')? 2:1, 8192 );
1071     fcx = m_alloc( sizeof *fcx + 20 );
1072     fcx->fp = fp;
1073     fcx->print_only_name = 1;
1074     sprintf(fcx->fname, "[fd %d]", fd );
1075     a->filter = file_filter;
1076     a->filter_ov = fcx;
1077     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
1078     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
1079     if( DBG_IOBUF )
1080         log_debug("iobuf-%d.%d: fdopen `%s'\n", a->no, a->subno, fcx->fname );
1081     iobuf_ioctl (a,3,1,NULL); /* disable fd caching */
1082     return a;
1083 }
1084
1085
1086 IOBUF
1087 iobuf_sockopen ( int fd, const char *mode )
1088 {
1089     IOBUF a;
1090 #ifdef _WIN32
1091     sock_filter_ctx_t *scx;
1092     size_t len;
1093
1094     a = iobuf_alloc( strchr( mode, 'w')? 2:1, 8192 );
1095     scx = m_alloc( sizeof *scx + 25 );
1096     scx->sock = fd;
1097     scx->print_only_name = 1;
1098     sprintf(scx->fname, "[sock %d]", fd );
1099     a->filter = sock_filter;
1100     a->filter_ov = scx;
1101     sock_filter( scx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
1102     sock_filter( scx, IOBUFCTRL_INIT, NULL, NULL, &len );
1103     if( DBG_IOBUF )
1104         log_debug("iobuf-%d.%d: sockopen `%s'\n", a->no, a->subno, scx->fname);
1105     iobuf_ioctl (a,3,1,NULL); /* disable fd caching */ 
1106 #else
1107     a = iobuf_fdopen (fd, mode);
1108 #endif
1109     return a;
1110 }
1111
1112 /****************
1113  * create an iobuf for writing to a file; the file will be created.
1114  */
1115 IOBUF
1116 iobuf_create( const char *fname )
1117 {
1118     IOBUF a;
1119     FILEP_OR_FD fp;
1120     file_filter_ctx_t *fcx;
1121     size_t len;
1122     int print_only = 0;
1123     int fd;
1124
1125     if( !fname || (*fname=='-' && !fname[1]) ) {
1126         fp = FILEP_OR_FD_FOR_STDOUT;
1127 #ifdef USE_SETMODE
1128         setmode ( my_fileno(fp) , O_BINARY );
1129 #endif
1130         fname = "[stdout]";
1131         print_only = 1;
1132     }
1133     else if ( (fd = check_special_filename ( fname )) != -1 )
1134         return iobuf_fdopen ( translate_file_handle (fd, 1), "wb" );
1135     else if( (fp = my_fopen(fname, "wb")) == INVALID_FP )
1136         return NULL;
1137     a = iobuf_alloc(2, 8192 );
1138     fcx = m_alloc( sizeof *fcx + strlen(fname) );
1139     fcx->fp = fp;
1140     fcx->print_only_name = print_only;
1141     strcpy(fcx->fname, fname );
1142     if( !print_only )
1143         a->real_fname = m_strdup( fname );
1144     a->filter = file_filter;
1145     a->filter_ov = fcx;
1146     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
1147     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
1148     if( DBG_IOBUF )
1149         log_debug("iobuf-%d.%d: create `%s'\n", a->no, a->subno, a->desc );
1150
1151     return a;
1152 }
1153
1154 /****************
1155  * append to an iobuf; if the file does not exist, create it.
1156  * cannot be used for stdout.
1157  * Note: This is not used.
1158  */
1159 #if 0 /* not used */
1160 IOBUF
1161 iobuf_append( const char *fname )
1162 {
1163     IOBUF a;
1164     FILE *fp;
1165     file_filter_ctx_t *fcx;
1166     size_t len;
1167
1168     if( !fname )
1169         return NULL;
1170     else if( !(fp = my_fopen(fname, "ab")) )
1171         return NULL;
1172     a = iobuf_alloc(2, 8192 );
1173     fcx = m_alloc( sizeof *fcx + strlen(fname) );
1174     fcx->fp = fp;
1175     strcpy(fcx->fname, fname );
1176     a->real_fname = m_strdup( fname );
1177     a->filter = file_filter;
1178     a->filter_ov = fcx;
1179     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
1180     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
1181     if( DBG_IOBUF )
1182         log_debug("iobuf-%d.%d: append `%s'\n", a->no, a->subno, a->desc );
1183
1184     return a;
1185 }
1186 #endif
1187
1188 IOBUF
1189 iobuf_openrw( const char *fname )
1190 {
1191     IOBUF a;
1192     FILEP_OR_FD fp;
1193     file_filter_ctx_t *fcx;
1194     size_t len;
1195
1196     if( !fname )
1197         return NULL;
1198     else if( (fp = my_fopen(fname, "r+b")) == INVALID_FP )
1199         return NULL;
1200     a = iobuf_alloc(2, 8192 );
1201     fcx = m_alloc( sizeof *fcx + strlen(fname) );
1202     fcx->fp = fp;
1203     strcpy(fcx->fname, fname );
1204     a->real_fname = m_strdup( fname );
1205     a->filter = file_filter;
1206     a->filter_ov = fcx;
1207     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
1208     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
1209     if( DBG_IOBUF )
1210         log_debug("iobuf-%d.%d: openrw `%s'\n", a->no, a->subno, a->desc );
1211
1212     return a;
1213 }
1214
1215
1216 int
1217 iobuf_ioctl ( IOBUF a, int cmd, int intval, void *ptrval )
1218 {
1219     if ( cmd == 1 ) {  /* keep system filepointer/descriptor open */
1220         if( DBG_IOBUF )
1221             log_debug("iobuf-%d.%d: ioctl `%s' keep=%d\n",
1222                       a? a->no:-1, a?a->subno:-1, a?a->desc:"?", intval );
1223         for( ; a; a = a->chain )
1224             if( !a->chain && a->filter == file_filter ) {
1225                 file_filter_ctx_t *b = a->filter_ov;
1226                 b->keep_open = intval;
1227                 return 0;
1228             }
1229 #ifdef _WIN32
1230             else if( !a->chain && a->filter == sock_filter ) {
1231                 sock_filter_ctx_t *b = a->filter_ov;
1232                 b->keep_open = intval;
1233                 return 0;
1234             }
1235 #endif
1236     }
1237     else if ( cmd == 2 ) {  /* invalidate cache */
1238         if( DBG_IOBUF )
1239             log_debug("iobuf-*.*: ioctl `%s' invalidate\n",
1240                       ptrval? (char*)ptrval:"?");
1241         if ( !a && !intval && ptrval ) {
1242 #ifndef FILE_FILTER_USES_STDIO
1243             fd_cache_invalidate (ptrval);
1244 #endif
1245             return 0;
1246         }
1247     }
1248     else if ( cmd == 3 ) {  /* disallow/allow caching */
1249         if( DBG_IOBUF )
1250             log_debug("iobuf-%d.%d: ioctl `%s' no_cache=%d\n",
1251                       a? a->no:-1, a?a->subno:-1, a?a->desc:"?", intval );
1252         for( ; a; a = a->chain )
1253             if( !a->chain && a->filter == file_filter ) {
1254                 file_filter_ctx_t *b = a->filter_ov;
1255                 b->no_cache = intval;
1256                 return 0;
1257             }
1258 #ifdef _WIN32
1259             else if( !a->chain && a->filter == sock_filter ) {
1260                 sock_filter_ctx_t *b = a->filter_ov;
1261                 b->no_cache = intval;
1262                 return 0;
1263             }
1264 #endif
1265     }
1266
1267     return -1;
1268 }
1269
1270
1271 /****************
1272  * Register an i/o filter.
1273  */
1274 int
1275 iobuf_push_filter( IOBUF a,
1276                    int (*f)(void *opaque, int control,
1277                    IOBUF chain, byte *buf, size_t *len), void *ov )
1278 {
1279     return iobuf_push_filter2( a, f, ov, 0 );
1280 }
1281
1282 int
1283 iobuf_push_filter2( IOBUF a,
1284                     int (*f)(void *opaque, int control,
1285                     IOBUF chain, byte *buf, size_t *len),
1286                     void *ov, int rel_ov )
1287 {
1288     IOBUF b;
1289     size_t dummy_len=0;
1290     int rc=0;
1291
1292     if( a->directfp )
1293         BUG();
1294
1295     if( a->use == 2 && (rc=iobuf_flush(a)) )
1296         return rc;
1297     /* make a copy of the current stream, so that
1298      * A is the new stream and B the original one.
1299      * The contents of the buffers are transferred to the
1300      * new stream.
1301      */
1302     b = m_alloc(sizeof *b);
1303     memcpy(b, a, sizeof *b );
1304     /* fixme: it is stupid to keep a copy of the name at every level
1305      * but we need the name somewhere because the name known by file_filter
1306      * may have been released when we need the name of the file */
1307     b->real_fname = a->real_fname? m_strdup(a->real_fname):NULL;
1308     /* remove the filter stuff from the new stream */
1309     a->filter = NULL;
1310     a->filter_ov = NULL;
1311     a->filter_ov_owner = 0;
1312     a->filter_eof = 0;
1313     if( a->use == 3 )
1314         a->use = 2;  /* make a write stream from a temp stream */
1315
1316     if( a->use == 2 ) { /* allocate a fresh buffer for the original stream */
1317         b->d.buf = m_alloc( a->d.size );
1318         b->d.len = 0;
1319         b->d.start = 0;
1320     }
1321     else { /* allocate a fresh buffer for the new stream */
1322         a->d.buf = m_alloc( a->d.size );
1323         a->d.len = 0;
1324         a->d.start = 0;
1325     }
1326     /* disable nlimit for the new stream */
1327     a->ntotal = b->ntotal + b->nbytes;
1328     a->nlimit = a->nbytes = 0;
1329     a->nofast &= ~1;
1330     /* make a link from the new stream to the original stream */
1331     a->chain = b;
1332     a->opaque = b->opaque;
1333
1334     /* setup the function on the new stream */
1335     a->filter = f;
1336     a->filter_ov = ov;
1337     a->filter_ov_owner = rel_ov;
1338
1339     a->subno = b->subno + 1;
1340     f( ov, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &dummy_len );
1341
1342     if( DBG_IOBUF ) {
1343         log_debug("iobuf-%d.%d: push `%s'\n", a->no, a->subno, a->desc );
1344         print_chain( a );
1345     }
1346
1347     /* now we can initialize the new function if we have one */
1348     if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_INIT, a->chain,
1349                        NULL, &dummy_len)) )
1350         log_error("IOBUFCTRL_INIT failed: %s\n", g10_errstr(rc) );
1351     return rc;
1352 }
1353
1354 /****************
1355  * Remove an i/o filter.
1356  */
1357 static int
1358 pop_filter( IOBUF a, int (*f)(void *opaque, int control,
1359                       IOBUF chain, byte *buf, size_t *len), void *ov )
1360 {
1361     IOBUF b;
1362     size_t dummy_len=0;
1363     int rc=0;
1364
1365     if( a->directfp )
1366         BUG();
1367
1368     if( DBG_IOBUF )
1369         log_debug("iobuf-%d.%d: pop `%s'\n", a->no, a->subno, a->desc );
1370     if( !a->filter ) { /* this is simple */
1371         b = a->chain;
1372         assert(b);
1373         m_free(a->d.buf);
1374         m_free(a->real_fname);
1375         memcpy(a,b, sizeof *a);
1376         m_free(b);
1377         return 0;
1378     }
1379     for(b=a ; b; b = b->chain )
1380         if( b->filter == f && (!ov || b->filter_ov == ov) )
1381             break;
1382     if( !b )
1383         log_bug("pop_filter(): filter function not found\n");
1384
1385     /* flush this stream if it is an output stream */
1386     if( a->use == 2 && (rc=iobuf_flush(b)) ) {
1387         log_error("iobuf_flush failed in pop_filter: %s\n", g10_errstr(rc));
1388         return rc;
1389     }
1390     /* and tell the filter to free it self */
1391     if( b->filter && (rc = b->filter(b->filter_ov, IOBUFCTRL_FREE, b->chain,
1392                        NULL, &dummy_len)) ) {
1393         log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
1394         return rc;
1395     }
1396     if( b->filter_ov && b->filter_ov_owner ) {
1397         m_free( b->filter_ov );
1398         b->filter_ov = NULL;
1399     }
1400
1401
1402     /* and see how to remove it */
1403     if( a == b && !b->chain )
1404         log_bug("can't remove the last filter from the chain\n");
1405     else if( a == b ) { /* remove the first iobuf from the chain */
1406         /* everything from b is copied to a. This is save because
1407          * a flush has been done on the to be removed entry
1408          */
1409         b = a->chain;
1410         m_free(a->d.buf);
1411         m_free(a->real_fname);
1412         memcpy(a,b, sizeof *a);
1413         m_free(b);
1414         if( DBG_IOBUF )
1415            log_debug("iobuf-%d.%d: popped filter\n", a->no, a->subno );
1416     }
1417     else if( !b->chain ) { /* remove the last iobuf from the chain */
1418         log_bug("Ohh jeee, trying to remove a head filter\n");
1419     }
1420     else {  /* remove an intermediate iobuf from the chain */
1421         log_bug("Ohh jeee, trying to remove an intermediate filter\n");
1422     }
1423
1424     return rc;
1425 }
1426
1427
1428 /****************
1429  * read underflow: read more bytes into the buffer and return
1430  * the first byte or -1 on EOF.
1431  */
1432 static int
1433 underflow(IOBUF a)
1434 {
1435     size_t len;
1436     int rc;
1437
1438     assert( a->d.start == a->d.len );
1439     if( a->use == 3 )
1440         return -1; /* EOF because a temp buffer can't do an underflow */
1441
1442     if( a->filter_eof ) {
1443         if( a->chain ) {
1444             IOBUF b = a->chain;
1445             if( DBG_IOBUF )
1446                 log_debug("iobuf-%d.%d: pop `%s' in underflow\n",
1447                                         a->no, a->subno, a->desc );
1448             m_free(a->d.buf);
1449             m_free(a->real_fname);
1450             memcpy(a, b, sizeof *a);
1451             m_free(b);
1452             print_chain(a);
1453         }
1454         else
1455              a->filter_eof = 0;  /* for the top level filter */
1456         if( DBG_IOBUF )
1457             log_debug("iobuf-%d.%d: underflow: eof (due to filter eof)\n",
1458                                                     a->no, a->subno );
1459         return -1; /* return one(!) EOF */
1460     }
1461     if( a->error ) {
1462         if( DBG_IOBUF )
1463             log_debug("iobuf-%d.%d: error\n", a->no, a->subno );
1464         return -1;
1465     }
1466
1467     if( a->directfp ) {
1468         FILE *fp = a->directfp;
1469
1470         len = fread( a->d.buf, 1, a->d.size, fp);
1471         if( len < a->d.size ) {
1472             if( ferror(fp) )
1473                 a->error = 1;
1474         }
1475         a->d.len = len;
1476         a->d.start = 0;
1477         return len? a->d.buf[a->d.start++] : -1;
1478     }
1479
1480
1481     if( a->filter ) {
1482         len = a->d.size;
1483         if( DBG_IOBUF )
1484             log_debug("iobuf-%d.%d: underflow: req=%lu\n",
1485                       a->no, a->subno, (ulong)len );
1486         rc = a->filter( a->filter_ov, IOBUFCTRL_UNDERFLOW, a->chain,
1487                         a->d.buf, &len );
1488         if( DBG_IOBUF ) {
1489             log_debug("iobuf-%d.%d: underflow: got=%lu rc=%d\n",
1490                     a->no, a->subno, (ulong)len, rc );
1491 /*          if( a->no == 1 ) */
1492 /*                   log_hexdump ("     data:", a->d.buf, len); */
1493         }
1494         if( a->use == 1 && rc == -1 ) { /* EOF: we can remove the filter */
1495             size_t dummy_len=0;
1496
1497             /* and tell the filter to free itself */
1498             if( (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE, a->chain,
1499                                NULL, &dummy_len)) )
1500                 log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
1501             if( a->filter_ov && a->filter_ov_owner ) {
1502                 m_free( a->filter_ov );
1503                 a->filter_ov = NULL;
1504             }
1505             a->filter = NULL;
1506             a->desc = NULL;
1507             a->filter_ov = NULL;
1508             a->filter_eof = 1;
1509             if( !len && a->chain ) {
1510                 IOBUF b = a->chain;
1511                 if( DBG_IOBUF )
1512                     log_debug("iobuf-%d.%d: pop `%s' in underflow (!len)\n",
1513                                                a->no, a->subno, a->desc );
1514                 m_free(a->d.buf);
1515                 m_free(a->real_fname);
1516                 memcpy(a,b, sizeof *a);
1517                 m_free(b);
1518                 print_chain(a);
1519             }
1520         }
1521         else if( rc )
1522             a->error = 1;
1523
1524         if( !len ) {
1525             if( DBG_IOBUF )
1526                 log_debug("iobuf-%d.%d: underflow: eof\n", a->no, a->subno );
1527             return -1;
1528         }
1529         a->d.len = len;
1530         a->d.start = 0;
1531         return a->d.buf[a->d.start++];
1532     }
1533     else {
1534         if( DBG_IOBUF )
1535             log_debug("iobuf-%d.%d: underflow: eof (no filter)\n",
1536                                                     a->no, a->subno );
1537         return -1;  /* no filter; return EOF */
1538     }
1539 }
1540
1541
1542 int
1543 iobuf_flush(IOBUF a)
1544 {
1545     size_t len;
1546     int rc;
1547
1548     if( a->directfp )
1549         return 0;
1550
1551     if( a->use == 3 ) { /* increase the temp buffer */
1552         char *newbuf;
1553         size_t newsize = a->d.size + 8192;
1554
1555         if( DBG_IOBUF )
1556           log_debug("increasing temp iobuf from %lu to %lu\n",
1557                     (ulong)a->d.size, (ulong)newsize );
1558         newbuf = m_alloc( newsize );
1559         memcpy( newbuf, a->d.buf, a->d.len );
1560         m_free(a->d.buf);
1561         a->d.buf = newbuf;
1562         a->d.size = newsize;
1563         return 0;
1564     }
1565     else if( a->use != 2 )
1566         log_bug("flush on non-output iobuf\n");
1567     else if( !a->filter )
1568         log_bug("iobuf_flush: no filter\n");
1569     len = a->d.len;
1570     rc = a->filter( a->filter_ov, IOBUFCTRL_FLUSH, a->chain, a->d.buf, &len );
1571     if( !rc && len != a->d.len ) {
1572         log_info("iobuf_flush did not write all!\n");
1573         rc = G10ERR_WRITE_FILE;
1574     }
1575     else if( rc )
1576         a->error = 1;
1577     a->d.len = 0;
1578
1579     return rc;
1580 }
1581
1582
1583 /****************
1584  * Read a byte from the iobuf; returns -1 on EOF
1585  */
1586 int
1587 iobuf_readbyte(IOBUF a)
1588 {
1589     int c;
1590
1591     /* nlimit does not work together with unget */
1592     /* nbytes is also not valid! */
1593     if( a->unget.buf ) {
1594         if( a->unget.start < a->unget.len )
1595             return a->unget.buf[a->unget.start++];
1596         m_free(a->unget.buf);
1597         a->unget.buf = NULL;
1598         a->nofast &= ~2;
1599     }
1600
1601     if( a->nlimit && a->nbytes >= a->nlimit )
1602         return -1; /* forced EOF */
1603
1604     if( a->d.start < a->d.len ) {
1605         c = a->d.buf[a->d.start++];
1606     }
1607     else if( (c=underflow(a)) == -1 )
1608         return -1; /* EOF */
1609
1610     a->nbytes++;
1611     return c;
1612 }
1613
1614
1615 int
1616 iobuf_read(IOBUF a, byte *buf, unsigned buflen )
1617 {
1618     int c, n;
1619
1620     if( a->unget.buf || a->nlimit ) {
1621         /* handle special cases */
1622         for(n=0 ; n < buflen; n++ ) {
1623             if( (c = iobuf_readbyte(a)) == -1 ) {
1624                 if( !n )
1625                     return -1; /* eof */
1626                 break;
1627             }
1628             else
1629                 if( buf ) *buf = c;
1630             if( buf ) buf++;
1631         }
1632         return n;
1633     }
1634
1635     n = 0;
1636     do {
1637         if( n < buflen && a->d.start < a->d.len ) {
1638             unsigned size = a->d.len - a->d.start;
1639             if( size > buflen - n )
1640                 size = buflen - n;
1641             if( buf )
1642                 memcpy( buf, a->d.buf + a->d.start, size );
1643             n += size;
1644             a->d.start += size;
1645             if( buf )
1646                 buf += size;
1647         }
1648         if( n < buflen ) {
1649             if( (c=underflow(a)) == -1 ) {
1650                 a->nbytes += n;
1651                 return n? n : -1/*EOF*/;
1652             }
1653             if( buf )
1654                 *buf++ = c;
1655             n++;
1656         }
1657     } while( n < buflen );
1658     a->nbytes += n;
1659     return n;
1660 }
1661
1662
1663 /****************
1664  * Have a look at the iobuf.
1665  * NOTE: This only works in special cases.
1666  */
1667 int
1668 iobuf_peek(IOBUF a, byte *buf, unsigned buflen )
1669 {
1670     int n=0;
1671
1672     if( a->filter_eof )
1673         return -1;
1674
1675     if( !(a->d.start < a->d.len) ) {
1676         if( underflow(a) == -1 )
1677             return -1;
1678         /* and unget this character */
1679         assert(a->d.start == 1);
1680         a->d.start = 0;
1681     }
1682
1683     for(n=0 ; n < buflen && (a->d.start+n) < a->d.len ; n++, buf++ )
1684         *buf = a->d.buf[n];
1685     return n;
1686 }
1687
1688
1689
1690
1691 int
1692 iobuf_writebyte(IOBUF a, unsigned c)
1693 {
1694
1695     if( a->directfp )
1696         BUG();
1697
1698     if( a->d.len == a->d.size )
1699         if( iobuf_flush(a) )
1700             return -1;
1701
1702     assert( a->d.len < a->d.size );
1703     a->d.buf[a->d.len++] = c;
1704     return 0;
1705 }
1706
1707
1708 int
1709 iobuf_write(IOBUF a, byte *buf, unsigned buflen )
1710 {
1711
1712     if( a->directfp )
1713         BUG();
1714
1715     do {
1716         if( buflen && a->d.len < a->d.size ) {
1717             unsigned size = a->d.size - a->d.len;
1718             if( size > buflen ) size = buflen;
1719             memcpy( a->d.buf + a->d.len, buf, size );
1720             buflen -= size;
1721             buf += size;
1722             a->d.len += size;
1723         }
1724         if( buflen ) {
1725             if( iobuf_flush(a) )
1726                 return -1;
1727         }
1728     } while( buflen );
1729     return 0;
1730 }
1731
1732
1733 int
1734 iobuf_writestr(IOBUF a, const char *buf )
1735 {
1736     for( ; *buf; buf++ )
1737         if( iobuf_writebyte(a, *buf) )
1738             return -1;
1739     return 0;
1740 }
1741
1742
1743
1744 /****************
1745  * copy the contents of TEMP to A.
1746  */
1747 int
1748 iobuf_write_temp( IOBUF a, IOBUF temp )
1749 {
1750     while( temp->chain )
1751         pop_filter( temp, temp->filter, NULL );
1752     return iobuf_write(a, temp->d.buf, temp->d.len );
1753 }
1754
1755 /****************
1756  * copy the contents of the temp io stream to BUFFER.
1757  */
1758 size_t
1759 iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen )
1760 {
1761     size_t n = a->d.len;
1762
1763     if( n > buflen )
1764         n = buflen;
1765     memcpy( buffer, a->d.buf, n );
1766     return n;
1767 }
1768
1769
1770 /****************
1771  * Call this function to terminate processing of the temp stream
1772  * without closing it.  This removes all filters from the stream
1773  * makes sure that iobuf_get_temp_{buffer,length}() returns correct
1774  * values.
1775  */
1776 void
1777 iobuf_flush_temp( IOBUF temp )
1778 {
1779     while( temp->chain )
1780         pop_filter( temp, temp->filter, NULL );
1781 }
1782
1783
1784 /****************
1785  * Set a limit on how many bytes may be read from the input stream A.
1786  * Setting the limit to 0 disables this feature.
1787  */
1788 void
1789 iobuf_set_limit( IOBUF a, off_t nlimit )
1790 {
1791     if( nlimit )
1792         a->nofast |= 1;
1793     else
1794         a->nofast &= ~1;
1795     a->nlimit = nlimit;
1796     a->ntotal += a->nbytes;
1797     a->nbytes = 0;
1798 }
1799
1800
1801
1802 /****************
1803  * Return the length of an open file
1804  */
1805 off_t
1806 iobuf_get_filelength( IOBUF a )
1807 {
1808     struct stat st;
1809
1810     if( a->directfp )  {
1811         FILE *fp = a->directfp;
1812
1813        if( !fstat(fileno(fp), &st) )
1814            return st.st_size;
1815         log_error("fstat() failed: %s\n", strerror(errno) );
1816         return 0;
1817     }
1818
1819     /* Hmmm: file_filter may have already been removed */
1820     for( ; a; a = a->chain )
1821         if( !a->chain && a->filter == file_filter ) {
1822             file_filter_ctx_t *b = a->filter_ov;
1823             FILEP_OR_FD fp = b->fp;
1824
1825 #if defined(HAVE_DOSISH_SYSTEM) && !defined(FILE_FILTER_USES_STDIO)
1826             ulong size;
1827
1828             if ( (size=GetFileSize (fp, NULL)) != 0xffffffff ) 
1829                 return size;
1830             log_error ("GetFileSize for handle %p failed: ec=%d\n",
1831                        fp, (int)GetLastError () );
1832 #else
1833             if( !fstat(my_fileno(fp), &st) )
1834                 return st.st_size;
1835             log_error("fstat() failed: %s\n", strerror(errno) );
1836 #endif
1837             break;
1838         }
1839
1840     return 0;
1841 }
1842
1843 /****************
1844  * Tell the file position, where the next read will take place
1845  */
1846 off_t
1847 iobuf_tell( IOBUF a )
1848 {
1849     return a->ntotal + a->nbytes;
1850 }
1851
1852
1853 #if !defined(HAVE_FSEEKO) && !defined(fseeko)
1854
1855 #ifdef HAVE_LIMITS_H
1856 # include <limits.h>
1857 #endif
1858 #ifndef LONG_MAX
1859 # define LONG_MAX ((long) ((unsigned long) -1 >> 1))
1860 #endif
1861 #ifndef LONG_MIN
1862 # define LONG_MIN (-1 - LONG_MAX)
1863 #endif
1864
1865 /****************
1866  * A substitute for fseeko, for hosts that don't have it.
1867  */
1868 static int
1869 fseeko( FILE *stream, off_t newpos, int whence )
1870 {
1871     while( newpos != (long) newpos ) {
1872        long pos = newpos < 0 ? LONG_MIN : LONG_MAX;
1873        if( fseek( stream, pos, whence ) != 0 )
1874            return -1;
1875        newpos -= pos;
1876        whence = SEEK_CUR;
1877     }
1878     return fseek( stream, (long)newpos, whence );
1879 }
1880 #endif
1881
1882 /****************
1883  * This is a very limited implementation. It simply discards all internal
1884  * buffering and removes all filters but the first one.
1885  */
1886 int
1887 iobuf_seek( IOBUF a, off_t newpos )
1888 {
1889     file_filter_ctx_t *b = NULL;
1890
1891     if( a->directfp ) {
1892         FILE *fp = a->directfp;
1893         if( fseeko( fp, newpos, SEEK_SET ) ) {
1894             log_error("can't seek: %s\n", strerror(errno) );
1895             return -1;
1896         }
1897         clearerr(fp);
1898     }
1899     else {
1900         for( ; a; a = a->chain ) {
1901             if( !a->chain && a->filter == file_filter ) {
1902                 b = a->filter_ov;
1903                 break;
1904             }
1905         }
1906         if( !a )
1907             return -1;
1908 #ifdef FILE_FILTER_USES_STDIO
1909        if( fseeko( b->fp, newpos, SEEK_SET ) ) {
1910            log_error("can't fseek: %s\n", strerror(errno) );
1911            return -1;
1912        }
1913 #else
1914 #ifdef HAVE_DOSISH_SYSTEM
1915        if (SetFilePointer (b->fp, newpos, NULL, FILE_BEGIN) == 0xffffffff ) {
1916            log_error ("SetFilePointer failed on handle %p: ec=%d\n",
1917                       b->fp, (int)GetLastError () );
1918            return -1;
1919        }
1920 #else
1921        if ( lseek (b->fp, newpos, SEEK_SET) == (off_t)-1 ) {
1922            log_error("can't lseek: %s\n", strerror(errno) );
1923            return -1;
1924        }
1925 #endif
1926 #endif
1927     }
1928     a->d.len = 0;   /* discard buffer */
1929     a->d.start = 0;
1930     a->nbytes = 0;
1931     a->nlimit = 0;
1932     a->nofast &= ~1;
1933     a->ntotal = newpos;
1934     a->error = 0;
1935     /* remove filters, but the last */
1936     if( a->chain )
1937         log_debug("pop_filter called in iobuf_seek - please report\n");
1938     while( a->chain )
1939        pop_filter( a, a->filter, NULL );
1940
1941     return 0;
1942 }
1943
1944
1945
1946
1947
1948
1949 /****************
1950  * Retrieve the real filename
1951  */
1952 const char *
1953 iobuf_get_real_fname( IOBUF a )
1954 {
1955     if( a->real_fname )
1956         return a->real_fname;
1957
1958     /* the old solution */
1959     for( ; a; a = a->chain )
1960         if( !a->chain && a->filter == file_filter ) {
1961             file_filter_ctx_t *b = a->filter_ov;
1962             return b->print_only_name? NULL : b->fname;
1963         }
1964
1965     return NULL;
1966 }
1967
1968
1969 /****************
1970  * Retrieve the filename
1971  */
1972 const char *
1973 iobuf_get_fname( IOBUF a )
1974 {
1975     for( ; a; a = a->chain )
1976         if( !a->chain && a->filter == file_filter ) {
1977             file_filter_ctx_t *b = a->filter_ov;
1978             return b->fname;
1979         }
1980
1981     return NULL;
1982 }
1983
1984
1985 /****************
1986  * enable partial block mode as described in the OpenPGP draft.
1987  * LEN is the first length byte on read, but ignored on writes.
1988  */
1989 void
1990 iobuf_set_partial_block_mode( IOBUF a, size_t len )
1991 {
1992     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1993
1994     assert( a->use == 1 || a->use == 2 );
1995     ctx->use = a->use;
1996     if( !len ) {
1997         if( a->use == 1 )
1998             log_debug("pop_filter called in set_partial_block_mode"
1999                                                     " - please report\n");
2000         pop_filter(a, block_filter, NULL );
2001     }
2002     else {
2003         ctx->partial = 1;
2004         ctx->size = 0;
2005         ctx->first_c = len;
2006         iobuf_push_filter(a, block_filter, ctx );
2007     }
2008 }
2009
2010
2011 /****************
2012  * Same as fgets() but if the buffer is too short a larger one will
2013  * be allocated up to some limit *max_length.
2014  * A line is considered a byte stream ending in a LF.
2015  * Returns the length of the line. EOF is indicated by a line of
2016  * length zero. The last LF may be missing due to an EOF.
2017  * is max_length is zero on return, the line has been truncated.
2018  *
2019  * Note: The buffer is allocated with enough space to append a CR,LF,EOL
2020  */
2021 unsigned
2022 iobuf_read_line( IOBUF a, byte **addr_of_buffer,
2023                           unsigned *length_of_buffer, unsigned *max_length )
2024 {
2025     int c;
2026     char *buffer = *addr_of_buffer;
2027     unsigned length = *length_of_buffer;
2028     unsigned nbytes = 0;
2029     unsigned maxlen = *max_length;
2030     char *p;
2031
2032     if( !buffer ) { /* must allocate a new buffer */
2033         length = 256;
2034         buffer = m_alloc( length );
2035         *addr_of_buffer = buffer;
2036         *length_of_buffer = length;
2037     }
2038
2039     length -= 3; /* reserve 3 bytes (cr,lf,eol) */
2040     p = buffer;
2041     while( (c=iobuf_get(a)) != -1 ) {
2042         if( nbytes == length ) { /* increase the buffer */
2043             if( length > maxlen  ) { /* this is out limit */
2044                 /* skip the rest of the line */
2045                 while( c != '\n' && (c=iobuf_get(a)) != -1 )
2046                     ;
2047                 *p++ = '\n'; /* always append a LF (we have reserved space) */
2048                 nbytes++;
2049                 *max_length = 0; /* indicate truncation */
2050                 break;
2051             }
2052             length += 3; /* correct for the reserved byte */
2053             length += length < 1024? 256 : 1024;
2054             buffer = m_realloc( buffer, length );
2055             *addr_of_buffer = buffer;
2056             *length_of_buffer = length;
2057             length -= 3; /* and reserve again */
2058             p = buffer + nbytes;
2059         }
2060         *p++ = c;
2061         nbytes++;
2062         if( c == '\n' )
2063             break;
2064     }
2065     *p = 0; /* make sure the line is a string */
2066
2067     return nbytes;
2068 }
2069
2070 /* This is the non iobuf specific function */
2071 int
2072 iobuf_translate_file_handle ( int fd, int for_write )
2073 {
2074 #ifdef _WIN32
2075     {
2076         int x;
2077             
2078         if  ( fd <= 2 )
2079             return fd; /* do not do this for error, stdin, stdout, stderr */
2080
2081         x = _open_osfhandle ( fd, for_write? 1:0 );
2082         if (x==-1 )
2083             log_error ("failed to translate osfhandle %p\n", (void*)fd );
2084         else {
2085             /*log_info ("_open_osfhandle %p yields %d%s\n",
2086               (void*)fd, x, for_write? " for writing":"" );*/
2087             fd = x;
2088         }
2089     }
2090 #endif
2091     return fd;
2092 }
2093
2094 static int
2095 translate_file_handle ( int fd, int for_write )
2096 {
2097 #ifdef _WIN32
2098 #ifdef FILE_FILTER_USES_STDIO  
2099     fd = iobuf_translate_file_handle (fd, for_write);
2100 #else
2101     {
2102         int x;
2103
2104         if  ( fd == 0 ) 
2105             x = (int)GetStdHandle (STD_INPUT_HANDLE);
2106         else if (fd == 1)    
2107             x = (int)GetStdHandle (STD_OUTPUT_HANDLE);
2108         else if (fd == 2)    
2109             x = (int)GetStdHandle (STD_ERROR_HANDLE);
2110         else
2111             x = fd;
2112
2113         if (x == -1)
2114             log_debug ("GetStdHandle(%d) failed: ec=%d\n",
2115                        fd, (int)GetLastError () );
2116
2117         fd = x;
2118     }
2119 #endif
2120 #endif
2121     return fd;
2122 }
2123
2124
2125 void
2126 iobuf_skip_rest(IOBUF a, unsigned long n, int partial)
2127 {
2128     if ( partial ) {
2129         for (;;) {
2130             if (a->nofast || a->d.start >= a->d.len) {
2131                 if (iobuf_readbyte (a) == -1) {
2132                     break;
2133                 }
2134             } else {
2135                 unsigned long count = a->d.len - a->d.start;
2136                 a->nbytes += count;
2137                 a->d.start = a->d.len;
2138             }
2139         }
2140     } else {
2141         unsigned long remaining = n;
2142         while (remaining > 0) {
2143             if (a->nofast || a->d.start >= a->d.len) {
2144                 if (iobuf_readbyte (a) == -1) {
2145                     break;
2146                 }
2147                 --remaining;
2148             } else {
2149                 unsigned long count = a->d.len - a->d.start;
2150                 if (count > remaining) {
2151                     count = remaining;
2152                 }
2153                 a->nbytes += count;
2154                 a->d.start += count;
2155                 remaining -= count;
2156             }
2157         }
2158     }
2159 }