Coverage Report

Created: 2026-07-30 07:17

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libzip/lib/zip_source_compress.c
Line
Count
Source
1
/*
2
  zip_source_compress.c -- (de)compression routines
3
  Copyright (C) 2017-2025 Dieter Baron and Thomas Klausner
4
5
  This file is part of libzip, a library to manipulate ZIP archives.
6
  The authors can be contacted at <info@libzip.org>
7
8
  Redistribution and use in source and binary forms, with or without
9
  modification, are permitted provided that the following conditions
10
  are met:
11
  1. Redistributions of source code must retain the above copyright
12
     notice, this list of conditions and the following disclaimer.
13
  2. Redistributions in binary form must reproduce the above copyright
14
     notice, this list of conditions and the following disclaimer in
15
     the documentation and/or other materials provided with the
16
     distribution.
17
  3. The names of the authors may not be used to endorse or promote
18
     products derived from this software without specific prior
19
     written permission.
20
21
  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
22
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24
  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
25
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
29
  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30
  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31
  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
*/
33
34
#include "zipint.h"
35
36
#include <stdlib.h>
37
#include <string.h>
38
39
struct context {
40
    zip_error_t error;
41
42
    bool end_of_input;
43
    bool end_of_stream;
44
    bool can_store;
45
    bool is_stored; /* only valid if end_of_stream is true */
46
    bool compress;
47
    bool check_consistency;
48
    zip_int32_t method;
49
50
    zip_uint64_t size;
51
    zip_int64_t first_read;
52
    zip_uint8_t buffer[BUFSIZE];
53
54
    zip_compression_algorithm_t *algorithm;
55
    void *ud;
56
};
57
58
59
struct implementation {
60
    zip_uint16_t method;
61
    zip_compression_algorithm_t *compress;
62
    zip_compression_algorithm_t *decompress;
63
};
64
65
static struct implementation implementations[] = {
66
    {ZIP_CM_DEFLATE, &zip_algorithm_deflate_compress, &zip_algorithm_deflate_decompress},
67
#if defined(HAVE_LIBBZ2)
68
    {ZIP_CM_BZIP2, &zip_algorithm_bzip2_compress, &zip_algorithm_bzip2_decompress},
69
#endif
70
#if defined(HAVE_LIBLZMA)
71
    {ZIP_CM_LZMA, &zip_algorithm_xz_compress, &zip_algorithm_xz_decompress},
72
    /*  Disabled - because 7z isn't able to unpack ZIP+LZMA2
73
        archives made this way - and vice versa.
74
75
        {ZIP_CM_LZMA2, &zip_algorithm_xz_compress, &zip_algorithm_xz_decompress},
76
    */
77
    {ZIP_CM_XZ, &zip_algorithm_xz_compress, &zip_algorithm_xz_decompress},
78
#endif
79
#if defined(HAVE_LIBZSTD)
80
    {ZIP_CM_ZSTD, &zip_algorithm_zstd_compress, &zip_algorithm_zstd_decompress},
81
#endif
82
83
};
84
85
static size_t implementations_size = sizeof(implementations) / sizeof(implementations[0]);
86
87
static zip_source_t *compression_source_new(zip_t *za, zip_source_t *src, zip_int32_t method, bool compress, zip_uint32_t compression_flags);
88
static zip_int64_t compress_callback(zip_source_t *, void *, void *, zip_uint64_t, zip_source_cmd_t);
89
static void context_free(struct context *ctx);
90
static struct context *context_new(zip_int32_t method, bool compress, zip_uint32_t compression_flags, zip_compression_algorithm_t *algorithm, bool check_consistency);
91
static zip_int64_t compress_read(zip_source_t *, struct context *, void *, zip_uint64_t);
92
93
1.12k
zip_compression_algorithm_t *_zip_get_compression_algorithm(zip_int32_t method, bool compress) {
94
1.12k
    size_t i;
95
1.12k
    zip_uint16_t real_method = ZIP_CM_ACTUAL(method);
96
97
1.13k
    for (i = 0; i < implementations_size; i++) {
98
1.12k
        if (implementations[i].method == real_method) {
99
1.12k
            if (compress) {
100
0
                return implementations[i].compress;
101
0
            }
102
1.12k
            else {
103
1.12k
                return implementations[i].decompress;
104
1.12k
            }
105
1.12k
        }
106
1.12k
    }
107
108
5
    return NULL;
109
1.12k
}
110
111
0
ZIP_EXTERN int zip_compression_method_supported(zip_int32_t method, int compress) {
112
0
    if (method == ZIP_CM_STORE) {
113
0
        return 1;
114
0
    }
115
0
    return _zip_get_compression_algorithm(method, compress) != NULL;
116
0
}
117
118
0
zip_source_t *zip_source_compress(zip_t *za, zip_source_t *src, zip_int32_t method, zip_uint32_t compression_flags) {
119
0
    return compression_source_new(za, src, method, true, compression_flags);
120
0
}
121
122
1.12k
zip_source_t *zip_source_decompress(zip_t *za, zip_source_t *src, zip_int32_t method) {
123
1.12k
    return compression_source_new(za, src, method, false, 0);
124
1.12k
}
125
126
127
1.12k
static zip_source_t *compression_source_new(zip_t *za, zip_source_t *src, zip_int32_t method, bool compress, zip_uint32_t compression_flags) {
128
1.12k
    struct context *ctx;
129
1.12k
    zip_source_t *s2;
130
1.12k
    zip_compression_algorithm_t *algorithm = NULL;
131
132
1.12k
    if (src == NULL) {
133
0
        zip_error_set(&za->error, ZIP_ER_INVAL, 0);
134
0
        return NULL;
135
0
    }
136
137
1.12k
    if ((algorithm = _zip_get_compression_algorithm(method, compress)) == NULL) {
138
5
        zip_error_set(&za->error, ZIP_ER_COMPNOTSUPP, 0);
139
5
        return NULL;
140
5
    }
141
142
1.12k
    if ((ctx = context_new(method, compress, compression_flags, algorithm, za->open_flags & ZIP_CHECKCONS)) == NULL) {
143
0
        zip_error_set(&za->error, ZIP_ER_MEMORY, 0);
144
0
        return NULL;
145
0
    }
146
147
1.12k
    if ((s2 = zip_source_layered(za, src, compress_callback, ctx)) == NULL) {
148
0
        context_free(ctx);
149
0
        return NULL;
150
0
    }
151
152
1.12k
    return s2;
153
1.12k
}
154
155
156
1.12k
static struct context *context_new(zip_int32_t method, bool compress, zip_uint32_t compression_flags, zip_compression_algorithm_t *algorithm, bool check_consistency) {
157
1.12k
    struct context *ctx;
158
159
1.12k
    if ((ctx = (struct context *)malloc(sizeof(*ctx))) == NULL) {
160
0
        return NULL;
161
0
    }
162
1.12k
    zip_error_init(&ctx->error);
163
1.12k
    ctx->can_store = compress ? method == ZIP_CM_DEFAULT : false;
164
1.12k
    ctx->algorithm = algorithm;
165
1.12k
    ctx->method = method;
166
1.12k
    ctx->compress = compress;
167
1.12k
    ctx->end_of_input = false;
168
1.12k
    ctx->end_of_stream = false;
169
1.12k
    ctx->is_stored = false;
170
1.12k
    ctx->check_consistency = check_consistency;
171
172
1.12k
    if ((ctx->ud = ctx->algorithm->allocate(ZIP_CM_ACTUAL(method), compression_flags, &ctx->error)) == NULL) {
173
0
        zip_error_fini(&ctx->error);
174
0
        free(ctx);
175
0
        return NULL;
176
0
    }
177
178
1.12k
    return ctx;
179
1.12k
}
180
181
182
1.12k
static void context_free(struct context *ctx) {
183
1.12k
    if (ctx == NULL) {
184
0
        return;
185
0
    }
186
187
1.12k
    ctx->algorithm->deallocate(ctx->ud);
188
1.12k
    zip_error_fini(&ctx->error);
189
190
1.12k
    free(ctx);
191
1.12k
}
192
193
194
2.08k
static zip_int64_t compress_read(zip_source_t *src, struct context *ctx, void *data, zip_uint64_t len) {
195
2.08k
    zip_compression_status_t ret;
196
2.08k
    bool end;
197
2.08k
    zip_int64_t n;
198
2.08k
    zip_uint64_t out_offset;
199
2.08k
    zip_uint64_t out_len;
200
201
2.08k
    if (zip_error_code_zip(&ctx->error) != ZIP_ER_OK) {
202
11
        return -1;
203
11
    }
204
205
2.07k
    if (len == 0 || ctx->end_of_stream) {
206
501
        return 0;
207
501
    }
208
209
1.57k
    out_offset = 0;
210
211
1.57k
    end = false;
212
4.68k
    while (!end && out_offset < len) {
213
3.11k
        out_len = len - out_offset;
214
3.11k
        ret = ctx->algorithm->process(ctx->ud, (zip_uint8_t *)data + out_offset, &out_len);
215
216
3.11k
        if (ret != ZIP_COMPRESSION_ERROR) {
217
3.00k
            out_offset += out_len;
218
3.00k
        }
219
220
3.11k
        switch (ret) {
221
532
        case ZIP_COMPRESSION_END:
222
532
            ctx->end_of_stream = true;
223
224
532
            if (!ctx->end_of_input) {
225
532
                n = zip_source_read(src, ctx->buffer, 1);
226
532
                if (n < 0) {
227
11
                    zip_error_set_from_source(&ctx->error, src);
228
11
                    end = true;
229
11
                    break;
230
11
                }
231
521
                else if (n == 0) {
232
521
                    ctx->end_of_input = true;
233
521
                    n = ctx->algorithm->end_of_input(ctx->ud) ? 1 : 0;
234
521
                }
235
236
521
                if (n > 0 && ctx->check_consistency) {
237
                    /* garbage after stream, or compression ended before all data read */
238
0
                    zip_error_set(&ctx->error, ZIP_ER_INCONS, ZIP_ER_DETAIL_COMPRESSED_DATA_TRAILING_GARBAGE);
239
0
                    end = true;
240
0
                    break;
241
0
                }
242
521
            }
243
244
521
            if (ctx->first_read < 0) {
245
                /* we got end of processed stream before reading any input data */
246
0
                zip_error_set(&ctx->error, ZIP_ER_INTERNAL, 0);
247
0
                end = true;
248
0
                break;
249
0
            }
250
521
            if (ctx->can_store && (zip_uint64_t)ctx->first_read <= out_offset) {
251
0
                ctx->is_stored = true;
252
0
                ctx->size = (zip_uint64_t)ctx->first_read;
253
0
                (void)memcpy_s(data, ctx->size, ctx->buffer, ctx->size);
254
0
                return (zip_int64_t)ctx->size;
255
0
            }
256
521
            end = true;
257
521
            break;
258
259
704
        case ZIP_COMPRESSION_OK:
260
704
            break;
261
262
1.76k
        case ZIP_COMPRESSION_NEED_DATA:
263
1.76k
            if (ctx->end_of_input) {
264
                /* TODO: error: stream not ended, but no more input */
265
426
                end = true;
266
426
                break;
267
426
            }
268
269
1.33k
            if ((n = zip_source_read(src, ctx->buffer, sizeof(ctx->buffer))) < 0) {
270
17
                zip_error_set_from_source(&ctx->error, src);
271
17
                end = true;
272
17
                break;
273
17
            }
274
1.32k
            else if (n == 0) {
275
222
                ctx->end_of_input = true;
276
222
                ctx->algorithm->end_of_input(ctx->ud);
277
222
                if (ctx->first_read < 0) {
278
1
                    ctx->first_read = 0;
279
1
                }
280
222
            }
281
1.10k
            else {
282
1.10k
                if (ctx->first_read >= 0) {
283
                    /* we overwrote a previously filled ctx->buffer */
284
0
                    ctx->can_store = false;
285
0
                }
286
1.10k
                else {
287
1.10k
                    ctx->first_read = n;
288
1.10k
                }
289
290
1.10k
                ctx->algorithm->input(ctx->ud, ctx->buffer, (zip_uint64_t)n);
291
1.10k
            }
292
1.32k
            break;
293
294
1.32k
        case ZIP_COMPRESSION_ERROR:
295
            /* error set by algorithm */
296
114
            if (zip_error_code_zip(&ctx->error) == ZIP_ER_OK) {
297
0
                zip_error_set(&ctx->error, ZIP_ER_INTERNAL, 0);
298
0
            }
299
114
            end = true;
300
114
            break;
301
3.11k
        }
302
3.11k
    }
303
304
1.57k
    if (out_offset > 0) {
305
1.22k
        ctx->can_store = false;
306
1.22k
        ctx->size += out_offset;
307
1.22k
        return (zip_int64_t)out_offset;
308
1.22k
    }
309
310
353
    return (zip_error_code_zip(&ctx->error) == ZIP_ER_OK) ? 0 : -1;
311
1.57k
}
312
313
314
8.84k
static zip_int64_t compress_callback(zip_source_t *src, void *ud, void *data, zip_uint64_t len, zip_source_cmd_t cmd) {
315
8.84k
    struct context *ctx;
316
317
8.84k
    ctx = (struct context *)ud;
318
319
8.84k
    switch (cmd) {
320
1.11k
    case ZIP_SOURCE_OPEN: {
321
1.11k
        zip_stat_t st;
322
1.11k
        zip_file_attributes_t attributes;
323
324
1.11k
        ctx->size = 0;
325
1.11k
        ctx->end_of_input = false;
326
1.11k
        ctx->end_of_stream = false;
327
1.11k
        ctx->is_stored = false;
328
1.11k
        ctx->first_read = -1;
329
330
1.11k
        if (zip_source_stat(src, &st) < 0 || zip_source_get_file_attributes(src, &attributes) < 0) {
331
0
            zip_error_set_from_source(&ctx->error, src);
332
0
            return -1;
333
0
        }
334
335
1.11k
        if (!ctx->algorithm->start(ctx->ud, &st, &attributes)) {
336
0
            return -1;
337
0
        }
338
339
1.11k
        return 0;
340
1.11k
    }
341
342
2.08k
    case ZIP_SOURCE_READ:
343
2.08k
        return compress_read(src, ctx, data, len);
344
345
1.11k
    case ZIP_SOURCE_CLOSE:
346
1.11k
        if (!ctx->algorithm->end(ctx->ud)) {
347
0
            return -1;
348
0
        }
349
1.11k
        return 0;
350
351
1.16k
    case ZIP_SOURCE_STAT: {
352
1.16k
        zip_stat_t *st;
353
354
1.16k
        st = (zip_stat_t *)data;
355
356
1.16k
        if (ctx->compress) {
357
0
            if (ctx->end_of_stream) {
358
0
                st->comp_method = ctx->is_stored ? ZIP_CM_STORE : ZIP_CM_ACTUAL(ctx->method);
359
0
                st->comp_size = ctx->size;
360
0
                st->valid |= ZIP_STAT_COMP_SIZE | ZIP_STAT_COMP_METHOD;
361
0
            }
362
0
            else {
363
0
                st->valid &= ~(ZIP_STAT_COMP_SIZE | ZIP_STAT_COMP_METHOD);
364
0
            }
365
0
        }
366
1.16k
        else {
367
1.16k
            st->comp_method = ZIP_CM_STORE;
368
1.16k
            st->valid |= ZIP_STAT_COMP_METHOD;
369
1.16k
            st->valid &= ~ZIP_STAT_COMP_SIZE;
370
1.16k
            if (ctx->end_of_stream) {
371
720
                st->size = ctx->size;
372
720
                st->valid |= ZIP_STAT_SIZE;
373
720
            }
374
1.16k
        }
375
1.16k
    }
376
1.16k
        return 0;
377
378
1.11k
    case ZIP_SOURCE_ERROR:
379
1.11k
        return zip_error_to_data(&ctx->error, data, len);
380
381
1.12k
    case ZIP_SOURCE_FREE:
382
1.12k
        context_free(ctx);
383
1.12k
        return 0;
384
385
0
    case ZIP_SOURCE_GET_FILE_ATTRIBUTES: {
386
0
        zip_file_attributes_t *attributes = (zip_file_attributes_t *)data;
387
388
0
        if (len < sizeof(*attributes)) {
389
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
390
0
            return -1;
391
0
        }
392
393
0
        attributes->valid |= ZIP_FILE_ATTRIBUTES_VERSION_NEEDED | ZIP_FILE_ATTRIBUTES_GENERAL_PURPOSE_BIT_FLAGS;
394
0
        attributes->version_needed = ctx->algorithm->version_needed;
395
0
        attributes->general_purpose_bit_mask = ZIP_FILE_ATTRIBUTES_GENERAL_PURPOSE_BIT_FLAGS_ALLOWED_MASK;
396
0
        attributes->general_purpose_bit_flags = (ctx->is_stored ? 0 : ctx->algorithm->general_purpose_bit_flags(ctx->ud));
397
398
0
        return sizeof(*attributes);
399
0
    }
400
401
1.12k
    case ZIP_SOURCE_SUPPORTS:
402
1.12k
        return ZIP_SOURCE_SUPPORTS_READABLE | zip_source_make_command_bitmap(ZIP_SOURCE_GET_FILE_ATTRIBUTES, ZIP_SOURCE_SUPPORTS_REOPEN, -1);
403
404
0
    default:
405
0
        return zip_source_pass_to_lower_layer(src, data, len, cmd);
406
8.84k
    }
407
8.84k
}