* export.c (do_export_stream) [ENABLE_SELINUX_HACKS]: Don't allow
[gnupg.git] / g10 / compress.c
1 /* compress.c - compress filter
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2003 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 /* Note that the code in compress-bz2.c is nearly identical to the
23    code here, so if you fix a bug here, look there to see if a
24    matching bug needs to be fixed.  I tried to have one set of
25    functions that could do ZIP, ZLIB, and BZIP2, but it became
26    dangerously unreadable with #ifdefs and if(algo) -dshaw */
27
28 #include <config.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <unistd.h>
33 #include <assert.h>
34 #include <errno.h>
35 #include <zlib.h>
36 #if defined(__riscos__) && defined(USE_ZLIBRISCOS)
37 # include "zlib-riscos.h"
38 #endif
39
40 #include "util.h"
41 #include "memory.h"
42 #include "packet.h"
43 #include "filter.h"
44 #include "main.h"
45 #include "options.h"
46
47 int compress_filter_bz2( void *opaque, int control,
48                          IOBUF a, byte *buf, size_t *ret_len);
49
50 static void
51 init_compress( compress_filter_context_t *zfx, z_stream *zs )
52 {
53     int rc;
54     int level;
55
56 #if defined(__riscos__) && defined(USE_ZLIBRISCOS)
57     static int zlib_initialized = 0;
58
59     if (!zlib_initialized)
60         zlib_initialized = riscos_load_module("ZLib", zlib_path, 1);
61 #endif
62
63     if( opt.compress_level >= 1 && opt.compress_level <= 9 )
64         level = opt.compress_level;
65     else if( opt.compress_level == -1 )
66         level = Z_DEFAULT_COMPRESSION;
67     else {
68         log_error("invalid compression level; using default level\n");
69         level = Z_DEFAULT_COMPRESSION;
70     }
71
72     if( (rc = zfx->algo == 1? deflateInit2( zs, level, Z_DEFLATED,
73                                             -13, 8, Z_DEFAULT_STRATEGY)
74                             : deflateInit( zs, level )
75                             ) != Z_OK ) {
76         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
77                                rc == Z_MEM_ERROR ? "out of core" :
78                                rc == Z_VERSION_ERROR ? "invalid lib version" :
79                                                        "unknown error" );
80     }
81
82     zfx->outbufsize = 8192;
83     zfx->outbuf = m_alloc( zfx->outbufsize );
84 }
85
86 static int
87 do_compress( compress_filter_context_t *zfx, z_stream *zs, int flush, IOBUF a )
88 {
89     int zrc;
90     unsigned n;
91
92     do {
93 #ifndef __riscos__
94         zs->next_out = zfx->outbuf;
95 #else /* __riscos__ */
96         zs->next_out = (Bytef *) zfx->outbuf;
97 #endif /* __riscos__ */
98         zs->avail_out = zfx->outbufsize;
99         if( DBG_FILTER )
100             log_debug("enter deflate: avail_in=%u, avail_out=%u, flush=%d\n",
101                     (unsigned)zs->avail_in, (unsigned)zs->avail_out, flush );
102         zrc = deflate( zs, flush );
103         if( zrc == Z_STREAM_END && flush == Z_FINISH )
104             ;
105         else if( zrc != Z_OK ) {
106             if( zs->msg )
107                 log_fatal("zlib deflate problem: %s\n", zs->msg );
108             else
109                 log_fatal("zlib deflate problem: rc=%d\n", zrc );
110         }
111         n = zfx->outbufsize - zs->avail_out;
112         if( DBG_FILTER )
113             log_debug("leave deflate: "
114                       "avail_in=%u, avail_out=%u, n=%u, zrc=%d\n",
115                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
116                                                (unsigned)n, zrc );
117
118         if( iobuf_write( a, zfx->outbuf, n ) ) {
119             log_debug("deflate: iobuf_write failed\n");
120             return G10ERR_WRITE_FILE;
121         }
122     } while( zs->avail_in || (flush == Z_FINISH && zrc != Z_STREAM_END) );
123     return 0;
124 }
125
126 static void
127 init_uncompress( compress_filter_context_t *zfx, z_stream *zs )
128 {
129     int rc;
130
131     /****************
132      * PGP uses a windowsize of 13 bits. Using a negative value for
133      * it forces zlib not to expect a zlib header.  This is a
134      * undocumented feature Peter Gutmann told me about.
135      *    
136      * We must use 15 bits for the inflator because CryptoEx uses 15
137      * bits thus the output would get scrambled w/o error indication
138      * if we would use 13 bits.  For the uncompressing this does not
139      * matter at all.
140      */
141     if( (rc = zfx->algo == 1? inflateInit2( zs, -15)
142                             : inflateInit( zs )) != Z_OK ) {
143         log_fatal("zlib problem: %s\n", zs->msg? zs->msg :
144                                rc == Z_MEM_ERROR ? "out of core" :
145                                rc == Z_VERSION_ERROR ? "invalid lib version" :
146                                                        "unknown error" );
147     }
148
149     zfx->inbufsize = 2048;
150     zfx->inbuf = m_alloc( zfx->inbufsize );
151     zs->avail_in = 0;
152 }
153
154 static int
155 do_uncompress( compress_filter_context_t *zfx, z_stream *zs,
156                IOBUF a, size_t *ret_len )
157 {
158     int zrc;
159     int rc=0;
160     size_t n;
161     int nread, count;
162     int refill = !zs->avail_in;
163
164     if( DBG_FILTER )
165         log_debug("begin inflate: avail_in=%u, avail_out=%u, inbuf=%u\n",
166                 (unsigned)zs->avail_in, (unsigned)zs->avail_out,
167                 (unsigned)zfx->inbufsize );
168     do {
169         if( zs->avail_in < zfx->inbufsize && refill ) {
170             n = zs->avail_in;
171             if( !n )
172 #ifndef __riscos__
173                 zs->next_in = zfx->inbuf;
174 #else /* __riscos__ */
175                 zs->next_in = (Bytef *) zfx->inbuf;
176 #endif /* __riscos__ */
177             count = zfx->inbufsize - n;
178             nread = iobuf_read( a, zfx->inbuf + n, count );
179             if( nread == -1 ) nread = 0;
180             n += nread;
181             /* If we use the undocumented feature to suppress
182              * the zlib header, we have to give inflate an
183              * extra dummy byte to read */
184             if( nread < count && zfx->algo == 1 ) {
185                 *(zfx->inbuf + n) = 0xFF; /* is it really needed ? */
186                 zfx->algo1hack = 1;
187                 n++;
188             }
189             zs->avail_in = n;
190         }
191         refill = 1;
192         if( DBG_FILTER )
193             log_debug("enter inflate: avail_in=%u, avail_out=%u\n",
194                     (unsigned)zs->avail_in, (unsigned)zs->avail_out);
195 #ifdef Z_SYNC_FLUSH
196         zrc = inflate( zs, Z_SYNC_FLUSH );
197 #else
198         zrc = inflate( zs, Z_PARTIAL_FLUSH );
199 #endif
200         if( DBG_FILTER )
201             log_debug("leave inflate: avail_in=%u, avail_out=%u, zrc=%d\n",
202                    (unsigned)zs->avail_in, (unsigned)zs->avail_out, zrc);
203         if( zrc == Z_STREAM_END )
204             rc = -1; /* eof */
205         else if( zrc != Z_OK && zrc != Z_BUF_ERROR ) {
206             if( zs->msg )
207                 log_fatal("zlib inflate problem: %s\n", zs->msg );
208             else
209                 log_fatal("zlib inflate problem: rc=%d\n", zrc );
210         }
211     } while( zs->avail_out && zrc != Z_STREAM_END  && zrc != Z_BUF_ERROR );
212     *ret_len = zfx->outbufsize - zs->avail_out;
213     if( DBG_FILTER )
214         log_debug("do_uncompress: returning %u bytes\n", (unsigned)*ret_len );
215     return rc;
216 }
217
218 static int
219 compress_filter( void *opaque, int control,
220                  IOBUF a, byte *buf, size_t *ret_len)
221 {
222     size_t size = *ret_len;
223     compress_filter_context_t *zfx = opaque;
224     z_stream *zs = zfx->opaque;
225     int rc=0;
226
227     if( control == IOBUFCTRL_UNDERFLOW ) {
228         if( !zfx->status ) {
229             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
230             init_uncompress( zfx, zs );
231             zfx->status = 1;
232         }
233
234 #ifndef __riscos__
235         zs->next_out = buf;
236 #else /* __riscos__ */
237         zs->next_out = (Bytef *) buf;
238 #endif /* __riscos__ */
239         zs->avail_out = size;
240         zfx->outbufsize = size; /* needed only for calculation */
241         rc = do_uncompress( zfx, zs, a, ret_len );
242     }
243     else if( control == IOBUFCTRL_FLUSH ) {
244         if( !zfx->status ) {
245             PACKET pkt;
246             PKT_compressed cd;
247             if(zfx->algo != COMPRESS_ALGO_ZIP
248                && zfx->algo != COMPRESS_ALGO_ZLIB)
249               BUG();
250             memset( &cd, 0, sizeof cd );
251             cd.len = 0;
252             cd.algorithm = zfx->algo;
253             init_packet( &pkt );
254             pkt.pkttype = PKT_COMPRESSED;
255             pkt.pkt.compressed = &cd;
256             if( build_packet( a, &pkt ))
257                 log_bug("build_packet(PKT_COMPRESSED) failed\n");
258             zs = zfx->opaque = m_alloc_clear( sizeof *zs );
259             init_compress( zfx, zs );
260             zfx->status = 2;
261         }
262
263 #ifndef __riscos__
264         zs->next_in = buf;
265 #else /* __riscos__ */
266         zs->next_in = (Bytef *) buf;
267 #endif /* __riscos__ */
268         zs->avail_in = size;
269         rc = do_compress( zfx, zs, Z_NO_FLUSH, a );
270     }
271     else if( control == IOBUFCTRL_FREE ) {
272         if( zfx->status == 1 ) {
273             inflateEnd(zs);
274             m_free(zs);
275             zfx->opaque = NULL;
276             m_free(zfx->outbuf); zfx->outbuf = NULL;
277         }
278         else if( zfx->status == 2 ) {
279 #ifndef __riscos__
280             zs->next_in = buf;
281 #else /* __riscos__ */
282             zs->next_in = (Bytef *) buf;
283 #endif /* __riscos__ */
284             zs->avail_in = 0;
285             do_compress( zfx, zs, Z_FINISH, a );
286             deflateEnd(zs);
287             m_free(zs);
288             zfx->opaque = NULL;
289             m_free(zfx->outbuf); zfx->outbuf = NULL;
290         }
291         if (zfx->release)
292           zfx->release (zfx);
293     }
294     else if( control == IOBUFCTRL_DESC )
295         *(char**)buf = "compress_filter";
296     return rc;
297 }
298
299
300 static void
301 release_context (compress_filter_context_t *ctx)
302 {
303   m_free (ctx);
304 }
305
306 /****************
307  * Handle a compressed packet
308  */
309 int
310 handle_compressed( void *procctx, PKT_compressed *cd,
311                    int (*callback)(IOBUF, void *), void *passthru )
312 {
313     compress_filter_context_t *cfx;
314     int rc;
315
316     if(check_compress_algo(cd->algorithm))
317       return G10ERR_COMPR_ALGO;
318     cfx = m_alloc_clear (sizeof *cfx);
319     cfx->release = release_context;
320     cfx->algo = cd->algorithm;
321     push_compress_filter(cd->buf,cfx,cd->algorithm);
322     if( callback )
323         rc = callback(cd->buf, passthru );
324     else
325         rc = proc_packets(procctx, cd->buf);
326     cd->buf = NULL;
327     return rc;
328 }
329
330 void
331 push_compress_filter(IOBUF out,compress_filter_context_t *zfx,int algo)
332 {
333   push_compress_filter2(out,zfx,algo,0);
334 }
335
336 void
337 push_compress_filter2(IOBUF out,compress_filter_context_t *zfx,
338                       int algo,int rel)
339 {
340   if(algo>=0)
341     zfx->algo=algo;
342   else
343     zfx->algo=DEFAULT_COMPRESS_ALGO;
344
345   switch(zfx->algo)
346     {
347     case COMPRESS_ALGO_NONE:
348       break;
349
350     case COMPRESS_ALGO_ZIP:
351     case COMPRESS_ALGO_ZLIB:
352       iobuf_push_filter2(out,compress_filter,zfx,rel);
353       break;
354
355 #ifdef HAVE_BZIP2
356     case COMPRESS_ALGO_BZIP2:
357       iobuf_push_filter2(out,compress_filter_bz2,zfx,rel);
358       break;
359 #endif
360
361     default:
362       BUG();
363     }
364 }