1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
|
/*
* Copyright (c) 2012 Tim Ruehsen
* Copyright (c) 2015-2024 Free Software Foundation, Inc.
*
* This file is part of libwget.
*
* Libwget is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Libwget is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libwget. If not, see <https://www.gnu.org/licenses/>.
*
*
* HTTP decompression routines
*
* Changelog
* 20.06.2012 Tim Ruehsen created
* 31.12.2013 Tim Ruehsen added XZ / LZMA decompression
* 02.01.2014 Tim Ruehsen added BZIP2 decompression
* 24.02.2017 Tim Ruehsen added Brotli decompression
*
* References
* https://en.wikipedia.org/wiki/HTTP_compression
* https://wiki.mozilla.org/LZMA2_Compression
* https://groups.google.com/forum/#!topic/mozilla.dev.platform/CBhSPWs3HS8
* https://github.com/google/brotli
*/
#include <config.h>
#include <stdio.h>
#include <string.h>
#ifdef WITH_ZLIB
#define ZLIB_CONST
#include <zlib.h>
#endif
#ifdef WITH_BZIP2
#include <bzlib.h>
#endif
#ifdef WITH_LZMA
#include <lzma.h>
#endif
#ifdef WITH_BROTLIDEC
#include <brotli/decode.h>
#endif
#ifdef WITH_ZSTD
#include <zstd.h>
#endif
#ifdef WITH_LZIP
#include <stdint.h>
#include <lzlib.h>
#endif
#include <wget.h>
#include "private.h"
typedef int wget_decompressor_decompress_fn(wget_decompressor *dc, const char *src, size_t srclen);
typedef void wget_decompressor_exit_fn(wget_decompressor *dc);
struct wget_decompressor_st {
#ifdef WITH_ZLIB
z_stream
z_strm;
#endif
#ifdef WITH_LZMA
lzma_stream
lzma_strm;
#endif
#ifdef WITH_BZIP2
bz_stream
bz_strm;
#endif
#ifdef WITH_BROTLIDEC
BrotliDecoderState
*brotli_strm;
#endif
#ifdef WITH_ZSTD
ZSTD_DStream
*zstd_strm;
#endif
#ifdef WITH_LZIP
struct LZ_Decoder
*lzip_strm;
#endif
wget_decompressor_sink_fn
*sink; // decompressed data goes here
wget_decompressor_error_handler
*error_handler; // called on error
wget_decompressor_decompress_fn
*decompress;
wget_decompressor_exit_fn
*exit;
void
*context; // given to sink()
wget_content_encoding
encoding;
bool
inflating; // deflate/gzip succeeded the init phase
};
#ifdef WITH_ZLIB
static int gzip_init(z_stream *strm)
{
memset(strm, 0, sizeof(*strm));
// +16: decode gzip format only
// +32: decode gzip and zlib (autodetect)
if (inflateInit2(strm, 15 + 32) != Z_OK) {
error_printf(_("Failed to init gzip decompression\n"));
return -1;
}
return 0;
}
static int gzip_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
z_stream *strm;
char dst[10240];
int status;
if (!srclen) {
// special case to avoid decompress errors
if (dc->sink)
dc->sink(dc->context, "", 0);
return 0;
}
strm = &dc->z_strm;
restart:
strm->next_in = (const unsigned char *) src;
strm->avail_in = (unsigned int) srclen;
do {
strm->next_out = (unsigned char *) dst;
strm->avail_out = sizeof(dst);
status = inflate(strm, Z_SYNC_FLUSH);
if (status == Z_DATA_ERROR && !dc->inflating) {
// Looks like some servers send gzip/deflate streams without header.
// Reported at https://gitlab.com/gnuwget/wget2/-/issues/532.
inflateEnd(strm);
if(inflateInit2(strm, -MAX_WBITS) != Z_OK) {
error_printf(_("Failed to re-init deflate/gzip decompression\n"));
return -1;
}
dc->inflating = true;
goto restart;
}
dc->inflating = true;
if ((status == Z_OK || status == Z_STREAM_END) && strm->avail_out < sizeof(dst)) {
if (dc->sink)
dc->sink(dc->context, dst, sizeof(dst) - strm->avail_out);
}
} while (status == Z_OK && !strm->avail_out);
if (status == Z_OK || status == Z_BUF_ERROR || status == Z_STREAM_END)
return 0;
error_printf(_("Failed to uncompress gzip stream (%d)\n"), status);
return -1;
}
static void gzip_exit(wget_decompressor *dc)
{
int status;
if ((status = inflateEnd(&dc->z_strm)) != Z_OK) {
error_printf(_("Failed to close gzip stream (%d)\n"), status);
}
}
static int deflate_init(z_stream *strm)
{
memset(strm, 0, sizeof(*strm));
if (inflateInit(strm) != Z_OK) {
error_printf(_("Failed to init deflate decompression\n"));
return -1;
}
return 0;
}
#endif // WITH_ZLIB
#ifdef WITH_LZMA
static int lzma_init(lzma_stream *strm)
{
memset(strm, 0, sizeof(*strm));
// if (lzma_stream_decoder(strm, UINT64_MAX, LZMA_TELL_UNSUPPORTED_CHECK | LZMA_CONCATENATED) != LZMA_OK) {
if (lzma_auto_decoder(strm, UINT64_MAX, 0) != LZMA_OK) {
error_printf(_("Failed to init LZMA decompression\n"));
return -1;
}
return 0;
}
static int lzma_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
lzma_stream *strm;
char dst[10240];
int status;
if (!srclen) {
// special case to avoid decompress errors
if (dc->sink)
dc->sink(dc->context, "", 0);
return 0;
}
strm = &dc->lzma_strm;
strm->next_in = (const uint8_t *) src;
strm->avail_in = srclen;
do {
strm->next_out = (unsigned char *) dst;
strm->avail_out = sizeof(dst);
status = lzma_code(strm, LZMA_RUN);
if ((status == LZMA_OK || status == LZMA_STREAM_END) && strm->avail_out<sizeof(dst)) {
if (dc->sink)
dc->sink(dc->context, dst, sizeof(dst) - strm->avail_out);
}
} while (status == LZMA_OK && !strm->avail_out);
if (status == LZMA_OK || status == LZMA_STREAM_END)
return 0;
error_printf(_("Failed to uncompress LZMA stream (%d)\n"), status);
return -1;
}
static void lzma_exit(wget_decompressor *dc)
{
lzma_end(&dc->lzma_strm);
}
#endif // WITH_LZMA
#ifdef WITH_BROTLIDEC
static int brotli_init(BrotliDecoderState **strm)
{
if ((*strm = BrotliDecoderCreateInstance(NULL, NULL, NULL)) == NULL) {
error_printf(_("Failed to init Brotli decompression\n"));
return -1;
}
return 0;
}
static int brotli_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
BrotliDecoderState *strm;
BrotliDecoderResult status;
uint8_t dst[10240];
size_t available_in, available_out;
const uint8_t *next_in;
uint8_t *next_out;
if (!srclen) {
// special case to avoid decompress errors
if (dc->sink)
dc->sink(dc->context, "", 0);
return 0;
}
strm = dc->brotli_strm;
next_in = (const uint8_t *) src;
available_in = srclen;
do {
next_out = (unsigned char *)dst;
available_out = sizeof(dst);
status = BrotliDecoderDecompressStream(strm, &available_in, &next_in, &available_out, &next_out, NULL);
if (available_out != sizeof(dst)) {
if (dc->sink)
dc->sink(dc->context, (char *)dst, sizeof(dst) - available_out);
}
} while (status == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT);
if (status == BROTLI_DECODER_RESULT_SUCCESS || status == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT)
return 0;
BrotliDecoderErrorCode err = BrotliDecoderGetErrorCode(strm);
error_printf(_("Failed to uncompress Brotli stream (%u): %s\n"), status, BrotliDecoderErrorString(err));
return -1;
}
static void brotli_exit(wget_decompressor *dc)
{
BrotliDecoderDestroyInstance(dc->brotli_strm);
}
#endif // WITH_BROTLIDEC
#ifdef WITH_ZSTD
static int zstd_init(ZSTD_DStream **strm)
{
if ((*strm = ZSTD_createDStream()) == NULL) {
error_printf(_("Failed to create Zstandard decompression\n"));
return -1;
}
size_t rc = ZSTD_initDStream(*strm);
if (ZSTD_isError(rc)) {
error_printf(_("Failed to init Zstandard decompression: %s\n"), ZSTD_getErrorName(rc));
ZSTD_freeDStream(*strm);
*strm = NULL;
return -1;
}
return 0;
}
static int zstd_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
ZSTD_DStream *strm;
uint8_t dst[10240];
if (!srclen) {
// special case to avoid decompress errors
if (dc->sink)
dc->sink(dc->context, "", 0);
return 0;
}
strm = dc->zstd_strm;
ZSTD_inBuffer input = { .src = src, .size = srclen, .pos = 0 };
while (input.pos < input.size) {
ZSTD_outBuffer output = { .dst = dst, .size = sizeof(dst), .pos = 0 };
size_t rc = ZSTD_decompressStream(strm, &output , &input);
if (ZSTD_isError(rc)) {
error_printf(_("Failed to uncompress Zstandard stream: %s\n"), ZSTD_getErrorName(rc));
return -1;
}
if (output.pos && dc->sink)
dc->sink(dc->context, (char *)dst, output.pos);
}
return 0;
}
static void zstd_exit(wget_decompressor *dc)
{
ZSTD_freeDStream(dc->zstd_strm);
}
#endif // WITH_ZSTD
#ifdef WITH_LZIP
static int lzip_init(struct LZ_Decoder **strm)
{
if ((*strm = LZ_decompress_open()) == NULL) {
error_printf(_("Failed to create lzip decompression\n"));
return -1;
}
// docs say, we have to check the pointer
enum LZ_Errno err;
if ((err = LZ_decompress_errno(*strm)) != LZ_ok) {
error_printf(_("Failed to create lzip decompression: %d %s\n"), (int) err, LZ_strerror(err));
LZ_decompress_close(*strm);
return -1;
}
return 0;
}
static int lzip_drain(wget_decompressor *dc)
{
struct LZ_Decoder *strm = dc->lzip_strm;
uint8_t dst[10240];
int rbytes;
enum LZ_Errno err;
while ((rbytes = LZ_decompress_read(strm, dst, sizeof(dst))) > 0) {
if (dc->sink)
dc->sink(dc->context, (char *) dst, rbytes);
}
if ((err = LZ_decompress_errno(strm)) != LZ_ok) {
error_printf(_("Failed to uncompress lzip stream: %d %s\n"), (int) err, LZ_strerror(err));
return -1;
}
return 0;
}
static int lzip_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
struct LZ_Decoder *strm;
int available_in;
const uint8_t *next_in;
int wbytes;
if (!srclen) {
// special case to avoid decompress errors
if (dc->sink)
dc->sink(dc->context, "", 0);
return 0;
}
strm = dc->lzip_strm;
next_in = (const uint8_t *) src;
available_in = (int) srclen;
do {
wbytes = LZ_decompress_write(strm, next_in, available_in);
next_in += wbytes;
available_in -= wbytes;
if (lzip_drain(dc) < 0)
return -1;
} while (wbytes > 0);
return 0;
}
static void lzip_exit(wget_decompressor *dc)
{
struct LZ_Decoder *strm = dc->lzip_strm;
if (LZ_decompress_finish(strm) == 0)
lzip_drain(dc);
LZ_decompress_close(strm);
}
#endif // WITH_LZIP
#ifdef WITH_BZIP2
static int bzip2_init(bz_stream *strm)
{
memset(strm, 0, sizeof(*strm));
if (BZ2_bzDecompressInit(strm, 0, 0) != BZ_OK) {
error_printf(_("Failed to init bzip2 decompression\n"));
return -1;
}
return 0;
}
static int bzip2_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
bz_stream *strm;
char dst[10240];
int status;
if (!srclen) {
// special case to avoid decompress errors
if (dc->sink)
dc->sink(dc->context, "", 0);
return 0;
}
strm = &dc->bz_strm;
strm->next_in = (char *) src;
strm->avail_in = (unsigned int) srclen;
do {
strm->next_out = dst;
strm->avail_out = sizeof(dst);
status = BZ2_bzDecompress(strm);
if ((status == BZ_OK || status == BZ_STREAM_END) && strm->avail_out<sizeof(dst)) {
if (dc->sink)
dc->sink(dc->context, dst, sizeof(dst) - strm->avail_out);
}
} while (status == BZ_OK && !strm->avail_out);
if (status == BZ_OK || status == BZ_STREAM_END)
return 0;
error_printf(_("Failed to uncompress bzip2 stream (%d)\n"), status);
return -1;
}
static void bzip2_exit(wget_decompressor *dc)
{
BZ2_bzDecompressEnd(&dc->bz_strm);
}
#endif // WITH_BZIP2
static int identity(wget_decompressor *dc, const char *src, size_t srclen)
{
if (dc->sink)
dc->sink(dc->context, src, srclen);
return 0;
}
wget_decompressor *wget_decompress_open(
wget_content_encoding encoding,
wget_decompressor_sink_fn *sink,
void *context)
{
int rc = 0;
wget_decompressor *dc = wget_calloc(1, sizeof(wget_decompressor));
if (!dc)
return NULL;
if (encoding == wget_content_encoding_gzip) {
#ifdef WITH_ZLIB
if ((rc = gzip_init(&dc->z_strm)) == 0) {
dc->decompress = gzip_decompress;
dc->exit = gzip_exit;
}
#endif
} else if (encoding == wget_content_encoding_deflate) {
#ifdef WITH_ZLIB
if ((rc = deflate_init(&dc->z_strm)) == 0) {
dc->decompress = gzip_decompress;
dc->exit = gzip_exit;
}
#endif
} else if (encoding == wget_content_encoding_bzip2) {
#ifdef WITH_BZIP2
if ((rc = bzip2_init(&dc->bz_strm)) == 0) {
dc->decompress = bzip2_decompress;
dc->exit = bzip2_exit;
}
#endif
} else if (encoding == wget_content_encoding_lzma || encoding == wget_content_encoding_xz) {
#ifdef WITH_LZMA
if ((rc = lzma_init(&dc->lzma_strm)) == 0) {
dc->decompress = lzma_decompress;
dc->exit = lzma_exit;
}
#endif
} else if (encoding == wget_content_encoding_brotli) {
#ifdef WITH_BROTLIDEC
if ((rc = brotli_init(&dc->brotli_strm)) == 0) {
dc->decompress = brotli_decompress;
dc->exit = brotli_exit;
}
#endif
} else if (encoding == wget_content_encoding_zstd) {
#ifdef WITH_ZSTD
if ((rc = zstd_init(&dc->zstd_strm)) == 0) {
dc->decompress = zstd_decompress;
dc->exit = zstd_exit;
}
#endif
} else if (encoding == wget_content_encoding_lzip) {
#ifdef WITH_LZIP
if ((rc = lzip_init(&dc->lzip_strm)) == 0) {
dc->decompress = lzip_decompress;
dc->exit = lzip_exit;
}
#endif
}
if (!dc->decompress) {
// identity
if (encoding != wget_content_encoding_identity)
debug_printf("Falling back to Content-Encoding 'identity'\n");
dc->decompress = identity;
}
if (rc) {
xfree(dc);
return NULL;
}
dc->encoding = encoding;
dc->sink = sink;
dc->context = context;
return dc;
}
void wget_decompress_close(wget_decompressor *dc)
{
if (dc) {
if (dc->exit)
dc->exit(dc);
xfree(dc);
}
}
int wget_decompress(wget_decompressor *dc, const char *src, size_t srclen)
{
if (dc) {
int rc = dc->decompress(dc, src, srclen);
if (rc && dc->error_handler)
dc->error_handler(dc, rc);
}
return 0;
}
void wget_decompress_set_error_handler(wget_decompressor *dc, wget_decompressor_error_handler *error_handler)
{
if (dc)
dc->error_handler = error_handler;
}
void *wget_decompress_get_context(wget_decompressor *dc)
{
return dc ? dc->context : NULL;
}
static char _encoding_names[][9] = {
[wget_content_encoding_identity] = "identity",
[wget_content_encoding_gzip] = "gzip",
[wget_content_encoding_deflate] = "deflate",
[wget_content_encoding_xz] = "xz",
[wget_content_encoding_lzma] = "lzma",
[wget_content_encoding_bzip2] = "bzip2",
[wget_content_encoding_brotli] = "br",
[wget_content_encoding_zstd] = "zstd",
[wget_content_encoding_lzip] = "lzip",
};
wget_content_encoding wget_content_encoding_by_name(const char *name)
{
if (name) {
for (wget_content_encoding it = 0; it < wget_content_encoding_max; it++) {
if (!strcmp(_encoding_names[it], name))
return it;
}
if (!strcmp("none", name))
return wget_content_encoding_identity;
}
return wget_content_encoding_unknown;
}
const char *wget_content_encoding_to_name(wget_content_encoding type)
{
if (type >= 0 && type < wget_content_encoding_max)
return _encoding_names[type];
return NULL;
}
|