Fix the zlib config option
[openssl.git] / crypto / comp / c_zlib.c
1 /* ====================================================================
2  * Copyright (c) 1999-2015 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@OpenSSL.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This product includes cryptographic software written by Eric Young
50  * (eay@cryptsoft.com).  This product includes software written by Tim
51  * Hudson (tjh@cryptsoft.com).
52  *
53  */
54
55 #include <stdio.h>
56 #include <stdlib.h>
57 #include <string.h>
58 #include <openssl/objects.h>
59 #include <openssl/comp.h>
60 #include <openssl/err.h>
61 #include "internal/cryptlib_int.h"
62 #include "internal/bio.h"
63 #include "comp_lcl.h"
64
65 COMP_METHOD *COMP_zlib(void);
66
67 static COMP_METHOD zlib_method_nozlib = {
68     NID_undef,
69     "(undef)",
70     NULL,
71     NULL,
72     NULL,
73     NULL,
74 };
75
76 #ifndef ZLIB
77 # undef ZLIB_SHARED
78 #else
79
80 # include <zlib.h>
81
82 static int zlib_stateful_init(COMP_CTX *ctx);
83 static void zlib_stateful_finish(COMP_CTX *ctx);
84 static int zlib_stateful_compress_block(COMP_CTX *ctx, unsigned char *out,
85                                         unsigned int olen, unsigned char *in,
86                                         unsigned int ilen);
87 static int zlib_stateful_expand_block(COMP_CTX *ctx, unsigned char *out,
88                                       unsigned int olen, unsigned char *in,
89                                       unsigned int ilen);
90
91 /* memory allocations functions for zlib initialisation */
92 static void *zlib_zalloc(void *opaque, unsigned int no, unsigned int size)
93 {
94     void *p;
95
96     p = OPENSSL_zalloc(no * size);
97     return p;
98 }
99
100 static void zlib_zfree(void *opaque, void *address)
101 {
102     OPENSSL_free(address);
103 }
104
105
106 static COMP_METHOD zlib_stateful_method = {
107     NID_zlib_compression,
108     LN_zlib_compression,
109     zlib_stateful_init,
110     zlib_stateful_finish,
111     zlib_stateful_compress_block,
112     zlib_stateful_expand_block
113 };
114
115 /*
116  * When OpenSSL is built on Windows, we do not want to require that
117  * the ZLIB.DLL be available in order for the OpenSSL DLLs to
118  * work.  Therefore, all ZLIB routines are loaded at run time
119  * and we do not link to a .LIB file when ZLIB_SHARED is set.
120  */
121 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
122 #  include <windows.h>
123 # endif                         /* !(OPENSSL_SYS_WINDOWS ||
124                                  * OPENSSL_SYS_WIN32) */
125
126 # ifdef ZLIB_SHARED
127 #  include "internal/dso.h"
128
129 /* Function pointers */
130 typedef int (*compress_ft) (Bytef *dest, uLongf * destLen,
131                             const Bytef *source, uLong sourceLen);
132 typedef int (*inflateEnd_ft) (z_streamp strm);
133 typedef int (*inflate_ft) (z_streamp strm, int flush);
134 typedef int (*inflateInit__ft) (z_streamp strm,
135                                 const char *version, int stream_size);
136 typedef int (*deflateEnd_ft) (z_streamp strm);
137 typedef int (*deflate_ft) (z_streamp strm, int flush);
138 typedef int (*deflateInit__ft) (z_streamp strm, int level,
139                                 const char *version, int stream_size);
140 typedef const char *(*zError__ft) (int err);
141 static compress_ft p_compress = NULL;
142 static inflateEnd_ft p_inflateEnd = NULL;
143 static inflate_ft p_inflate = NULL;
144 static inflateInit__ft p_inflateInit_ = NULL;
145 static deflateEnd_ft p_deflateEnd = NULL;
146 static deflate_ft p_deflate = NULL;
147 static deflateInit__ft p_deflateInit_ = NULL;
148 static zError__ft p_zError = NULL;
149
150 static int zlib_loaded = 0;     /* only attempt to init func pts once */
151 static DSO *zlib_dso = NULL;
152
153 #  define compress                p_compress
154 #  define inflateEnd              p_inflateEnd
155 #  define inflate                 p_inflate
156 #  define inflateInit_            p_inflateInit_
157 #  define deflateEnd              p_deflateEnd
158 #  define deflate                 p_deflate
159 #  define deflateInit_            p_deflateInit_
160 #  define zError                  p_zError
161 # endif                         /* ZLIB_SHARED */
162
163 struct zlib_state {
164     z_stream istream;
165     z_stream ostream;
166 };
167
168 static int zlib_stateful_init(COMP_CTX *ctx)
169 {
170     int err;
171     struct zlib_state *state = OPENSSL_zalloc(sizeof(*state));
172
173     if (state == NULL)
174         goto err;
175
176     state->istream.zalloc = zlib_zalloc;
177     state->istream.zfree = zlib_zfree;
178     state->istream.opaque = Z_NULL;
179     state->istream.next_in = Z_NULL;
180     state->istream.next_out = Z_NULL;
181     err = inflateInit_(&state->istream, ZLIB_VERSION, sizeof(z_stream));
182     if (err != Z_OK)
183         goto err;
184
185     state->ostream.zalloc = zlib_zalloc;
186     state->ostream.zfree = zlib_zfree;
187     state->ostream.opaque = Z_NULL;
188     state->ostream.next_in = Z_NULL;
189     state->ostream.next_out = Z_NULL;
190     err = deflateInit_(&state->ostream, Z_DEFAULT_COMPRESSION,
191                        ZLIB_VERSION, sizeof(z_stream));
192     if (err != Z_OK)
193         goto err;
194
195     ctx->data = state;
196     return 1;
197  err:
198     OPENSSL_free(state);
199     return 0;
200 }
201
202 static void zlib_stateful_finish(COMP_CTX *ctx)
203 {
204     struct zlib_state *state = ctx->data;
205     inflateEnd(&state->istream);
206     deflateEnd(&state->ostream);
207     OPENSSL_free(state);
208 }
209
210 static int zlib_stateful_compress_block(COMP_CTX *ctx, unsigned char *out,
211                                         unsigned int olen, unsigned char *in,
212                                         unsigned int ilen)
213 {
214     int err = Z_OK;
215     struct zlib_state *state = ctx->data;
216
217     if (state == NULL)
218         return -1;
219
220     state->ostream.next_in = in;
221     state->ostream.avail_in = ilen;
222     state->ostream.next_out = out;
223     state->ostream.avail_out = olen;
224     if (ilen > 0)
225         err = deflate(&state->ostream, Z_SYNC_FLUSH);
226     if (err != Z_OK)
227         return -1;
228     return olen - state->ostream.avail_out;
229 }
230
231 static int zlib_stateful_expand_block(COMP_CTX *ctx, unsigned char *out,
232                                       unsigned int olen, unsigned char *in,
233                                       unsigned int ilen)
234 {
235     int err = Z_OK;
236     struct zlib_state *state = ctx->data;
237
238     if (state == NULL)
239         return 0;
240
241     state->istream.next_in = in;
242     state->istream.avail_in = ilen;
243     state->istream.next_out = out;
244     state->istream.avail_out = olen;
245     if (ilen > 0)
246         err = inflate(&state->istream, Z_SYNC_FLUSH);
247     if (err != Z_OK)
248         return -1;
249     return olen - state->istream.avail_out;
250 }
251
252 #endif
253
254 COMP_METHOD *COMP_zlib(void)
255 {
256     COMP_METHOD *meth = &zlib_method_nozlib;
257
258 #ifdef ZLIB_SHARED
259     if (!zlib_loaded) {
260 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
261         zlib_dso = DSO_load(NULL, "ZLIB1", NULL, 0);
262 # else
263         zlib_dso = DSO_load(NULL, "z", NULL, 0);
264 # endif
265         if (zlib_dso != NULL) {
266             p_compress = (compress_ft) DSO_bind_func(zlib_dso, "compress");
267             p_inflateEnd
268                 = (inflateEnd_ft) DSO_bind_func(zlib_dso, "inflateEnd");
269             p_inflate = (inflate_ft) DSO_bind_func(zlib_dso, "inflate");
270             p_inflateInit_
271                 = (inflateInit__ft) DSO_bind_func(zlib_dso, "inflateInit_");
272             p_deflateEnd
273                 = (deflateEnd_ft) DSO_bind_func(zlib_dso, "deflateEnd");
274             p_deflate = (deflate_ft) DSO_bind_func(zlib_dso, "deflate");
275             p_deflateInit_
276                 = (deflateInit__ft) DSO_bind_func(zlib_dso, "deflateInit_");
277             p_zError = (zError__ft) DSO_bind_func(zlib_dso, "zError");
278
279             if (p_compress && p_inflateEnd && p_inflate
280                 && p_inflateInit_ && p_deflateEnd
281                 && p_deflate && p_deflateInit_ && p_zError)
282                 zlib_loaded++;
283
284             if (!OPENSSL_init_crypto(OPENSSL_INIT_ZLIB, NULL)) {
285                 COMP_zlib_cleanup();
286                 return meth;
287             }
288             if (zlib_loaded)
289                 meth = &zlib_stateful_method;
290         }
291     }
292 #endif
293 #if defined(ZLIB)
294     meth = &zlib_stateful_method;
295 #endif
296
297     return (meth);
298 }
299
300 void COMP_zlib_cleanup(void)
301 {
302 #ifdef ZLIB_SHARED
303     if (zlib_dso != NULL)
304         DSO_free(zlib_dso);
305     zlib_dso = NULL;
306 #endif
307 }
308
309 #ifdef ZLIB
310
311 /* Zlib based compression/decompression filter BIO */
312
313 typedef struct {
314     unsigned char *ibuf;        /* Input buffer */
315     int ibufsize;               /* Buffer size */
316     z_stream zin;               /* Input decompress context */
317     unsigned char *obuf;        /* Output buffer */
318     int obufsize;               /* Output buffer size */
319     unsigned char *optr;        /* Position in output buffer */
320     int ocount;                 /* Amount of data in output buffer */
321     int odone;                  /* deflate EOF */
322     int comp_level;             /* Compression level to use */
323     z_stream zout;              /* Output compression context */
324 } BIO_ZLIB_CTX;
325
326 # define ZLIB_DEFAULT_BUFSIZE 1024
327
328 static int bio_zlib_new(BIO *bi);
329 static int bio_zlib_free(BIO *bi);
330 static int bio_zlib_read(BIO *b, char *out, int outl);
331 static int bio_zlib_write(BIO *b, const char *in, int inl);
332 static long bio_zlib_ctrl(BIO *b, int cmd, long num, void *ptr);
333 static long bio_zlib_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp);
334
335 static const BIO_METHOD bio_meth_zlib = {
336     BIO_TYPE_COMP,
337     "zlib",
338     bio_zlib_write,
339     bio_zlib_read,
340     NULL,
341     NULL,
342     bio_zlib_ctrl,
343     bio_zlib_new,
344     bio_zlib_free,
345     bio_zlib_callback_ctrl
346 };
347
348 const BIO_METHOD *BIO_f_zlib(void)
349 {
350     return &bio_meth_zlib;
351 }
352
353 static int bio_zlib_new(BIO *bi)
354 {
355     BIO_ZLIB_CTX *ctx;
356 # ifdef ZLIB_SHARED
357     (void)COMP_zlib();
358     if (!zlib_loaded) {
359         COMPerr(COMP_F_BIO_ZLIB_NEW, COMP_R_ZLIB_NOT_SUPPORTED);
360         return 0;
361     }
362 # endif
363     ctx = OPENSSL_zalloc(sizeof(*ctx));
364     if (ctx == NULL) {
365         COMPerr(COMP_F_BIO_ZLIB_NEW, ERR_R_MALLOC_FAILURE);
366         return 0;
367     }
368     ctx->ibufsize = ZLIB_DEFAULT_BUFSIZE;
369     ctx->obufsize = ZLIB_DEFAULT_BUFSIZE;
370     ctx->zin.zalloc = Z_NULL;
371     ctx->zin.zfree = Z_NULL;
372     ctx->zout.zalloc = Z_NULL;
373     ctx->zout.zfree = Z_NULL;
374     ctx->comp_level = Z_DEFAULT_COMPRESSION;
375     BIO_set_init(bi, 1);
376     BIO_set_data(bi, ctx);
377
378     return 1;
379 }
380
381 static int bio_zlib_free(BIO *bi)
382 {
383     BIO_ZLIB_CTX *ctx;
384     if (!bi)
385         return 0;
386     ctx = BIO_get_data(bi);
387     if (ctx->ibuf) {
388         /* Destroy decompress context */
389         inflateEnd(&ctx->zin);
390         OPENSSL_free(ctx->ibuf);
391     }
392     if (ctx->obuf) {
393         /* Destroy compress context */
394         deflateEnd(&ctx->zout);
395         OPENSSL_free(ctx->obuf);
396     }
397     OPENSSL_free(ctx);
398     BIO_set_data(bi, NULL);
399     BIO_set_init(bi, 0);
400
401     return 1;
402 }
403
404 static int bio_zlib_read(BIO *b, char *out, int outl)
405 {
406     BIO_ZLIB_CTX *ctx;
407     int ret;
408     z_stream *zin;
409     BIO *next = BIO_next(b);
410
411     if (!out || !outl)
412         return 0;
413     ctx = BIO_get_data(b);
414     zin = &ctx->zin;
415     BIO_clear_retry_flags(b);
416     if (!ctx->ibuf) {
417         ctx->ibuf = OPENSSL_malloc(ctx->ibufsize);
418         if (ctx->ibuf == NULL) {
419             COMPerr(COMP_F_BIO_ZLIB_READ, ERR_R_MALLOC_FAILURE);
420             return 0;
421         }
422         inflateInit(zin);
423         zin->next_in = ctx->ibuf;
424         zin->avail_in = 0;
425     }
426
427     /* Copy output data directly to supplied buffer */
428     zin->next_out = (unsigned char *)out;
429     zin->avail_out = (unsigned int)outl;
430     for (;;) {
431         /* Decompress while data available */
432         while (zin->avail_in) {
433             ret = inflate(zin, 0);
434             if ((ret != Z_OK) && (ret != Z_STREAM_END)) {
435                 COMPerr(COMP_F_BIO_ZLIB_READ, COMP_R_ZLIB_INFLATE_ERROR);
436                 ERR_add_error_data(2, "zlib error:", zError(ret));
437                 return 0;
438             }
439             /* If EOF or we've read everything then return */
440             if ((ret == Z_STREAM_END) || !zin->avail_out)
441                 return outl - zin->avail_out;
442         }
443
444         /*
445          * No data in input buffer try to read some in, if an error then
446          * return the total data read.
447          */
448         ret = BIO_read(next, ctx->ibuf, ctx->ibufsize);
449         if (ret <= 0) {
450             /* Total data read */
451             int tot = outl - zin->avail_out;
452             BIO_copy_next_retry(b);
453             if (ret < 0)
454                 return (tot > 0) ? tot : ret;
455             return tot;
456         }
457         zin->avail_in = ret;
458         zin->next_in = ctx->ibuf;
459     }
460 }
461
462 static int bio_zlib_write(BIO *b, const char *in, int inl)
463 {
464     BIO_ZLIB_CTX *ctx;
465     int ret;
466     z_stream *zout;
467     BIO *next = BIO_next(b);
468
469     if (!in || !inl)
470         return 0;
471     ctx = BIO_get_data(b);
472     if (ctx->odone)
473         return 0;
474     zout = &ctx->zout;
475     BIO_clear_retry_flags(b);
476     if (!ctx->obuf) {
477         ctx->obuf = OPENSSL_malloc(ctx->obufsize);
478         /* Need error here */
479         if (ctx->obuf == NULL) {
480             COMPerr(COMP_F_BIO_ZLIB_WRITE, ERR_R_MALLOC_FAILURE);
481             return 0;
482         }
483         ctx->optr = ctx->obuf;
484         ctx->ocount = 0;
485         deflateInit(zout, ctx->comp_level);
486         zout->next_out = ctx->obuf;
487         zout->avail_out = ctx->obufsize;
488     }
489     /* Obtain input data directly from supplied buffer */
490     zout->next_in = (void *)in;
491     zout->avail_in = inl;
492     for (;;) {
493         /* If data in output buffer write it first */
494         while (ctx->ocount) {
495             ret = BIO_write(next, ctx->optr, ctx->ocount);
496             if (ret <= 0) {
497                 /* Total data written */
498                 int tot = inl - zout->avail_in;
499                 BIO_copy_next_retry(b);
500                 if (ret < 0)
501                     return (tot > 0) ? tot : ret;
502                 return tot;
503             }
504             ctx->optr += ret;
505             ctx->ocount -= ret;
506         }
507
508         /* Have we consumed all supplied data? */
509         if (!zout->avail_in)
510             return inl;
511
512         /* Compress some more */
513
514         /* Reset buffer */
515         ctx->optr = ctx->obuf;
516         zout->next_out = ctx->obuf;
517         zout->avail_out = ctx->obufsize;
518         /* Compress some more */
519         ret = deflate(zout, 0);
520         if (ret != Z_OK) {
521             COMPerr(COMP_F_BIO_ZLIB_WRITE, COMP_R_ZLIB_DEFLATE_ERROR);
522             ERR_add_error_data(2, "zlib error:", zError(ret));
523             return 0;
524         }
525         ctx->ocount = ctx->obufsize - zout->avail_out;
526     }
527 }
528
529 static int bio_zlib_flush(BIO *b)
530 {
531     BIO_ZLIB_CTX *ctx;
532     int ret;
533     z_stream *zout;
534     BIO *next = BIO_next(b);
535
536     ctx = BIO_get_data(b);
537     /* If no data written or already flush show success */
538     if (!ctx->obuf || (ctx->odone && !ctx->ocount))
539         return 1;
540     zout = &ctx->zout;
541     BIO_clear_retry_flags(b);
542     /* No more input data */
543     zout->next_in = NULL;
544     zout->avail_in = 0;
545     for (;;) {
546         /* If data in output buffer write it first */
547         while (ctx->ocount) {
548             ret = BIO_write(next, ctx->optr, ctx->ocount);
549             if (ret <= 0) {
550                 BIO_copy_next_retry(b);
551                 return ret;
552             }
553             ctx->optr += ret;
554             ctx->ocount -= ret;
555         }
556         if (ctx->odone)
557             return 1;
558
559         /* Compress some more */
560
561         /* Reset buffer */
562         ctx->optr = ctx->obuf;
563         zout->next_out = ctx->obuf;
564         zout->avail_out = ctx->obufsize;
565         /* Compress some more */
566         ret = deflate(zout, Z_FINISH);
567         if (ret == Z_STREAM_END)
568             ctx->odone = 1;
569         else if (ret != Z_OK) {
570             COMPerr(COMP_F_BIO_ZLIB_FLUSH, COMP_R_ZLIB_DEFLATE_ERROR);
571             ERR_add_error_data(2, "zlib error:", zError(ret));
572             return 0;
573         }
574         ctx->ocount = ctx->obufsize - zout->avail_out;
575     }
576 }
577
578 static long bio_zlib_ctrl(BIO *b, int cmd, long num, void *ptr)
579 {
580     BIO_ZLIB_CTX *ctx;
581     int ret, *ip;
582     int ibs, obs;
583     BIO *next = BIO_next(b);
584
585     if (next == NULL)
586         return 0;
587     ctx = BIO_get_data(b);
588     switch (cmd) {
589
590     case BIO_CTRL_RESET:
591         ctx->ocount = 0;
592         ctx->odone = 0;
593         ret = 1;
594         break;
595
596     case BIO_CTRL_FLUSH:
597         ret = bio_zlib_flush(b);
598         if (ret > 0)
599             ret = BIO_flush(next);
600         break;
601
602     case BIO_C_SET_BUFF_SIZE:
603         ibs = -1;
604         obs = -1;
605         if (ptr != NULL) {
606             ip = ptr;
607             if (*ip == 0)
608                 ibs = (int)num;
609             else
610                 obs = (int)num;
611         } else {
612             ibs = (int)num;
613             obs = ibs;
614         }
615
616         if (ibs != -1) {
617             OPENSSL_free(ctx->ibuf);
618             ctx->ibuf = NULL;
619             ctx->ibufsize = ibs;
620         }
621
622         if (obs != -1) {
623             OPENSSL_free(ctx->obuf);
624             ctx->obuf = NULL;
625             ctx->obufsize = obs;
626         }
627         ret = 1;
628         break;
629
630     case BIO_C_DO_STATE_MACHINE:
631         BIO_clear_retry_flags(b);
632         ret = BIO_ctrl(next, cmd, num, ptr);
633         BIO_copy_next_retry(b);
634         break;
635
636     default:
637         ret = BIO_ctrl(next, cmd, num, ptr);
638         break;
639
640     }
641
642     return ret;
643 }
644
645 static long bio_zlib_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
646 {
647     BIO *next = BIO_next(b);
648     if (next == NULL)
649         return 0;
650     return BIO_callback_ctrl(next, cmd, fp);
651 }
652
653 #endif