755da1d821cfb2e4da02c851e9e1b3f28ddf8f5e
[gnupg.git] / util / iobuf.c
1 /* iobuf.c  -  file handling
2  *      Copyright (C) 1998,1999 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     if( a && a->directfp ) {
435         fclose( a->directfp );
436         if( DBG_IOBUF )
437             log_debug("iobuf_close -> %p\n", a->directfp );
438         return 0;
439     }
440
441     for( ; a && !rc ; a = a2 ) {
442         a2 = a->chain;
443         if( a->usage == 2 && (rc=iobuf_flush(a)) )
444             log_error("iobuf_flush failed on close: %s\n", g10_errstr(rc));
445
446         if( DBG_IOBUF )
447             log_debug("iobuf-%d.%d: close `%s'\n", a->no, a->subno, a->desc );
448         if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE,
449                                          a->chain, NULL, &dummy_len)) )
450             log_error("IOBUFCTRL_FREE failed on close: %s\n", g10_errstr(rc) );
451         m_free(a->d.buf);
452         m_free(a);
453     }
454     return rc;
455 }
456
457 int
458 iobuf_cancel( IOBUF a )
459 {
460     const char *s;
461
462     if( a && a->usage == 2 ) {
463         s = get_real_fname(a);
464         if( s && *s )
465             remove(s);  /* remove the file. Fixme: this will fail for MSDOZE*/
466     }                   /* because the file is still open */
467     return iobuf_close(a);
468 }
469
470
471 /****************
472  * create a temporary iobuf, which can be used to collect stuff
473  * in an iobuf and later be written by iobuf_write_temp() to another
474  * iobuf.
475  */
476 IOBUF
477 iobuf_temp()
478 {
479     IOBUF a;
480
481     a = iobuf_alloc(3, 8192 );
482
483     return a;
484 }
485
486 IOBUF
487 iobuf_temp_with_content( const char *buffer, size_t length )
488 {
489     IOBUF a;
490
491     a = iobuf_alloc(3, length );
492     memcpy( a->d.buf, buffer, length );
493     a->d.len = length;
494
495     return a;
496 }
497
498
499 /****************
500  * Create a head iobuf for reading from a file
501  * returns: NULL if an error occures and sets errno
502  */
503 IOBUF
504 iobuf_open( const char *fname )
505 {
506     IOBUF a;
507     FILE *fp;
508     file_filter_ctx_t *fcx;
509     size_t len;
510     int print_only = 0;
511
512     if( !fname || (*fname=='-' && !fname[1])  ) {
513         fp = stdin; /* fixme: set binary mode for msdoze */
514         fname = "[stdin]";
515         print_only = 1;
516     }
517     else if( !(fp = fopen(fname, "rb")) )
518         return NULL;
519     a = iobuf_alloc(1, 8192 );
520     fcx = m_alloc( sizeof *fcx + strlen(fname) );
521     fcx->fp = fp;
522     fcx->print_only_name = print_only;
523     strcpy(fcx->fname, fname );
524     a->filter = file_filter;
525     a->filter_ov = fcx;
526     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
527     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
528     if( DBG_IOBUF )
529         log_debug("iobuf-%d.%d: open `%s'\n", a->no, a->subno, fname );
530
531     return a;
532 }
533
534 /****************
535  * create an iobuf for writing to a file; the file will be created.
536  */
537 IOBUF
538 iobuf_create( const char *fname )
539 {
540     IOBUF a;
541     FILE *fp;
542     file_filter_ctx_t *fcx;
543     size_t len;
544     int print_only = 0;
545
546     if( !fname || (*fname=='-' && !fname[1]) ) {
547         fp = stdout;
548         fname = "[stdout]";
549         print_only = 1;
550     }
551     else if( !(fp = fopen(fname, "wb")) )
552         return NULL;
553     a = iobuf_alloc(2, 8192 );
554     fcx = m_alloc( sizeof *fcx + strlen(fname) );
555     fcx->fp = fp;
556     fcx->print_only_name = print_only;
557     strcpy(fcx->fname, fname );
558     a->filter = file_filter;
559     a->filter_ov = fcx;
560     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
561     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
562     if( DBG_IOBUF )
563         log_debug("iobuf-%d.%d: create `%s'\n", a->no, a->subno, a->desc );
564
565     return a;
566 }
567
568 /****************
569  * append to an iobuf; if the file does not exist, create it.
570  * cannot be used for stdout.
571  */
572 IOBUF
573 iobuf_append( const char *fname )
574 {
575     IOBUF a;
576     FILE *fp;
577     file_filter_ctx_t *fcx;
578     size_t len;
579
580     if( !fname )
581         return NULL;
582     else if( !(fp = fopen(fname, "ab")) )
583         return NULL;
584     a = iobuf_alloc(2, 8192 );
585     fcx = m_alloc( sizeof *fcx + strlen(fname) );
586     fcx->fp = fp;
587     strcpy(fcx->fname, fname );
588     a->filter = file_filter;
589     a->filter_ov = fcx;
590     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
591     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
592     if( DBG_IOBUF )
593         log_debug("iobuf-%d.%d: append `%s'\n", a->no, a->subno, a->desc );
594
595     return a;
596 }
597
598 IOBUF
599 iobuf_openrw( const char *fname )
600 {
601     IOBUF a;
602     FILE *fp;
603     file_filter_ctx_t *fcx;
604     size_t len;
605
606     if( !fname )
607         return NULL;
608     else if( !(fp = fopen(fname, "r+b")) )
609         return NULL;
610     a = iobuf_alloc(2, 8192 );
611     fcx = m_alloc( sizeof *fcx + strlen(fname) );
612     fcx->fp = fp;
613     strcpy(fcx->fname, fname );
614     a->filter = file_filter;
615     a->filter_ov = fcx;
616     file_filter( fcx, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &len );
617     file_filter( fcx, IOBUFCTRL_INIT, NULL, NULL, &len );
618     if( DBG_IOBUF )
619         log_debug("iobuf-%d.%d: openrw `%s'\n", a->no, a->subno, a->desc );
620
621     return a;
622 }
623
624
625
626 /****************
627  * You can overwrite the normal iobuf behaviour by using this function.
628  * If used the iobuf is a simple wrapper around stdio.
629  * NULL if an error occures and sets errno
630  */
631 IOBUF
632 iobuf_fopen( const char *fname, const char *mode )
633 {
634     IOBUF a;
635     FILE *fp;
636     int print_only = 0;
637
638     if( !fname || (*fname=='-' && !fname[1])  ) {
639         fp = stdin; /* fixme: set binary mode for msdoze */
640         fname = "[stdin]";
641         print_only = 1;
642     }
643     else if( !(fp = fopen(fname, mode) ) )
644         return NULL;
645     a = iobuf_alloc(1, 8192 );
646     a->directfp = fp;
647
648     if( DBG_IOBUF )
649         log_debug("iobuf_fopen -> %p\n", a->directfp );
650
651     return a;
652 }
653
654
655
656
657 /****************
658  * Register an i/o filter.
659  */
660 int
661 iobuf_push_filter( IOBUF a,
662                    int (*f)(void *opaque, int control,
663                    IOBUF chain, byte *buf, size_t *len), void *ov )
664 {
665     IOBUF b;
666     size_t dummy_len=0;
667     int rc=0;
668
669     if( a->directfp )
670         BUG();
671
672     if( a->usage == 2 && (rc=iobuf_flush(a)) )
673         return rc;
674     /* make a copy of the current stream, so that
675      * A is the new stream and B the original one.
676      * The contents of the buffers are transferred to the
677      * new stream.
678      */
679     b = m_alloc(sizeof *b);
680     memcpy(b, a, sizeof *b );
681     /* remove the filter stuff from the new stream */
682     a->filter = NULL;
683     a->filter_ov = NULL;
684     a->filter_eof = 0;
685     if( a->usage == 2 ) { /* allocate a fresh buffer for the original stream */
686         b->d.buf = m_alloc( a->d.size );
687         b->d.len = 0;
688         b->d.start = 0;
689     }
690     else { /* allocate a fresh buffer for the new stream */
691         a->d.buf = m_alloc( a->d.size );
692         a->d.len = 0;
693         a->d.start = 0;
694     }
695     /* disable nlimit for the new stream */
696     a->ntotal = b->ntotal + b->nbytes;
697     a->nlimit = a->nbytes = 0;
698     a->nofast &= ~1;
699     /* make a link from the new stream to the original stream */
700     a->chain = b;
701     a->opaque = b->opaque;
702
703     /* setup the function on the new stream */
704     a->filter = f;
705     a->filter_ov = ov;
706
707     a->subno = b->subno + 1;
708     f( ov, IOBUFCTRL_DESC, NULL, (byte*)&a->desc, &dummy_len );
709
710     if( DBG_IOBUF ) {
711         log_debug("iobuf-%d.%d: push `%s'\n", a->no, a->subno, a->desc );
712         for(b=a; b; b = b->chain )
713             log_debug("\tchain: %d.%d `%s'\n", b->no, b->subno, b->desc );
714     }
715
716     /* now we can initialize the new function if we have one */
717     if( a->filter && (rc = a->filter(a->filter_ov, IOBUFCTRL_INIT, a->chain,
718                        NULL, &dummy_len)) )
719         log_error("IOBUFCTRL_INIT failed: %s\n", g10_errstr(rc) );
720     return rc;
721 }
722
723 /****************
724  * Remove an i/o filter.
725  * Only needed for iobuf_seek?
726  */
727 static int
728 pop_filter( IOBUF a, int (*f)(void *opaque, int control,
729                       IOBUF chain, byte *buf, size_t *len), void *ov )
730 {
731     IOBUF b;
732     size_t dummy_len=0;
733     int rc=0;
734
735     if( a->directfp )
736         BUG();
737
738     if( DBG_IOBUF )
739         log_debug("iobuf-%d.%d: pop `%s'\n", a->no, a->subno, a->desc );
740     if( !a->filter ) { /* this is simple */
741         b = a->chain;
742         assert(b);
743         m_free(a->d.buf);
744         memcpy(a,b, sizeof *a);
745         m_free(b);
746         return 0;
747     }
748     for(b=a ; b; b = b->chain )
749         if( b->filter == f && (!ov || b->filter_ov == ov) )
750             break;
751     if( !b )
752         log_bug("iobuf_pop_filter(): filter function not found\n");
753
754     /* flush this stream if it is an output stream */
755     if( a->usage == 2 && (rc=iobuf_flush(b)) ) {
756         log_error("iobuf_flush failed in pop_filter: %s\n", g10_errstr(rc));
757         return rc;
758     }
759     /* and tell the filter to free it self */
760     if( b->filter && (rc = b->filter(b->filter_ov, IOBUFCTRL_FREE, b->chain,
761                        NULL, &dummy_len)) ) {
762         log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
763         return rc;
764     }
765
766     /* and see how to remove it */
767     if( a == b && !b->chain )
768         log_bug("can't remove the last filter from the chain\n");
769     else if( a == b ) { /* remove the first iobuf from the chain */
770         /* everything from b is copied to a. This is save because
771          * a flush has been done on the to be removed entry
772          */
773         b = a->chain;
774         m_free(a->d.buf);
775         memcpy(a,b, sizeof *a);
776         m_free(b);
777         if( DBG_IOBUF )
778            log_debug("iobuf-%d.%d: popped filter\n", a->no, a->subno );
779     }
780     else if( !b->chain ) { /* remove the last iobuf from the chain */
781         log_bug("Ohh jeee, trying to remove a head filter\n");
782     }
783     else {  /* remove an intermediate iobuf from the chain */
784         log_bug("Ohh jeee, trying to remove an intermediate filter\n");
785     }
786
787     return rc;
788 }
789
790
791
792 /****************
793  * read underflow: read more bytes into the buffer and return
794  * the first byte or -1 on EOF.
795  */
796 static int
797 underflow(IOBUF a)
798 {
799     size_t len;
800     int rc;
801
802     assert( a->d.start == a->d.len );
803     if( a->usage == 3 )
804         return -1; /* EOF because a temp buffer can't do an underflow */
805
806     if( a->filter_eof ) {
807         if( a->chain ) {
808             IOBUF b = a->chain;
809             m_free(a->d.buf);
810             memcpy(a, b, sizeof *a);
811             m_free(b);
812             if( DBG_IOBUF )
813                 log_debug("iobuf-%d.%d: popped filter in underflow\n",
814                                                          a->no, a->subno );
815         }
816         else
817             a->filter_eof = 0;
818         if( DBG_IOBUF )
819             log_debug("iobuf-%d.%d: underflow: eof (due to filter eof)\n",
820                                                     a->no, a->subno );
821         return -1; /* return one(!) EOF */
822     }
823     if( a->error ) {
824         if( DBG_IOBUF )
825             log_debug("iobuf-%d.%d: error\n", a->no, a->subno );
826         return -1;
827     }
828
829     if( a->directfp ) {
830         FILE *fp = a->directfp;
831
832         len = fread( a->d.buf, 1, a->d.size, fp);
833         if( len < a->d.size ) {
834             if( ferror(fp) )
835                 a->error = 1;
836         }
837         a->d.len = len;
838         a->d.start = 0;
839         return len? a->d.buf[a->d.start++] : -1;
840     }
841
842
843     if( a->filter ) {
844         len = a->d.size;
845         rc = a->filter( a->filter_ov, IOBUFCTRL_UNDERFLOW, a->chain,
846                         a->d.buf, &len );
847         if( DBG_IOBUF )
848             log_debug("iobuf-%d.%d: underflow: req=%lu got=%lu rc=%d\n",
849                     a->no, a->subno, (ulong)a->d.size, (ulong)len, rc );
850         if( a->usage == 1 && rc == -1 ) { /* EOF: we can remove the filter */
851             size_t dummy_len;
852
853             /* and tell the filter to free itself */
854             if( (rc = a->filter(a->filter_ov, IOBUFCTRL_FREE, a->chain,
855                                NULL, &dummy_len)) )
856                 log_error("IOBUFCTRL_FREE failed: %s\n", g10_errstr(rc) );
857             a->filter = NULL;
858             a->desc = NULL;
859             a->filter_ov = NULL;
860             a->filter_eof = 1;
861             if( !len && a->chain ) {
862                 IOBUF b = a->chain;
863                 m_free(a->d.buf);
864                 memcpy(a,b, sizeof *a);
865                 m_free(b);
866                 if( DBG_IOBUF )
867                     log_debug("iobuf-%d.%d: popped filter in underflow (!len)\n",
868                                                              a->no, a->subno );
869             }
870         }
871         else if( rc )
872             a->error = 1;
873
874         if( !len ) {
875             if( DBG_IOBUF )
876                 log_debug("iobuf-%d.%d: underflow: eof\n", a->no, a->subno );
877             return -1;
878         }
879         a->d.len = len;
880         a->d.start = 0;
881         return a->d.buf[a->d.start++];
882     }
883     else {
884         if( DBG_IOBUF )
885             log_debug("iobuf-%d.%d: underflow: eof (no filter)\n",
886                                                     a->no, a->subno );
887         return -1;  /* no filter; return EOF */
888     }
889 }
890
891
892 int
893 iobuf_flush(IOBUF a)
894 {
895     size_t len;
896     int rc;
897
898     if( a->directfp )
899         return 0;
900
901     /*log_debug("iobuf-%d.%d: flush\n", a->no, a->subno );*/
902     if( a->usage == 3 ) { /* must increase the size of the temp buffer */
903         char *newbuf;
904         size_t newsize = a->d.size + 8192;
905
906         log_debug("increasing temp iobuf from %lu to %lu\n",
907                     (ulong)a->d.size, (ulong)newsize );
908         newbuf = m_alloc( newsize );
909         memcpy( newbuf, a->d.buf, a->d.len );
910         m_free(a->d.buf);
911         a->d.buf = newbuf;
912         a->d.size = newsize;
913         return 0;
914     }
915     else if( a->usage != 2 )
916         log_bug("flush on non-output iobuf\n");
917     else if( !a->filter )
918         log_bug("iobuf_flush: no filter\n");
919     len = a->d.len;
920     rc = a->filter( a->filter_ov, IOBUFCTRL_FLUSH, a->chain, a->d.buf, &len );
921     if( !rc && len != a->d.len ) {
922         log_info("iobuf_flush did not write all!\n");
923         rc = G10ERR_WRITE_FILE;
924     }
925     else if( rc )
926         a->error = 1;
927     a->d.len = 0;
928
929     return rc;
930 }
931
932
933 /****************
934  * Read a byte from the iobuf; returns -1 on EOF
935  */
936 int
937 iobuf_readbyte(IOBUF a)
938 {
939     int c;
940
941     /* nlimit does not work together with unget */
942     /* nbytes is also not valid! */
943     if( a->unget.buf ) {
944         if( a->unget.start < a->unget.len )
945             return a->unget.buf[a->unget.start++];
946         m_free(a->unget.buf);
947         a->unget.buf = NULL;
948         a->nofast &= ~2;
949     }
950
951     if( a->nlimit && a->nbytes >= a->nlimit )
952         return -1; /* forced EOF */
953
954     if( a->d.start < a->d.len ) {
955         c = a->d.buf[a->d.start++];
956     }
957     else if( (c=underflow(a)) == -1 )
958         return -1; /* EOF */
959
960     a->nbytes++;
961     return c;
962 }
963
964
965 int
966 iobuf_read(IOBUF a, byte *buf, unsigned buflen )
967 {
968     int c, n;
969
970     if( a->unget.buf || a->nlimit ) {
971         /* handle special cases */
972         for(n=0 ; n < buflen; n++, buf++ ) {
973             if( (c = iobuf_readbyte(a)) == -1 ) {
974                 if( !n )
975                     return -1; /* eof */
976                 break;
977             }
978             else
979                 *buf = c;
980         }
981         return n;
982     }
983
984     n = 0;
985     do {
986         for( ; n < buflen && a->d.start < a->d.len; n++ )
987             *buf++ = a->d.buf[a->d.start++];
988         if( n < buflen ) {
989             if( (c=underflow(a)) == -1 ) {
990                 a->nbytes += n;
991                 return n? n : -1/*EOF*/;
992             }
993             *buf++ = c; n++;
994         }
995     } while( n < buflen );
996     a->nbytes += n;
997     return n;
998 }
999
1000
1001 /****************
1002  * Have a look at the iobuf.
1003  * NOTE: This only works in special cases.
1004  */
1005 int
1006 iobuf_peek(IOBUF a, byte *buf, unsigned buflen )
1007 {
1008     int n=0;
1009
1010     if( a->filter_eof )
1011         return -1;
1012     if( !(a->d.start < a->d.len) ) {
1013         if( underflow(a) == -1 )
1014             return -1;
1015         /* and unget this character */
1016         assert(a->d.start == 1);
1017         a->d.start = 0;
1018     }
1019
1020     for(n=0 ; n < buflen && (a->d.start+n) < a->d.len ; n++, buf++ )
1021         *buf = a->d.buf[n];
1022     return n;
1023 }
1024
1025
1026
1027
1028 int
1029 iobuf_writebyte(IOBUF a, unsigned c)
1030 {
1031
1032     if( a->directfp )
1033         BUG();
1034
1035     if( a->d.len == a->d.size )
1036         if( iobuf_flush(a) )
1037             return -1;
1038
1039     assert( a->d.len < a->d.size );
1040     a->d.buf[a->d.len++] = c;
1041     return 0;
1042 }
1043
1044
1045 int
1046 iobuf_write(IOBUF a, byte *buf, unsigned buflen )
1047 {
1048
1049     if( a->directfp )
1050         BUG();
1051
1052     do {
1053         for( ; buflen && a->d.len < a->d.size; buflen--, buf++ )
1054             a->d.buf[a->d.len++] = *buf;
1055         if( buflen ) {
1056             if( iobuf_flush(a) )
1057                 return -1;
1058         }
1059     } while( buflen );
1060     return 0;
1061 }
1062
1063
1064 int
1065 iobuf_writestr(IOBUF a, const char *buf )
1066 {
1067     for( ; *buf; buf++ )
1068         if( iobuf_writebyte(a, *buf) )
1069             return -1;
1070     return 0;
1071 }
1072
1073
1074
1075 /****************
1076  * copy the contents of TEMP to A.
1077  */
1078 int
1079 iobuf_write_temp( IOBUF a, IOBUF temp )
1080 {
1081     return iobuf_write(a, temp->d.buf, temp->d.len );
1082 }
1083
1084 /****************
1085  * copy the contents of the temp io stream to BUFFER.
1086  */
1087 size_t
1088 iobuf_temp_to_buffer( IOBUF a, byte *buffer, size_t buflen )
1089 {
1090     size_t n = a->d.len;
1091
1092     if( n > buflen )
1093         n = buflen;
1094     memcpy( buffer, a->d.buf, n );
1095     return n;
1096 }
1097
1098 /****************
1099  * unget the contents of the temp io stream to A and close temp
1100  * Could be optimized!!
1101  */
1102 void
1103 iobuf_unget_and_close_temp( IOBUF a, IOBUF temp )
1104 {
1105     if( a->unget.buf ) {
1106         if( a->unget.start < a->unget.len )
1107             log_fatal("cannot do any more ungets on this buffer\n");
1108         /* not yet cleaned up; do it now */
1109         m_free(a->unget.buf);
1110         a->unget.buf = NULL;
1111         a->nofast &= ~2;
1112     }
1113     a->unget.size = temp->d.len;
1114     a->unget.buf = m_alloc( a->unget.size );
1115     a->nofast |= 2;
1116     a->unget.len = temp->d.len;
1117     a->unget.start = 0;
1118     memcpy( a->unget.buf, temp->d.buf, a->unget.len );
1119     iobuf_close(temp);
1120 }
1121
1122
1123 /****************
1124  * Set a limit on how many bytes may be read from the input stream A.
1125  * Setting the limit to 0 disables this feature.
1126  */
1127 void
1128 iobuf_set_limit( IOBUF a, unsigned long nlimit )
1129 {
1130     if( nlimit )
1131         a->nofast |= 1;
1132     else
1133         a->nofast &= ~1;
1134     a->nlimit = nlimit;
1135     a->ntotal += a->nbytes;
1136     a->nbytes = 0;
1137 }
1138
1139
1140
1141 /****************
1142  * Return the length of an open file
1143  */
1144 u32
1145 iobuf_get_filelength( IOBUF a )
1146 {
1147     struct stat st;
1148
1149     if( a->directfp )  {
1150         FILE *fp = a->directfp;
1151
1152         if( !fstat(fileno(fp), &st) )
1153             return st.st_size;
1154         log_error("fstat() failed: %s\n", strerror(errno) );
1155         return 0;
1156     }
1157
1158     for( ; a; a = a->chain )
1159         if( !a->chain && a->filter == file_filter ) {
1160             file_filter_ctx_t *b = a->filter_ov;
1161             FILE *fp = b->fp;
1162
1163             if( !fstat(fileno(fp), &st) )
1164                 return st.st_size;
1165             log_error("fstat() failed: %s\n", strerror(errno) );
1166             break;
1167         }
1168
1169     return 0;
1170 }
1171
1172 /****************
1173  * Tell the file position, where the next read will take place
1174  */
1175 ulong
1176 iobuf_tell( IOBUF a )
1177 {
1178     return a->ntotal + a->nbytes;
1179 }
1180
1181
1182
1183 /****************
1184  * This is a very limited implementation. It simply discards all internal
1185  * buffering and removes all filters but the first one.
1186  */
1187 int
1188 iobuf_seek( IOBUF a, ulong newpos )
1189 {
1190     file_filter_ctx_t *b = NULL;
1191
1192     if( a->directfp ) {
1193         FILE *fp = a->directfp;
1194         if( fseek( fp, newpos, SEEK_SET ) ) {
1195             log_error("can't seek to %lu: %s\n", newpos, strerror(errno) );
1196             return -1;
1197         }
1198         clearerr(fp);
1199     }
1200     else {
1201         for( ; a; a = a->chain ) {
1202             if( !a->chain && a->filter == file_filter ) {
1203                 b = a->filter_ov;
1204                 break;
1205             }
1206         }
1207         if( !a )
1208             return -1;
1209         if( fseek( b->fp, newpos, SEEK_SET ) ) {
1210             log_error("can't seek to %lu: %s\n", newpos, strerror(errno) );
1211             return -1;
1212         }
1213     }
1214     a->d.len = 0;   /* discard buffer */
1215     a->d.start = 0;
1216     a->nbytes = 0;
1217     a->nlimit = 0;
1218     a->nofast &= ~1;
1219     a->ntotal = newpos;
1220     a->error = 0;
1221     /* remove filters, but the last */
1222     if( a->chain )
1223         log_debug("pop_filter called in iobuf_seek - please report\n");
1224     while( a->chain )
1225         pop_filter( a, a->filter, NULL );
1226
1227     return 0;
1228 }
1229
1230
1231
1232
1233
1234
1235 /****************
1236  * Retrieve the real filename
1237  */
1238 static const char *
1239 get_real_fname( IOBUF a )
1240 {
1241     for( ; a; a = a->chain )
1242         if( !a->chain && a->filter == file_filter ) {
1243             file_filter_ctx_t *b = a->filter_ov;
1244             return b->print_only_name? NULL : b->fname;
1245         }
1246
1247     return NULL;
1248 }
1249
1250 /****************
1251  * Retrieve the filename
1252  */
1253 const char *
1254 iobuf_get_fname( IOBUF a )
1255 {
1256     for( ; a; a = a->chain )
1257         if( !a->chain && a->filter == file_filter ) {
1258             file_filter_ctx_t *b = a->filter_ov;
1259             return b->fname;
1260         }
1261
1262     return NULL;
1263 }
1264
1265 /****************
1266  * Start the block write mode, see rfc1991.new for details.
1267  * A value of 0 for N stops this mode (flushes and writes
1268  * the end marker)
1269  */
1270 void
1271 iobuf_set_block_mode( IOBUF a, size_t n )
1272 {
1273     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1274
1275     assert( a->usage == 1 || a->usage == 2 );
1276     ctx->usage = a->usage;
1277     if( !n ) {
1278         log_debug("pop_filter called in set_block_mode - please report\n");
1279         pop_filter(a, block_filter, NULL );
1280     }
1281     else {
1282         ctx->size = n; /* only needed for usage 2 */
1283         iobuf_push_filter(a, block_filter, ctx );
1284     }
1285 }
1286
1287 /****************
1288  * enable partial block mode as described in the OpenPGP draft.
1289  * LEN is the first length byte on read, but ignored on writes.
1290  */
1291 void
1292 iobuf_set_partial_block_mode( IOBUF a, size_t len )
1293 {
1294     block_filter_ctx_t *ctx = m_alloc_clear( sizeof *ctx );
1295
1296     assert( a->usage == 1 || a->usage == 2 );
1297     ctx->usage = a->usage;
1298     if( !len ) {
1299         log_debug("pop_filter called in set_partial_block_mode - please report\n");
1300         pop_filter(a, block_filter, NULL );
1301     }
1302     else {
1303         ctx->partial = 1;
1304         ctx->size = 0;
1305         ctx->first_c = len;
1306         iobuf_push_filter(a, block_filter, ctx );
1307     }
1308 }
1309
1310
1311 /****************
1312  * Checks whether the stream is in block mode
1313  * Note: This does not work if other filters are pushed on the stream.
1314  */
1315 int
1316 iobuf_in_block_mode( IOBUF a )
1317 {
1318     if( a && a->filter == block_filter )
1319         return 1; /* yes */
1320     return 0; /* no */
1321 }
1322
1323
1324 /****************
1325  * Same as fgets() but if the buffer is too short a larger one will
1326  * be allocated up to some limit *max_length.
1327  * A line is considered a byte stream ending in a LF.
1328  * Returns the length of the line. EOF is indicated by a line of
1329  * length zero. The last LF may be missing due to an EOF.
1330  * is max_length is zero on return, the line has been truncated.
1331  *
1332  * Note: The buffer is allocated with enough space to append a CR,LF,EOL
1333  */
1334 unsigned
1335 iobuf_read_line( IOBUF a, byte **addr_of_buffer,
1336                           unsigned *length_of_buffer, unsigned *max_length )
1337 {
1338     int c;
1339     char *buffer = *addr_of_buffer;
1340     unsigned length = *length_of_buffer;
1341     unsigned nbytes = 0;
1342     unsigned maxlen = *max_length;
1343     char *p;
1344
1345     if( !buffer ) { /* must allocate a new buffer */
1346         length = 256;
1347         buffer = m_alloc( length );
1348         *addr_of_buffer = buffer;
1349         *length_of_buffer = length;
1350     }
1351
1352     length -= 3; /* reserve 3 bytes (cr,lf,eol) */
1353     p = buffer;
1354     while( (c=iobuf_get(a)) != -1 ) {
1355         if( nbytes == length ) { /* increase the buffer */
1356             if( length > maxlen  ) { /* this is out limit */
1357                 /* skip the rest of the line */
1358                 while( c != '\n' && (c=iobuf_get(a)) != -1 )
1359                     ;
1360                 *p++ = '\n'; /* always append a LF (we have reserved space) */
1361                 nbytes++;
1362                 *max_length = 0; /* indicate truncation */
1363                 break;
1364             }
1365             length += 3; /* correct for the reserved byte */
1366             length += length < 1024? 256 : 1024;
1367             buffer = m_realloc( buffer, length );
1368             *addr_of_buffer = buffer;
1369             *length_of_buffer = length;
1370             length -= 3; /* and reserve again */
1371             p = buffer + nbytes;
1372         }
1373         *p++ = c;
1374         nbytes++;
1375         if( c == '\n' )
1376             break;
1377     }
1378     *p = 0; /* make sure the line is a string */
1379
1380     return nbytes;
1381 }
1382