2 * Copyright 1998-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
13 #include <openssl/objects.h>
14 #include "internal/comp.h"
15 #include <openssl/err.h>
16 #include "crypto/cryptlib.h"
17 #include "internal/bio.h"
18 #include "comp_local.h"
20 COMP_METHOD *COMP_zlib(void);
22 static COMP_METHOD zlib_method_nozlib = {
37 static int zlib_stateful_init(COMP_CTX *ctx);
38 static void zlib_stateful_finish(COMP_CTX *ctx);
39 static int zlib_stateful_compress_block(COMP_CTX *ctx, unsigned char *out,
40 unsigned int olen, unsigned char *in,
42 static int zlib_stateful_expand_block(COMP_CTX *ctx, unsigned char *out,
43 unsigned int olen, unsigned char *in,
46 /* memory allocations functions for zlib initialisation */
47 static void *zlib_zalloc(void *opaque, unsigned int no, unsigned int size)
51 p = OPENSSL_zalloc(no * size);
55 static void zlib_zfree(void *opaque, void *address)
57 OPENSSL_free(address);
61 static COMP_METHOD zlib_stateful_method = {
66 zlib_stateful_compress_block,
67 zlib_stateful_expand_block
71 * When OpenSSL is built on Windows, we do not want to require that
72 * the ZLIB.DLL be available in order for the OpenSSL DLLs to
73 * work. Therefore, all ZLIB routines are loaded at run time
74 * and we do not link to a .LIB file when ZLIB_SHARED is set.
76 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
78 # endif /* !(OPENSSL_SYS_WINDOWS ||
79 * OPENSSL_SYS_WIN32) */
82 # include "internal/dso.h"
84 /* Function pointers */
85 typedef int (*compress_ft) (Bytef *dest, uLongf * destLen,
86 const Bytef *source, uLong sourceLen);
87 typedef int (*inflateEnd_ft) (z_streamp strm);
88 typedef int (*inflate_ft) (z_streamp strm, int flush);
89 typedef int (*inflateInit__ft) (z_streamp strm,
90 const char *version, int stream_size);
91 typedef int (*deflateEnd_ft) (z_streamp strm);
92 typedef int (*deflate_ft) (z_streamp strm, int flush);
93 typedef int (*deflateInit__ft) (z_streamp strm, int level,
94 const char *version, int stream_size);
95 typedef const char *(*zError__ft) (int err);
96 static compress_ft p_compress = NULL;
97 static inflateEnd_ft p_inflateEnd = NULL;
98 static inflate_ft p_inflate = NULL;
99 static inflateInit__ft p_inflateInit_ = NULL;
100 static deflateEnd_ft p_deflateEnd = NULL;
101 static deflate_ft p_deflate = NULL;
102 static deflateInit__ft p_deflateInit_ = NULL;
103 static zError__ft p_zError = NULL;
105 static int zlib_loaded = 0; /* only attempt to init func pts once */
106 static DSO *zlib_dso = NULL;
108 # define compress p_compress
109 # define inflateEnd p_inflateEnd
110 # define inflate p_inflate
111 # define inflateInit_ p_inflateInit_
112 # define deflateEnd p_deflateEnd
113 # define deflate p_deflate
114 # define deflateInit_ p_deflateInit_
115 # define zError p_zError
116 # endif /* ZLIB_SHARED */
123 static int zlib_stateful_init(COMP_CTX *ctx)
126 struct zlib_state *state = OPENSSL_zalloc(sizeof(*state));
131 state->istream.zalloc = zlib_zalloc;
132 state->istream.zfree = zlib_zfree;
133 state->istream.opaque = Z_NULL;
134 state->istream.next_in = Z_NULL;
135 state->istream.next_out = Z_NULL;
136 err = inflateInit_(&state->istream, ZLIB_VERSION, sizeof(z_stream));
140 state->ostream.zalloc = zlib_zalloc;
141 state->ostream.zfree = zlib_zfree;
142 state->ostream.opaque = Z_NULL;
143 state->ostream.next_in = Z_NULL;
144 state->ostream.next_out = Z_NULL;
145 err = deflateInit_(&state->ostream, Z_DEFAULT_COMPRESSION,
146 ZLIB_VERSION, sizeof(z_stream));
157 static void zlib_stateful_finish(COMP_CTX *ctx)
159 struct zlib_state *state = ctx->data;
160 inflateEnd(&state->istream);
161 deflateEnd(&state->ostream);
165 static int zlib_stateful_compress_block(COMP_CTX *ctx, unsigned char *out,
166 unsigned int olen, unsigned char *in,
170 struct zlib_state *state = ctx->data;
175 state->ostream.next_in = in;
176 state->ostream.avail_in = ilen;
177 state->ostream.next_out = out;
178 state->ostream.avail_out = olen;
180 err = deflate(&state->ostream, Z_SYNC_FLUSH);
183 return olen - state->ostream.avail_out;
186 static int zlib_stateful_expand_block(COMP_CTX *ctx, unsigned char *out,
187 unsigned int olen, unsigned char *in,
191 struct zlib_state *state = ctx->data;
196 state->istream.next_in = in;
197 state->istream.avail_in = ilen;
198 state->istream.next_out = out;
199 state->istream.avail_out = olen;
201 err = inflate(&state->istream, Z_SYNC_FLUSH);
204 return olen - state->istream.avail_out;
209 COMP_METHOD *COMP_zlib(void)
211 COMP_METHOD *meth = &zlib_method_nozlib;
214 /* LIBZ may be externally defined, and we should respect that value */
216 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
217 # define LIBZ "ZLIB1"
218 # elif defined(OPENSSL_SYS_VMS)
226 zlib_dso = DSO_load(NULL, LIBZ, NULL, 0);
227 if (zlib_dso != NULL) {
228 p_compress = (compress_ft) DSO_bind_func(zlib_dso, "compress");
230 = (inflateEnd_ft) DSO_bind_func(zlib_dso, "inflateEnd");
231 p_inflate = (inflate_ft) DSO_bind_func(zlib_dso, "inflate");
233 = (inflateInit__ft) DSO_bind_func(zlib_dso, "inflateInit_");
235 = (deflateEnd_ft) DSO_bind_func(zlib_dso, "deflateEnd");
236 p_deflate = (deflate_ft) DSO_bind_func(zlib_dso, "deflate");
238 = (deflateInit__ft) DSO_bind_func(zlib_dso, "deflateInit_");
239 p_zError = (zError__ft) DSO_bind_func(zlib_dso, "zError");
241 if (p_compress && p_inflateEnd && p_inflate
242 && p_inflateInit_ && p_deflateEnd
243 && p_deflate && p_deflateInit_ && p_zError)
246 if (!OPENSSL_init_crypto(OPENSSL_INIT_ZLIB, NULL)) {
247 comp_zlib_cleanup_int();
251 meth = &zlib_stateful_method;
256 meth = &zlib_stateful_method;
262 void comp_zlib_cleanup_int(void)
272 /* Zlib based compression/decompression filter BIO */
275 unsigned char *ibuf; /* Input buffer */
276 int ibufsize; /* Buffer size */
277 z_stream zin; /* Input decompress context */
278 unsigned char *obuf; /* Output buffer */
279 int obufsize; /* Output buffer size */
280 unsigned char *optr; /* Position in output buffer */
281 int ocount; /* Amount of data in output buffer */
282 int odone; /* deflate EOF */
283 int comp_level; /* Compression level to use */
284 z_stream zout; /* Output compression context */
287 # define ZLIB_DEFAULT_BUFSIZE 1024
289 static int bio_zlib_new(BIO *bi);
290 static int bio_zlib_free(BIO *bi);
291 static int bio_zlib_read(BIO *b, char *out, int outl);
292 static int bio_zlib_write(BIO *b, const char *in, int inl);
293 static long bio_zlib_ctrl(BIO *b, int cmd, long num, void *ptr);
294 static long bio_zlib_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
296 static const BIO_METHOD bio_meth_zlib = {
299 /* TODO: Convert to new style write function */
302 /* TODO: Convert to new style read function */
305 NULL, /* bio_zlib_puts, */
306 NULL, /* bio_zlib_gets, */
310 bio_zlib_callback_ctrl
313 const BIO_METHOD *BIO_f_zlib(void)
315 return &bio_meth_zlib;
318 static int bio_zlib_new(BIO *bi)
324 COMPerr(COMP_F_BIO_ZLIB_NEW, COMP_R_ZLIB_NOT_SUPPORTED);
328 ctx = OPENSSL_zalloc(sizeof(*ctx));
330 COMPerr(COMP_F_BIO_ZLIB_NEW, ERR_R_MALLOC_FAILURE);
333 ctx->ibufsize = ZLIB_DEFAULT_BUFSIZE;
334 ctx->obufsize = ZLIB_DEFAULT_BUFSIZE;
335 ctx->zin.zalloc = Z_NULL;
336 ctx->zin.zfree = Z_NULL;
337 ctx->zout.zalloc = Z_NULL;
338 ctx->zout.zfree = Z_NULL;
339 ctx->comp_level = Z_DEFAULT_COMPRESSION;
341 BIO_set_data(bi, ctx);
346 static int bio_zlib_free(BIO *bi)
351 ctx = BIO_get_data(bi);
353 /* Destroy decompress context */
354 inflateEnd(&ctx->zin);
355 OPENSSL_free(ctx->ibuf);
358 /* Destroy compress context */
359 deflateEnd(&ctx->zout);
360 OPENSSL_free(ctx->obuf);
363 BIO_set_data(bi, NULL);
369 static int bio_zlib_read(BIO *b, char *out, int outl)
374 BIO *next = BIO_next(b);
378 ctx = BIO_get_data(b);
380 BIO_clear_retry_flags(b);
382 ctx->ibuf = OPENSSL_malloc(ctx->ibufsize);
383 if (ctx->ibuf == NULL) {
384 COMPerr(COMP_F_BIO_ZLIB_READ, ERR_R_MALLOC_FAILURE);
388 zin->next_in = ctx->ibuf;
392 /* Copy output data directly to supplied buffer */
393 zin->next_out = (unsigned char *)out;
394 zin->avail_out = (unsigned int)outl;
396 /* Decompress while data available */
397 while (zin->avail_in) {
398 ret = inflate(zin, 0);
399 if ((ret != Z_OK) && (ret != Z_STREAM_END)) {
400 COMPerr(COMP_F_BIO_ZLIB_READ, COMP_R_ZLIB_INFLATE_ERROR);
401 ERR_add_error_data(2, "zlib error:", zError(ret));
404 /* If EOF or we've read everything then return */
405 if ((ret == Z_STREAM_END) || !zin->avail_out)
406 return outl - zin->avail_out;
410 * No data in input buffer try to read some in, if an error then
411 * return the total data read.
413 ret = BIO_read(next, ctx->ibuf, ctx->ibufsize);
415 /* Total data read */
416 int tot = outl - zin->avail_out;
417 BIO_copy_next_retry(b);
419 return (tot > 0) ? tot : ret;
423 zin->next_in = ctx->ibuf;
427 static int bio_zlib_write(BIO *b, const char *in, int inl)
432 BIO *next = BIO_next(b);
436 ctx = BIO_get_data(b);
440 BIO_clear_retry_flags(b);
442 ctx->obuf = OPENSSL_malloc(ctx->obufsize);
443 /* Need error here */
444 if (ctx->obuf == NULL) {
445 COMPerr(COMP_F_BIO_ZLIB_WRITE, ERR_R_MALLOC_FAILURE);
448 ctx->optr = ctx->obuf;
450 deflateInit(zout, ctx->comp_level);
451 zout->next_out = ctx->obuf;
452 zout->avail_out = ctx->obufsize;
454 /* Obtain input data directly from supplied buffer */
455 zout->next_in = (void *)in;
456 zout->avail_in = inl;
458 /* If data in output buffer write it first */
459 while (ctx->ocount) {
460 ret = BIO_write(next, ctx->optr, ctx->ocount);
462 /* Total data written */
463 int tot = inl - zout->avail_in;
464 BIO_copy_next_retry(b);
466 return (tot > 0) ? tot : ret;
473 /* Have we consumed all supplied data? */
477 /* Compress some more */
480 ctx->optr = ctx->obuf;
481 zout->next_out = ctx->obuf;
482 zout->avail_out = ctx->obufsize;
483 /* Compress some more */
484 ret = deflate(zout, 0);
486 COMPerr(COMP_F_BIO_ZLIB_WRITE, COMP_R_ZLIB_DEFLATE_ERROR);
487 ERR_add_error_data(2, "zlib error:", zError(ret));
490 ctx->ocount = ctx->obufsize - zout->avail_out;
494 static int bio_zlib_flush(BIO *b)
499 BIO *next = BIO_next(b);
501 ctx = BIO_get_data(b);
502 /* If no data written or already flush show success */
503 if (!ctx->obuf || (ctx->odone && !ctx->ocount))
506 BIO_clear_retry_flags(b);
507 /* No more input data */
508 zout->next_in = NULL;
511 /* If data in output buffer write it first */
512 while (ctx->ocount) {
513 ret = BIO_write(next, ctx->optr, ctx->ocount);
515 BIO_copy_next_retry(b);
524 /* Compress some more */
527 ctx->optr = ctx->obuf;
528 zout->next_out = ctx->obuf;
529 zout->avail_out = ctx->obufsize;
530 /* Compress some more */
531 ret = deflate(zout, Z_FINISH);
532 if (ret == Z_STREAM_END)
534 else if (ret != Z_OK) {
535 COMPerr(COMP_F_BIO_ZLIB_FLUSH, COMP_R_ZLIB_DEFLATE_ERROR);
536 ERR_add_error_data(2, "zlib error:", zError(ret));
539 ctx->ocount = ctx->obufsize - zout->avail_out;
543 static long bio_zlib_ctrl(BIO *b, int cmd, long num, void *ptr)
548 BIO *next = BIO_next(b);
552 ctx = BIO_get_data(b);
562 ret = bio_zlib_flush(b);
564 ret = BIO_flush(next);
567 case BIO_C_SET_BUFF_SIZE:
582 OPENSSL_free(ctx->ibuf);
588 OPENSSL_free(ctx->obuf);
595 case BIO_C_DO_STATE_MACHINE:
596 BIO_clear_retry_flags(b);
597 ret = BIO_ctrl(next, cmd, num, ptr);
598 BIO_copy_next_retry(b);
601 case BIO_CTRL_WPENDING:
602 if (ctx->obuf == NULL)
610 /* Unknown amount pending but we are not finished */
614 ret = BIO_ctrl(next, cmd, num, ptr);
617 case BIO_CTRL_PENDING:
618 ret = ctx->zin.avail_in;
620 ret = BIO_ctrl(next, cmd, num, ptr);
624 ret = BIO_ctrl(next, cmd, num, ptr);
632 static long bio_zlib_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
634 BIO *next = BIO_next(b);
637 return BIO_callback_ctrl(next, cmd, fp);