2003-09-28 Timo Schulz <twoaday@freakmail.de>
[gnupg.git] / g10 / compress.c
1 /* compress.c - compress filter
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 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 <unistd.h>
26 #include <assert.h>
27 #include <errno.h>
28 #include <zlib.h>
29 #ifdef __riscos__
30 # include "zlib-riscos.h"
31 #endif
32
33 #include "util.h"
34 #include "memory.h"
35 #include "packet.h"
36 #include "filter.h"
37 #include "main.h"
38 #include "options.h"
39
40 static void
41 init_compress( compress_filter_context_t *zfx, z_stream *zs )
42 {
43     int rc;
44     int level;
45
46 #ifdef __riscos__
47     static int zlib_initialized = 0;
48
49     if (!zlib_initialized)
50         zlib_initialized = riscos_load_module("ZLib", zlib_path, 1);
51 #endif
52
53     if( opt.compress >= 0 && opt.compress <= 9 )
54         level = opt.compress;
55     else if( opt.compress == -1 )
56         level = Z_DEFAULT_COMPRESSION;
57     else if( opt.compress == 10 ) /* remove this ! */
58         level = 0;
59     else {
60         log_error("invalid compression level; using default level\n");
61         level = Z_DEFAULT_COMPRESSION;
62     }
63
64
65     if( (rc = zfx->algo == 1? deflateInit2( zs, level, Z_DEFLATED,
66                                             -13, 8, Z_DEFAULT_STRATEGY)
67                             : deflateInit( zs, level )
68                             ) != Z_OK ) {
69         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
70                                rc == Z_MEM_ERROR ? "out of core" :
71                                rc == Z_VERSION_ERROR ? "invalid lib version" :
72                                                        "unknown error" );
73     }
74
75     zfx->outbufsize = 8192;
76     zfx->outbuf = m_alloc( zfx->outbufsize );
77 }
78
79 static int
80 do_compress( compress_filter_context_t *zfx, z_stream *zs, int flush, IOBUF a )
81 {
82     int zrc;
83     unsigned n;
84
85     do {
86 #ifndef __riscos__
87         zs->next_out = zfx->outbuf;
88 #else /* __riscos__ */
89         zs->next_out = (Bytef *) zfx->outbuf;
90 #endif /* __riscos__ */
91         zs->avail_out = zfx->outbufsize;
92         if( DBG_FILTER )
93             log_debug("enter deflate: avail_in=%u, avail_out=%u, flush=%d\n",
94                     (unsigned)zs->avail_in, (unsigned)zs->avail_out, flush );
95         zrc = deflate( zs, flush );
96         if( zrc == Z_STREAM_END && flush == Z_FINISH )
97             ;
98         else if( zrc != Z_OK ) {
99             if( zs->msg )
100                 log_fatal("zlib deflate problem: %s\n", zs->msg );
101             else
102                 log_fatal("zlib deflate problem: rc=%d\n", zrc );
103         }
104         n = zfx->outbufsize - zs->avail_out;
105         if( DBG_FILTER )
106             log_debug("leave deflate: "
107                       "avail_in=%u, avail_out=%u, n=%u, zrc=%d\n",
108                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
109                                                (unsigned)n, zrc );
110
111         if( iobuf_write( a, zfx->outbuf, n ) ) {
112             log_debug("deflate: iobuf_write failed\n");
113             return G10ERR_WRITE_FILE;
114         }
115     } while( zs->avail_in || (flush == Z_FINISH && zrc != Z_STREAM_END) );
116     return 0;
117 }
118
119 static void
120 init_uncompress( compress_filter_context_t *zfx, z_stream *zs )
121 {
122     int rc;
123
124     /****************
125      * PGP uses a windowsize of 13 bits. Using a negative value for
126      * it forces zlib not to expect a zlib header.  This is a
127      * undocumented feature Peter Gutmann told me about.
128      *    
129      * We must use 15 bits for the inflator because CryptoEx uses 15
130      * bits thus the output would get scrambled w/o error indication
131      * if we would use 13 bits.  For the uncompressing this does not
132      * matter at all.
133      */
134     if( (rc = zfx->algo == 1? inflateInit2( zs, -15)
135                             : inflateInit( zs )) != Z_OK ) {
136         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
137                                rc == Z_MEM_ERROR ? "out of core" :
138                                rc == Z_VERSION_ERROR ? "invalid lib version" :
139                                                        "unknown error" );
140     }
141
142     zfx->inbufsize = 2048;
143     zfx->inbuf = m_alloc( zfx->inbufsize );
144     zs->avail_in = 0;
145 }
146
147 static int
148 do_uncompress( compress_filter_context_t *zfx, z_stream *zs,
149                IOBUF a, size_t *ret_len )
150 {
151     int zrc;
152     int rc=0;
153     size_t n;
154     int nread, count;
155     int refill = !zs->avail_in;
156
157     if( DBG_FILTER )
158         log_debug("begin inflate: avail_in=%u, avail_out=%u, inbuf=%u\n",
159                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
160                 (unsigned)zfx->inbufsize );
161     do {
162         if( zs->avail_in < zfx->inbufsize && refill ) {
163             n = zs->avail_in;
164             if( !n )
165 #ifndef __riscos__
166                 zs->next_in = zfx->inbuf;
167 #else /* __riscos__ */
168                 zs->next_in = (Bytef *) zfx->inbuf;
169 #endif /* __riscos__ */
170             count = zfx->inbufsize - n;
171             nread = iobuf_read( a, zfx->inbuf + n, count );
172             if( nread == -1 ) nread = 0;
173             n += nread;
174             /* If we use the undocumented feature to suppress
175              * the zlib header, we have to give inflate an
176              * extra dummy byte to read */
177             if( nread < count && zfx->algo == 1 ) {
178                 *(zfx->inbuf + n) = 0xFF; /* is it really needed ? */
179                 zfx->algo1hack = 1;
180                 n++;
181             }
182             zs->avail_in = n;
183         }
184         refill = 1;
185         if( DBG_FILTER )
186             log_debug("enter inflate: avail_in=%u, avail_out=%u\n",
187                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
188 #ifdef Z_SYNC_FLUSH
189         zrc = inflate( zs, Z_SYNC_FLUSH );
190 #else
191         zrc = inflate( zs, Z_PARTIAL_FLUSH );
192 #endif
193         if( DBG_FILTER )
194             log_debug("leave inflate: avail_in=%u, avail_out=%u, zrc=%d\n",
195                    (unsigned)zs->avail_in, (unsigned)zs->avail_out, zrc);
196         if( zrc == Z_STREAM_END )
197             rc = -1; /* eof */
198         else if( zrc != Z_OK && zrc != Z_BUF_ERROR ) {
199             if( zs->msg )
200                 log_fatal("zlib inflate problem: %s\n", zs->msg );
201             else
202                 log_fatal("zlib inflate problem: rc=%d\n", zrc );
203         }
204     } while( zs->avail_out && zrc != Z_STREAM_END  && zrc != Z_BUF_ERROR );
205     *ret_len = zfx->outbufsize - zs->avail_out;
206     if( DBG_FILTER )
207         log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
208     return rc;
209 }
210
211 int
212 compress_filter( void *opaque, int control,
213                  IOBUF a, byte *buf, size_t *ret_len)
214 {
215     size_t size = *ret_len;
216     compress_filter_context_t *zfx = opaque;
217     z_stream *zs = zfx->opaque;
218     int rc=0;
219
220     if( control == IOBUFCTRL_UNDERFLOW ) {
221         if( !zfx->status ) {
222             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
223             init_uncompress( zfx, zs );
224             zfx->status = 1;
225         }
226
227 #ifndef __riscos__
228         zs->next_out = buf;
229 #else /* __riscos__ */
230         zs->next_out = (Bytef *) buf;
231 #endif /* __riscos__ */
232         zs->avail_out = size;
233         zfx->outbufsize = size; /* needed only for calculation */
234         rc = do_uncompress( zfx, zs, a, ret_len );
235     }
236     else if( control == IOBUFCTRL_FLUSH ) {
237         if( !zfx->status ) {
238             PACKET pkt;
239             PKT_compressed cd;
240
241             if( !zfx->algo )
242                 zfx->algo = DEFAULT_COMPRESS_ALGO;
243             if( zfx->algo != 1 && zfx->algo != 2 )
244               BUG();
245             memset( &cd, 0, sizeof cd );
246             cd.len = 0;
247             cd.algorithm = zfx->algo;
248             init_packet( &pkt );
249             pkt.pkttype = PKT_COMPRESSED;
250             pkt.pkt.compressed = &cd;
251             if( build_packet( a, &pkt ))
252                 log_bug("build_packet(PKT_COMPRESSED) failed\n");
253             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
254             init_compress( zfx, zs );
255             zfx->status = 2;
256         }
257
258 #ifndef __riscos__
259         zs->next_in = buf;
260 #else /* __riscos__ */
261         zs->next_in = (Bytef *) buf;
262 #endif /* __riscos__ */
263         zs->avail_in = size;
264         rc = do_compress( zfx, zs, Z_NO_FLUSH, a );
265     }
266     else if( control == IOBUFCTRL_FREE ) {
267         if( zfx->status == 1 ) {
268             inflateEnd(zs);
269             m_free(zs);
270             zfx->opaque = NULL;
271             m_free(zfx->outbuf); zfx->outbuf = NULL;
272         }
273         else if( zfx->status == 2 ) {
274 #ifndef __riscos__
275             zs->next_in = buf;
276 #else /* __riscos__ */
277             zs->next_in = (Bytef *) buf;
278 #endif /* __riscos__ */
279             zs->avail_in = 0;
280             do_compress( zfx, zs, Z_FINISH, a );
281             deflateEnd(zs);
282             m_free(zs);
283             zfx->opaque = NULL;
284             m_free(zfx->outbuf); zfx->outbuf = NULL;
285         }
286         if (zfx->release)
287           zfx->release (zfx);
288     }
289     else if( control == IOBUFCTRL_DESC )
290         *(char**)buf = "compress_filter";
291     return rc;
292 }
293
294
295 static void
296 release_context (compress_filter_context_t *ctx)
297 {
298   m_free (ctx);
299 }
300
301 /****************
302  * Handle a compressed packet
303  */
304 int
305 handle_compressed( void *procctx, PKT_compressed *cd,
306                    int (*callback)(IOBUF, void *), void *passthru )
307 {
308     compress_filter_context_t *cfx;
309     int rc;
310
311     if( cd->algorithm < 1 || cd->algorithm > 2  )
312         return G10ERR_COMPR_ALGO;
313     cfx = m_alloc_clear (sizeof *cfx);
314     cfx->algo = cd->algorithm;
315     cfx->release = release_context;
316     iobuf_push_filter( cd->buf, compress_filter, cfx );
317     if( callback )
318         rc = callback(cd->buf, passthru );
319     else
320         rc = proc_packets(procctx, cd->buf);
321     cd->buf = NULL;
322     return rc;
323 }
324