1 /* ====================================================================
2 * Copyright (c) 1999-2015 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
58 #include <openssl/objects.h>
59 #include <openssl/comp.h>
60 #include <openssl/err.h>
61 #include <internal/cryptlib_int.h>
64 COMP_METHOD *COMP_zlib(void);
66 static COMP_METHOD zlib_method_nozlib = {
81 static int zlib_stateful_init(COMP_CTX *ctx);
82 static void zlib_stateful_finish(COMP_CTX *ctx);
83 static int zlib_stateful_compress_block(COMP_CTX *ctx, unsigned char *out,
84 unsigned int olen, unsigned char *in,
86 static int zlib_stateful_expand_block(COMP_CTX *ctx, unsigned char *out,
87 unsigned int olen, unsigned char *in,
90 /* memory allocations functions for zlib initialisation */
91 static void *zlib_zalloc(void *opaque, unsigned int no, unsigned int size)
95 p = OPENSSL_zalloc(no * size);
99 static void zlib_zfree(void *opaque, void *address)
101 OPENSSL_free(address);
105 static COMP_METHOD zlib_stateful_method = {
106 NID_zlib_compression,
109 zlib_stateful_finish,
110 zlib_stateful_compress_block,
111 zlib_stateful_expand_block
115 * When OpenSSL is built on Windows, we do not want to require that
116 * the ZLIB.DLL be available in order for the OpenSSL DLLs to
117 * work. Therefore, all ZLIB routines are loaded at run time
118 * and we do not link to a .LIB file when ZLIB_SHARED is set.
120 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
121 # include <windows.h>
122 # endif /* !(OPENSSL_SYS_WINDOWS ||
123 * OPENSSL_SYS_WIN32) */
126 # include <openssl/dso.h>
128 /* Function pointers */
129 typedef int (*compress_ft) (Bytef *dest, uLongf * destLen,
130 const Bytef *source, uLong sourceLen);
131 typedef int (*inflateEnd_ft) (z_streamp strm);
132 typedef int (*inflate_ft) (z_streamp strm, int flush);
133 typedef int (*inflateInit__ft) (z_streamp strm,
134 const char *version, int stream_size);
135 typedef int (*deflateEnd_ft) (z_streamp strm);
136 typedef int (*deflate_ft) (z_streamp strm, int flush);
137 typedef int (*deflateInit__ft) (z_streamp strm, int level,
138 const char *version, int stream_size);
139 typedef const char *(*zError__ft) (int err);
140 static compress_ft p_compress = NULL;
141 static inflateEnd_ft p_inflateEnd = NULL;
142 static inflate_ft p_inflate = NULL;
143 static inflateInit__ft p_inflateInit_ = NULL;
144 static deflateEnd_ft p_deflateEnd = NULL;
145 static deflate_ft p_deflate = NULL;
146 static deflateInit__ft p_deflateInit_ = NULL;
147 static zError__ft p_zError = NULL;
149 static int zlib_loaded = 0; /* only attempt to init func pts once */
150 static DSO *zlib_dso = NULL;
152 # define compress p_compress
153 # define inflateEnd p_inflateEnd
154 # define inflate p_inflate
155 # define inflateInit_ p_inflateInit_
156 # define deflateEnd p_deflateEnd
157 # define deflate p_deflate
158 # define deflateInit_ p_deflateInit_
159 # define zError p_zError
160 # endif /* ZLIB_SHARED */
167 static int zlib_stateful_init(COMP_CTX *ctx)
170 struct zlib_state *state = OPENSSL_zalloc(sizeof(*state));
175 state->istream.zalloc = zlib_zalloc;
176 state->istream.zfree = zlib_zfree;
177 state->istream.opaque = Z_NULL;
178 state->istream.next_in = Z_NULL;
179 state->istream.next_out = Z_NULL;
180 err = inflateInit_(&state->istream, ZLIB_VERSION, sizeof(z_stream));
184 state->ostream.zalloc = zlib_zalloc;
185 state->ostream.zfree = zlib_zfree;
186 state->ostream.opaque = Z_NULL;
187 state->ostream.next_in = Z_NULL;
188 state->ostream.next_out = Z_NULL;
189 err = deflateInit_(&state->ostream, Z_DEFAULT_COMPRESSION,
190 ZLIB_VERSION, sizeof(z_stream));
201 static void zlib_stateful_finish(COMP_CTX *ctx)
203 struct zlib_state *state = ctx->data;
204 inflateEnd(&state->istream);
205 deflateEnd(&state->ostream);
209 static int zlib_stateful_compress_block(COMP_CTX *ctx, unsigned char *out,
210 unsigned int olen, unsigned char *in,
214 struct zlib_state *state = ctx->data;
219 state->ostream.next_in = in;
220 state->ostream.avail_in = ilen;
221 state->ostream.next_out = out;
222 state->ostream.avail_out = olen;
224 err = deflate(&state->ostream, Z_SYNC_FLUSH);
228 fprintf(stderr, "compress(%4d)->%4d %s\n",
229 ilen, olen - state->ostream.avail_out,
230 (ilen != olen - state->ostream.avail_out) ? "zlib" : "clear");
232 return olen - state->ostream.avail_out;
235 static int zlib_stateful_expand_block(COMP_CTX *ctx, unsigned char *out,
236 unsigned int olen, unsigned char *in,
240 struct zlib_state *state = ctx->data;
245 state->istream.next_in = in;
246 state->istream.avail_in = ilen;
247 state->istream.next_out = out;
248 state->istream.avail_out = olen;
250 err = inflate(&state->istream, Z_SYNC_FLUSH);
254 fprintf(stderr, "expand(%4d)->%4d %s\n",
255 ilen, olen - state->istream.avail_out,
256 (ilen != olen - state->istream.avail_out) ? "zlib" : "clear");
258 return olen - state->istream.avail_out;
263 COMP_METHOD *COMP_zlib(void)
265 COMP_METHOD *meth = &zlib_method_nozlib;
269 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
270 zlib_dso = DSO_load(NULL, "ZLIB1", NULL, 0);
272 zlib_dso = DSO_load(NULL, "z", NULL, 0);
274 if (zlib_dso != NULL) {
275 p_compress = (compress_ft) DSO_bind_func(zlib_dso, "compress");
277 = (inflateEnd_ft) DSO_bind_func(zlib_dso, "inflateEnd");
278 p_inflate = (inflate_ft) DSO_bind_func(zlib_dso, "inflate");
280 = (inflateInit__ft) DSO_bind_func(zlib_dso, "inflateInit_");
282 = (deflateEnd_ft) DSO_bind_func(zlib_dso, "deflateEnd");
283 p_deflate = (deflate_ft) DSO_bind_func(zlib_dso, "deflate");
285 = (deflateInit__ft) DSO_bind_func(zlib_dso, "deflateInit_");
286 p_zError = (zError__ft) DSO_bind_func(zlib_dso, "zError");
288 if (p_compress && p_inflateEnd && p_inflate
289 && p_inflateInit_ && p_deflateEnd
290 && p_deflate && p_deflateInit_ && p_zError)
293 meth = &zlib_stateful_method;
294 OPENSSL_INIT_crypto_library_start(OPENSSL_INIT_ZLIB, NULL);
299 meth = &zlib_stateful_method;
305 void COMP_zlib_cleanup(void)
308 if (zlib_dso != NULL)
316 /* Zlib based compression/decompression filter BIO */
319 unsigned char *ibuf; /* Input buffer */
320 int ibufsize; /* Buffer size */
321 z_stream zin; /* Input decompress context */
322 unsigned char *obuf; /* Output buffer */
323 int obufsize; /* Output buffer size */
324 unsigned char *optr; /* Position in output buffer */
325 int ocount; /* Amount of data in output buffer */
326 int odone; /* deflate EOF */
327 int comp_level; /* Compression level to use */
328 z_stream zout; /* Output compression context */
331 # define ZLIB_DEFAULT_BUFSIZE 1024
333 static int bio_zlib_new(BIO *bi);
334 static int bio_zlib_free(BIO *bi);
335 static int bio_zlib_read(BIO *b, char *out, int outl);
336 static int bio_zlib_write(BIO *b, const char *in, int inl);
337 static long bio_zlib_ctrl(BIO *b, int cmd, long num, void *ptr);
338 static long bio_zlib_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp);
340 static BIO_METHOD bio_meth_zlib = {
350 bio_zlib_callback_ctrl
353 BIO_METHOD *BIO_f_zlib(void)
355 return &bio_meth_zlib;
358 static int bio_zlib_new(BIO *bi)
364 COMPerr(COMP_F_BIO_ZLIB_NEW, COMP_R_ZLIB_NOT_SUPPORTED);
368 ctx = OPENSSL_zalloc(sizeof(*ctx));
370 COMPerr(COMP_F_BIO_ZLIB_NEW, ERR_R_MALLOC_FAILURE);
373 ctx->ibufsize = ZLIB_DEFAULT_BUFSIZE;
374 ctx->obufsize = ZLIB_DEFAULT_BUFSIZE;
375 ctx->zin.zalloc = Z_NULL;
376 ctx->zin.zfree = Z_NULL;
377 ctx->zout.zalloc = Z_NULL;
378 ctx->zout.zfree = Z_NULL;
379 ctx->comp_level = Z_DEFAULT_COMPRESSION;
381 bi->ptr = (char *)ctx;
386 static int bio_zlib_free(BIO *bi)
391 ctx = (BIO_ZLIB_CTX *) bi->ptr;
393 /* Destroy decompress context */
394 inflateEnd(&ctx->zin);
395 OPENSSL_free(ctx->ibuf);
398 /* Destroy compress context */
399 deflateEnd(&ctx->zout);
400 OPENSSL_free(ctx->obuf);
409 static int bio_zlib_read(BIO *b, char *out, int outl)
416 ctx = (BIO_ZLIB_CTX *) b->ptr;
418 BIO_clear_retry_flags(b);
420 ctx->ibuf = OPENSSL_malloc(ctx->ibufsize);
421 if (ctx->ibuf == NULL) {
422 COMPerr(COMP_F_BIO_ZLIB_READ, ERR_R_MALLOC_FAILURE);
426 zin->next_in = ctx->ibuf;
430 /* Copy output data directly to supplied buffer */
431 zin->next_out = (unsigned char *)out;
432 zin->avail_out = (unsigned int)outl;
434 /* Decompress while data available */
435 while (zin->avail_in) {
436 ret = inflate(zin, 0);
437 if ((ret != Z_OK) && (ret != Z_STREAM_END)) {
438 COMPerr(COMP_F_BIO_ZLIB_READ, COMP_R_ZLIB_INFLATE_ERROR);
439 ERR_add_error_data(2, "zlib error:", zError(ret));
442 /* If EOF or we've read everything then return */
443 if ((ret == Z_STREAM_END) || !zin->avail_out)
444 return outl - zin->avail_out;
448 * No data in input buffer try to read some in, if an error then
449 * return the total data read.
451 ret = BIO_read(b->next_bio, ctx->ibuf, ctx->ibufsize);
453 /* Total data read */
454 int tot = outl - zin->avail_out;
455 BIO_copy_next_retry(b);
457 return (tot > 0) ? tot : ret;
461 zin->next_in = ctx->ibuf;
465 static int bio_zlib_write(BIO *b, const char *in, int inl)
472 ctx = (BIO_ZLIB_CTX *) b->ptr;
476 BIO_clear_retry_flags(b);
478 ctx->obuf = OPENSSL_malloc(ctx->obufsize);
479 /* Need error here */
480 if (ctx->obuf == NULL) {
481 COMPerr(COMP_F_BIO_ZLIB_WRITE, ERR_R_MALLOC_FAILURE);
484 ctx->optr = ctx->obuf;
486 deflateInit(zout, ctx->comp_level);
487 zout->next_out = ctx->obuf;
488 zout->avail_out = ctx->obufsize;
490 /* Obtain input data directly from supplied buffer */
491 zout->next_in = (void *)in;
492 zout->avail_in = inl;
494 /* If data in output buffer write it first */
495 while (ctx->ocount) {
496 ret = BIO_write(b->next_bio, ctx->optr, ctx->ocount);
498 /* Total data written */
499 int tot = inl - zout->avail_in;
500 BIO_copy_next_retry(b);
502 return (tot > 0) ? tot : ret;
509 /* Have we consumed all supplied data? */
513 /* Compress some more */
516 ctx->optr = ctx->obuf;
517 zout->next_out = ctx->obuf;
518 zout->avail_out = ctx->obufsize;
519 /* Compress some more */
520 ret = deflate(zout, 0);
522 COMPerr(COMP_F_BIO_ZLIB_WRITE, COMP_R_ZLIB_DEFLATE_ERROR);
523 ERR_add_error_data(2, "zlib error:", zError(ret));
526 ctx->ocount = ctx->obufsize - zout->avail_out;
530 static int bio_zlib_flush(BIO *b)
535 ctx = (BIO_ZLIB_CTX *) b->ptr;
536 /* If no data written or already flush show success */
537 if (!ctx->obuf || (ctx->odone && !ctx->ocount))
540 BIO_clear_retry_flags(b);
541 /* No more input data */
542 zout->next_in = NULL;
545 /* If data in output buffer write it first */
546 while (ctx->ocount) {
547 ret = BIO_write(b->next_bio, ctx->optr, ctx->ocount);
549 BIO_copy_next_retry(b);
558 /* Compress some more */
561 ctx->optr = ctx->obuf;
562 zout->next_out = ctx->obuf;
563 zout->avail_out = ctx->obufsize;
564 /* Compress some more */
565 ret = deflate(zout, Z_FINISH);
566 if (ret == Z_STREAM_END)
568 else if (ret != Z_OK) {
569 COMPerr(COMP_F_BIO_ZLIB_FLUSH, COMP_R_ZLIB_DEFLATE_ERROR);
570 ERR_add_error_data(2, "zlib error:", zError(ret));
573 ctx->ocount = ctx->obufsize - zout->avail_out;
577 static long bio_zlib_ctrl(BIO *b, int cmd, long num, void *ptr)
584 ctx = (BIO_ZLIB_CTX *) b->ptr;
594 ret = bio_zlib_flush(b);
596 ret = BIO_flush(b->next_bio);
599 case BIO_C_SET_BUFF_SIZE:
614 OPENSSL_free(ctx->ibuf);
620 OPENSSL_free(ctx->obuf);
627 case BIO_C_DO_STATE_MACHINE:
628 BIO_clear_retry_flags(b);
629 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
630 BIO_copy_next_retry(b);
634 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
642 static long bio_zlib_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
646 return BIO_callback_ctrl(b->next_bio, cmd, fp);