*** empty log message ***
[gnupg.git] / util / iobuf.c
1 /* iobuf.c  -  file handling
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GNUPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30
31 #include "memory.h"
32 #include "util.h"
33 #include "iobuf.h"
34
35 typedef struct {
36     FILE *fp;      /* open file handle */
37     int  print_only_name; /* flags indicating that fname is not a real file*/
38     char fname[1]; /* name of the file */
39 } file_filter_ctx_t ;
40
41 /* The first partial length header block must be of size 512
42  * to make it easier (and efficienter) we use a min. block size of 512
43  * for all chznks (but the last one) */
44 #define OP_MIN_PARTIAL_CHUNK      512
45 #define OP_MIN_PARTIAL_CHUNK_2POW 9
46
47 typedef struct {
48     int usage;
49     size_t size;
50     size_t count;
51     int partial;  /* 1 = partial header, 2 in last partial packet */
52     char *buffer;    /* used for partial header */
53     size_t buflen;   /* used size of buffer */
54     int first_c;     /* of partial header (which is > 0)*/
55     int eof;
56 } block_filter_ctx_t;
57
58
59 static int underflow(IOBUF a);
60 static const char *get_real_fname( IOBUF a );
61
62 /****************
63  * Read data from a file into buf which has an allocated length of *LEN.
64  * return the number of read bytes in *LEN. OPAQUE is the FILE * of
65  * the stream. A is not used.
66  * control may be:
67  * IOBUFCTRL_INIT: called just before the function is linked into the
68  *                 list of function. This can be used to prepare internal
69  *                 data structures of the function.
70  * IOBUFCTRL_FREE: called just before the function is removed from the
71  *                  list of functions and can be used to release internal
72  *                  data structures or close a file etc.
73  * IOBUFCTRL_UNDERFLOW: called by iobuf_underflow to fill the buffer
74  *                  with new stuff. *RET_LEN is the available size of the
75  *                  buffer, and should be set to the number of bytes
76  *                  which were put into the buffer. The function
77  *                  returns 0 to indicate success, -1 on EOF and
78  *                  G10ERR_xxxxx for other errors.
79  *
80  * IOBUFCTRL_FLUSH: called by iobuf_flush() to write out the collected stuff.
81  *                  *RET_LAN is the number of bytes in BUF.
82  *
83  */
84 static int
85 file_filter(void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
86 {
87     file_filter_ctx_t *a = opaque;
88     FILE *fp = a->fp;
89     size_t size = *ret_len;
90     size_t nbytes = 0;
91     int c, rc = 0;
92     char *p;
93
94     if( control == IOBUFCTRL_UNDERFLOW ) {
95         assert( size ); /* need a buffer */
96         for(; size; size-- ) {
97             if( (c=getc(fp)) == EOF ) {
98                 if( ferror(fp) ) {
99                     log_error("%s: read error: %s\n",
100                                         a->fname, strerror(errno));
101                     rc = G10ERR_READ_FILE;
102                 }
103                 else if( !nbytes )
104                     rc = -1; /* okay: we can return EOF now. */
105                 break;
106             }
107             buf[nbytes++] = c & 0xff;
108         }
109         *ret_len = nbytes;
110     }
111     else if( control == IOBUFCTRL_FLUSH ) {
112         for(p=buf; nbytes < size; nbytes++, p++ ) {
113             if( putc(*p, fp) == EOF ) {
114                 log_error("%s: write error: %s\n",
115                                     a->fname, strerror(errno));
116                 rc = G10ERR_WRITE_FILE;
117                 break;
118             }
119         }
120         *ret_len = nbytes;
121     }
122     else if( control == IOBUFCTRL_INIT ) {
123     }
124     else if( control == IOBUFCTRL_DESC ) {
125         *(char**)buf = "file_filter";
126     }
127     else if( control == IOBUFCTRL_FREE ) {
128         if( fp != stdin && fp != stdout )
129             fclose(fp);
130         fp = NULL;
131         m_free(a); /* we can free our context now */
132     }
133
134     return rc;
135 }
136
137
138 /****************
139  * This is used to implement the block write mode.
140  * Block reading is done on a byte by byte basis in readbyte(),
141  * without a filter
142  */
143 static int
144 block_filter(void *opaque, int control, IOBUF chain, byte *buf, size_t *ret_len)
145 {
146     block_filter_ctx_t *a = opaque;
147     size_t size = *ret_len;
148     int c, rc = 0;
149     char *p;
150
151     if( control == IOBUFCTRL_UNDERFLOW ) {
152         size_t n=0;
153
154         p = buf;
155         assert( size ); /* need a buffer */
156         if( a->eof ) /* don't read any further */
157             rc = -1;
158         while( !rc && size ) {
159             if( !a->size ) { /* get the length bytes */
160                 if( a->partial == 2 ) {
161                     a->eof = 1;
162                     if( !n )
163                         rc = -1;
164                     break;
165                 }
166                 else if( a->partial ) {
167                     /* These OpenPGP introduced huffman encoded length
168                      * bytes are really a mess :-( */
169                     if( a->first_c ) {
170                         c = a->first_c;
171                         a->first_c = 0;
172                         assert( c >= 224 && c < 255 );
173                     }
174                     else if( (c = iobuf_get(chain)) == -1 ) {
175                         log_error("block_filter: 1st length byte missing\n");
176                         rc = G10ERR_READ_FILE;
177                         break;
178                     }
179                     if( c < 192 ) {
180                         a->size = c;
181                         a->partial = 2;
182                         if( !a->size ) {
183                             a->eof = 1;
184                             if( !n )
185                                 rc = -1;
186                             break;
187                         }
188                     }
189                     else if( c < 224 ) {
190                         a->size = (c - 192) * 256;
191                         if( (c = iobuf_get(chain)) == -1 ) {
192                             log_error("block_filter: 2nd length byte missing\n");
193                             rc = G10ERR_READ_FILE;
194                             break;
195                         }
196                         a->size += c + 192;
197                         a->partial = 2;
198                         if( !a->size ) {
199                             a->eof = 1;
200                             if( !n )
201                                 rc = -1;
202                             break;
203                         }
204                     }
205                     else if( c == 255 ) {
206                         a->size  = iobuf_get(chain) << 24;
207                         a->size |= iobuf_get(chain) << 16;
208                         a->size |= iobuf_get(chain) << 8;
209                         if( (c = iobuf_get(chain)) == -1 ) {
210                             log_error("block_filter: invalid 4 byte length\n");
211                             rc = G10ERR_READ_FILE;
212                             break;
213                         }
214                         a->size |= c;
215                     }
216                     else { /* next partial body length */
217                         a->size = 1 << (c & 0x1f);
218                     }
219                 }
220                 else { /* the gnupg partial length scheme - much better :-) */
221                     c = iobuf_get(chain);
222                     a->size = c << 8;
223                     c = iobuf_get(chain);
224                     a->size |= c;
225                     if( c == -1 ) {
226                         log_error("block_filter: error reading length info\n");
227                         rc = G10ERR_READ_FILE;
228                     }
229                     if( !a->size ) {
230                         a->eof = 1;
231                         if( !n )
232                             rc = -1;
233                         break;
234                     }
235                 }
236             }
237
238             for(; !rc && size && a->size; size--, a->size-- ) {
239                 if( (c=iobuf_get(chain)) == -1 ) {
240                     log_error("block_filter %p: read error (size=%lu,a->size=%lu)\n",
241                                 a,  (ulong)size, (ulong)a->size);
242                     rc = G10ERR_READ_FILE;
243                 }
244                 else {
245                     *p++ = c;
246                     n++;
247                 }
248             }
249         }
250         *ret_len = n;
251     }
252     else if( control == IOBUFCTRL_FLUSH ) {
253         if( a->partial ) { /* the complicated openpgp scheme */
254             size_t blen, n, nbytes = size + a->buflen;
255
256             assert( a->buflen <= OP_MIN_PARTIAL_CHUNK );
257             if( nbytes < OP_MIN_PARTIAL_CHUNK ) {
258                 /* not enough to write a partial block out , so we store it*/
259                 if( !a->buffer )
260                     a->buffer = m_alloc( OP_MIN_PARTIAL_CHUNK );
261                 memcpy( a->buffer + a->buflen, buf, size );
262                 a->buflen += size;
263             }
264             else { /* okay, we can write out something */
265                 /* do this in a loop to use the most efficient block lengths */
266                 p = buf;
267                 do {
268                     /* find the best matching block length - this is limited
269                      * by the size of the internal buffering */
270                     for( blen=OP_MIN_PARTIAL_CHUNK*2,
271                             c=OP_MIN_PARTIAL_CHUNK_2POW+1; blen < nbytes;
272                                                             blen *=2, c++ )
273                         ;
274                     blen /= 2; c--;
275                     /* write the partial length header */
276                     assert( c <= 0x1f ); /*;-)*/
277                     c |= 0xe0;
278                     iobuf_put( chain, c );
279                     if( (n=a->buflen) ) { /* write stuff from the buffer */
280                         assert( n == OP_MIN_PARTIAL_CHUNK);
281                         if( iobuf_write(chain, a->buffer, n ) )
282                             rc = G10ERR_WRITE_FILE;
283                         a->buflen = 0;
284                         nbytes -= n;
285                     }
286                     if( (n = nbytes) > blen )
287                         n = blen;
288                     if( n && iobuf_write(chain, p, n ) )
289                         rc = G10ERR_WRITE_FILE;
290                     p += n;
291                     nbytes -= n;
292                 } while( !rc && nbytes >= OP_MIN_PARTIAL_CHUNK );
293                 /* store the rest in the buffer */
294                 if( !rc && nbytes ) {
295                     assert( !a->buflen );
296                     assert( nbytes < OP_MIN_PARTIAL_CHUNK );
297                     if( !a->buffer )
298                         a->buffer = m_alloc( OP_MIN_PARTIAL_CHUNK );
299                     memcpy( a->buffer, p, nbytes );
300                     a->buflen = nbytes;
301                 }
302             }
303         }
304         else { /* the gnupg scheme */
305             size_t avail, n;
306
307             for(p=buf; !rc && size; ) {
308                 n = size;
309                 avail = a->size - a->count;
310                 if( !avail ) {
311                     if( n > a->size ) {
312                         iobuf_put( chain, (a->size >> 8) & 0xff );
313                         iobuf_put( chain, a->size & 0xff );
314                         avail = a->size;
315                         a->count = 0;
316                     }
317                     else {
318                         iobuf_put( chain, (n >> 8) & 0xff );
319                         iobuf_put( chain, n & 0xff );
320                         avail = n;
321                         a->count = a->size - n;
322                     }
323                 }
324                 if( n > avail )
325                     n = avail;
326                 if( iobuf_write(chain, p, n ) )
327                     rc = G10ERR_WRITE_FILE;
328                 a->count += n;
329                 p += n;
330                 size -= n;
331             }
332         }
333     }
334     else if( control == IOBUFCTRL_INIT ) {
335         if( DBG_IOBUF )
336             log_debug("init block_filter %p\n", a );
337         if( a->partial )
338             a->count = 0;
339         else if( a->usage == 1 )
340             a->count = a->size = 0;
341         else
342             a->count = a->size; /* force first length bytes */
343         a->eof = 0;
344         a->buffer = NULL;
345         a->buflen = 0;
346     }
347     else if( control == IOBUFCTRL_DESC ) {
348         *(char**)buf = "block_filter";
349     }
350     else if( control == IOBUFCTRL_FREE ) {
351         if( a->usage == 2 ) { /* write the end markers */
352             if( a->partial ) {
353                 u32 len;
354                 /* write out the remaining bytes without a partial header
355                  * the length of this header may be 0 - but if it is
356                  * the first block we are not allowed to use a partial header
357                  * and frankly we can't do so, because this length must be
358                  * a power of 2. This is _really_ complicated because we
359                  * have to check the possible length of a packet prior
360                  * to it's creation: a chein of filters becomes complicated
361                  * and we need a lot of code to handle compressed packets etc.
362                  *   :-(((((((
363                  */
364                 /* construct header */
365                 len = a->buflen;
366                 if( len < 192 )
367                     rc = iobuf_put(chain, len );
368                 else if( len < 8384 ) {
369                     if( !(rc=iobuf_put( chain, ((len-192) / 256) + 192)) )
370                         rc = iobuf_put( chain, ((len-192) % 256));
371                 }
372                 else { /* use a 4 byte header */
373                     if( !(rc=iobuf_put( chain, 0xff )) )
374                         if( !(rc=iobuf_put( chain, (len >> 24)&0xff )) )
375                             if( !(rc=iobuf_put( chain, (len >> 16)&0xff )) )
376                                 if( !(rc=iobuf_put( chain, (len >> 8)&0xff )))
377                                     rc=iobuf_put( chain, len & 0xff );
378                 }
379                 if( !rc && len )
380                     rc = iobuf_write(chain, a->buffer, len );
381                 if( rc ) {
382                     log_error("block_filter: write error: %s\n",strerror(errno));
383                     rc = G10ERR_WRITE_FILE;
384                 }
385                 m_free( a->buffer ); a->buffer = NULL; a->buflen = 0;
386             }
387             else {
388                 iobuf_writebyte(chain, 0);
389                 iobuf_writebyte(chain, 0);
390             }
391         }
392         else if( a->size ) {
393             log_error("block_filter: pending bytes!\n");
394         }
395         if( DBG_IOBUF )
396             log_debug("free block_filter %p\n", a );
397         m_free(a); /* we can free our context now */
398     }
399
400     return rc;
401 }
402
403
404
405 /****************
406  * Allocate a new io buffer, with no function assigned.
407  * Usage is the desired usage: 1 for input, 2 for output, 3 for temp buffer
408  * BUFSIZE is a suggested buffer size.
409  */
410 IOBUF
411 iobuf_alloc(int usage, size_t bufsize)
412 {
413     IOBUF a;
414     static int number=0;
415
416     a = m_alloc_clear(sizeof *a);
417     a->usage = usage;
418     a->d.buf = m_alloc( bufsize );
419     a->d.size = bufsize;
420     a->no = ++number;
421     a->subno = 0;
422     a->opaque = NULL;
423     return a;
424 }
425
426
427 int
428 iobuf_close( IOBUF a )
429 {
430     IOBUF a2;
431     size_t dummy_len;
432     int rc=0;
433
434     for( ; a && !rc ; a = a2 ) {
435         a2 = a->chain;
436         if( a->usage == 2 && (rc=iobuf_flush(a)) )
437             log_error("iobuf_flush failed on close: %s\n", g10_errstr(rc));
438
439         if( DBG_IOBUF )
440             log_debug("iobuf-%d.%d: close '%s'\n", a->no, a->subno, a->desc );
441         if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE,
442                                          a->chain, NULL, &dummy_len)) )
443             log_error("IOBUFCTRL_FREE failed on close: %s\n", g10_errstr(rc) );
444         m_free(a->d.buf);
445         m_free(a);
446     }
447     return rc;
448 }
449
450 int
451 iobuf_cancel( IOBUF a )
452 {
453     const char *s;
454
455     if( a && a->usage == 2 ) {
456         s = get_real_fname(a);
457         if( s && *s )
458             remove(s);  /* remove the file. Fixme: this will fail for MSDOZE*/
459     }                   /* because the file is still open */
460     return iobuf_close(a);
461 }
462
463
464 /****************
465  * create a temporary iobuf, which can be used to collect stuff
466  * in an iobuf and later be written by iobuf_write_temp() to another
467  * iobuf.
468  */
469 IOBUF
470 iobuf_temp()
471 {
472     IOBUF a;
473
474     a = iobuf_alloc(3, 8192 );
475
476     return a;
477 }
478
479
480 /****************
481  * Create a head iobuf for reading from a file
482  * returns: NULL if an error occures and sets errno
483  */
484 IOBUF
485 iobuf_open( const char *fname )
486 {
487     IOBUF a;
488     FILE *fp;
489     file_filter_ctx_t *fcx;
490     size_t len;
491     int print_only = 0;
492
493     if( !fname || (*fname=='-' && !fname[1])  ) {
494         fp = stdin; /* fixme: set binary mode for msdoze */
495         fname = "[stdin]";
496         print_only = 1;
497     }
498     else if( !(fp = fopen(fname, "rb")) )
499         return NULL;
500     a = iobuf_alloc(1, 8192 );
501     fcx = m_alloc( sizeof *fcx + strlen(fname) );
502     fcx->fp = fp;
503     fcx->print_only_name = print_only;
504     strcpy(fcx->fname, fname );
505     a->filter = file_filter;
506     a->filter_ov = fcx;
507     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
508     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
509     if( DBG_IOBUF )
510         log_debug("iobuf-%d.%d: open '%s'\n", a->no, a->subno, fname );
511
512     return a;
513 }
514
515 /****************
516  * create an iobuf for writing to a file; the file will be created.
517  */
518 IOBUF
519 iobuf_create( const char *fname )
520 {
521     IOBUF a;
522     FILE *fp;
523     file_filter_ctx_t *fcx;
524     size_t len;
525     int print_only = 0;
526
527     if( !fname || (*fname=='-' && !fname[1]) ) {
528         fp = stdout;
529         fname = "[stdout]";
530         print_only = 1;
531     }
532     else if( !(fp = fopen(fname, "wb")) )
533         return NULL;
534     a = iobuf_alloc(2, 8192 );
535     fcx = m_alloc( sizeof *fcx + strlen(fname) );
536     fcx->fp = fp;
537     fcx->print_only_name = print_only;
538     strcpy(fcx->fname, fname );
539     a->filter = file_filter;
540     a->filter_ov = fcx;
541     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
542     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
543     if( DBG_IOBUF )
544         log_debug("iobuf-%d.%d: create '%s'\n", a->no, a->subno, a->desc );
545
546     return a;
547 }
548
549 /****************
550  * append to an iobuf; if the file does not exist, create it.
551  * cannot be used for stdout.
552  */
553 IOBUF
554 iobuf_append( const char *fname )
555 {
556     IOBUF a;
557     FILE *fp;
558     file_filter_ctx_t *fcx;
559     size_t len;
560
561     if( !fname )
562         return NULL;
563     else if( !(fp = fopen(fname, "ab")) )
564         return NULL;
565     a = iobuf_alloc(2, 8192 );
566     fcx = m_alloc( sizeof *fcx + strlen(fname) );
567     fcx->fp = fp;
568     strcpy(fcx->fname, fname );
569     a->filter = file_filter;
570     a->filter_ov = fcx;
571     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
572     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
573     if( DBG_IOBUF )
574         log_debug("iobuf-%d.%d: append '%s'\n", a->no, a->subno, a->desc );
575
576     return a;
577 }
578
579 IOBUF
580 iobuf_openrw( const char *fname )
581 {
582     IOBUF a;
583     FILE *fp;
584     file_filter_ctx_t *fcx;
585     size_t len;
586
587     if( !fname )
588         return NULL;
589     else if( !(fp = fopen(fname, "r+b")) )
590         return NULL;
591     a = iobuf_alloc(2, 8192 );
592     fcx = m_alloc( sizeof *fcx + strlen(fname) );
593     fcx->fp = fp;
594     strcpy(fcx->fname, fname );
595     a->filter = file_filter;
596     a->filter_ov = fcx;
597     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
598     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
599     if( DBG_IOBUF )
600         log_debug("iobuf-%d.%d: openrw '%s'\n", a->no, a->subno, a->desc );
601
602     return a;
603 }
604
605 /****************
606  * Register an i/o filter.
607  */
608 int
609 iobuf_push_filter( IOBUF a,
610                    int (*f)(void *opaque, int control,
611                    IOBUF chain, byte *buf, size_t *len), void *ov )
612 {
613     IOBUF b;
614     size_t dummy_len=0;
615     int rc=0;
616
617     if( a->usage == 2 && (rc=iobuf_flush(a)) )
618         return rc;
619     /* make a copy of the current stream, so that
620      * A is the new stream and B the original one.
621      * The contents of the buffers are transferred to the
622      * new stream.
623      */
624     b = m_alloc(sizeof *b);
625     memcpy(b, a, sizeof *b );
626     /* remove the filter stuff from the new stream */
627     a->filter = NULL;
628     a->filter_ov = NULL;
629     a->filter_eof = 0;
630     if( a->usage == 2 ) { /* allocate a fresh buffer for the original stream */
631         b->d.buf = m_alloc( a->d.size );
632         b->d.len = 0;
633         b->d.start = 0;
634     }
635     else { /* allocate a fresh buffer for the new stream */
636         a->d.buf = m_alloc( a->d.size );
637         a->d.len = 0;
638         a->d.start = 0;
639     }
640     /* disable nlimit for the new stream */
641     a->ntotal = b->ntotal + b->nbytes;
642     a->nlimit = a->nbytes = 0;
643     /* make a link from the new stream to the original stream */
644     a->chain = b;
645     a->opaque = b->opaque;
646
647     /* setup the function on the new stream */
648     a->filter = f;
649     a->filter_ov = ov;
650
651     a->subno = b->subno + 1;
652     f( ov, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &dummy_len );
653
654     if( DBG_IOBUF ) {
655         log_debug("iobuf-%d.%d: push '%s'\n", a->no, a->subno, a->desc );
656         for(b=a; b; b = b->chain )
657             log_debug("\tchain: %d.%d '%s'\n", b->no, b->subno, b->desc );
658     }
659
660     /* now we can initialize the new function if we have one */
661     if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_INIT, a->chain,
662                        NULL, &dummy_len)) )
663         log_error("IOBUFCTRL_INIT failed: %s\n", g10_errstr(rc) );
664     return rc;
665 }
666
667 /****************
668  * Remove an i/o filter.
669  */
670 int
671 iobuf_pop_filter( IOBUF a, int (*f)(void *opaque, int control,
672                       IOBUF chain, byte *buf, size_t *len), void *ov )
673 {
674     IOBUF b;
675     size_t dummy_len=0;
676     int rc=0;
677
678     if( DBG_IOBUF )
679         log_debug("iobuf-%d.%d: pop '%s'\n", a->no, a->subno, a->desc );
680     if( !a->filter ) { /* this is simple */
681         b = a->chain;
682         assert(b);
683         m_free(a->d.buf);
684         memcpy(a,b, sizeof *a);
685         m_free(b);
686         return 0;
687     }
688     for(b=a ; b; b = b->chain )
689         if( b->filter == f && (!ov || b->filter_ov == ov) )
690             break;
691     if( !b )
692         log_bug("iobuf_pop_filter(): filter function not found\n");
693
694     /* flush this stream if it is an output stream */
695     if( a->usage == 2 && (rc=iobuf_flush(b)) ) {
696         log_error("iobuf_flush failed in pop_filter: %s\n", g10_errstr(rc));
697         return rc;
698     }
699     /* and tell the filter to free it self */
700     if( (rc = b->filter(b->filter_ov, IOBUFCTRL_FREE, b->chain,
701                        NULL, &dummy_len)) ) {
702         log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
703         return rc;
704     }
705
706     /* and see how to remove it */
707     if( a == b && !b->chain )
708         log_bug("can't remove the last filter from the chain\n");
709     else if( a == b ) { /* remove the first iobuf from the chain */
710         /* everything from b is copied to a. This is save because
711          * a flush has been done on the to be removed entry
712          */
713         b = a->chain;
714         m_free(a->d.buf);
715         memcpy(a,b, sizeof *a);
716         m_free(b);
717         if( DBG_IOBUF )
718            log_debug("iobuf-%d.%d: popped filter\n", a->no, a->subno );
719     }
720     else if( !b->chain ) { /* remove the last iobuf from the chain */
721         log_bug("Ohh jeee, trying to remove a head filter\n");
722     }
723     else {  /* remove an intermediate iobuf from the chain */
724         log_bug("Ohh jeee, trying to remove an intermediate filter\n");
725     }
726
727     return rc;
728 }
729
730
731
732 /****************
733  * read underflow: read more bytes into the buffer and return
734  * the first byte or -1 on EOF.
735  */
736 static int
737 underflow(IOBUF a)
738 {
739     size_t len;
740     int rc;
741
742   /*log_debug("iobuf-%d.%d: underflow: start=%lu len=%lu\n",
743                 a->no, a->subno, (ulong)a->d.start, (ulong)a->d.len );*/
744     assert( a->d.start == a->d.len );
745     if( a->usage == 3 )
746         return -1; /* EOF because a temp buffer can't do an underflow */
747     if( a->filter_eof ) {
748         if( DBG_IOBUF )
749             log_debug("iobuf-%d.%d: filter eof\n", a->no, a->subno );
750         return -1;
751     }
752     if( a->error ) {
753         if( DBG_IOBUF )
754             log_debug("iobuf-%d.%d: error\n", a->no, a->subno );
755         return -1;
756     }
757
758     if( a->filter ) {
759         len = a->d.size;
760         rc = a->filter( a->filter_ov, IOBUFCTRL_UNDERFLOW, a->chain,
761                         a->d.buf, &len );
762         if( a->usage == 1 && rc == -1 ) { /* EOF: we can remove the filter */
763             size_t dummy_len;
764
765             /* and tell the filter to free it self */
766             if( a->filter != file_filter ) {
767                 if( (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE, a->chain,
768                                    NULL, &dummy_len)) )
769                     log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
770                 a->filter = NULL;
771                 a->desc = NULL;
772                 a->filter_ov = NULL;
773             }
774             a->filter_eof = 1;
775         }
776         else if( rc )
777             a->error = 1;
778
779         if( !len )
780             return -1;
781         a->d.len = len;
782         a->d.start = 0;
783         return a->d.buf[a->d.start++];
784     }
785     else
786         return -1;  /* no filter; return EOF */
787 }
788
789
790 void
791 iobuf_clear_eof(IOBUF a)
792 {
793     assert(a->usage == 1);
794
795     if( a->filter )
796         log_info("iobuf-%d.%d: clear_eof '%s' with enabled filter\n", a->no, a->subno, a->desc );
797     if( !a->filter_eof )
798         log_info("iobuf-%d.%d: clear_eof '%s' with no EOF pending\n", a->no, a->subno, a->desc );
799     iobuf_pop_filter(a, NULL, NULL);
800 }
801
802
803 int
804 iobuf_flush(IOBUF a)
805 {
806     size_t len;
807     int rc;
808
809     /*log_debug("iobuf-%d.%d: flush\n", a->no, a->subno );*/
810     if( a->usage == 3 )
811         log_bug("temp buffer too short\n");
812     else if( a->usage != 2 )
813         log_bug("flush on non-output iobuf\n");
814     else if( !a->filter )
815         log_bug("iobuf_flush: no filter\n");
816     len = a->d.len;
817     rc = a->filter( a->filter_ov, IOBUFCTRL_FLUSH, a->chain, a->d.buf, &len );
818     if( !rc && len != a->d.len ) {
819         log_info("iobuf_flush did not write all!\n");
820         rc = G10ERR_WRITE_FILE;
821     }
822     else if( rc )
823         a->error = 1;
824     a->d.len = 0;
825
826     return rc;
827 }
828
829
830 /****************
831  * Read a byte from the iobuf; returns -1 on EOF
832  */
833 int
834 iobuf_readbyte(IOBUF a)
835 {
836     int c;
837
838     /* nlimit does not work together with unget */
839     /* nbytes is also not valid! */
840     if( a->unget.buf ) {
841         if( a->unget.start < a->unget.len )
842             return a->unget.buf[a->unget.start++];
843         m_free(a->unget.buf);
844         a->unget.buf = NULL;
845     }
846
847     if( a->nlimit && a->nbytes >= a->nlimit )
848         return -1; /* forced EOF */
849
850     if( a->d.start < a->d.len ) {
851         c = a->d.buf[a->d.start++];
852     }
853     else if( (c=underflow(a)) == -1 )
854         return -1; /* EOF */
855
856     a->nbytes++;
857     return c;
858 }
859
860
861 int
862 iobuf_read(IOBUF a, byte *buf, unsigned buflen )
863 {
864     int c, n;
865
866     if( a->unget.buf || a->nlimit ) {
867         /* handle special cases */
868         for(n=0 ; n < buflen; n++, buf++ ) {
869             if( (c = iobuf_readbyte(a)) == -1 ) {
870                 if( !n )
871                     return -1; /* eof */
872                 break;
873             }
874             else
875                 *buf = c;
876         }
877         return n;
878     }
879
880     n = 0;
881     do {
882         for( ; n < buflen && a->d.start < a->d.len; n++ )
883             *buf++ = a->d.buf[a->d.start++];
884         if( n < buflen ) {
885             if( (c=underflow(a)) == -1 ) {
886                 a->nbytes += n;
887                 return n? n : -1/*EOF*/;
888             }
889             *buf++ = c; n++;
890         }
891     } while( n < buflen );
892     a->nbytes += n;
893     return n;
894 }
895
896
897 /****************
898  * Have a look at the iobuf.
899  * NOTE: This only works in special cases.
900  */
901 int
902 iobuf_peek(IOBUF a, byte *buf, unsigned buflen )
903 {
904     int n=0;
905
906     if( a->filter_eof )
907         return -1;
908     if( !(a->d.start < a->d.len) ) {
909         if( underflow(a) == -1 )
910             return -1;
911         /* and unget this character */
912         assert(a->d.start == 1);
913         a->d.start = 0;
914     }
915
916     for(n=0 ; n < buflen && (a->d.start+n) < a->d.len ; n++, buf++ )
917         *buf = a->d.buf[n];
918     return n;
919 }
920
921
922
923
924 int
925 iobuf_writebyte(IOBUF a, unsigned c)
926 {
927     if( a->d.len == a->d.size )
928         if( iobuf_flush(a) )
929             return -1;
930
931     assert( a->d.len < a->d.size );
932     a->d.buf[a->d.len++] = c;
933     return 0;
934 }
935
936
937 int
938 iobuf_write(IOBUF a, byte *buf, unsigned buflen )
939 {
940     do {
941         for( ; buflen && a->d.len < a->d.size; buflen--, buf++ )
942             a->d.buf[a->d.len++] = *buf;
943         if( buflen ) {
944             if( iobuf_flush(a) )
945                 return -1;
946         }
947     } while( buflen );
948     return 0;
949 }
950
951
952 int
953 iobuf_writestr(IOBUF a, const char *buf )
954 {
955     for( ; *buf; buf++ )
956         if( iobuf_writebyte(a, *buf) )
957             return -1;
958     return 0;
959 }
960
961
962
963 /****************
964  * copy the contents of TEMP to A.
965  */
966 int
967 iobuf_write_temp( IOBUF a, IOBUF temp )
968 {
969     return iobuf_write(a, temp->d.buf, temp->d.len );
970 }
971
972 /****************
973  * copy the contents of the temp io stream to BUFFER.
974  */
975 size_t
976 iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen )
977 {
978     size_t n = a->d.len;
979
980     if( n > buflen )
981         n = buflen;
982     memcpy( buffer, a->d.buf, n );
983     return n;
984 }
985
986 /****************
987  * unget the contents of the temp io stream to A and close temp
988  * Could be optimized!!
989  */
990 void
991 iobuf_unget_and_close_temp( IOBUF a, IOBUF temp )
992 {
993     if( a->unget.buf ) {
994         if( a->unget.start < a->unget.len )
995             log_fatal("cannot do any more ungets on this buffer\n");
996         /* not yet cleaned up; do it now */
997         m_free(a->unget.buf);
998         a->unget.buf = NULL;
999     }
1000     a->unget.size = temp->d.len;
1001     a->unget.buf = m_alloc( a->unget.size );
1002     a->unget.len = temp->d.len;
1003     memcpy( a->unget.buf, temp->d.buf, a->unget.len );
1004     iobuf_close(temp);
1005 }
1006
1007
1008 /****************
1009  * Set a limit on how many bytes may be read from the input stream A.
1010  * Setting the limit to 0 disables this feature.
1011  */
1012 void
1013 iobuf_set_limit( IOBUF a, unsigned long nlimit )
1014 {
1015     a->nlimit = nlimit;
1016     a->ntotal += a->nbytes;
1017     a->nbytes = 0;
1018 }
1019
1020
1021
1022 /****************
1023  * Return the length of an open file
1024  */
1025 u32
1026 iobuf_get_filelength( IOBUF a )
1027 {
1028     struct stat st;
1029
1030     for( ; a; a = a->chain )
1031         if( !a->chain && a->filter == file_filter ) {
1032             file_filter_ctx_t *b = a->filter_ov;
1033             FILE *fp = b->fp;
1034
1035             if( !fstat(fileno(fp), &st) )
1036                 return st.st_size;
1037             log_error("fstat() failed: %s\n", strerror(errno) );
1038             break;
1039         }
1040
1041     return 0;
1042 }
1043
1044 /****************
1045  * Tell the file position, where the next read will take place
1046  */
1047 ulong
1048 iobuf_tell( IOBUF a )
1049 {
1050     return a->ntotal + a->nbytes;
1051 }
1052
1053
1054
1055 /****************
1056  * This is a very limited implementation. It simply discards all internal
1057  * buffering and removes all filters but the first one.
1058  */
1059 int
1060 iobuf_seek( IOBUF a, ulong newpos )
1061 {
1062     file_filter_ctx_t *b = NULL;
1063
1064     for( ; a; a = a->chain ) {
1065         if( !a->chain && a->filter == file_filter ) {
1066             b = a->filter_ov;
1067             break;
1068         }
1069     }
1070     if( !a )
1071         return -1;
1072
1073     if( fseek( b->fp, newpos, SEEK_SET ) ) {
1074         log_error("can't seek to %lu: %s\n", newpos, strerror(errno) );
1075         return -1;
1076     }
1077     a->d.len = 0;   /* discard buffer */
1078     a->d.start = 0;
1079     a->nbytes = 0;
1080     a->nlimit = 0;
1081     a->ntotal = newpos;
1082     a->error = 0;
1083     /* remove filters, but the last */
1084     while( a->chain )
1085         iobuf_pop_filter( a, a->filter, NULL );
1086
1087
1088     return 0;
1089 }
1090
1091
1092
1093
1094
1095
1096 /****************
1097  * Retrieve the real filename
1098  */
1099 static const char *
1100 get_real_fname( IOBUF a )
1101 {
1102     for( ; a; a = a->chain )
1103         if( !a->chain && a->filter == file_filter ) {
1104             file_filter_ctx_t *b = a->filter_ov;
1105             return b->print_only_name? NULL : b->fname;
1106         }
1107
1108     return NULL;
1109 }
1110
1111 /****************
1112  * Retrieve the filename
1113  */
1114 const char *
1115 iobuf_get_fname( IOBUF a )
1116 {
1117     for( ; a; a = a->chain )
1118         if( !a->chain && a->filter == file_filter ) {
1119             file_filter_ctx_t *b = a->filter_ov;
1120             return b->fname;
1121         }
1122
1123     return NULL;
1124 }
1125
1126 /****************
1127  * Start the block write mode, see rfc1991.new for details.
1128  * A value of 0 for N stops this mode (flushes and writes
1129  * the end marker)
1130  */
1131 void
1132 iobuf_set_block_mode( IOBUF a, size_t n )
1133 {
1134     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1135
1136     assert( a->usage == 1 || a->usage == 2 );
1137     ctx->usage = a->usage;
1138     if( !n ) {
1139         iobuf_pop_filter(a, block_filter, NULL );
1140     }
1141     else {
1142         ctx->size = n; /* only needed for usage 2 */
1143         iobuf_push_filter(a, block_filter, ctx );
1144     }
1145 }
1146
1147 /****************
1148  * enable partial block mode as described in the OpenPGP draft.
1149  * LEN is the first length byte on read, but ignored on writes.
1150  */
1151 void
1152 iobuf_set_partial_block_mode( IOBUF a, size_t len )
1153 {
1154     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1155
1156     assert( a->usage == 1 || a->usage == 2 );
1157     ctx->usage = a->usage;
1158     if( !len ) {
1159         iobuf_pop_filter(a, block_filter, NULL );
1160     }
1161     else {
1162         ctx->partial = 1;
1163         ctx->size = 0;
1164         ctx->first_c = len;
1165         iobuf_push_filter(a, block_filter, ctx );
1166     }
1167 }
1168
1169
1170 /****************
1171  * Checks whether the stream is in block mode
1172  * Note: This does not work if other filters are pushed on the stream.
1173  */
1174 int
1175 iobuf_in_block_mode( IOBUF a )
1176 {
1177     if( a && a->filter == block_filter )
1178         return 1; /* yes */
1179     return 0; /* no */
1180 }
1181
1182
1183